Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Hierarchy

Index

Properties

align?: "none" | "min" | "center" | "max" | "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.

channels?: Channels

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

Parameters for the markers' base color. The markers' actual color can also be affected by the lightness channel.

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?: "rectangle" | "circle" | "area" | "line"

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

Parameters for the content of the labels that appear on the markers.

legend?: "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.

lightness?: Channel | SeriesList

Parameters for markers' lightness.

Splits the markers as all the other channels, but have no effect on the markers' appearance. Thus, it only works with dimensions.

orientation?: "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?: boolean

Reverts the order of the markers if set.

rotate?: number

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

Parameters for the markers' size. Effective only for circle and line geometry affecting the circle area or the line width respectively.

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?: 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.

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.

Parameters for the X-axis, determining the position of the markers on the x-axis - or their angle when using polar coordinates. Note: leaving x and y channels empty will result in a chart "without coordinates" like a Treemap or a Bubble Chart.

Parameters for the Y-axis, determining the position of the markers on the y-axis - or their radius when using polar coordinates) .

Generated using TypeDoc