election_day.utils.election.lists
=================================

.. py:module:: election_day.utils.election.lists


Classes
-------

.. autoapisummary::

   election_day.utils.election.lists.ListResultRow


Functions
---------

.. autoapisummary::

   election_day.utils.election.lists.get_list_results
   election_day.utils.election.lists.get_lists_data
   election_day.utils.election.lists.get_lists_panachage_data


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

.. py:class:: ListResultRow

   Bases: :py:obj:`NamedTuple`


   .. py:attribute:: votes
      :type:  int


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


   .. py:attribute:: number_of_mandates
      :type:  int


.. py:function:: get_list_results(election: onegov.election_day.models.Election, limit: int | None = None, names: collections.abc.Collection[str] | None = None, sort_by_names: bool = False, entities: collections.abc.Collection[str] | None = None) -> sqlalchemy.orm.Query[ListResultRow]

   Returns the aggregated list results as list. 


.. py:function:: get_lists_data(election: onegov.election_day.models.Election, limit: int | None = None, names: collections.abc.Collection[str] | None = None, mandates_only: bool = False, sort_by_names: bool = False, entities: collections.abc.Collection[str] | None = None) -> onegov.core.types.JSONObject_ro

   " View the lists as JSON. Used to for the lists bar chart. 


.. py:function:: get_lists_panachage_data(election: onegov.election_day.models.Election, request: onegov.election_day.request.ElectionDayRequest | None) -> onegov.core.types.JSONObject_ro

   " Get the panachage data as JSON. Used to for the panachage sankey
   chart.