API REFERENCE
ValueSetterParams
Fields, allowed values, and APIs that use ValueSetterParams.
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.
export interface ValueSetterParams<TData = GridData, TValue = unknown, TContext = unknown> {
newValue: TValue;
oldValue: TValue;
field: GridFieldPath<TData>;
data: TData;
colDef: ColumnDef<TData, TValue, TContext>;
context: TContext;
api: SyGridApi<TData, TContext>;
rowIndex: number;
sourceRowIndex?: number;
colId: string;
}APIs using this type
- valueSetter
Custom logic for writing a converted value into the source row. Follow the return contract indicating whether a change occurred.