AnyChart
API Reference
Still have questions?
Contact support
Top
You are looking at an outdated 7.13.1 version of this document. Switch to the 8.4.0 version to see the up to date information.

class anychart.core.ui.ColorRange Improve this Doc

Extends: anychart.core.axes.Linear

Color range.

Methods Overview

Specific settings
drawFirstLabel()Drawing of the first label.
drawLastLabel()Drawing of the last label.
labels()Labels settings.
marker()Marker settings.
minorLabels()Minor labels settings.
minorTicks()Minor ticks settings.
overlapMode()Overlap mode for labels.
scale()Scale settings.
staggerLines()Stagger lines.
staggerMaxLines()Maximum stagger lines.
staggerMode()Stagger mode state.
ticks()Ticks settings.
title()Title 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
align()Align setting.
colorLineSize()Color line size.
getRemainingBounds()Returns remaining parent bounds to use elsewhere.
isHorizontal()Whether an axis is horizontal.
length()Length setting.
orientation()Axis orientation.
width()Axis width.
zIndex()Z-index of the element.

Methods Description

align

Getter for the current color range align setting.

Returns:

anychart.enums.Align - The current color range align.
Setter for color range align setting.

Params:

NameTypeDefaultDescription
valueanychart.enums.Align | string
"center"
Color range align.

Returns:

anychart.core.ui.ColorRange - Color range align or self for chaining.

colorLineSize

Getter for the current color line size.

Returns:

number - The current color line size
Setter for the color line size.

Params:

NameTypeDefaultDescription
valuenumber
20
Value to set.

Returns:

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

drawFirstLabel

Getter for the first label drawing flag.

Returns:

boolean - Drawing flag.
See listing
var currentAxis = chart.yAxis();
var flag = currentAxis.drawFirstLabel();
Setter for the first label drawing flag.

Params:

NameTypeDefaultDescription
valueboolean
true
Value to set.

Returns:

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

drawLastLabel

Getter for the last label drawing flag.

Returns:

boolean - Drawing flag.
See listing
var currentAxis = chart.yAxis();
var flag = currentAxis.drawLastLabel();
Setter for the last label drawing flag.

Params:

NameTypeDefaultDescription
valueboolean
true
Value to set.

Returns:

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

enabled

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

Returns:

boolean - The current element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
valueboolean
true
Value to set.

Returns:

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

getRemainingBounds

Returns remaining parent bounds to use elsewhere.

Returns:

anychart.math.Rect - Parent bounds without the space used by the title.

isHorizontal

Whether an axis is horizontal.

Returns:

boolean - Returns true if the axis is horizontal.

labels

Getter for axis labels.

Returns:

anychart.core.ui.LabelsFactory - Axis labels instance.
Setter for axis labels.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
true
Value to set.

Returns:

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

length

Getter for the current color range line length.

Returns:

number | string - Color line length.
Setter for the current color range line length.

Params:

NameTypeDefaultDescription
valuestring | number
"70%"
Color line length.

Returns:

anychart.core.ui.ColorRange - Color line length.

listen

Adds an event listener to an implementing object.

Params:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback 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 }.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopeObjectObject in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback method.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopeObjectObject in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

marker

Getter for the current color range marker.

Returns:

anychart.core.ui.MarkersFactory.Marker - Color range marker.
Getter for the color range marker.

Params:

NameTypeDescription
valueanychart.core.ui.MarkersFactory.Marker | ObjectMarker or marker settings.

Returns:

anychart.core.ui.ColorRange - Color range marker.

minorLabels

Getter for axis minor labels.

Returns:

anychart.core.ui.LabelsFactory - Axis labels instance.
Setter for axis minor labels.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
false
Value to set.

Returns:

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

minorTicks

Getter for minor axis ticks.

Returns:

anychart.core.axes.Ticks - Axis ticks.
Setter for minor axis ticks.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
false
Value to set.

Returns:

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

orientation

Getter for the axis orientation.

Returns:

anychart.enums.Orientation - Axis orientation.
See listing
var currentAxis = chart.yAxis();
var axisOrientation = currentAxis.orientation();
Setter for the axis orientation.

Params:

NameTypeDefaultDescription
valuestring | anychart.enums.Orientation
"top"
Value to set.

Returns:

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

overlapMode

Getter for labels overlap mode.

Returns:

anychart.enums.LabelsOverlapMode - Overlap mode.
Setter for labels overlap mode.

Params:

NameTypeDefaultDescription
valueanychart.enums.LabelsOverlapMode | string
"noOverlap"
Value to set.

Returns:

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

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 axis scale.

Returns:

anychart.scales.Base - Axis scale.
See listing
var currentAxis = chart.yAxis();
var axisScale = currentAxis.scale();
Setter for the axis scale.

Params:

NameTypeDescription
valueanychart.scales.BaseValue to set.

Returns:

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

staggerLines

Getter for stagger lines.

Returns:

number - Stagger line settings.
See listing
var currentAxis = chart.yAxis();
var lines = currentAxis.staggerLines();
Setter for stagger lines.
Note: pass null to enable autocalculation.

Params:

NameTypeDefaultDescription
valuenumber
null
Count of stagger lines.

Returns:

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

staggerMaxLines

Getter for maximum stagger lines.

Returns:

number - Stagger line settings.
See listing
var currentAxis = chart.yAxis();
var maxLines = currentAxis.staggerMaxLines();
Setter for maximum stagger lines in autocalculation mode (if anychart.core.axes.Linear#staggerLines passed null).

Params:

NameTypeDefaultDescription
valuenumber | null
2
Limits the number of lines to be used when drawing labels. If we need less – we use less, but never – more.

Returns:

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

staggerMode

Getter for the stagger mode state.

Returns:

boolean - Stagger mode state.
See listing
var currentAxis = chart.yAxis();
var flag = currentAxis.staggerMode();
Setter for the stagger mode state.

Params:

NameTypeDefaultDescription
valueboolean
true
On/off stagger mode.

Returns:

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

stroke

Getter for axis stroke settings.

Returns:

anychart.graphics.vector.Stroke - Axis stroke settings.
See listing
var currentAxis = chart.yAxis();
var axisStroke = currentAxis.stroke();
Setter for axis stroke settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
valueanychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null
"#CECECE"
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinanychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapanychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

ticks

Getter for axis ticks.

Returns:

anychart.core.axes.Ticks - Axis ticks.
Setter for axis ticks.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
true
Value to set.

Returns:

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

title

Getter for the axis title.

Returns:

anychart.core.ui.Title - Axis title.
Setter for the axis title.

Params:

NameTypeDefaultDescription
valuenull | boolean | Object | string
false
Value to set.

Returns:

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

unlisten

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

Params:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback method.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopeObjectObject 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.

width

Getter for the axis width.

Returns:

number | string | null - Axis width.
See listing
var currentYAxis = chart.yAxis();
var axisWidth = currentYAxis.width();
Setter for the axis width.

Params:

NameTypeDefaultDescription
valuenumber | string
null
Value to set.

Returns:

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

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
valuenumber
0
Value to set.

Returns:

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