AdaptableQL Expression Technical Reference
Summary
- Expression Options contains many properties to configure AdapTableQl and Expressions
- The Expression API section of AdapTable API provides run-time access to Expressions
Expression Options
The ExpressionOptions section of Adaptable Options contains options for using AdapTableQL Expressions:
| Property | Description | Default |
|---|---|---|
| caseSensitiveExpressions | Perform case-sensitive text comparisons when evaluating Expressions | false |
| customAggregatedFunctions | Bespoke Aggregated functions - to complement those provided by AdapTable | |
| customBooleanFunctions | Custom Boolean Expression Functions available in AdapTableQL | null (none) |
| 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 | |
| customScalarFunctions | Custom Scalar Expression Functions available in AdapTableQL | null (none) |
| displayColumnFriendlyNamesForExpressions | Reference a Column's Header (i.e. FriendlyName) in all Expression overviews (instead of ColumnId) | true |
| evaluateAdaptableQLExternally | Whether a Module (or specific expression) should be evaluated by AdapTableQL | All Modules are evaluated by AdapTable |
| fields | Fields are items in Data Source that are NOT columns but can be used in Expressions (via FIELD keyword) | |
| isColumnQueryable | Can a given column be included in Expressions | |
| maxTimeframeSize | Maximum time (in milliseconds) to hold a Data Change event in a trailing timeframe | 28800000 (~8 hours) |
| moduleExpressionFunctions | Module-specific Expression Functions available | undefined (defaults to available System & Custom values) |
| performExpressionValidation | Validate Expressions before they can be run or saved | true |
| systemAggregatedBooleanFunctions | System AggregatedBoolean Expression Functions available in AdapTableQL | null (sets all) |
| systemAggregatedScalarFunctions | System AggregatedScalar Expression Functions available in AdapTableQL | undefined (sets all) |
| systemBooleanFunctions | System Boolean Expression Functions available in AdapTableQL | null (sets all) |
| systemObservableFunctions | System Observable Expression Functions available in AdapTableQL | null (sets all) |
| systemScalarFunctions | System Scalar Expression Functions available in AdapTableQL | null (sets all) |
Expression API
Expression API section of Adaptable API contains functions which enable run-time access of AdapTableQL.
| Method | Description |
|---|---|
| getAdaptableQueryExpression(query) | Returns Expression string of given AdaptableQuery: can be Boolean, AggregatedBoolean, Scalar, AggregatedScalar or Observable |
| getAdaptableQueryExpressionWithColumnFriendlyNames(query) | Returns Expression string of given AdaptableQuery with column friendly names (instead of Column IDs) |
| getASTForExpression(expression) | Runs the AST that AdapTableQL creates for an Expression - useful when evaluating remotely |
| getColumnsFromExpression(expression) | Returns all Columns referenced in an Expression |
| isColumnQueryable(abColumn) | Returns whether a Column is Queryable |
| isValidAggregatedBooleanExpression(expression, module, validationErrorMessage) | Whether the given AggregatedBooleanExpression is valid |
| isValidAggregatedScalarExpression(expression, module, validationErrorMessage) | Whether the given AggregatedScalarExpression is valid |
| isValidBooleanExpression(expression, module, validationErrorMessage) | Whether the given BooleanExpression is valid |
| isValidObservableExpression(expression, module, validationErrorMessage) | Whether the given ObservableExpression is valid |
| useCaseSensitivity() | Whether Expressions are evaluated using Case Sensitivity |