Plot Workbench: Difference between revisions

From FreeCAD Documentation
(Started Plot module documentation)
 
(If FreeCAD uses Python 2.7, you should have matplotlib for the same version)
(15 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<languages/>
The Plot module allows to edit and save output plots created from other modules and tools. With plot module you can edit easily the working area, the axes, labels, titles, styles, etc. Plot module is an abstraction of matplotlib conveniently addapted to FreeCAD.
<translate>
<!--T:11-->
{{Docnav|[[Path Workbench|Path Workbench]]|[[Points Workbench|Points Workbench]]|IconL=Path-Workbench.svg|IconR=PointsWorkbench.svg}}


</translate>
===Tools===
[[Image:Workbench_Plot.svg|64px]]
<translate>


== Introduction == <!--T:8-->
These are tools availables.


<!--T:1-->
* [[Image:Plot_Save.png]] [[Plot_Save|Save plot]]: Saves the plot in several formats. You can select the output size and resolution too.
{{TOCright}}
* [[Image:Plot_Axes.png]] [[Plot_Axes|Axes]]: Add, remove or edit plot axes.
The [[Plot Workbench|Plot Workbench]] allows the user to edit and save output plots created from other workbenches and tools.
* [[Image:Plot_Series.png]] [[Plot_Series|Series]]: Edit series title and styling.
* [[Image:Plot_Grid.png]] [[Plot_Grid|Grid]]: Show/hide grid.
* [[Image:Plot_Legend.png]] [[Plot_Legend|Legend]]: Show/hide legend.
* [[Image:Plot_Labels.png]] [[Plot_Labels|Labels]]: Edit labels.
* [[Image:Plot_Positions.png]] [[Plot_Positions|Positions]]: Set elements positions.


<!--T:9-->
===Scripting===
With the Plot workbench you can edit the working area, the axes, labels, titles, line styles, and other elements of plots.


<!--T:10-->
Since Plot module is a layer over matplotlib, you are free to use all matplotlib commands over plot instances. See [[Scripting_examples|scripting examples]] section to see examples.
The Plot workbench is an abstraction of the [https://matplotlib.org/ matplotlib] [[Python|Python]] library conveniently adapted for FreeCAD. To use the Plot functions, the version of {{incode|matplotlib}} installed in your system should match the Python version that FreeCAD uses, that is, if FreeCAD uses Python 2.7, you should have {{incode|matplotlib}} for the same version.


==Tools== <!--T:2-->
[[Category:User Documentation]]

<!--T:3-->
* [[Image:Plot_Save.png|32px]] [[Plot_Save|Save plot]]: Saves the plot in several formats. You can select the output size and resolution too.
* [[Image:Plot_Axes.png|32px]] [[Plot_Axes|Axes]]: Add, remove or edit plot axes.
* [[Image:Plot_Series.png|32px]] [[Plot_Series|Series]]: Edit series title and styling.
* [[Image:Plot_Grid.png|32px]] [[Plot_Grid|Grid]]: Show/hide grid.
* [[Image:Plot_Legend.png|32px]] [[Plot_Legend|Legend]]: Show/hide legend.
* [[Image:Plot_Labels.png|32px]] [[Plot_Labels|Labels]]: Edit labels.
* [[Image:Plot_Positions.png|32px]] [[Plot_Positions|Positions]]: Set elements positions.

==Scripting== <!--T:4-->
Since the Plot Workbench is a layer on top of {{incode|matplotlib}}, you are free to use any function from this library on plot instances. See [[Scripting_examples|scripting examples]] for examples.

==Tutorial== <!--T:5-->
* [[Plot Basic tutorial]]
* [[Plot MultiAxes tutorial]]

<!--T:6-->
{{Docnav|[[Path Workbench|Path Workbench]]|[[Points Workbench|Points Workbench]]|IconL=Path-Workbench.svg|IconR=PointsWorkbench.svg}}

<!--T:12-->
{{Plot Tools navi}}
{{Userdocnavi}}
[[Category:Workbenches]]


</translate>

Revision as of 06:43, 8 April 2019

Introduction

The Plot Workbench allows the user to edit and save output plots created from other workbenches and tools.

With the Plot workbench you can edit the working area, the axes, labels, titles, line styles, and other elements of plots.

The Plot workbench is an abstraction of the matplotlib Python library conveniently adapted for FreeCAD. To use the Plot functions, the version of matplotlib installed in your system should match the Python version that FreeCAD uses, that is, if FreeCAD uses Python 2.7, you should have matplotlib for the same version.

Tools

  • Save plot: Saves the plot in several formats. You can select the output size and resolution too.
  • Axes: Add, remove or edit plot axes.
  • Series: Edit series title and styling.
  • Grid: Show/hide grid.
  • Legend: Show/hide legend.
  • Labels: Edit labels.
  • Positions: Set elements positions.

Scripting

Since the Plot Workbench is a layer on top of matplotlib, you are free to use any function from this library on plot instances. See scripting examples for examples.

Tutorial