corvix.config.dashboards
========================

.. py:module:: corvix.config.dashboards

.. autoapi-nested-parse::

   Dashboard configuration model and YAML parsing.



Attributes
----------

.. autoapisummary::

   corvix.config.dashboards.NO_FILTERS_DASHBOARD_NAME


Classes
-------

.. autoapisummary::

   corvix.config.dashboards.DashboardSpec


Functions
---------

.. autoapisummary::

   corvix.config.dashboards.default_dashboard
   corvix.config.dashboards.no_filters_dashboard
   corvix.config.dashboards.available_dashboards
   corvix.config.dashboards.is_no_filters_dashboard
   corvix.config.dashboards._parse_dashboards
   corvix.config.dashboards._parse_dashboard_ignore_rules


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

.. py:data:: NO_FILTERS_DASHBOARD_NAME
   :value: 'no filters'


.. py:class:: DashboardSpec

   Dashboard configuration for sorting, grouping, and filtering.


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: group_by
      :type:  str
      :value: 'none'



   .. py:attribute:: sort_by
      :type:  str
      :value: 'score'



   .. py:attribute:: descending
      :type:  bool
      :value: True



   .. py:attribute:: include_read
      :type:  bool
      :value: False



   .. py:attribute:: max_items
      :type:  int
      :value: 100



   .. py:attribute:: match
      :type:  corvix.config.rules.MatchCriteria


   .. py:attribute:: ignore_rules
      :type:  list[corvix.config.rules.MatchCriteria]
      :value: []



.. py:function:: default_dashboard() -> DashboardSpec

   Return the fallback dashboard used when config defines none.


.. py:function:: no_filters_dashboard() -> DashboardSpec

   Return the hardcoded dashboard that bypasses config-driven filtering.


.. py:function:: available_dashboards(dashboards: list[DashboardSpec]) -> list[DashboardSpec]

   Return configured dashboards plus the built-in rule-free dashboard.


.. py:function:: is_no_filters_dashboard(dashboard: DashboardSpec) -> bool

   Return whether the dashboard is the hardcoded rule-free dashboard.


.. py:function:: _parse_dashboards(value: object) -> list[DashboardSpec]

.. py:function:: _parse_dashboard_ignore_rules(value: object) -> list[corvix.config.rules.MatchCriteria]