Class Expression

Index

Constructors

Methods

execute getDescription getSources isValid parse validate

Constructors

constructor

new Expression(expression: string): BG.charts.Expression
an expression represents a simple mathematic formula based on one or more timeseries as input parameters. It supports basic arithmetic operations such as addition, subtraction, division, and some simple mathematic functions (MAX, MIN, ABS, SQRT).

Expressions are used to calculate so called Composite Symbols, for example ratio or spread charts.

To add a Composite Symbol to a chart, the built in Expression loader can be used as follows (Assuming you have previously provided a data loader named "custom"):
```
   controller.addTimeSeries('Expression(custom:a/custom:b)');
```
Parameters
- expression: string
Returns BG.charts.Expression

Methods

execute

execute(...args: any[]): number
Parameters
- ...args: any[]
Returns number

getDescription

getDescription(names?: string[]): string
Parameters
- Optionalnames: string[]
Returns string

getSources

getSources(): string[]
Returns string[]

isValid

isValid(): boolean
Returns boolean

`Static`parse

parse(expression: string): null | BG.charts.Expression
Parameters
- expression: string
Returns null | BG.charts.Expression

`Static`validate

validate(expression: string): boolean
Parameters
- expression: string
Returns boolean