AdaptableQL Predicate Technical Reference
Summary
- The Predicate Options section in Adaptable Options contains many properties to configure Predicates
- The Predicate API section of AdapTable API provides run-time access to Predicates
Predicate Options
The Predicate Options section of Adaptable Options provides options for managing Predicates.
This includes Custom Predicate Definitions and a set of functions which limit which System Predicates are available.
| Property | Type | Description | Default |
|---|---|---|---|
| caseSensitivePredicates | boolean | ((context:AdaptableColumnContext) => boolean) | Perform case-sensitive text comparisons when evaluating Predicates | false |
| customPredicateDefs | (AdaptablePredicateDef | AdaptablePredicateDefPartialWithExtends)[] | Definitions for Custom provided Predicates | [] |
| evaluateInPredicateUsingTime | boolean | ((context:AdaptableColumnContext) => boolean) | Should In Predicate evaluate using datetime, rather than date (the default) | false |
| systemAlertPredicates | SystemAlertPredicateIds| ((context:SystemPredicatesContext<SystemAlertPredicateId>) =>SystemAlertPredicateIds) | Which System Predicates are available in Alert Module | all SystemAlertPredicateIds |
| systemBadgeStylePredicates | SystemBadgeStylePredicateIds| ((context:SystemPredicatesContext<SystemBadgeStylePredicateId>) =>SystemBadgeStylePredicateIds) | Which System Predicates are available for Badge Styles | all SystemBadgeStylePredicateIds |
| systemFilterPredicates | SystemFilterPredicateIds| ((context:SystemPredicatesContext<SystemFilterPredicateId>) =>SystemFilterPredicateIds) | Which System Predicates are available when Filtering | all SystemFilterPredicateIds |
| systemFlashingCellPredicates | SystemFlashingCellPredicateIds| ((context:SystemPredicatesContext<SystemFlashingCellPredicateId>) =>SystemFlashingCellPredicateIds) | Which System Predicates are available in Flashing Cell Module | all SystemFlashingCellPredicateIds |
| systemFormatColumnPredicates | SystemFormatColumnPredicateIds| ((context:SystemPredicatesContext<SystemFormatColumnPredicateId>) =>SystemFormatColumnPredicateIds) | Which System Predicates are available in Format Column Module | all SystemFormatColumnPredicateIds |
Predicate API
The Predicate API section of Adaptable API provides run-time access to Predicates:
| Method | Returns | Description |
|---|---|---|
| getCustomPredicateDefById(predicateId) | AdaptablePredicateDef | Gets Predicate Definition provided by users for given Id |
| getCustomPredicateDefs() | AdaptablePredicateDef[] | Returns Predicate Definitions provided by users |
| getPredicateDefById(predicateId) | AdaptablePredicateDef | Gets the Predicate Definition for a given Id |
| getPredicateDefs() | AdaptablePredicateDef[] | Returns all current Predicate Definitions |
| getPredicateDefsByModuleScope(moduleScope) | AdaptablePredicateDef[] | Retrieves all Predicate Definitions for given Module Scope |
| getSystemPredicateDefById(predicateId) | AdaptablePredicateDef | Gets Predicate Definition provided by AdapTable for given Id |
| getSystemPredicateDefs() | AdaptablePredicateDef[] | Returns Predicate Definitions provided by AdapTable |
| getSystemPredicateDefsByModuleScope(moduleScope) | AdaptablePredicateDef<PREDICATE_TYPE>[] | Returns Predicate Definitions provided by AdapTable for given Module Scope |
| handleColumnPredicate(predicate, params, defaultReturn) | boolean | Same has handle predicate but it tales into account predicate column id. |
| handleColumnPredicates(predicate, params, defaultReturn) | boolean | Same has handle predicates but it tales into account predicate column id. |
| handlePredicate(predicate, params, defaultReturn) | boolean | Main Handler function for a Predicate Definition - used by AdapTableQL |
| handlePredicates(predicates, params, defaultReturn) | boolean | Handle and compose (with AND) the given Predicate Definitions |
| isEveryPredicateValid(predicates) | boolean | Checks if all predicates are valid |
| isValidPredicate(predicate) | boolean | Checks whether a given Predicate Definition is valid |
| predicatesToString(predicates, logicalOperator) | string | Stringifies a list of Predicate Definitions, using the given logical operator (AND/OR) |
| predicateToString(predicate) | string | Stringifies a given Predicate Definition |
| useCaseSensitivity(columnId) | boolean | Whether Predicates are evaluated using Case Sensitivity |