FormatDefinition Interface
An extension of FormatProps to help identify formats.
Extends
Properties
| Name | Type | Description | |
|---|---|---|---|
| description Readonly | string | undefined | ||
| label Readonly | string | undefined | ||
| name Readonly | string | undefined |
Inherited properties
| Name | Type | Inherited from | Description |
|---|---|---|---|
| allowMathematicOperations Readonly Inherited | boolean | undefined | FormatProps | Enables calculating mathematic operations during parsing; only addition and subtraction are supported. |
| azimuthBase Readonly Inherited | number | undefined | FormatProps | The base value for azimuth, specified from east counter-clockwise. |
| azimuthBaseUnit Readonly Inherited | string | undefined | FormatProps | The name of the unit for the azimuth base value. |
| azimuthCounterClockwise Readonly Inherited | boolean | undefined | FormatProps | If set to true, azimuth values are returned counter-clockwise from the base. |
| composite Readonly Inherited | FormatCompositeProps | undefined | FormatProps | Composite format specification for multi-unit display. |
| decimalSeparator Readonly Inherited | string | undefined | FormatProps | Character separating integer from fractional part. |
| formatTraits Readonly Inherited | string | string[] | FormatProps | Array of format traits controlling display behavior. |
| minWidth Readonly Inherited | number | undefined | FormatProps | Minimum width of the formatted output including digits and separators. |
| precision Readonly Inherited | number | undefined | FormatProps | The precision for the format. |
| ratioFormatType Readonly Inherited | string | undefined | FormatProps | The format type for the numbers within a ratio. |
| ratioSeparator Readonly Inherited | string | undefined | FormatProps | The separator character for ratio formatting. |
| ratioType Readonly Inherited | string | undefined | FormatProps | Required when type is Ratio. |
| revolutionUnit Readonly Inherited | string | undefined | FormatProps | The name of the unit that represents a revolution/perigon. |
| roundFactor Readonly Inherited | number | undefined | FormatProps | Value is rounded to a multiple of this factor if nonzero and the applyRounding trait is set, defaults to 0 |
| scientificType Readonly Inherited | string | undefined | FormatProps | Required when type is Scientific. |
| showSignOption Readonly Inherited | string | undefined | FormatProps | How and when positive and negative signs are displayed. |
| stationBaseFactor Readonly Inherited | number | undefined | FormatProps | Optional base factor for station formatting. |
| stationOffsetSize Readonly Inherited | number | undefined | FormatProps | Required when type is Station. |
| stationSeparator Readonly Inherited | string | undefined | FormatProps | Character separating station and offset portions of a Station formatted value. |
| thousandSeparator Readonly Inherited | string | undefined | FormatProps | Character separating thousands in the integer part. |
| type Readonly Inherited | string | FormatProps | The format type. |
| uomSeparator Readonly Inherited | string | undefined | FormatProps | Character separating the magnitude from the unit label. |
Defined in
- quantity/src/Formatter/Interfaces.ts Line 176
Last Updated: 07 February, 2026
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.