All docs
V19.2
24.2
The page you are viewing does not exist in version 24.2.
24.1
The page you are viewing does not exist in version 24.1.
23.2
The page you are viewing does not exist in version 23.2.
23.1
The page you are viewing does not exist in version 23.1.
22.2
The page you are viewing does not exist in version 22.2.
22.1
The page you are viewing does not exist in version 22.1.
21.2
The page you are viewing does not exist in version 21.2.
21.1
The page you are viewing does not exist in version 21.1.
20.2
The page you are viewing does not exist in version 20.2.
20.1
The page you are viewing does not exist in version 20.1.
19.2
19.1
18.2
18.1
17.2
A newer version of this page is available. Switch to the current version.

JavaScript/jQuery Chart - Point.Methods

Methods used to control the series point.

clearHover()

Switches the point from the hover state back to normal.

clearSelection()

Deselects the point.

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

Multiple Point Selection Demo API - Select a Point Demo

getBoundingRect()

Gets the parameters of the point's minimum bounding rectangle (MBR).

Return Value:

Object

An object with the following content: { x: numeric, y: numeric, height: numeric, width: numeric }.

The object returned by this method contains the X and Y coordinates of the upper-left corner of the MBR. These coordinates are relative to the client area (widget's container). Additionally, the returned object contains the height and width of the MBR.

NOTE
This method is not supported for the rangeBar and rangeArea series points.

getColor()

Gets the color of a particular point.

Return Value:

String

The color of a point.

getLabel()

Allows you to obtain the label(s) of the series point.

Return Value:

Point Label

|

Array<Point Label>

The point label(s).

This method returns an array of two Label objects if a series point has two labels, like in a range bar or range area series. Otherwise, it returns a single Label object.

hideTooltip()

Hides the tooltip of the point.

The hideTooltip() and showTooltip() methods allow you to change tooltip visibility in code. Call the point's hideTooltip() method to hide the tooltip of this point.

hover()

Switches the point 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 point.

Return Value:

Boolean

Hover state of a point.

When a point 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.

isSelected()

Provides information about the selection state of a point.

Return Value:

Boolean

Selection state of a point.

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

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

Multiple Point Selection Demo API - Select a Point Demo

select()

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

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

Multiple Point Selection Demo API - Select a Point Demo

showTooltip()

Shows the tooltip of the point.

The hideTooltip() and showTooltip() methods allow you to change tooltip visibility in code. Call the point's showTooltip() method to show the tooltip of this point.

View Demo