Class FormatUtil`Abstract`

Formatting utility functions for MAIDR value display. Provides format resolution, application, and pre-built formatter factories.

Index

Methods

resolveFormat wrapFormat applyFormat

Methods

`Static`resolveFormat

resolveFormat(axisFormat?: AxisFormat): FormatFunction
Resolves a format function from an AxisFormat configuration.

Priority order:
1. function - Function body string (custom logic)
2. type - Format type specifier (common patterns)
3. Default (toString)
Parameters
- OptionalaxisFormat: AxisFormat
  Optional axis format configuration
Returns FormatFunction
Resolved format function
- Defined in src/util/format.ts:151

`Static`wrapFormat

wrapFormat(
format: FormatFunction,
options?: { missingText?: string },
): FormatFunction
Wraps a format function with edge case handling. Handles null, undefined, and NaN values gracefully.
Parameters
- format: FormatFunction
  The format function to wrap
- Optionaloptions: { missingText?: string }
  Options for handling edge cases
  - OptionalmissingText?: string
    Text to display for missing/invalid values (default: 'missing')
Returns FormatFunction
Wrapped format function with edge case handling
- Defined in src/util/format.ts:212

`Static`applyFormat

applyFormat(
value: FormattableValue,
formatter: FormatFunction,
): string | string[]
Applies a format function to a single value or array of values. When given an array, formats each element individually.
Parameters
- value: FormattableValue
  Single value or array of values to format
- formatter: FormatFunction
  Format function to apply
Returns string | string[]
Formatted string or array of formatted strings
- Defined in src/util/format.ts:244