base-formatter
    Preparing search index...

    Interface BaseFormatterOptions

    The options passed to BaseFormatter, BaseFormatter.encode and BaseFormatter.decode. It includes the options for the BaseConverter.

    interface BaseFormatterOptions {
        digitSeparator?: string;
        fractionPadCharacter?: string;
        groupingLength?: number;
        groupingSeparator?: string;
        integerPadCharacter?: string;
        maximumFractionLength?: number;
        minimumFractionLength?: number;
        minimumIntegerLength?: number;
        negativeSign?: string;
        notation?: Notation;
        positiveSign?: string;
        precision?: number;
        radixCharacter?: string;
        radixDisplay?: RadixDisplay;
        roundingMode?: RoundingMode;
        scientificNotationCharacter?: string;
        signDisplay?: SignDisplay;
        useGrouping?: UseGrouping;
    }

    Hierarchy (View Summary)

    Index

    Properties

    digitSeparator? fractionPadCharacter? groupingLength? groupingSeparator? integerPadCharacter? maximumFractionLength? minimumFractionLength? minimumIntegerLength? negativeSign? notation? positiveSign? precision? radixCharacter? radixDisplay? roundingMode? scientificNotationCharacter? signDisplay? useGrouping?

    Properties

    digitSeparator?: string

    The digit separator, if specified, will be places between every digit without a grouping separator.

    ''

    fractionPadCharacter?: string

    The fraction pad character, padding the right side of the fraction. By default the specified digit for zero is used, but could also be a ' ' space char for example.

    null

    groupingLength?: number

    The grouping length, the distance between grouping separators, e.g. with a length of 2: 1,00,00,00.

    3

    groupingSeparator?: string

    The grouping separator, such as the commas in 100,000,000.

    ','

    integerPadCharacter?: string

    The integer pad character, padding the left side of the integer. By default the specified digit for zero is used, but could also be a ' ' space char for example.

    null

    maximumFractionLength?: number

    The maximum fraction length. By default, the maximum fraction length is determined by the precision.

    null

    minimumFractionLength?: number

    The minimum fraction. A value with a smaller fraction length than this number will be right-padded with zeros.

    0

    minimumIntegerLength?: number

    The minimum integer length. A value with a smaller number of integer digits than this number will be left-padded with zeros or the specified integer pad character.

    0

    negativeSign?: string

    The negative sign.

    '-'

    notation?: Notation

    The formatting that should be displayed for the number.

    'standard'

    positiveSign?: string

    The positive sign.

    '+'

    precision?: number

    The precision of the number, the number of significant digits.

    32

    radixCharacter?: string

    The radix character, or "decimal" point/mark/separator, such as the point in 0.5).

    '.'

    radixDisplay?: RadixDisplay

    When to display the radix character.

    'auto'

    roundingMode?: RoundingMode

    How numbers are to be rounded.

    'halfExpand'

    scientificNotationCharacter?: string

    The scientific notation character, such as the e in 1.342e3.

    'e'

    signDisplay?: SignDisplay

    When to display the sign.

    'auto'

    useGrouping?: UseGrouping

    When numbers are to be grouped.

    false

    Settings

    Member Visibility

    On This Page

    Properties