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.

Show Example:
jQuery

In this example, the point's fullState field is used to implement deselecting of a selected point. The function, which is assigned to the onPointClick option, checks the current state of the clicked point. If the point is selected, the selection will be removed using the clearSelection() method. Otherwise, the point will be selected using the point's select() method.


                                    

                                    

originalArgument

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

Show Example:
jQuery

Click a point on the chart to display the data about this point. In this example, the point's originalArgument field is used to receive a non-formatted name of a country.


                                    

                                    

originalCloseValue

Contains the close value of the point. This field is useful for points belonging to a series of the candle stick or stock type only.

Type: Number|String

originalHighValue

Contains the high value of the point. This field is useful for points belonging to a series of the candle stick or stock type only.

Type: Number|String

originalLowValue

Contains the low value of the point. This field is useful for points belonging to a series of the candle stick or stock type only.

Type: Number|String

originalMinValue

Contains the first value of the point. This field is useful for points belonging to a series of the range area or range bar type only.

NOTE: To get the second value of the point, use the originalValue field of the point.

originalOpenValue

Contains the open value of the point. This field is useful for points belonging to a series of the candle stick or stock type only.

Type: Number|String

originalValue

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

NOTE: If the point belongs to a series of the range area or range bar type, this field contains the second value of the point. To get the first value of the point, use the originalMinValue field.

Show Example:
jQuery

Click a point on the chart to display the data about this point. In this example, the point's originalValue field is used to receive a non-formatted population number of a country.


                                    

                                    

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.

Show Example:
jQuery

Click a point on the chart to display the data about this point. In this example, the point's series field is used to receive the name of the point series.


                                    

                                    

size

Contains the size of the bubble as it was set in the data source. This field is useful for points belonging to a series of the bubble type only.

Type: Number|String

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.

Show Example:
jQuery

In this example, сlick a point on the chart to select this point. The information about the corresponding country will be displayed. This information is received using the tag field.