Top
You are looking at an outdated 7.14.3 version of this document. Switch to the 8.0.1 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

Getter for the crosshair display mode.

Returns:

anychart.enums.CrosshairDisplayMode - Crosshair display mode.

Try it:

Setter for the display mode for crosshair.

Params:

Name Type Default Description
value anychart.enums.CrosshairDisplayMode | string
"float"
Display mode.

Returns:

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

Try it:

enabled

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

Returns:

boolean - The current element state.

Try it:

Setter for the element enabled state.

Params:

Name Type Default Description
value boolean
true
Value to set.

Returns:

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

Try it:

listen

Adds an event listener to an implementing object.

Params:

Name Type Default Description
type string
The event type id.
listener function
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 }.
useCapture boolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope Object
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

listenOnce

Adds an event listener to an implementing object.

Params:

Name Type Default Description
type string
The event type id.
listener function
Callback method.
useCapture boolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope Object
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

print

Prints all elements on related stage.

Params:

Name Type Default Description
paperSizeOrOptions anychart.graphics.vector.PaperSize | Object
Paper size or object with options.
landscape boolean
false
Flag of landscape.

Try it:

removeAllListeners

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

Params:

Name Type Description
type string Type of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

Try it:

unlisten

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

Params:

Name Type Default Description
type string
The event type id.
listener function
Callback method.
useCapture boolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope Object
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

Try it:

unlistenByKey

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

Params:

Name Type Description
key Object The key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

Try it:

xLabel

Getter for the crosshair X-label settings.

Returns:

anychart.core.ui.CrosshairLabel - Crosshair X-label settings.

Try it:

Setter for the crosshair X-label settings.

Params:

Name Type Default Description
value Object | 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.

Try it:

Setter for the X-line stroke.

Params:

Name Type Default Description
value anychart.graphics.vector.Stroke | string | null
"#cecece"
Stroke settings.
thickness number
Line thickness.
dashpattern string
Controls the pattern of dashes and gaps used to stroke paths.
lineJoin anychart.graphics.vector.StrokeLineJoin
Line joint style.
lineCap anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

Try it:

yLabel

Getter for the crosshair Y-label settings.

Returns:

anychart.core.ui.CrosshairLabel - Crosshair Y-label settings.

Try it:

Setter for the crosshair Y-label settings.

Params:

Name Type Default Description
value Object | 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.

Try it:

Setter for the Y-line stroke.

Params:

Name Type Default Description
value anychart.graphics.vector.Stroke | string | null
"#cecece"
Stroke settings.
thickness number
Line thickness.
dashpattern string
Controls the pattern of dashes and gaps used to stroke paths.
lineJoin anychart.graphics.vector.StrokeLineJoin
Line joint style.
lineCap anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

Try it:

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.

Try it:

Setter for the Z-index of the element.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it: