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

class anychart.palettes.RangeColors Improve this Doc

Extends: anychart.core.Base

Gradient palette.

Methods Overview

Specific settings
count()Colors counts.
itemAt()Color by index.
items()Colors list.
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.

Methods Description

count

Getter for color palette colors counts.

Returns:

number - Current color palette colors count.
Setter for color palette's colors counts.
Note: Defines how many steps we need in gradient.

Params:

Name Type Default Description
value number
NaN
Color palette colors counts.

Returns:

anychart.palettes.RangeColors - Self instance for method chaining.

Try it:

itemAt

Getter for color palette colors from list by index.

Params:

Name Type Description
index number Index to get color.

Returns:

anychart.graphics.vector.SolidFill - Color palette colors by index.

Try it:

Setter for color palette colors from list by index.

Params:

Name Type Description
index number Index to set color.
color anychart.graphics.vector.SolidFill Color to set by passed index.

Returns:

anychart.palettes.RangeColors - Self instance for method chaining.

Try it:

items

Getter for color palette colors list.

Returns:

Array.<anychart.graphics.vector.SolidFill> - Color palette colors list.
Setter for color palette colors list.

Params:

Name Type Description
value Array.<anychart.graphics.vector.SolidFill> | anychart.graphics.vector.LinearGradientFill | anychart.graphics.vector.RadialGradientFill | Array.<anychart.graphics.vector.GradientKey> | Array.<string> | anychart.graphics.vector.SolidFill | string Color palette colors list to set.
var_args anychart.graphics.vector.SolidFill | string Another colors.

Returns:

anychart.palettes.RangeColors - Self instance for method chaining.

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:

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:

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: