MAIDR JavaScript API
    Preparing search index...

    Class FormatterService

    Service for managing value formatting across all layers in a MAIDR figure.

    The FormatterService extracts format configurations from layer definitions and provides methods to format values consistently throughout the application.

    // In Controller
    const formatterService = new FormatterService(maidrData);

    // Format a value
    const formatted = formatterService.formatValue(128.47, 'layer-1', 'y');
    // Returns "$128.47" if layer has currency formatter

    // Format an array (e.g., boxplot outliers)
    const formattedArray = formatterService.formatValue(
      [-9.795, 6.057, 14.736],
      'layer-1',
      'y'
    );
    // Returns ["-9.80", "6.06", "14.74"] if layer has 2-decimal formatter

    Implements

    Index

    Constructors

    constructor

    Methods

    refresh getFormatter hasAuthoredFormat formatValue formatSingleValue formatArrayValue dispose

    Constructors

    Methods

    • Rebuilds all layer formatters from updated MAIDR data. Called after a live data update replaces the chart data.

      Parameters

      • maidr: Maidr

        The updated MAIDR data

      Returns void

    • Whether the layer declared a format for this axis, as opposed to falling back to the default.

      The chart description's data table asks before it formats: it has its own rounding, and a reader of an unformatted chart should see exactly what they saw before. Where an author did ask for currency, a percentage or a date, the table has to say the same thing the announcement does, or the two surfaces describe one number two ways.

      Parameters

      • layerId: string

        The ID of the layer

      • axis: AxisType

        The axis type ('x', 'y', or 'z')

      Returns boolean

      True when the layer's JSON carried a format for that axis

    • Formats a value (single or array) using the formatter for the specified layer and axis.

      This is the primary method for formatting values in the application. It handles both single values and arrays (e.g., boxplot outliers).

      Parameters

      • value: FormattableValue

        The value or array of values to format

      • layerId: string

        The ID of the layer

      • axis: AxisType

        The axis type ('x', 'y', or 'z')

      Returns string | string[]

      Formatted string or array of formatted strings

      // Single value
      formatValue(128.47, 'layer-1', 'y') // "$128.47"

      // Array of values (boxplot outliers)
      formatValue([-9.795, 6.057], 'layer-1', 'y') // ["-9.80", "6.06"]

    • Formats a single value (not an array) and always returns a string. Use this when you're certain the value is not an array.

      Parameters

      • value: string | number

        The single value to format

      • layerId: string

        The ID of the layer

      • axis: AxisType

        The axis type ('x', 'y', or 'z')

      Returns string

      Formatted string

    • Formats an array of values and always returns a string array. Use this when you're certain the value is an array.

      Parameters

      • values: (string | number)[]

        The array of values to format

      • layerId: string

        The ID of the layer

      • axis: AxisType

        The axis type ('x', 'y', or 'z')

      Returns string[]

      Array of formatted strings

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods