IDurationFormatterSettings

Type interface

Sources

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

Inheritance

IDurationFormatterSettings extends IEntitySettings.

IDurationFormatterSettings is not extended by any other symbol.

Properties

#baseUnit

Type TimeUnitDefault "second"

Unit of the numbers being formatted: "millisecond", "second", "minute", "hour", "day", "week", "month" or "year".

More info: Formatting durations: base unit

#durationFields

Type string[]

Data fields that hold durations. Text placeholders with these fields are formatted as durations even without formatDuration().

More info: Data placeholders: formatting placeholders

#durationFormat

Type undefined | string

Format for every duration that is not given its own format. Overrides durationFormats.

#durationFormats

Type Partial

Formats picked when durationFormat is not set, by base unit and by the largest unit the value reaches: durationFormats[baseUnit][unit]. Also used by DurationAxis.

#negativeBase

Type undefined | numberDefault 0

Values below this are negative: they use the negative part of the format (after the first |) and get a minus sign. A value equal to it uses the zero part (after the second |).

9 inherited items

#animations

Type ArrayInherited from IEntitySettingsSince 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 | stringInherited 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 | trueDefault falseInherited from IEntitySettingsSince 5.15.6

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

#stateAnimationDuration

Type undefined | numberDefault 0Inherited from IEntitySettings

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

0 switches at once.

#stateAnimationEasing

Type $ease.EasingDefault out(cubic)Inherited from IEntitySettings

Easing of the animated switch from one state to another.

#themes

Type ArrayInherited from IEntitySettings

Themes applied to the element and everything inside it.

#themeTags

Type ArrayInherited 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.

More info: Themes

#themeTagsSelf

Type ArrayInherited from IEntitySettings

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

More info: Themes

#userData

Type anyInherited from IEntitySettings

Any data of your own to keep with the element.