ColorSet – amCharts 5 Documentation

Type class

A list of colors that series and other elements take in turn. When the list runs out, it generates more.

Sources

ColorSet can be used (imported) via one of the following packages.

// Import ColorSet
import * as am5 from "@amcharts/amcharts5";

// Create ColorSet
am5.ColorSet.new(root, {
  // ... config if applicable
});

<!-- Load ColorSet -->
<script src="index.js"></script>

<script>
// Create ColorSet
am5.ColorSet.new(root, {
  // ... config if applicable
});
</script>

Inheritance

ColorSet extends Entity.

ColorSet is not extended by any other symbol.

Settings

Set these settings on a ColorSet object using its set() and setAll() methods.

Read about settings concept.

animations #	Type `Array` Inherited from `IEntitySettings` Animations the element plays on its own, described as data - so they can be set from a JSON config and saved with it. Each one animates a setting of the element (or, with `target: "dataItem"`, a value of its data item - a map point's `positionOnLine`, say). They start when the setting is applied, restart when it changes, and stop when the element is disposed. A saved config keeps what was configured, never a value caught half way through an animation. sprite.set("animations", [ { key: "rotation", to: 360, duration: 4000, loops: 0 }, { key: "scale", from: 1, to: 1.3, duration: 800, loops: 0, yoyo: true, easing: "sine" } ]); @since 5.20.8
baseColor #	Type `Color` A base color to generate new colors from if `colors` is not set.
colors #	Type `Color[]` The colors in the set. Generated colors are added to this list.
id #	Type `undefined` \| `string` Inherited from `IEntitySettings` A unique ID for looking the element up in `root.entitiesById`. Setting an ID that another element already has throws an error.
ignoreThemes #	Type `undefined` \| `false` \| `true` Default `false` Inherited from `IEntitySettings` Ignores themes: no theme rule applies to the element, not even one of the default theme. @since 5.15.6
passOptions #	Type `IColorSetStepOptions` How the colors generated when the list runs out differ from the original list. Each time the list runs out, a new pass of colors is added, shifted by these amounts once more.
reuse #	Type `undefined` \| `false` \| `true` Default `false` Repeats the list from the start when it runs out, instead of generating new colors.
saturation #	Type `undefined` \| `number` Saturation for every color the set returns, from `0` (grey) to `1`.
startIndex #	Type `undefined` \| `number` Default `0` Index of the color the first `next()` returns, and `reset()` goes back to.
stateAnimationDuration #	Type `undefined` \| `number` Default `0` Inherited from `IEntitySettings` How long, in milliseconds, a switch from one state to another animates. `0` switches at once.
stateAnimationEasing #	Type `$ease.Easing` Default `out(cubic)` Inherited from `IEntitySettings` Easing of the animated switch from one state to another.
step #	Type `undefined` \| `number` Default `1` How many positions `next()` moves each time: `2` returns every second color.
themeTags #	Type `Array` Inherited from `IEntitySettings` Tags that theme rules can target. They also count for the element's children, so a rule can match a child by a tag of its parent. Click here for more info
themeTagsSelf #	Type `Array` Inherited from `IEntitySettings` Tags that theme rules can target, like `themeTags`, but only for this element, not its children. Click here for more info
themes #	Type `Array` Inherited from `IEntitySettings` Themes applied to the element and everything inside it.
userData #	Type `any` Inherited from `IEntitySettings` Any data of your own to keep with the element.
There are 9 inherited items currently hidden from this list.

Private settings

These are read-only settings accessible from a ColorSet object using its getPrivate() method.

Read about private settings.

currentPass #	Read only Type `undefined` \| `number`
currentStep #	Read only Type `undefined` \| `number`

currentPass
#

Read only

Type undefined | number

currentStep
#

Read only

Type undefined | number

Properties

adapters #	Type `Adapters` Default `new Adapters(this)` Inherited from `Entity`
className #	Static Type `string` Default `"ColorSet"`
classNames #	Static Type `Array` Default `"ColorSet", "Entity"`
enableDispose #	Type `boolean` Default `true` Inherited from `Settings` Set to `false` to make `dispose()` do nothing.
events #	Type `EventDispatcher` Default `this._createEvents()` Inherited from `Entity`
root #	Type `Root` Inherited from `Entity` The `Root` the object belongs to. @readonly @since 5.0.6
states #	Type `States` Default `new States(this)` Inherited from `Entity`
template #	Type `Template` \| `undefined` Inherited from `Entity` A `Template` applied to the object. Its settings apply where the object has none set of its own.
uid #	Type `number` Default `++counter` Inherited from `Settings` A unique number, given to each object as it is created.
There are 7 inherited items currently hidden from this list.

Methods

animate( options: `AnimationOptions` ) #	Returns `Animation` Inherited from `Settings` Animates a setting from its current value (or `from`) to `to`. The setting jumps to `from` at once. With `duration` `0`, or no value to start from, it is set to `to` at once and the returned animation is already stopped. Click here for more info
dispose() #	Returns `void` Inherited from `Settings` Disposes the object, freeing everything it holds. A disposed object can't be used again.
get( key: `Key`, fallback: `F` ) #	Returns `NonNullable` \| `F` Inherited from `Entity` Returns the value of setting `key`, run through any adapters, or `fallback` if it is not set. Click here for more info
getIndex( index: `number` ) #	Returns `Color` Returns the `Color` at `index`, generating more colors if the list is shorter.
has( key: `Key` ) #	Returns `boolean` Inherited from `Settings` Returns `true` if setting `key` is set. Click here for more info
isDisposed() #	Returns `boolean` Inherited from `Settings` Returns `true` if the object has been disposed.
isType( type: `string` ) #	Returns `this` Inherited from `Entity` Returns `true` if the object is of class `type` or extends it.
new( root: `Root`, settings: `ITSettings`, template?: `Template` ) #	Static Returns `T` Inherited from `Entity` Creates an instance of the class. Use it instead of `new Class()`. Click here for more info
next() #	Returns `Color` Returns the next `Color` in the list, `step` positions after the last one. Generates more colors when the list runs out.
off( key: `Key`, callback?: `undefined` \| ( value: `[""]`, target: `this`, key: `Key`) => `void` ) #	Returns `void` Inherited from `Settings` Removes a callback added with `on()`. Without `callback`, removes all of them for `key`. Click here for more info @since 5.9.2
offDebounced( key: `Key`, callback?: `undefined` \| ( value: `[""]`, target: `this`, key: `Key`) => `void` ) #	Returns `void` Inherited from `Settings` Removes a callback added with `onDebounced()`. Without `callback`, removes all of them for `key`. Click here for more info
offDebouncedPrivate( key: `Key`, callback?: `undefined` \| ( value: `[""]`, target: `this`, key: `Key`) => `void` ) #	Returns `void` Inherited from `Settings` Removes a callback added with `onPrivateDebounced()`. Without `callback`, removes all of them for `key`. Click here for more info
offPrivate( key: `Key`, callback?: `undefined` \| ( value: `[""]`, target: `this`, key: `Key`) => `void` ) #	Returns `void` Inherited from `Settings` Removes a callback added with `onPrivate()`. Without `callback`, removes all of them for `key`. Click here for more info @since 5.9.2
on( key: `Key`, callback: ( value: `[""]`, target: `this`, key: `Key`) => `void` ) #	Returns `IDisposer` Inherited from `Settings` Calls `callback` each time the value of setting `key` changes or is removed. Setting the same value again does not call it. Click here for more info
onDebounced( key: `Key`, callback: ( value: `[""]`, target: `this`, key: `Key`) => `void`, debounceDelay: `number` ) #	Returns `IDisposer` Inherited from `Settings` Like `on()`, but waits until setting `key` has not changed for `debounceDelay` milliseconds, then calls `callback` once with the latest value. Click here for more info
onPrivate( key: `Key`, callback: ( value: `[""]`, target: `this`, key: `Key`) => `void` ) #	Returns `IDisposer` Inherited from `Settings` Calls `callback` each time the value of private setting `key` changes. Click here for more info
onPrivateDebounced( key: `Key`, callback: ( value: `[""]`, target: `this`, key: `Key`) => `void`, debounceDelay: `number` ) #	Returns `IDisposer` Inherited from `Settings` Like `onPrivate()`, but waits until private setting `key` has not changed for `debounceDelay` milliseconds, then calls `callback` once with the latest value. Click here for more info
once( key: `Key`, callback: ( value: `[""]`, target: `this`, key: `Key`) => `void` ) #	Returns `IDisposer` Inherited from `Settings` Like `on()`, but the callback is removed after it is called once. Click here for more info @since 5.20.4
onceDebounced( key: `Key`, callback: ( value: `[""]`, target: `this`, key: `Key`) => `void`, debounceDelay: `number` ) #	Returns `IDisposer` Inherited from `Settings` Like `onDebounced()`, but the callback is removed after it is called once. Click here for more info @since 5.20.4
remove( key: `Key` ) #	Returns `void` Inherited from `Entity` Removes the value set for setting `key`. The setting goes back to the value from a theme or template, if one has it. Click here for more info
removeAll() #	Returns `void` Inherited from `Settings` Removes all settings, as `remove()` does for each one. Click here for more info
reset() #	Returns `void` Starts over, so the next `next()` returns the color at `startIndex`.
set( key: `Key`, value: `Value` ) #	Returns `Value` Inherited from `Entity` Sets setting `key` to `value` and returns `value`. A value set this way overrides themes and templates, and stops any animation of the setting. Click here for more info
setAll( settings: `Partial` ) #	Returns `void` Inherited from `Settings` Sets several settings at once, from an object of key-value pairs. Click here for more info
setTimeout( fn: () => `void`, delay: `number` ) #	Returns `IDisposer` Inherited from `Entity` Calls `fn` after `delay` milliseconds, unless the object is disposed first. Disposing the returned disposer cancels it.
There are 22 inherited items currently hidden from this list.

animate(

options: AnimationOptions

)

Returns Animation

Inherited from Settings

Animates a setting from its current value (or from) to to. The setting jumps to from at once. With duration 0, or no value to start from, it is set to to at once and the returned animation is already stopped.

Click here for more info

dispose()

Returns void

Inherited from Settings

Disposes the object, freeing everything it holds. A disposed object can't be used again.

get(

key: Key,
fallback: F

)

Returns NonNullable | F

Inherited from Entity

Returns the value of setting key, run through any adapters, or fallback if it is not set.

Click here for more info

getIndex(

index: number

)

Returns Color

Returns the Color at index, generating more colors if the list is shorter.

has(

key: Key

)

Returns boolean

Inherited from Settings

Returns true if setting key is set.

Click here for more info

isDisposed()

Returns boolean

Inherited from Settings

Returns true if the object has been disposed.

isType(

type: string

)

Returns this

Inherited from Entity

Returns true if the object is of class type or extends it.

new(

root: Root,
settings: ITSettings,
template?: Template

)

Static

Returns T

Inherited from Entity

Creates an instance of the class. Use it instead of new Class().

Click here for more info

next()

Returns Color

Returns the next Color in the list, step positions after the last one. Generates more colors when the list runs out.

off(

key: Key,
callback?: undefined | ( value: [""], target: this, key: Key) => void

)

Returns void

Inherited from Settings

Removes a callback added with on(). Without callback, removes all of them for key.

Click here for more info
@since 5.9.2

offDebounced(

key: Key,
callback?: undefined | ( value: [""], target: this, key: Key) => void

)

Returns void

Inherited from Settings

Removes a callback added with onDebounced(). Without callback, removes all of them for key.

Click here for more info

offDebouncedPrivate(

key: Key,
callback?: undefined | ( value: [""], target: this, key: Key) => void

)

Returns void

Inherited from Settings

Removes a callback added with onPrivateDebounced(). Without callback, removes all of them for key.

Click here for more info

offPrivate(

key: Key,
callback?: undefined | ( value: [""], target: this, key: Key) => void

)

Returns void

Inherited from Settings

Removes a callback added with onPrivate(). Without callback, removes all of them for key.

Click here for more info
@since 5.9.2

on(

key: Key,
callback: ( value: [""], target: this, key: Key) => void

)

Returns IDisposer

Inherited from Settings

Calls callback each time the value of setting key changes or is removed. Setting the same value again does not call it.

Click here for more info

onDebounced(

key: Key,
callback: ( value: [""], target: this, key: Key) => void,
debounceDelay: number

)

Returns IDisposer

Inherited from Settings

Like on(), but waits until setting key has not changed for debounceDelay milliseconds, then calls callback once with the latest value.

Click here for more info

onPrivate(

key: Key,
callback: ( value: [""], target: this, key: Key) => void

)

Returns IDisposer

Inherited from Settings

Calls callback each time the value of private setting key changes.

Click here for more info

onPrivateDebounced(

key: Key,
callback: ( value: [""], target: this, key: Key) => void,
debounceDelay: number

)

Returns IDisposer

Inherited from Settings

Like onPrivate(), but waits until private setting key has not changed for debounceDelay milliseconds, then calls callback once with the latest value.

Click here for more info

once(

key: Key,
callback: ( value: [""], target: this, key: Key) => void

)

Returns IDisposer

Inherited from Settings

Like on(), but the callback is removed after it is called once.

Click here for more info
@since 5.20.4

onceDebounced(

key: Key,
callback: ( value: [""], target: this, key: Key) => void,
debounceDelay: number

)

Returns IDisposer

Inherited from Settings

Like onDebounced(), but the callback is removed after it is called once.

Click here for more info
@since 5.20.4

remove(

key: Key

)

Returns void

Inherited from Entity

Removes the value set for setting key. The setting goes back to the value from a theme or template, if one has it.

Click here for more info

removeAll()

Returns void

Inherited from Settings

Removes all settings, as remove() does for each one.

Click here for more info

reset()

Returns void

Starts over, so the next next() returns the color at startIndex.

set(

key: Key,
value: Value

)

Returns Value

Inherited from Entity

Sets setting key to value and returns value. A value set this way overrides themes and templates, and stops any animation of the setting.

Click here for more info

setAll(

settings: Partial

)

Returns void

Inherited from Settings

Sets several settings at once, from an object of key-value pairs.

Click here for more info

setTimeout(

fn: () => void,
delay: number

)

Returns IDisposer

Inherited from Entity

Calls fn after delay milliseconds, unless the object is disposed first. Disposing the returned disposer cancels it.

There are 22 inherited items currently hidden from this list.

Events

ColorSet does not have any events.