election_day.layouts.vote
=========================

.. py:module:: election_day.layouts.vote


Classes
-------

.. autoapisummary::

   election_day.layouts.vote.VoteLayout


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

.. py:class:: VoteLayout(model: onegov.election_day.models.Vote, request: onegov.election_day.request.ElectionDayRequest, tab: str = 'entities')

   Bases: :py:obj:`onegov.election_day.layouts.detail.DetailLayout`


   A common base layout for election and votes which caches some values
   used in the macros.



   .. py:attribute:: model
      :type:  onegov.election_day.models.Vote


   .. py:attribute:: tab
      :value: 'entities'



   .. py:attribute:: tabs_with_embedded_tables
      :value: ('entities', 'districts', 'statistics', 'proposal-entities', 'proposal-districts',...



   .. py:property:: all_tabs
      :type: tuple[str, Ellipsis]


      Return all tabs. Ordering is important for the main view.



   .. py:method:: title(tab: str | None = None) -> str


   .. py:method:: subtitle(tab: str | None = None) -> str


   .. py:method:: tab_visible(tab: str | None) -> bool


   .. py:method:: label(value: str) -> str


   .. py:property:: visible
      :type: bool



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



   .. py:property:: scope
      :type: str | None



   .. py:property:: ballot
      :type: onegov.election_day.models.Ballot



   .. py:property:: map_link
      :type: str | None



   .. py:method:: table_link(query_params: dict[str, str] | None = None) -> str | None


   .. py:property:: widget_link
      :type: str



   .. py:property:: summarize
      :type: bool



   .. py:property:: main_view
      :type: str



   .. py:property:: answer
      :type: str | None



   .. py:property:: direct
      :type: bool



   .. py:property:: menu
      :type: election_day.layouts.election.NestedMenu



   .. py:property:: pdf_path
      :type: str | None


      Returns the path to the PDF file or None, if it is not available.
              



   .. py:property:: svg_prefix
      :type: str



   .. py:property:: svg_path
      :type: str | None


      Returns the path to the SVG file or None, if it is not available.
              



   .. py:property:: svg_link
      :type: str


      Returns a link to the SVG download view. 



   .. py:property:: svg_name
      :type: str


      Returns a nice to read SVG filename.