# ValueGetterParams

Fields, allowed values, and APIs that use ValueGetterParams.

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

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

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

## APIs using this type

- [valueGetter](https://grid.syidax.com/docs/columns/valueGetter.md) — Returns a cell value calculated from the source row. Use valueFormatter for display-text changes only.
- [tooltipValueGetter](https://grid.syidax.com/docs/columns/tooltipValueGetter.md) — Calculates tooltip content from the current cell context. Do not expose unauthorized values indirectly.

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

## Contracts containing this type

- [ColumnDef](https://grid.syidax.com/docs/types/ColumnDef.md)

<a id="related"></a>

## Related types

- [GridData](https://grid.syidax.com/docs/types/GridData.md)
- [ColumnDef](https://grid.syidax.com/docs/types/ColumnDef.md)
- [SyGridApi](https://grid.syidax.com/docs/types/SyGridApi.md)