Top

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.

Try it:

Setter for color range align setting.

Params:

Name Type Default Description
value anychart.enums.Align | string
"center"
Color range align.

Returns:

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

Try it:

colorLineSize

Getter for the current color line size.

Returns:

number - The current color line size

Try it:

Setter for the color line size.

Params:

Name Type Default Description
value number
20
Value to set.

Returns:

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

Try it:

drawFirstLabel

Getter for the first label drawing flag.

Returns:

boolean - Drawing flag.
Setter for the first label drawing flag.

Params:

Name Type Default Description
value boolean
true
Value to set.

Returns:

anychart.core.axes.Linear - Self instance for method chaining.

Try it:

drawLastLabel

Getter for the last label drawing flag.

Returns:

boolean - Drawing flag.
Setter for the last label drawing flag.

Params:

Name Type Default Description
value boolean
true
Value to set.

Returns:

anychart.core.axes.Linear - 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:

getRemainingBounds

Returns remaining parent bounds to use elsewhere.

Returns:

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

Try it:

isHorizontal

Whether an axis is horizontal.

Returns:

boolean - Returns true if the axis is horizontal.

Try it:

labels

Getter for axis labels.

Returns:

anychart.core.ui.LabelsFactory - Axis labels instance.

Try it:

Setter for axis labels.

Params:

Name Type Default Description
value Object | boolean | null
true
Value to set.

Returns:

anychart.core.axes.Linear - Self instance for method chaining.

length

Getter for the current color range line length.

Returns:

number string - Color line length.

Try it:

Setter for the current color range line length.

Params:

Name Type Default Description
value string | number
"70%"
Color line length.

Returns:

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

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:

marker

Getter for the current color range marker.

Returns:

anychart.core.ui.MarkersFactory.Marker - Color range marker.

Try it:

Getter for the color range marker.

Params:

Name Type Description
value anychart.core.ui.MarkersFactory.Marker | Object Marker or marker settings.

Returns:

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

Try it:

minorLabels

Getter for axis minor labels.

Returns:

anychart.core.ui.LabelsFactory - Axis labels instance.

Try it:

Setter for axis minor labels.

Params:

Name Type Default Description
value Object | boolean | null
false
Value to set.

Returns:

anychart.core.axes.Linear - Self instance for method chaining.

minorTicks

Getter for minor axis ticks.

Returns:

anychart.core.axes.Ticks - Axis ticks.

Try it:

Setter for minor axis ticks.

Params:

Name Type Default Description
value Object | boolean | null
false
Value to set.

Returns:

anychart.core.axes.Linear - Self instance for method chaining.

orientation

Getter for axis orientation.

Returns:

anychart.enums.Orientation - Axis orientation.
Setter for axis orientation.

Params:

Name Type Default Description
value string | anychart.enums.Orientation
"top"
Value to set.

Returns:

anychart.core.axes.Linear - Self instance for method chaining.

Try it:

overlapMode

Getter for overlap mode for labels.

Returns:

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

Params:

Name Type Default Description
value anychart.enums.LabelsOverlapMode | string
"noOverlap"
Value to set.

Returns:

anychart.core.axes.Linear - Self instance for method chaining.

Try it:

print

Prints all elements on related stage.

Params:

Name Type Default Description
paperSize anychart.graphics.vector.PaperSize
Paper size.
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 axis scale.

Returns:

anychart.scales.Base - Axis scale.
Setter for axis scale.

Params:

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

Returns:

anychart.core.axes.Linear - Self instance for method chaining.

Try it:

staggerLines

Getter for stagger lines.

Returns:

number - Current stagger line settings.
Setter for stagger lines.
Note: pass null to enable autocalculation.

Params:

Name Type Default Description
value number
null
Count of stager lines.

Returns:

anychart.core.axes.Linear - Self instance for method chaining.

Try it:

staggerMaxLines

Getter for maximum stagger lines.

Returns:

number - Current stagger line settings.
Setter for maximum stagger lines in autocalculation mode (if anychart.core.axes.Linear#staggerLines passed null).

Params:

Name Type Default Description
value number | 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.axes.Linear - Self instance for method chaining.

Try it:

staggerMode

Getter for stagger mode state.

Returns:

boolean - Current stagger mode state.
Setter for stagger mode state.

Params:

Name Type Default Description
value boolean
true
On/off stagger mode.

Returns:

anychart.core.axes.Linear - Self instance for method chaining.

Try it:

stroke

Getter for axis stroke settings.

Returns:

anychart.graphics.vector.Stroke - Axis line stroke settings.
Setter for axis stroke settings. Learn more about stroke settings.

Params:

Name Type Default Description
value anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null
"#eaeaea"
Stroke settings.
thickness number
1
Line thickness.
dashpattern string
Controls the pattern of dashes and gaps used to stroke paths.
lineJoin anychart.graphics.vector.StrokeLineJoin
'round'
Line join style.
lineCap anychart.graphics.vector.StrokeLineCap
'square'
Line cap style.

Returns:

anychart.core.axes.Linear - Self instance for method chaining.

Try it:

ticks

Getter for axis ticks.

Returns:

anychart.core.axes.Ticks - Axis ticks.

Try it:

Setter for axis ticks.

Params:

Name Type Default Description
value Object | boolean | null
true
Value to set.

Returns:

anychart.core.axes.Linear - Self instance for method chaining.

title

Getter for the axis title.

Returns:

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

Params:

Name Type Default Description
value null | boolean | Object | string
false
Value to set.

Returns:

anychart.core.axes.Linear - Self instance for method chaining.

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:

width

Getter for axis width.

Returns:

number string null - The current axis width.
Setter for axis width.

Params:

Name Type Default Description
value number | string
null
Value to set.

Returns:

anychart.core.axes.Linear - Self instance for method chaining.

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: