arctichoke.plot.hvplots
=======================

.. py:module:: arctichoke.plot.hvplots


Functions
---------

.. autoapisummary::

   arctichoke.plot.hvplots.quadmesh_map


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

.. py:function:: quadmesh_map(xr_data: xarray.Dataset, var: str, save_as: str = None, map_projection: str = 'NorthPolarStereo', map_bbox: [float, float, float, float] = sps.NWP_BBOX, clims: [(int, float), (int, float)] = None, diverging_cbar: bool = False, verbose: bool = False, **kwargs)

   Create an `hvplot` quadmesh map.

   Plot a map of the given data using the `hvplot.quadmesh()` function.

   :param xr_data: The dataset to plot.
   :type xr_data: `xarray.Dataset`
   :param var: The variable in `xr_data` to plot.
   :type var: `str`
   :param save_as: The file name to pass to `arctichoke.plot.save_hvplots.save_hvplot()`.
                   Default is `None`, which doesn't save the plot to a file.
   :type save_as: `str`, `None`, optional
   :param map_projection: A string naming the map projection to use in the plot.
                          Must be one of the following: 'NorthPolarStereo', 'Orthograpic'.
                          Default is 'NorthPolarStereo'.
   :type map_projection: `str`, optional
   :param map_bbox:
                    An array of coordinates defining the bounding box of the map in the following format:
                        - [LAT_MAX, LAT_MIN, LON_MAX, LON_MIN]

                    Default is `arctichoke.params.latlon_params.NWP_BBOX`.
   :type map_bbox: Array of `float`, optional
   :param clims: The limits to use in the colorbar.
                 Note: This overrides the default method of limiting the colorbar range when `diverging_cbar=True`.
                 Default is `None`, which uses the minimum / maximum values present in the data.
   :type clims: List or tuple of `int`, `float`, optional
   :param diverging_cbar: Whether to use a diverging colormap on the colorbar.
                          Default is `False`.
   :type diverging_cbar: `bool`, optional
   :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 `hvplot.quadmesh()` and `arctichoke.plot.limit_extent.get_limited_extent()`

   :returns: **qm_map_plot** -- An overlay object which can be used to construct the plot.
   :rtype: `holoviews.core.overlay.Overlay`

   .. rubric:: Examples

   >>> import xarray as xr
   >>> this_plot = hvplots.quadmesh_map(xr.open_dataset("data/areacello_Ofx_EC-Earth3P-HR_highres-future_r2i1p2f1_gn.nc", 'areacello')
   >>> print(type(this_plot))
   <class 'holoviews.core.overlay.Overlay'>