Difference between revisions of "Plot Workbench/pt"

From FreeCAD Documentation
Jump to navigation Jump to search
(Updating to match new version of source page)
m (FuzzyBot moved page Plot Module/pt to Plot Workbench/pt without leaving a redirect: Part of translatable page "Plot Module")
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
<languages/>
 
<languages/>
  
{{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].}}
+
[[Image:Workbench_Plot.svg|thumb|128px|Plot workbench icon]]
  
[[Image:Workbench_Plot.svg|thumb|128px|Plot workbench icon]]
+
{{TOCright}}
  
 
== Introduction ==
 
== Introduction ==
{{TOCright}}
 
  
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.
+
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]].
 +
 
 +
==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:
 +
 
 +
{{Code|code=
 +
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
 +
 
 +
{{Code|code=
 +
from FreeCAD.Plot import Plot
 +
}}
 +
 
 +
After that, you can plot a straight line from (0,0) to (1,2) just simply typing
 +
 
 +
{{Code|code=
 +
Plot.plot([0, 1], [0, 2])
 +
}}
  
With the Plot workbench you can edit the working area, the axes, labels, titles, line styles, and other elements of plots.
+
You can find more complex examples in the [[Plot_Basic_tutorial|Plot Basic tutorial]] and the [[Plot_MultiAxes_tutorial|Plot MultiAxes tutorial]].
  
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.
+
==Workbench Tools==
  
==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:
  
 
* [[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_Save.svg|32px]] [[Plot_Save|Save plot]]: Saves the plot in several formats. You can select the output size and resolution too.
Line 25: Line 46:
  
 
==Scripting==
 
==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_examples|scripting examples]] for examples.
+
 
 +
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==
 
==Tutorial==
* [[Plot Basic tutorial]]
+
 
* [[Plot MultiAxes tutorial]]
+
* [[Plot_Basic_tutorial|Plot Basic tutorial]]
 +
* [[Plot_MultiAxes_tutorial|Plot MultiAxes tutorial]]
  
  
{{Plot Tools navi{{#translation:}}}}
+
{{Plot_Tools_navi{{#translation:}}}}
 
{{Userdocnavi{{#translation:}}}}
 
{{Userdocnavi{{#translation:}}}}
[[Category:External Workbenches{{#translation:}}]]
+
[[Category:External_Workbenches{{#translation:}}]]
 
[[Category:Addons{{#translation:}}]]
 
[[Category:Addons{{#translation:}}]]

Latest revision as of 18:45, 2 October 2021

Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Türkçe • ‎español • ‎français • ‎hrvatski • ‎italiano • ‎magyar • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎svenska • ‎čeština • ‎български • ‎русский • ‎中文 • ‎中文(中国大陆)‎ • ‎中文(台灣)‎
Plot workbench icon

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 Workbench Plot.svg 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 Workbench Plot.svg 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 Workbench Plot.svg Plot Workbench using the Add-on manager, you will have the following tools available to manage the plots created with the module:

  • Plot Save.svg Save plot: Saves the plot in several formats. You can select the output size and resolution too.
  • Plot Axes.svg Axes: Add, remove or edit plot axes.
  • Plot Series.svg Series: Edit series title and styling.
  • Plot Grid.svg Grid: Show/hide grid.
  • Plot Legend.svg Legend: Show/hide legend.
  • Plot Labels.svg Labels: Edit labels.
  • Plot Positions.svg 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