Difference between revisions of "TechDraw NewAnnotation"
Jump to navigation
Jump to search
TechDraw
User documentation
(Move the notes to the usage section, so they are prominent.) |
m ([[ | ]]) |
||
| Line 9: | Line 9: | ||
|MenuLocation=TechDraw → Annotation | |MenuLocation=TechDraw → Annotation | ||
|Workbenches=[[TechDraw Module|TechDraw]] | |Workbenches=[[TechDraw Module|TechDraw]] | ||
| − | |SeeAlso=[[Draft Text]], [[Draft ShapeString]] | + | |SeeAlso=[[Draft Text|Draft Text]], [[Draft ShapeString|Draft ShapeString]] |
}} | }} | ||
| Line 35: | Line 35: | ||
{{Caption|Modifying the annotation through the property editor}} | {{Caption|Modifying the annotation through the property editor}} | ||
| − | <-- | + | <!-- Editor's note: do not change the & values, they are used to escape the symbols and show them verbatim --> |
| + | |||
{{Emphasis|Note:}} some characters interfere with the internal representation of the Annotation text. Specifically, these are the double quote {{incode|"}}, less than {{incode|<}}, and greater than {{incode|>}} symbols; these must be replaced by HTML escape characters, {{incode|&quot;}}, {{incode|&lt;}}, and {{incode|&gt;}} respectively. See [https://en.wikipedia.org/wiki/Character_encodings_in_HTML#HTML_character_references Character encodings in HTML] for details. | {{Emphasis|Note:}} some characters interfere with the internal representation of the Annotation text. Specifically, these are the double quote {{incode|"}}, less than {{incode|<}}, and greater than {{incode|>}} symbols; these must be replaced by HTML escape characters, {{incode|&quot;}}, {{incode|&lt;}}, and {{incode|&gt;}} respectively. See [https://en.wikipedia.org/wiki/Character_encodings_in_HTML#HTML_character_references Character encodings in HTML] for details. | ||
| Line 55: | Line 56: | ||
<!--T:16--> | <!--T:16--> | ||
| − | {{Emphasis|See also:}} [[TechDraw API]] and [[FreeCAD Scripting Basics]]. | + | {{Emphasis|See also:}} [[TechDraw API|TechDraw API]] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]]. |
<!--T:17--> | <!--T:17--> | ||
| − | The New Annotation tool can be used in [[macros]] and from the [[Python]] console by using the following functions: | + | The New Annotation tool can be used in [[macros|macros]] and from the [[Python|Python]] console by using the following functions: |
</translate> | </translate> | ||
Revision as of 10:02, 17 September 2019
|
|
| Menu location |
|---|
| TechDraw → Annotation |
| Workbenches |
| TechDraw |
| Default shortcut |
| None |
| Introduced in version |
| - |
| See also |
| Draft Text, Draft ShapeString |
Description
The Annotation tool adds a text block to a drawing page.
Annotation in the drawing page
How to use
- If you have multiple drawing pages in your document, you will need to select the desired page in the tree.
- Press the
Annotation button - A text block containing "Default Text" will appear on the page. Use the property editor to change the text. Drag the Annotation to the required position.
- You may need to press recompute
to get your text to change.
Modifying the annotation through the property editor
Note: some characters interfere with the internal representation of the Annotation text. Specifically, these are the double quote ", less than <, and greater than > symbols; these must be replaced by HTML escape characters, ", <, and > respectively. See Character encodings in HTML for details.
Properties
- DataText: The text to be displayed.
- DataFont: The name of the font to use. Annotation will use the best match of installed fonts.
- DataTextColor: The color of the text.
- DataTextSize: The size of the text in mm.
- DataMaxWidth: The maximum width of the Annotation block. -1 indicates no maximum width.
- DataLineSpace: Line spacing adjustment (%).
- DataTextStyle: "Normal", "Bold", "Italic", "Bold-Italic"
Note: Annotation inherits all applicable basic View properties except Scale. Use the TextSize property instead.
Scripting
See also: TechDraw API and FreeCAD Scripting Basics.
The New Annotation tool can be used in macros and from the Python console by using the following functions:
anno = FreeCAD.ActiveDocument.addObject('TechDraw::DrawViewAnnotation','TestAnno')
anno.Text = ['Different Text']
anno.TextStyle = 'Bold'
rc = page.addView(anno)
Notes
TechDraw
- Pages: Insert Default Page, Insert Page using Template, Redraw Page
- Views: Insert View, Insert Active View, Insert Projection Group, Insert Section View, Insert Detail View, Insert Draft Workbench Object, Insert Arch Workbench Object, Insert Spreadsheet View
- Clips: Insert Clip Group, Add View to Clip Group, Remove View from Clip Group
- Dimensions: New Length, New Horizontal, New Vertical, New Radius, New Diameter, New Angle, New Angle3Pt, New Links, New Balloon
- Decorations: Hatch Face using Image File, Apply Geometric Hatch to Face, Insert SVG Symbol, Insert Bitmap Image, Turn View Frames On/Off
- Annotations: Insert Annotation, Add Leaderline to View, Insert Rich Text Annotation, Add Cosmetic Vertex, Add Midpoint Vertices, Add Quadrant Vertices, Add Centerline to Face(s), Add Centerline between 2 Lines, Add Centerline between 2 Points, Remove Cosmetic Object, Change Appearance of Line(s), Show/Hide Invisible Edges, Add Welding Information to Leader
- Import/Export: Export Page as SVG, Export Page as DXF
- Additional: Preferences; Hatching, LineGroup, Templates; TechDraw API, TechDrawGui API
User documentation
- Getting started
- Installation: Download, Linux, Windows, MacOS, Docker, AppImage, Ubuntu Snap
- Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties; Help FreeCAD, Donate
- Help: Tutorials, Video tutorials
- Workbenches: Std Base; Arch, Draft, FEM, Image, Inspection, Mesh, OpenSCAD, Part, PartDesign, Path, Points, Raytracing, Reverse Engineering, Sketcher, Spreadsheet, Start, Surface, TechDraw, Test Framework, Web
- Unmaintained workbenches: Plot, Robot, Ship
- Deprecated workbenches: Complete, Drawing
- Code: Addon Manager, Addons, Macros, External workbenches
- Hubs: User hub, Power users hub, Developer hub
