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. |
| 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
Setter for the line marker axis.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| axis | anychart.core.axes.Linear | null | Axis to set. |
Returns:
anychart.core.axisMarkers.Line - Self instance for method chaining.Try it:
enabled
Getter for the element state (enabled or disabled).
Returns:
boolean - Element state.Try it:
Setter for the element enabled state.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | true | Enabled state to set. |
Returns:
anychart.core.axisMarkers.Line - 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 |
|---|---|---|---|
| layout | anychart.enums.Layout | string | 'horizontal' | Line marker layout. |
Returns:
anychart.core.axisMarkers.Line - Self instance for method chaining.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 | Default | Description |
|---|---|---|---|
| settings | anychart.scales.Base | Object | anychart.enums.ScaleTypes | string | anychart.scales.Linear | Scale settings to set. |
Returns:
anychart.core.axisMarkers.Line - Self instance for method chaining.Try it:
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.
Whether to consider the line marker value in the scale calculation or not. The 'consider' mode consideres the marker value in the scale.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| mode | string | anychart.enums.ScaleRangeMode | 'none' | Mode 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 stroke = lineMarkerSettings.stroke();
Setter for the line marker stroke.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null | '#7c868e 1' | Stroke settings. |
| thickness | number | 2 | Line thickness. |
| dashpattern | string | 'none' | Controls the pattern of dashes and gaps used to stroke paths. |
| lineJoin | string | anychart.graphics.vector.StrokeLineJoin | 'miter' | Line joint style. |
| lineCap | string | anychart.graphics.vector.StrokeLineCap | 'square' | Line cap style. |
Returns:
anychart.core.axisMarkers.Line - Self instance for method chaining.Try it:
Setter for price indicator stroke settings using an object.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | {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.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
Setter for the Z-index of the element.
Detailed description
The bigger the index - the higher the element position is.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| zIndex | number | 0 | Value to set. |
Returns:
anychart.core.axisMarkers.Line - Self instance for method chaining.Try it: