gopen#
- cfplot.gopen(rows: int = 1, columns: int = 1, file: str = 'cfplot.png', orientation: str = 'landscape', figsize: list[float] | tuple[float, float] = (11.7, 8.3), dpi: float | None = None, user_position: bool = False, left: float | None = None, right: float | None = None, top: float | None = None, bottom: float | None = None, wspace: float | None = None, hspace: float | None = None, animation_session_id: str | None = None, animation_meta_callback: Any = None, animation_frame_callback: Any = None, _user_plot: int = 1) None[source]#
Open a graphics file to contain plots.
- Parameter breakdown (see below for full detail). The following parameters:
- configure the plot layout:
rows,columns
- configure the output file and figure:
file,orientation,figsize,dpi
- control user-defined plot positioning:
user_position
- configure figure margins and subplot spacing:
left,right,top,bottom,wspace,hspace
- configure animation session integration:
animation_session_id,animation_meta_callback,animation_frame_callback
- internal use only (do not use):
_user_plot
- Parameters:
rows (int, optional) -- Number of plot rows on the page. Defaults to
1.columns (int, optional) -- Number of plot columns on the page. Defaults to
1.file (str, optional) -- Output file name. Defaults to
'cfplot.png'.orientation (str, optional) -- Figure orientation. Options are
'landscape'and'portrait'. Defaults to'landscape'.figsize (list[float] | tuple[float, float], optional) -- Figure size in inches, specified as a list or tuple of two values. Defaults to
(11.7, 8.3).dpi (float | None, optional) -- Resolution in dots per inch. Defaults to
Nonewhich defers to the matplotlib default value (normally100.0, see matplotlib configuration and the Matplotlib figure.dpi configuration).user_position (bool, optional) -- If
True, allow the plot position to be supplied via thegposarguments ofxmin,xmax,ymin,ymaxinstead of an integer for automatic positioning by cf-plot. Defaults toFalse.left (float | None, optional) -- Left margin in normalised coordinates. Defaults to
Noneto use0.12.right (float | None, optional) -- Right margin in normalised coordinates. Defaults to
Noneto use0.92.top (float | None, optional) -- Top margin in normalised coordinates. Defaults to
Noneto use0.08.bottom (float | None, optional) -- Bottom margin in normalised coordinates. Defaults to
Noneto use0.08.wspace (float | None, optional) -- Width reserved for blank space between subplots. Defaults to
Noneto use0.2.hspace (float | None, optional) -- Height reserved for blank space between subplots. Defaults to
Noneto use0.2.animation_session_id (str | None, optional) -- Identifier for the animation session. Defaults to
None.animation_meta_callback (Any, optional) -- Callback for providing animation metadata. Defaults to
None.animation_frame_callback (Any, optional) -- Callback for handling animation frames. Defaults to
None._user_plot (int, optional) -- Internal plot variable for validation purposes. Do not use. Defaults to
1.
- Returns:
None