PredicateOptions

Options for managing Adaptable Predicates using AdaptableQL

export interface

Properties

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)[];

Default Value

[]

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);

Default Value

all SystemAlertPredicateIds

Property Value

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

systemBadgeStylePredicates

Which System Predicates are available for Badge Styles

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

Default Value

all SystemBadgeStylePredicateIds

Property Value

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

systemFilterPredicates

Which System Predicates are available when Filtering

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

Default Value

all SystemFilterPredicateIds

Property Value

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

systemFlashingCellPredicates

Which System Predicates are available in Flashing Cell Module

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

Default Value

all SystemFlashingCellPredicateIds

Property Value

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

systemFormatColumnPredicates

Which System Predicates are available in Format Column Module

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

Default Value

all SystemFormatColumnPredicateIds

Property Value

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