Top
You are looking at an outdated 7.13.0 version of this document. Switch to the 8.0.1 version to see the up to date information.

class anychart.standalones.axisMarkers.Range Improve this Doc

Methods Overview

Axes and Scales
axis()Axis settings.
scale()Scale settings.
Coloring
fill()Fill 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
from()Starting range marker value.
isHorizontal()Whether a range marker has horizontal layout.
layout()Layout settings.
parentBounds()Parent bounds for range marker.
to()Ending range marker value.
zIndex()Z-index of the element.
Miscellaneous
container()Container for range marker.
draw()Drawing of the range marker.

Methods Description

axis

Getter for the range marker axis.

Returns:

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

Try it:

Setter for the range 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 range marker current container.
Setter for the range 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.Range - Self instance for method chaining.

Try it:

draw

Drawing of the range marker.

Returns:

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

fill

Getter for the range marker fill.

Returns:

anychart.graphics.vector.Fill - Range marker settings.
See listing
var rangeMarkerSettings = chart.rangeMarker();
var currentFill = rangeMarkerSettings.fill();
Setter for fill settings using an array or a string. Learn more about coloring.

Params:

Name Type Default Description
value anychart.graphics.vector.Fill
"#000 0.3"
Color as an object or a string.

Returns:

anychart.core.axisMarkers.Range - Self instance for method chaining.
Fill color with opacity. Fill as a string or an object.

Params:

Name Type Default Description
color string
"#000"
Color as a string.
opacity number
0.3
Color opacity.

Returns:

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

Try it:

Linear gradient fill. Learn more about coloring.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Gradient keys.
angle number Gradient angle.
mode boolean | anychart.graphics.vector.Rect | Object Gradient mode.
opacity number Gradient opacity.

Returns:

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

Try it:

Radial gradient fill. Learn more about coloring.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Color-stop gradient keys.
cx number X ratio of center radial gradient.
cy number Y ratio of center radial gradient.
mode anychart.graphics.math.Rect If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity number Opacity of the gradient.
fx number X ratio of focal point.
fy number Y ratio of focal point.

Returns:

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

Try it:

Params:

Name Type Description
imageSettings anychart.graphics.vector.Fill Object with settings.

Returns:

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

Try it:

from

Getter for the starting range marker value.

Returns:

number - The starting range marker value.
See listing
var rangeMarkerSettings = chart.rangeMarker();
var startingValue = rangeMarkerSettings.from();
Setter for the starting range marker value.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

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

Try it:

isHorizontal

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

Returns:

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

Try it:

layout

Getter for the range marker layout.

Returns:

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

Try it:

Setter for the range marker layout.

Params:

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

Returns:

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

Try it:

listen

Adds an event listener to an implementing object.

Params:

Name Type 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 Whether to fire in capture phase (defaults to false).
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 Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
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.Range - 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.Range - 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 range marker scale.

Returns:

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

Params:

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

Returns:

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

Try it:

to

Getter for the ending range marker value.

Returns:

number - The ending range marker value.
See listing
var rangeMarkerSettings = chart.rangeMarker();
var endingValue = rangeMarkerSettings.to();
Setter for the ending range marker value.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

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

Try it:

unlisten

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

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
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:

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: