TemplateState – amCharts 5 Documentation

Type class

A state of a Template, passed on to every object that uses the template.

Sources

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

Inheritance

TemplateState does not extend any other symbol.

TemplateState is not extended by any other symbol.

Settings

TemplateState does not have any settings.

Private settings

TemplateState does not have any private settings.

Properties

TemplateState does not have any properties.

Methods

constructor( name: `string`, template: `Template`, settings: `Partial` ) #	Returns `TemplateState`
get( key: `Key` ) #	Returns `[""]` Returns the state's value of setting `key`, or `fallback` if it has none.
remove( key: `Key` ) #	Returns `void` Removes setting `key` from the state.
set( key: `Key`, value: `[""]` ) #	Returns `void` Sets the value setting `key` takes in this state, for every object that uses the template.
setAll( settings: `Partial` ) #	Returns `void` Sets several of the state's settings at once.

constructor(

name: string,
template: Template,
settings: Partial

)

Returns TemplateState

get(

key: Key

)

Returns [""]

Returns the state's value of setting key, or fallback if it has none.

remove(

key: Key

)

Returns void

Removes setting key from the state.

set(

key: Key,
value: [""]

)

Returns void

Sets the value setting key takes in this state, for every object that uses the template.

setAll(

settings: Partial

)

Returns void

Sets several of the state's settings at once.

Events

TemplateState does not have any events.