Fields

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

fullState

Provides information about the state of the point object.

Type:

Number

Each point within a chart can be in several states. These states are represented by the numbers that are enumerated in the list below:

  • 0
    The point is not hovered and not selected (normal state);
  • 1
    The point is hovered;
  • 2
    The point is selected;
  • 3
    The point is hovered and selected.

You can also use the isHovered() and isSelected() point methods to check whether a point is hovered or selected.

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

originalArgument

Returns the point's argument value that was set in the data source.

Type:

String

|

Number

|

Date

originalValue

Returns the point's value that was set in the data source.

Type:

String

|

Number

|

Date

series

Returns the series object to which the point belongs.

Type:

Object

For information on members that a series object exposes, refer to the Series object description.

tag

Returns the tag of the point.

Type:

String

When defining a data source, you can provide auxiliary information for each point by adding a tag field to the data source, and specifying the name of the field via the tagField option of the series. You can also specify auxiliary information for a series via the tag option.