AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.standalones.ColorRange Improve this Doc

Extends: anychart.core.ui.ColorRange

The ColorRange class contains methods for configuring standalones 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.
padding()Padding settings.
parentBounds()Parent bounds settings.
width()Axis width.
zIndex()Z-index of the element.
Miscellaneous
container()Getter for the color range container.
draw()Draw color range.

Methods Description

align

Getter for color range align settings.

Returns:

anychart.enums.Align | string - Color range align.
Setter for color range align settings.

Params:

NameTypeDefaultDescription
alignanychart.enums.Align | string
'center'
Color range align.

Returns:

anychart.standalones.ColorRange - Self instance for method chaining.

colorLineSize

Getter for the color line size.

Returns:

number - The color line size.
See listing
var size = colorRange.colorLineSize();
Setter for the color line size.

Params:

NameTypeDefaultDescription
sizenumber
10
Color line size to set.

Returns:

anychart.standalones.ColorRange - Self instance for method chaining.

container

Getter for the color range container.
Setter for the color range container.

Params:

NameTypeDescription
elementanychart.graphics.vector.Layer | anychart.graphics.vector.StageThe value to set.

Returns:

anychart.standalones.ColorRange - Self instance for method chaining.

draw

Draw color range.

Returns:

anychart.standalones.ColorRange - Self instance for method chaining.

drawFirstLabel

Getter for the first label drawing flag.

Returns:

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

Params:

NameTypeDefaultDescription
enabledboolean
true
Value to set.

Returns:

anychart.standalones.ColorRange - Self instance for method chaining.

drawLastLabel

Getter for the last label drawing flag.

Returns:

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

Params:

NameTypeDefaultDescription
enabledboolean
true
Value to set.

Returns:

anychart.standalones.ColorRange - 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.standalones.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
settingsObject | boolean | null
true
Value to set.

Returns:

anychart.standalones.ColorRange - Self instance for method chaining.

length

Getter for the color range line length.

Returns:

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

Params:

NameTypeDefaultDescription
lengthstring | number
'70%'
Color line length.

Returns:

anychart.standalones.ColorRange - 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.

marker

Getter for the color range marker.

Returns:

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

Params:

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

Returns:

anychart.standalones.ColorRange - Self instance for method chaining.

minorLabels

Getter for axis minor labels.

Returns:

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

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
false
Value to set.

Returns:

anychart.standalones.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
settingsObject | boolean | null
false
Value to set.

Returns:

anychart.standalones.ColorRange - Self instance for method chaining.

orientation

Getter for the axis orientation.

Returns:

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

Params:

NameTypeDefaultDescription
orientationanychart.enums.Orientation | string
'top'
Value to set.

Returns:

anychart.standalones.ColorRange - Self instance for method chaining.

overlapMode

Getter for labels overlap mode.

Returns:

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

Params:

NameTypeDefaultDescription
modeanychart.enums.LabelsOverlapMode | string
'noOverlap'
Value to set.

Returns:

anychart.standalones.ColorRange - Self instance for method chaining.

padding

Getter for padding settings object.

Returns:

anychart.core.ui.table.Padding - Padding settings object.
Setter for paddings in pixels using a single value.

Params:

NameTypeDescription
paddingnull | Array.<(number|string)> | ObjectPadding to set.

Returns:

anychart.standalones.ColorRange - Self instance for method chaining.
Examples for paddings
// all paddings 15px
colorRange.padding(15);
// all paddings 15px
colorRange.padding('15px');
// top and bottom 5px ,right and left 15px
colorRange.padding(anychart.utils.padding(5,15));
Setter for current cell paddings in pixels using several numbers.

Params:

NameTypeDescription
value1string | numberTop or top-bottom space.
value2string | numberRight or right-left space.
value3string | numberBottom space.
value4string | numberLeft space.

Returns:

anychart.standalones.ColorRange - Self instance for method chaining.
Examples for paddings
// 1) top and bottom 10px, left and right 15px
colorRange.cellPadding(10, '15px');
// 2) top 10px, left and right 15px, bottom 5px
colorRange.cellPadding(10, '15px', 5);
// 3) top 10px, right 15px, bottom 5px, left 12px
colorRange.cellPadding(10, '15px', '5px', 12);

parentBounds

Getter for parent bounds.
As a getter falls back to stage bounds.

Returns:

anychart.math.Rect - Parent bounds.
Setter for bounds using single value.

Params:

NameTypeDescription
boundsanychart.math.Rect | Object | nullParent bounds to set.

Returns:

anychart.standalones.ColorRange - Self instance for method chaining.
Setter for bounds using several values.

Params:

NameTypeDescription
leftnumberLeft space.
topnumberTop space.
widthnumberA width for a color range.
heightnumberA height for a color range.

Returns:

anychart.standalones.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 axis = chart.yAxis();
var axisScale = axis.scale();
Setter for the axis scale.

Params:

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

Returns:

anychart.standalones.ColorRange - Self instance for method chaining.

staggerLines

Getter for stagger lines.

Returns:

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

Params:

NameTypeDefaultDescription
countnumber
null
Count of stagger lines.

Returns:

anychart.standalones.ColorRange - Self instance for method chaining.

staggerMaxLines

Getter for maximum stagger lines.

Returns:

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

Params:

NameTypeDefaultDescription
countnumber | 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.standalones.ColorRange - Self instance for method chaining.

staggerMode

Getter for the stagger mode state.

Returns:

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

Params:

NameTypeDefaultDescription
enabledboolean
true
On/off stagger mode.

Returns:

anychart.standalones.ColorRange - Self instance for method chaining.

stroke

Getter for axis stroke settings.

Returns:

anychart.graphics.vector.Stroke - Axis stroke settings.
See listing
var yAxis = chart.yAxis();
var axisStroke = yAxis.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.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.standalones.ColorRange - Self instance for method chaining.
Setter for axis stroke settings using an object.

Params:

NameTypeDescription
settingsObjectObject with stroke settings from anychart.graphics.vector.Stroke

Returns:

anychart.standalones.ColorRange - Self instance for method chaining.

ticks

Getter for axis ticks.

Returns:

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

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
true
Value to set.

Returns:

anychart.standalones.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
settingsnull | boolean | Object | string
false
Value to set.

Returns:

anychart.standalones.ColorRange - 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.

width

Getter for the axis width.

Returns:

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

Params:

NameTypeDefaultDescription
widthnumber | string
null
Value to set.

Returns:

anychart.standalones.ColorRange - 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.standalones.ColorRange - Self instance for method chaining.