election_day.utils.election_compound.list_groups
================================================

.. py:module:: election_day.utils.election_compound.list_groups


Classes
-------

.. autoapisummary::

   election_day.utils.election_compound.list_groups.ListGroupsRow


Functions
---------

.. autoapisummary::

   election_day.utils.election_compound.list_groups.get_list_groups
   election_day.utils.election_compound.list_groups.get_list_groups_data


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

.. py:class:: ListGroupsRow

   Bases: :py:obj:`NamedTuple`


   .. py:attribute:: name
      :type:  str | None


   .. py:attribute:: voters_count
      :type:  decimal.Decimal | int | None


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


.. py:function:: get_list_groups(election_compound: onegov.election_day.models.ElectionCompound) -> list[ListGroupsRow]

   " Get list groups data. 


.. py:function:: get_list_groups_data(election_compound: onegov.election_day.models.ElectionCompound) -> onegov.core.types.JSONObject_ro

   " Get the list groups bar chart data as JSON.