TechDraw LeaderLine

From FreeCAD Documentation

File:Techdraw-mline.svg TechDraw LeaderLine

Menu location
TechDraw → LeaderLine
Workbenches
TechDraw
Default shortcut
None
Introduced in version
-
See also
TechDraw Templates, Draft SVG, RichTextBlock

Description

The LeaderLine tool adds a line to a View. Other annotation objects (such as RichTextBlock) can be connected to the LeaderLine to form complex annotations.

Leader line added to View001

How to use

  1. Press the File:Techdraw-mline.svg LeaderLine button
  2. A Task dialog will open. The dialog allows drawing of the leader line and assigning end symbols to the line.
  3. The Pick points button starts a line drawing function. Line drawing always starts at the point the line is to be attached to the View.
  4. Click to add a point, move the mouse to draw a line segment.
  5. To exit the line editor, double click, press Right Mouse Button or press the Escape Edit button in the dialog.
  6. After the line is created, it can be edited by double clicking the LeaderLine in the Tree.


Properties

  • DataX,Y: The point at which the leader line is connected to the View.
  • DataLeader Parent: The View to which the leader is attached.
  • DataStart Symbol: The line end symbol (arrowhead) at the View end.
  • DataEnd Symbol: The line end symbol at the annotation block end.
  • DataScalable: Leader scales with Leader Parent.
  • ViewColor: Pen colour for the leader line.
  • ViewLine Style: 0 - No Line, 1 - Solid Line, ...
  • ViewLine Width: Weight of leader line.


Scripting

See also: TechDraw API and FreeCAD Scripting Basics.

The LeaderLine tool can be used in macros and from the Python console by using the following functions:

myPage = FreeCAD.ActiveDocument().Page
myBase = FreeCAD.ActiveDocument().View
leaderObj = FreeCAD.ActiveDocument.addObject('TechDraw::DrawLeaderLine','DrawLeaderLine')
FreeCAD.activeDocument().myPage.addView(leaderObj)
FreeCAD.activeDocument().leaderObj.LeaderParent = myBase
#first waypoint is always (0,0,0)  
#rest of waypoints are positions relative to (0,0,0)
leaderObj.Waypoints = [p0,p1,p2]
leaderObj.X = 5
leaderObj.Y = 5

Notes

  • This feature was added in v0.19
  • You can edit your LeaderLine by double clicking on it in the tree view. Double clicking in the graphics area is not yet supported.
  • The leader line can be edited by pressing "Edit points" while in edit mode. To exit point editing: press "Escape editing", press ESC or press RightMouseButton (RMB).