plesty.lib.monitor.common.series
================================

.. py:module:: plesty.lib.monitor.common.series

.. autoapi-nested-parse::

   One field against another, over the rows a run has committed.

   Nothing here is about spectra: this is the view of any sweep whose steps each
   produce a number — a power against an angle, a temperature against time, a
   count rate against a wavelength.



Classes
-------

.. autoapisummary::

   plesty.lib.monitor.common.series.Series


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

.. py:class:: Series(y: str, x: str = '', *, title: str = '', name: str = '', weight: Optional[float] = None, area: str = '', color: str = 'mint', x_label: str = '', y_label: str = '', marker: bool = True)

   Bases: :py:obj:`plesty.lib.monitor.plots.Plot`


   One field against another, a point per committed row.

   The ordinary view of a sweep whose steps each produce a number: a power
   against an angle, a count rate against a wavelength.

   Draw *y* against *x* over the rows.

   :param y: Field holding the value.
   :param x: Field holding the position; empty numbers the rows.
   :param title: What the view is called; defaults to the field names.
   :param name: Layout key.
   :param weight: Relative size.
   :param area: Which side of the window it starts on.
   :param color: Palette token.
   :param x_label: Axis label; defaults to the field name.
   :param y_label: Axis label; defaults to the field name.
   :param marker: Mark each point as well as joining them.


   .. py:attribute:: title
      :value: 'Series'



   .. py:attribute:: x
      :value: ''



   .. py:attribute:: y


   .. py:attribute:: color
      :value: 'mint'



   .. py:attribute:: x_label
      :value: 'Step'



   .. py:attribute:: y_label


   .. py:attribute:: marker
      :value: True



   .. py:method:: draw(data: Any) -> plesty.lib.monitor.plots.Drawing

      Draw the series, leaving out rows that carry no value.

      :param data: The run's data.

      :returns: One curve, or nothing before the first value.