syidaxgrid
Home Pricing Settings

API REFERENCE

ValueGetterParams

Fields, allowed values, and APIs that use ValueGetterParams.

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 ValueGetterParams<TData = GridData, TValue = unknown, TContext = unknown> {
  data: Readonly<TData>;
  colDef: ColumnDef<TData, TValue, TContext>;
  rowIndex: number;
  context: TContext;
  api: SyGridApi<TData, TContext>;
  node: { rowIndex: number; rowId?: string | number };
  colId: string;
  getValue: (otherColId: string) => unknown;
}

APIs using this type

  • valueGetter

    Returns a cell value calculated from the source row. Use valueFormatter for display-text changes only.

  • tooltipValueGetter

    Calculates tooltip content from the current cell context. Do not expose unauthorized values indirectly.

Contracts containing this type