formcycle 8.5.0 - JavaScript for forms
    Preparing search index...

    Interface NumberFormatApi

    The entry point the NumberFormat picker API. NumberFormat enhances input fields with number formatting and validation. When a user input a number, the input field is automatically formatted according to the configured options.

    The API is available via $.xutil.numberFormat.

    For clarity, the API is divided into several sub-APIs:

    • $.xutil.numberFormat.do: For actions that change the state of NumberFormat elements.
    • $.xutil.numberFormat.get: For retrieving data from NumberFormat elements.
    • $.xutil.numberFormat.formatter: For formatting and parsing numerical values.
    • $.xutil.numberFormat.lifecycle: For managing the lifecycle of NumberFormat elements.
    • $.xutil.numberFormat.porcelain: Additional methods that are subject to change.
    interface NumberFormatApi {
        do: NumberFormatApiDo;
        formatter: NumberFormatApiFormatter;
        get: NumberFormatApiGet;
        lifecycle: NumberFormatApiLifecycle;
        porcelain: NumberFormatApiPorcelain;
    }
    Index

    Properties

    do formatter get lifecycle porcelain

    Properties

    do: NumberFormatApiDo

    The API for performing actions on NumberFormat elements, such as changing the value or the options.

    The API is available via $.xutil.numberFormat.do.

    For example, to change the value of an element, use $.xutil.numberFormat.do.setValue(...).

    // Set the value to 12.34
    $.xutil.numberFormat.do.setValue(".tf1", 12.34);
    formatter: NumberFormatApiFormatter

    The API for formatting and parsing numerical values, independent of any NumberFormat element.

    The API is available via $.xutil.numberFormat.formatter.

    get: NumberFormatApiGet

    The API for getting information from NumberFormat elements, such as the current value.

    The API is available via $.xutil.numberFormat.get.

    For example, to get the value of an element as a number, use $.xutil.numberFormat.get.valueNumeric(...).

    // 12.12345
    $.xutil.numberFormat.get.valueNumeric(".tf1");
    lifecycle: NumberFormatApiLifecycle

    The API for the lifecycle of NumberFormat elements, such as initialization and destruction.

    The API is available via $.xutil.numberFormat.lifecycle.

    For example, to manually initialize an element with the NumberFormat feature, use $.xutil.numberFormat.lifecycle.initialize(...).

    // Initialize a single element by its class name
    // Use a comma as the decimal separator and a dot as the digit group separator
    // E.g. 1.234.567,89
    $.xutil.numberFormat.lifecycle.initialize(".tf1", {
      digitGroupSeparator: '.',
      decimalSeparator: ',',
      decimalPlaces: 0,
    });
    porcelain: NumberFormatApiPorcelain

    The API for the porcelain layer of NumberFormat elements, such as accessing the underlying library. Note that this API is fragile and may change at any time without notice.

    The API is available via $.xutil.numberFormat.porcelain.

    Settings

    Member Visibility

    On This Page

    Properties