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

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

.. autoapi-nested-parse::

   Dashboard Components.

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

   Reusable UI components for the dashboard.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /_api/sda/dashboard/components/filters/index
   /_api/sda/dashboard/components/forms/index
   /_api/sda/dashboard/components/graphs/index
   /_api/sda/dashboard/components/layouts/index
   /_api/sda/dashboard/components/tables/index


Functions
---------

.. autoapisummary::

   sda.dashboard.components.create_filter_panel
   sda.dashboard.components.create_unified_filter_sidebar
   sda.dashboard.components.create_graph_component
   sda.dashboard.components.create_dashboard_layout
   sda.dashboard.components.create_line_layout
   sda.dashboard.components.create_scatter_layout
   sda.dashboard.components.create_sidebar
   sda.dashboard.components.create_table_layout
   sda.dashboard.components.create_test_selection_layout


Package Contents
----------------

.. py:function:: create_filter_panel(plot_type = 'scatter')

   Create a filter panel with dynamic filter slots.

   This creates a fixed number of filter slots that are dynamically allocated
   to the selected columns from the Test Selection tab.

   DEPRECATED: This function is kept for backward compatibility.
   Use create_unified_filter_sidebar() for new implementations.

   :param plot_type: Type of plot ("scatter" or "line")
   :type plot_type: :py:class:`str`

   :returns: Filter panel component with dynamic slots
   :rtype: :py:class:`html.Div`


.. py:function:: create_unified_filter_sidebar()

   Create a unified filter sidebar using Bootstrap Offcanvas.

   This creates a collapsible right sidebar with dynamic filter slots
   that are shared across all plot types (scatter, line, table).

   :returns: Unified filter sidebar component using Bootstrap Offcanvas
   :rtype: :py:class:`dbc.Offcanvas`


.. py:function:: create_graph_component(graph_id, height = None, width = None)

   Create a graph component with consistent styling.

   :param graph_id: ID for the graph component
   :type graph_id: :py:class:`str`
   :param height: Height of the graph (e.g., "80vh", "500px")
   :type height: :py:class:`str`, *optional*
   :param width: Width of the graph (e.g., "100%", "800px")
   :type width: :py:class:`str`, *optional*

   :returns: Configured graph component
   :rtype: :py:class:`dcc.Graph`


.. py:function:: create_dashboard_layout(test_name, debug = False)

   Create the complete dashboard layout with Spark styling.

   :param test_name: The name of the test to load initially
   :type test_name: :py:class:`str`
   :param debug: Whether to enable debug mode features
   :type debug: :py:class:`bool`

   :returns: Complete dashboard layout with Spark styling
   :rtype: :py:class:`html.Div`


.. py:function:: create_line_layout(test_name)

   Create line plot layout.

   :param test_name: Name of the test or list of test names
   :type test_name: :py:class:`str` or :py:class:`list` of :py:class:`str`

   :returns: Line plot layout
   :rtype: :py:class:`html.Div`


.. py:function:: create_scatter_layout(test_name)

   Create scatter plot layout.

   :param test_name: Name of the test or list of test names
   :type test_name: :py:class:`str` or :py:class:`list` of :py:class:`str`

   :returns: Scatter plot layout
   :rtype: :py:class:`html.Div`


.. py:function:: create_sidebar()

   Create a sidebar component (stub for backward compatibility).

   :returns: Empty sidebar component
   :rtype: :py:class:`html.Div`


.. py:function:: create_table_layout(test_name)

   Create table layout for displaying all data points.

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

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


.. py:function:: create_test_selection_layout(test_name, selected_columns = None)

   Create the test selection layout.

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

   :returns: Test selection layout component.
   :rtype: :py:class:`html.Div`