Plot Save: Difference between revisions

From FreeCAD Documentation
No edit summary
(Module to Workbench renaming.)
 
(16 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>

<!--T:11-->
<!--T:11-->
{{Docnav
{{Docnav||[[Plot_Axes|Axes]]|[[Plot_Module|Plot]]|IconL=|IconC=Workbench_Plot.svg|IconR=Plot_Axes.svg}}
|
|[[Plot_Axes|Axes]]
|[[Plot_Workbench|Plot]]
|IconL=
|IconR=Plot_Axes.svg
|IconC=Workbench_Plot.svg
}}


<!--T:1-->
<!--T:1-->
{{GuiCommand
{{GuiCommand|Name=Plot Save|Workbenches=[[Plot Module|Plot]]|MenuLocation=Plot → Save plot}}
|Name=Plot Save
|MenuLocation=Plot → Save plot
|Workbenches=[[Plot_Workbench|Plot]]
}}


==Description== <!--T:2-->
==Description== <!--T:15-->
Plot save tool saves the active plot at desired location. With this tool you can also select the size and resolution of output image.


<!--T:3-->
<!--T:2-->
The standard plot module already provides a minimum tool to save plots [[File:Matplotlib_save_button.png|24px]]. If you install the [[Image:Workbench_Plot.svg|24px]] [[Plot_Workbench|Plot Workbench]] using the [[Std_AddonMgr|Add-on manager]], a more complete tool to save the active plot will be available. With this tool you can also select the size and resolution of the output image.

</translate>
[[Image:Plot_Trigonometric_Example.png|600px]]
[[Image:Plot_Trigonometric_Example.png|600px]]
<translate>


==How to use== <!--T:4-->
==Usage== <!--T:16-->
Select the plot tab that you want to save, and run this tool. Use path selector button in order to show a file dialog where you can choose the output image place and format.


<!--T:5-->
<!--T:4-->
Select the plot tab that you want to save, and run this tool. Use the path selector button to show a file dialog where you can choose the file location and format.

</translate>
[[Image:Plot_Save_Path.png‎|Path selection button]]
[[Image:Plot_Save_Path.png‎|Path selection button]]
<translate>
<span style="font-variant:small-caps">Path selection button</span>
<!--T:17-->
{{Caption|Path selection button}}

==Options== <!--T:18-->


==Options== <!--T:6-->
<!--T:6-->
* '''File path''': You can set the output image path (including format extension) inserting it at text line too.
* '''File path''': You can set the output image path (including format extension) inserting it at text line too.
* '''Size''': You can specify output image width and height (inches).
* '''Size''': You can specify output image width and height (inches).
* '''dpi''': You can set the image resolution (Dots Per Inch). Final resolution (in pixels) will be the multiplication of width and height by dpi.
* '''dpi''': You can set the image resolution (Dots Per Inch). Final resolution (in pixels) will be the multiplication of width and height by dpi.


==Scripting== <!--T:7-->
Plot save tool can be used in [[macros]] and from Python console by using the following function:

<!--T:8-->
'''save(str, (float, float), float)''' : Saves the plot at path, width the size specified in inches, and the resolution specified in Dots Per Inch.

<!--T:9-->
Example:
</translate>
{{Code|code=
import Plot
Plot.save("~/example.pdf", (12.8, 9.6), 50)
}}
<translate>
<!--T:10-->
That will save a pdf image of 12.8x9.6 inches, with 640x480 pixels.


<!--T:12-->
<!--T:12-->
{{Docnav
{{Docnav||[[Plot_Axes|Axes]]|[[Plot_Module|Plot]]|IconL=|IconC=Workbench_Plot.svg|IconR=Plot_Axes.svg}}
|
|[[Plot_Axes|Axes]]
|[[Plot_Workbench|Plot]]
|IconL=
|IconR=Plot_Axes.svg
|IconC=Workbench_Plot.svg
}}


</translate>
</translate>
{{Plot_Tools_navi{{#translation:}}}}
{{Plot_Tools_navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
[[Category:External_Workbenches{{#translation:}}]]
{{clear}}
[[Category:Addons{{#translation:}}]]

Latest revision as of 18:56, 2 October 2021

Plot Save

Menu location
Plot → Save plot
Workbenches
Plot
Default shortcut
None
Introduced in version
-
See also
None

Description

The standard plot module already provides a minimum tool to save plots . If you install the Plot Workbench using the Add-on manager, a more complete tool to save the active plot will be available. With this tool you can also select the size and resolution of the output image.

Usage

Select the plot tab that you want to save, and run this tool. Use the path selector button to show a file dialog where you can choose the file location and format.

Path selection button

Path selection button

Options

  • File path: You can set the output image path (including format extension) inserting it at text line too.
  • Size: You can specify output image width and height (inches).
  • dpi: You can set the image resolution (Dots Per Inch). Final resolution (in pixels) will be the multiplication of width and height by dpi.