autofig.figure.Figure.draw (function)
def draw(self, fig=None, i=None, calls=None, tight_layout=True, draw_sidebars=True, draw_title=True, subplot_grid=None, show=False, save=False, save_afig=False, in_animation=False)
Draw the contents of the autofig.figure.Figure to a matplotlib figure object.
See also:
- autofig.figure.Figure.animate
- autofig.draw
- autofig.axes.Axes.draw
- autofig.call.Plot.draw
- autofig.call.Mesh.draw
Arguments
fig
(matplotlib figure or None, optional, default=None): matplotlib figure instances to use during drawing.i
(float or None, optional, default=None): passed on to autofig.axes.Axes.draw for all autofig.axes.Axes in autofig.figure.Figure.axes.calls
(list of autofig.call.Call objects or None, optional, default=None): passed on to autofig.axes.Axes.draw for all autofig.axes.Axes in autofig.figure.Figure.axes.tight_layout
(bool, optional, default=True): whether to callfig.tight_layout
after positioning all subplots, but before drawing any applicable sidebars.draw_sidebars
(bool, optional, default=True): whether to draw any applicable sidebars.draw_title
(bool, optional, default=True): passed on to autofig.axes.Axes.draw for all autofig.axes.Axes in autofig.figure.Figure.axes. Whether to draw the title on the matplotlib axes.subplot_grid
(None or tuple, optional, default=None): Override the subplot locations. Passed on to autofig.axes.Axes.append_subplot for each autofig.axes.Axes in autofig.figure.Figure.axes.show
(bool, optional, default=False): whether to immediately draw and show the resulting matplotlib figure.save
(False or string, optional, default=False): the filename to save the resulting matplotlib figure, or False to not save.save_afig
(False or string, optional, default=False): the filename to save the autofig object, along with the options for this draw call. See also autofig.figure.Figure.save.in_animation
(bool, optional, default=False): whether the current call todraw
is a single frame in an animation. Usually this should not be changed by the user. See autofig.figure.Figure.animate for creating animations.
Returns
- (matplotlib Figure): the matplotlib figure object.