Template

Type class

Sources

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

// Import Template
import * as am5 from "@amcharts/amcharts5";

// Create Template
am5.Template.new(root, {
  // ... config if applicable
});

<!-- Load Template -->
<script src="index.js"></script>

<script>
// Create Template
am5.Template.new(root, {
  // ... config if applicable
});
</script>

Inheritance

Template does not extend any other symbol.

Template is not extended by any other symbol.

Settings

Template does not have any settings.

Private settings

Template does not have any private settings.

Properties

adapters #	Type `TemplateAdapters` Default `new TemplateAdapters()`
entities #	Type `Array` Array of all entities using this template.
events #	Type `EventDispatcher` Default `new EventDispatcher()`
setup #	Type ( entity: `O`) => `void` \| `undefined`
states #	Type `TemplateStates` Default `new TemplateStates(this)`

Methods

constructor( settings: `IESettings`, isReal: `boolean` ) #	Returns `Template`
dispose() #	Returns `void` Disposes this object.
get( key: `Key` ) #	Returns `[""]`
getPrivate( key: `Key`, fallback: `F` ) #	Returns `void`
isDisposed() #	Returns `boolean` Returns `true` if this element is disposed.
new( settings: `IESettings` ) #	Static Returns `Template` Use this method to create an instance of this class. Click here for more info
on( key: `Key`, callback: ( value: `[""]`, target: `E`, key: `Key`) => `void` ) #	Returns `IDisposer`
onPrivate( key: `Key`, callback: ( value: `[""]`, target: `E`, key: `Key`) => `void` ) #	Returns `IDisposer`
remove( key: `Key` ) #	Returns `void`
removeAll() #	Returns `void`
removePrivate( key: `Key` ) #	Returns `void`
set( key: `Key`, value: `[""]` ) #	Returns `void`
setAll( value: `Partial` ) #	Returns `void`
setPrivate( key: `Key`, value: `Value` ) #	Returns `Value`
setPrivateRaw( key: `Key`, value: `Value` ) #	Returns `Value`
setRaw( key: `Key`, value: `[""]` ) #	Returns `void`

constructor(

settings: IESettings,
isReal: boolean

)

Returns Template

dispose()

Returns void

Disposes this object.

get(

key: Key

)

Returns [""]

getPrivate(

key: Key,
fallback: F

)

Returns void

isDisposed()

Returns boolean

Returns true if this element is disposed.

new(

settings: IESettings

)

Static

Returns Template

Use this method to create an instance of this class.

Click here for more info

on(

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

)

Returns IDisposer

onPrivate(

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

)

Returns IDisposer

remove(

key: Key

)

Returns void

removeAll()

Returns void

removePrivate(

key: Key

)

Returns void

set(

key: Key,
value: [""]

)

Returns void

setAll(

value: Partial

)

Returns void

setPrivate(

key: Key,
value: Value

)

Returns Value

setPrivateRaw(

key: Key,
value: Value

)

Returns Value

setRaw(

key: Key,
value: [""]

)

Returns void

Events

Template does not have any events.