Documentation

IDurationFormatterSettings

Type interface

Inheritance

IDurationFormatterSettings extends IEntitySettings.

IDurationFormatterSettings is not extended by any other symbol.

Properties

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 `root.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.