TechDraw DetailView: Difference between revisions

From FreeCAD Documentation
No edit summary
No edit summary
 
(39 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>

<!--T:19-->
<!--T:19-->
{{Docnav
{{Docnav
|[[TechDraw_ComplexSection|ComplexSection]]
|[[TechDraw_SectionView|Section View]]
|[[TechDraw_DraftView|Draft View]]
|[[TechDraw_DraftView|DraftView]]
|[[TechDraw_Module|TechDraw]]
|[[TechDraw_Workbench|TechDraw]]
|IconL=TechDraw_SectionView.svg
|IconL=TechDraw_ComplexSection.svg
|IconR=TechDraw DraftView.svg
|IconR=TechDraw DraftView.svg
|IconC=Workbench_TechDraw.svg
|IconC=Workbench_TechDraw.svg
Line 14: Line 15:
{{GuiCommand
{{GuiCommand
|Name=TechDraw DetailView
|Name=TechDraw DetailView
|MenuLocation=TechDraw → Insert Detail View
|MenuLocation=TechDraw → TechDraw Views → Insert Detail View
|Workbenches=[[TechDraw_Module|TechDraw]]
|Workbenches=[[TechDraw_Workbench|TechDraw]]
|SeeAlso=[[TechDraw_View|TechDraw Insert View]], [[TechDraw_ProjectionGroup|TechDraw Insert Projection Group]]
|SeeAlso=[[TechDraw_View|TechDraw View]], [[TechDraw_ProjectionGroup|TechDraw ProjectionGroup]]
}}
}}


Line 22: Line 23:


<!--T:10-->
<!--T:10-->
The Detail tool creates a view of small area of an existing view.
The '''TechDraw DetailView''' tool creates a view of a small area of an existing view.


</translate>
</translate>
Line 28: Line 29:
<translate>
<translate>
<!--T:11-->
<!--T:11-->
{{Caption|Detail view with circular viewbox of an existing view}}
{{Caption|Detail view with a circular outline}}


==Usage== <!--T:3-->
==Usage== <!--T:3-->


<!--T:12-->
<!--T:12-->
* Select a view in the page or tree.
# Select a base view for the detail view.
# There are several ways to invoke the tool:
* Press the {{Button|[[Image:TechDraw_DetailView.svg|16px]] [[TechDraw_DetailView|Insert Detail View]]}} button to create the detail view.
#* Press the {{Button|[[Image:TechDraw_DetailView.svg|16px]] [[TechDraw_DetailView|Insert Detail View]]}} button.
* In the appearing task dialog you can define the radius of the view box, the scale and the view position. For the latter you can do this
#* Select the {{MenuCommand|TechDraw → TechDraw Views → [[Image:TechDraw_DetailView.svg|16px]] Insert Detail View}} option from the menu.
** either by changing the coordinates
# A highlight outline is added to the base view, a detail view is added to the page, and a task panel opens.
** or by pressing the button {{Button|Drag Highlight}}. In this case the detail origin border is highlighted bold and with the label ''drag''. Click on the border or the label, keep the mouse button pressed and drag it to the position you like. Finally release the mouse to accept the change.
# For clarity it is best to move the detail view so that it no longer overlaps the base view: hold down the left mouse button on its frame or label and drag it to a new position.
# To change the position of the highlight outline do one of the following:
#* Move the outline by dragging:
#*# Press the {{Button|Drag Highlight}} button.
#*# The outline is marked on the page and a temporary ''drag'' label is added.
#*# Hold down the left mouse button on the outline itself, or on that label, and drag the outline to a new position.
#* Move the outline by coordinate input:
#*# Change the X and Y coordinates in the task panel. The coordinates are relative to the center of the base view.
# Optionally change the '''Radius''' of the detail view.
# Optionally change the '''Scale Type''' and '''Scale Factor''' of the detail view. See [[TechDraw_View#Properties|TechDraw View]] for more information.
# Specify a '''Reference''' label. This label will be displayed near the highlight outline.
# Press the {{Button|OK}} button.


<!--T:13-->
==Notes== <!--T:30-->
The Detail view can be displayed within a round or square view box. This is controlled by the [[TechDraw_Preferences#Annotation|preferences]] setting '''Detail View Outline Shape'''.


==Properties== <!--T:5-->
<!--T:37-->
* To edit a detail view double-click it in the [[Tree_view|Tree view]].
* The outlines of detail views can be round or square. This is controlled by the '''Detail View Outline Shape''' [[TechDraw_Preferences#Annotation|preference]].
* [https://www.forum.freecadweb.org/viewtopic.php?f=35&t=34055#p285281 Forum topic with a good discussion about setting the anchor.]


===Detail View=== <!--T:25-->
== Properties Detail View == <!--T:31-->


<!--T:14-->
<!--T:32-->
See also [[TechDraw_View#Properties|TechDraw View]].
* {{PropertyData|BaseView}}: The view on which this Detail view is based.
* {{PropertyData|Anchor Point}}: The center of the Detail view within the {{PropertyData|BaseView}}.
* {{PropertyData|Radius}}: The size of the area in the {{PropertyData|BaseView}} that is displayed in the Detail view.
* {{PropertyData|Scale Type}}: Type of the scale. The choices are:
** ''Page'': The scale factor of the drawing [[TechDraw_PageDefault|Page]] is used
** ''Automatic'': In case the detail view would be larger than the page, it will be scaled down to fit into the page
** ''Custom'': A custom scale factor set by {{PropertyData|Scale}}
* {{PropertyData|Scale}}: Magnification level.
* {{PropertyData|Reference}}: An identifier to indicate the area of the {{PropertyData|BaseView}} that is displayed.


===Base View=== <!--T:9-->
=== Data === <!--T:33-->
A Detail view inherits all applicable properties of the view specified as {{PropertyData|BaseView}}. In the properties of this view you can change the appearance of the detail outline:


<!--T:26-->
<!--T:34-->
{{TitleProperty|Detail}}
* {{PropertyView|Highlight Adjust}}: Clockwise rotation angle of the Detail view.
* {{PropertyView|Highlight Line Color}}: Line color for the outline shape. Default setting for this is the setting '''Detail Highlight''' in the [[TechDraw_Preferences|TechDraw preferences]].
* {{PropertyView|Highlight Line Style}}: Line style for the outline shape. Default setting for this is the setting '''Detail Highlight Style''' in the [[TechDraw_Preferences|TechDraw preferences]].


==Scripting== <!--T:6-->
<!--T:35-->
* {{PropertyData|Base View|Link}}: The view on which the detail view is based.
* {{PropertyData|Anchor Point|Vector}}: The center of the detail view within the {{PropertyData|Base View}}.
* {{PropertyData|Radius|Float}}: The size of the area in the {{PropertyData|Base View}} that is displayed in the detail view.
* {{PropertyData|Reference|String}}: An identifier for the detail view in the {{PropertyData|Base View}}.


<!--T:15-->
== Properties Base View == <!--T:36-->
{{Emphasis|See also:}} [[TechDraw_API|TechDraw API]] and [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].


<!--T:16-->
<!--T:9-->
A detail view inherits all applicable properties of its {{PropertyData|Base View}}. In the properties of that view you can change the appearance of the detail outline:
The Detail tool can be used in [[Macros|macros]] and from the [[Python|Python]] console by using the following functions:


=== View === <!--T:38-->
</translate>
{{Code|code=
Detail = FreeCAD.ActiveDocument.addObject('TechDraw::DrawViewDetail','Detail')
...TBA
}}
<translate>


==Tricks== <!--T:22-->
<!--T:39-->
{{TitleProperty|Hightlight}}


<!--T:23-->
<!--T:26-->
* {{PropertyView|Highlight Adjust|Float}}: See [[TechDraw_View#View|TechDraw View]]
* The space around the view outline and the view object border is by default a white area. This means it covers everything behind it. Sometimes there is not enough space on the page and you can save space by reducing this unnecessary white area.
* {{PropertyView|Highlight Line Color|Color}}: Idem.

* {{PropertyView|Highlight Line Style|Enumeration}}: Idem.
<!--T:29-->
This is done by putting the Detail view into a [[TechDraw_ClipGroup|clip group]]:

</translate>
[[Image:TechDraw_DetailClipped.png]]
<translate>
<!--T:24-->
{{Caption|Detail view in a clip group}}

<!--T:28-->
* For detail views with a round outline, the position of the reference label in the base view can be changed via the base view property {{PropertyView|Highlight Adjust}}.


==Notes== <!--T:20-->
* [https://www.forum.freecadweb.org/viewtopic.php?f=35&t=34055#p285281 A good discussion about setting the Anchor]


<!--T:21-->
<!--T:21-->
{{Docnav
{{Docnav
|[[TechDraw_ComplexSection|ComplexSection]]
|[[TechDraw_SectionView|Section View]]
|[[TechDraw_DraftView|Draft View]]
|[[TechDraw_DraftView|DraftView]]
|[[TechDraw_Module|TechDraw]]
|[[TechDraw_Workbench|TechDraw]]
|IconL=TechDraw_SectionView.svg
|IconL=TechDraw_ComplexSection.svg
|IconR=TechDraw DraftView.svg
|IconR=TechDraw DraftView.svg
|IconC=Workbench_TechDraw.svg
|IconC=Workbench_TechDraw.svg
Line 113: Line 104:
{{TechDraw Tools navi{{#translation:}}}}
{{TechDraw Tools navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}

Latest revision as of 14:57, 27 July 2023

TechDraw DetailView

Menu location
TechDraw → TechDraw Views → Insert Detail View
Workbenches
TechDraw
Default shortcut
None
Introduced in version
-
See also
TechDraw View, TechDraw ProjectionGroup

Description

The TechDraw DetailView tool creates a view of a small area of an existing view.

Detail view with a circular outline

Usage

  1. Select a base view for the detail view.
  2. There are several ways to invoke the tool:
    • Press the Insert Detail View button.
    • Select the TechDraw → TechDraw Views → Insert Detail View option from the menu.
  3. A highlight outline is added to the base view, a detail view is added to the page, and a task panel opens.
  4. For clarity it is best to move the detail view so that it no longer overlaps the base view: hold down the left mouse button on its frame or label and drag it to a new position.
  5. To change the position of the highlight outline do one of the following:
    • Move the outline by dragging:
      1. Press the Drag Highlight button.
      2. The outline is marked on the page and a temporary drag label is added.
      3. Hold down the left mouse button on the outline itself, or on that label, and drag the outline to a new position.
    • Move the outline by coordinate input:
      1. Change the X and Y coordinates in the task panel. The coordinates are relative to the center of the base view.
  6. Optionally change the Radius of the detail view.
  7. Optionally change the Scale Type and Scale Factor of the detail view. See TechDraw View for more information.
  8. Specify a Reference label. This label will be displayed near the highlight outline.
  9. Press the OK button.

Notes

Properties Detail View

See also TechDraw View.

Data

Detail

  • DataBase View (Link): The view on which the detail view is based.
  • DataAnchor Point (Vector): The center of the detail view within the DataBase View.
  • DataRadius (Float): The size of the area in the DataBase View that is displayed in the detail view.
  • DataReference (String): An identifier for the detail view in the DataBase View.

Properties Base View

A detail view inherits all applicable properties of its DataBase View. In the properties of that view you can change the appearance of the detail outline:

View

Hightlight

  • ViewHighlight Adjust (Float): See TechDraw View
  • ViewHighlight Line Color (Color): Idem.
  • ViewHighlight Line Style (Enumeration): Idem.