QuantityFieldFormatOptions Interface @beta
As part of a FieldFormatOptions, specifies how to format FieldPropertyType
"quantity" or "coordinate" values.
kindOfQuantity and persistenceUnit are independent overrides: setting one falls
through to the property for the other, and an empty string counts as unset. A name the iModel's
schemas define may use any case and either Schema.Item or Schema:Item spelling; a
KindOfQuantity defined only by a FormatSet must match its key exactly. A field that resolves
no format renders its raw value.
These property names are also the persisted form — a FieldRun serializes them verbatim
into its element's TextAnnotationData — so applications can query for annotations carrying
quantity overrides by the literal strings "kindOfQuantity" and "persistenceUnit".
@see Quantity formatting for text annotation fields for the full resolution order.
Properties
| Name | Type | Description | |
|---|---|---|---|
| formatSet | string | undefined | Identifier of a FormatSet whose formats take precedence for this field, letting one iModel | |
| kindOfQuantity | string | undefined | Full name of a KindOfQuantity (e.g. | |
| persistenceUnit | string | undefined | Full name of a Unit (e.g. |
Defined in
Last Updated: 02 October, 2026