anki.stats
==========

.. py:module:: anki.stats


Attributes
----------

.. autoapisummary::

   anki.stats.PERIOD_MONTH
   anki.stats.PERIOD_YEAR
   anki.stats.PERIOD_LIFE
   anki.stats.colYoung
   anki.stats.colMature
   anki.stats.colCum
   anki.stats.colLearn
   anki.stats.colRelearn
   anki.stats.colCram
   anki.stats.colIvl
   anki.stats.colHour
   anki.stats.colTime
   anki.stats.colUnseen
   anki.stats.colSusp


Classes
-------

.. autoapisummary::

   anki.stats.CardStats
   anki.stats.CollectionStats


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

.. py:class:: CardStats(col: anki.consts.anki.collection.Collection, card: anki.consts.anki.cards.Card)

   Do not use - this class is only left around for backwards compatibility.


   .. py:attribute:: card


   .. py:attribute:: txt
      :value: ''



   .. py:method:: report(include_revlog: bool = False) -> str


   .. py:method:: addLine(k: str, v: int | str) -> None


   .. py:method:: makeLine(k: str, v: str | int) -> str


   .. py:method:: date(tm: float) -> str


   .. py:method:: time(tm: float) -> str


.. py:data:: PERIOD_MONTH
   :value: 0


.. py:data:: PERIOD_YEAR
   :value: 1


.. py:data:: PERIOD_LIFE
   :value: 2


.. py:data:: colYoung
   :value: '#7c7'


.. py:data:: colMature
   :value: '#070'


.. py:data:: colCum
   :value: 'rgba(0,0,0,0.9)'


.. py:data:: colLearn
   :value: '#00F'


.. py:data:: colRelearn
   :value: '#c00'


.. py:data:: colCram
   :value: '#ff0'


.. py:data:: colIvl
   :value: '#077'


.. py:data:: colHour
   :value: '#ccc'


.. py:data:: colTime
   :value: '#770'


.. py:data:: colUnseen
   :value: '#000'


.. py:data:: colSusp
   :value: '#ff0'


.. py:class:: CollectionStats(col: anki.consts.anki.collection.Collection)

   .. py:attribute:: col


   .. py:attribute:: type
      :value: 0



   .. py:attribute:: width
      :value: 600



   .. py:attribute:: height
      :value: 200



   .. py:attribute:: wholeCollection
      :value: False



   .. py:method:: report(type: int = PERIOD_MONTH) -> str


   .. py:attribute:: css
      :value: Multiline-String

      .. raw:: html

         <details><summary>Show Value</summary>

      .. code-block:: python

         """
         <style>
         h1 { margin-bottom: 0; margin-top: 1em; }
         .pielabel { text-align:center; padding:0px; color:white; }
         body:not(.night_mode) {background-image: url(data:image/png;base64,%s); }
         @media print {
             .section { page-break-inside: avoid; padding-top: 5mm; }
         }
         body { direction: ltr !important; }
         </style>
         """

      .. raw:: html

         </details>




   .. py:method:: todayStats() -> str


   .. py:method:: get_start_end_chunk(by: str = 'review') -> tuple[int, int | None, int]


   .. py:method:: dueGraph() -> str


   .. py:method:: introductionGraph() -> str


   .. py:method:: repsGraphs() -> str


   .. py:method:: ivlGraph() -> str


   .. py:method:: easeGraph() -> str


   .. py:method:: hourGraph() -> str


   .. py:method:: cardGraph() -> str


   .. py:method:: footer() -> str