TextLeaderStyleProps Interface @beta
Properties describing the appearance of TextAnnotationLeader in a TextAnnotation. Used when producing geometry for TextAnnotation.
Properties
| Name | Type | Description | |
|---|---|---|---|
| color | TextStyleColor | "inherit" | The color of the leader. | |
| elbowLength | number | undefined | Multiplier used to compute length of the elbow in the leader. | |
| showLeaders | boolean | undefined | Whether to show the leaders in a TextAnnotation. | |
| showTargetPoint | boolean | undefined | Whether to show the target point in a TextAnnotation. | |
| showTerminators | boolean | undefined | Whether to show the leader terminator in a TextAnnotation. | |
| targetPointOffsetFactor | number | undefined | Multiplier used to compute the offset distance between the target point (at the leader start point) and the start of the leader line, measured along the first leader segment. | |
| targetPointShape | "plus" | "rectangle" | "circle" | "square" | "cross" | The shape of the target point in a TextAnnotation. | |
| terminatorHeightFactor | number | undefined | Multiplier to compute height of the leader terminator. | |
| terminatorShape | "none" | "circle" | "openArrow" | "closedArrow" | "closedArrowFilled" | "circleFilled" | "slash" | The shape of the leader terminator. | |
| terminatorWidthFactor | number | undefined | Multiplier to compute width of the leader terminator. | |
| wantElbow | boolean | undefined | Whether to use an elbow in the leader. |
Defined in
Last Updated: 03 September, 2026
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.