Global

Type Definitions

DataTypes

Source:
Type:
  • object

Dimension

Source:
Properties:
Name Type Attributes Default Description
id string

unique id
name string

label
required boolean
operation 'get' | 'group' | 'groups' | 'rollup' | 'rollup-leaf' | 'rollups' | 'groupAggregate' | 'groupBy' | 'proxy'

the operation type
targets Object

only for proxy operations
multiple Boolean <optional>
 false

controls if a dimension accept a value with more than one item
minValues number <optional>

min number of items required for the value of the dimension
maxValues number <optional>

max number of items required for the value of the dimension
validTypes Array

valid data types for the dimension (one or more of 'number', 'string', 'date', 'boolean')
Type:
  • object

MappedDimension

Source:
Type:
  • object

Mapping

Source:
Type:
  • object

MappingDefinition

Source:
Type:

ParserResult

Source:
Properties:
Name Type Description
dataset Array

parsed dataset (list of objects)
dataTypes Object

dataTypes used for parsing dataset
errors Array

list of errors from parsing
Type:
  • object

RawConfig

Source:
Properties:
Name Type Description
data Array.<Object>

the tabular data to be represented
dataTypes DataTypes

object with data types annotations (column name => type name)
mapping Mapping

the current mapping of column names to dimensions of the current visual model
visualOptions VisualOptions

visual options
Type:
  • object

RenderFunction(node, data, visualOptions, mapping, originalData)

Source:
Parameters:
Name Type Description
node Node
data any

the data from mapping
visualOptions object

the chart visual options
mapping object

the mapping from column names to
originalData array

the original tabular dataset

VisualModel

Source:
Properties:
Name Type Attributes Default Description
render RenderFunction

the render function
dimensions MappingDefinition

the dimensions configuration (mapping definition)
options VisualOptionsDefinition

the visual options exposed by the model
skipMapping Boolean <optional>
 false

if set to true will skip the mapping phase (current mapping is still passed to the render function)
Type:
  • object

VisualOption

Source:
Type:
  • object

VisualOptions

Source:
Type:
  • object

VisualOptionsDefinition

Source:
Type: