colour.plotting.render¶
-
colour.plotting.
render
(**kwargs)[source]¶ Renders the current figure while adjusting various settings such as the bounding box, the title or background transparency.
- Other Parameters
figure (Figure, optional) – Figure to apply the render elements onto.
axes (Axes, optional) – Axes to apply the render elements onto.
filename (unicode, optional) – Figure will be saved using given
filename
argument.standalone (bool, optional) – Whether to show the figure and call
plt.show()
definition.aspect (unicode, optional) – Matplotlib axes aspect.
axes_visible (bool, optional) – Whether the axes are visible. Default is True.
bounding_box (array_like, optional) – Array defining current axes limits such bounding_box = (x min, x max, y min, y max).
tight_layout (bool, optional) – Whether to invoke the
plt.tight_layout()
definition.legend (bool, optional) – Whether to display the legend. Default is False.
legend_columns (int, optional) – Number of columns in the legend. Default is 1.
transparent_background (bool, optional) – Whether to turn off the background patch. Default is False.
title (unicode, optional) – Figure title.
wrap_title (unicode, optional) – Whether to wrap the figure title, the default is to wrap at a number of characters equal to the width of the figure multiplied by 10.
x_label (unicode, optional) – X axis label.
y_label (unicode, optional) – Y axis label.
x_ticker (bool, optional) – Whether to display the X axis ticker. Default is True.
y_ticker (bool, optional) – Whether to display the Y axis ticker. Default is True.
- Returns
Current figure and axes.
- Return type