States – amCharts 5 Documentation

Type class

The State objects of an element, by name, such as "hover" or "hidden".

Sources

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

Inheritance

States does not extend any other symbol.

States is not extended by any other symbol.

Settings

States does not have any settings.

Private settings

States does not have any private settings.

Properties

States does not have any properties.

Methods

apply( newState: `string` ) #	Returns `void` Applies the state called `newState` to the element at once, without animation.
applyAnimate( newState: `string`, duration?: `undefined` \| `number` ) #	Returns `Animations` \| `undefined` Applies the state called `newState` to the element, animating each setting to its new value. Returns the `Animation` objects, by setting key, or `undefined` if there is no such state.
constructor( entity: `E` ) #	Returns `States`
create( name: `string`, settings: `Partial` ) #	Returns `State` Creates the state called `name` with `settings`, or adds `settings` to it if it already exists.
lookup( name: `string` ) #	Returns `State` \| `undefined` Returns the state called `name`, or `undefined` if there is none.
remove( name: `string` ) #	Returns `void` Removes the state called `name`.

apply(

newState: string

)

Returns void

Applies the state called newState to the element at once, without animation.

applyAnimate(

newState: string,
duration?: undefined | number

)

Returns Animations | undefined

Applies the state called newState to the element, animating each setting to its new value. Returns the Animation objects, by setting key, or undefined if there is no such state.

constructor(

entity: E

)

Returns States

create(

)

Returns State

Creates the state called name with settings, or adds settings to it if it already exists.

lookup(

)

Returns State | undefined

Returns the state called name, or undefined if there is none.

remove(

)

Returns void

Removes the state called name.

Events

States does not have any events.