plots.sources.xarray
====================

.. py:module:: plots.sources.xarray


Classes
-------

.. autoapisummary::

   plots.sources.xarray.XarraySource


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

.. py:class:: XarraySource

   Bases: :py:obj:`earthkit.plots.sources.single.SingleSource`


   Source class for xarray data.

   :param data: The data to be plotted.
   :type data: xarray.Dataset
   :param x: The x-coordinate variable in data.
   :type x: str, optional
   :param y: The y-coordinate variable in data.
   :type y: str, optional
   :param z: The z-coordinate variable in data.
   :type z: str, optional
   :param u: The u-component variable in data.
   :type u: str, optional
   :param v: The v-component variable in data.
   :type v: str, optional
   :param crs: The CRS of the data.
   :type crs: cartopy.crs.CRS, optional
   :param \*\*kwargs: Metadata keys and values to attach to this Source.


   .. py:property:: coordinate_axis

      The coordinate axis of the data. One of 'x' or 'y'.


   .. py:property:: crs

      The CRS of the data.


   .. py:property:: data

      The underlying xarray data.


   .. py:method:: datetime()

      Get the datetime of the data.



   .. py:property:: dims

      The dimensions of the data.


   .. py:method:: extract_u()

      Extract the u values of the data.



   .. py:method:: extract_v()

      Extract the v values of the data.



   .. py:method:: extract_x()

      Extract the x values of the data.



   .. py:method:: extract_xy()

      Extract the x and y values from the data.



   .. py:method:: extract_xyz()

      Extract the x, y and z values from the data.



   .. py:method:: extract_y()

      Extract the y values of the data.



   .. py:method:: extract_z()

      Extract the z values of the data.



   .. py:property:: magnitude_values

      The magnitude values of the data.


   .. py:method:: metadata(key, default=None)

      Extract metadata from the data.

      :param key: The metadata key to extract.
      :type key: str
      :param default: The default value to return if the key is not found.
      :type default: any, optional



   .. py:property:: u_values

      The u values of the data.


   .. py:property:: v_values

      The v values of the data.


   .. py:property:: x_values

      The x values of the data.


   .. py:property:: y_values

      The y values of the data.


   .. py:property:: z_values

      The z values of the data.