concreteproperties.post.plotting_context#

plotting_context(ax: Optional[matplotlib.axes.Axes] = None, pause: Optional[bool] = True, title: Optional[str] = '', filename: Optional[str] = '', render: Optional[bool] = True, axis_index: Optional[Union[None, int, Tuple[int]]] = None, **kwargs)[source]#

Executes code required to set up a matplotlib figure.

Parameters

  • ax (Optional[matplotlib.axes.Axes]) – Axes object on which to plot

  • pause (Optional[bool]) – If set to true, the figure pauses the script until the window is closed. If set to false, the script continues immediately after the window is rendered.

  • title (Optional[str]) – Plot title

  • filename (Optional[str]) – Pass a non-empty string or path to save the image as. If this option is used, the figure is closed after the file is saved.

  • render (Optional[bool]) – If set to False, the image is not displayed. This may be useful if the figure or axes will be embedded or further edited before being displayed.

  • axis_index (Optional[Union[None, int, Tuple[int]]) – If more than 1 axes is created by subplot, then this is the axis to plot on. This may be a tuple if a 2D array of plots is returned. The default value of None will select the top left plot.

  • kwargs – Passed to matplotlib.pyplot.subplots()