Plot Workbench/pt: Difference between revisions

Revision as of 20:49, 6 September 2021

Other languages:

Introduction

FreeCAD is able to perform plots using the matplotlib Python library. A module is provided to this end, as an external add-on in version 0.19 and as a core component from version 0.20 on. Older versions of FreeCAD are not covered in this documentation.

The produced plots offer the standard matplotlib tools to edit and save. On top of that, a Plot Workbench is provided as an external add-on offering more complete tools to edit the plot and save it. The add-on can be installed with the Add-on manager.

Module

The module can be invoked in a Python console or in a macro. The first thing you must do is importing the module. In FreeCAD 0.19 you must first install the Plot Workbench using the Add-on manager, and then you can import Plot by typing:

from freecad.plot import Plot

From FreeCAD 0.20 on plot module is already packaged within the program, so you don't need to install any add-on, but just type

from FreeCAD.Plot import Plot

After that, you can plot a straight line from (0,0) to (1,2) just simply typing

Plot.plot([0, 1], [0, 2])

You can find more complex examples in the Plot Basic tutorial and the Plot MultiAxes tutorial.

Workbench Tools

If you decide to install the Plot Workbench using the Add-on manager, you will have the following tools available to manage the plots created with the module:

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 3: / Line 3: @@
 [[Image:Workbench_Plot.svg|thumb|128px|Plot workbench icon]]
-== Introduction ==
 {{TOCright}}
+== Introduction ==
 FreeCAD is able to perform plots using the [https://matplotlib.org/ matplotlib] [[Python|Python]] library. A module is provided to this end, as an external add-on in version 0.19 and as a core component from version 0.20 on. Older versions of FreeCAD are not covered in this documentation.
-The produced plots offer the standard [https://matplotlib.org/ matplotlib] tools to edit and save. On top of that, a [[Image:Workbench_Plot.svg|24px]] [[Plot Workbench|Plot Workbench]] is provided as an external add-on offering more complete tools to edit the plot and save it. The add-on can be installed with the [[Std_AddonMgr|Add-on manager]].
+The produced plots offer the standard [https://matplotlib.org/ matplotlib] tools to edit and save. On top of that, a [[Image:Workbench_Plot.svg|24px]] [[Plot_Workbench|Plot Workbench]] is provided as an external add-on offering more complete tools to edit the plot and save it. The add-on can be installed with the [[Std_AddonMgr|Add-on manager]].
 ==Module==
-The module can be invoked in a Python console or in a [[Macro|macro]]. The first thing you must do is importing the module.
+The module can be invoked in a Python console or in a [[Macros|macro]]. The first thing you must do is importing the module. In FreeCAD 0.19 you must first install the [[Image:Workbench_Plot.svg|24px]] [[Plot_Workbench|Plot Workbench]] using the [[Std_AddonMgr|Add-on manager]], and then you can import Plot by typing:
-In FreeCAD 0.19 you must first install the [[Image:Workbench_Plot.svg|24px]] [[Plot Workbench|Plot Workbench]] using the [[Std_AddonMgr|Add-on manager]], and then you can import Plot typing
 {{Code|code=
@@ Line 31: / Line 31: @@
 }}
-You can find more complex examples in the [[Plot Basic tutorial]] and the [[Plot MultiAxes tutorial]].
+You can find more complex examples in the [[Plot_Basic_tutorial|Plot Basic tutorial]] and the [[Plot_MultiAxes_tutorial|Plot MultiAxes tutorial]].
 ==Workbench Tools==
-If you decide to install the [[Image:Workbench_Plot.svg|24px]] [[Plot Workbench|Plot Workbench]] using the [[Std_AddonMgr|Add-on manager]], you will have the following tools available to manage the plots created with the module:
+If you decide to install the [[Image:Workbench_Plot.svg|24px]] [[Plot_Workbench|Plot Workbench]] using the [[Std_AddonMgr|Add-on manager]], you will have the following tools available to manage the plots created with the module:
 * [[Image:Plot_Save.svg|32px]] [[Plot_Save|Save plot]]: Saves the plot in several formats. You can select the output size and resolution too.
@@ Line 46: / Line 46: @@
 ==Scripting==
 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==
-* [[Plot Basic tutorial]]
-* [[Plot MultiAxes tutorial]]
+* [[Plot_Basic_tutorial|Plot Basic tutorial]]
+* [[Plot_MultiAxes_tutorial|Plot MultiAxes tutorial]]