bundle.website.builtin.components.graphic
=========================================

.. py:module:: bundle.website.builtin.components.graphic

.. autoapi-nested-parse::

   Graphics component foundations (base, 2D, 3D).



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/bundle/website/builtin/components/graphic/base/index
   /autoapi/bundle/website/builtin/components/graphic/threeD/index
   /autoapi/bundle/website/builtin/components/graphic/twoD/index


Classes
-------

.. autoapisummary::

   bundle.website.builtin.components.graphic.GraphicBaseComponent
   bundle.website.builtin.components.graphic.GraphicComponentParams
   bundle.website.builtin.components.graphic.GraphicThreeDComponent
   bundle.website.builtin.components.graphic.GraphicThreeDComponentParams
   bundle.website.builtin.components.graphic.GraphicTwoDComponent
   bundle.website.builtin.components.graphic.GraphicTwoDComponentParams


Package Contents
----------------

.. py:class:: GraphicBaseComponent(/, **data: Any)

   Bases: :py:obj:`bundle.website.core.component.Component`


   Base graphics component with shared typed params.


   .. py:attribute:: params
      :type:  GraphicComponentParams
      :value: None



.. py:class:: GraphicComponentParams(/, **data: Any)

   Bases: :py:obj:`bundle.core.data.Data`


   Shared parameters for graphics component instances.


   .. py:attribute:: graph_id
      :type:  str
      :value: 'graphics'



   .. py:attribute:: render_mode
      :type:  str
      :value: 'base'



.. py:class:: GraphicThreeDComponent(/, **data: Any)

   Bases: :py:obj:`bundle.website.builtin.components.graphic.base.GraphicBaseComponent`


   Base class for Three.js/WebGL style 3D graphics components.


   .. py:attribute:: params
      :type:  GraphicThreeDComponentParams
      :value: None



.. py:class:: GraphicThreeDComponentParams(/, **data: Any)

   Bases: :py:obj:`bundle.website.builtin.components.graphic.base.GraphicComponentParams`


   Shared parameters for 3D graphics components.


   .. py:attribute:: render_mode
      :type:  str
      :value: '3d'



   .. py:attribute:: camera_mode
      :type:  str
      :value: 'orbit'



   .. py:attribute:: field_of_view
      :type:  float
      :value: 40.0



   .. py:attribute:: near
      :type:  float
      :value: 0.1



   .. py:attribute:: far
      :type:  float
      :value: 100.0



.. py:class:: GraphicTwoDComponent(/, **data: Any)

   Bases: :py:obj:`bundle.website.builtin.components.graphic.base.GraphicBaseComponent`


   Base class for canvas/SVG style 2D graphics components.


   .. py:attribute:: params
      :type:  GraphicTwoDComponentParams
      :value: None



.. py:class:: GraphicTwoDComponentParams(/, **data: Any)

   Bases: :py:obj:`bundle.website.builtin.components.graphic.base.GraphicComponentParams`


   Shared parameters for 2D graphics components.


   .. py:attribute:: render_mode
      :type:  str
      :value: '2d'



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



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



   .. py:attribute:: device_pixel_ratio_cap
      :type:  float
      :value: 2.0