cobramod.visualization.escher
=============================

.. py:module:: cobramod.visualization.escher

.. autoapi-nested-parse::

   .. versionadded:: 1.3.0

   This module contains an alternative Python integration for `Escher <https://github.com/zakandrewking/escher>`_ .



Classes
-------

.. autoapisummary::

   cobramod.visualization.escher.ReactionScale
   cobramod.visualization.escher.EscherIntegration


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

.. py:class:: ReactionScale

   Bases: :py:obj:`TypedDict`


   .. versionadded:: 1.3.0

   A Python class that represents the options available in Escher. It defines one point on the color scale.

   :param type: The type of definition. A specific value can be used here (value), by means of
                quantiles (“Q1” or “Q3”) or by means of minimum maximum median or mean.
   :type type: Literal["min", "max", "mean", "median", "Q1", "Q3", "value"]
   :param value: It is only used to set the value if type value was used.
   :type value: Optional[float]
   :param color: The color to be used for the specified area.
   :type color: str
   :param size: The width of the reactions covered by this definition.
   :type size: int

   .. rubric:: Notes

   ReactionScale should only be an orientation for the possible options in Python. For further explanations and
   examples, please refer to `Escher's JavaScript documentation for 'escher.Builder.options.reaction_scale'. <https://escher.readthedocs.io/en/latest/javascript_api.html#escher.Builder.options.reaction_scale>`_


   .. py:attribute:: type
      :type:  Literal['min', 'max', 'mean', 'median', 'Q1', 'Q3', 'value']


   .. py:attribute:: value
      :type:  Optional[float]


   .. py:attribute:: color
      :type:  str


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


.. py:class:: EscherIntegration(map_name = None, map_json = None, reaction_data = None, reaction_scale = None, reaction_styles = None, never_ask_before_quit = False)

   Bases: :py:obj:`anywidget.AnyWidget`


   .. versionadded:: 1.3.0

   An alternative Python integration for `Escher <https://github.com/zakandrewking/escher>`_ .



   .. py:attribute:: reaction_styles
      :type:  Optional[List[Any]]


   .. py:attribute:: map_name


   .. py:attribute:: map_json


   .. py:attribute:: reaction_scale


   .. py:attribute:: reaction_data
      :type:  Optional[Dict[str, float]]


   .. py:attribute:: never_ask_before_quit


   .. py:property:: model_data


   .. py:property:: embedded_css


   .. py:property:: options


   .. py:method:: save_html(filepath)

      This method creates a standalone HTML file that contains all the data of the
      Escher map and loads it automatically when it is opened.

      :param filepath: The file in which the HTML file is to be saved.