AdaptablePredicateDef
Defines a Predicate - include where it can run and what it does
TypeScript
export interfaceProperties
| Property | Type | Description |
|---|---|---|
| columnScope | ColumnScope | Columns (or DataTypes) where Predicate is active |
| handler | (params:PredicateDefHandlerContext) => boolean | Actual boolean function invoked when evaluating the Predicate |
| icon | AdaptableIcon | \{ text: string; \} | Icon to show (primarily used in Filter dropdown) |
| id | PREDICATE_TYPE | Predicate Id |
| inputs | PredicateDefInput[] | Inputs the Predicate can take |
| label | string | Name of the Predicate |
| moduleScope | PredicateModuleScope[] | Modules where Predicate can run |
| shortcuts | string[] | Keyboard shortcuts to initiate predicate - used in Quick Filter bar |
| toString | (params:PredicateDefToStringParams) => string | String representation of the Predicate |
Property Details
columnScope
Columns (or DataTypes) where Predicate is active
TypeScript
columnScope: ColumnScope;Property Value
handler
Actual boolean function invoked when evaluating the Predicate
TypeScript
handler: (params: PredicateDefHandlerContext) => boolean;Property Value
(params:PredicateDefHandlerContext) => boolean
icon
Icon to show (primarily used in Filter dropdown)
TypeScript
icon?: AdaptableIcon | {
text: string;
};Property Value
AdaptableIcon | \{ text: string; \}
id
Predicate Id
TypeScript
id: PREDICATE_TYPE;Property Value
PREDICATE_TYPE
inputs
Inputs the Predicate can take
TypeScript
inputs?: PredicateDefInput[];Property Value
label
Name of the Predicate
TypeScript
label: string;Property Value
string
moduleScope
Modules where Predicate can run
TypeScript
moduleScope: PredicateModuleScope[];Property Value
shortcuts
Keyboard shortcuts to initiate predicate - used in Quick Filter bar
TypeScript
shortcuts?: string[];Property Value
string[]
toString
String representation of the Predicate
TypeScript
toString?: (params: PredicateDefToStringParams) => string;Property Value
(params:PredicateDefToStringParams) => string