WorkbookTable | @sheetwrite/core

Serializable canonical workbook table. Its range includes header/totals rows.

Package: @sheetwrite/core
Source: packages/core/src/types/table.ts#L38

Members 8

id

id: WorkbookTableIdtype WorkbookTableId = string;type WorkbookTableId = string;type WorkbookTableId = string;Stable identity for a workbook table. Names may change; IDs never do.API reference →;

name Workbook-global, case-insensitively unique structured-reference name.

name: string;

range Inclusive table rectangle on one stable sheet ID.

range: Rangeinterface Range {
  sheet: SheetId;
  start: { row: number; col: number };
  end: { row: number; col: number };
}interface Range {
  sheet: SheetId;
  start: { row: number; col: number };
  end: { row: number; col: number };
}interface Range {
  sheet: SheetId;
  start: {
    row: number;
    col: number;
  };
  end: {
    row: number;
    col: number;
  };
}Inclusive rectangular cell range on a stable sheet ID.API reference →;

columns Ordered stable columns; length is exactly the table rectangle width.

columns: WorkbookTableColumninterface WorkbookTableColumn {
  id: string;
  name: string;
  totalsRowLabel?: string;
}interface WorkbookTableColumn {
  id: string;
  name: string;
  totalsRowLabel?: string;
}interface WorkbookTableColumn {
  id: string;
  name: string;
  totalsRowLabel?: string;
}Stable identity and display metadata for one ordered table column.API reference →[];

headerRow Whether the first range row is the structured-reference header row.

headerRow: boolean;

totalsRow Whether the last range row is the structured-reference totals row.

totalsRow: boolean;

style

style?: WorkbookTableStyleinterface WorkbookTableStyle {
  name?: string;
  showFirstColumn?: boolean;
  showLastColumn?: boolean;
  showRowStripes?: boolean;
  showColumnStripes?: boolean;
}interface WorkbookTableStyle {
  name?: string;
  showFirstColumn?: boolean;
  showLastColumn?: boolean;
  showRowStripes?: boolean;
  showColumnStripes?: boolean;
}interface WorkbookTableStyle {
  name?: string;
  showFirstColumn?: boolean;
  showLastColumn?: boolean;
  showRowStripes?: boolean;
  showColumnStripes?: boolean;
}Bounded native subset of ECMA-376 table style information.API reference →;

unsupportedFeatures

unsupportedFeatures?: WorkbookTableUnsupportedFeaturetype WorkbookTableUnsupportedFeature =
  | "auto-filter"
  | "sort-state"
  | "calculated-columns"
  | "totals-functions"
  | "query-table"
  | "external-data"
  | "extensions";type WorkbookTableUnsupportedFeature =
  | "auto-filter"
  | "sort-state"
  | "calculated-columns"
  | "totals-functions"
  | "query-table"
  | "external-data"
  | "extensions";type WorkbookTableUnsupportedFeature =
  | "auto-filter"
  | "sort-state"
  | "calculated-columns"
  | "totals-functions"
  | "query-table"
  | "external-data"
  | "extensions";OOXML table features deliberately retained as explicit loss metadata rather than silently flattened into an ordinary range.API reference →[];

Declaration

View full TypeScript declaration

export interface WorkbookTable {
  id: WorkbookTableIdtype WorkbookTableId = string;type WorkbookTableId = string;type WorkbookTableId = string;Stable identity for a workbook table. Names may change; IDs never do.API reference →;
  name: string;
  range: Rangeinterface Range {
  sheet: SheetId;
  start: { row: number; col: number };
  end: { row: number; col: number };
}interface Range {
  sheet: SheetId;
  start: { row: number; col: number };
  end: { row: number; col: number };
}interface Range {
  sheet: SheetId;
  start: {
    row: number;
    col: number;
  };
  end: {
    row: number;
    col: number;
  };
}Inclusive rectangular cell range on a stable sheet ID.API reference →;
  columns: WorkbookTableColumninterface WorkbookTableColumn {
  id: string;
  name: string;
  totalsRowLabel?: string;
}interface WorkbookTableColumn {
  id: string;
  name: string;
  totalsRowLabel?: string;
}interface WorkbookTableColumn {
  id: string;
  name: string;
  totalsRowLabel?: string;
}Stable identity and display metadata for one ordered table column.API reference →[];
  headerRow: boolean;
  totalsRow: boolean;
  style?: WorkbookTableStyleinterface WorkbookTableStyle {
  name?: string;
  showFirstColumn?: boolean;
  showLastColumn?: boolean;
  showRowStripes?: boolean;
  showColumnStripes?: boolean;
}interface WorkbookTableStyle {
  name?: string;
  showFirstColumn?: boolean;
  showLastColumn?: boolean;
  showRowStripes?: boolean;
  showColumnStripes?: boolean;
}interface WorkbookTableStyle {
  name?: string;
  showFirstColumn?: boolean;
  showLastColumn?: boolean;
  showRowStripes?: boolean;
  showColumnStripes?: boolean;
}Bounded native subset of ECMA-376 table style information.API reference →;
  unsupportedFeatures?: WorkbookTableUnsupportedFeaturetype WorkbookTableUnsupportedFeature =
  | "auto-filter"
  | "sort-state"
  | "calculated-columns"
  | "totals-functions"
  | "query-table"
  | "external-data"
  | "extensions";type WorkbookTableUnsupportedFeature =
  | "auto-filter"
  | "sort-state"
  | "calculated-columns"
  | "totals-functions"
  | "query-table"
  | "external-data"
  | "extensions";type WorkbookTableUnsupportedFeature =
  | "auto-filter"
  | "sort-state"
  | "calculated-columns"
  | "totals-functions"
  | "query-table"
  | "external-data"
  | "extensions";OOXML table features deliberately retained as explicit loss metadata rather than silently flattened into an ordinary range.API reference →[];
}