SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface LocaleProfile

    Everything regional behavior depends on, resolved for a single locale.

    This is the one source of truth for separators, date patterns, currency, and collation. It is derived data -- the identity is the BCP 47 tag, which is what a workbook persists.

    interface LocaleProfile {
        collator: CollatorOptions;
        csvDelimiter: string;
        currencyCode: string;
        currencyDisplay: CurrencyDisplay;
        currencyPosition: CurrencyPosition;
        currencySpacing: CurrencySpacing;
        currencySymbol: string;
        date: {
            am?: string;
            calendar: string;
            firstDay: DayOfWeek;
            hour12: boolean;
            long: string;
            medium: string;
            monthsAbbr: string[];
            monthsWide: string[];
            pm?: string;
            short: string;
            timeLong: string;
            timeShort: string;
            weekdaysAbbr: string[];
            weekdaysWide: string[];
            weekend: [DayOfWeek, DayOfWeek];
        };
        decimal: string;
        group: string;
        grouping: number[];
        listSeparator: string;
        minusSign: string;
        numberingSystem: string;
        percentSign: string;
        permilleSign: string;
        rtl: boolean;
        tag: string;
    }
    Index
    collator csvDelimiter currencyCode currencyDisplay currencyPosition currencySpacing currencySymbol date decimal group grouping listSeparator minusSign numberingSystem percentSign permilleSign rtl tag
    collator: CollatorOptions

    Collation defaults for sorting.

    csvDelimiter: string
    currencyCode: string

    ISO 4217 code for the region, e.g. EUR.

    currencyDisplay: CurrencyDisplay
    currencyPosition: CurrencyPosition
    currencySpacing: CurrencySpacing
    currencySymbol: string

    The rendered symbol for LocaleProfile.currencyCode, e.g. €.

    date: {
        am?: string;
        calendar: string;
        firstDay: DayOfWeek;
        hour12: boolean;
        long: string;
        medium: string;
        monthsAbbr: string[];
        monthsWide: string[];
        pm?: string;
        short: string;
        timeLong: string;
        timeShort: string;
        weekdaysAbbr: string[];
        weekdaysWide: string[];
        weekend: [DayOfWeek, DayOfWeek];
    }

    Type Declaration

    • Optionalam?: string
    • calendar: string

      e.g. gregory

    • firstDay: DayOfWeek
    • hour12: boolean
    • long: string

      e.g. MMMM d, y

    • medium: string

      e.g. MMM d, y

    • monthsAbbr: string[]
    • monthsWide: string[]
    • Optionalpm?: string
    • short: string

      e.g. M/d/yy

    • timeLong: string

      e.g. h:mm:ss a z -- note: z is a hint only

    • timeShort: string

      e.g. h:mm a or HH:mm

    • weekdaysAbbr: string[]
    • weekdaysWide: string[]
    • weekend: [DayOfWeek, DayOfWeek]
    decimal: string
    group: string
    grouping: number[]

    e.g. [3], or [3,2] for hi-IN.

    listSeparator: string

    Function/list argument separator, like Excel (, or ;).

    minusSign: string
    numberingSystem: string
    percentSign: string
    permilleSign: string

    usually ‰

    rtl: boolean
    tag: string

    The BCP 47 tag this profile was resolved from, e.g. de-DE.

    Settings
    Member Visibility

    On This Page
    Properties