Plot Namespace Reference

Classes
class	Line
class	Plot

Functions
def	addNavigationToolbar ()
def	addNewAxes (rect=None, frameon=True, patchcolor='none')
def	axes ()
def	axesList ()
def	closePlot ()
def	delNavigationToolbar ()
def	figure (winTitle="plot")
def	getMainWindow ()
def	getMdiArea ()
def	getPlot ()
def	grid (status=True)
def	legend (status=True, pos=None, fontsize=None)
def	plot (x, y, name=None)
def	removeSerie (index)
def	save (path, figsize=None, dpi=None)
def	series ()
def	title (string)
def	xlabel (string)
def	ylabel (string)

Function Documentation

addNavigationToolbar()

def Plot.addNavigationToolbar

(

)

Add the matplotlib QT navigation toolbar to the plot.

References getPlot().

addNewAxes()

def Plot.addNewAxes	(		rect = None,
			frameon = True,
			patchcolor = 'none'
	)

Add new axes to plot, setting it as the active one.

Keyword arguments:
rect -- Axes area, None to copy from the last axes data.
frameon -- True to show frame, False otherwise.
patchcolor -- Patch color, 'none' for transparent plot.

References getPlot().

axes()

def Plot.axes

(

)

Return the active plot axes.

References getPlot().

axesList()

def Plot.axesList

(

)

Return the plot axes sets list. 

References getPlot().

closePlot()

def Plot.closePlot

(

)

 closePlot(): Close the active plot window. 

References getMdiArea().

delNavigationToolbar()

def Plot.delNavigationToolbar

(

)

Remove the matplotlib QT navigation toolbar from the plot.

References getPlot().

figure()

def Plot.figure

(

winTitle = "plot"

)

Create a new plot subwindow/tab.

Keyword arguments:
winTitle -- Plot tab title.

References getMdiArea().

Referenced by plot().

getMainWindow()

def Plot.getMainWindow

(

)

 Return the FreeCAD main window. 

Referenced by getMdiArea().

getMdiArea()

def Plot.getMdiArea

(

)

 Return FreeCAD MdiArea. 

References getMainWindow().

Referenced by closePlot(), figure(), and getPlot().

getPlot()

def Plot.getPlot

(

)

 Return the selected Plot document if exist. 

References getMdiArea().

Referenced by addNavigationToolbar(), addNewAxes(), axes(), axesList(), delNavigationToolbar(), grid(), legend(), plot(), removeSerie(), save(), series(), title(), xlabel(), and ylabel().

grid()

def Plot.grid

(

status = True

)

Show/Hide the grid from the active plot.

Keyword arguments:
status -- True if grid must be shown, False otherwise.

References getPlot().

legend()

def Plot.legend	(		status = True,
			pos = None,
			fontsize = None
	)

Show/Hide the legend from the active plot.

Keyword arguments:
status -- True if legend must be shown, False otherwise.
pos -- Legend position.
fontsize -- Font size

References getPlot(), and series().

plot()

def Plot.plot	(		x,
			y,
			name = None
	)

Plots a new serie (as line plot)

Keyword arguments:
x -- X values
y -- Y values
name -- Data serie name (for legend).

References figure(), and getPlot().

removeSerie()

def Plot.removeSerie

(

index

)

Remove a data serie from the active plot.

Keyword arguments:
index -- Index of the serie to remove.

References getPlot().

save()

def Plot.save	(		path,
			figsize = None,
			dpi = None
	)

Save plot.

Keyword arguments:
path -- Destination file path.
figsize -- w,h figure size tuple in inches.
dpi -- Dots per inch.

References getPlot().

series()

def Plot.series

(

)

Return all the lines from a selected plot.

References getPlot().

Referenced by legend().

title()

def Plot.title

(

string

)

Setup the plot title.

Keyword arguments:
string -- Plot title.

References getPlot().

xlabel()

def Plot.xlabel

(

string

)

Setup the x label.

Keyword arguments:
string -- Title to set.

References getPlot().

ylabel()

def Plot.ylabel

(

string

)

Setup the y label.

Keyword arguments:
string -- Title to set.

References getPlot().