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 | |
| 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 | { includeZero?: boolean, spacer?: string, units: { label?: string, name: string }[] } | undefined | FormatProps | |
| decimalSeparator Readonly Inherited | string | undefined | FormatProps | |
| formatTraits Readonly Inherited | string | string[] | FormatProps | |
| minWidth Readonly Inherited | number | undefined | FormatProps | |
| precision Readonly Inherited | number | undefined | FormatProps | |
| ratioType Readonly Inherited | string | undefined | FormatProps | conditionally required. |
| revolutionUnit Readonly Inherited | string | undefined | FormatProps | The name of the unit that represents a revolution/perigon. |
| roundFactor Readonly Inherited | number | undefined | FormatProps | |
| scientificType Readonly Inherited | string | undefined | FormatProps | conditionally required. |
| showSignOption Readonly Inherited | string | undefined | FormatProps | |
| stationOffsetSize Readonly Inherited | number | undefined | FormatProps | conditionally required. |
| stationSeparator Readonly Inherited | string | undefined | FormatProps | |
| thousandSeparator Readonly Inherited | string | undefined | FormatProps | |
| type Readonly Inherited | string | FormatProps | |
| uomSeparator Readonly Inherited | string | undefined | FormatProps |
Defined in
- quantity/src/Formatter/Interfaces.ts Line 102
Last Updated: 26 April, 2025
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.