Skip to content

Vizzu / Modules / vizzu / Config / Chart

Interface: Chart

vizzu.Config.Chart

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

Hierarchy

Properties

align

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

Optional channels: Channels

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


color

Optional color: SeriesList | Channel

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

Inherited from

Channels.color


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

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


label

Optional label: SeriesList | Channel

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

Inherited from

Channels.label


legend

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

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.


lightness

Optional lightness: SeriesList | Channel

Parameters for markers' lightness.

Inherited from

Channels.lightness


noop

Optional noop: SeriesList | Channel

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

Inherited from

Channels.noop


orientation

Optional 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

Optional reverse: boolean

Reverts the order of the markers if set.


rotate

Optional rotate: number

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


size

Optional size: SeriesList | Channel

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

Inherited from

Channels.size


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.


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.


x

Optional x: SeriesList | Channel

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.

Inherited from

Channels.x


y

Optional y: SeriesList | Channel

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

Inherited from

Channels.y