chart_dicts
===========

.. py:module:: chart_dicts


Classes
-------

.. autoapisummary::

   chart_dicts.BaseChart
   chart_dicts.ColorLegend
   chart_dicts.ColorProperties
   chart_dicts.AxisProperties
   chart_dicts.Axes
   chart_dicts.ScatterChart


Functions
---------

.. autoapisummary::

   chart_dicts.StackedRowChart


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

.. py:class:: BaseChart

   Bases: :py:obj:`TypedDict`


   .. py:attribute:: title
      :type:  str


   .. py:attribute:: legend
      :type:  str


   .. py:attribute:: param
      :type:  str | list[str]


   .. py:attribute:: size
      :type:  tuple[int, int]

      When using `absolute` positioning, this will be the top-left corner of the chart in pixels.
      Ignored when `gridstack` positioning is used.


   .. py:attribute:: position
      :type:  tuple[int, int]


   .. py:attribute:: id
      :type:  Optional[str]


.. py:class:: ColorLegend

   Bases: :py:obj:`TypedDict`


   dict() -> new empty dictionary
   dict(mapping) -> new dictionary initialized from a mapping object's
       (key, value) pairs
   dict(iterable) -> new dictionary initialized as if via:
       d = {}
       for k, v in iterable:
           d[k] = v
   dict(**kwargs) -> new dictionary initialized with the name=value pairs
       in the keyword argument list.  For example:  dict(one=1, two=2)


   .. py:attribute:: display
      :type:  bool


   .. py:attribute:: pos
      :type:  tuple[int, int]


.. py:class:: ColorProperties

   Bases: :py:obj:`TypedDict`


   dict() -> new empty dictionary
   dict(mapping) -> new dictionary initialized from a mapping object's
       (key, value) pairs
   dict(iterable) -> new dictionary initialized as if via:
       d = {}
       for k, v in iterable:
           d[k] = v
   dict(**kwargs) -> new dictionary initialized with the name=value pairs
       in the keyword argument list.  For example:  dict(one=1, two=2)


   .. py:attribute:: color_by
      :type:  str


   .. py:attribute:: color_legend
      :type:  ColorLegend


.. py:class:: AxisProperties

   Bases: :py:obj:`TypedDict`


   dict() -> new empty dictionary
   dict(mapping) -> new dictionary initialized from a mapping object's
       (key, value) pairs
   dict(iterable) -> new dictionary initialized as if via:
       d = {}
       for k, v in iterable:
           d[k] = v
   dict(**kwargs) -> new dictionary initialized with the name=value pairs
       in the keyword argument list.  For example:  dict(one=1, two=2)


   .. py:attribute:: label
      :type:  str


   .. py:attribute:: size
      :type:  int


   .. py:attribute:: textSize
      :type:  int


   .. py:attribute:: tickfont
      :type:  int


.. py:class:: Axes

   Bases: :py:obj:`TypedDict`


   dict() -> new empty dictionary
   dict(mapping) -> new dictionary initialized from a mapping object's
       (key, value) pairs
   dict(iterable) -> new dictionary initialized as if via:
       d = {}
       for k, v in iterable:
           d[k] = v
   dict(**kwargs) -> new dictionary initialized with the name=value pairs
       in the keyword argument list.  For example:  dict(one=1, two=2)


   .. py:attribute:: x
      :type:  AxisProperties


   .. py:attribute:: y
      :type:  AxisProperties


.. py:class:: ScatterChart

   Bases: :py:obj:`BaseChart`, :py:obj:`ColorProperties`


   .. py:attribute:: type
      :type:  Literal['wgl_scatter_plot']


   .. py:attribute:: axis
      :type:  Axes


.. py:function:: StackedRowChart(**kwargs: BaseChart | ColorProperties)