FilterRowNodesRequest
Request for filterRowNodes.
TypeScript
export interface FilterRowNodesRequest extendsExtends
Properties
| Property | Type | Description |
|---|---|---|
| cellValueOverride | CellValueOverride | Applied to each candidate row as it is evaluated ("which rows would match if this column were this value?"). |
| expression | string | Boolean AdaptableQL Expression to evaluate against each row. |
| rowFilter | (rowNode: IRowNode) => boolean | Extra predicate applied before the expression (logical AND). |
| rowScope | 'all' | 'visible' | Grid-row set to filter. 'all' (default) uses every loaded row;'visible' uses rows the user currently sees. |
Property Details
cellValueOverride
Applied to each candidate row as it is evaluated ("which rows would match if this column were this value?").
TypeScript
cellValueOverride?: CellValueOverride;Property Value
expression
Boolean AdaptableQL Expression to evaluate against each row.
TypeScript
expression: string;Property Value
string
rowFilter
Extra predicate applied before the expression (logical AND).
TypeScript
rowFilter?: (rowNode: IRowNode) => boolean;Property Value
(rowNode: IRowNode) => boolean
rowScope
Grid-row set to filter. 'all' (default) uses every loaded row;
'visible' uses rows the user currently sees.
TypeScript
rowScope?: 'all' | 'visible';Property Value
'all' | 'visible'