@sheetwrite/coreinterface
Live workbook schema containing ordered sheets and the active sheet ID.
- Package
@sheetwrite/core- Source
packages/core/src/types/document.ts#L75
Members 3
sheets Sheets in display/tab order.
sheets: 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 →[];activeSheet Active sheet ID and initial tab presented when the grid is created.
activeSheet: SheetIdtype SheetId = string;type SheetId = string;type SheetId = string;Stable identifier used to address a workbook sheet.API reference →;namedRanges Formula names shared by the workbook or shadowed within a sheet scope.
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 →[];Declaration
View full TypeScript declaration
export interface Workbook { sheets: 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 →[]; 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 →[];}