TechDraw Balloon: Difference between revisions

From FreeCAD Documentation
No edit summary
mNo edit summary
 
(54 intermediate revisions by 12 users not shown)
Line 1: Line 1:
{{UnfinishedDocu}}
<languages/>
<languages/>
<translate>
<translate>

<!--T:23-->
<!--T:23-->
{{Docnav
{{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}}
|[[TechDraw_LinkDimension|LinkDimension]]
|[[TechDraw_AxoLengthDimension|AxoLengthDimension]]
|[[TechDraw_Workbench|TechDraw]]
|IconL=TechDraw_LinkDimension.svg
|IconR=TechDraw_AxoLengthDimension.svg
|IconC=Workbench_TechDraw.svg
}}


<!--T:1-->
<!--T:1-->
{{GuiCommand
{{GuiCommand
|Name=TechDraw Balloon
|Name=TechDraw Balloon
|MenuLocation=TechDraw → Balloon
|MenuLocation=TechDraw → Annotations → Insert Balloon Annotation
|Workbenches=[[TechDraw Module|TechDraw]]
|Workbenches=[[TechDraw_Workbench|TechDraw]]
|Version=0.19 (dev)
|Version=0.19
|SeeAlso=[[TechDraw NewAnnotation|TechDraw New annotation]]
|SeeAlso=[[TechDraw_Annotation|TechDraw Annotation]]
}}
}}


Line 17: Line 24:


<!--T:11-->
<!--T:11-->
The Balloon tool can add balloons with leader line in a drawing.
The '''TechDraw Balloon''' tool can add balloons with leader line in a drawing.


</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 one of the following:
#* A View (on the page or in the [[Tree_view|Tree view]]).
# Press the {{Button|[[Image:TechDraw_Balloon.svg|16px]] [[TechDraw Balloon|Balloon]]}} button.
#* A vertex in a View. {{Version|0.20}}
# The cursor is now displayed as a balloon icon. Click on the page to place the balloon origin to the desired position.
#* An edge in a View. {{Version|0.20}}
# The balloon bubble may be dragged to the desired position. Use CTRL-drag to move the bubble and the arrow.
#* A closed region in a View. {{Version|0.20}}
# You can change balloon properties by double clicking balloon label or balloon object in the tree. This will open the Balloon Task dialog:
# There are several ways to invoke the tool:
[[File:task_balloon.png|center]]
#* Press the {{Button|[[Image:TechDraw_Balloon.svg|16px]] [[TechDraw_Balloon|Insert Balloon Annotation]]}} button.
#* Select the {{MenuCommand|TechDraw → Annotations → [[Image:TechDraw_Balloon.svg|16px]] Insert Balloon Annotation}} option from the menu.
# If a View or a region was selected:
## The cursor changes to a balloon icon.
## Click a point on the page for the origin of the Balloon.

<!--T:30-->
To move the bubble of a Balloon, press and hold the left mouse button on its center and drag the mouse.

<!--T:31-->
To change the properties of a Balloon double-click it on the page or in the [[Tree_view|Tree view]]. This will open the Balloon task panel.

<!--T:29-->
'''Note:''' The position of a Balloon is relative to its Source View and uses the same scale factor.


== 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:


<!--T:27-->
[[File:balloon_separator.png]]
[[File:balloon_separator.png|300px]]


==Properties== <!--T:5-->
==Properties== <!--T:5-->


=== Data === <!--T:16-->
=== Data === <!--T:32-->

<!--T:16-->
* {{PropertyData|Text}}: Text to be displayed.
* {{PropertyData|Source View}}: Source View for the balloon.
* {{PropertyData|Origin X}}: Balloon origin x-position relative to the View.
* {{PropertyData|Origin Y}}: Balloon origin y-position relative to the View.
* {{PropertyData|End Type}}: End symbol for the balloon line. Options: [[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, None.
* {{PropertyData|End Type Scale}}: Scale factor for the '''End Type'''.
* {{PropertyData|Bubble Shape}}: Shape of the balloon bubble. Options: [[Image:Circular.svg|20px]] Circular, None, [[Image:Triangle.svg|20px]] Triangle, [[Image:Inspection.svg|20px]] Inspection, [[Image:Hexagon.svg|20px]] Hexagon, [[Image:TechDraw_Square.svg|20px]] Square, [[Image:Rectangle.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:33-->

<!--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 Visible}}: Whether the balloon line is visible.
* {{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]].
See also: [https://freecad.github.io/SourceDoc/ Autogenerated API documentation] 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 104:
}}
}}
<translate>
<translate>


==Notes== <!--T:10-->

<!--T:20-->
*




<!--T:24-->
<!--T:24-->
{{Docnav
{{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}}
|[[TechDraw_LinkDimension|LinkDimension]]

|[[TechDraw_AxoLengthDimension|AxoLengthDimension]]
<!--T:21-->
|[[TechDraw_Workbench|TechDraw]]
{{TechDraw Tools navi}}
|IconL=TechDraw_LinkDimension.svg
|IconR=TechDraw_AxoLengthDimension.svg
|IconC=Workbench_TechDraw.svg
}}


<!--T:22-->
{{Userdocnavi}}
</translate>
</translate>
{{TechDraw Tools navi{{#translation:}}}}
{{clear}}
{{Userdocnavi{{#translation:}}}}

Latest revision as of 09:58, 27 July 2023

TechDraw Balloon

Menu location
TechDraw → Annotations → Insert Balloon Annotation
Workbenches
TechDraw
Default shortcut
None
Introduced in version
0.19
See also
TechDraw Annotation

Description

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

Usage

  1. Select one of the following:
  2. There are several ways to invoke the tool:
    • Press the Insert Balloon Annotation button.
    • Select the TechDraw → Annotations → Insert Balloon Annotation option from the menu.
  3. If a View or a region was selected:
    1. The cursor changes to a balloon icon.
    2. Click a point on the page for the origin of the Balloon.

To move the bubble of a Balloon, press and hold the left mouse button on its center and drag the mouse.

To change the properties of a Balloon double-click it on the page or in the Tree view. This will open the Balloon task panel.

Note: The position of a Balloon is relative to its Source View and uses the same scale factor.

Using separators

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

Properties

Data

  • DataText: Text to be displayed.
  • DataSource View: Source View for the balloon.
  • DataOrigin X: Balloon origin x-position relative to the View.
  • DataOrigin Y: Balloon origin y-position relative to the View.
  • DataEnd Type: End symbol for the balloon line. Options: Filled Arrow, Open Arrow, Tick, Dot, Open Circle, Fork, Filled Triangle, None.
  • DataEnd Type Scale: Scale factor for the End Type.
  • DataBubble Shape: Shape of the balloon bubble. Options: Circular, None, Triangle, Inspection, Hexagon, Square, 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 Visible: Whether the balloon line is visible.
  • ViewLine Width: Balloon line width

Scripting

See also: Autogenerated API documentation 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)