colour.plotting.plot_multi_colour_swatches#

colour.plotting.plot_multi_colour_swatches(colour_swatches: Sequence[Union[ArrayLike, ColourSwatch]], width: Floating = 1, height: Floating = 1, spacing: Floating = 0, columns: Optional[Integer] = None, direction: Union[Literal['+y', '-y'], str] = '+y', text_kwargs: Optional[Dict] = None, background_colour: ArrayLike = (1.0, 1.0, 1.0), compare_swatches: Optional[Union[Literal['Diagonal', 'Stacked'], str]] = None, **kwargs: Any) Tuple[plt.Figure, plt.Axes][source]#

Plot given colours swatches.

Parameters
  • colour_swatches (Sequence[Union[ArrayLike, ColourSwatch]]) – Colour swatch sequence, either a regular ArrayLike or a sequence of colour.plotting.ColourSwatch class instances.

  • width (Floating) – Colour swatch width.

  • height (Floating) – Colour swatch height.

  • spacing (Floating) – Colour swatches spacing.

  • columns (Optional[Integer]) – Colour swatches columns count, defaults to the colour swatch count or half of it if comparing.

  • direction (Union[Literal[('+y', '-y')], str]) – Row stacking direction.

  • text_kwargs (Optional[Dict]) –

    Keyword arguments for the matplotlib.pyplot.text() definition. The following special keywords can also be used:

    • offset: Sets the text offset.

    • visible: Sets the text visibility.

  • background_colour (ArrayLike) – Background colour.

  • compare_swatches (Optional[Union[Literal[('Diagonal', 'Stacked')], str]]) – Whether to compare the swatches, in which case the colour swatch count must be an even number with alternating reference colour swatches and test colour swatches. Stacked will draw the test colour swatch in the center of the reference colour swatch, Diagonal will draw the reference colour swatch in the upper left diagonal area and the test colour swatch in the bottom right diagonal area.

  • kwargs (Any) – {colour.plotting.artist(), colour.plotting.render()}, See the documentation of the previously listed definitions.

Returns

Current figure and axes.

Return type

tuple

Examples

>>> RGB_1 = ColourSwatch((0.45293517, 0.31732158, 0.26414773))
>>> RGB_2 = ColourSwatch((0.77875824, 0.57726450, 0.50453169))
>>> plot_multi_colour_swatches([RGB_1, RGB_2])  
(<Figure size ... with 1 Axes>, <...AxesSubplot...>)
plot_multi_colour_swatches