Difference between revisions of "TechDraw Balloon"

From FreeCAD Documentation
Jump to navigation Jump to search
 
(27 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{UnfinishedDocu}}
 
 
<languages/>
 
<languages/>
 
<translate>
 
<translate>
 +
 
<!--T:23-->
 
<!--T:23-->
{{Docnav|[[TechDraw_Dimension_Link|Dimension Link ]]|[[TechDraw_SaveSVG|Save SVG]]|[[TechDraw_Module|TechDraw]]|IconL=Techdraw_Dimension_Link.png|IconC=Workbench_TechDraw.svg|IconR=techdraw-saveSVG.svg}}
+
{{Docnav
 +
|[[TechDraw_Dimension_Link|Dimension Link ]]
 +
|[[TechDraw_Dimension_Horizontal_Extent|New Horizontal Extent]]
 +
|[[TechDraw_Module|TechDraw]]
 +
|IconL=TechDraw_Dimension_Link.svg
 +
|IconR=TechDraw_Dimension_Horizontal_Extent.svg
 +
|IconC=Workbench_TechDraw.svg
 +
}}
  
 
<!--T:1-->
 
<!--T:1-->
Line 9: Line 16:
 
|Name=TechDraw Balloon
 
|Name=TechDraw Balloon
 
|MenuLocation=TechDraw → Balloon
 
|MenuLocation=TechDraw → Balloon
|Workbenches=[[TechDraw Module|TechDraw]]
+
|Workbenches=[[TechDraw_Module|TechDraw]]
|Version=0.19 (dev)
+
|Version=0.19
|SeeAlso=[[TechDraw NewAnnotation|TechDraw New annotation]]
+
|SeeAlso=[[TechDraw_NewAnnotation|TechDraw New annotation]]
 
}}
 
}}
  
Line 20: Line 27:
  
 
</translate>
 
</translate>
[[Image:Techdraw_balloon.png]]
+
[[Image:Techdraw_balloon.png|600px]]
 
<translate>
 
<translate>
  
==How to use== <!--T:3-->
+
==Usage== <!--T:3-->
  
 
<!--T:13-->
 
<!--T:13-->
 
# Select the View to which the Balloon will be attached.
 
# Select the View to which the Balloon will be attached.
# Press the {{Button|[[Image:TechDraw_Balloon.svg|16px]] [[TechDraw Balloon|Balloon]]}} button.
+
# Press the {{Button|[[Image:TechDraw_Balloon.svg|16px]] [[TechDraw_Balloon|Balloon]]}} button.
 
# The cursor is now displayed as a balloon icon. Click on the page to place the balloon origin to the desired position.
 
# The cursor is now displayed as a balloon icon. Click on the page to place the balloon origin to the desired position.
 
# The balloon bubble may be dragged to the desired position. Use CTRL-drag to move the bubble and the arrow.
 
# The balloon bubble may be dragged to the desired position. Use CTRL-drag to move the bubble and the arrow.
# You can change balloon properties by double clicking balloon label or balloon object in the tree. This will open the Balloon Task dialog:
+
# You can change balloon properties by double clicking balloon label or balloon object in the tree. This will open the Balloon task dialog.
[[File:task_balloon.png|center]]
 
  
 
== Using separators == <!--T:7-->
 
== Using separators == <!--T:7-->
  
 +
<!--T:26-->
 
When using a rectangle shape, separators can be added using "|" in the text.
 
When using a rectangle shape, separators can be added using "|" in the text.
 
For example "AAA|TEST|111" gives:
 
For example "AAA|TEST|111" gives:
  
[[File:balloon_separator.png]]
+
<!--T:27-->
 +
[[File:balloon_separator.png|300 px]]
  
 
==Properties== <!--T:5-->
 
==Properties== <!--T:5-->
  
 
=== Data === <!--T:16-->
 
=== Data === <!--T:16-->
 +
* {{PropertyData|Text}}: Text to be displayed.
 +
* {{PropertyData|Source View}}: Source View for the balloon.
 +
* {{PropertyData|Origin X}}: Balloon origin x-position
 +
* {{PropertyData|Origin Y}}: Balloon origin y-position
 +
* {{PropertyData|End Type}}: End symbol for the balloon line. Options: [[Image:Arrownone.svg|20px]] None, [[Image:Arrowfilled.svg|20px]] Filled Arrow, [[Image:Arrowopen.svg|20px]] Open Arrow, [[Image:Arrowtick.svg|20px]] Tick, [[Image:Arrowdot.svg|20px]] Dot, [[Image:arrowopendot.svg|20px]] Open Circle, [[Image:arrowfork.svg|20px]] Fork, [[Image:arrowpyramid.svg|20px]] Filled Triangle
 +
* {{PropertyData|Shape}}: Shape of the balloon bubble. Options: [[Image:Circular.svg|20px]] Circular, None, [[Image:Triangular.svg|20px]] Triangle, [[Image:Inspection.svg|20px]] Inspection, [[Image:Hexagon.svg|20px]] Hexagon, [[Image:Square-Shape.svg|20px]] Square, [[Image:Rectangular.svg|20px]] Rectangle
 +
* {{PropertyData|Shape Scale}}: Scale factor for the '''Shape'''.
 +
* {{PropertyData|Text Wrap}}: Text wrap length; -1 means the text will never be wrapped and the result is in every case a single line.
 +
* {{PropertyData|Kink Length}}: Distance from the '''Shape''' to the leader line kink.
 
* {{PropertyData|X}}: Horizontal position of the balloon bubble relative to the View.
 
* {{PropertyData|X}}: Horizontal position of the balloon bubble relative to the View.
 
* {{PropertyData|Y}}: Vertical position of the balloon bubble relative to the View.
 
* {{PropertyData|Y}}: Vertical position of the balloon bubble relative to the View.
  
 
=== View === <!--T:17-->
 
=== View === <!--T:17-->
 +
* {{PropertyView|Color}}: Color of the balloon text.
 
* {{PropertyView|Font}}: The name of the font to use for the balloon bubble.
 
* {{PropertyView|Font}}: The name of the font to use for the balloon bubble.
 
* {{PropertyView|Fontsize}}: Dimension text size in mm.
 
* {{PropertyView|Fontsize}}: Dimension text size in mm.
 +
* {{PropertyView|Line Width}}: Balloon line width
  
 
==Scripting== <!--T:6-->
 
==Scripting== <!--T:6-->
  
 
<!--T:18-->
 
<!--T:18-->
{{Emphasis|See also:}} [[TechDraw API|TechDraw API]] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]].
+
{{Emphasis|See also:}} [[TechDraw_API|TechDraw API]] and [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].
  
 
<!--T:19-->
 
<!--T:19-->
The Balloon tool can be used in [[macros|macros]] and from the [[Python|Python]] console by using the following functions:
+
The Balloon tool can be used in [[Macros|macros]] and from the [[Python|Python]] console by using the following functions:
  
 
</translate>
 
</translate>
Line 64: Line 83:
 
}}
 
}}
 
<translate>
 
<translate>
 
 
==Notes== <!--T:10-->
 
 
<!--T:20-->
 
*
 
 
  
 
<!--T:24-->
 
<!--T:24-->
{{Docnav|[[TechDraw_Dimension_Link|Dimension Link ]]|[[TechDraw_SaveSVG|Save SVG]]|[[TechDraw_Module|TechDraw]]|IconL=Techdraw_Dimension_Link.png|IconC=Workbench_TechDraw.svg|IconR=techdraw-saveSVG.svg}}
+
{{Docnav
 
+
|[[TechDraw_Dimension_Link|Dimension Link ]]
<!--T:21-->
+
|[[TechDraw_Dimension_Horizontal_Extent|New Horizontal Extent]]
{{TechDraw Tools navi}}
+
|[[TechDraw_Module|TechDraw]]
 +
|IconL=TechDraw_Dimension_Link.svg
 +
|IconR=TechDraw_Dimension_Horizontal_Extent.svg
 +
|IconC=Workbench_TechDraw.svg
 +
}}
  
<!--T:22-->
 
{{Userdocnavi}}
 
 
</translate>
 
</translate>
 +
{{TechDraw Tools navi{{#translation:}}}}
 +
{{Userdocnavi{{#translation:}}}}
 
{{clear}}
 
{{clear}}

Latest revision as of 22:03, 2 December 2020

Other languages:
Deutsch • ‎English • ‎français • ‎italiano • ‎русский

TechDraw Balloon.svg TechDraw Balloon

Menu location
TechDraw → Balloon
Workbenches
TechDraw
Default shortcut
None
Introduced in version
0.19
See also
TechDraw New annotation


Description

The Balloon tool can add balloons with leader line in a drawing.

Techdraw balloon.png

Usage

  1. Select the View to which the Balloon will be attached.
  2. Press the TechDraw Balloon.svg Balloon button.
  3. The cursor is now displayed as a balloon icon. Click on the page to place the balloon origin to the desired position.
  4. The balloon bubble may be dragged to the desired position. Use CTRL-drag to move the bubble and the arrow.
  5. You can change balloon properties by double clicking balloon label or balloon object in the tree. This will open the Balloon task dialog.

Using separators

When using a rectangle shape, separators can be added using "|" in the text. For example "AAA|TEST|111" gives:

Balloon separator.png

Properties

Data

  • DataText: Text to be displayed.
  • DataSource View: Source View for the balloon.
  • DataOrigin X: Balloon origin x-position
  • DataOrigin Y: Balloon origin y-position
  • DataEnd Type: End symbol for the balloon line. Options: Arrownone.svg None, Arrowfilled.svg Filled Arrow, Arrowopen.svg Open Arrow, Arrowtick.svg Tick, Arrowdot.svg Dot, Arrowopendot.svg Open Circle, Arrowfork.svg Fork, Arrowpyramid.svg Filled Triangle
  • DataShape: Shape of the balloon bubble. Options: Circular.svg Circular, None, Triangular.svg Triangle, Inspection.svg Inspection, Hexagon.svg Hexagon, Square-Shape.svg Square, Rectangular.svg Rectangle
  • DataShape Scale: Scale factor for the Shape.
  • DataText Wrap: Text wrap length; -1 means the text will never be wrapped and the result is in every case a single line.
  • DataKink Length: Distance from the Shape to the leader line kink.
  • DataX: Horizontal position of the balloon bubble relative to the View.
  • DataY: Vertical position of the balloon bubble relative to the View.

View

  • ViewColor: Color of the balloon text.
  • ViewFont: The name of the font to use for the balloon bubble.
  • ViewFontsize: Dimension text size in mm.
  • ViewLine Width: Balloon line width

Scripting

See also: TechDraw API and FreeCAD Scripting Basics.

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

bal1 = FreeCAD.ActiveDocument.addObject('TechDraw::DrawViewBalloon','Balloon')
rc = page.addView(bal1)