Interface: Chart

The config contains all of the parameters needed to render a particular static chart or a state of an animated chart.

Properties

align?

optional align: "none" | "center" | "stretch"

Sets the alignment of the markers with relation to the x- or the y-axis depending on where the measure is. In case both axes have measures on them, this is determined by the orientation of the chart.

angle?

optional angle: number

Rotates the plot area to the specified angle in radian. Note: this is an experimental, not tested feature.

caption?

optional caption: string

This is the caption shown on the bottom of the chart. If set to null, the caption will not be shown and will not take up any space in the chart layout.

channels?

optional channels: Channels

List of the chart's channels' configuration. The chart object also extends the channels object as a configuration shorthand.

coordSystem?

optional coordSystem: "cartesian" | "polar"

Sets the coordinate system for the chart. Switch to the 'polar' coordinate system to create a chart from the pie/radial chart family.

geometry?

optional geometry: "rectangle" | "circle" | "area" | "line"

Sets the geometric elements used for the markers to represent the data.

legend?

optional legend: "auto" | "color" | "lightness" | "size"

Specifies which channel should be shown on the legend. If set to null, the legend will not be shown and will not take up any space in the chart layout. If set to auto, the internal logic will select the most suitable channel for the legend.

orientation?

optional orientation: "auto" | "horizontal" | "vertical"

If both axes have measures on them, this parameter sets the orientation of the chart, meaning to which axis the graphical elements are oriented to.

reverse?

optional reverse: boolean

Reverts the order of the markers if set.

sort?

optional sort: "none" | "byValue"

'none': markers are sorted in the order as the corresponding data appear in the data set.
'byValue': markers will be sorted by the corresponding measure (if present) in decreasing order.

split?

optional split: boolean

If set to true, markers will be split by the dimension(s) along the axis. This works if you have at least one dimension and a measure on the same axis.In case both axes have measures and dimension(s) on them, this is determined by the orientation of the chart.

subtitle?

optional subtitle: string

This is the subtitle shown on the top of the chart under the title. If set to null, the subtitle will not be shown and will not take up any space in the chart layout.

title?

optional title: string

This is the title shown on the top of the chart. If set to null, the title will not be shown and will not take up any space in the chart layout.

optional tooltip: string

Unique identifier of the marker, the tooltip should be turned on. This parameter is not needed to set manually, tooltip will be taken care of automatically when tooltip feature is enabled.