Documentation

InterfaceColorSet

Type class

This module contains a version of ColorSet that can (and should) be used for coloring UI elements.

The main difference from the basic ColorSet is that instead of sequenced colors, it uses a concept of named colors.

This way, every element in the UI can extract an exact color theme author meant for the specific purpose, like strokes, backgrounds, etc.

Click here for color-related info

Sources

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

/**
 * --------------------------------------------------------
 * Import from: "core.ts"
 * Use like: am4core.InterfaceColorSet
 * --------------------------------------------------------
 */
import * as am4core from "@amcharts/amcharts4/core";


/**
 * --------------------------------------------------------
 * Include via: <script src="core.js"></script>
 * Access items like: am4.InterfaceColorSet
 * --------------------------------------------------------
 */

Inheritance

InterfaceColorSet extends BaseObject.

InterfaceColorSet is not extended by any other symbol.

Properties

clonedFrom
#

Type $type.Optional < this >

Inherited from BaseObject

Reference to the original object this object was cloned from. We need to keep this so we can disassociate it from source object when this object is disposed.
config
#

Type object

Inherited from BaseObject

Use this property to set JSON-based config. When set, triggers processing routine, which will go through all properties, and try to apply values, create instances, etc.

Use this with caution, as it is a time-consuming process. It's used for initialchart setup only, not routine operations.
id
#

Type $type.Optional < string >

Inherited from BaseObject

Sets the user-defined id of the element.
uid
#

Type string

Inherited from BaseObject

Returns object's internal unique ID.
There are 4 inherited items currently hidden from this list.

Methods

clone(

cloneId?: string

)

#

Returns this

Inherited from BaseObject

Makes a copy of this object and returns the clone. Try to avoid cloning complex objects like chart, create new instances if you need them.

constructor()

#

Returns InterfaceColorSet

Constructor

copyFrom(

object: this

)

#

Returns void

Inherited from BaseObject

Copies all properties and related data from different element.

dispose()

#

Returns void

Inherited from BaseObject

Destroys this object and all related data.

getCurrentThemes()

#

Returns ITheme[]

Inherited from BaseObject

Returns a list of themes that should be applied to this element. It could either be a list of themes set explicitly on this element, or system-wide.

getFor(

purpose: ...

)

#

Returns Color

Returns a color to be used for the specific purpose.

let uicolors = new am4core.InterfaceColorSet();
console.log(uicolors.getFor("stroke"));

var uicolors = new am4core.InterfaceColorSet();
console.log(uicolors.getFor("stroke"));

isDisposed()

#

Returns boolean

Inherited from BaseObject

Returns if this object has been already been disposed.

setFor(

purpose: ...,
color: Color

)

#

Returns void

Sets color to be used for the specific purpose.
There are 5 inherited items currently hidden from this list.

Events

InterfaceColorSet does not have any events.

Adapters

InterfaceColorSet does not have any adapters.