Skip to Content
APIGrid CoreColumnGeneratorParams

ColumnGeneratorParams type

Parameters supplied to a ColumnGenerator.

Tip

This API reference is automatically generated from the source code  of the @jsoc/grid-core  package.

View Declaration

export type ColumnGeneratorParams< C extends PluginConfig, D extends ColumnDataType, > = { /** * `ColumnKey` of the column for which the column definition needs to be generated */ columnKey: ColumnKey; /** * `ColumnDataType` of the column */ columnDataType: D; /** * {@link GridSchema} that this column belongs to. */ gridSchema: GridSchema<C>; };

Fields

NameTypeDefault
columnKeystring

ColumnKey of the column for which the column definition needs to be generated

columnDataTypeD

ColumnDataType of the column

gridSchemaGridSchema<C>

GridSchema that this column belongs to.