toCsv | @sheetwrite/core

@sheetwrite/corefunction

Export the current visible CSV view (UTF-8 BOM, CRLF): visible columns and view-ordered rows surviving sort, filter, hidden-row, and group state. String values beginning with = + - @ \t \r are prefixed with '. The synchronous API returns one in-memory string, but fetches at most maxWriterWindowRows view rows from the store per read.

Package: @sheetwrite/core
Source: packages/core/src/export.ts#L56

Declaration

function toCsv(
  sheet: Sheetinterface Sheet {
  id: SheetId;
  name: string;
  visibility?: SheetVisibility;
  columns: Column[];
  rowCount: number;
  rowHeights?: Map<number, number>;
  hiddenRows?: Set<number>;
  rowGroups?: RowGroup[];
  conditionalFormats?: ConditionalFormatRule[];
  validationRules?: DataValidationRule[];
  protectedRanges?: ProtectedRange[];
  notes?: CellNote[];
  sortKeys?: SortKey[];
  filters?: Array<[col: number, filter: ColumnFilter]>;
  // … 4 more lines — see the API reference
}interface Sheet {
  id: SheetId;
  name: string;
  visibility?: SheetVisibility;
  columns: Column[];
  rowCount: number;
  rowHeights?: Map<number, number>;
  hiddenRows?: Set<number>;
  rowGroups?: RowGroup[];
  conditionalFormats?: ConditionalFormatRule[];
  validationRules?: DataValidationRule[];
  protectedRanges?: ProtectedRange[];
  notes?: CellNote[];
  sortKeys?: SortKey[];
  filters?: Array<[col: number, filter: ColumnFilter]>;
  // … 4 more lines — see the API reference
}interface Sheet {
  id: SheetId;
  name: string;
  visibility?: SheetVisibility;
  columns: Column[];
  rowCount: number;
  rowHeights?: Map<
    number,
    number
  >;
  hiddenRows?: Set<number>;
  rowGroups?: RowGroup[];
  conditionalFormats?: ConditionalFormatRule[];
  validationRules?: DataValidationRule[];
  protectedRanges?: ProtectedRange[];
  notes?: CellNote[];
  sortKeys?: SortKey[];
  filters?: Array<
    [
  // … 8 more lines — see the API reference
}Workbook sheet schema used when creating a live grid.API reference →,
  store: Storeinterface Store {
  getWorkbook(): Workbook;
  getCell(addr: CellAddress): ResolvedCell;
  getFormula(addr: CellAddress): string | null;
  getRefTarget(addr: CellAddress): CellAddress | null;
  recalculateVolatile(now?: Date): void;
  getVisibleWindow(
    sheet: SheetId,
    rows: { start: number; end: number },
    cols: readonly number[],
  ): VisibleWindowView;
  getDataWindow?(
    sheet: SheetId,
    rows: { start: number; end: number },
    cols: readonly number[],
  // … 22 more lines — see the API reference
}interface Store {
  getWorkbook(): Workbook;
  getCell(addr: CellAddress): ResolvedCell;
  getFormula(addr: CellAddress): string | null;
  getRefTarget(addr: CellAddress): CellAddress | null;
  recalculateVolatile(now?: Date): void;
  getVisibleWindow(
    sheet: SheetId,
    rows: { start: number; end: number },
    cols: readonly number[],
  ): VisibleWindowView;
  getDataWindow?(
    sheet: SheetId,
    rows: { start: number; end: number },
    cols: readonly number[],
  // … 22 more lines — see the API reference
}interface Store {
  getWorkbook(): Workbook;
  getCell(
    addr: CellAddress,
  ): ResolvedCell;
  getFormula(
    addr: CellAddress,
  ): string | null;
  getRefTarget(
    addr: CellAddress,
  ): CellAddress | null;
  recalculateVolatile(
    now?: Date,
  ): void;
  getVisibleWindow(
    sheet: SheetId,
    rows: {
      start: number;
      end: number;
  // … 53 more lines — see the API reference
}Columnar workbook storage, query, transaction, and subscription contract.API reference →,
  options?: DelimitedTextOptionsinterface DelimitedTextOptions {
  resourceLimits?: Partial<DelimitedTextResourceLimits>;
}interface DelimitedTextOptions {
  resourceLimits?: Partial<DelimitedTextResourceLimits>;
}interface DelimitedTextOptions {
  resourceLimits?: Partial<DelimitedTextResourceLimits>;
}Optional resource ceilings for an in-memory delimited-text operation.API reference →,
): string