AnyChart
API Reference
Still have questions?
Contact support
    Top
    You are looking at an outdated v7 version of this document. Switch to the v8 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

    align()Since version 7.6.0

    Getter for color range align settings.

    Returns:

    anychart.enums.Align - Color range align.

    Try it:

    align(value)Since version 7.6.0

    Setter for color range align settings.

    Params:

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

    Returns:

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

    Try it:

    colorLineSize

    colorLineSize()Since version 7.6.0

    Getter for the color line size.

    Returns:

    number - Color line size

    Try it:

    colorLineSize(value)Since version 7.6.0

    Setter for the color line size.

    Params:

    NameTypeDefaultDescription
    valuenumber
    20
    		 Value to set.

    Returns:

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

    Try it:

    drawFirstLabel

    drawFirstLabel()

    Getter for the first label drawing flag.

    Returns:

    boolean - Drawing flag.
    See listing
    var currentAxis = chart.yAxis();
var flag = currentAxis.drawFirstLabel();

    drawFirstLabel(value)

    Setter for the first label drawing flag.

    Params:

    NameTypeDefaultDescription
    valueboolean
    true
    		 Value to set.

    Returns:

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

    Try it:

    drawLastLabel

    drawLastLabel()

    Getter for the last label drawing flag.

    Returns:

    boolean - Drawing flag.
    See listing
    var currentAxis = chart.yAxis();
var flag = currentAxis.drawLastLabel();

    drawLastLabel(value)

    Setter for the last label drawing flag.

    Params:

    NameTypeDefaultDescription
    valueboolean
    true
    		 Value to set.

    Returns:

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

    Try it:

    enabled

    enabled()

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

    Returns:

    boolean - The current element state.

    Try it:

    enabled(value)

    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);

    Try it:

    getRemainingBounds

    getRemainingBounds()

    Returns remaining parent bounds to use elsewhere.

    Returns:

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

    Try it:

    isHorizontal

    isHorizontal()

    Whether an axis is horizontal.

    Returns:

    boolean - Returns true if the axis is horizontal.

    Try it:

    labels

    labels()

    Getter for axis labels.

    Returns:

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

    Try it:

    labels(value)

    Setter for axis labels.

    Params:

    NameTypeDefaultDescription
    valueObject | boolean | null
    true
    		 Value to set.

    Returns:

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

    Try it:

    length

    length()Since version 7.6.0

    Getter for the color range line length.

    Returns:

    number | string - Color line length.

    Try it:

    length(value)Since version 7.6.0

    Setter for the current color range line length.

    Params:

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

    Returns:

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

    Try it:

    listen

    listen(type, listener, useCapture, listenerScope)

    Adds an event listener to an implementing object.

    Params:

    NameTypeDefaultDescription
    typestring
    		The event type id.
    listenerfunction
    		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.
    Try it:
    listenOnce
    listenOnce(type, listener, useCapture, listenerScope)
    Adds an event listener to an implementing object.
    Params:
    NameTypeDefaultDescription
    typestring
    		The event type id.
    listenerfunction
    		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.
    Try it:
    marker
    marker()Since version 7.6.0
    Getter for the color range marker.
    Returns:
    anychart.core.ui.MarkersFactory.Marker - Color range marker.
    Try it:
    marker(value)Since version 7.6.0
    Getter for the color range marker.
    Params:
    NameTypeDescription
    valueanychart.core.ui.MarkersFactory.Marker | ObjectMarker or marker settings.
    Returns:
    anychart.core.ui.ColorRange - Self instance for method chaining.
    Try it:
    minorLabels
    minorLabels()
    Getter for axis minor labels.
    Returns:
    anychart.core.ui.LabelsFactory - Axis labels instance.
    Try it:
    minorLabels(value)
    Setter for axis minor labels.
    Params:
    NameTypeDefaultDescription
    valueObject | boolean | null
    false
    		 Value to set.
    Returns:
    anychart.core.ui.ColorRange - Self instance for method chaining.
    Try it:
    minorTicks
    minorTicks()
    Getter for minor axis ticks.
    Returns:
    anychart.core.axes.Ticks - Axis ticks.
    Try it:
    minorTicks(value)
    Setter for minor axis ticks.
    Params:
    NameTypeDefaultDescription
    valueObject | boolean | null
    false
    		 Value to set.
    Returns:
    anychart.core.ui.ColorRange - Self instance for method chaining.
    Try it:
    orientation
    orientation()
    Getter for the axis orientation.
    Returns:
    anychart.enums.Orientation - Axis orientation.
     See listing
    var currentAxis = chart.yAxis();
var axisOrientation = currentAxis.orientation();
    orientation(value)
    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.
    Try it:
    overlapMode
    overlapMode()
    Getter for labels overlap mode.
    Returns:
    anychart.enums.LabelsOverlapMode - Overlap mode.
    Try it:
    overlapMode(value)
    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.
    Try it:
    print
    print(paperSizeOrOptions, landscape)
    Prints all elements on related stage.
    Params:
    NameTypeDefaultDescription
    paperSizeOrOptionsanychart.graphics.vector.PaperSize | Object
    		Paper size or object with options.
    landscapeboolean
    false
    		 Flag of landscape.
    Try it:
    removeAllListeners
    removeAllListeners(type)
    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.
    Try it:
    scale
    scale()
    Getter for the axis scale.
    Returns:
    anychart.scales.Base - Axis scale.
     See listing
    var currentAxis = chart.yAxis();
var axisScale = currentAxis.scale();
    scale(value)
    Setter for the axis scale.
    Params:
    NameTypeDescription
    valueanychart.scales.BaseValue to set.
    Returns:
    anychart.core.ui.ColorRange - Self instance for method chaining.
    Try it:
    staggerLines
    staggerLines()
    Getter for stagger lines.
    Returns:
    number - Stagger line settings.
     See listing
    var currentAxis = chart.yAxis();
var lines = currentAxis.staggerLines();
    staggerLines(value)
    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.
    Try it:
    staggerMaxLines
    staggerMaxLines()
    Getter for maximum stagger lines.
    Returns:
    number - Stagger line settings.
     See listing
    var currentAxis = chart.yAxis();
var maxLines = currentAxis.staggerMaxLines();
    staggerMaxLines(value)
    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.
    Try it:
    staggerMode
    staggerMode()
    Getter for the stagger mode state.
    Returns:
    boolean - Stagger mode state.
     See listing
    var currentAxis = chart.yAxis();
var flag = currentAxis.staggerMode();
    staggerMode(value)
    Setter for the stagger mode state.
    Params:
    NameTypeDefaultDescription
    valueboolean
    true
    		 On/off stagger mode.
    Returns:
    anychart.core.ui.ColorRange - Self instance for method chaining.
    Try it:
    stroke
    stroke()
    Getter for axis stroke settings.
    Returns:
    anychart.graphics.vector.Stroke - Axis stroke settings.
     See listing
    var currentAxis = chart.yAxis();
var axisStroke = currentAxis.stroke();
    stroke(value, thickness, dashpattern, lineJoin, lineCap)
    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.
    Try it:
    ticks
    ticks()
    Getter for axis ticks.
    Returns:
    anychart.core.axes.Ticks - Axis ticks.
    Try it:
    ticks(value)
    Setter for axis ticks.
    Params:
    NameTypeDefaultDescription
    valueObject | boolean | null
    true
    		 Value to set.
    Returns:
    anychart.core.ui.ColorRange - Self instance for method chaining.
    Try it:
    title
    title()
    Getter for the axis title.
    Returns:
    anychart.core.ui.Title - Axis title.
    Try it:
    title(value)
    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.
    Try it:
    unlisten
    unlisten(type, listener, useCapture, listenerScope)
    Removes a listener added using listen() or listenOnce() methods.
    Params:
    NameTypeDefaultDescription
    typestring
    		The event type id.
    listenerfunction
    		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.
    Try it:
    unlistenByKey
    unlistenByKey(key)
    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.
    Try it:
    width
    width()
    Getter for the axis width.
    Returns:
    number | string | null - Axis width.
     See listing
    var currentYAxis = chart.yAxis();
var axisWidth = currentYAxis.width();
    width(value)
    Setter for the axis width.
    Params:
    NameTypeDefaultDescription
    valuenumber | string
    null
    		 Value to set.
    Returns:
    anychart.core.ui.ColorRange - Self instance for method chaining.
    Try it:
    zIndex
    zIndex()
    Getter for the current Z-index of the element.
    Returns:
    number - The current zIndex.
    Try it:
    zIndex(value)
    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.
    Try it:
    AnyChart - The most comprehensive JavaScript charting library