AdapTable Version:

Framework:

PredicateApi

Functions which manage the Predicate object in AdapTable

TypeScript

export interface

Methods

Method	Description
getCustomPredicateDefById(predicateId)	Gets Predicate Definition provided by users for given Id
getCustomPredicateDefs()	Returns Predicate Definitions provided by users
getPredicateDefById(predicateId)	Gets the Predicate Definition for a given Id
getPredicateDefs()	Returns all current Predicate Definitions
getPredicateDefsByModuleScope(moduleScope)	Retrieves all Predicate Definitions for given Module Scope
getSystemPredicateDefById(predicateId)	Gets Predicate Definition provided by AdapTable for given Id
getSystemPredicateDefs()	Returns Predicate Definitions provided by AdapTable
getSystemPredicateDefsByModuleScope(moduleScope)	Returns Predicate Definitions provided by AdapTable for given Module Scope
handleColumnPredicate(predicate, params, defaultReturn)	Same has handle predicate but it tales into account predicate column id.
handleColumnPredicates(predicate, params, defaultReturn)	Same has handle predicates but it tales into account predicate column id.
handlePredicate(predicate, params, defaultReturn)	Main Handler function for a Predicate Definition - used by AdapTableQL
handlePredicates(predicates, params, defaultReturn)	Handle and compose (with AND) the given Predicate Definitions
isEveryPredicateValid(predicates)	Checks if all predicates are valid
isValidPredicate(predicate)	Checks whether a given Predicate Definition is valid
predicatesToString(predicates, logicalOperator)	Stringifies a list of Predicate Definitions, using the given logical operator (AND/OR)
predicateToString(predicate)	Stringifies a given Predicate Definition
useCaseSensitivity(columnId)	Whether Predicates are evaluated using Case Sensitivity

Method Details

getCustomPredicateDefById

Gets Predicate Definition provided by users for given Id

TypeScript

getCustomPredicateDefById(predicateId: string): AdaptablePredicateDef;

Parameters

Parameter	Type	Description
predicateId	`string`	predicateId to check

Returns

AdaptablePredicateDef

getCustomPredicateDefs

Returns Predicate Definitions provided by users

TypeScript

getCustomPredicateDefs(): AdaptablePredicateDef[];

Returns

AdaptablePredicateDef[]

getPredicateDefById

Gets the Predicate Definition for a given Id

TypeScript

getPredicateDefById(predicateId: string): AdaptablePredicateDef;

Parameters

Parameter	Type	Description
predicateId	`string`	Id of Predicate Definition

Returns

AdaptablePredicateDef

getPredicateDefs

Returns all current Predicate Definitions

TypeScript

getPredicateDefs(): AdaptablePredicateDef[];

Returns

AdaptablePredicateDef[]

getPredicateDefsByModuleScope

Retrieves all Predicate Definitions for given Module Scope

TypeScript

getPredicateDefsByModuleScope(moduleScope: PredicateModuleScope): AdaptablePredicateDef[];

Parameters

Parameter	Type	Description
moduleScope	`PredicateModuleScope`	Module Scope to use

Returns

AdaptablePredicateDef[]

getSystemPredicateDefById

Gets Predicate Definition provided by AdapTable for given Id

TypeScript

getSystemPredicateDefById(predicateId: string): AdaptablePredicateDef;

Parameters

Parameter	Type	Description
predicateId	`string`	predicateId to check

Returns

AdaptablePredicateDef

getSystemPredicateDefs

Returns Predicate Definitions provided by AdapTable

TypeScript

getSystemPredicateDefs(): AdaptablePredicateDef[];

Returns

AdaptablePredicateDef[]

getSystemPredicateDefsByModuleScope

Returns Predicate Definitions provided by AdapTable for given Module Scope

TypeScript

getSystemPredicateDefsByModuleScope<PREDICATE_TYPE extends string = string>(moduleScope: PredicateModuleScope): AdaptablePredicateDef<PREDICATE_TYPE>[];

Parameters

Parameter	Type	Description
moduleScope	`PredicateModuleScope`	Module Scope to use

Returns

AdaptablePredicateDef<PREDICATE_TYPE>[]

handleColumnPredicate

Same has handle predicate but it tales into account predicate column id.

TypeScript

handleColumnPredicate(predicate: AdaptableColumnPredicate, params: Omit<PredicateDefHandlerContext, 'adaptableApi' | 'inputs'>, defaultReturn: boolean): boolean;

Parameters

Parameter	Type	Description
predicate	`AdaptableColumnPredicate`
params	`Omit<PredicateDefHandlerContext, 'adaptableApi' \| 'inputs'>`
defaultReturn	`boolean`

Returns

boolean

handleColumnPredicates

Same has handle predicates but it tales into account predicate column id.

TypeScript

handleColumnPredicates(predicate: AdaptableColumnPredicate[], params: Omit<PredicateDefHandlerContext, 'adaptableApi' | 'inputs'>, defaultReturn: boolean): boolean;

Parameters

Parameter	Type	Description
predicate	`AdaptableColumnPredicate[]`
params	`Omit<PredicateDefHandlerContext, 'adaptableApi' \| 'inputs'>`
defaultReturn	`boolean`

Returns

boolean

handlePredicate

Main Handler function for a Predicate Definition - used by AdapTableQL

TypeScript

handlePredicate(predicate: AdaptablePredicate | undefined, params: Omit<PredicateDefHandlerContext, 'adaptableApi' | 'inputs'>, defaultReturn: boolean): boolean;

Parameters

Parameter	Type	Description
predicate	`AdaptablePredicate` `\| undefined`	Predicate to handle
params	`Omit<PredicateDefHandlerContext, 'adaptableApi' \| 'inputs'>`	Additional inputs as required
defaultReturn	`boolean`	Whether to return the default

Returns

boolean

handlePredicates

Handle and compose (with AND) the given Predicate Definitions

TypeScript

handlePredicates(predicates: AdaptablePredicate[], params: Omit<PredicateDefHandlerContext, 'adaptableApi' | 'inputs'>, defaultReturn: boolean): boolean;

Parameters

Parameter	Type	Description
predicates	`AdaptablePredicate[]`
params	`Omit<PredicateDefHandlerContext, 'adaptableApi' \| 'inputs'>`	Additional inputs as required
defaultReturn	`boolean`	Whether to return the default

Returns

boolean

isEveryPredicateValid

Checks if all predicates are valid

TypeScript

isEveryPredicateValid(predicates: AdaptablePredicate[]): boolean;

Parameters

Parameter	Type	Description
predicates	`AdaptablePredicate[]`	Predicates Definitions to check

Returns

boolean

isValidPredicate

Checks whether a given Predicate Definition is valid

TypeScript

isValidPredicate(predicate: AdaptablePredicate): boolean;

Parameters

Parameter	Type	Description
predicate	`AdaptablePredicate`	Predicate Definition to check

Returns

boolean

predicatesToString

Stringifies a list of Predicate Definitions, using the given logical operator (AND/OR)

TypeScript

predicatesToString(predicates: AdaptablePredicate[], logicalOperator?: string): string;

Parameters

Parameter	Type	Description
predicates	`AdaptablePredicate[]`	List of Predicate Definitions to stringify
logicalOperator	`string`	Logical operator to use to join the stringified Predicates (default AND)

Returns

string

predicateToString

Stringifies a given Predicate Definition

TypeScript

predicateToString(predicate: AdaptablePredicate): string;

Parameters

Parameter	Type	Description
predicate	`AdaptablePredicate`	Predicate Definition to stringify

Returns

string

useCaseSensitivity

Whether Predicates are evaluated using Case Sensitivity

TypeScript

useCaseSensitivity(columnId: string): boolean;

Parameters

Parameter	Type
columnId	`string`

Returns

boolean

PreviousPredefinedConfig NextPredicateDefHandlerContext