.. include:: ../../toolkit-substitutions

.. oe:namespace:: OEGrapheme

.. oe:class:: OEMonomerGraphDisplayOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEMonomerGraphDisplayOptions

   The :oe:cls:`OEGrapheme::OEMonomerGraphDisplayOptions` class
   is used to customize molecule depiction when using  :oe:cls:`OEGrapheme::OEDrawMonomerGraph` function.
   
   .. only:: oehtml

      .. raw:: html

         <p align="center">
         <b>hover cursor over graph</b>
         </p>

         <p align="center">
         <object data="../../_images/DrawMonomerGraph.svg" type="image/svg+xml"  width = "500" ></object>
         <p>

         <p align="center">
         <b>Example of using the OEDrawMonomerGraph function</b>
         <p>

      .. image:: ../images/DrawMonomerGraph.svg
         :width: 1pt

   .. only:: oepdf

      .. figure:: ../images/DrawMonomerGraph.*
         :align:  center

         **Example of using the OEDrawMonomerGraph function**

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMonomerGraphDisplayOptions()

      .. oe:language:: python

         .. oe:api:: python

            OEMonomerGraphDisplayOptions() -> OEMonomerGraphDisplayOptions

      Default constructor.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEMonomerGraphDisplayOptions(const OEMonomerGraphDisplayOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEMonomerGraphDisplayOptions(rhs: OEMonomerGraphDisplayOptions) -> OEMonomerGraphDisplayOptions

      Copy constructor.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEMonomerGraphDisplayOptions &operator=(const OEMonomerGraphDisplayOptions &rhs)

      Assignment operator.

   .. oe:method:: GetInteractiveEffect

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetInteractiveEffect() const

      .. oe:language:: python

         .. oe:api:: python

            GetInteractiveEffect() -> int

      Returns the interactive effect of the generated :file:`svg` image.

   .. oe:method:: GetMonomerColorFunctor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEMonomerColorBase& GetMonomerColorFunctor() const

      .. oe:language:: python

         .. oe:api:: python

            GetMonomerColorFunctor() -> OEMonomerColorBase

      Returns the functor that is used to determine the color used to draw the glyph representing the monomer.
      By default, the :oe:cls:`OEGrapheme::OEMonomerColorDefault` functor is used.

   .. oe:method:: GetMonomerScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetMonomerScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetMonomerScale() -> float

      Returns the scaling factor of monomer components in interactive mode.

   .. oe:method:: GetMonomerGlyphStyleFunctor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEMonomerGlyphStyleBase& GetMonomerGlyphStyleFunctor() const

      .. oe:language:: python

         .. oe:api:: python

            GetMonomerGlyphStyleFunctor() -> OEMonomerGlyphStyleBase

      Returns the functor that is used to determine the circle style used to draw the glyph representing the monomer.
      By default, the :oe:cls:`OEGrapheme::OEMonomerGlyphStyleDefault` functor is used.

   .. oe:method:: GetMonomerLabelColorFunctor

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEMonomerColorBase& GetMonomerLabelColorFunctor() const

      .. oe:language:: python

         .. oe:api:: python

            GetMonomerLabelColorFunctor() -> OEMonomerColorBase

      Returns the functor that is used to determine the color of the font used to depict the monomer code.
      By default, the :oe:cls:`OEGrapheme::OEMonomerColorMonochrome` functor is used
      to set all monomer code fonts to black.


   .. oe:method:: SetInteractiveEffect

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetInteractiveEffect(const unsigned effect)

      .. oe:language:: python

         .. oe:api:: python

            SetInteractiveEffect(effect: int) -> None

      Sets the interactive effect of the generated :file:`svg` image.
      In interactive mode, the structures of the monomers that make up the molecule 
      are shown on mouse-over or mouse-click.

      .. seealso::

         * :oe:constns:`OEDepict::OEInteractiveEffect` namespace for available interactive effects.

   .. oe:method:: SetMonomerColorFunctor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMonomerColorFunctor(const OEMonomerColorBase& func)

      .. oe:language:: python

         .. oe:api:: python

            SetMonomerColorFunctor(func: OEMonomerColorBase) -> None

      Sets the functor that is used to determine the color used to draw the glyph representing the monomer.

   .. oe:method:: SetMonomerScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMonomerScale(const double scale)

      .. oe:language:: python

         .. oe:api:: python

            SetMonomerScale(scale: float) -> None

      Sets the scaling factor of monomer components in interactive mode.

      scale
         This value has to be in a range of [0.25, 0.75]. The default value is 0.50.

      .. note::

         This option has to be used along with the
         :oe:meth:`OEGrapheme::OEMonomerGraphDisplayOptions::SetInteractiveEffect` method

   .. oe:method:: SetMonomerGlyphStyleFunctor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMonomerGlyphStyleFunctor(const OEMonomerGlyphStyleBase& func)

      .. oe:language:: python

         .. oe:api:: python

            SetMonomerGlyphStyleFunctor(func: OEMonomerGlyphStyleBase) -> None

      Sets the functor that is used to determine the circle style used to draw the glyph representing the monomer.

   .. oe:method:: SetMonomerLabelColorFunctor

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetMonomerLabelColorFunctor(const OEMonomerColorBase& func)

      .. oe:language:: python

         .. oe:api:: python

            SetMonomerLabelColorFunctor(func: OEMonomerColorBase) -> None

      Sets the functor that is used to determine the color of the font used to depict the monomer code.
