syidaxgrid
Home Pricing Settings

API REFERENCE

GridData

Fields, allowed values, and APIs that use GridData.

Markdown source Features

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>;

APIs using this type

  • rowData

    The source row array for the table. Pass a new array to replace a complete query result, or use applyTransaction for partial updates.

  • components

    Registers local custom renderers, editors, filters, and other components for this Grid.

  • externalFilter

    Determines whether each row passes conditions outside the Grid. Supply activation and row predicates or a lifecycle instance.

  • rowHeightFn

    Calculates individual row heights from row indices and data. Call refreshRowHeights when relevant data changes.

  • getRowId

    Returns a stable, unique row ID. The same business row must retain its ID after sorting, filtering, and editing.

  • getApi

    Accesses the current Grid's typed API and app context. Read from a fully initialized element.

  • getColumn

    Finds a current column object by ID. Returns null for missing columns and reflects live state rather than an initial columnDefs copy.

  • getColumns

    Reads current column objects to connect widths, order, and visibility to your app.

  • getColumnGroup

    Finds a current column group by ID. Returns null if absent.

  • getColumnGroups

    Reads current column group objects.

  • getRow

    Finds a row object by stable row ID, rather than display index.

  • getDisplayedRowAtIndex

    Finds a row object by its current display index. Sorting, filtering, and grouping can change the row at an index.

  • forEachRow

    Runs a callback for each row object. Use forEachDisplayedRow when display order matters.

  • forEachDisplayedRow

    Iterates current displayed rows for app features that distinguish source order from display order.

  • registerGridComponent

    Registers a custom Grid component under the public component contract.

  • replaceGridComponent

    Replaces a registered custom component definition.

  • getCellRendererInstance

    Queries mounted cell renderer instances. Offscreen cells may be unmounted because of virtualization.

  • getCellEditorInstance

    Reads the mounted cell editor instance and context, or null if no editor exists.

  • getColumnFilterInstance

    Queries a column's custom filter instance. May return null if absent or not yet created.

  • gridObjectChanged

    Emitted when public objects such as rows and columns change. Read the target and changes from detail.

Contracts containing this type