Interface FormatSettingsProperties

Properties that can be passed into the constructor for FormatSettings.

interface FormatSettingsProperties {
    currency?: string;
    dateFormat?: string;
    fractionalDigits?: number;
    locale?: string;
    numberFormat?: string;
    timeFormat?: string;
    timeZone?: string;
    useFieldInfo?: boolean;
}

Properties

currency? dateFormat? fractionalDigits? locale? numberFormat? timeFormat? timeZone? useFieldInfo?

Properties

Optionalcurrency

currency?: string

The 3-letter ISO 4217 currency code (e.g "USD", "CAD"). Required when formatting a number using NumberFormat.CURRENCY or NumberFormat.ACCOUNTING.

OptionaldateFormat

dateFormat?: string

The default format for date values. Either a utilities/format/formats!DateFormat constant, or a custom date format string.

OptionalfractionalDigits

fractionalDigits?: number

The number of digits to show after the decimal point. If unspecified, an appropriate value is determined based on the locale and currency.

Optionallocale

locale?: string

The locale to use when formatting values.

OptionalnumberFormat

numberFormat?: string

The default format for number values. Either a utilities/format/formats!NumberFormat constant, or a custom number format string.

OptionaltimeFormat

timeFormat?: string

The default format for time values. Either a utilities/format/formats!DateFormat constant, or a custom time format string.

OptionaltimeZone

timeZone?: string

The time zone to display date/time data in. The default will be the user's local time zone.

OptionaluseFieldInfo

useFieldInfo?: boolean

Whether to use formatting from the field info if it is specified.

Settings

Member Visibility

On This Page

Properties