FieldPropertyPath Interface @beta

A chain of property accesses that resolves to a primitive value that forms the basis of the displayed content of a FieldRun.

• The simplest property paths consist of a propertyName and nothing else, where propertyName identifies
• a primitive property.
• If propertyName identifies a struct or array property, then additional accessors are required to identify the specific value.
• If propertyName (including any accessors) resolves to a string property of extended type Json, such as JsonProperties,
• then additional jsonAccessors are required to identify a specific value within the serialized JSON.
• Some examples:
• | Access String | propertyName | accessors | jsonAccessors |
• | ------------- | ------------ | --------- | ------------- |
• | name | "name" | undefined | undefined |
• | spouse.name | "spouse" | [name] | undefined |
• | colors[2] | "colors" | [2] | undefined |
• | spouse.favoriteRestaurants[1].address | "spouse" | ["favoriteRestaurants", 1, "address"] | undefined |
• | jsonProperties.contactInfo.email | "jsonProperties" | undefined | ["contactInfo", "email"] |
• | spouse.jsonProperties.contactInfo.phoneNumbers[0].areaCode | "spouse" | ["jsonProperties"] | ["contactInfo", "phoneNumbers", 0, "areaCode"] |
• A path using jsonAccessors must end on a scalar (string, number, or boolean); a path that ends on an object, an array,
• or a JSON null resolves to no value.
• For example, to display a value stored in an element's JsonProperties:
• /** Create a field that displays the contactInfo.email value stored in the element's JsonProperties. */ export function createJsonPropertiesField(elementId: Id64String): FieldRun { return FieldRun.create({ propertyHost: { elementId, schemaName: "BisCore", className: "PhysicalElement" }, propertyPath: { propertyName: "JsonProperties", jsonAccessors: ["contactInfo", "email"] }, }); }
• Or, when the JSON property is reached through a struct member:
• /** Create a field whose JSON property is reached through a struct member.
• accessors walks the EC properties to the Json-typed string property; jsonAccessors then walks the parsed JSON. */ export function createNestedJsonField(elementId: Id64String): FieldRun { return FieldRun.create({ propertyHost: { elementId, schemaName: "MySchema", className: "Person" }, propertyPath: { propertyName: "spouse", accessors: ["jsonProperties"], jsonAccessors: ["phoneNumbers", 0, "areaCode"], }, }); }

Properties

Defined in

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