bencher.results.composable_container.composable_container_panel
===============================================================

.. py:module:: bencher.results.composable_container.composable_container_panel


Classes
-------

.. autoapisummary::

   bencher.results.composable_container.composable_container_panel.ComposableContainerPanel


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

.. py:class:: ComposableContainerPanel

   Bases: :py:obj:`bencher.results.composable_container.composable_container_base.ComposableContainerBase`


   A base class for renderer backends.  A composable renderer


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



   .. py:attribute:: var_name
      :type:  str | None
      :value: None



   .. py:attribute:: var_value
      :type:  str | None
      :value: None



   .. py:attribute:: width
      :type:  int | None
      :value: None



   .. py:attribute:: background_col
      :type:  str | None
      :value: None



   .. py:attribute:: horizontal
      :type:  bool | None
      :value: None



   .. py:method:: __post_init__() -> None


   .. py:method:: append(obj)

      Add an object to the container.  The relationship between the objects is defined by the ComposeType

      :param obj: Object to add to the container
      :type obj: Any



   .. py:method:: render()

      Return a representation of the container that can be composed with other render() results. This function can also be used to defer layout and rending options until all the information about the container content is known.  You may need to override this method depending on the container. See composable_container_video as an example.

      :returns: Visual representation of the container that can be combined with other containers
      :rtype: Any