ChartAxis.valueToPositionInfo Method

Gets the axis position information for the given value.
 

Parameters

value

Type: Object
The axis value. Number.NEGATIVE_INFINITY is supported to represent the beginning of the axis, and Number.POSITIVE_INFINITY the end.
series

Type: ChartSeries
(optional) The series displaying the value on an X axis where data point series are offset from the values into clusters, as with clustered bar charts.
Optional: True
groupingIndex

Type: Number (Integer)
(optional) The zero-based index of the grouping of points within series, if any.
Optional: True

Return Value


Type: Object
An object with properties:
     position        [type: Number, mayBeNull: true]     - The position value relative to the range of the axis between 0.0 and 1.0, or null if none exists.
     isVisible       [type: Boolean]                     - True if the position is along the visible range of the axis (ignoring zooming).
 
 

Remarks

The axis position is relative to the X or Y dimension, which may be reversed. If this is an unreversed Y axis, 0 is the start at the bottom of the plotting area and 1 is the end at the top of the plotting area. If this is an unreversed X axis, 0 is the start at the left of the plotting area and 1 is the end at the right of the plotting area. The axis position is relative to the entire length of the axis, even if zoomed in so that only part of it is visible.