grid-pro.gridpro.mergeallcolumndefsandstates

Home > @genesislcap/grid-pro > GridPro > mergeAllColumnDefsAndStates

GridPro.mergeAllColumnDefsAndStates() method

Will merge templated column definitions with columnDefs plus localStorage's column state or deferredColumnStates.

Signature:

mergeAllColumnDefsAndStates(columnDefs: ColDef[], deferredColumnDefsOrState?: boolean): Promise<ColDef<any>[]>;

Parameters

Parameter	Type	Description
columnDefs	ColDef[]	The column definitions to apply to the grid.
deferredColumnDefsOrState	boolean	(Optional) If true, will merge the column definitions with the saved column state or the deferredColumnStates property on the grid-pro-genesis-datasource element. Defaults to false but grid-pro-genesis-datasource will set this to true.

Returns:

Promise<ColDef<any>[]>

The merged column definitions.

Remarks

This will favor the column state from the browser's local storage over the deferredColumnStates property on the grid-pro-genesis-datasource element.