TechDraw Balloon: Difference between revisions

From FreeCAD Documentation
m (correct wording)
m (typo fixed)
(5 intermediate revisions by 3 users not shown)
Line 5: Line 5:
{{Docnav
{{Docnav
|[[TechDraw_Dimension_Link|Dimension Link ]]
|[[TechDraw_Dimension_Link|Dimension Link ]]
|[[TechDraw_Dimension_Horizontal_Extent|New Horizontal Extent]]
|[[TechDraw_Dimension_Horizontal_Extent|Dimension Horizontal Extent]]
|[[TechDraw_Module|TechDraw]]
|[[TechDraw_Module|TechDraw]]
|IconL=TechDraw_Dimension_Link.svg
|IconL=TechDraw_Dimension_Link.svg
Line 36: Line 36:
# 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 {{KEY|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.
# To change the balloon properties either double-clicking onto it in the drawing or double-click on the balloon object in the model tree. This will open the balloon dialog.


<!--T:29-->
'''Note:''' The position of the balloon is relative to the View and uses the same scale factor than the View.
'''Note:''' The position of the balloon is relative to the View and uses the same scale factor than the View.


Line 59: Line 60:
* {{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|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|End Type Scale}}: Scale factor for the '''End Type'''.
* {{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: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|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|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|Text Wrap}}: Text wrap length; -1 means the text will never be wrapped and the result is in every case a single line.
Line 91: Line 92:
{{Docnav
{{Docnav
|[[TechDraw_Dimension_Link|Dimension Link ]]
|[[TechDraw_Dimension_Link|Dimension Link ]]
|[[TechDraw_Dimension_Horizontal_Extent|New Horizontal Extent]]
|[[TechDraw_Dimension_Horizontal_Extent|Dimension Horizontal Extent]]
|[[TechDraw_Module|TechDraw]]
|[[TechDraw_Module|TechDraw]]
|IconL=TechDraw_Dimension_Link.svg
|IconL=TechDraw_Dimension_Link.svg

Revision as of 02:08, 20 January 2021

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.

Usage

  1. Select the View to which the Balloon will be attached.
  2. Press the 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. To change the balloon properties either double-clicking onto it in the drawing or double-click on the balloon object in the model tree. This will open the balloon dialog.

Note: The position of the balloon is relative to the View and uses the same scale factor than the View.

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: None, Filled Arrow, Open Arrow, Tick, Dot, Open Circle, Fork, Filled Triangle
  • 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: 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)