ExpressionApi

Functions related to Expressions in AdapTableQL (the Adaptable Query Language)

TypeScript

export interface

Methods

Method	Returns	Description
getAdaptableQueryExpression(query)	`string \| undefined`	Returns Expression string of given AdaptableQuery: can be Boolean, AggregatedBoolean, Scalar, AggregatedScalar or Observable
getAdaptableQueryExpressionWithColumnFriendlyNames(query)	`string \| undefined`	Returns Expression string of given AdaptableQuery with column friendly names (instead of Column IDs)
getASTForExpression(expression)	`any`	Runs the AST that AdapTableQL creates for an Expression - useful when evaluating remotely
getColumnsFromExpression(expression)	`string[]`	Returns all Columns referenced in an Expression
isColumnQueryable(abColumn)	`boolean`	Returns whether a Column is Queryable
isValidAggregatedBooleanExpression(expression, module, validationErrorMessage)	`boolean`	Whether the given AggregatedBooleanExpression is valid
isValidAggregatedScalarExpression(expression, module, validationErrorMessage)	`boolean`	Whether the given AggregatedScalarExpression is valid
isValidBooleanExpression(expression, module, validationErrorMessage)	`boolean`	Whether the given BooleanExpression is valid
isValidObservableExpression(expression, module, validationErrorMessage)	`boolean`	Whether the given ObservableExpression is valid
useCaseSensitivity()	`boolean`	Whether Expressions are evaluated using Case Sensitivity

Method Details

getAdaptableQueryExpression

Returns Expression string of given AdaptableQuery: can be Boolean, AggregatedBoolean, Scalar, AggregatedScalar or Observable

TypeScript

getAdaptableQueryExpression(query: Partial<AdaptableQuery>): string | undefined;

Parameters

Parameter	Type	Description
query	`Partial<AdaptableQuery>`	the AdaptableQuery

Returns

string | undefined

getAdaptableQueryExpressionWithColumnFriendlyNames

Returns Expression string of given AdaptableQuery with column friendly names (instead of Column IDs)

TypeScript

getAdaptableQueryExpressionWithColumnFriendlyNames(query: Partial<AdaptableQuery>): string | undefined;

Parameters

Parameter	Type	Description
query	`Partial<AdaptableQuery>`	the AdaptableQuery

Returns

string | undefined

getASTForExpression

Runs the AST that AdapTableQL creates for an Expression - useful when evaluating remotely

TypeScript

getASTForExpression(expression: string): any;

Parameters

Parameter	Type	Description
expression	`string`	expression to be run

Returns

any

getColumnsFromExpression

Returns all Columns referenced in an Expression

TypeScript

getColumnsFromExpression(expression: string): string[];

Parameters

Parameter	Type	Description
expression	`string`	expression to check

Returns

string[]

isColumnQueryable

Returns whether a Column is Queryable

TypeScript

isColumnQueryable(abColumn: AdaptableColumn): boolean;

Parameters

Parameter	Type
abColumn	`AdaptableColumn`

Returns

boolean

isValidAggregatedBooleanExpression

Whether the given AggregatedBooleanExpression is valid

TypeScript

isValidAggregatedBooleanExpression(expression: string, module: AdaptableModule, validationErrorMessage?: string): boolean;

Parameters

Parameter	Type	Description
expression	`string`	AggregatedBooleanExpression to check
module	`AdaptableModule`	module specific query
validationErrorMessage	`string`	optional validation error message; if provided, the error will be logged

Returns

boolean

isValidAggregatedScalarExpression

Whether the given AggregatedScalarExpression is valid

TypeScript

isValidAggregatedScalarExpression(expression: string, module: AdaptableModule, validationErrorMessage?: string): boolean;

Parameters

Parameter	Type	Description
expression	`string`	AggregatedScalarExpression to check
module	`AdaptableModule`	module specific query
validationErrorMessage	`string`	optional validation error message; if provided, the error will be logged

Returns

boolean

isValidBooleanExpression

Whether the given BooleanExpression is valid

TypeScript

isValidBooleanExpression(expression: string, module: AdaptableModule, validationErrorMessage?: string): boolean;

Parameters

Parameter	Type	Description
expression	`string`	query to Check
module	`AdaptableModule`	module specific query
validationErrorMessage	`string`	optional validation error message; if provided, the error will be logged

Returns

boolean

isValidObservableExpression

Whether the given ObservableExpression is valid

TypeScript

isValidObservableExpression(expression: string, module: AdaptableModule, validationErrorMessage?: string): boolean;

Parameters

Parameter	Type	Description
expression	`string`	ObservableExpression to check
module	`AdaptableModule`	module specific query
validationErrorMessage	`string`	optional validation error message; if provided, the error will be logged

Returns

boolean

useCaseSensitivity

Whether Expressions are evaluated using Case Sensitivity

TypeScript

useCaseSensitivity(): boolean;

Returns

boolean

PreviousExportState NextExpressionCategory