ExpressionFunctionAvailabilityContext

View as Markdown

Context for AdaptableExpressionFunctionEnhancement.isAvailable and (as a base) for the global expressionOptions.isExpressionFunctionAvailable. Identifies the function being queried and the module requesting it.

TypeScript

export interface ExpressionFunctionAvailabilityContext extends

Extends

BaseContext

Properties

Property	Type	Description
column	`AdaptableColumn`	The Column the function is being offered for. Set only when resolving the operator list for a specific Column Filter (so `isExpressionFunctionAvailable` can allow/deny operators per Column); `undefined` for module-level resolution. Callbacks must tolerate it being `undefined`.
columnScope	`ColumnScope`	The `ColumnScope` for (a single-Column scope). Provided alongside `column` for Column Filter operator resolution; `undefined` otherwise.
expressionFunction	`AdaptableExpressionFunctionMetadata`	The function definition itself (argument model, docs and Adaptable enhancement metadata). Scalar / observable entries also carry the handler; aggregation entries are docs-only.
functionName	`string`	The function's registered name / AQL keyword (e.g. `GT`, `CONTAINS`, `SUM`, a custom function name).
functionType	`ExpressionFunctionType`	The kind of expression function (scalar, observable or aggregated).
isCustom	`boolean`	`false` for built-in system functions, `true` for user-registered custom functions.
module	`AdaptableModule` `\| undefined`	The module requesting the function (e.g. ColumnFilter, GridFilter, CalculatedColumn, Alert). May be `undefined` in rare cases — callbacks must tolerate it.
adaptableContext	`any`	Custom application Context provided in `AdaptableOptions.adaptableContext`

Property Details

column

The Column the function is being offered for. Set only when resolving the operator list for a specific Column Filter (so isExpressionFunctionAvailable can allow/deny operators per Column); undefined for module-level resolution. Callbacks must tolerate it being undefined.

TypeScript

column?: AdaptableColumn;

Property Value

AdaptableColumn

columnScope

The ColumnScope for (a single-Column scope). Provided alongside column for Column Filter operator resolution; undefined otherwise.

TypeScript

columnScope?: ColumnScope;

Property Value

ColumnScope

expressionFunction

The function definition itself (argument model, docs and Adaptable enhancement metadata). Scalar / observable entries also carry the handler; aggregation entries are docs-only.

TypeScript

expressionFunction: AdaptableExpressionFunctionMetadata;

Property Value

AdaptableExpressionFunctionMetadata

functionName

The function's registered name / AQL keyword (e.g. GT, CONTAINS, SUM, a custom function name).

TypeScript

functionName: string;

Property Value

string

functionType

The kind of expression function (scalar, observable or aggregated).

TypeScript

functionType: ExpressionFunctionType;

Property Value

ExpressionFunctionType

isCustom

false for built-in system functions, true for user-registered custom functions.

TypeScript

isCustom: boolean;

Property Value

boolean

module

The module requesting the function (e.g. ColumnFilter, GridFilter, CalculatedColumn, Alert). May be undefined in rare cases — callbacks must tolerate it.

TypeScript

module: AdaptableModule | undefined;

Property Value

AdaptableModule | undefined

adaptableContext

Inherited from BaseContext

Custom application Context provided in AdaptableOptions.adaptableContext

TypeScript

adaptableContext: any;

Property Value

any

PreviousExpressionFunction NextExpressionFunctionDocBlock