PredicateOptions
Options for managing Adaptable Predicates using AdaptableQL
export interfaceProperties
| Property | Description | Default |
|---|---|---|
| caseSensitivePredicates | Perform case-sensitive text comparisons when evaluating Predicates | false |
| customPredicateDefs | Definitions for Custom provided Predicates | |
| evaluateInPredicateUsingTime | Should In Predicate evaluate using datetime, rather than date (the default) | false |
| systemAlertPredicates | Which System Predicates are available in Alert Module | |
| systemBadgeStylePredicates | Which System Predicates are available for Badge Styles | |
| systemFilterPredicates | Which System Predicates are available when Filtering | |
| systemFlashingCellPredicates | Which System Predicates are available in Flashing Cell Module | |
| systemFormatColumnPredicates | Which System Predicates are available in Format Column Module |
Property Details
caseSensitivePredicates
Perform case-sensitive text comparisons when evaluating Predicates
caseSensitivePredicates?: boolean | ((context: AdaptableColumnContext) => boolean);Default Value
false
Property Value
boolean | ((context:AdaptableColumnContext) => boolean)
customPredicateDefs
Definitions for Custom provided Predicates
customPredicateDefs?: (AdaptablePredicateDef | AdaptablePredicateDefPartialWithExtends)[];Property Value
(AdaptablePredicateDef | AdaptablePredicateDefPartialWithExtends)[]
evaluateInPredicateUsingTime
Should In Predicate evaluate using datetime, rather than date (the default)
evaluateInPredicateUsingTime?: boolean | ((context: AdaptableColumnContext) => boolean);Default Value
false
Property Value
boolean | ((context:AdaptableColumnContext) => boolean)
systemAlertPredicates
Which System Predicates are available in Alert Module
systemAlertPredicates?: SystemAlertPredicateIds | ((context: SystemPredicatesContext<SystemAlertPredicateId>) => SystemAlertPredicateIds);Property Value
SystemAlertPredicateIds| ((context:SystemPredicatesContext<SystemAlertPredicateId>) =>SystemAlertPredicateIds)
systemBadgeStylePredicates
Which System Predicates are available for Badge Styles
systemBadgeStylePredicates?: SystemBadgeStylePredicateIds | ((context: SystemPredicatesContext<SystemBadgeStylePredicateId>) => SystemBadgeStylePredicateIds);Property Value
SystemBadgeStylePredicateIds| ((context:SystemPredicatesContext<SystemBadgeStylePredicateId>) =>SystemBadgeStylePredicateIds)
systemFilterPredicates
Which System Predicates are available when Filtering
systemFilterPredicates?: SystemFilterPredicateIds | ((context: SystemPredicatesContext<SystemFilterPredicateId>) => SystemFilterPredicateIds);Property Value
SystemFilterPredicateIds| ((context:SystemPredicatesContext<SystemFilterPredicateId>) =>SystemFilterPredicateIds)
systemFlashingCellPredicates
Which System Predicates are available in Flashing Cell Module
systemFlashingCellPredicates?: SystemFlashingCellPredicateIds | ((context: SystemPredicatesContext<SystemFlashingCellPredicateId>) => SystemFlashingCellPredicateIds);Property Value
SystemFlashingCellPredicateIds| ((context:SystemPredicatesContext<SystemFlashingCellPredicateId>) =>SystemFlashingCellPredicateIds)
systemFormatColumnPredicates
Which System Predicates are available in Format Column Module
systemFormatColumnPredicates?: SystemFormatColumnPredicateIds | ((context: SystemPredicatesContext<SystemFormatColumnPredicateId>) => SystemFormatColumnPredicateIds);Property Value
SystemFormatColumnPredicateIds| ((context:SystemPredicatesContext<SystemFormatColumnPredicateId>) =>SystemFormatColumnPredicateIds)