FormatOptions

[ Interface ]

Version 1.10.1336.10

export interface FormatOptions {
    timeZone?: string | undefined;
    type?: 'full' | 'date' | 'time';
    locale?: string | undefined | null;
}

Version 1.12

export interface FormatOptions {
    timeZone?: string | undefined;
    type?: Localization.FormatType;
    locale?: string | undefined | null;
}

Properties

Name

Type

Description

timeZone [ Optional ]

string, undefined

If this time zone is not specified or undefined, the setting of the current user is used.

type [ Optional ]

Version 1.10.1336.10

'full', 'date', 'time'

Version 1.12

Localization.FormatType

Specifies whether the date, time (including milliseconds) or both should be displayed.

The options from version 1.10.1336.10 are compatible with version 1.12.

locale [ Optional ]

string, undefined, null

If this localization is not specified or undefined/null, the timeFormatLocale setting of the current user is used.

The settings of the current user are also available under TcHmi.Server.getCurrentUserConfig.

FormatOptions 1:

Available from version 1.10.1336.10