sda.dashboard.components.tables
===============================

.. py:module:: sda.dashboard.components.tables

.. autoapi-nested-parse::

   Table Components.

   ===============

   Components for displaying data in tabular format.



Attributes
----------

.. autoapisummary::

   sda.dashboard.components.tables.Options


Classes
-------

.. autoapisummary::

   sda.dashboard.components.tables.DropdownOption


Functions
---------

.. autoapisummary::

   sda.dashboard.components.tables.create_table_layout
   sda.dashboard.components.tables.create_data_table
   sda.dashboard.components.tables.get_table_info


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

.. py:class:: DropdownOption

   Bases: :py:obj:`TypedDict`


   dict() -> new empty dictionary
   dict(mapping) -> new dictionary initialized from a mapping object's
       (key, value) pairs
   dict(iterable) -> new dictionary initialized as if via:
       d = {}
       for k, v in iterable:
           d[k] = v
   dict(**kwargs) -> new dictionary initialized with the name=value pairs
       in the keyword argument list.  For example:  dict(one=1, two=2)


   .. py:attribute:: label
      :type:  str


   .. py:attribute:: value
      :type:  Union[int, str]


.. py:data:: Options

.. py:function:: create_table_layout(test_name)

   Create table layout for displaying all data points.

   :param test_name: Name of the test to display
   :type test_name: :py:class:`str`

   :returns: Complete table layout
   :rtype: :py:class:`html.Div`


.. py:function:: create_data_table(df, page_size = 25)

   Create a Dash DataTable from a pandas DataFrame.

   :param df: Data to display
   :type df: :py:class:`pd.DataFrame`
   :param page_size: Number of rows per page
   :type page_size: :py:class:`int`, *default* ``25``

   :returns: Configured DataTable component
   :rtype: :py:class:`dash_table.DataTable`


.. py:function:: get_table_info(df, selected_rows = None)

   Get table information summary.

   :param df: Data to analyze
   :type df: :py:class:`pd.DataFrame`
   :param selected_rows: List of selected row indices
   :type selected_rows: :py:class:`List[int]`, *optional*

   :returns: Table information summary
   :rtype: :py:class:`str`