FieldRunProps Interface

JSON representation of a FieldRun.

Extends

Properties

Name Type Description
cachedContent string | undefined The field's most recently evaluated display string.  
formatter FieldFormatter | undefined Specifies how to format the property value obtained from propertyPath into a string to be stored in cachedContent.  
propertyHost FieldPropertyHost The element and BIS class containing the property described by propertyPath.  
propertyPath FieldPropertyPath Describes how to obtain the property value from propertyHost.  
type Readonly "field" Discriminator field for the RunProps union.  

Inherited properties

Name Type Inherited from Description
styleOverrides Inherited TextStyleSettingsProps | undefined TextBlockComponentProps Deviations from the base TextStyleSettings defined by the AnnotationTextStyle applied to this component.

Defined in

Last Updated: 29 July, 2025