AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.ui.Crosshair Improve this Doc

Extends: anychart.core.VisualBase

Crosshair class.

Methods Overview

Specific settings
displayMode()Display mode.
xLabel()X-label settings
yLabel()Y-label settings
Coloring
xStroke()X-line stroke settings.
yStroke()Y-line stroke settings.
Events
listen()Adds an event listener
listenOnce()Adds a single time event listener
removeAllListeners()Removes all listeners
unlisten()Removes the listener
unlistenByKey()Removes the listener by the key
Export
print()Prints all elements.
Interactivity
enabled()Element state (enabled or disabled).
Size and Position
zIndex()Z-index of the element.

Methods Description

displayMode

Getter for the crosshair display mode.

Returns:

anychart.enums.CrosshairDisplayMode | string - Crosshair display mode.
Setter for the display mode for crosshair.

Params:

NameTypeDescription
modeanychart.enums.CrosshairDisplayMode | stringDisplay mode. 'float' is the default value for Scatter charts, 'sticky' for Stock charts. Note, the display mode isn't used for Cartesian charts.

Returns:

anychart.core.ui.Crosshair - Self instance for method chaining.

enabled

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
enabledboolean
true
Enabled state to set.

Returns:

anychart.core.ui.Crosshair - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
Callback method. Function that looks like:
function(event){
   // event.actualTarget - actual event target
   // event.currentTarget - current event target
   // event.iterator - event iterator
   // event.originalEvent - original event
   // event.point - event point
   // event.pointIndex - event point index
}
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

print

Prints all elements on related stage.

Params:

NameTypeDefaultDescription
paperSizeOrOptionsanychart.graphics.vector.PaperSize | Object
Paper size or object with options.
landscapeboolean
false
Flag of landscape.

removeAllListeners

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

Params:

NameTypeDescription
typestringType of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

unlisten

Removes a listener added using listen() or listenOnce() methods.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object):boolean|undefined
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

unlistenByKey

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

NameTypeDescription
keyObjectThe key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

xLabel

Getter for the crosshair X-label settings.

Params:

NameTypeDefaultDescription
indexnumber
0
X-label index.

Returns:

anychart.core.ui.CrosshairLabel - Crosshair X-label settings.
Setter for the crosshair X-label settings.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
true
X-label settings.

Returns:

anychart.core.ui.Crosshair - Self instance for method chaining.
Setter for the crosshair X-label settings by index.

Params:

NameTypeDefaultDescription
indexnumber
0
X-label index.
settingsObject | boolean | null
true
X-label settings.

Returns:

anychart.core.ui.Crosshair - Self instance for method chaining.

xStroke

Getter for the X-line stroke.

Returns:

anychart.graphics.vector.Stroke - X-line stroke settings.
Setter for the X-line stroke.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | string | null
'#969EA5'
Stroke settings.
thicknessnumber
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line joint style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.ui.Crosshair - Self instance for method chaining.

yLabel

Getter for the crosshair Y-label settings.

Params:

NameTypeDefaultDescription
indexnumber
0
Y-label index.

Returns:

anychart.core.ui.CrosshairLabel - Crosshair Y-label settings.
Setter for the crosshair Y-label settings.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
true
Y-label.

Returns:

anychart.core.ui.Crosshair - Self instance for method chaining.
Setter for the crosshair Y-label settings by index.

Params:

NameTypeDefaultDescription
indexnumber
0
Y-label index.
settingsObject | boolean | null
true
Y-label

Returns:

anychart.core.ui.Crosshair - Self instance for method chaining.

yStroke

Getter for the Y-line stroke.

Returns:

anychart.graphics.vector.Stroke - Y-line stroke settings.
Setter for the Y-line stroke.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | string | null
'#969EA5'
Stroke settings.
thicknessnumber
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line joint style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.ui.Crosshair - Self instance for method chaining.

zIndex

Getter for the Z-index of the element.

Returns:

number - Z-index.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
zIndexnumber
0
Value to set.

Returns:

anychart.core.ui.Crosshair - Self instance for method chaining.