# GridData

Fields, allowed values, and APIs that use GridData.

Canonical: https://grid.syidax.com/docs/types/GridData/

<a id="definition"></a>

## Type definition

A question mark (?) marks an optional field; readonly marks a value you should not change directly. A union (|) accepts one of the listed forms. Functions are callbacks that Grid invokes at the relevant point.

```typescript
export type GridData = Record<string, unknown>;
```

<a id="used-by"></a>

## APIs using this type

- [rowData](https://grid.syidax.com/docs/options/rowData.md) — The source row array for the table. Pass a new array to replace a complete query result, or use applyTransaction for partial updates.
- [components](https://grid.syidax.com/docs/options/components.md) — Registers local custom renderers, editors, filters, and other components for this Grid.
- [externalFilter](https://grid.syidax.com/docs/options/externalFilter.md) — Determines whether each row passes conditions outside the Grid. Supply activation and row predicates or a lifecycle instance.
- [rowHeightFn](https://grid.syidax.com/docs/options/rowHeightFn.md) — Calculates individual row heights from row indices and data. Call refreshRowHeights when relevant data changes.
- [getRowId](https://grid.syidax.com/docs/options/getRowId.md) — Returns a stable, unique row ID. The same business row must retain its ID after sorting, filtering, and editing.
- [getApi](https://grid.syidax.com/docs/methods/getApi.md) — Accesses the current Grid's typed API and app context. Read from a fully initialized element.
- [getColumn](https://grid.syidax.com/docs/methods/getColumn.md) — Finds a current column object by ID. Returns null for missing columns and reflects live state rather than an initial columnDefs copy.
- [getColumns](https://grid.syidax.com/docs/methods/getColumns.md) — Reads current column objects to connect widths, order, and visibility to your app.
- [getColumnGroup](https://grid.syidax.com/docs/methods/getColumnGroup.md) — Finds a current column group by ID. Returns null if absent.
- [getColumnGroups](https://grid.syidax.com/docs/methods/getColumnGroups.md) — Reads current column group objects.
- [getRow](https://grid.syidax.com/docs/methods/getRow.md) — Finds a row object by stable row ID, rather than display index.
- [getDisplayedRowAtIndex](https://grid.syidax.com/docs/methods/getDisplayedRowAtIndex.md) — Finds a row object by its current display index. Sorting, filtering, and grouping can change the row at an index.
- [forEachRow](https://grid.syidax.com/docs/methods/forEachRow.md) — Runs a callback for each row object. Use forEachDisplayedRow when display order matters.
- [forEachDisplayedRow](https://grid.syidax.com/docs/methods/forEachDisplayedRow.md) — Iterates current displayed rows for app features that distinguish source order from display order.
- [registerGridComponent](https://grid.syidax.com/docs/methods/registerGridComponent.md) — Registers a custom Grid component under the public component contract.
- [replaceGridComponent](https://grid.syidax.com/docs/methods/replaceGridComponent.md) — Replaces a registered custom component definition.
- [getCellRendererInstance](https://grid.syidax.com/docs/methods/getCellRendererInstance.md) — Queries mounted cell renderer instances. Offscreen cells may be unmounted because of virtualization.
- [getCellEditorInstance](https://grid.syidax.com/docs/methods/getCellEditorInstance.md) — Reads the mounted cell editor instance and context, or null if no editor exists.
- [getColumnFilterInstance](https://grid.syidax.com/docs/methods/getColumnFilterInstance.md) — Queries a column's custom filter instance. May return null if absent or not yet created.
- [gridObjectChanged](https://grid.syidax.com/docs/events/gridObjectChanged.md) — Emitted when public objects such as rows and columns change. Read the target and changes from detail.

<a id="parents"></a>

## Contracts containing this type

- [CellCallbackParams](https://grid.syidax.com/docs/types/CellCallbackParams.md)
- [ColumnDef](https://grid.syidax.com/docs/types/ColumnDef.md)
- [GridCellClickedDetail](https://grid.syidax.com/docs/types/GridCellClickedDetail.md)
- [GridCellDoubleClickedDetail](https://grid.syidax.com/docs/types/GridCellDoubleClickedDetail.md)
- [GridCellEditingRequestedDetail](https://grid.syidax.com/docs/types/GridCellEditingRequestedDetail.md)
- [GridCellEditorDeclaration](https://grid.syidax.com/docs/types/GridCellEditorDeclaration.md)
- [GridCellValueChangedDetail](https://grid.syidax.com/docs/types/GridCellValueChangedDetail.md)
- [GridColumnDefinition](https://grid.syidax.com/docs/types/GridColumnDefinition.md)
- [GridColumnGroupDef](https://grid.syidax.com/docs/types/GridColumnGroupDef.md)
- [GridColumnGroupRef](https://grid.syidax.com/docs/types/GridColumnGroupRef.md)
- [GridColumnRef](https://grid.syidax.com/docs/types/GridColumnRef.md)
- [GridLiveObjectEvent](https://grid.syidax.com/docs/types/GridLiveObjectEvent.md)
- [GridLiveObjectListener](https://grid.syidax.com/docs/types/GridLiveObjectListener.md)
- [GridLiveRef](https://grid.syidax.com/docs/types/GridLiveRef.md)
- [GridRemoteEditAppliedDetail](https://grid.syidax.com/docs/types/GridRemoteEditAppliedDetail.md)
- [GridRowClickedDetail](https://grid.syidax.com/docs/types/GridRowClickedDetail.md)
- [GridRowDataChangedDetail](https://grid.syidax.com/docs/types/GridRowDataChangedDetail.md)
- [GridRowRef](https://grid.syidax.com/docs/types/GridRowRef.md)
- [GridRowTransaction](https://grid.syidax.com/docs/types/GridRowTransaction.md)
- [SyGridApi](https://grid.syidax.com/docs/types/SyGridApi.md)
- [SyGridApiPdfDownloadOptions](https://grid.syidax.com/docs/types/SyGridApiPdfDownloadOptions.md)
- [SyGridApiPdfExportOptions](https://grid.syidax.com/docs/types/SyGridApiPdfExportOptions.md)
- [SyGridCellClickedEventDetail](https://grid.syidax.com/docs/types/SyGridCellClickedEventDetail.md)
- [SyGridCellDoubleClickedEventDetail](https://grid.syidax.com/docs/types/SyGridCellDoubleClickedEventDetail.md)
- [SyGridCellEditingRequestedEventDetail](https://grid.syidax.com/docs/types/SyGridCellEditingRequestedEventDetail.md)
- [SyGridCellTooltipTarget](https://grid.syidax.com/docs/types/SyGridCellTooltipTarget.md)
- [SyGridCellValueChangedEventDetail](https://grid.syidax.com/docs/types/SyGridCellValueChangedEventDetail.md)
- [SyGridColSpanParams](https://grid.syidax.com/docs/types/SyGridColSpanParams.md)
- [SyGridCustomEvent](https://grid.syidax.com/docs/types/SyGridCustomEvent.md)
- [SyGridEventListener](https://grid.syidax.com/docs/types/SyGridEventListener.md)
- [SyGridEventMap](https://grid.syidax.com/docs/types/SyGridEventMap.md)
- [SyGridFullWidthRenderParams](https://grid.syidax.com/docs/types/SyGridFullWidthRenderParams.md)
- [SyGridFullWidthRenderer](https://grid.syidax.com/docs/types/SyGridFullWidthRenderer.md)
- [SyGridFullWidthRowInfo](https://grid.syidax.com/docs/types/SyGridFullWidthRowInfo.md)
- [SyGridImperativeMethods](https://grid.syidax.com/docs/types/SyGridImperativeMethods.md)
- [SyGridPinnedRow](https://grid.syidax.com/docs/types/SyGridPinnedRow.md)
- [SyGridPinnedRowChange](https://grid.syidax.com/docs/types/SyGridPinnedRowChange.md)
- [SyGridPinnedRowInfo](https://grid.syidax.com/docs/types/SyGridPinnedRowInfo.md)
- [SyGridPinnedRowInput](https://grid.syidax.com/docs/types/SyGridPinnedRowInput.md)
- [SyGridPinnedRowSetInput](https://grid.syidax.com/docs/types/SyGridPinnedRowSetInput.md)
- [SyGridPinnedRowsChangedDetail](https://grid.syidax.com/docs/types/SyGridPinnedRowsChangedDetail.md)
- [SyGridPinnedRowsReport](https://grid.syidax.com/docs/types/SyGridPinnedRowsReport.md)
- [SyGridPinnedRowsResult](https://grid.syidax.com/docs/types/SyGridPinnedRowsResult.md)
- [SyGridRowClickedEventDetail](https://grid.syidax.com/docs/types/SyGridRowClickedEventDetail.md)
- [SyGridRowDataChangedEventDetail](https://grid.syidax.com/docs/types/SyGridRowDataChangedEventDetail.md)
- [SyGridRowSpanParams](https://grid.syidax.com/docs/types/SyGridRowSpanParams.md)
- [SyGridRowTransactionResult](https://grid.syidax.com/docs/types/SyGridRowTransactionResult.md)
- [ValueFormatterParams](https://grid.syidax.com/docs/types/ValueFormatterParams.md)
- [ValueGetterParams](https://grid.syidax.com/docs/types/ValueGetterParams.md)
- [ValueParserParams](https://grid.syidax.com/docs/types/ValueParserParams.md)
- [ValueSetterParams](https://grid.syidax.com/docs/types/ValueSetterParams.md)