new CursorOptions()
The CursorOptions object defines the configuration options to display crosshair over the hover/touch area, tooltips for some or all nearby series data items, as well as tooltips on axes. Use the cursor option to specify different configuration options to show the cursor (crosshair over the hover/touch area, tooltips for some or all nearby series data items, as well as tooltips on axes).
For instance, the "visible" option:
cursor: { visible: true }shows the cursor (crosshair over the hover/touch area, tooltips for some or all nearby series data items, as well as tooltips on axes)
Members
(static) showCursorCategoryLine :ShowCursorCategoryLineEnum
The showCursorCategoryLine field specifies the flags to show the vertical/horizontal category/x-line, when the crosshair cursor hovers the chart.
Type:
- ShowCursorCategoryLineEnum
Example
null {null}, no vertical/horizontal category/x-line is shown
"near" {string} or 1 {number}, the vertical/horizontal category/x-line is shown when the pointer is near the category(static) showCursorSerieTooltip :ShowCursorSerieTooltipEnum
The showCursorSerieTooltip field defines the flags to show the tooltips, when the crosshair cursor hovers the charts of the series.
Type:
- ShowCursorSerieTooltipEnum
Example
null {null}, no tooltip is displayed when the crosshair cursor hovers the chart
"near" {string} or 1 {number}, the vertical/horizontal category/x-line indicates the series whose tooltip is displayed, when the crosshair cursor hovers the chart (default)(static) showCursorValueLine :boolean
The showCursorValueLine field shows or hides the horizontal/vertical value/y-line, when the crosshair cursor hovers the chart
Type:
- boolean
Example
null {null}, the horizontal/vertical value/y-line is shown
false {boolean}, the horizontal/vertical value/y-line is hidden
true {boolean}, the horizontal/vertical value/y-line is shown when the pointer hovers the chart(static) showCursorXLine :boolean
The showCursorXLine field shows or hides the vertical y-line, when the crosshair cursor hovers the chart (available for xy-chart types only)
Type:
- boolean
Example
null {null}, the vertical y-line is shown
false {boolean}, the vertical y-line is hidden
true {boolean}, the vertical y-line is shown when the pointer hovers the chart(static) showCursorYLine :boolean
The showCursorYLine field shows or hides the horizontal x-line, when the crosshair cursor hovers the chart (available for xy-chart types only)
Type:
- boolean
Example
null {null}, the horizontal x-line is shown
false {boolean}, the horizontal x-line is hidden
true {boolean}, the horizontal x-line is shown when the pointer hovers the chart(static) smooth :number
The smooth field defines the time in ms the cursor goes from one layout to another.
Type:
- number
Example
null {null}, inherits the smooth option of the control
0 {number}, no smooth changes once the cursor goes from a layout to another
125 {number}, specifies that a smooth-transition is performed from a layout to another for 125 ms.(static) visible :boolean
The visible field shows or hides the cursor (crosshair over the hover/touch area, tooltips for some or all nearby series data items, as well as tooltips on axes). The "cursorLine" shape defines the visual-appearance (frameColor, frameSize, frameDash) to display the crosshair over the hover/touch area.
Type:
- boolean