ZoomCharts Documentation


Inheritance hierarchy

This type inherits from LinearChartSettingsSeries.


This type does not define any methods.


cluster: string

Cluster identifier. Columns with the same cluster id will be placed in same cluster.

Data manipulation settings used for default series.

enabled: boolean

Enable/disable series.

extra: any
Introduced in version 1.11.0.

A field that can be used to store any additional data with the series object. This can be useful in situations when the data is required in event handlers, such as onClick when the event arguments contain the configuration of the series that was hovered or clicked. This value is copied by reference.

id: string
legendGroupId: string
Introduced in version 1.15.0.

Group ID for legend. Items in the same group have a different toggle behavior. When all the items in a group are enabled, clicking an item causes that item to stay enabled and all other items are disabled. Clicking it again enables all items again. Consequently, at least one item in each group is always enabled. The exception to this is if the group ID is null (no group) or the group contains only one item. Then the item is toggled on/off individually.

name: string

Name to show in the info popup. The same value is also used in the legend unless nameLegend is also set.

nameLegend: string

Name to show in the legend. If not specified, value from the name property is shown.

showInLegend: boolean

Whether to show the series name in legend and info popup.

stack: string

Stack identifier. Series with same stack ID are placed in the same stack. Define a stack with the same identifier to tune the stack.

Custom style based on series type. See the documentation of the derived classes for available properties.

type: "candlestick" | "columns" | "line"

Series type.

Valid values:
  • candlestick
  • columns
  • line
valueAxis: string

ID of value axis that this series will use. Maps to a configuration specified in valueAxis property.