Documentation

IDateFormatterSettings

Type interface

Inheritance

IDateFormatterSettings extends IEntitySettings.

IDateFormatterSettings is not extended by any other symbol.

Properties

capitalize #	Type `undefined` \| `false` \| `true` Default `true` Should the first letter of the formatted date be capitalized?
dateFields #	Type `string[]` An array of data fields that hold date values and should be formatted with a `DateFormatter`. Click here for more info
dateFormat #	Type `string` \| `DateTimeFormatOptions` A date format to be used when formatting dates. Click here for more info
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 to use when formatting using `Intl.DateFormatter`.
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.