jQuery Chart - Series.Methods

Methods used to control the series.

clearHover()

Switches the series from the hover state back to normal.

clearSelection()

Cancels the selection of this particular series. The series is displayed in its initial style.

To cancel the selection of all chart series, call the clearSelection() method of the UI component instance.

View Demo

See Also

deselectPoint(point)

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

Parameters:
point:

Point

The point to be deselected.

getAllPoints()

Gets all points in the series.

Return Value:

Array<Point>

All points in the series.

NOTE

A series point is a data object's visual representation. It can be selected, hovered over, or hidden. You can access the data object that the series point represents using the point's data field.

If data aggregation is enabled, a single series point can represent more than one data object. In this case, you can access the data objects using the point's aggregationInfo.data field.

getArgumentAxis()

Gets the argument axis to which the series belongs.

Return Value:

Chart Axis

The argument axis to which the series belongs.

See Also

getColor()

Gets the color of a particular series.

Return Value:

String

The color of a series.

getPointByPos(positionIndex)

Gets a series point with the specified index.

Parameters:
positionIndex:

Number

A zero-based index. Series points are indexed according to their drawing order.

Return Value:

Point

A series point found by the index.

getPointsByArg(pointArg)

Gets a series point with the specified argument value.

Parameters:
pointArg:

Number

|

String

|

Date

An argument value.

Return Value:

Array<Point>

Series points that correspond to the argument value, or an empty array if none was found.

getValueAxis()

Gets the value axis to which the series belongs.

Return Value:

Chart Axis

The value axis to which the series belongs.

See Also

getVisiblePoints()

Gets visible series points.

Return Value:

Array<Point>

Visible series points.

Use this method to get series points in the UI component's viewport which can change during zooming and panning.

NOTE
This method does not change the behavior if you hide the series.

hide()

Hides a series at runtime.

See Also

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.

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.

View Demo

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.

selectPoint(point)

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

Parameters:
point:

Point

The point to be selected.

show()

Makes a particular series visible.