plots.styles.legends
====================

.. py:module:: plots.styles.legends


Attributes
----------

.. autoapisummary::

   plots.styles.legends.DEFAULT_LEGEND_LABEL


Functions
---------

.. autoapisummary::

   plots.styles.legends.colorbar
   plots.styles.legends.disjoint


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

.. py:data:: DEFAULT_LEGEND_LABEL
   :value: '{variable_name} ({units})'


.. py:function:: colorbar(layer, *args, shrink=0.8, aspect=35, ax=None, **kwargs)

   Produce a colorbar for a given layer.

   :param layer: The layer for which to produce a colorbar.
   :type layer: earthkit.maps.charts.layers.Layer
   :param \*\*kwargs: Any keyword arguments accepted by `matplotlib.figures.Figure.colorbar`.


.. py:function:: disjoint(layer, *args, location='bottom', frameon=False, **kwargs)

   Produce a disjoint legend for a given layer.

   :param layer: The layer for which to produce a colorbar.
   :type layer: earthkit.maps.charts.layers.Layer
   :param \*\*kwargs: Any keyword arguments accepted by `matplotlib.figures.Figure.legend`.