Fields

Fields that provide information on the series point.

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

Type:

String

|

Number

|

Date

Show Example:
jQuery

Click a point on the chart to display the value of the point's originalArgument field.


                                    

                                    

originalValue

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

Type:

String

|

Number

|

Date

Show Example:
jQuery

Click a point on the chart to display the value of the point's originalValue field.


                                    

                                    

percent

Gets the percentage value of the specific point.

Type:

String

|

Number

|

Date

Show Example:
jQuery

Click a point on the chart to display the value of the point's percent field.


                                    

                                    

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 type of the point's series. Information about the series type is obtained using the point's series field.


                                    

                                    

tag

Returns the tag of the point.

Type: any

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.

Show Example:
jQuery

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