ExpressionOptions

Options for managing Expressions in AdapTable's Query Language

export interface

Properties

Property Details

caseSensitiveExpressions

Perform case-sensitive text comparisons when evaluating Expressions

caseSensitiveExpressions?: boolean;

Default Value

false

Property Value

boolean

customAggregatedFunctions

Bespoke Aggregated functions - to complement those provided by AdapTable

customAggregatedFunctions?: Record<string, AggregatedExpressionFunction> | ((context: GlobalExpressionFunctionsContext<string>) => Record<string, AggregatedExpressionFunction>);

Property Value

Record<string,AggregatedExpressionFunction> | ((context:GlobalExpressionFunctionsContext<string>) => Record<string,AggregatedExpressionFunction>)

customBooleanFunctions

Custom Boolean Expression Functions available in AdapTableQL

customBooleanFunctions?: Record<string, ExpressionFunction> | ((context: GlobalExpressionFunctionsContext<BooleanFunctionName>) => Record<string, ExpressionFunction>);

Default Value

null (none)

Property Value

Record<string,ExpressionFunction> | ((context:GlobalExpressionFunctionsContext<BooleanFunctionName>) => Record<string,ExpressionFunction>)

customQueryVariables

Values to be attached to variables so that a single value can easily be expressed multiple times within a query, or quickly changed to affect the results of a query; evaluated synchronously with each expression evaluation

customQueryVariables?: Record<string, string | number | boolean | Date | ((context: CustomQueryVariableContext) => string | number | boolean | Date)>;

Property Value

Record<string, string | number | boolean | Date | ((context:CustomQueryVariableContext) => string | number | boolean | Date)>

customScalarFunctions

Custom Scalar Expression Functions available in AdapTableQL

customScalarFunctions?: Record<string, ExpressionFunction> | ((context: GlobalExpressionFunctionsContext<ScalarFunctionName>) => Record<string, ExpressionFunction>);

Default Value

null (none)

Property Value

Record<string,ExpressionFunction> | ((context:GlobalExpressionFunctionsContext<ScalarFunctionName>) => Record<string,ExpressionFunction>)

displayColumnFriendlyNamesForExpressions

Reference a Column's Header (i.e. FriendlyName) in all Expression overviews (instead of ColumnId)

displayColumnFriendlyNamesForExpressions?: boolean;

Default Value

true

Property Value

boolean

evaluateAdaptableQLExternally

Whether a Module (or specific expression) should be evaluated by AdapTableQL

evaluateAdaptableQLExternally?: (context: EvaluateExpressionExternallyContext<TData>) => boolean;

Default Value

All Modules are evaluated by AdapTable

Property Value

(context:EvaluateExpressionExternallyContext<TData>) => boolean

fields

Fields are items in Data Source that are NOT columns but can be used in Expressions (via FIELD keyword)

fields?: AdaptableField[] | ((context: AdaptableFieldContext) => AdaptableField[]);

Property Value

AdaptableField[] | ((context:AdaptableFieldContext) =>AdaptableField[])

isColumnQueryable

Can a given column be included in Expressions

isColumnQueryable?: (queryableColumnContext: QueryableColumnContext) => boolean;

Property Value

(queryableColumnContext:QueryableColumnContext) => boolean

maxTimeframeSize

Maximum time (in milliseconds) to hold a Data Change event in a trailing timeframe

maxTimeframeSize?: number;

Default Value

28800000 (~8 hours)

Property Value

number

moduleExpressionFunctions

Module-specific Expression Functions available

moduleExpressionFunctions?: ModuleExpressionFunctionsMap | ((context: ModuleExpressionFunctionsContext) => ModuleExpressionFunctions | undefined);

Default Value

undefined (defaults to available System & Custom values)

Property Value

ModuleExpressionFunctionsMap| ((context:ModuleExpressionFunctionsContext) =>ModuleExpressionFunctions | undefined)

performExpressionValidation

Validate Expressions before they can be run or saved

performExpressionValidation?: boolean;

Default Value

true

Property Value

boolean

systemAggregatedBooleanFunctions

System AggregatedBoolean Expression Functions available in AdapTableQL

systemAggregatedBooleanFunctions?: AggregatedBooleanFunctionName[] | ((context: GlobalExpressionFunctionsContext<AggregatedBooleanFunctionName>) => AggregatedBooleanFunctionName[]);

Default Value

null (sets all)

Property Value

AggregatedBooleanFunctionName[] | ((context:GlobalExpressionFunctionsContext<AggregatedBooleanFunctionName>) =>AggregatedBooleanFunctionName[])

systemAggregatedScalarFunctions

System AggregatedScalar Expression Functions available in AdapTableQL

systemAggregatedScalarFunctions?: AggregatedScalarFunctionName[] | ((context: GlobalExpressionFunctionsContext<AggregatedScalarFunctionName>) => AggregatedScalarFunctionName[]);

Default Value

undefined (sets all)

Property Value

AggregatedScalarFunctionName[] | ((context:GlobalExpressionFunctionsContext<AggregatedScalarFunctionName>) =>AggregatedScalarFunctionName[])

systemBooleanFunctions

System Boolean Expression Functions available in AdapTableQL

systemBooleanFunctions?: BooleanFunctionName[] | ((context: GlobalExpressionFunctionsContext<BooleanFunctionName>) => BooleanFunctionName[]);

Default Value

null (sets all)

Property Value

BooleanFunctionName[] | ((context:GlobalExpressionFunctionsContext<BooleanFunctionName>) =>BooleanFunctionName[])

systemObservableFunctions

System Observable Expression Functions available in AdapTableQL

systemObservableFunctions?: ObservableFunctionName[] | ((context: GlobalExpressionFunctionsContext<ObservableFunctionName>) => ObservableFunctionName[]);

Default Value

null (sets all)

Property Value

ObservableFunctionName[] | ((context:GlobalExpressionFunctionsContext<ObservableFunctionName>) =>ObservableFunctionName[])

systemScalarFunctions

System Scalar Expression Functions available in AdapTableQL

systemScalarFunctions?: ScalarFunctionName[] | ((context: GlobalExpressionFunctionsContext<ScalarFunctionName>) => ScalarFunctionName[]);

Default Value

null (sets all)

Property Value

ScalarFunctionName[] | ((context:GlobalExpressionFunctionsContext<ScalarFunctionName>) =>ScalarFunctionName[])