solarwindpy.plotting.tools.multipanel_figure_shared_cbar

multipanel_figure_shared_cbar(nrows: int, ncols: int, vertical_cbar: bool = True, sharex: bool = True, sharey: bool = True, **kwargs)[source]

Create a grid of axes that share a single colorbar.

This is a lightweight wrapper around build_ax_array_with_common_colorbar() for backward compatibility.

Parameters:

  • nrows (int) – Shape of the axes grid.

  • ncols (int) – Shape of the axes grid.

  • vertical_cbar (bool, optional) – If True the colorbar is placed to the right of the axes; otherwise it is placed above them.

  • sharex (bool, optional) – If True share the respective axis limits across all panels.

  • sharey (bool, optional) – If True share the respective axis limits across all panels.

  • **kwargs – Additional arguments controlling layout such as figsize or grid ratios.

Returns:

Examples

>>> fig, axs, cax = multipanel_figure_shared_cbar(2, 2)