Methods

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

clearSelection()

Deselects the point.

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

View 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:

Object

|

Array

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.

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.

View 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.

View 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