Documentation

IDataProcessorSettings

Type interface

Inheritance

IDataProcessorSettings extends IEntitySettings.

IDataProcessorSettings is not extended by any other symbol.

Properties

animations
#

Type Array

Inherited from IEntitySettings

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" }
]);

@since 5.20.8

colorFields
#

Type string[]

Data fields to convert to Color objects. A nested field is written as a path, such as "values.color".
dateFields
#

Type string[]

Data fields to convert to timestamps. A nested field is written as a path, such as "values.date".
dateFormat
#

Type undefined | string

Format of the string dates in dateFields, such as "yyyy-MM-dd". Set it whenever those fields hold strings.
emptyAs
#

Type any

Replaces empty values (null, undefined or "") in any field with this value.
id
#

Type undefined | string

Inherited from IEntitySettings

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 | true

Default false

Inherited from IEntitySettings

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

@since 5.15.6

numericFields
#

Type string[]

Data fields to convert to numbers. A nested field is written as a path, such as "values.value".
stateAnimationDuration
#

Type undefined | number

Default 0

Inherited from IEntitySettings

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

0 switches at once.
stateAnimationEasing
#

Type $ease.Easing

Default out(cubic)

Inherited from IEntitySettings

Easing of the animated switch from one state to another.
themeTags
#

Type Array

Inherited from IEntitySettings

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.

Click here for more info

themeTagsSelf
#

Type Array

Inherited from IEntitySettings

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

Click here for more info

themes
#

Type Array

Inherited from IEntitySettings

Themes applied to the element and everything inside it.
userData
#

Type any

Inherited from IEntitySettings

Any data of your own to keep with the element.
There are 9 inherited items currently hidden from this list.