Entity

Type class

Base class of amCharts objects with settings, states, adapters and events:

elements, series, charts, formatters and more.

Sources

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

TypeScript

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

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

JavaScript

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

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

Inheritance

Entity extends Settings.

Entity is extended by Annotator, AxisBullet, Bullet, ColorSet, DataProcessor, DateFormatter, Dropdown, DurationFormatter, Exporting, ExportingMenu, Gradient, InterfaceColors, Language, Layout, Modal, NumberFormatter, Pattern, PatternSet, Serializer, SliceGrouper, Sprite, StockControl, StockToolbar.

Settings

Set these settings on a Entity object using its set() and setAll() methods. Read about settings concept.

#animations

Type ArraySince 5.20.8

Animations the element plays on its own, described as data - so they can be set from a JSON config and saved with it.

Each one animates a setting of the element (or, with target: "dataItem", a value of its data item - a map point's positionOnLine, say). They start when the setting is applied, restart when it changes, and stop when the element is disposed. A saved config keeps what was configured, never a value caught half way through an animation.

sprite.set("animations", [
  { key: "rotation", to: 360, duration: 4000, loops: 0 },
  { key: "scale", from: 1, to: 1.3, duration: 800, loops: 0, yoyo: true, easing: "sine" }
]);

#id

Type undefined | string

A unique ID for looking the element up in root.entitiesById. Setting an ID that another element already has throws an error.

#ignoreThemes

Type undefined | false | trueDefault falseSince 5.15.6

Ignores themes: no theme rule applies to the element, not even one of the default theme.

#stateAnimationDuration

Type undefined | numberDefault 0

How long, in milliseconds, a switch from one state to another animates.

0 switches at once.

#stateAnimationEasing

Type $ease.EasingDefault out(cubic)

Easing of the animated switch from one state to another.

#themes

Type Array

Themes applied to the element and everything inside it.

#themeTags

Type Array

Tags that theme rules can target. They also count for the element's children, so a rule can match a child by a tag of its parent.

More info: Themes

#themeTagsSelf

Type Array

Tags that theme rules can target, like themeTags, but only for this element, not its children.

More info: Themes

#userData

Type any

Any data of your own to keep with the element.

Private settings

These are read-only settings accessible from a Entity object using its getPrivate() method. Read about private settings.

Entity does not have any private settings.

Properties

#adapters

Type AdaptersDefault new Adapters(this)

#className

StaticType stringDefault "Entity"

#classNames

StaticType ArrayDefault [ "Entity" ]

#events

Type EventDispatcherDefault this._createEvents()

#root

Type RootSince 5.0.6

The Root the object belongs to.

#states

Type StatesDefault new States(this)

#template

Type Template | undefined

A Template applied to the object. Its settings apply where the object has none set of its own.

2 inherited items

#enableDispose

Type booleanDefault trueInherited from Settings

Set to false to make dispose() do nothing.

#uid

Type numberDefault ++counterInherited from Settings

A unique number, given to each object as it is created.

Methods

#get(key: Key,
fallback: F)

Returns NonNullable | F

Returns the value of setting key, run through any adapters, or fallback if it is not set.

More info: Settings

#isType(type: string)

Returns this

Returns true if the object is of class type or extends it.

#new(root: Root,
settings: ITSettings,
template?: Template)

StaticReturns T

Creates an instance of the class. Use it instead of new Class().

More info: Getting started: new element syntax

#remove(key: Key)

Returns void

Removes the value set for setting key. The setting goes back to the value from a theme or template, if one has it.

More info: Settings

#set(key: Key,
value: Value)

Returns Value

Sets setting key to value and returns value. A value set this way overrides themes and templates, and stops any animation of the setting.

More info: Settings

#setTimeout(fn: () => void,
delay: number)

Returns IDisposer

Calls fn after delay milliseconds, unless the object is disposed first. Disposing the returned disposer cancels it.

16 inherited items

#animate(options: AnimationOptions)

Returns AnimationInherited from Settings

Animates a setting from its current value (or from) to to. The setting jumps to from at once. With duration 0, or no value to start from, it is set to to at once and the returned animation is already stopped.

More info: Animations: animating settings

#dispose()

Returns voidInherited from Settings

Disposes the object, freeing everything it holds. A disposed object can't be used again.

#has(key: Key)

Returns booleanInherited from Settings

Returns true if setting key is set.

More info: Settings

#isDisposed()

Returns booleanInherited from Settings

Returns true if the object has been disposed.

#off(key: Key,
callback?: undefined | (value: [""], target: this, key: Key) => void)

Returns voidInherited from SettingsSince 5.9.2

Removes a callback added with on(). Without callback, removes all of them for key.

More info: Events: settings value change

#offDebounced(key: Key,
callback?: undefined | (value: [""], target: this, key: Key) => void)

Returns voidInherited from Settings

Removes a callback added with onDebounced(). Without callback, removes all of them for key.

More info: Events: settings value change

#offDebouncedPrivate(key: Key,
callback?: undefined | (value: [""], target: this, key: Key) => void)

Returns voidInherited from Settings

Removes a callback added with onPrivateDebounced(). Without callback, removes all of them for key.

More info: Events: settings value change

#offPrivate(key: Key,
callback?: undefined | (value: [""], target: this, key: Key) => void)

Returns voidInherited from SettingsSince 5.9.2

Removes a callback added with onPrivate(). Without callback, removes all of them for key.

More info: Events: settings value change

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

Returns IDisposerInherited from Settings

Calls callback each time the value of setting key changes or is removed. Setting the same value again does not call it.

More info: Events: settings value change

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

Returns IDisposerInherited from SettingsSince 5.20.4

Like on(), but the callback is removed after it is called once.

More info: Events: settings value change

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

Returns IDisposerInherited from SettingsSince 5.20.4

Like onDebounced(), but the callback is removed after it is called once.

More info: Events: settings value change

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

Returns IDisposerInherited from Settings

Like on(), but waits until setting key has not changed for debounceDelay milliseconds, then calls callback once with the latest value.

More info: Events: settings value change

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

Returns IDisposerInherited from Settings

Calls callback each time the value of private setting key changes.

More info: Events: settings value change

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

Returns IDisposerInherited from Settings

Like onPrivate(), but waits until private setting key has not changed for debounceDelay milliseconds, then calls callback once with the latest value.

More info: Events: settings value change

#removeAll()

Returns voidInherited from Settings

Removes all settings, as remove() does for each one.

More info: Settings

#setAll(settings: Partial)

Returns voidInherited from Settings

Sets several settings at once, from an object of key-value pairs.

More info: Settings

Events

Entity does not have any events.