TextAnnotationLeader Interface
A line that connects a TextAnnotation to a point in space relative to another element in the iModel. A leader is always attached to the frame around the annotation's TextBlock. If the frame is not visible, the leader attaches to an invisible rectangular frame around the text block.
@see - leaders for the leaders associated with an annotation.
- TextStyleSettings.leader and styleOverrides to customize the appearance of leaders.
Properties
| Name | Type | Description | |
|---|---|---|---|
| attachment | LeaderAttachment | Describes how to attach the leader to the frame around textBlock. | |
| intermediatePoints | Point3d[] | undefined | Optional intermediate points that the leader should pass through. | |
| startPoint | Point3d | The point where the leader starts. | |
| styleOverrides | TextStyleSettingsProps | undefined | Optional style overrides for the leader. |
Defined in
Last Updated: 29 July, 2025
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.