Interface FormulaBuilder

The formula transform extends data objects with new values according to a calculation formula.

Hierarchy

DatasetTransform
- FormulaBuilder

Implemented by

FormulaBuilderImpl

Index

Methods

Methods

as

as(value: string): FormulaBuilder

- Defined in facade/formula.ts:26
The output field at which to write the formula value.

Parameters
- value: string
Returns FormulaBuilder

build

build(df: any, from: any, ds: DatasetManager): any

Inherited from DatasetTransform.build
- Defined in facade/interfaces.ts:15
Build the transformation

Parameters
- df: any
  
  The vega dataflow instance
- from: any
  
  The vega-dataflow node that is the parent of this node
- ds: DatasetManager
  
  The chart-parts dataset
Returns any

formula

formula(value: Transformer<any, any>): FormulaBuilder

- Defined in facade/formula.ts:20
The formula to use for calculating new results.

Parameters
- value: Transformer<any, any>
Returns FormulaBuilder

initOnly

initOnly(value: boolean): FormulaBuilder

- Defined in facade/formula.ts:34
If true, the formula is evaluated only when a data object is first observed. The formula values will not automatically update if data objects are modified. The default is false.

Parameters
- value: boolean
Returns FormulaBuilder