API Reference › core-Quantity› Quantity › BaseFormat

BaseFormat Class

A base Format class with shared properties and functionality between quantity and ecschema-metadata Format classes

Extended by

Methods

Name Description
constructor(name: string): BaseFormat    
hasFormatTraitSet(formatTrait: FormatTraits): boolean This method returns true if the formatTrait is set in this Format object.  
loadFormatProperties(formatProps: FormatProps): void    
parseFormatTraits(formatTraitsFromJson: string | string[]): void This method parses input string that is typically extracted for persisted JSON data and validates that the string is a valid FormatType.  

Properties

Name Type Description
_allowMathematicOperations Protected boolean    
_azimuthBase Protected number | undefined    
_azimuthBaseUnit Protected UnitProps | undefined    
_azimuthCounterClockwise Protected boolean | undefined    
_decimalSeparator Protected string    
_formatTraits Protected FormatTraits    
_includeZero Protected boolean    
_minWidth Protected number | undefined    
_precision Protected number    
_ratioType Protected RatioType | undefined    
_revolutionUnit Protected UnitProps | undefined    
_roundFactor Protected number    
_scientificType Protected ScientificType | undefined    
_showSignOption Protected ShowSignOption    
_spacer Protected string    
_stationOffsetSize Protected number | undefined    
_stationSeparator Protected string    
_thousandSeparator Protected string    
_type Protected FormatType    
_uomSeparator Protected string    
allowMathematicOperations Accessor boolean    
azimuthBase Accessor undefined | number    
azimuthBaseUnit Accessor undefined | UnitProps    
azimuthClockwiseOrDefault Accessor ReadOnly boolean    
azimuthCounterClockwise Accessor undefined | boolean    
decimalSeparator Accessor string    
formatTraits Accessor FormatTraits    
includeZero Accessor undefined | boolean    
minWidth Accessor undefined | number    
name Accessor ReadOnly string    
precision Accessor DecimalPrecision | FractionalPrecision    
ratioType Accessor undefined | RatioType    
revolutionUnit Accessor undefined | UnitProps    
roundFactor Accessor number    
scientificType Accessor undefined | ScientificType    
showSignOption Accessor ShowSignOption    
spacer Accessor undefined | string    
spacerOrDefault Accessor ReadOnly string    
stationOffsetSize Accessor undefined | number    
stationSeparator Accessor string    
thousandSeparator Accessor string    
type Accessor FormatType    
uomSeparator Accessor string    

Defined in

Last Updated: 21 November, 2024