WorkbookSnapshot | @sheetwrite/core

Schema-versioned serializable workbook document.

Package: @sheetwrite/core
Source: packages/core/src/types/document.ts#L301

Members 5

schemaVersion

schemaVersion: 1;

documentId

documentId?: string;

version

version?: number;

workbook

workbook: { activeSheet: SheetIdtype SheetId = string;type SheetId = string;type SheetId = string;Stable identifier used to address a workbook sheet.API reference →; namedRanges?: NamedRangeSnapshotinterface NamedRangeSnapshot {
  name: string;
  scope?: SheetId;
  range: Range;
}interface NamedRangeSnapshot {
  name: string;
  scope?: SheetId;
  range: Range;
}interface NamedRangeSnapshot {
  name: string;
  scope?: SheetId;
  range: Range;
}Workbook-global or sheet-scoped named range used by formulas and persistence.API reference →[]; };

sheets

sheets: SheetSnapshotinterface SheetSnapshot {
  id: SheetId;
  name: string;
  order: number;
  visibility?: SheetVisibility;
  rowCount: number;
  columns: Column[];
  frozenRows?: number;
  frozenCols?: number;
  rowMeta?: Array<[row: number, meta: RowMetadata]>;
  merges?: MergeRange[];
  conditionalFormats?: ConditionalFormatRule[];
  validationRules?: DataValidationRule[];
  protectedRanges?: ProtectedRange[];
  notes?: CellNote[];
  // … 5 more lines — see the API reference
}interface SheetSnapshot {
  id: SheetId;
  name: string;
  order: number;
  visibility?: SheetVisibility;
  rowCount: number;
  columns: Column[];
  frozenRows?: number;
  frozenCols?: number;
  rowMeta?: Array<[row: number, meta: RowMetadata]>;
  merges?: MergeRange[];
  conditionalFormats?: ConditionalFormatRule[];
  validationRules?: DataValidationRule[];
  protectedRanges?: ProtectedRange[];
  notes?: CellNote[];
  // … 5 more lines — see the API reference
}interface SheetSnapshot {
  id: SheetId;
  name: string;
  order: number;
  visibility?: SheetVisibility;
  rowCount: number;
  columns: Column[];
  frozenRows?: number;
  frozenCols?: number;
  rowMeta?: Array<
    [
      row: number,
      meta: RowMetadata,
    ]
  >;
  merges?: MergeRange[];
  conditionalFormats?: ConditionalFormatRule[];
  validationRules?: DataValidationRule[];
  protectedRanges?: ProtectedRange[];
  // … 11 more lines — see the API reference
}Serializable complete state for one workbook sheet.API reference →[];

Declaration

View full TypeScript declaration

export interface WorkbookSnapshot {
  schemaVersion: 1;
  documentId?: string;
  version?: number;
  workbook: {
    activeSheet: SheetIdtype SheetId = string;type SheetId = string;type SheetId = string;Stable identifier used to address a workbook sheet.API reference →;
    namedRanges?: NamedRangeSnapshotinterface NamedRangeSnapshot {
  name: string;
  scope?: SheetId;
  range: Range;
}interface NamedRangeSnapshot {
  name: string;
  scope?: SheetId;
  range: Range;
}interface NamedRangeSnapshot {
  name: string;
  scope?: SheetId;
  range: Range;
}Workbook-global or sheet-scoped named range used by formulas and persistence.API reference →[];
  };
  sheets: SheetSnapshotinterface SheetSnapshot {
  id: SheetId;
  name: string;
  order: number;
  visibility?: SheetVisibility;
  rowCount: number;
  columns: Column[];
  frozenRows?: number;
  frozenCols?: number;
  rowMeta?: Array<[row: number, meta: RowMetadata]>;
  merges?: MergeRange[];
  conditionalFormats?: ConditionalFormatRule[];
  validationRules?: DataValidationRule[];
  protectedRanges?: ProtectedRange[];
  notes?: CellNote[];
  // … 5 more lines — see the API reference
}interface SheetSnapshot {
  id: SheetId;
  name: string;
  order: number;
  visibility?: SheetVisibility;
  rowCount: number;
  columns: Column[];
  frozenRows?: number;
  frozenCols?: number;
  rowMeta?: Array<[row: number, meta: RowMetadata]>;
  merges?: MergeRange[];
  conditionalFormats?: ConditionalFormatRule[];
  validationRules?: DataValidationRule[];
  protectedRanges?: ProtectedRange[];
  notes?: CellNote[];
  // … 5 more lines — see the API reference
}interface SheetSnapshot {
  id: SheetId;
  name: string;
  order: number;
  visibility?: SheetVisibility;
  rowCount: number;
  columns: Column[];
  frozenRows?: number;
  frozenCols?: number;
  rowMeta?: Array<
    [
      row: number,
      meta: RowMetadata,
    ]
  >;
  merges?: MergeRange[];
  conditionalFormats?: ConditionalFormatRule[];
  validationRules?: DataValidationRule[];
  protectedRanges?: ProtectedRange[];
  // … 11 more lines — see the API reference
}Serializable complete state for one workbook sheet.API reference →[];
}