Skip to Content
APIAG GridPluginConfigAg

PluginConfigAg type

Tip

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

View Declaration

export type PluginConfigAg = PluginConfig<ColDefAg> &
  Pick<
    AgGridReactProps<GridRow>,
    "rowData" | "columnDefs" | "getRowId" | "suppressFieldDotNotation"
  >;

Fields

NameTypeDefault
__columnTypeColDefAg

Internal property used to store the column definition type of the grid plugin. This is solely for type inference and not a valid property of the plugin config.

rowDataUJSONObject[] | null

Set the data to be displayed as rows in the grid.

columnDefs(ColDef<UJSONObject, any> | ColGroupDef<UJSONObject>)[] | null

Array of Column / Column Group definitions.

getRowIdGetRowIdFunc<UJSONObject, any>

Provide a pure function that returns a string ID to uniquely identify a given row. This enables the grid to work optimally with data changes and updates.

suppressFieldDotNotationboolean

If true, then dots in field names (e.g. 'address.firstLine') are not treated as deep references. Allows you to use dots in your field name if you prefer.

false
useGridStoreAnt Design Table