API Reference › ecschema-Metadata› Metadata › SchemaItemOverrideFormatProps

SchemaItemOverrideFormatProps Interface

Extends

Properties

Name Type Description
parent Readonly string    

Inherited properties

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

Defined in

Last Updated: 29 January, 2026