API Reference › ecschema-Metadata› Metadata › OverrideFormat

OverrideFormat Class @preview

Overrides of a Format, from a Schema, and is SchemaItem that is used specifically on KindOfQuantity.

Methods

Name Description
getFormatProps(): SchemaItemOverrideFormatProps Returns a JSON object that contains the specification for the OverrideFormat where the precision and units properties have been overriden.  
hasFormatTrait(formatTrait: FormatTraits): boolean    
createOverrideFormatFullName(parent: Format, precision?: DecimalPrecision | FractionalPrecision, unitAndLabels?: [LazyLoadedUnit | LazyLoadedInvertedUnit, string | undefined][]): string Static Creates a valid OverrideFormat fullName from the parent Format and overridden units.  
parseFormatString(formatString: string): OverrideFormatProps Static Parses the format string into the parts that make up an Override Format  

Properties

Name Type Description
decimalSeparator Accessor ReadOnly string    
formatTraits Accessor ReadOnly FormatTraits    
fullName Accessor ReadOnly string    
includeZero Accessor ReadOnly boolean | undefined    
minWidth Accessor ReadOnly number | undefined    
name Readonly string The name of this OverrideFormat.  
parent Readonly Format The Format that this OverrideFormat is extending  
precision Accessor ReadOnly DecimalPrecision | FractionalPrecision    
ratioFormatType Accessor ReadOnly string | undefined    
ratioSeparator Accessor ReadOnly string | undefined    
ratioType Accessor ReadOnly string | undefined    
roundFactor Accessor ReadOnly number    
scientificType Accessor ReadOnly ScientificType | undefined    
showSignOption Accessor ReadOnly ShowSignOption    
spacer Accessor ReadOnly string | undefined    
stationOffsetSize Accessor ReadOnly number | undefined    
stationSeparator Accessor ReadOnly string    
thousandSeparator Accessor ReadOnly string    
type Accessor ReadOnly FormatType    
units Accessor ReadOnly ReadonlyArray<[LazyLoadedUnit | LazyLoadedInvertedUnit, string | undefined]> | undefined    
uomSeparator Accessor ReadOnly string    

Defined in

Last Updated: 07 May, 2026