arctichoke.plot.cbar_limits
===========================

.. py:module:: arctichoke.plot.cbar_limits


Functions
---------

.. autoapisummary::

   arctichoke.plot.cbar_limits.set_cbar_lims


Module Contents
---------------

.. py:function:: set_cbar_lims(hv_overlay: (holoviews.core.overlay.Overlay, holoviews.element.raster.QuadMesh), cmin: (int, float), cmax: (int, float), verbose: bool = False, **kwargs)

   Limit the colorbar range without changing the colors.

   Set the limits of the colorbar in the given overlay object such that the displayed range of the colorbar is within those limits but the colors to which every value corresponds remains the same as the original.
   This is done by completely replacing the original colorbar with a new one where the range has been limited.

   :param hv_overlay: The overlay object for which to construct the limited colorbar.
   :type hv_overlay: `holoviews.core.overlay.Overlay`, `holoviews.element.raster.QuadMesh`
   :param cmin: The minimum display value for the colormap.
   :type cmin: `int`, `float`
   :param cmax: The maximum display value for the colormap.
   :type cmax: `int`, `float`
   :param verbose: Whether to verbosely output information as the function executes.
                   Default is `False`.
   :type verbose: `bool`, optional
   :param \*\*kwargs: Keyword arguments to pass to `bokeh.models.LinearColorMapper()` and `bokeh.models.ColorBar()`.

   :returns: **fig** -- The figure containing the original plot and the new, limited colorbar.
   :rtype: `bokeh.plotting._figure.figure`

   .. rubric:: Examples

   >>> from arctichoke.plot.cbar_limits import set_cbar_lims