AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.axisMarkers.Line Improve this Doc

Extends: anychart.core.VisualBase

Line marker.

Methods Overview

Specific settings
value()Value settings.
Axes and Scales
axis()Axis settings.
scale()Scale settings.
scaleRangeMode()Scale range mode.
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.
zIndex()Z-index of the element.

Methods Description

axis

Getter for the line marker axis.

Returns:

anychart.core.axes.Linear - The line marker axis.
Setter for the line marker axis.

Params:

NameTypeDefaultDescription
axisanychart.core.axes.Linear
null
Axis to set.

Returns:

anychart.core.axisMarkers.Line - 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.axisMarkers.Line - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

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.

layout

Getter for the line marker layout.

Returns:

anychart.enums.Layout | string - The line marker layout.
Setter for the line marker layout.

Params:

NameTypeDefaultDescription
layoutanychart.enums.Layout | string
'horizontal'
Line marker layout.

Returns:

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

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.

scale

Getter for the line marker scale.

Returns:

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

Params:

NameTypeDefaultDescription
settingsanychart.scales.Base | Object | anychart.enums.ScaleTypes | string
anychart.scales.Linear
Scale settings to set.

Returns:

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

scaleRangeMode

Getter for the scale range mode.

Returns:

string - Scale range mode.
See listing
var lineMarker = chart.lineMarker();
var scaleRangeMode = lineMarker.scaleRangeMode();
Setter for the scale range mode.
Whether to consider the line marker value in the scale calculation or not. The 'consider' mode consideres the marker value in the scale.

Params:

NameTypeDefaultDescription
modestring | anychart.enums.ScaleRangeMode
'none'
Mode to set.

Returns:

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

stroke

Getter for the line marker stroke.

Returns:

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

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
'#7c868e 1'
Stroke settings.
thicknessnumber
2
Line thickness.
dashpatternstring
'none'
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
'miter'
Line joint style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
'square'
Line cap style.

Returns:

anychart.core.axisMarkers.Line - Self instance for method chaining.
Setter for price indicator stroke settings using an object.

Params:

NameTypeDefaultDescription
settingsObject
{color: '#7c868e', opacity: 1, thickness: 2, dash: 'none', lineJoin: 'miter', opacity: 1, thickness: 2}
Object with stroke settings from anychart.graphics.vector.Stroke

Returns:

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

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.

value

Getter for the line marker value.

Returns:

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

Params:

NameTypeDefaultDescription
newValuenumber
0
Line marker value settings.

Returns:

anychart.core.axisMarkers.Line - 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.axisMarkers.Line - Self instance for method chaining.