plots.metadata.labels
=====================

.. py:module:: plots.metadata.labels


Attributes
----------

.. autoapisummary::

   plots.metadata.labels.CRS_NAMES
   plots.metadata.labels.DEFAULT_ANALYSIS_TITLE
   plots.metadata.labels.DEFAULT_FORECAST_TITLE
   plots.metadata.labels.MAGIC_KEYS
   plots.metadata.labels.TIME_KEYS


Functions
---------

.. autoapisummary::

   plots.metadata.labels.default_label
   plots.metadata.labels.extract


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

.. py:data:: CRS_NAMES

.. py:data:: DEFAULT_ANALYSIS_TITLE
   :value: '{variable_name} at {valid_time:%H:%M} on {valid_time:%Y-%m-%d}'


.. py:data:: DEFAULT_FORECAST_TITLE
   :value: Multiline-String

   .. raw:: html

      <details><summary>Show Value</summary>

   .. code-block:: python

      """{variable_name}
      Base time: {base_time:%H:%M} on {base_time:%Y-%m-%d}   Valid time: {valid_time:%H:%M} on {valid_time:%Y-%m-%d} (T+{lead_time})"""

   .. raw:: html

      </details>



.. py:data:: MAGIC_KEYS

.. py:data:: TIME_KEYS
   :value: ['base_time', 'valid_time', 'lead_time', 'time', 'utc_offset']


.. py:function:: default_label(data)

   Get the default label type for a given data object (analysis or forecast).

   :param data: The data source to get the label for.
   :type data: earthkit.plots.sources.Source


.. py:function:: extract(data, attr, default=None)

   Extract an attribute from a data object.

   :param data: The data source to extract the label from.
   :type data: earthkit.plots.sources.Source
   :param attr: The attribute to extract.
   :type attr: str
   :param default: The default label to use if the attribute is not found.
   :type default: str, optional