FieldPropertyType Type Alias

FieldPropertyType = "quantity" | "coordinate" | "string" | "boolean" | "datetime" | "int-enum" | "string-enum"

Enumerates the different kinds of Property values that can be used as the basis for a FieldRun's display string. A field's property type is derived from the property's PrimitiveType and other attributes like its PrimitiveOrEnumPropertyBase.extendedTypeName. The conversion of the raw property value into a display string can be customized by different FieldFormatOptions based on its type. The following types are currently recognized:

• "quantity": an often-unitized scalar value like a distance or area, formatted using a quantity Format.
• "coordinate": a 2- or 3-dimensional point, with each component formatted as a "quantity".
• "boolean": a true or false value; currently converted via toString() (localized formatting not yet implemented).
• "datetime": an ECMAScript Date.
• "int-enum": an integer EnumerationProperty; currently converted via toString() (display-label lookup not yet implemented).
• "string-enum": a string EnumerationProperty; currently converted via toString() (display-label lookup not yet implemented).
• "string": a value convertible to a string.

@note "quantity" and "coordinate" values format through the quantity pipeline when a Format resolves for the field, from the FormatSets configured via ElementDrivesTextAnnotation.registerFieldFormatting or from the iModel's schemas. Otherwise they render as value.toString() — a bare number, or (x, y[, z]) for a coordinate.

Defined in

• core/common/src/annotation/TextField.ts Line 28