NumberFormatter

Type class

Number formatter

Click here for more info

Sources

NumberFormatter can be used (imported) via one of the following packages.

// Import NumberFormatter
import * as am5 from "@amcharts/amcharts5";

// Create NumberFormatter
am5.NumberFormatter.new(root, {
  // ... config if applicable
});
<!-- Load NumberFormatter -->
<script src="index.js"></script>

<script>
// Create NumberFormatter
am5.NumberFormatter.new(root, {
  // ... config if applicable
});
</script>

Inheritance

NumberFormatter extends Entity.

NumberFormatter is not extended by any other symbol.

Settings

Set these settings on a NumberFormatter object using its set() and setAll() methods.

Read about settings concept.

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.

forceLTR
#

Type undefined | false | true

Default false

If set to true will force the number string to be LTR, even if RTL is enabled.

@since 5.3.13

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.

Private settings

Properties

adapters
#

Type Adapters

Default new Adapters(this)

Inherited from Entity

className
#

Static

Type string

Default "Entity"

Inherited from Entity

classNames
#

Static

Type Array

Default "NumberFormatter", "Entity"

Inherited from Entity

events
#

Type EventDispatcher

Default this._createEvents()

Inherited from Entity

root
#

Type Root

Inherited from Entity

An instance of Root object.

@readonly
@since 5.0.6

states
#

Type States

Default new States(this)

Inherited from Entity

template
#

Type Template | undefined

Inherited from Entity

@todo needs description

uid
#

Type number

Default ++counter

Inherited from Settings

Unique ID.

There are 8 inherited items currently hidden from this list.

Methods

animate(

options: AnimationOptions

)

#

Returns Animation

Inherited from Settings

Animates setting values from current/start values to new ones.

Click here for more info

dispose()

#

Returns void

Inherited from Settings

Disposes this object.

format(

value: number | string,
format?: string | NumberFormatOptions,
precision?: undefined | number

)

#

Returns string

Formats the number according to specific format.

get(

key: Key,
fallback: F

)

#

Returns NonNullable | F

Inherited from Entity

Returns settings value for the specified key.

If there is no value, fallback is returned instead (if set).

Click here for more info

has(

key: Key

)

#

Returns boolean

Inherited from Settings

Returns true if the setting exists.

Click here for more info

isDisposed()

#

Returns boolean

Inherited from Settings

Returns true if this element is disposed.

isType(

type: string

)

#

Returns this

Inherited from Entity

Checks if element is of certain class (or inherits one).

new(

root: Root,
settings: ITSettings,
template?: Template

)

#

Static

Returns T

Inherited from Entity

Use this method to create an instance of this class.

Click here for more info

off(

key: Key,
callback?: undefined | ( value: [""], target: this, key: Key) => void

)

#

Returns void

Inherited from Settings

Removes a callback for when value of a setting changes.

Click here for more info
@since 5.9.2

offPrivate(

key: Key,
callback?: undefined | ( value: [""], target: this, key: Key) => void

)

#

Returns void

Inherited from Settings

Removes a callback for when value of a private setting changes.

Click here for more info
@since 5.9.2

on(

key: Key,
callback: ( value: [""], target: this, key: Key) => void

)

#

Returns IDisposer

Inherited from Settings

Sets a callback function to invoke when specific key of settings changes or is set.

Click here for more info

onPrivate(

key: Key,
callback: ( value: [""], target: this, key: Key) => void

)

#

Returns IDisposer

Inherited from Settings

Sets a callback function to invoke when specific key of private settings changes or is set.

Click here for more info

remove(

key: Key

)

#

Returns void

Inherited from Entity

Removes a setting value for the specified key.

Click here for more info

removeAll()

#

Returns void

Inherited from Settings

Removes all keys;

Click here for more info

set(

key: Key,
value: Value

)

#

Returns Value

Inherited from Entity

Sets a setting value for the specified key, and returns the same value.

Click here for more info

setAll(

settings: Partial

)

#

Returns void

Inherited from Settings

Sets multiple settings at once.

settings must be an object with key: value pairs.

Click here for more info

setTimeout(

fn: () => void,
delay: number

)

#

Returns IDisposer

Inherited from Entity

Creates and returns a "disposable" timeout.

There are 16 inherited items currently hidden from this list.

Events

NumberFormatter does not have any events.