DurationFormatter – amCharts 5 Documentation

Type class

A class used to format numberic values as time duration.

Sources

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

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

// Create DurationFormatter
am5.DurationFormatter.new(root, {
  // ... config if applicable
});

<!-- Load DurationFormatter -->
<script src="index.js"></script>

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

Inheritance

DurationFormatter extends Entity.

DurationFormatter is not extended by any other symbol.

Settings

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

Read about settings concept.

baseUnit #	Type `TimeUnit` Default `"second"` Identifies what values are used in duration. Available options: `"millisecond"`, `"second"` (default), `"minute"`, `"hour"`, `"day"`, `"week"`, `"month"`, and `"year"`. Click here for more info
durationFields #	Type `string[]` An array of data fields that hold duration values and should be formatted with a `DurationFormatter`. Click here for more info
durationFormat #	Type `undefined` \| `string` A universal duration format to use wherever number needs to be formatted as a duration.
durationFormats #	Type `Partial` Time unit dependent duration formats. Used be `DurationAxis`.
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.
negativeBase #	Type `undefined` \| `number` Default `0` A base value. Any number below it will be considered "negative".
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 `"DurationFormatter", "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?: `undefined` \| `string`, base?: `TimeUnit` ) #	Returns `string` Formats the number as duration. For example `1000` (base unit seconds) would be converted to `16:40` as in 16 minutes and 40 seconds.
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
getFormat( value: `number`, maxValue?: `undefined` \| `number`, baseUnit?: `TimeUnit` ) #	Returns `string` Returns appropriate default format for the value. If `maxValue` is sepcified, it will use that value to determine the time unit for the format. For example if your `baseUnit` is `"second"` and you pass in `10`, you will get `"10"`. However, you might want it to be formatted in the context of bigger scale, say 10 minutes (600 seconds). If you pass in `600` as `maxValue`, all values, including small ones will use format with minutes, e.g.: `00:10`, `00:50`, `12: 30`, etc.
getMilliseconds( value: `number`, baseUnit?: `TimeUnit` ) #	Returns `number` Converts value to milliseconds according to `baseUnit`.
getValueUnit( value: `number`, baseUnit?: `TimeUnit` ) #	Returns `TimeUnit` \| `undefined` Returns value's closest denominator time unit, e.g 100 seconds is `"minute"`, while 59 seconds would still be `second`.
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.
toTimeStamp( value: `number`, baseUnit: `TimeUnit` ) #	Returns `number` Converts numeric value to timestamp in milliseconds.
There are 16 inherited items currently hidden from this list.

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?: undefined | string,
base?: TimeUnit

)

Returns string

Formats the number as duration.

For example 1000 (base unit seconds) would be converted to 16:40 as in 16 minutes and 40 seconds.

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

getFormat(

value: number,
maxValue?: undefined | number,
baseUnit?: TimeUnit

)

Returns string

Returns appropriate default format for the value.

If maxValue is sepcified, it will use that value to determine the time unit for the format.

For example if your baseUnit is "second" and you pass in 10, you will get "10".

However, you might want it to be formatted in the context of bigger scale, say 10 minutes (600 seconds). If you pass in 600 as maxValue, all values, including small ones will use format with minutes, e.g.:

00:10, 00:50, 12: 30, etc.

getMilliseconds(

value: number,
baseUnit?: TimeUnit

)

Returns number

Converts value to milliseconds according to baseUnit.

getValueUnit(

value: number,
baseUnit?: TimeUnit

)

Returns TimeUnit | undefined

Returns value's closest denominator time unit, e.g 100 seconds is "minute", while 59 seconds would still be second.

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.

toTimeStamp(

value: number,
baseUnit: TimeUnit

)

Returns number

Converts numeric value to timestamp in milliseconds.

There are 16 inherited items currently hidden from this list.

Events

DurationFormatter does not have any events.