AnyChart
API Reference
Still have questions?
Contact support
Top
You are looking at an outdated 7.10.1 version of this document. Switch to the 8.4.0 version to see the up to date information.

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

Gets for the current crosshair display mode.

Returns:

anychart.enums.CrosshairDisplayMode - The current crosshair display mode.
Sets for the display mode for crosshair.

Params:

NameTypeDefaultDescription
valueanychart.enums.CrosshairDisplayMode | string
"float"
Display mode.

Returns:

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

enabled

Getter for the current element state (enabled or disabled).

Returns:

boolean - The current element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
valueboolean
true
Value 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:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback 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 }.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopescopeObject in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback method.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopescopeObject in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

print

Prints all elements on related stage.

Params:

NameTypeDefaultDescription
paperSizeanychart.graphics.vector.PaperSize
Paper size.
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:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback method.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopescopeObject 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 current crosshair x-label settings.

Returns:

anychart.core.ui.CrosshairLabel - The current crosshair x-label settings.
Setter for the crosshair x-label settings.

Params:

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

Returns:

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

xStroke

Getter for the current x-line stroke.

Returns:

anychart.graphics.vector.Stroke - The current x-line stroke.
Setter for the x-line stroke.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Stroke | string | null
"#cecece"
Stroke settings.
thicknessnumber
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinanychart.graphics.vector.StrokeLineJoin
Line joint style.
lineCapanychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

yLabel

Getter for the current crosshair y-label settings.

Returns:

anychart.core.ui.CrosshairLabel - The current crosshair y-label settings.
Setter for the crosshair y-label settings.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
true
Y-label

Returns:

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

yStroke

Getter for the current y-line stroke.

Returns:

anychart.graphics.vector.Stroke - Self instance for method chaining.
Setter for the y-line stroke.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Stroke | string | null
"#cecece"
Stroke settings.
thicknessnumber
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinanychart.graphics.vector.StrokeLineJoin
Line joint style.
lineCapanychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
valuenumber
0
Value to set.

Returns:

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