TechDraw Image: Difference between revisions

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

<!--T:16-->
<!--T:16-->
{{Docnav
{{Docnav
|[[TechDraw_Symbol|Insert SVG Symbol]]
|[[TechDraw_Symbol|Symbol]]
|[[TechDraw_ToggleFrame|Turn View Frames On/Off]]
|[[TechDraw_ToggleFrame|ToggleFrame]]
|[[TechDraw_Module|TechDraw]]
|[[TechDraw_Workbench|TechDraw]]
|IconL=TechDraw_Symbol.svg
|IconL=TechDraw_Symbol.svg
|IconR=TechDraw_ToggleFrame.svg
|IconR=TechDraw_ToggleFrame.svg
Line 14: Line 15:
{{GuiCommand
{{GuiCommand
|Name=TechDraw Image
|Name=TechDraw Image
|MenuLocation=TechDraw → Insert Bitmap Image
|MenuLocation=TechDraw → TechDraw Views → Insert Bitmap Image
|Workbenches=[[TechDraw Module|TechDraw]]
|Workbenches=[[TechDraw_Workbench|TechDraw]]
|SeeAlso=[[TechDraw_Symbol|Insert SVG Symbol]]
|SeeAlso=[[TechDraw_Symbol|TechDraw SVG Symbol]]
}}
}}


Line 22: Line 23:


<!--T:8-->
<!--T:8-->
The Image tool inserts a [[bitmap|bitmap]] image (PNG, TIFF, JPEG, etc.) from a file into the page as a view.
The '''TechDraw Image''' tool inserts a [[Bitmap|bitmap]] image (PNG, TIFF, JPEG, etc.) from a file into the page as a view.


</translate>
</translate>
Line 33: Line 34:


<!--T:10-->
<!--T:10-->
# If there are multiple drawing pages in the document: optionally activate the desired page by selecting it in the [[Tree_view|Tree view]].
# Press the {{Button|[[Image:TechDraw_Image.svg|16px]] [[TechDraw Image|Insert Bitmap Image]]}} button
# There are several ways to invoke the tool:
# A file dialog will open. Select a location and file name.
#* Press the {{Button|[[Image:TechDraw_Image.svg|16px]] [[TechDraw_Image|Insert Bitmap Image]]}} button.
#* Select the {{MenuCommand|TechDraw → TechDraw Views → [[Image:TechDraw_Image.svg|16px]] Insert Bitmap Image}} option from the menu.
# If there are multiple drawing pages in the document and you have not yet activated a page, the {{MenuCommand|Page Chooser}} dialog box opens: {{Version|0.20}}
## Select the desired page.
## Press the {{Button|OK}} button.
# A file dialog opens.
# Select a location and file name.
# The image is inserted.
# Optionally change its {{PropertyData|Scale}} property to adjust its size.


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


<!--T:11-->
<!--T:18-->
See also [[TechDraw_View#Properties|TechDraw View]].
* Use the Scale property to adjust the size of the image.

* Use the Width and Height properties to clip the image.
=== Data === <!--T:19-->

<!--T:20-->
{{TitleProperty|Image}}

<!--T:21-->
* {{PropertyData|Image File|File}}: The file containing this bitmap.
* {{PropertyData|Image Included|FileIncluded}}: Embedded image file. System use only.
* {{PropertyData|Width|Float}}: The width of the cropped image in mm. Only used if {{PropertyView|Crop}} is {{TRUE}}.
* {{PropertyData|Height|Float}}: The height of the cropped image in mm. Idem.

=== View === <!--T:22-->

<!--T:23-->
{{TitleProperty|Image}}

<!--T:24-->
* {{PropertyView|Crop|Bool}}: Crop the image to {{PropertyData|Width}} x {{PropertyData|Height}}.


==Scripting== <!--T:6-->
==Scripting== <!--T:6-->


<!--T:12-->
<!--T:12-->
{{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:13-->
<!--T:13-->
Line 58: Line 86:
dvi.Width = 200
dvi.Width = 200
}}
}}

<translate>
<translate>


Line 64: Line 91:
<!--T:17-->
<!--T:17-->
{{Docnav
{{Docnav
|[[TechDraw_Symbol|Insert SVG Symbol]]
|[[TechDraw_Symbol|Symbol]]
|[[TechDraw_ToggleFrame|Turn View Frames On/Off]]
|[[TechDraw_ToggleFrame|ToggleFrame]]
|[[TechDraw_Module|TechDraw]]
|[[TechDraw_Workbench|TechDraw]]
|IconL=TechDraw_Symbol.svg
|IconL=TechDraw_Symbol.svg
|IconR=TechDraw_ToggleFrame.svg
|IconR=TechDraw_ToggleFrame.svg

Latest revision as of 08:57, 26 July 2023

TechDraw Image

Menu location
TechDraw → TechDraw Views → Insert Bitmap Image
Workbenches
TechDraw
Default shortcut
None
Introduced in version
-
See also
TechDraw SVG Symbol

Description

The TechDraw Image tool inserts a bitmap image (PNG, TIFF, JPEG, etc.) from a file into the page as a view.

Image inserted in the drawing page

Usage

  1. If there are multiple drawing pages in the document: optionally activate the desired page by selecting it in the Tree view.
  2. There are several ways to invoke the tool:
    • Press the Insert Bitmap Image button.
    • Select the TechDraw → TechDraw Views → Insert Bitmap Image option from the menu.
  3. If there are multiple drawing pages in the document and you have not yet activated a page, the Page Chooser dialog box opens: introduced in version 0.20
    1. Select the desired page.
    2. Press the OK button.
  4. A file dialog opens.
  5. Select a location and file name.
  6. The image is inserted.
  7. Optionally change its DataScale property to adjust its size.

Properties

See also TechDraw View.

Data

Image

  • DataImage File (File): The file containing this bitmap.
  • DataImage Included (FileIncluded): Embedded image file. System use only.
  • DataWidth (Float): The width of the cropped image in mm. Only used if ViewCrop is true.
  • DataHeight (Float): The height of the cropped image in mm. Idem.

View

Image

  • ViewCrop (Bool): Crop the image to DataWidth x DataHeight.

Scripting

See also: Autogenerated API documentation and FreeCAD Scripting Basics.

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

dvi = FreeCAD.ActiveDocument.addObject('TechDraw::DrawViewImage','TestImage')
rc = page.addView(dvi)
dvi.ImageFile = "pathToMy/imageFile.png"
dvi.Height = 200
dvi.Width  = 200