API Reference › core-common› Annotation › FieldPropertyPath

FieldPropertyPath Interface

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.
  • Some examples:
  • | Access String | propertyName | accessors |
  • | ------------- | ------------ | --------- |
  • | name | "name" | undefined |
  • | spouse.name | "spouse" | [name] |
  • | colors[2] | "colors" | [2] |
  • | spouse.favoriteRestaurants[1].address | "spouse" | ["favoriteRestaurants", 1, "address"] |

Properties

Name Type Description
accessors string | number[] | undefined Property names and/or array indices describing the path from propertyName to the ultimate BIS property.  
propertyName string The name of the BIS property of the FieldPropertyHost that serves as the root of the path.  

Defined in

Last Updated: 07 October, 2025