IEntitySettings

Type interface

Sources

IEntitySettings is an interface: it describes a shape of data and is not imported on its own.

Inheritance

IEntitySettings does not extend any other symbol.

IEntitySettings is extended by IAnnotatorSettings, IAxisBulletSettings, IBulletSettings, IColorSetSettings, IDataProcessorSettings, IDateFormatterSettings, IDropdownSettings, IDurationFormatterSettings, IExportingMenuSettings, IExportingSettings, IGradientSettings, IInterfaceColorsSettings, ILanguageSettings, ILayoutSettings, IModalSettings, INumberFormatterSettings, IPatternSetSettings, IPatternSettings, ISerializerSettings, ISliceGrouperSettings, ISpriteSettings, IStockControlSettings, IStockToolbarSettings.

Properties

#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.