plots.interactive.box
=====================

.. py:module:: plots.interactive.box


Attributes
----------

.. autoapisummary::

   plots.interactive.box.DEFAULT_KWARGS
   plots.interactive.box.DEFAULT_QUANTILES
   plots.interactive.box.THICKEST
   plots.interactive.box.THINNEST


Functions
---------

.. autoapisummary::

   plots.interactive.box.box


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

.. py:data:: DEFAULT_KWARGS

.. py:data:: DEFAULT_QUANTILES
   :value: [0.05, 0.25, 0.5, 0.75, 0.95]


.. py:data:: THICKEST
   :value: 0.6


.. py:data:: THINNEST
   :value: 0.3


.. py:function:: box(*args, quantiles=DEFAULT_QUANTILES, time_axis=0, **kwargs)

   Generate a set of box plot traces based on the provided data and quantiles.

   :param data: The data to be plotted.
   :type data: array-like or earthkit.data.FieldList
   :param \*args: Positional arguments passed to the plotly `go.Box` constructors.
   :type \*args: tuple
   :param quantiles: A list of quantiles to calculate for the data. The default is
                     [0.05, 0.25, 0.5, 0.75, 0.95]. Note that any number of quantiles
                     can be provided, but the default is based on the standard five-point
                     box plot.
   :type quantiles: list of float, optional
   :param time_axis: The axis along which to calculate the quantiles. The default is 0.
   :type time_axis: int, optional
   :param \*\*kwargs: Additional keyword arguments passed to the `go.Box` constructor.
   :type \*\*kwargs: dict

   :rtype: list of plotly.graph_objects.Box

   .. rubric:: Notes

   - The width of the box plots is scaled based on the x-axis spacing.
   - Extra boxes are added for quantiles beyond the standard five-point box plot.
   - Hover information is included for quantile scatter points, showing the
     quantile value and percentage.