Top

class anychart.standalones.axisMarkers.Line Improve this Doc

Methods Overview

Specific settings
value()Value settings.
Axes and Scales
axis()Axis settings.
scale()Scale settings.
Coloring
stroke()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
isHorizontal()Whether a line marker has horizontal layout.
layout()Line marker layout.
parentBounds()Parent bounds for line marker.
zIndex()Z-index of the element.
Miscellaneous
container()Container for line marker.
draw()Drawing of the line marker.

Methods Description

axis

Getter for the line marker axis.

Returns:

anychart.core.axes.Linear - The line marker axis.

Try it:

Setter for the line marker axis.

Params:

Name Type Default Description
value anychart.core.axes.Linear
null
Value to set.

Returns:

anychart.core.axisMarkers.Line - Self instance for method chaining.

Try it:

container

Getter for the line marker current container.
Setter for the line marker current container.

Params:

Name Type Description
value anychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | Element The value to set.

Returns:

anychart.standalones.axisMarkers.Line - Self instance for method chaining.

Try it:

draw

Drawing of the line marker.

Returns:

anychart.standalones.axisMarkers.Line - 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:

isHorizontal

Whether a line marker has horizontal layout. Layout is define by anychart.core.axisMarkers.Line#layout method.

Returns:

boolean - Returns true if the line marker's layout is horizontal.

Try it:

layout

Getter for the line marker layout.

Returns:

anychart.enums.Layout string - The line marker layout.

Try it:

Setter for the line marker layout.

Params:

Name Type Default Description
value anychart.enums.Layout | string
"horizontal"
Line marker layout.

Returns:

anychart.core.axisMarkers.Line - Self instance for method chaining.

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:

parentBounds

Getter for bounds.

Returns:

anychart.math.Rect - Current stage bounds.
Setter for bounds using single value.

Params:

Name Type Description
value anychart.math.Rect | Object | null Value to set

Returns:

anychart.standalones.axisMarkers.Line - Self instance for method chaining.

Try it:

Setter for bounds using several values.

Params:

Name Type Description
left number Left space
top number Top space
width number Width line marker
height number Height line marker

Returns:

anychart.standalones.axisMarkers.Line - Self instance for method chaining.

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:

scale

Getter for the line marker scale.

Returns:

anychart.scales.Base - The line marker scale.
Setter for the line marker scale.

Params:

Name Type Description
value anychart.scales.Base Value to set.

Returns:

anychart.core.axisMarkers.Line - Self instance for method chaining.

Try it:

stroke

Getter for the line marker stroke.

Returns:

string anychart.graphics.vector.Stroke - Line marker settings.
See listing
var lineMarkerSettings = chart.lineMarker();
var currentStroke = lineMarkerSettings.stroke();
Setter for the line marker stroke.

Params:

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

Returns:

anychart.core.axisMarkers.Line - Self instance for method chaining.

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:

value

Getter for the line marker value.

Returns:

number - Line marker value settings.
Setter for the line marker value.

Params:

Name Type Default Description
newValue number
0
Line marker value settings.

Returns:

anychart.core.axisMarkers.Line - 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: