cbar#

cbar(arg='vert', colors=0, minmax=None, grad=5, *, ax=None, cmap=None)#

Display a full or partial color bar, following EEGLAB cbar.

Parameters:

  • arg (str | Axes | int | None) – "vert", "horiz", "pos", or an existing axes. Passing an axes draws into it and infers orientation from its shape.

  • colors (int | Sequence[int]) – One-based colormap indices, or an integer count of colors to remove from the upper end. Zero displays the full colormap.

  • minmax (Sequence[float] | None) – Optional values represented by the two ends of the color bar.

  • grad (int) – Number of tick labels when minmax is supplied.

  • ax (Axes | None) – Existing axes to draw into. This is the keyword equivalent of passing an axes as arg.

  • cmap (str | Colormap | None) – Matplotlib colormap name or object. The source axes’ colormap is used when possible, otherwise Matplotlib’s default is used.

Returns:

The axes containing the color strip.

Return type:

Axes

On this page