A newer version of this page is available. Switch to the current version.

JavaScript/jQuery Chart - Point.Fields

Fields that provide information on the series point.

aggregationInfo

Provides information about the aggregation interval and the data objects that fall within it.

See Also

data

Contains the data object that the series point represents.

Type: any

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

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.

Type:

String

|

Number

|

Date

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

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

Type:

String

|

Number

|

Date

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.

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.

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: 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 property of the series.