colour.plotting.common.KwargsRender#

class colour.plotting.common.KwargsRender(*args, **kwargs)[source]#

Define the keyword argument types for the colour.plotting.render() definition.

Parameters:
  • figure (matplotlib.figure.Figure) – Figure to apply the render elements onto.

  • axes (matplotlib.axes._axes.Axes) – Axes to apply the render elements onto.

  • filename (str) – Figure will be saved using given filename argument.

  • standalone (bool) – Whether to show the figure and call matplotlib.pyplot.show() definition.

  • aspect (Union[Literal['auto', 'equal'], float]) – Matplotlib axes aspect.

  • axes_visible (bool) – Whether the axes are visible. Default is True.

  • bounding_box (ArrayLike) – Array defining current axes limits such bounding_box = (x min, x max, y min, y max).

  • tight_layout (bool) – Whether to invoke the matplotlib.pyplot.tight_layout() definition.

  • legend (bool) – Whether to display the legend. Default is False.

  • legend_columns (int) – Number of columns in the legend. Default is 1.

  • transparent_background (bool) – Whether to turn off the background patch. Default is True.

  • title (str) – Figure title.

  • wrap_title (bool) – Whether to wrap the figure title. Default is True.

  • x_label (str) – X axis label.

  • y_label (str) – Y axis label.

  • x_ticker (bool) – Whether to display the X axis ticker. Default is True.

  • y_ticker (bool) – Whether to display the Y axis ticker. Default is True.

__init__(*args, **kwargs)#

Methods

__init__(*args, **kwargs)

clear()

copy()

fromkeys([value])

Create a new dictionary with keys from iterable and values set to value.

get(key[, default])

Return the value for key if key is in the dictionary, else default.

items()

keys()

pop(k[,d])

If key is not found, d is returned if given, otherwise KeyError is raised

popitem()

Remove and return a (key, value) pair as a 2-tuple.

setdefault(key[, default])

Insert key with a value of default if key is not in the dictionary.

update([E, ]**F)

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values()

Attributes

figure

axes

filename

standalone

aspect

axes_visible

bounding_box

tight_layout

legend

legend_columns

transparent_background

title

wrap_title

x_label

y_label

x_ticker

y_ticker