Documentation

INumberFormatterSettings

Type interface

Inheritance

INumberFormatterSettings extends IEntitySettings.

INumberFormatterSettings is not extended by any other symbol.

Properties

bigNumberPrefixes #	Type `INumberSuffix[]` Prefixes and thresholds to group big numbers into, e.g. 1M. Used in conjunction with `a` modifier of the number format.
bytePrefixes #	Type `INumberSuffix[]` Prefixes to and thresholds to use when grouping data size numbers, e.g. 1MB. Used in conjunction with `b` modifier of the number format.
id #	Type `undefined` \| `string` Inherited from `IEntitySettings` A custom string ID for the element. If set, element can be looked up via `am5.registry.entitiesById`. Will raise error if an element with the same ID already exists.
intlLocales #	Type `undefined` \| `string` Locales if you are using date formats in `Intl.NumberFormatOptions` syntax. @see (@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/NumberFormat) about using Intl for number formatting @param Locales
negativeBase #	Type `undefined` \| `number` Default `0` A threshold value for negative numbers.
numberFormat #	Type `string` \| `NumberFormatOptions` Default `"#,###.#####"` Number format to be used when formatting numbers.
numericFields #	Type `string[]` Indicates which fields in data should be considered numeric. It is used when formatting data placeholder values.
smallNumberPrefixes #	Type `INumberSuffix[]` Prefixes and thresholds to group small numbers into, e.g. 1m. Used in conjunction with `a` modifier of the number format.
smallNumberThreshold #	Type `undefined` \| `number` Default `1` All numbers below this value are considered small.
stateAnimationDuration #	Type `undefined` \| `number` Inherited from `IEntitySettings` Duration of transition from one state to another.
stateAnimationEasing #	Type `$ease.Easing` Inherited from `IEntitySettings` Easing of transition from one state to another.
themeTags #	Type `Array` Inherited from `IEntitySettings` Tags which can be used by the theme rules. Click here for more info
themeTagsSelf #	Type `Array` Inherited from `IEntitySettings` Tags which can be used by the theme rules. These tags only apply to this object, not any children. Click here for more info
themes #	Type `Array` Inherited from `IEntitySettings` A list of themes applied to the element.
userData #	Type `any` Inherited from `IEntitySettings` A storage for any custom user data that needs to be associated with the element.
There are 7 inherited items currently hidden from this list.