API Reference › core-Quantity› Quantity › FormatProps

FormatProps Interface

This interface defines the persistence format for describing the formatting of quantity values.

Properties

Name Type Description
allowMathematicOperations Readonly boolean | undefined Enables calculating mathematic operations during parsing; only addition and subtraction are supported.  
azimuthBase Readonly number | undefined The base value for azimuth, specified from east counter-clockwise.  
azimuthBaseUnit Readonly string | undefined The name of the unit for the azimuth base value.  
azimuthCounterClockwise Readonly boolean | undefined If set to true, azimuth values are returned counter-clockwise from the base.  
composite Readonly FormatCompositeProps | undefined Composite format specification for multi-unit display.  
decimalSeparator Readonly string | undefined Character separating integer from fractional part.  
formatTraits Readonly string | string[] Array of format traits controlling display behavior.  
minWidth Readonly number | undefined Minimum width of the formatted output including digits and separators.  
precision Readonly number | undefined The precision for the format.  
ratioFormatType Readonly string | undefined The format type for the numbers within a ratio.  
ratioSeparator Readonly string | undefined The separator character for ratio formatting.  
ratioType Readonly string | undefined Required when type is Ratio.  
revolutionUnit Readonly string | undefined The name of the unit that represents a revolution/perigon.  
roundFactor Readonly number | undefined Value is rounded to a multiple of this factor if nonzero and the applyRounding trait is set, defaults to 0  
scientificType Readonly string | undefined Required when type is Scientific.  
showSignOption Readonly string | undefined How and when positive and negative signs are displayed.  
stationBaseFactor Readonly number | undefined Optional base factor for station formatting.  
stationOffsetSize Readonly number | undefined Required when type is Station.  
stationSeparator Readonly string | undefined Character separating station and offset portions of a Station formatted value.  
thousandSeparator Readonly string | undefined Character separating thousands in the integer part.  
type Readonly string The format type.  
uomSeparator Readonly string | undefined Character separating the magnitude from the unit label.  

Defined in

Last Updated: 07 February, 2026