State – amCharts 5 Documentation

Type class

An object representing a collection of setting values to apply as required.

Sources

This information about State is provided for reference only and is not available through exported packages and thus should not be imported or used on its own.

Inheritance

State does not extend any other symbol.

State is not extended by any other symbol.

Settings

State does not have any settings.

Private settings

State does not have any private settings.

Properties

State does not have any properties.

Methods

apply() #	Returns `void` Applies the state to the target element. All setting values are set immediately.
applyAnimate( duration?: `undefined` \| `number` ) #	Returns `Animations` Applies the state to the target element. Returns an object representing all `Animation` objects created for each setting key transition.
constructor( entity: `E`, settings: `Partial` ) #	Returns `State`
get( key: `Key` ) #	Returns `[""]` Returns settings value for the specified `key`. If there is no value, `fallback` is returned instead (if set). Click here for more info
remove( key: `Key` ) #	Returns `void` Removes a setting value for the specified `key`. Click here for more info
set( key: `Key`, value: `[""]` ) #	Returns `void` Sets a setting `value` for the specified `key` to be set when the state is applied.
setAll( settings: `Partial` ) #	Returns `void` Sets multiple settings at once. `settings` must be an object with key: value pairs. Click here for more info

apply()

Returns void

Applies the state to the target element.

All setting values are set immediately.

applyAnimate(

duration?: undefined | number

)

Returns Animations

Applies the state to the target element.

Returns an object representing all Animation objects created for each setting key transition.

constructor(

entity: E,
settings: Partial

)

Returns State

get(

key: Key

)

Returns [""]

Returns settings value for the specified key.

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

Click here for more info

remove(

key: Key

)

Returns void

Removes a setting value for the specified key.

Click here for more info

set(

key: Key,
value: [""]

)

Returns void

Sets a setting value for the specified key to be set when the state is applied.

setAll(

settings: Partial

)

Returns void

Sets multiple settings at once.

settings must be an object with key: value pairs.

Click here for more info

Events

State does not have any events.