Draft Text: Difference between revisions

From FreeCAD Documentation
(Arrows)
(More information for the properties)
Line 35: Line 35:


==Properties== <!--T:7-->
==Properties== <!--T:7-->
* {{PropertyData|Position}}: The base point of the text block
* {{PropertyData|Text}}: specifies the contents of the text block as a list of strings; each element on the list, separated by a comma, indicates a new line.
* {{PropertyData|Label Text}}: The contents of the text block
* {{PropertyData|Position}}: specifies the base point of the first line of the text block.
* {{PropertyView|Display Mode}}: Specifies if the text is aligned to the scene axes or always faces the camera
* {{PropertyData|Angle}}: specifies the rotation of the baseline of the first line of the text block.
* {{PropertyView|Font Size}}: The size of the letters
* {{PropertyData|Axis}}: specifies the axis to use for the rotation.

* {{PropertyView|Justification}}: Specifies if the text is aligned to the left, right or center of the base point.
=== View ===
* {{PropertyView|Line Spacing}}: Specifies the space between lines of text
* {{PropertyView|Rotation}}: Specifies a rotation to be applied to the text
* {{PropertyView|Display Mode}}: if "3D text" the text is aligned to the scene axes, initially lying on the XY plane; if "2D text" the text always faces the camera.
* {{PropertyView|Font Name}}: specifies the font to use to draw the text. It can be a font name, such as "Arial", a default style such as "sans", "serif" or "mono", a family such as "Arial,Helvetica,sans" or a name with a style such as "Arial:Bold". If the given font is not found on the system, a generic one is used instead.
* {{PropertyView|Rotation Axis}}: Specifies the axis to use for the rotation
* {{PropertyView|Font Size}}: specifies the size of the letters.
* {{PropertyView|Font Name}}: The font to use to draw the text. It can be a font name, such as "Arial", a default style such as "sans", "serif" or "mono", or a family such as "Arial,Helvetica,sans" or a name with a style such as "Arial:Bold". If the given font is not found on the system, a generic one is used instead.
* {{PropertyView|Justification}}: specifies if the text aligns to the left, right or at the center of the base point.
* {{PropertyView|Line Spacing}}: specifies the space between lines of text.


==Scripting== <!--T:8-->
==Scripting== <!--T:8-->

Revision as of 03:58, 7 November 2018

Draft Text

Menu location
Draft → Text
Workbenches
Draft, Arch
Default shortcut
T E
Introduced in version
-
See also
Draft ShapeString

Description

The Text tool inserts a piece of text at a given point in the current document. It uses the Draft Linestyle set on the Draft Tray.

To create solid text shapes use Draft ShapeString with Part Extrude.

How to use

  1. Press the Draft Text button, or press T then E keys.
  2. Click a point on the 3D view, or type a coordinate.
  3. Enter the desired text, pressing Enter between each line.
  4. Press Enter twice to finish the operation.

Options

  • To enter coordinates manually, simply enter the numbers, then press Enter between each X, Y and Z component.
  • Press Ctrl to force snapping your point to the nearest snap location, independently of the distance.
  • Press Enter or ↓ Down arrow to enter a new line of text.
  • Press ↑ Up arrow to edit the previous line of text.
  • Press Enter or ↓ Down arrow twice to finish editing the text.
  • Press Esc or the Close button to abort the current command.

Properties

  • DataText: specifies the contents of the text block as a list of strings; each element on the list, separated by a comma, indicates a new line.
  • DataPosition: specifies the base point of the first line of the text block.
  • DataAngle: specifies the rotation of the baseline of the first line of the text block.
  • DataAxis: specifies the axis to use for the rotation.

View

  • ViewDisplay Mode: if "3D text" the text is aligned to the scene axes, initially lying on the XY plane; if "2D text" the text always faces the camera.
  • ViewFont Name: specifies the font to use to draw the text. It can be a font name, such as "Arial", a default style such as "sans", "serif" or "mono", a family such as "Arial,Helvetica,sans" or a name with a style such as "Arial:Bold". If the given font is not found on the system, a generic one is used instead.
  • ViewFont Size: specifies the size of the letters.
  • ViewJustification: specifies if the text aligns to the left, right or at the center of the base point.
  • ViewLine Spacing: specifies the space between lines of text.

Scripting

The Text tool can by used in macros and from the python console by using the following function:

Text = makeText(stringlist, point=Vector(0,0,0), screen=False)
  • Creates a Text object, at the given point given by a FreeCAD.Vector
  • stringlist is a string, or a list of strings; if it's a list, each element is displayed in one line
  • The current Draft Linestyle specified in preferences are used
  • If screen is True, the text always faces the camera view direction, otherwise it lies on the XY plane

Example:

import FreeCAD, Draft
Draft.makeText("This is a sample text", FreeCAD.Vector(1,1,0))