Methods

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

clearHover()

Switches the series from the hover state back to normal.

clearSelection()

Unselects all the selected points of the series. The points are displayed in an initial style.

To learn about point selection, refer to the Selection Handling section.

View Demo

Show Example:
jQuery

In this example, click a series to select it. Then, click it once again to deselect it. The deselection is performed using the clearSelection() method.


                                    

                                    

deselectPoint(point)

Deselects the specified point. The point is displayed in an initial style.

Parameters:
point: Point

The point to be deselected.

To learn about point selection, refer to the Selection Handling section.

Show Example:
jQuery

In this example, if you click a series, only points with the value equal to 20 or more will be selected. The second click on the series deselects all previously selected points using the deselectPoint(point) method.


                                    

                                    

getAllPoints()

Returns an array of all points in the series.

Return Value: Array

The points from the series point collection.

Show Example:
jQuery

In this example, the maximum point value in the clicked series is displayed. The series' getAllPoints() method is used to calculate the maximum value from all the points.


                                    

                                    

getColor()

Gets the color of a particular series.

Return Value: String

The color of a series.

Show Example:
jQuery

In this example, you can get a series' color by clicking it. The color will be displayed at the bottom of the chart.


                                    

                                    

getPointByPos(positionIndex)

Gets a point from the series point collection based on the specified point position.

Parameters:
positionIndex: Number

The index of the point to be found within the series point collection.

Return Value: Object

The point that is found by the specified position index.

Points in the series point collection are arranged as they go along the argument axis from left to right. Note that the series are numbered from zero in the series collection.

Show Example:
jQuery

In this example, choose one of the point indexes using the radio buttons. Here, the getPointByPos(positionIndex) method is used to select all points with the chosen index.


                                    

                                    

getPointsByArg(pointArg)

Gets points from the series point collection based on the specified argument.

Parameters:
pointArg: Number|String|Date

The argument of the point(s) to be found.

Return Value: Array

The points that are found by the specified argument.

If a point with the specified argument is not found, the function returns empty array.

getVisiblePoints()

Returns visible series points.

Return Value: Array

Visible points.

Use this method to get points that lay within the visible range defined by the min and max options of an axis. This method is also useful if you need to obtain the points displayed when data aggregation is applied.

NOTE
If a chart series or its points are not displayed as hidden from code, the getVisiblePoints() method called for this series still returns points that lay within the visible range as if these points were visible.

hide()

Hides a series.

This method hides a series at runtime. To specify a series hidden at design-time, set the series | visible option to false.

NOTE
When the series is invisible, the marker of its legend item is faded.

hover()

Switches the series into the hover state, the same as when a user places the mouse pointer on it.

isHovered()

Provides information about the hover state of a series.

Return Value: Boolean

Hover state of a series.

When a series is hovered over, this method returns true. Otherwise, the returned value is false.

To learn more about point and series hover operation, refer to the Hover Handling topic.

Show Example:
jQuery

Hover over a series on the chart and information about the maximum point value of this series will appear under the chart. When the series that has been hovered over is hovered out, this information disappears. This behavior is achieved using the isHovered() method of the hovered series.


                                    

                                    

isSelected()

Provides information about the selection state of a series.

Return Value: Boolean

Selection state of a series.

When a series is selected, this method returns true. Otherwise, the returned value is false.

You can select a series using its select() method. To learn more about point and series selection, refer to the Selection Handling topic.

Show Example:
jQuery

Click a series on the chart to select this series. Information about the maximum point value of the selected series will appear under the chart. Click this series again and the information will disappear. This behavior is achieved using the isSelected() method of the clicked series.


                                    

                                    

isVisible()

Provides information about the visibility state of a series.

Return Value: Boolean

Visibility state of a series.

When a series is visible, this method returns true. Otherwise, the returned value is false.

You can make a series visible using its show() method, or hide a series using its hide() method.

select()

Selects the series. The series is displayed in a 'selected' style until another series is selected or the current series is deselected programmatically.

To learn about series selection, refer to the Selection Handling section.

View Demo

Show Example:
jQuery

In the example below, click a series to select it. Then, click it once again to deselect it. The selection is performed using the select() method.


                                    

                                    

selectPoint(point)

Selects the specified point. The point is displayed in a 'selected' style.

Parameters:
point: Point

The point to be selected.

For information on point selection, refer to the Selection Handling section.

Show Example:
jQuery

In this example, if you click a series, only points with the value equal to 20 or more will be selected using the selectPoint(point) method. The second click on the series deselects all previously selected points.


                                    

                                    

show()

Makes a particular series visible.