Options for managing Adaptable Predicates using AdaptableQL

TypeScript
export interface

Properties

PropertyDescriptionDefault
caseSensitivePredicatesPerform case-sensitive text comparisons when evaluating Predicatesfalse
customPredicateDefsDefinitions for Custom provided Predicates
evaluateInPredicateUsingTimeShould In Predicate evaluate using datetime, rather than date (the default)false
systemAlertPredicatesWhich System Predicates are available in Alert Module
systemBadgeStylePredicatesWhich System Predicates are available for Badge Styles
systemFilterPredicatesWhich System Predicates are available when Filtering
systemFlashingCellPredicatesWhich System Predicates are available in Flashing Cell Module
systemFormatColumnPredicatesWhich System Predicates are available in Format Column Module

Property Details

caseSensitivePredicates

Perform case-sensitive text comparisons when evaluating Predicates

TypeScript
caseSensitivePredicates?: boolean | ((context: AdaptableColumnContext) => boolean);
Default Value

false

Property Value

boolean | ((context:AdaptableColumnContext) => boolean)

customPredicateDefs

Definitions for Custom provided Predicates

TypeScript
customPredicateDefs?: (AdaptablePredicateDef | AdaptablePredicateDefPartialWithExtends)[];
Property Value

(AdaptablePredicateDef | AdaptablePredicateDefPartialWithExtends)[]

evaluateInPredicateUsingTime

Should In Predicate evaluate using datetime, rather than date (the default)

TypeScript
evaluateInPredicateUsingTime?: boolean | ((context: AdaptableColumnContext) => boolean);
Default Value

false

Property Value

boolean | ((context:AdaptableColumnContext) => boolean)

systemAlertPredicates

Which System Predicates are available in Alert Module

TypeScript
systemAlertPredicates?: SystemAlertPredicateIds | ((context: SystemPredicatesContext<SystemAlertPredicateId>) => SystemAlertPredicateIds);
Property Value

SystemAlertPredicateIds| ((context:SystemPredicatesContext<SystemAlertPredicateId>) =>SystemAlertPredicateIds)

systemBadgeStylePredicates

Which System Predicates are available for Badge Styles

TypeScript
systemBadgeStylePredicates?: SystemBadgeStylePredicateIds | ((context: SystemPredicatesContext<SystemBadgeStylePredicateId>) => SystemBadgeStylePredicateIds);
Property Value

SystemBadgeStylePredicateIds| ((context:SystemPredicatesContext<SystemBadgeStylePredicateId>) =>SystemBadgeStylePredicateIds)

systemFilterPredicates

Which System Predicates are available when Filtering

TypeScript
systemFilterPredicates?: SystemFilterPredicateIds | ((context: SystemPredicatesContext<SystemFilterPredicateId>) => SystemFilterPredicateIds);
Property Value

SystemFilterPredicateIds| ((context:SystemPredicatesContext<SystemFilterPredicateId>) =>SystemFilterPredicateIds)

systemFlashingCellPredicates

Which System Predicates are available in Flashing Cell Module

TypeScript
systemFlashingCellPredicates?: SystemFlashingCellPredicateIds | ((context: SystemPredicatesContext<SystemFlashingCellPredicateId>) => SystemFlashingCellPredicateIds);
Property Value

SystemFlashingCellPredicateIds| ((context:SystemPredicatesContext<SystemFlashingCellPredicateId>) =>SystemFlashingCellPredicateIds)

systemFormatColumnPredicates

Which System Predicates are available in Format Column Module

TypeScript
systemFormatColumnPredicates?: SystemFormatColumnPredicateIds | ((context: SystemPredicatesContext<SystemFormatColumnPredicateId>) => SystemFormatColumnPredicateIds);
Property Value

SystemFormatColumnPredicateIds| ((context:SystemPredicatesContext<SystemFormatColumnPredicateId>) =>SystemFormatColumnPredicateIds)