Draft Label

Description
The Draft Label command inserts a multi-line textbox with a 2-segment leader line and an arrow. If an object or a sub-element (face, edge or vertex) is selected when starting the command, the Label can be made to display a certain attribute of the selected element, including position, length, area, volume or material.

To insert a text element without an arrow use the Draft Text command.



Usage

 * 1) There are several ways to invoke the command:
 * 2) * Press the button.
 * 3) * Select the option from the menu.
 * 4) * Use the keyboard shortcut: then.
 * 5) Click the first point in the 3D view, or type coordinates and press the  button. This point indicates the target (arrow head). This can be anywhere, it doesn't have to be an element.
 * 6) Click the second point in the 3D view, or type coordinates and press the  button. This point indicates the start of a horizontal or vertical leader.
 * 7) Click the third point in the 3D view, or type coordinates and press the  button. This point indicates the base point of the text.

Options

 * Click on to select the type of information to display, including "Custom", "Name", "Label", "Position", "Length", "Area", "Volume", "Tag" and "Material". (See explanation of  Label types below)
 * To enter coordinates manually, simply enter the numbers, then press between each X, Y and Z component. You can press the  button when you have the desired values to insert the point.
 * Hold while placing the label to force snapping your point to the nearest snap location, independently of the distance.
 * Press or the  button to abort the current command.

Properties
See also: Property editor.

A Draft Label object is derived from an App FeaturePython object and inherits all its properties. The following properties are additional unless otherwise stated:

Data

 * : specifies the contents of the text if is . Each item in the list represents a new text line.
 * : specifies the type of information displayed by the label (see Label types below).
 * : specifies the position of the text in the 3D view and, unless is, also of the first leader segment, which is the segment where the text is attached. See Placement.
 * : (read-only) specifies the contents of the text that is actually displayed. Each item in the list represents a new text line.


 * : specifies the points of the leader.
 * : specifies the direction of the first leader segment:, or.
 * : specifies the length of the first leader segment. Only used if is  or . If the distance is positive, the leader starts from the right side of the text and the text aligns to the right. Otherwise the leader starts from the left side of the text and the text aligns to the left.


 * : specifies the object and optional subelement the label is linked to.
 * : specifies the position of the tip of the leader, which is where the arrow is attached.

Label types

 * : displays the contents of.
 * : displays the internal name of the target object. The internal name is assigned when an object is created and remains fixed throughout the existence of the object.
 * : displays the label of the target object. The label of an object can be changed by the user.
 * : displays the coordinates of the base point of the target object, of the target vertex, or of the center of mass of the target subelement, if applicable.
 * : displays the length of the target object or subelement, if applicable.
 * : displays the area of the target object or subelement, if applicable.
 * : displays the volume of the target object, if applicable.
 * : displays the attribute of the target object, if applicable. Objects created with the Arch Workbench can have this attribute.
 * : displays the label of the material of the target object, if applicable.

View

 * : specifies the annotation style applied to the label. See Draft AnnotationStyleEditor.
 * : specifies the general scaling factor applied to the label.


 * : specifies how the text is displayed. If it is the text will be displayed in a plane defined by the  of the label. If it is  the text will always face the camera. This is an inherited property.


 * : specifies the size of the symbol displayed at the tip of the leader.
 * : specifies the type of symbol displayed at the tip of the leader, which can be, , , or.
 * : specifies what type of frame is drawn around the text. The current options are or.
 * : specifies whether to display the leader line. If it is only the arrow and the text are displayed.
 * : specifies the color of the leader and the arrow.
 * : specifies the width of the leader.


 * : specifies the horizontal alignment of the text:, or . Only used if  is . Otherwise the horizontal alignment is based on the sign (positive or negative) of.
 * : specifies the factor applied to the default line height of the text.
 * : specifies the maximum number of characters on each line of the text.
 * : specifies the vertical alignment of the text:, or.
 * : specifies the color of the text.
 * : specifies the font used to draw the text. It can be a font name, such as, a default style such as , or , a family such as , or a name with a style such as . If the given font is not found on the system, a default font is used instead.
 * : specifies the size of the letters. The text can be invisible in the 3D view if this value is very small.

Scripting
See also: Autogenerated API documentation and FreeCAD Scripting Basics.

To create a Draft Label use the method  of the Draft module. This method replaces the deprecated method.

Example: