polartoolkit.Figure.add_colorbar

Figure.add_colorbar(hist=False, cpt_lims=None, cbar_frame=None, verbose='warning', **kwargs)

Add a colorbar based on the last cmap used by PyGMT and optionally a histogram of the data values.

Parameters:

• hist (bool) – choose whether to add a colorbar histogram, by default False

• cpt_lims (tuple[float, float] | None) – cpt lims to use for the colorbar histogram, must match those used to create the colormap. If not supplied, will attempt to get values from kwargs grid, by default None

• cbar_frame (list[str] | str | None) – frame for the colorbar, by default None

• verbose (str) – verbosity level for pygmt, by default “warning” for warnings

• **kwargs (Any) – additional keyword arguments to pass

Return type:

None