formcycle 8.4.0 - JavaScript für Formulare
    Bereite Suchindex vor...

    Schnittstelle NumberFormatApiFormatter

    Die API zum Formatieren und Parsen von numerischen Werten, unabhängig von einem NumberFormat-Element.

    Die API ist über $.xutil.numberFormat.formatter verfügbar.

    interface NumberFormatApiFormatter {
        formatNumber: (
            value: string | number,
            options: Partial<NumberFormatOptions>,
        ) => string;
        isCorrectlyFormatted: (
            value: string,
            options: Partial<NumberFormatOptions>,
        ) => boolean;
        parseAsNumber: (
            value: string,
            options: Partial<NumberFormatOptions>,
        ) => number;
        parseAsString: (
            value: string,
            options: Partial<NumberFormatOptions>,
        ) => string;
    }
    Index

    Eigenschaften

    formatNumber: (
        value: string | number,
        options: Partial<NumberFormatOptions>,
    ) => string

    Formatiert eine Zahl mit den angegebenen Optionen. Die Zahl kann entweder als Zahl oder als Zeichenkette angegeben werden. Die Zeichenkette muss eine gültige Zahl sein und einen Punkt als Dezimaltrennzeichen verwenden. Die Verwendung einer Zeichenkette vermeidet Probleme mit der Genauigkeit von Gleitkommazahlen.

    Typendeklaration

      • (value: string | number, options: Partial<NumberFormatOptions>): string
      • Parameter

        • value: string | number

          Die zu formatierende Zahl.

        • options: Partial<NumberFormatOptions>

          Die Optionen, die beim Formatieren der Zahl verwendet werden sollen.

        Rückgabewert string

        Die formatierte Zahl.

    Wenn die angegebene Zahl eine Zeichenkette ist, die keine gültige Zahl darstellt.

    isCorrectlyFormatted: (
        value: string,
        options: Partial<NumberFormatOptions>,
    ) => boolean

    Prüft, ob der angegebene Wert eine gültige Zahl ist, die mit den angegebenen Optionen formatiert werden kann.

    Typendeklaration

      • (value: string, options: Partial<NumberFormatOptions>): boolean
      • Parameter

        • value: string

          Die zu prüfende formatierte Zahl.

        • options: Partial<NumberFormatOptions>

          Optionen, die für die Prüfung verwendet werden sollen.

        Rückgabewert boolean

        True wenn der Wert eine gültige Zahl ist, false sonst.

    parseAsNumber: (value: string, options: Partial<NumberFormatOptions>) => number

    Parst eine formatierte Zahl mit den angegebenen Optionen. Der Wert wird als Zahl zurückgegeben.

    Typendeklaration

      • (value: string, options: Partial<NumberFormatOptions>): number
      • Parameter

        • value: string

          Die zu verarbeitende formatierte Zahl.

        • options: Partial<NumberFormatOptions>

          Die Optionen, die beim Parsen der Zahl verwendet werden sollen.

        Rückgabewert number

        Die geparste Zahl.

    Wenn die angegebene Zeichenkette keine gültige Zahl darstellt.

    parseAsString: (value: string, options: Partial<NumberFormatOptions>) => string

    Parst eine formatierte Zahl mit den angegebenen Optionen. Der Wert wird als Zeichenkette zurückgegeben und verwendet einen Punkt als Dezimaltrennzeichen.

    Typendeklaration

      • (value: string, options: Partial<NumberFormatOptions>): string
      • Parameter

        • value: string

          Die zu verarbeitende formatierte Zahl.

        • options: Partial<NumberFormatOptions>

          Die Optionen, die beim Parsen der Zahl verwendet werden sollen.

        Rückgabewert string

        Die geparste Zahl.

    Wenn die angegebene Zeichenkette keine gültige Zahl darstellt.