Skip to content
Sheetwritev0.5.1

Column@sheetwrite/core

On this page
@sheetwrite/coreinterface

Schema and default presentation for one workbook column.

Source
packages/core/src/types/cell.ts#L107

Members 11

key Non-empty key, unique within the sheet, used to map input and datasource values. 
key: string;
header Schema label used by table exports and data-grid presentation headers. 
header: string;
width Unzoomed column width in CSS pixels. 
width: number;
type Controls cell input parsing and default value formatting for this column. 
type: CellFormat;
numberFormat Excel number-format code, e.g. 
numberFormat?: string;

Excel number-format code, e.g. "#,##0.00"

numberLocale Explicit BCP 47 locale for separators; omitted keeps the deterministic default. 
numberLocale?: string;
headerStyle Overrides theme styling for the painted column header. 
headerStyle?: CellStyle;
cellStyle Base style merged beneath each cell's own style. 
cellStyle?: CellStyle;
visible Set to false to exclude the column from the live view and table exports. 
visible?: boolean;
renderer Name of a registered custom cell renderer (see Grid.defineCellRenderer). 
renderer?: string;
editor Name of a registered custom editor (see GridOptions.editors). 
editor?: string;

Declaration

View full TypeScript declaration 
export interface Column {
  key: string;
  header: string;
  width: number;
  type: CellFormat;
  numberFormat?: string;
  numberLocale?: string;
  headerStyle?: CellStyle;
  cellStyle?: CellStyle;
  visible?: boolean;
  renderer?: string;
  editor?: string;
}

Referenced by

Workspace packages depending on @sheetwrite/core

  • @sheetwrite/benchdependency
  • @sheetwrite/docs-startdependency
  • @sheetwrite/reactdependency
  • @sheetwrite/sveltedependency
  • @sheetwrite/vuedependency
  • @sheetwrite/xlsxdependency

Public exports naming Column

Documentation