SimpleColumn | @sheetwrite/core/adapter

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

Source: packages/core/src/adapter.ts#L400

Members 9

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

key: keyof Row & string;

title Semantic title painted in data-grid mode and written by table exports.

title: string;

width Unzoomed width in CSS pixels; defaults to 120.

width?: number;

type Input and formatting type; defaults to text.

type?: CellFormat;

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

numberFormat?: string;

headerStyle Style applied to the painted column header.

headerStyle?: CellStyle;

editor Name of a custom editor registered through GridOptions.editors.

editor?: string;

cellStyle Base style merged beneath cell-specific styles.

cellStyle?: CellStyle;

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, CellScalar>> {
  key: keyof Row & string;
  title: string;
  width?: number;
  type?: CellFormat;
  numberFormat?: string;
  headerStyle?: CellStyle;
  editor?: string;
  cellStyle?: CellStyle;
  visible?: boolean;
}

Referenced by

Workspace packages depending on @sheetwrite/core

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

Public exports naming SimpleColumn

SimpleSheetwriteOptions@sheetwrite/core
SheetwriteProps@sheetwrite/react
SheetwriteProps@sheetwrite/svelte
SheetwriteProps@sheetwrite/vue

Loading documentation…