API Reference › core-common› Annotation

Annotation

APIs for producing and manipulating annotations like text, dimensions, and labels.

Classes

Name Description  
FieldRun A Run that displays the formatted value of a property of some Element.  
FractionRun A Run containing a numeric ratio to be displayed as a numerator and denominator separated by a horizontal or diagonal bar.  
LineBreakRun A Run that represents the end of a line of text within a Paragraph.  
List A collection of list items (Paragraphs).  
Paragraph A collection of Runs and Lists.  
TabRun A TabRun is used to shift the next tab stop.  
TextAnnotation Represents a formatted block of text positioned in 2d or 3d space.  
TextBlock Represents a formatted text document consisting of a series of Paragraphs, each laid out on a separate line and containing their own content.  
TextBlockComponent Abstract representation of any of the building blocks that make up a TextBlock document - namely Runs and StructuralTextBlockComponents.  
TextRun The most common type of Run, containing a sequence of characters to be displayed using a single style.  
TextStyleSettings A description of the formatting to be applied to a TextBlockComponent.  

Constants

Name Description  
textAnnotationFrameShapes Set of predefined shapes that can be computed and drawn around the margins of a TextBlock  

Enumerations

Name Description  
ListMarkerEnumerator Predefined markers for list items in text annotations.  

Global Functions

Name Description  
getMarkerText Returns the formatted marker text for a list item based on the marker type and item number.  
traverseTextBlockComponent Recursively traverses a StructuralTextBlockComponent tree, yielding each child component along with its parent container.  

Interfaces

Name Description  
ClearTextStyleOptions Options supplied to clearStyleOverrides to control how the style overrides are cleared on the component and its child components.  
DateTimeFieldFormatOptions As part of a FieldFormatOptions, specifies how to format properties of FieldPropertyType "datetime".  
FieldFormatOptions Customizes how to format the raw property value resolved by a FieldPropertyPath into a FieldRun's display string.  
FieldPropertyHost Describes the source of the property value against which a FieldPropertyPath is evaluated.  
FieldPropertyPath A chain of property accesses that resolves to a primitive value that forms the basis of the displayed content  
FieldRunProps JSON representation of a FieldRun.  
FractionRunProps JSON representation of a FractionRun.  
LineBreakRunProps JSON representation of a LineBreakRun.  
LineLayoutResult Represents a single line in a TextBlockLayoutResult.  
ListMarker A settings to specify how to mark or denote the start of a list item in a List.  
ListProps JSON representation of a List.  
ParagraphProps JSON representation of a Paragraph.  
RunLayoutResult Represents a single run in a LineLayoutResult.  
TabRunProps JSON representation of a TabRun.  
TextAnnotationAnchor Describes how to compute the "anchor point" for a TextAnnotation.  
TextAnnotationCreateArgs Arguments supplied to TextAnnotation.create.  
TextAnnotationLeader A line that connects a TextAnnotation to a point in space relative to another element in the iModel.  
TextAnnotationLeaderProps JSON representation of a TextAnnotationLeader.  
TextAnnotationProps JSON representation of a TextAnnotation.  
TextBlockComponentProps The JSON representation of a TextBlockComponent.  
TextBlockGeometryProps JSON representation of the geometric primitives that can be used to display a TextBlock.  
TextBlockLayoutResult Represents the result of laying out a TextBlock's contents into a series of lines containing runs.  
TextBlockMargins Describes the margins around the content inside a TextBlock, measured in meters.  
TextBlockProps JSON representation of a TextBlock.  
TextBlockStringifyContext Context information that may be useful when converting a TextBlock to a string.  
TextBlockStringifyOptions Options supplied to stringify to control how the content is formatted.  
TextFrameStyleProps Describes how to draw the frame around a TextAnnotation.  
TextLeaderStyleProps Properties describing the appearance of TextAnnotationLeader in a TextAnnotation.  
TextRunProps JSON representation of a TextRun.  
TextStyleSettingsProps Serves both as the JSON representation of a TextStyleSettings, and a way for a TextBlockComponent to selectively override aspects of a AnnotationTextStyle's properties.  

Namespaces

Name Description  
Run A sequence of characters within a Paragraph that share a single style.  

Type Aliases

Name Description  
BaselineShift Describes whether the characters of a TextRun should be displayed normally, in subscript, or in superscript.  
FieldCase As part of FieldFormatOptions, specifies how to modify the case of the display string.  
FieldPropertyType Enumerates the different kinds of Property values that can be used as the basis for a FieldRun's display string.  
LeaderAttachment Describes how to attach a TextAnnotationLeader to the frame around a TextBlock.  
LeaderTextPointOptions Specifies the possible positions to attach a leader on the frame around a TextBlock  
Run TextBlockComponents contained within a Paragraph.  
RunProps The JSON representation of a Run.  
StackedFractionType Specifies how to separate the numerator and denominator of a FractionRun, by either a horizontal or diagonal bar.  
StructuralTextBlockComponent A union of all the TextBlockComponents that can contain other components.  
TextAnnotationFillColor Describes what color to use when filling the frame around a TextBlock.  
TextAnnotationFrameShape Describes a predefined shape that can be computed and drawn around the margins of a TextBlock  
TextBlockGeometryPropsEntry A single entry in a TextBlockGeometryProps, representing one of the following primitive types:  
TextJustification Describes the relative alignment of text.  
TextStyleColor Describes the color in which to draw the text in a TextRun.  

Last Updated: 01 October, 2025