Fields

Fields that provide information on the series.

axis

Returns the name of the value axis of the series.

Type:

String

fullState

Provides information about the state of the series object.

Type:

Number

Each series within a chart can be in several states. These states are represented by the numbers that are enumerated in the list below:

  • 0
    Series is not hovered and not selected (normal state);
  • 1
    Series is hovered;
  • 2
    Series is selected;
  • 3
    Series is hovered and selected.

You can also use the isHovered() and isSelected() series methods to check whether a series is hovered or selected.

To learn more about the handling of series hover and selection, refer to the Series Hover and Series Selection topics.

name

Returns the name of the series.

Type: any

pane

Returns the name of the series pane.

Type:

String

tag

Returns the tag of the series.

Type: any

When defining a series, you can specify auxiliary information for it via the tag option. You can specify auxiliary information for each point as well. To do this, add a tag field to the data source and specify the name of the field via the series tagField option.

type

Returns the type of the series.

Type:

String

To learn about different series types, refer to the Series help section.