Skip to Content
APIGrid CoreGridSchema

GridSchema type

Schema definition exposed to grid plugins.

Tip

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

View Declaration

export interface GridSchema<C extends PluginConfig = PluginConfig> { /** * The store that contains the schema. */ readonly store: GridStore<C>; id: GridId; rows: GridRows; primaryColumnKey: PrimaryColumnKey; origin: GridSchemaOrigin<C> | null; /** * Gets the cell value for the given {@link GridCellLocation}. */ getCellValue<D extends ColumnDataType>( cell: GridCellLocation, ): ColumnValueByDataType[D]; }

Fields

NameTypeDefault
storeGridStore<C>

The store that contains the schema.

idstring
rowsGridRows
primaryColumnKeystring
originGridSchemaOrigin<C> | null
getCellValue<D extends ColumnDataType>(cell: GridCellLocation) => ColumnValueByDataType[D]

Gets the cell value for the given GridCellLocation.