SimpleColumn | @sheetwrite/core/adapter

Column definition accepted by the adapters’ simple row-object API.

Package: @sheetwrite/core/adapter
Source: packages/core/src/adapter.ts#L161

Members 8

key Non-empty row-object key, unique within the column list.

key: keyof Row & string;

title Schema header label used by exports.

title: string;

width Unzoomed width in CSS pixels; defaults to 120.

width?: number;

type Input and formatting type; defaults to text.

type?: CellFormattype CellFormat = "text" | "number" | "date" | "currency";type CellFormat = "text" | "number" | "date" | "currency";type CellFormat =
  | "text"
  | "number"
  | "date"
  | "currency";How a column's cells are typed, parsed, and rendered: text verbatim, number via its numberFormat, date as an Excel-style serial (see date-serial.ts) rendered by a date numberFormat, and currency as a plain number rendered by a currency numberFormat (e.g. $#,##0.00).API reference →;

numberFormat Excel number-format code used for number, date, or currency display.

numberFormat?: string;

headerStyle Style applied to the painted column-letter header.

headerStyle?: CellStyleinterface CellStyle {
  bold?: boolean;
  italic?: boolean;
  underline?: boolean;
  strikethrough?: boolean;
  fontSize?: number;
  color?: string;
  backgroundColor?: string;
  align?: CellAlign;
  wrap?: boolean;
  border?: CellBorders;
}interface CellStyle {
  bold?: boolean;
  italic?: boolean;
  underline?: boolean;
  strikethrough?: boolean;
  fontSize?: number;
  color?: string;
  backgroundColor?: string;
  align?: CellAlign;
  wrap?: boolean;
  border?: CellBorders;
}interface CellStyle {
  bold?: boolean;
  italic?: boolean;
  underline?: boolean;
  strikethrough?: boolean;
  fontSize?: number;
  color?: string;
  backgroundColor?: string;
  align?: CellAlign;
  wrap?: boolean;
  border?: CellBorders;
}Serializable formatting applied to a cell or used as a column default.API reference →;

cellStyle Base style merged beneath cell-specific styles.

cellStyle?: CellStyleinterface CellStyle {
  bold?: boolean;
  italic?: boolean;
  underline?: boolean;
  strikethrough?: boolean;
  fontSize?: number;
  color?: string;
  backgroundColor?: string;
  align?: CellAlign;
  wrap?: boolean;
  border?: CellBorders;
}interface CellStyle {
  bold?: boolean;
  italic?: boolean;
  underline?: boolean;
  strikethrough?: boolean;
  fontSize?: number;
  color?: string;
  backgroundColor?: string;
  align?: CellAlign;
  wrap?: boolean;
  border?: CellBorders;
}interface CellStyle {
  bold?: boolean;
  italic?: boolean;
  underline?: boolean;
  strikethrough?: boolean;
  fontSize?: number;
  color?: string;
  backgroundColor?: string;
  align?: CellAlign;
  wrap?: boolean;
  border?: CellBorders;
}Serializable formatting applied to a cell or used as a column default.API reference →;

visible Set to false to exclude the column from the live view and table exports.

visible?: boolean;

Declaration

View full TypeScript declaration

export interface SimpleColumn<Row extends Record<string, CellScalartype CellScalar = string | number | boolean | null;type CellScalar = string | number | boolean | null;type CellScalar =
  | string
  | number
  | boolean
  | null;A scalar that can be displayed directly.API reference →>> {
  key: keyof Row & string;
  title: string;
  width?: number;
  type?: CellFormattype CellFormat = "text" | "number" | "date" | "currency";type CellFormat = "text" | "number" | "date" | "currency";type CellFormat =
  | "text"
  | "number"
  | "date"
  | "currency";How a column's cells are typed, parsed, and rendered: text verbatim, number via its numberFormat, date as an Excel-style serial (see date-serial.ts) rendered by a date numberFormat, and currency as a plain number rendered by a currency numberFormat (e.g. $#,##0.00).API reference →;
  numberFormat?: string;
  headerStyle?: CellStyleinterface CellStyle {
  bold?: boolean;
  italic?: boolean;
  underline?: boolean;
  strikethrough?: boolean;
  fontSize?: number;
  color?: string;
  backgroundColor?: string;
  align?: CellAlign;
  wrap?: boolean;
  border?: CellBorders;
}interface CellStyle {
  bold?: boolean;
  italic?: boolean;
  underline?: boolean;
  strikethrough?: boolean;
  fontSize?: number;
  color?: string;
  backgroundColor?: string;
  align?: CellAlign;
  wrap?: boolean;
  border?: CellBorders;
}interface CellStyle {
  bold?: boolean;
  italic?: boolean;
  underline?: boolean;
  strikethrough?: boolean;
  fontSize?: number;
  color?: string;
  backgroundColor?: string;
  align?: CellAlign;
  wrap?: boolean;
  border?: CellBorders;
}Serializable formatting applied to a cell or used as a column default.API reference →;
  cellStyle?: CellStyleinterface CellStyle {
  bold?: boolean;
  italic?: boolean;
  underline?: boolean;
  strikethrough?: boolean;
  fontSize?: number;
  color?: string;
  backgroundColor?: string;
  align?: CellAlign;
  wrap?: boolean;
  border?: CellBorders;
}interface CellStyle {
  bold?: boolean;
  italic?: boolean;
  underline?: boolean;
  strikethrough?: boolean;
  fontSize?: number;
  color?: string;
  backgroundColor?: string;
  align?: CellAlign;
  wrap?: boolean;
  border?: CellBorders;
}interface CellStyle {
  bold?: boolean;
  italic?: boolean;
  underline?: boolean;
  strikethrough?: boolean;
  fontSize?: number;
  color?: string;
  backgroundColor?: string;
  align?: CellAlign;
  wrap?: boolean;
  border?: CellBorders;
}Serializable formatting applied to a cell or used as a column default.API reference →;
  visible?: boolean;
}