Documentation

INumberFormatterSettings

Type interface

Inheritance

INumberFormatterSettings extends IEntitySettings.

INumberFormatterSettings 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
bigNumberPrefixes #	Type `INumberSuffix[]` Suffixes for big numbers and the values they stand for, such as `"M"` for a million. Used by the `a` modifier of the number format.
bytePrefixes #	Type `INumberSuffix[]` Suffixes for data sizes and the byte counts they stand for, such as `"KB"` for 1024. Used by the `b` modifier of the number format.
forceLTR #	Type `undefined` \| `false` \| `true` Default `false` Forces formatted numbers to read left to right, even in a right-to-left layout. @since 5.3.13
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
intlLocales #	Type `undefined` \| `string` Locale for formats given as `Intl.NumberFormat` options, such as `"de-DE"`. The browser's locale if not set. Click here for more info
negativeBase #	Type `undefined` \| `number` Default `0` Values below this use the negative part of the format (after the first `\|`), and a value equal to it the zero part (after the second `\|`). The minus sign still shows only for values below `0`.
numberFormat #	Type `string` \| `NumberFormatOptions` Default `"#,###.#####"` Format used when no other format is given: a format string, or options for `Intl.NumberFormat`.
numericFields #	Type `string[]` Data fields that hold numbers. Text placeholders with these fields are formatted as numbers even without `formatNumber()`.
smallNumberPrefixes #	Type `INumberSuffix[]` Suffixes for small numbers and the values they stand for, such as `"m"` for a thousandth. Used by the `a` modifier of the number format.
smallNumberThreshold #	Type `undefined` \| `number` Default `1` Numbers below this use `smallNumberPrefixes` with the `a` modifier; others use `bigNumberPrefixes`.
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.