Fields

This section describes the fields that can be used in code to manipulate the Series object.

axis

Returns the name of the value axis of the series.

Type: String

To learn more on how to display a chart with several value axes, refer to the Multi-Axis Chart topic.

Show Example:
jQuery

In this example, click a series to display the name of this series' value axis. The axis name is received using the series' axis field.


                                    

                                    

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.

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

Show Example:
jQuery

In this example, the series' fullState field is used to implement deselecting of a selected series. The function, which is assigned to the seriesClick option, checks the current state of the clicked series. If the series is selected, the selection will be removed using the clearSelection() method. Otherwise, the series will be selected using the series' select() method.


                                    

                                    

name

Returns the name of the series.

Type: String

Show Example:
jQuery

In this example, click a series to display the name of this series. This name is received using the series' name field.


                                    

                                    

pane

Returns the name of the series pane.

Type: String

To learn more on how to display series in different panes, refer to the Multi-Pane Chart topic.

Show Example:
jQuery

In this example, click a series to display the name of this series' pane. This name is received using the series' pane field.


                                    

                                    

tag

Returns the tag of the series.

Type: String

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.

Show Example:
jQuery

In this example, сlick a series on the chart to select this series. The information about the corresponding country will be displayed. This information is received using the tag field.


                                    

                                    

type

Returns the type of the series.

Type: String

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

Show Example:
jQuery

In this example, click a series to display the type of this series. This type is received using the series' type field.