org.models.dashboard
====================

.. py:module:: org.models.dashboard


Classes
-------

.. autoapisummary::

   org.models.dashboard.Dashboard
   org.models.dashboard.Boardlet
   org.models.dashboard.BoardletFact


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

.. py:class:: Dashboard(request: onegov.org.request.OrgRequest)

   .. py:attribute:: request


   .. py:property:: is_available
      :type: bool


      Returns true if there are `Boardlet`s to display. 



   .. py:method:: boardlets() -> list[tuple[Boardlet, Ellipsis]]

      Returns the boardlets, grouped/ordered by their order tuple. 



.. py:class:: Boardlet(name: str, order: tuple[int, int], icon: str, request: onegov.org.request.OrgRequest)

   Base class used by all boardlets.

   Use as follows::

       from onegov.app import App

       @App.boardlet(name='foo', order=(1, 1), icon='')
       class MyBoardlet(Boardlet):
           pass



   .. py:attribute:: name


   .. py:attribute:: order


   .. py:attribute:: icon


   .. py:attribute:: request


   .. py:property:: title
      :type: str

      :abstractmethod:


      Returns the title of the boardlet, which is meant to be something
      meaningful, like the most important metric used in the boardlet.




   .. py:property:: facts
      :type: collections.abc.Iterator[BoardletFact]

      :abstractmethod:


      Yields facts. (:class:`BoardletFact` instances)



   .. py:property:: is_available
      :type: bool


      Returns true if the boardlet is active/has data. 



   .. py:property:: state
      :type: Literal['success', 'warning', 'failure']


      Yields one of three states:

      * 'success'
      * 'warning'
      * 'failure'




.. py:class:: BoardletFact

   A single boardlet fact. 


   .. py:attribute:: text
      :type:  str


   .. py:attribute:: number
      :type:  int | float | str | None
      :value: None



   .. py:attribute:: link
      :type:  tuple[str, str] | None
      :value: None



   .. py:attribute:: icon
      :type:  str | None
      :value: None



   .. py:attribute:: visibility_icon
      :type:  str | None
      :value: None



   .. py:attribute:: icon_title
      :type:  str | None
      :value: None



   .. py:attribute:: css_class
      :type:  str | None
      :value: None