Synopsis
Creates a leader with multiline text.
Mixins
InkTextMixin
InkLeaderMixin
BasePart
Canonicals
| Name | Type | Description |
|---|---|---|
| location | point | Start point of the TextLeader. The first point in pointList. |
| toPoint | point | End point of the TextLeader. The last point in pointList. |
Parameters
| Name | Type | Description |
|---|---|---|
| textBoxWidth | number | The horizontal size of a line of text. |
| pointList | list | List of points to define the path of the leader line. Must contain at least: textBoxPoint, tailpoint, and toPoint. |
| justification | name | Justification of the lines of text. Choices are :Left, :Right, and :Center. The default value is the value of tailSide. |
Rules
| Name | Type | Description |
|---|---|---|
| tailSide | name | Determines to which side the leader tail will be applied. Can be either :Right or :Left. |
| textBoxPoint | point | Edge center of text box, on side closest to the leader tail. Equal to location + (tailDir * textBoxWidth / 2). |
| tailDir | vector | Vector direction of tail. Can be either -unitX or unitX. Dependant upon the value of tailSide. |
| tailPoint | point | Location of leader tail. Equal to textBoxPoint + (tailDir * charHeight) |
Group Rules
<pointList> Determines the location and toPoint values from the list of points.
Example 1
| Name: | textLeader_Ex01 |
| Design: | acDrawingDocument |
| Child Name: | textLeader_1 | |
| Child Design: | :TextLeader | |
| Name | Type | Supplied |
| justification | name | :Left |
| pointList | list | {Point(2.5,2.5,0), Point(0.5,1.5,0)} |
| Text | string | "This is a TextLeader object" |
| textBoxWidth | number | 2 |
| arrowStyle | name | :ClosedFilled |
| arrowSize | number | 0.188 |
Example 2
| Name: | textLeader_Ex02 |
| Design: | acDrawingDocument |
| Child Name: | circle | |
| Child Design: | :Arc | |
| Name | Type | Supplied |
| center | point | Point(0, 0, 0) |
| radius | number | 1.0 |
| startAngle | number | 0 |
| endAngle | number | 360 |
| Child Name: | textLeader_2 | |
| Child Design: | :TextLeader | |
| Name | Type | Supplied |
| justification | name | :Left |
| location | point | Point(3.5,1.75,0) |
| toPoint | point | circlePoint(circle, 60) |
| Text | string | "TextLeader" |
| arrowStyle | name | :ClosedFilled |
| arrowSize | number | 0.188 |