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.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:

NameTypeDefaultDescription
valuenumber
NaN
Color palette colors counts.

Returns:

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

itemAt

Getter for color palette colors from list by index.

Params:

NameTypeDescription
indexnumberIndex to get color.

Returns:

anychart.graphics.vector.SolidFill - Color palette colors by index.
Setter for color palette colors from list by index.

Params:

NameTypeDescription
indexnumberIndex to set color.
coloranychart.graphics.vector.SolidFillColor to set by passed index.

Returns:

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

items

Getter for color palette colors list.

Returns:

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

Params:

NameTypeDescription
valueArray.<anychart.graphics.vector.SolidFill> | anychart.graphics.vector.LinearGradientFill | anychart.graphics.vector.RadialGradientFill | Array.<anychart.graphics.vector.GradientKey> | Array.<string> | anychart.graphics.vector.SolidFill | stringColor palette colors list to set.
var_argsanychart.graphics.vector.SolidFill | stringAnother colors.

Returns:

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

listen

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.

listenOnce

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.

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.

unlisten

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.

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.