Plot Workbench: Difference between revisions

Revision as of 17:45, 30 December 2020

Other languages:

The Plot Workbench is unmaintained since v0.17. As of v0.19 it is now designated an external workbench, so it is no longer included in the base system. If you have experience with the topic and are interested in maintaining it, please see the project's repository.

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 and macros for examples.

Tutorial

Plot

Tools: Save, Axes, Series, Grid, Legend, Labels, Positions

User documentation

Getting started
Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate

Help: Tutorials, Video tutorials
Workbenches: Std Base, Arch, Assembly, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Start, Surface, TechDraw, Test Framework, Web

Addons: Addon Manager, External workbenches, Scripting and macros

Hubs: User hub, Power users hub, Developer hub

@@ 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:16-->
-===Tools===
+{{VeryImportantMessage|The Plot Workbench is unmaintained since v0.17. As of v0.19 it is now designated an [[external_workbenches|external workbench]], so it is no longer included in the base system. If you have experience with the topic and are interested in maintaining it, please see the [https://github.com/FreeCAD/freecad.plot/issues/9 project's repository].}}
+<!--T:13-->
-These are tools availables.
+[[Image:Workbench_Plot.svg|thumb|128px|Plot workbench icon]]
+== Introduction == <!--T:8-->
-* [[Image:Plot_Save.png]] [[Plot_Save|Save plot]]: Saves the plot in several formats. You can select the output size and resolution too.
+</translate>
-* [[Image:Plot_Axes.png]] [[Plot_Axes|Axes]]: Add, remove or edit plot axes.
+{{TOCright}}
-* [[Image:Plot_Series.png]] [[Plot_Series|Series]]: Edit series title and styling.
+<translate>
-* [[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:1-->
-===Scripting===
+The [[Image:Workbench_Plot.svg|24px]] [[Plot Workbench|Plot Workbench]] allows the user to edit and save output plots created from other workbenches and tools.
+<!--T:9-->
-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.
+With the Plot workbench you can edit the working area, the axes, labels, titles, line styles, and other elements of plots.
+<!--T:10-->
-{{languages | {{es|Plot Module/es}} {{it|Plot Module/it}}}}
+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.svg|32px]] [[Plot_Save|Save plot]]: Saves the plot in several formats. You can select the output size and resolution too.
+* [[Image:Plot_Axes.svg|32px]] [[Plot_Axes|Axes]]: Add, remove or edit plot axes.
+* [[Image:Plot_Series.svg|32px]] [[Plot_Series|Series]]: Edit series title and styling.
+* [[Image:Plot_Grid.svg|32px]] [[Plot_Grid|Grid]]: Show/hide grid.
+* [[Image:Plot_Legend.svg|32px]] [[Plot_Legend|Legend]]: Show/hide legend.
+* [[Image:Plot_Labels.svg|32px]] [[Plot_Labels|Labels]]: Edit labels.
+* [[Image:Plot_Positions.svg|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_and_macros|Scripting and macros]] for examples.
+==Tutorial== <!--T:5-->
+* [[Plot Basic tutorial]]
+* [[Plot MultiAxes tutorial]]
+</translate>
+{{Plot Tools navi{{#translation:}}}}
+{{Userdocnavi{{#translation:}}}}
+[[Category:External Workbenches{{#translation:}}]]
+[[Category:Addons{{#translation:}}]]