ExpressionFunction
Defines an AdaptableQL Function used in an Adaptable Expression
TypeScript
export interfaceProperties
| Property | Type | Description |
|---|---|---|
| category | ExpressionCategory | Used to group Functions Expression Editor dropdown |
| description | string | What the AdaptableQL Function does |
| examples | string[] | Examples that demonstrate the AdaptableQL Function |
| handler | ExpressionFunctionHandler | Actual AdaptableQL Function called by the Expression (mandatory prop) |
| hasEagerEvaluation | boolean | Whether Expression is evaluated without handling inner AST nodes |
| inputs | ExpressionFunctionInputType[] |ExpressionFunctionInputType[][] | Data Types of Inputs required by Expression |
| isHiddenFromMenu | boolean | Removes entry from Expression Editor's Functions dropdown |
| returnType | 'boolean' | 'number' | 'string' | 'date' | 'null' | 'any' | Type returned by Function: boolean, number, string, date, any |
| signatures | string[] | How the AdaptableQL Function should be called |
Property Details
category
Used to group Functions Expression Editor dropdown
TypeScript
category?: ExpressionCategory;Property Value
description
What the AdaptableQL Function does
TypeScript
description?: string;Property Value
string
examples
Examples that demonstrate the AdaptableQL Function
TypeScript
examples?: string[];Property Value
string[]
handler
Actual AdaptableQL Function called by the Expression (mandatory prop)
TypeScript
handler: ExpressionFunctionHandler;Property Value
hasEagerEvaluation
Whether Expression is evaluated without handling inner AST nodes
TypeScript
hasEagerEvaluation?: boolean;Property Value
boolean
inputs
Data Types of Inputs required by Expression
TypeScript
inputs?: ExpressionFunctionInputType[] | ExpressionFunctionInputType[][];Property Value
ExpressionFunctionInputType[] |ExpressionFunctionInputType[][]
isHiddenFromMenu
Removes entry from Expression Editor's Functions dropdown
TypeScript
isHiddenFromMenu?: boolean;Property Value
boolean
returnType
Type returned by Function: boolean, number, string, date, any
TypeScript
returnType?: 'boolean' | 'number' | 'string' | 'date' | 'null' | 'any';Property Value
'boolean' | 'number' | 'string' | 'date' | 'null' | 'any'
signatures
How the AdaptableQL Function should be called
TypeScript
signatures?: string[];Property Value
string[]