Documentation

InterfaceColors

Type class

Presets for common UI elements.

Sources

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

// InterfaceColors is available in all of the following modules.
// You only need to import one of them.

/**
 * --------------------------------------------------------
 * Import from: "index.ts"
 * Use like: am5.InterfaceColors
 * --------------------------------------------------------
 */
import * as am5 from "@amcharts/amcharts5";


// InterfaceColors is available in all of the following modules.
// You only need to import one of them.

/**
 * --------------------------------------------------------
 * Include via: <script src="index.js"></script>
 * Access items like: am5.InterfaceColors
 * --------------------------------------------------------
 */

Inheritance

InterfaceColors extends Entity.

InterfaceColors is not extended by any other symbol.

Settings

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

Read about settings concept.

alternativeBackground
#

Type Color

Alternative background, for elements that need to contrast with primary background.
alternativeText
#

Type Color

Alternative text color, used for inverted (dark) backgrounds.
background
#

Type Color

Chart background color.
disabled
#

Type Color

Color for disabled elements.
fill
#

Type Color

Used for generic fills.
grid
#

Type Color

Grid color.
id
#

Type undefined | string

Inherited from IEntitySettings

A custom string ID for the element.

If set, element can be looked up via am5.registry.entitiesById.

Will raise error if an element with the same ID already exists.
negative
#

Type Color

Color to indicate negative value.
positive
#

Type Color

Color to indicate positive value.
primaryButton
#

Type Color

Primary button fill color.
primaryButtonActive
#

Type Color

Primary button fill color when it is set as active.
primaryButtonDown
#

Type Color

Primary button fill color when pressing down on it.
primaryButtonHover
#

Type Color

Primary button fill color on hover.
primaryButtonStroke
#

Type Color

Primary button stroke (outline) color.
primaryButtonText
#

Type Color

Primary button text color.
secondaryButton
#

Type Color

Secondary button fill color.
secondaryButtonActive
#

Type Color

Secondary button fill color when it is set as active.
secondaryButtonDown
#

Type Color

Secondary button fill color when pressing down on it.
secondaryButtonHover
#

Type Color

Secondary button fill color on hover.
secondaryButtonStroke
#

Type Color

Secondary button stroke (outline) color.
secondaryButtonText
#

Type Color

Secondary button text color.
stateAnimationDuration
#

Type undefined | number

Inherited from IEntitySettings

Duration of transition from one state to another.
stateAnimationEasing
#

Type $ease.Easing

Inherited from IEntitySettings

Easing of transition from one state to another.
stroke
#

Type Color

Used for generic outlines.
text
#

Type Color

Label text color.
themeTags
#

Type Array

Inherited from IEntitySettings

Tags which can be used by the theme rules.

Click here for more info

themeTagsSelf
#

Type Array

Inherited from IEntitySettings

Tags which can be used by the theme rules.

These tags only apply to this object, not any children.

Click here for more info

themes
#

Type Array

Inherited from IEntitySettings

A list of themes applied to the element.
userData
#

Type any

Inherited from IEntitySettings

A storage for any custom user data that needs to be associated with the element.
There are 7 inherited items currently hidden from this list.

Private settings

Properties

adapters
#

Type Adapters

Default new Adapters(this)

Inherited from Entity
className
#

Static

Type string

Default "InterfaceColors"
classNames
#

Static

Type Array

Default "InterfaceColors", "Entity"
events
#

Type EventDispatcher

Default this._createEvents()

Inherited from Entity
root
#

Type Root

Inherited from Entity

An instance of Root object.

@readonly
@since 5.0.6

states
#

Type States

Default new States(this)

Inherited from Entity
template
#

Type Template | undefined

Inherited from Entity

@todo needs description

uid
#

Type number

Default ++counter

Inherited from Settings

Unique ID.
There are 6 inherited items currently hidden from this list.

Methods

animate(

options: AnimationOptions

)

#

Returns Animation

Inherited from Settings

Animates setting values from current/start values to new ones.

Click here for more info

dispose()

#

Returns void

Inherited from Settings

Disposes this object.

get(

key: Key,
fallback: F

)

#

Returns NonNullable | F

Inherited from Entity

Returns settings value for the specified key.

If there is no value, fallback is returned instead (if set).

Click here for more info

isDisposed()

#

Returns boolean

Inherited from Settings

Returns true if this element is disposed.

isType(

type: string

)

#

Returns this

Inherited from Entity

Checks if element is of certain class (or inherits one).

new(

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

)

#

Static

Returns T

Inherited from Entity

Use this method to create an instance of this class.

Click here for more info

on(

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

)

#

Returns IDisposer

Inherited from Settings

Sets a callback function to invoke when specific key of settings changes or is set.

Click here for more info

remove(

key: Key

)

#

Returns void

Inherited from Entity

Removes a setting value for the specified key.

Click here for more info

removeAll()

#

Returns void

Inherited from Settings

Removes all keys;

Click here for more info

set(

key: Key,
value: Value

)

#

Returns Value

Inherited from Entity

Sets a setting value for the specified key, and returns the same value.

Click here for more info

setAll(

settings: Partial

)

#

Returns void

Inherited from Settings

Sets multiple settings at once.

settings must be an object with key: value pairs.

Click here for more info

setTimeout(

fn: () => void,
delay: number

)

#

Returns IDisposer

Inherited from Entity

Creates and returns a "disposable" timeout.
There are 12 inherited items currently hidden from this list.

Events

InterfaceColors does not have any events.