Interface LocalizationApi

This API is used for the localization methods.

Accessed from the window at window.sas.vi.localization.

Example

window.sas.vi.localization.getLocale();
interface LocalizationApi {
    solution: SolutionLocalizationApi;
    getDirection(): "ltr" | "rtl";
    getFormatLocale(): string;
    getLocale(): string;
    getLocalizedDateTimeFormat(showTime?: boolean): string;
}

Properties

solution

Methods

getDirection getFormatLocale getLocale getLocalizedDateTimeFormat

Properties

solution

solution: SolutionLocalizationApi

Methods related to solution content localization.

Methods

getDirection

  • getDirection(): "ltr" | "rtl"

  • Returns "ltr" | "rtl"

    The current application display direction.

    Method

    Description

    Gets the application display direction. This is either "ltr" for left-to-right display locales, or "rtl" for right-to-left locales.

getFormatLocale

  • getFormatLocale(): string

  • Returns string

    The user's preferred locale format.

    Method

    Description

    Gets user's preferred locale format in BCP 47 format. This should be used to format dates\numbers in VI extensions but not to drive the language.

getLocale

  • getLocale(): string

  • Returns string

    The current application locale.

    Method

    Description

    Gets the application locale in BCP 47 format.

getLocalizedDateTimeFormat

  • getLocalizedDateTimeFormat(showTime?): string

  • Parameters

    • OptionalshowTime: boolean

      {boolean} Checks whether or not to include time (in 12 hour format).

    Returns string

    The localized date time format as a string.

    Method

    Description

    Returns the MomentJS format string based on locale.

Settings

Member Visibility

On This Page

Properties
Methods