syidaxgrid
Home Pricing Settings

API REFERENCE

GridRow

Fields, allowed values, and APIs that use GridRow.

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 interface GridRow {
  [key: string]: string | number | boolean | null;
}

APIs using this type

  • serverSideDatasource

    Data provider for a row model where the server handles sorting, filtering, grouping, and related requests.

  • viewportDatasource

    Viewport model supplying data for visible row ranges. Implement initialization, range changes, and cleanup.

  • contextMenuItemsCallback

    Returns cell context-menu items. Replaces the entire default list rather than appending to it.

  • rows

    Compatibility input for source rows. Prefer rowData in new configurations and avoid conflicting inputs.

  • isFullWidthRow

    Determines whether a row uses a full-width layout instead of individual column cells.

  • fullWidthCellRenderer

    Renderer for full-width row content. Uses a different input contract from regular cell renderers.

  • fullWidthRowHeight

    Fixed height or per-row height function for full-width rows.

  • pinnedTopRowData

    Row data pinned above the scrolling table.

  • pinnedBottomRowData

    Row data pinned below the scrolling table.

  • diffSnapshots

    Compares two snapshots or a snapshot with current data. Omit the second ID to compare against current data.

  • applyTransaction

    Adds, updates, and removes source rows by stable ID. Inspect results separately from app server saving.

  • getDataAsCsv

    Returns an object with CSV text and output row/column counts. Read the string from its csv field.

  • exportDataAsCsv

    Downloads CSV using current export conditions and returns the export result.

  • getFullWidthRowInfo

    Reads one full-width row's information, or the complete layout report when no argument is supplied.

  • setPinnedRows

    Sets top/bottom pinned row data and returns the application result.

  • getPinnedRows

    Reads current pinned row data as a report.

  • getPinnedRowInfo

    Reads details of a specified pinned row.

  • detailRowCreated

    Emitted when a detail panel is created. Connect app resources using its row ID and parent data.

  • pinnedRowsChanged

    Emitted when top/bottom pinned row data changes.

Contracts containing this type