colour.plotting.label_rectangles¶
- colour.plotting.label_rectangles(labels: Sequence[str], rectangles: Sequence[Patch], rotation: Union[Literal['horizontal', 'vertical'], str] = 'vertical', text_size: Floating = 10, offset: Optional[ArrayLike] = None, **kwargs: Any) Tuple[plt.Figure, plt.Axes] [source]¶
Add labels above given rectangles.
- Parameters
labels (Sequence[str]) – Labels to display.
rectangles (Sequence[Patch]) – Rectangles to used to set the labels value and position.
rotation (Union[Literal[('horizontal', 'vertical')], str]) – Labels orientation.
text_size (Floating) – Labels text size.
offset (Optional[ArrayLike]) – Labels offset as percentages of the largest rectangle dimensions.
figure – Figure to apply the render elements onto.
axes – Axes to apply the render elements onto.
kwargs (Any) –
- Returns
Current figure and axes.
- Return type