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

.. oe:namespace:: OEDepict

.. meta::
   :keywords: OE2DMolDisplayOptions, 2DMolDisplayOptions


.. _OEDepict_OE2DMolDisplayOptions:

.. oe:class:: OE2DMolDisplayOptions

   .. oe:api::

      class OE2DMolDisplayOptions

   This class represents the :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` class
   that encapsulates properties that determine how a molecule is depicted.

   The :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` class stores the following properties:

   .. list-table::
      :widths: 100 100 100 150
      :header-rows: 1

      * - Property
        - Get method
        - Set method
        - Corresponding namespace / class / type

      * - aromatic style
        - :oe:meth:`GetAromaticStyle<OEDepict::OE2DMolDisplayOptions::GetAromaticStyle>`
        - :oe:meth:`SetAromaticStyle<OEDepict::OE2DMolDisplayOptions::SetAromaticStyle>`
        - :oe:constns:`OEDepict::OEAromaticStyle`

      * - atomic number colors
        - :oe:meth:`GetAtomColor<OEDepict::OE2DMolDisplayOptions::GetAtomColor>`
        - :oe:meth:`SetAtomColor<OEDepict::OE2DMolDisplayOptions::SetAtomColor>`
        - :ref:`OEColor <OESystem_OEColor>`

      * - atom color style
        - :oe:meth:`GetAtomColorStyle<OEDepict::OE2DMolDisplayOptions::GetAtomColorStyle>`
        - :oe:meth:`SetAtomColorStyle<OEDepict::OE2DMolDisplayOptions::SetAtomColorStyle>`
        - :oe:constns:`OEDepict::OEAtomColorStyle`

      * - atom label font
        - :oe:meth:`GetAtomLabelFont<OEDepict::OE2DMolDisplayOptions::GetAtomLabelFont>`
        - :oe:meth:`SetAtomLabelFont<OEDepict::OE2DMolDisplayOptions::SetAtomLabelFont>`
        - :ref:`OEFont <OEDepict_OEFont>`

      * - atom label font scale
        - :oe:meth:`GetAtomLabelFontScale<OEDepict::OE2DMolDisplayOptions::GetAtomLabelFontScale>`
        - :oe:meth:`SetAtomLabelFontScale<OEDepict::OE2DMolDisplayOptions::SetAtomLabelFontScale>`
        - positive floating point number in the range of ``[0.5, 3.0]`` or ``0.0``

      * - atom property font
        - :oe:meth:`GetAtomPropLabelFont<OEDepict::OE2DMolDisplayOptions::GetAtomPropLabelFont>`
        - :oe:meth:`SetAtomPropLabelFont<OEDepict::OE2DMolDisplayOptions::SetAtomPropLabelFont>`
        - :ref:`OEFont <OEDepict_OEFont>`

      * - atom property label font scale
        - :oe:meth:`GetAtomPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::GetAtomPropLabelFontScale>`
        - :oe:meth:`SetAtomPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::SetAtomPropLabelFontScale>`
        - positive floating point number in the range of ``[0.5, 2.0]``

      * - atom property initializer
        - :oe:meth:`GetAtomPropertyFunctor<OEDepict::OE2DMolDisplayOptions::GetAtomPropertyFunctor>`
        - :oe:meth:`SetAtomPropertyFunctor<OEDepict::OE2DMolDisplayOptions::SetAtomPropertyFunctor>`
        - :ref:`OEDisplayAtomPropBase <OEDepict_OEDisplayAtomPropBase>`

      * - atom stereo style
        - :oe:meth:`GetAtomStereoStyle<OEDepict::OE2DMolDisplayOptions::GetAtomStereoStyle>`
        - :oe:meth:`SetAtomStereoStyle<OEDepict::OE2DMolDisplayOptions::SetAtomStereoStyle>`
        - :oe:constns:`OEDepict::OEAtomStereoStyle`

      * - atom SVG markup
        - :oe:meth:`GetAtomSVGMarkupFunctor<OEDepict::OE2DMolDisplayOptions::GetAtomSVGMarkupFunctor>`
        - :oe:meth:`SetAtomSVGMarkupFunctor<OEDepict::OE2DMolDisplayOptions::SetAtomSVGMarkupFunctor>`
        - :ref:`OEAtomSVGMarkupBase <OEDepict_OEAtomSVGMarkupBase>`

      * - atom visibility initializer
        - :oe:meth:`GetAtomVisibilityFunctor<OEDepict::OE2DMolDisplayOptions::GetAtomVisibilityFunctor>`
        - :oe:meth:`SetAtomVisibilityFunctor<OEDepict::OE2DMolDisplayOptions::SetAtomVisibilityFunctor>`
        - :oe:cls:`OEUnaryAtomPred<OESystem::OEUnaryPredicate>`

      * - background color
        - :oe:meth:`GetBackgroundColor<OEDepict::OE2DMolDisplayOptions::GetBackgroundColor>`
        - :oe:meth:`SetBackgroundColor<OEDepict::OE2DMolDisplayOptions::SetBackgroundColor>`
        - :ref:`OEColor <OESystem_OEColor>`

      * - bond color style
        - :oe:meth:`GetBondColorStyle<OEDepict::OE2DMolDisplayOptions::GetBondColorStyle>`
        - :oe:meth:`SetBondColorStyle<OEDepict::OE2DMolDisplayOptions::SetBondColorStyle>`
        - :oe:constns:`OEDepict::OEBondColorStyle`

      * - bond line gap scale
        - :oe:meth:`GetBondLineGapScale<OEDepict::OE2DMolDisplayOptions::GetBondLineGapScale>`
        - :oe:meth:`SetBondLineGapScale<OEDepict::OE2DMolDisplayOptions::SetBondLineGapScale>`
        - positive floating point number in the range of ``[0.5, 2.0]``

      * - bond line atom label gap scale
        - :oe:meth:`GetBondLineAtomLabelGapScale<OEDepict::OE2DMolDisplayOptions::GetBondLineAtomLabelGapScale>`
        - :oe:meth:`SetBondLineAtomLabelGapScale<OEDepict::OE2DMolDisplayOptions::SetBondLineAtomLabelGapScale>`
        - positive floating point number in the range of ``[0.5, 2.0]``

      * - bond property font
        - :oe:meth:`GetBondPropLabelFont<OEDepict::OE2DMolDisplayOptions::GetBondPropLabelFont>`
        - :oe:meth:`SetBondPropLabelFont<OEDepict::OE2DMolDisplayOptions::SetBondPropLabelFont>`
        - :ref:`OEFont <OEDepict_OEFont>`

      * - bond property label font scale
        - :oe:meth:`GetBondPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::GetBondPropLabelFontScale>`
        - :oe:meth:`SetBondPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::SetBondPropLabelFontScale>`
        - positive floating point number in the range of ``[0.5, 2.0]``

      * - bond property initializer
        - :oe:meth:`GetBondPropertyFunctor<OEDepict::OE2DMolDisplayOptions::GetBondPropertyFunctor>`
        - :oe:meth:`SetBondPropertyFunctor<OEDepict::OE2DMolDisplayOptions::SetBondPropertyFunctor>`
        - :ref:`OEDisplayBondPropBase <OEDepict_OEDisplayBondPropBase>`

      * - bond stereo style
        - :oe:meth:`GetBondStereoStyle<OEDepict::OE2DMolDisplayOptions::GetBondStereoStyle>`
        - :oe:meth:`SetBondStereoStyle<OEDepict::OE2DMolDisplayOptions::SetBondStereoStyle>`
        - :oe:constns:`OEDepict::OEBondStereoStyle`

      * - bond pen
        - :oe:meth:`GetDefaultBondPen<OEDepict::OE2DMolDisplayOptions::GetDefaultBondPen>`
        - :oe:meth:`SetDefaultBondPen<OEDepict::OE2DMolDisplayOptions::SetDefaultBondPen>`
        - :ref:`OEPen <OEDepict_OEPen>`

      * - bond width scaling
        - :oe:meth:`GetBondWidthScaling<OEDepict::OE2DMolDisplayOptions::GetBondWidthScaling>`
        - :oe:meth:`SetBondWidthScaling<OEDepict::OE2DMolDisplayOptions::SetBondWidthScaling>`
        - boolean

      * - bond SVG markup
        - :oe:meth:`GetBondSVGMarkupFunctor<OEDepict::OE2DMolDisplayOptions::GetBondSVGMarkupFunctor>`
        - :oe:meth:`SetBondSVGMarkupFunctor<OEDepict::OE2DMolDisplayOptions::SetBondSVGMarkupFunctor>`
        - :ref:`OEBondSVGMarkupBase <OEDepict_OEBondSVGMarkupBase>`

      * - explicit atom label angle
        - :oe:meth:`GetExplicitAtomLabelAngle<OEDepict::OE2DMolDisplayOptions::GetExplicitAtomLabelAngle>`
        - :oe:meth:`SetExplicitAtomLabelAngle<OEDepict::OE2DMolDisplayOptions::SetExplicitAtomLabelAngle>`
        - positive floating point number in the range of ``[120.0, 180.0]``

      * - height
        - :oe:meth:`GetHeight<OEDepict::OE2DMolDisplayOptions::GetHeight>`
        - :oe:meth:`SetHeight<OEDepict::OE2DMolDisplayOptions::SetHeight>`
        - positive floating point number

      * - hydrogen style
        - :oe:meth:`GetHydrogenStyle<OEDepict::OE2DMolDisplayOptions::GetHydrogenStyle>`
        - :oe:meth:`SetHydrogenStyle<OEDepict::OE2DMolDisplayOptions::SetHydrogenStyle>`
        - :oe:constns:`OEDepict::OEHydrogenStyle`

      * - margin(s)
        - :oe:meth:`GetMargin<OEDepict::OE2DMolDisplayOptions::GetMargin>`
        - :oe:meth:`SetMargin<OEDepict::OE2DMolDisplayOptions::SetMargin>`, :oe:meth:`SetMargins<OEDepict::OE2DMolDisplayOptions::SetMargins>`
        - positive floating point number in the range of ``[2.5, 25.0]``

      * - scale
        - :oe:meth:`GetScale<OEDepict::OE2DMolDisplayOptions::GetScale>`
        - :oe:meth:`SetScale<OEDepict::OE2DMolDisplayOptions::SetScale>`
        - positive floating point number

      * - super atom label font
        - :oe:meth:`GetSuperAtomLabelFont<OEDepict::OE2DMolDisplayOptions::GetSuperAtomLabelFont>`
        - :oe:meth:`SetSuperAtomLabelFont<OEDepict::OE2DMolDisplayOptions::SetSuperAtomLabelFont>`
        - :ref:`OEFont <OEDepict_OEFont>`

      * - super atom display style
        - :oe:meth:`GetSuperAtomStyle<OEDepict::OE2DMolDisplayOptions::GetSuperAtomStyle>`
        - :oe:meth:`SetSuperAtomStyle<OEDepict::OE2DMolDisplayOptions::SetSuperAtomStyle>`
        - :oe:constns:`OEDepict::OESuperAtomStyle`

      * - protective group label font
        - :oe:meth:`GetProtectiveGroupLabelFont<OEDepict::OE2DMolDisplayOptions::GetProtectiveGroupLabelFont>`
        - :oe:meth:`SetProtectiveGroupLabelFont<OEDepict::OE2DMolDisplayOptions::SetProtectiveGroupLabelFont>`
        - :ref:`OEFont <OEDepict_OEFont>`

      * - protective group display style
        - :oe:meth:`HasProtectiveGroupStyle<OEDepict::OE2DMolDisplayOptions::HasProtectiveGroupStyle>`
        - :oe:meth:`SetProtectiveGroupStyle<OEDepict::OE2DMolDisplayOptions::SetProtectiveGroupStyle>`
        - :oe:constns:`OEDepict::OEProtectiveGroupStyle`

      * - title font
        - :oe:meth:`GetTitleFont<OEDepict::OE2DMolDisplayOptions::GetTitleFont>`
        - :oe:meth:`SetTitleFont<OEDepict::OE2DMolDisplayOptions::SetTitleFont>`
        - :ref:`OEFont <OEDepict_OEFont>`

      * - title font scale
        - :oe:meth:`GetTitleFontScale<OEDepict::OE2DMolDisplayOptions::GetTitleFontScale>`
        - :oe:meth:`SetTitleFontScale<OEDepict::OE2DMolDisplayOptions::SetTitleFontScale>`
        - positive floating point number in the range of ``[0.5, 2.0]`` or ``0.0``

      * - title height
        - :oe:meth:`GetTitleHeight<OEDepict::OE2DMolDisplayOptions::GetTitleHeight>`
        - :oe:meth:`SetTitleHeight<OEDepict::OE2DMolDisplayOptions::SetTitleHeight>`
        - :oe:constns:`OEDepict::OETitleLocation`

      * - title location
        - :oe:meth:`GetTitleLocation<OEDepict::OE2DMolDisplayOptions::GetTitleLocation>`
        - :oe:meth:`SetTitleLocation<OEDepict::OE2DMolDisplayOptions::SetTitleLocation>`
        - :oe:constns:`OEDepict::OETitleLocation`

      * - width
        - :oe:meth:`GetWidth<OEDepict::OE2DMolDisplayOptions::GetWidth>`
        - :oe:meth:`SetWidth<OEDepict::OE2DMolDisplayOptions::SetWidth>`
        - positive floating point number


   The images below illustrate the three possible molecule display layouts depending on the position of the title.
   These layouts can be controlled by the following parameters:

   * The width and the height can be set either by the constructor of the
     :oe:meth:`OE2DMolDisplayOptions<OEDepict::OE2DMolDisplayOptions::Constructors>` class,
     by calling the :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetDimensions` method or by the
     :oe:meth:`SetWidth<OEDepict::OE2DMolDisplayOptions::SetWidth>` and
     :oe:meth:`SetHeight<OEDepict::OE2DMolDisplayOptions::SetHeight>` methods, respectively.

   * The location of the title area (blue box) can be set by the
     :oe:meth:`SetTitleLocation<OEDepict::OE2DMolDisplayOptions::SetTitleLocation>` method.
     The height of the title area (blue arrows) can be modified by invoking
     the :oe:meth:`SetTitleHeight<OEDepict::OE2DMolDisplayOptions::SetTitleHeight>` method.

   * The padding around the molecule (red arrows) can be changed by calling either the
     :oe:meth:`SetMargin<OEDepict::OE2DMolDisplayOptions::SetMargin>` or the
     :oe:meth:`SetMargins<OEDepict::OE2DMolDisplayOptions::SetMargins>` methods.

   .. _table_moldisplay_layouts:

   .. list-table:: **Example of molecule display layouts depending on position of the title**
      :widths: 250 250 250
      :header-rows: 1

      * - title hidden
        - title at the top
        - title at the bottom

      * - .. image:: ../images/OE2DMolDisplayLayout_TitleHidden.*
        - .. image:: ../images/OE2DMolDisplayLayout_TitleTop.*
        - .. image:: ../images/OE2DMolDisplayLayout_TitleBottom.*

   .. seealso::

      * :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` class
      * :ref:`section_mol_display_size` section

   .. hint::

      Even though **OEDepict TK** provides access to manipulate the
      properties of the atom and bond displays after the
      :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object is constructed,
      it is highly recommended to determine the style of the depiction by using
      the :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` class.
      Only by knowing all properties (such as labels, font styles and sizes *etc.*)
      in advance can ensure the **best depiction layout** *i.e.* that
      the molecule diagram is rendered without any label clippings
      and the labels are displayed with the minimum number of overlaps.

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

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

         .. oe:api::

            OE2DMolDisplayOptions()

      .. oe:language:: python

         .. oe:api:: python

            OE2DMolDisplayOptions() -> OE2DMolDisplayOptions

      Default constructor that initializes an :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>`
      object with the following properties:

      See example in :ref:`Molecule depiction with default options<figure_OE2DMolDisplayOptions_Default>`)

      .. list-table::  **Default parameters of OE2DMolDisplayOptions**
         :widths: 100 100
         :header-rows: 1

         * - Property
           - Default value

         * - aromatic style
           - :oe:const:`OEDepict::OEAromaticStyle::Default`

         * - atomic number colors
           - initialized based on :oe:const:`OEDepict::OEAtomColorStyle::Default`

         * - atom color style
           - :oe:const:`OEDepict::OEAtomColorStyle::Default`

         * - atom label font
           - :oe:const:`OEDepict::OEDepict::OEDefaultFont`

         * - atom label font scale
           - 1.0

         * - atom property font
           - OEFont(OEColor(75, 75, 75))

         * - atom property label font scale
           - 1.0

         * - atom property initializer
           - :ref:`OEDisplayNoAtomProp <OEDepict_OEDisplayNoAtomProp>`

         * - atom stereo style
           - :oe:const:`OEDepict::OEAtomStereoStyle::Default`

         * - atom SVG markup
           - :ref:`OEAtomSVGNoMarkup <OEDepict_OEAtomSVGNoMarkup>`

         * - atom visibility initializer
           - :oe:cls:`OEIsTrueAtom<OESystem::OEIsTrue>`

         * - background color
           - :oe:const:`OEDepict::OEDepict::OELightBackgroundColor` initialized based on :oe:const:`OEDepict::OEAtomColorStyle::Default`

         * - bond color style
           - :oe:const:`OEDepict::OEBondColorStyle::Default`

         * - bond line gap scale
           - 1.0

         * - bond line atom label gap scale
           - 1.0

         * - bond property font
           - OEFont(OEColor(75, 75, 75))

         * - bond property label font scale
           - 1.0

         * - bond property initializer
           - :ref:`OEDisplayNoBondProp <OEDepict_OEDisplayNoBondProp>`

         * - bond stereo style
           - :oe:const:`OEDepict::OEBondStereoStyle::Default`

         * - bond pen
           - :oe:const:`OEDepict::OEDepict::OEBlackPen`

         * - bond width scaling
           - `false`

         * - bond SVG markup
           - :ref:`OEBondSVGNoMarkup <OEDepict_OEBondSVGNoMarkup>`

         * - explicit atom label angle
           - 170.0 (degree)

         * - height
           - 0.0 (initialized based on scale)

         * - hydrogen style
           - :oe:const:`OEDepict::OEHydrogenStyle::Default`

         * - margins
           - left and right margin `5.0%` of the width; top and bottom margin `5.0%` of the height of the molecule display

         * - scale
           - :oe:const:`OEDepict::OEScale::AutoScale`

         * - super atom label font
           - OEFont(OEPink)

         * - super atom display style
           - :oe:const:`OEDepict::OESuperAtomStyle::Default`

         * - protective group label font
           - OEFont(OEPink)

         * - protective group display style
           - :oe:const:`OEDepict::OEProtectiveGroupStyle::Default`

         * - title font
           - :oe:const:`OEDepict::OEDepict::OEDefaultFont`

         * - title font scale
           - 1.0

         * - title location
           - :oe:const:`OEDepict::OETitleLocation::Default`

         * - title height
           - `10%` of the height of the molecule display

         * - width
           - 0.0 (initialized based on scale)


      .. _figure_OE2DMolDisplayOptions_Default:

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

         **Molecule depiction with default options**

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

         .. oe:api::

            OE2DMolDisplayOptions(double scale)

      .. oe:language:: python

         .. oe:api:: python

            OE2DMolDisplayOptions(scale: float) -> OE2DMolDisplayOptions

      Creates an :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` object with
      the specified scaling.

      *scale*
        A non-negative number that controls the magnification of the
        depicted molecule.

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

         .. oe:api::

            OE2DMolDisplayOptions(double width, double height, double scale)

      .. oe:language:: python

         .. oe:api:: python

            OE2DMolDisplayOptions(width: float, height: float, scale: float) -> OE2DMolDisplayOptions

      Creates an :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` object with
      the specified dimension and scaling.

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

         .. oe:api::

            OE2DMolDisplayOptions(const OE2DMolDisplayOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OE2DMolDisplayOptions(rhs: OE2DMolDisplayOptions) -> OE2DMolDisplayOptions

      Copy constructor.


   .. ################################################################
      # operator=
      ################################################################

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

      .. oe:api::

         OE2DMolDisplayOptions &operator=(const OE2DMolDisplayOptions &rhs)

      Assignment operator.


   .. _OEDepict_GetAromaticStyle:


   .. oe:method:: GetAromaticStyle


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

         .. oe:api::

            unsigned int GetAromaticStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetAromaticStyle() -> int

      Returns the style that controls how aromatic rings are displayed.
      The return value is taken from the :oe:constns:`OEDepict::OEAromaticStyle`
      namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAromaticStyle` method
         * :oe:constns:`OEDepict::OEAromaticStyle` namespace


   .. _OEDepict_GetAtomSVGMarkupFunctor:


   .. oe:method:: GetAtomSVGMarkupFunctor


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

         .. oe:api::

            const OEAtomSVGMarkupBase& GetAtomSVGMarkupFunctor() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomSVGMarkupFunctor() -> OEAtomSVGMarkupBase

      Returns the functor that defines how atoms are marked in
      :file:`svg` image.
      By default, residues are not marked (:ref:`OEAtomSVGNoMarkup <OEDepict_OEAtomSVGNoMarkup>`).

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomSVGMarkupFunctor` method


   .. _OEDepict_GetAtomColor:


   .. oe:method:: GetAtomColor


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

         .. oe:api::

            const OESystem::OEColor& GetAtomColor(unsigned int atomic) const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomColor(atomic: int) -> OEColor

      Returns the color associated with a specific atomic number.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomColor` method
         * :ref:`OEColor <OESystem_OEColor>` class
         * :ref:`chapter_element_color` section


   .. _OEDepict_GetAtomColorStyle:


   .. oe:method:: GetAtomColorStyle


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

         .. oe:api::

            unsigned int GetAtomColorStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomColorStyle() -> int

      Returns the style that is used to define the color of the
      background and the default color of atom labels.
      The return value is taken from the :oe:constns:`OEDepict::OEAtomColorStyle`
      namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomColorStyle` method
         * :oe:constns:`OEDepict::OEAtomColorStyle` namespace


   .. _OEDepict_GetAtomLabelFont:


   .. oe:method:: GetAtomLabelFont


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

         .. oe:api::

            const OEFont& GetAtomLabelFont() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomLabelFont() -> OEFont

      Returns the font that is used to initialize the depiction style
      of the atom labels
      (:oe:meth:`OEDepict::OE2DAtomDisplay::GetLabelFont`).

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomLabelFont` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomLabelFontScale` method
         * :ref:`OEFont <OEDepict_OEFont>` class


   .. _OEDepict_GetAtomLabelFontScale:


   .. oe:method:: GetAtomLabelFontScale


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

         .. oe:api::

            double GetAtomLabelFontScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomLabelFontScale() -> float

      Returns the multiplier that can be used to increase or decrease
      the size of the atom label fonts.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomLabelFont` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomLabelFontScale` method


   .. _OEDepict_GetAtomPropLabelFont:


   .. oe:method:: GetAtomPropLabelFont


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

         .. oe:api::

            const OEFont& GetAtomPropLabelFont() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomPropLabelFont() -> OEFont

      Returns the font that is used to initialize the depiction style
      of the atom property labels
      (:oe:meth:`OEDepict::OE2DAtomDisplay::GetPropertyFont`).

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomPropLabelFont` method
         * :ref:`OEFont <OEDepict_OEFont>` class

   .. _OEDepict_GetAtomPropLabelFontScale:


   .. oe:method:: GetAtomPropLabelFontScale


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

         .. oe:api::

            double GetAtomPropLabelFontScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomPropLabelFontScale() -> float

      Returns the multiplier that can be used to increase or decrease
      the size of the atom property label fonts.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomPropLabelFont` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomPropLabelFontScale` method


   .. _OEDepict_GetAtomPropertyFunctor:


   .. oe:method:: GetAtomPropertyFunctor


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

         .. oe:api::

            const OEDisplayAtomPropBase& GetAtomPropertyFunctor() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomPropertyFunctor() -> OEDisplayAtomPropBase

      Returns the functor that is used to initialize the atom property
      labels (:oe:meth:`OEDepict::OE2DAtomDisplay::GetProperty`).

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomPropertyFunctor` method
         * :ref:`OEDisplayAtomPropBase <OEDepict_OEDisplayAtomPropBase>` class
         * :ref:`OEDisplayAtomIdx <OEDepict_OEDisplayAtomIdx>` class
         * :ref:`OEDisplayAtomMapIdx <OEDepict_OEDisplayAtomMapIdx>` class
         * :ref:`OEDisplayNoAtomProp <OEDepict_OEDisplayNoAtomProp>` class


   .. _OEDepict_GetAtomVisibilityFunctor:


   .. oe:method:: GetAtomVisibilityFunctor


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

         .. oe:api::

            const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& GetAtomVisibilityFunctor() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomVisibilityFunctor() -> OEUnaryAtomPred

      Returns the functor that is used to identify visible atoms.  The default
      functor is the :oe:cls:`OEIsTrueAtom<OESystem::OEIsTrue>` class which
      results in all atoms being displayed.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomVisibilityFunctor` method
         * :oe:cls:`OEUnaryAtomPred<OESystem::OEUnaryPredicate>`

   .. _OEDepict_GetAtomStereoStyle:


   .. oe:method:: GetAtomStereoStyle


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

         .. oe:api::

            unsigned int GetAtomStereoStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomStereoStyle() -> int

      Returns the style that controls what atom stereo information is displayed.
      The return value is taken from the :oe:constns:`OEDepict::OEAtomStereoStyle`
      namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomStereoStyle` method
         * :oe:constns:`OEDepict::OEAtomStereoStyle` namespace


   .. _OEDepict_GetBackgroundColor:


   .. oe:method:: GetBackgroundColor


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

         .. oe:api::

            const OESystem::OEColor& GetBackgroundColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetBackgroundColor() -> OEColor

      Returns the color that is used to clear the background of an image
      (by calling :oe:meth:`OEDepict::OEImageBase::Clear` method)
      before rendering the molecule.


      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBackgroundColor` method
         * :ref:`OEColor <OESystem_OEColor>` class
         * :oe:func:`OEDepict::OERenderMolecule` function


   .. _OEDepict_GetBondColorStyle:


   .. oe:method:: GetBondColorStyle


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

         .. oe:api::

            unsigned int GetBondColorStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetBondColorStyle() -> int

      Returns the style that controls how bonds are colored.
      The return value is taken from the :oe:constns:`OEDepict::OEBondColorStyle`
      namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondColorStyle` method
         * :oe:constns:`OEDepict::OEBondColorStyle` namespace


   .. _OEDepict_GetBondLineGapScale:


   .. oe:method:: GetBondLineGapScale


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

         .. oe:api::

            double GetBondLineGapScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetBondLineGapScale() -> float

      Returns the multiplier that can be used to increase or decrease
      the gap between the lines of double and triple bonds.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondLineGapScale` method


   .. _OEDepict_GetBondLineAtomLabelGapScale:


   .. oe:method:: GetBondLineAtomLabelGapScale


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

         .. oe:api::

            double GetBondLineAtomLabelGapScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetBondLineAtomLabelGapScale() -> float

      Returns the multiplier that can be used to increase or decrease
      the gap between the line(s) of bonds and the adjacent atom labels.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondLineAtomLabelGapScale` method

   .. _OEDepict_GetBondPropLabelFont:


   .. oe:method:: GetBondPropLabelFont


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

         .. oe:api::

            const OEFont& GetBondPropLabelFont() const

      .. oe:language:: python

         .. oe:api:: python

            GetBondPropLabelFont() -> OEFont

      Returns the font that is used to initialize the depiction style
      of the bond property labels
      (:oe:meth:`OEDepict::OE2DBondDisplay::GetPropertyFont`).

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondPropLabelFont` method
         * :ref:`OEFont <OEDepict_OEFont>` class


   .. _OEDepict_GetBondPropLabelFontScale:


   .. oe:method:: GetBondPropLabelFontScale


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

         .. oe:api::

            double GetBondPropLabelFontScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetBondPropLabelFontScale() -> float

      Returns the multiplier that can be used to increase or decrease
      the size of the bond property label fonts.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondPropLabelFont` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondPropLabelFontScale` method


   .. _OEDepict_GetBondPropertyFunctor:


   .. oe:method:: GetBondPropertyFunctor


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

         .. oe:api::

            const OEDisplayBondPropBase& GetBondPropertyFunctor() const

      .. oe:language:: python

         .. oe:api:: python

            GetBondPropertyFunctor() -> OEDisplayBondPropBase

      Returns the functor that is used to initialize the bond property
      labels (:oe:meth:`OEDepict::OE2DBondDisplay::GetProperty`).

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondPropertyFunctor` method
         * :ref:`OEDisplayBondPropBase <OEDepict_OEDisplayBondPropBase>` class
         * :ref:`OEDisplayBondIdx <OEDepict_OEDisplayBondIdx>` class
         * :ref:`OEDisplayNoBondProp <OEDepict_OEDisplayNoBondProp>` class


   .. _OEDepict_GetBondStereoStyle:


   .. oe:method:: GetBondStereoStyle


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

         .. oe:api::

            unsigned int GetBondStereoStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetBondStereoStyle() -> int

      Returns the style that controls what bond stereo information is displayed.
      The return value is taken from the :oe:constns:`OEDepict::OEBondStereoStyle`
      namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondStereoStyle` method
         * :oe:constns:`OEDepict::OEBondStereoStyle` namespace


   .. _OEDepict_GetBondSVGMarkupFunctor:


   .. oe:method:: GetBondSVGMarkupFunctor


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

         .. oe:api::

            const OEBondSVGMarkupBase& GetBondSVGMarkupFunctor() const

      .. oe:language:: python

         .. oe:api:: python

            GetBondSVGMarkupFunctor() -> OEBondSVGMarkupBase

      Returns the functor that defines how bonds are marked in
      :file:`svg` image.
      By default, residues are not marked (:ref:`OEBondSVGNoMarkup <OEDepict_OEBondSVGNoMarkup>`).

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondSVGMarkupFunctor` method


   .. _OEDepict_GetBondWidthScaling:


   .. oe:method:: GetBondWidthScaling


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

         .. oe:api::

            bool GetBondWidthScaling() const

      .. oe:language:: python

         .. oe:api:: python

            GetBondWidthScaling() -> bool

      Returns whether the line width of the bond are increase or decreased based
      on the molecule scaling factor (:oe:meth:`OEDepict::OE2DMolDisplayOptions::GetScale`)

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondWidthScaling` method

   .. _OEDepict_GetDefaultBondPen:


   .. oe:method:: GetDefaultBondPen


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

         .. oe:api::

            const OEPen& GetDefaultBondPen() const

      .. oe:language:: python

         .. oe:api:: python

            GetDefaultBondPen() -> OEPen

      Returns the pen that is used to initialize the bond pens
      (:oe:meth:`OEDepict::OE2DBondDisplay::GetBgnPen` and
      :oe:meth:`OEDepict::OE2DBondDisplay::GetBgnPen`).

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetDefaultBondPen` method
         * :ref:`OEPen <OEDepict_OEPen>` class


   .. _OEDepict_GetExplicitAtomLabelAngle:


   .. oe:method:: GetExplicitAtomLabelAngle


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

         .. oe:api::

            double GetExplicitAtomLabelAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetExplicitAtomLabelAngle() -> float

      In the case of an almost linear X-C-X bond, an explicit "C" label
      will be drawn if the angle is more that the returned value of this
      function. 180.0 degree means that the "C" label will never be drawn.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetExplicitAtomLabelAngle` method


   .. _OEDepict_GetHeight:


   .. oe:method:: GetHeight


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

         .. oe:api::

            double GetHeight() const

      .. oe:language:: python

         .. oe:api:: python

            GetHeight() -> float

      Returns the vertical limit into which the molecule has to be fitted.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetDimensions` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetHeight` method


   .. _OEDepict_GetHydrogenStyle:


   .. oe:method:: GetHydrogenStyle


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

         .. oe:api::

            unsigned int GetHydrogenStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetHydrogenStyle() -> int

      Returns the style that controls of how implicit and explicit
      hydrogens are displayed.
      The return value is taken from the :oe:constns:`OEDepict::OEHydrogenStyle`
      namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetHydrogenStyle` method
         * :oe:constns:`OEDepict::OEHydrogenStyle` namespace


   .. _OEDepict_GetMargin:


   .. oe:method:: GetMargin


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

         .. oe:api::

            double GetMargin(unsigned int margin) const

      .. oe:language:: python

         .. oe:api:: python

            GetMargin(margin: int) -> float

      Returns the ratio of a specific margin of the
      :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` object.

      *margin*
         This value has to be from the :oe:constns:`OEDepict::OEMargin`
         namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetMargin` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetMargins` method
         * :oe:constns:`OEDepict::OEMargin` namespace


   .. _OEDepict_GetProtectiveGroupLabelFont:


   .. oe:method:: GetProtectiveGroupLabelFont


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

         .. oe:api::

            const OEFont& GetProtectiveGroupLabelFont() const

      .. oe:language:: python

         .. oe:api:: python

            GetProtectiveGroupLabelFont() -> OEFont

      Returns the font that is used to display the protective group labels.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetProtectiveGroupLabelFont` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetProtectiveGroupStyle` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetSuperAtomStyle` method
         * :ref:`OEFont <OEDepict_OEFont>` class


   .. _OEDepict_GetProtectiveGroupStyle:


   .. oe:method:: GetProtectiveGroupStyle


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

         .. oe:api::

            unsigned int GetProtectiveGroupStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetProtectiveGroupStyle() -> int

      Returns the style that controls whether or not specific pre-defined
      protective group are contracted and labeled with corresponding
      abbreviations.
      The return value is taken from the :oe:constns:`OEDepict::OEProtectiveGroupStyle`
      namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::HasProtectiveGroupStyle` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetProtectiveGroupStyle` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetProtectiveGroupLabelFont` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetSuperAtomStyle` method
         * :oe:constns:`OEDepict::OESuperAtomStyle` namespace
   
   .. warning::

      |DEPRECATED-API|
      Please use :oe:meth:`OEDepict::OE2DMolDisplayOptions::HasProtectiveGroupStyle` 
      to determine which protective groups are set.     


   .. _OEDepict_GetScale:


   .. oe:method:: GetScale


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

         .. oe:api::

            double GetScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetScale() -> float

      Returns the scaling factor used to magnify a molecule.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetDimensions` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetScale` method


   .. _OEDepict_GetSuperAtomLabelFont:


   .. oe:method:: GetSuperAtomLabelFont


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

         .. oe:api::

            const OEFont& GetSuperAtomLabelFont() const

      .. oe:language:: python

         .. oe:api:: python

            GetSuperAtomLabelFont() -> OEFont

      Returns the font that is used to display the abbreviations
      of contracted functional groups.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetSuperAtomLabelFont` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetSuperAtomStyle` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetProtectiveGroupStyle` method
         * :ref:`OEFont <OEDepict_OEFont>` class


   .. _OEDepict_GetSuperAtomStyle:


   .. oe:method:: GetSuperAtomStyle


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

         .. oe:api::

            unsigned int GetSuperAtomStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetSuperAtomStyle() -> int

      Returns the style that controls whether or not specific pre-defined
      functional groups are contracted and labeled with corresponding
      abbreviations.
      The return value is taken from the :oe:constns:`OEDepict::OESuperAtomStyle`
      namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetSuperAtomStyle` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetSuperAtomLabelFont` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetProtectiveGroupStyle` method
         * :oe:constns:`OEDepict::OESuperAtomStyle` namespace


   .. _OEDepict_GetTitleFont:


   .. oe:method:: GetTitleFont


      Returns the font that is used to display the title of the molecule
      (*i.e.* the string returned by the :oe:meth:`OEChem::OEMolBase::GetTitle`
      method).

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

         .. oe:api::

            const OEFont& GetTitleFont() const

      .. oe:language:: python

         .. oe:api:: python

            GetTitleFont() -> OEFont

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetTitleFont` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetTitleFontScale` method
         * :ref:`OEFont <OEDepict_OEFont>` class


   .. _OEDepict_GetTitleFontScale:


   .. oe:method:: GetTitleFontScale


      Returns the multiplier that can be used to increase or decrease
      the size of the title font.

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

         .. oe:api::

            double GetTitleFontScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetTitleFontScale() -> float

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetTitleFontScale` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetTitleFont` method


   .. _OEDepict_GetTitleLocation:


   .. oe:method:: GetTitleLocation


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

         .. oe:api::

            unsigned int GetTitleLocation() const

      .. oe:language:: python

         .. oe:api:: python

            GetTitleLocation() -> int

      Returns the position of the molecule title.
      The return value is taken from the :oe:constns:`OEDepict::OETitleLocation`
      namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetTitleLocation` method
         * :oe:constns:`OEDepict::OETitleLocation` namespace


   .. _OEDepict_GetTitleHeight:


   .. oe:method:: GetTitleHeight


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

         .. oe:api::

            double GetTitleHeight() const

      .. oe:language:: python

         .. oe:api:: python

            GetTitleHeight() -> float

      Returns the height of the title area.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetTitleHeight` method


   .. _OEDepict_GetWidth:


   .. oe:method:: GetWidth


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

         .. oe:api::

            double GetWidth() const

      .. oe:language:: python

         .. oe:api:: python

            GetWidth() -> float

      Returns the horizontal limit into which the molecule has to be fitted.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetDimensions` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetWidth` method

   .. _OEDepict_HasProtectiveGroupStyle:


   .. oe:method:: HasProtectiveGroupStyle


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

         .. oe:api::

            bool HasProtectiveGroupStyle(unsigned int style) const

      .. oe:language:: python

         .. oe:api:: python

            HasProtectiveGroupStyle(style: int) -> bool

      Returns true if the specific pre-defined protective group style is contracted 
      and labeled with corresponding abbreviations.
      
      *style*
         This value has to be from the :oe:constns:`OEDepict::OEProtectiveGroupStyle`
         namespace.


   .. _OEDepict_SetAromaticStyle:


   .. oe:method:: SetAromaticStyle


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

         .. oe:api::

            void SetAromaticStyle(unsigned int style)

      .. oe:language:: python

         .. oe:api:: python

            SetAromaticStyle(style: int) -> None

      Sets the style that controls how aromatic rings are displayed.

      *style*
         This value has to be from the :oe:constns:`OEDepict::OEAromaticStyle`
         namespace.

      **Example:** (:ref:`Figure: Example of using the SetAromaticStyle method<figure_OE2DMolDisplayOptions_SetAromaticStyle>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-AROMATIC-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-AROMATIC-STYLE

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-AROMATIC-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-AROMATIC-STYLE


      .. _figure_OE2DMolDisplayOptions_SetAromaticStyle:

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

         **Example of using the SetAromaticStyle method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAromaticStyle` method
         * :oe:constns:`OEDepict::OEAromaticStyle` namespace


   .. _OEDepict_SetAtomColor:


   .. oe:method:: SetAtomColor


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

         .. oe:api::

            void SetAtomColor(unsigned int atomic,
                              const OESystem::OEColor& color)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomColor(atomic: int, color: OEColor) -> None

      Sets the color associated with a specific atomic number.

      *atomic*
         This value has to be from the :oe:constns:`OEChem::OEElemNo`
         namespace of **OEChem TK**.

      *color*
         The color being associated with the given atomic number.

      **Example:** (:ref:`Figure: Example of using the SetAtomColor method<figure_OE2DMolDisplayOptions_SetAtomColor>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-COLOR

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-COLOR

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-COLOR

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-COLOR


      .. _figure_OE2DMolDisplayOptions_SetAtomColor:

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

         **Example of using the SetAtomColor method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomColor` method
         * :ref:`OEColor <OESystem_OEColor>` class
         * :ref:`chapter_element_color` section
  
      .. note::

         * The color of the atom also depends on the atom color style (:oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomColorStyle`).
         * Setting atom color style (:oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomColorStyle`) 
           to WhiteMonochrome sets white background and black color for all atoms. Likewise, setting 
           atom color style to BlackMonochrome sets black background and white color for all atoms. 
           But, user can choose to have another color for all atoms (in monochrome atom color style) by 
           setting another atom color (:oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomColor`) for Carbon atoms. 
           The example in :oe:src:`Listing 4<SNIPPET-DEPICT-MOL-GRAPH-DepictMolGraph>` demonstrates setting non-default atom colors in monochrome mode. 
           Setting atom color for other than Carbon atoms sets color of only specified atom types, not for all atoms.


   .. _OEDepict_SetAtomColorStyle:


   .. oe:method:: SetAtomColorStyle


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

         .. oe:api::

            void SetAtomColorStyle(unsigned int style)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomColorStyle(style: int) -> None

      Sets the style that is used to define the color of the background and the
      default color of atom labels.

      *style*
         This value has to be from the :oe:constns:`OEDepict::OEAtomColorStyle`
         namespace.

      **Example:** (:ref:`Figure: Example of using the SetAtomColorStyle method<figure_OE2DMolDisplayOptions_SetAtomColorStyle>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-COLOR-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-COLOR-STYLE

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-COLOR-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-COLOR-STYLE


      .. _figure_OE2DMolDisplayOptions_SetAtomColorStyle:

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

         **Example of using the SetAtomColorStyle method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomColorStyle` method
         * :oe:constns:`OEDepict::OEAtomColorStyle` namespace


   .. _OEDepict_SetAtomLabelFont:


   .. oe:method:: SetAtomLabelFont


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

         .. oe:api::

            void SetAtomLabelFont(const OEFont& font)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomLabelFont(font: OEFont) -> None

      Sets the font that is used to initialize the depiction style
      of the atom labels
      (:oe:meth:`OEDepict::OE2DAtomDisplay::GetLabelFont`).

      **Example:** (:ref:`Figure: Example of using the SetAtomLabelFont method<figure_OE2DMolDisplayOptions_SetAtomLabelFont>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-LABEL-FONT

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-LABEL-FONT

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-LABEL-FONT

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-LABEL-FONT


      .. _figure_OE2DMolDisplayOptions_SetAtomLabelFont:

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

         **Example of using the SetAtomLabelFont method**

      .. note::

         * The color of the atom label fonts also depends on
           the atom color style (:oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomColorStyle`).

         * The size of fonts of the atom labels also depends on:

           - the scaling factor used to fit a molecule to a given dimension
             (:oe:meth:`OEDepict::OE2DMolDisplayOptions::GetScale`)
           - the multiplier set by the
             :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomLabelFontScale`
             method

           See example in :ref:`Figure: Example of scaling the font of the atom label
           along with the molecule<figure_OE2DMolDisplayOptions_SetAtomLabelFont_Scaling>`

      .. _figure_OE2DMolDisplayOptions_SetAtomLabelFont_Scaling:

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

         **Example of scaling the font of the atom label along with the molecule**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomLabelFont` method
         * :ref:`OEFont <OEDepict_OEFont>` class


   .. _OEDepict_SetAtomLabelFontScale:


   .. oe:method:: SetAtomLabelFontScale


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

         .. oe:api::

            void SetAtomLabelFontScale(double scale)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomLabelFontScale(scale: float) -> None

      Sets the multiplier that can be used increase or decrease the
      size of the fonts of the atom labels.

      *scale*
         This value has to be either ``0.0`` or in a range of ``[0.5, 3.0]``.
         See examples in :ref:`Figure: Examples of scaling the font of the atom label relative to the molecule
         <figure_OE2DMolDisplayOptions_SetAtomLabelFont_ScalingFactor>`

         In case of ``0.0``, the atom labels are not scaled with the molecule
         but rather fixed font size are used regardless of the size of the molecule.
         See example in :ref:`Figure: Example of atom labels with fixed font size
         <figure_OE2DMolDisplayOptions_SetAtomLabelFont_NoScaling>`

      .. _figure_OE2DMolDisplayOptions_SetAtomLabelFont_ScalingFactor:

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

         **Examples of scaling the font of the atom label relative to the molecule**

      .. _figure_OE2DMolDisplayOptions_SetAtomLabelFont_NoScaling:

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

         **Example of atom labels with fixed font size**


      **Example:** (:ref:`Figure: Example of using the SetAtomLabelFontScale method<figure_OE2DMolDisplayOptions_SetAtomLabelFontScale>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-LABEL-FONT-SCALE

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-LABEL-FONT-SCALE

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-LABEL-FONT-SCALE

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-LABEL-FONT-SCALE


      .. _figure_OE2DMolDisplayOptions_SetAtomLabelFontScale:

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

         **Example of using the SetAtomLabelFontScale method**



      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomLabelFontScale` method


   .. _OEDepict_SetAtomPropLabelFont:


   .. oe:method:: SetAtomPropLabelFont


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

         .. oe:api::

            void SetAtomPropLabelFont(const OEFont& font)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomPropLabelFont(cont: OEFont) -> None

      Sets the font that is used to initialize the depiction style
      of the atom property labels
      (:oe:meth:`OEDepict::OE2DAtomDisplay::GetPropertyFont`).

      **Example:** (:ref:`Figure: Example of using the SetAtomPropLabelFont method<figure_OE2DMolDisplayOptions_SetAtomPropLabelFont>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-PROP-LABEL-FONT

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-PROP-LABEL-FONT

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-PROP-LABEL-FONT

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-PROP-LABEL-FONT


      .. _figure_OE2DMolDisplayOptions_SetAtomPropLabelFont:

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

         **Example of using the SetAtomPropLabelFont method**

      .. note::

         * The size of the atom property label fonts also depends on
           the scaling factor used to fit a molecule to a given dimension
           (:oe:meth:`OEDepict::OE2DMolDisplayOptions::GetScale`)
           and the multiplier set by the
           :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomPropLabelFontScale`
           method.
           See example in
           :ref:`Figure: Example of scaling the font of the atom property labels
           along with the molecule<figure_OE2DMolDisplayOptions_SetAtomLabelFont_Scaling>`

      .. _figure_OE2DMolDisplayOptions_SetAtomPropLabelFont_Scaling:

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

         **Example of scaling the font of the atom property labels along with the molecule**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomPropLabelFont` method
         * :ref:`OEFont <OEDepict_OEFont>` class


   .. _OEDepict_SetAtomPropLabelFontScale:


   .. oe:method:: SetAtomPropLabelFontScale


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

         .. oe:api::

            void SetAtomPropLabelFontScale(double scale)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomPropLabelFontScale(scale: float) -> None

      Sets the multiplier that can be used increase or decrease the
      size of the fonts of the atom property labels.

      *scale*
         This value has to be in the range of ``[0.5, 2.0]``.
         See examples in :ref:`Figure: Examples of scaling the font of the atom property labels relative to the molecule
         <figure_OE2DMolDisplayOptions_SetPropAtomLabelFont_ScalingFactor>`

      .. _figure_OE2DMolDisplayOptions_SetPropAtomLabelFont_ScalingFactor:

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

         **Examples of scaling the font of the atom property labels relative to the molecule**

      **Example:** (:ref:`Figure: Example of using the SetAtomPropLabelFontScale method<figure_OE2DMolDisplayOptions_SetAtomPropLabelFontScale>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-PROP-LABEL-FONT-SCALE

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-PROP-LABEL-FONT-SCALE

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-PROP-LABEL-FONT-SCALE

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-PROP-LABEL-FONT-SCALE


      .. _figure_OE2DMolDisplayOptions_SetAtomPropLabelFontScale:

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

         **Example of using the SetAtomPropLabelFontScale method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomPropLabelFontScale` method


   .. _OEDepict_SetAtomPropertyFunctor:


   .. oe:method:: SetAtomPropertyFunctor


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

         .. oe:api::

            void SetAtomPropertyFunctor(const OEDisplayAtomPropBase& func)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomPropertyFunctor(func: OEDisplayAtomPropBase) -> None

      Sets the functor that is used to initialize the atom property
      labels (:oe:meth:`OEDepict::OE2DAtomDisplay::GetProperty`)

      **Example:** (:ref:`Figure: Example of using the SetAtomPropertyFunctor method<figure_OE2DMolDisplayOptions_SetAtomPropertyFunctor>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-PROPERTY-FUNCTOR

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-PROPERTY-FUNCTOR

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-PROPERTY-FUNCTOR

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-PROPERTY-FUNCTOR


      .. _figure_OE2DMolDisplayOptions_SetAtomPropertyFunctor:

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

         **Example of using the SetAtomPropertyFunctor method**

      .. hint::

         It is recommended to use the :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomPropertyFunctor`
         method to define the atom property labels when the :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>`
         object is constructed.
         All labels displayed on the molecule diagram have to be known in advance in order to be
         able to minimize the number of label clashes and clippings when calculating
         the positions of the bond property labels.

         See example of user-defined atom properties in :ref:`section_mol_display_atom_prop`
         section.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomPropertyFunctor` method
         * :ref:`OEDisplayAtomPropBase <OEDepict_OEDisplayAtomPropBase>` class
         * :ref:`OEDisplayAtomIdx <OEDepict_OEDisplayAtomIdx>` class
         * :ref:`OEDisplayAtomMapIdx <OEDepict_OEDisplayAtomMapIdx>` class
         * :ref:`OEDisplayNoAtomProp <OEDepict_OEDisplayNoAtomProp>` class


   .. _OEDepict_SetAtomStereoStyle:


   .. oe:method:: SetAtomStereoStyle


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

         .. oe:api::

            void SetAtomStereoStyle(unsigned int style)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomStereoStyle(style: int) -> None

      Sets the style that controls what atom stereo information is displayed.

      *style*
         This value has to be from the :oe:constns:`OEDepict::OEAtomStereoStyle`
         namespace.

      **Example:** (:ref:`Figure: Example of using the SetAtomStereoStyle method<figure_OE2DMolDisplayOptions_SetAtomStereoStyle>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-STEREO-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-STEREO-STYLE

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-STEREO-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-STEREO-STYLE


      .. _figure_OE2DMolDisplayOptions_SetAtomStereoStyle:

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

         **Example of using the SetAtomStereoStyle method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomStereoStyle` method
         * :oe:constns:`OEDepict::OEAtomStereoStyle` namespace

   .. _OEDepict_SetAtomSVGMarkupFunctor:


   .. oe:method:: SetAtomSVGMarkupFunctor


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

         .. oe:api::

            void SetAtomSVGMarkupFunctor(const OEAtomSVGMarkupBase& func)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomSVGMarkupFunctor(func: OEAtomSVGMarkupBase) -> None

      Sets the functor that defines how atoms are marked in :file:`svg` image.
      Drawing elements representing atoms in :file:`svg` image are grouped together
      in the following format in which the ``<group id>`` and ``<class name>``
      strings are defined by the given functor:

      ::

          <g id='<group id>' class='<class name>'>
          ..
          list of drawing elements
          ..
          </g>

      .. note::

         This setting has only effect when generating :file:`.svg`
         images.

      .. seealso::

         * :ref:`OEAtomSVGMarkupBase <OEDepict_OEAtomSVGMarkupBase>` abstract base class
         * :ref:`OEAtomSVGNoMarkup <OEDepict_OEAtomSVGNoMarkup>` class
         * :ref:`OEAtomSVGAtomIdxMarkup <OEDepict_OEAtomSVGAtomIdxMarkup>` class
         * :ref:`OEAtomSVGResidueMarkup <OEDepict_OEAtomSVGResidueMarkup>` class
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomSVGMarkupFunctor` method


   .. _OEDepict_SetAtomVisibilityFunctor:


   .. oe:method:: SetAtomVisibilityFunctor


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

         .. oe:api::

            void SetAtomVisibilityFunctor(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& func)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomVisibilityFunctor(func: OEUnaryAtomPred) -> None

      Sets the functor that is used to identify visible atoms.

      **Example:** (:ref:`Figure: Example of using the SetAtomVisibilityFunctor method<figure_OE2DMolDisplayOptions_SetAtomVisibilityFunctor>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-VISIBILITY-FUNCTOR

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-VISIBILITY-FUNCTOR

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-VISIBILITY-FUNCTOR

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-ATOM-VISIBILITY-FUNCTOR


      .. _figure_OE2DMolDisplayOptions_SetAtomVisibilityFunctor:

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

         **Example of using the SetAtomVisibilityFunctor method to only display rings**

      .. hint::

         It is recommended to use the :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomVisibilityFunctor`
         method to identify the visible atoms when the :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>`
         object is constructed. All objects displayed in the molecule diagram have to be known in advance in order to be
         able to correctly size and scale the molecule.

         See additional examples of atom visibility control in the :ref:`section_mol_display_atom_prop`
         section.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetAtomVisibilityFunctor` method
         * :oe:cls:`OEUnaryAtomPred<OESystem::OEUnaryPredicate>`

   .. _OEDepict_SetBackgroundColor:


   .. oe:method:: SetBackgroundColor


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

         .. oe:api::

            void SetBackgroundColor(const OESystem::OEColor& color)

      .. oe:language:: python

         .. oe:api:: python

            SetBackgroundColor(color: OEColor) -> None

      Sets the color that is used to clear the background of an image
      (by calling :oe:meth:`OEDepict::OEImageBase::Clear` method)
      before rendering the molecule.

      **Example:** (:ref:`Figure: Example of using the SetBackgroundColor method<figure_OE2DMolDisplayOptions_SetBackgroundColor>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BACKGROUND-COLOR

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BACKGROUND-COLOR

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BACKGROUND-COLOR

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BACKGROUND-COLOR


      .. _figure_OE2DMolDisplayOptions_SetBackgroundColor:

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

         **Example of using the SetBackgroundColor method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetBackgroundColor` method
         * :ref:`OEColor <OESystem_OEColor>` class


   .. _OEDepict_SetBondColorStyle:


   .. oe:method:: SetBondColorStyle


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

         .. oe:api::

            void SetBondColorStyle(unsigned int style)

      .. oe:language:: python

         .. oe:api:: python

            SetBondColorStyle(style: int) -> None

      Sets the style that controls how bonds are colored.

      *style*
         This value has to be from the :oe:constns:`OEDepict::OEBondColorStyle`
         namespace.

      **Example:** (:ref:`Figure: Example of using the SetBondColorStyle method<figure_OE2DMolDisplayOptions_SetBondColorStyle>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-COLOR-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-COLOR-STYLE

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-COLOR-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-COLOR-STYLE


      .. _figure_OE2DMolDisplayOptions_SetBondColorStyle:

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

         **Example of using the SetBondColorStyle method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetBondColorStyle` method
         * :oe:constns:`OEDepict::OEBondColorStyle` namespace


   .. _OEDepict_SetBondLineGapScale:


   .. oe:method:: SetBondLineGapScale


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

         .. oe:api::

            void SetBondLineGapScale(double scale)

      .. oe:language:: python

         .. oe:api:: python

            SetBondLineGapScale(scale: float) -> None


      Sets the multiplier that can be used increase or decrease the
      gap between the lines of double and triple bonds.

      *scale*
         This value has to be in the range of ``[0.5, 2.0]``.
         See examples in :ref:`Figure: Examples of altering the gap between the lines of double and triple bonds
         <figure_OE2DMolDisplayOptions_BondLineGapScale>`

      .. _figure_OE2DMolDisplayOptions_BondLineGapScale:

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

         **Examples of altering the gap between the lines of double and triple bonds**

      **Example:** (:ref:`Figure: Example of using the SetBondLineGapScale method<figure_OE2DMolDisplayOptions_SetBondLineGapScale>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-LINE-GAP-SCALE

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-LINE-GAP-SCALE

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-LINE-GAP-SCALE

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-LINE-GAP-SCALE


      .. _figure_OE2DMolDisplayOptions_SetBondLineGapScale:

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

         **Example of using the SetBondLineGapScale method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetBondLineGapScale` method


   .. _OEDepict_SetBondLineAtomLabelGapScale:


   .. oe:method:: SetBondLineAtomLabelGapScale


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

         .. oe:api::

            void SetBondLineAtomLabelGapScale(double scale)

      .. oe:language:: python

         .. oe:api:: python

            SetBondLineAtomLabelGapScale(scale: float) -> None

      Sets the multiplier that can be used to increase or decrease
      the gap between the line(s) of bonds and the adjacent atom labels.

      *scale*
         This value has to be in the range of ``[0.5, 2.0]``.
         See examples in :ref:`Figure: Examples of altering the gap between the line(s) of bonds and adjacent atom labels
         <figure_OE2DMolDisplayOptions_BondLineAtomLabelGapScale>`

      .. _figure_OE2DMolDisplayOptions_BondLineAtomLabelGapScale:

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

         **Examples of altering the gap between the line(s) of bonds and adjacent atom labels**

      **Example:** (:ref:`Figure: Example of using the SetBondLineAtomLabelGapScale method<figure_OE2DMolDisplayOptions_SetBondLineAtomLabelGapScale>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-LINE-ATOM-LABEL-GAP-SCALE

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-LINE-ATOM-LABEL-GAP-SCALE

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-LINE-ATOM-LABEL-GAP-SCALE

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-LINE-ATOM-LABEL-GAP-SCALE

      .. _figure_OE2DMolDisplayOptions_SetBondLineAtomLabelGapScale:

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

         **Example of using the SetBondLineAtomLabelGapScale method**


      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetBondLineAtomLabelGapScale` method


   .. _OEDepict_SetBondPropLabelFont:


   .. oe:method:: SetBondPropLabelFont


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

         .. oe:api::

            void SetBondPropLabelFont(const OEFont& color)

      .. oe:language:: python

         .. oe:api:: python

            SetBondPropLabelFont(color: OEFont) -> None

      Sets the font that is used to initialize the depiction style
      of the bond property labels
      (:oe:meth:`OEDepict::OE2DBondDisplay::GetPropertyFont`).

      **Example:** (:ref:`Figure: Example of using the SetBondPropLabelFont method<figure_OE2DMolDisplayOptions_SetBondPropLabelFont>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-PROP-LABEL-FONT

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-PROP-LABEL-FONT

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-PROP-LABEL-FONT

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-PROP-LABEL-FONT


      .. _figure_OE2DMolDisplayOptions_SetBondPropLabelFont:

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

         **Example of using the SetBondPropLabelFont method**

      .. note::

         * The size of the bond property label fonts also depends on
           the scaling factor used to fit a molecule to a given dimension
           (:oe:meth:`OEDepict::OE2DMolDisplayOptions::GetScale`)
           and the multiplier set by the
           :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondPropLabelFontScale`
           method.
           See example in
           :ref:`Figure: Example of scaling the font of the bond property labels
           along with the molecule<figure_OE2DMolDisplayOptions_SetBondPropLabelFont_Scaling>`

      .. _figure_OE2DMolDisplayOptions_SetBondPropLabelFont_Scaling:

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

         **Example of scaling the font of the bond property labels along with the molecule**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetBondPropLabelFont` method
         * :ref:`OEFont <OEDepict_OEFont>` class


   .. _OEDepict_SetBondPropLabelFontScale:


   .. oe:method:: SetBondPropLabelFontScale


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

         .. oe:api::

            void SetBondPropLabelFontScale(double scale)

      .. oe:language:: python

         .. oe:api:: python

            SetBondPropLabelFontScale(scale: float) -> None

      Sets the multiplier that can be used increase or decrease the
      size of the fonts of the bond property labels.

      *scale*
         This value has to be in the range of ``[0.5, 2.0]``.
         See examples in :ref:`Figure:*Examples of scaling the font of the bond property labels relative to the molecule
         SetBondPropLabelFontScale method<figure_OE2DMolDisplayOptions_SetPropBondLabelFont_ScalingFactor>`

      .. _figure_OE2DMolDisplayOptions_SetPropBondLabelFont_ScalingFactor:

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

         **Examples of scaling the font of the bond property labels relative to the molecule**


      **Example:** (:ref:`Figure: Example of using the SetBondPropLabelFontScale method<figure_OE2DMolDisplayOptions_SetBondPropLabelFontScale>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-PROP-LABEL-FONT-SCALE

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-PROP-LABEL-FONT-SCALE

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-PROP-LABEL-FONT-SCALE

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-PROP-LABEL-FONT-SCALE


      .. _figure_OE2DMolDisplayOptions_SetBondPropLabelFontScale:

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

         **Example of using the SetBondPropLabelFontScale method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetBondPropLabelFontScale` method


   .. _OEDepict_SetBondPropertyFunctor:


   .. oe:method:: SetBondPropertyFunctor


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

         .. oe:api::

            void SetBondPropertyFunctor(const OEDisplayBondPropBase& func)

      .. oe:language:: python

         .. oe:api:: python

            SetBondPropertyFunctor(func: OEDisplayBondPropBase) -> None

      Sets the functor that is used to initialize the bond property
      labels (:oe:meth:`OEDepict::OE2DBondDisplay::GetProperty`)

      **Example:** (:ref:`Figure: Example of using the SetBondPropertyFunctor method<figure_OE2DMolDisplayOptions_SetBondPropertyFunctor>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-PROPERTY-FUNCTOR

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-PROPERTY-FUNCTOR

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-PROPERTY-FUNCTOR

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-PROPERTY-FUNCTOR

      .. _figure_OE2DMolDisplayOptions_SetBondPropertyFunctor:

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

         **Example of using the SetBondPropertyFunctor method**

      .. hint::

         It is recommended to use the :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondPropertyFunctor`
         method to define the bond property labels when the :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>`
         object is constructed.
         All labels displayed on the molecule diagram have to be known in advance in order to be
         able to minimize the number of label clashes and clippings when calculating
         the positions of the bond property labels.

         See example of user-defined bond properties in :ref:`section_mol_display_bond_prop`
         section.

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetBondPropertyFunctor` method
         * :ref:`OEDisplayBondPropBase <OEDepict_OEDisplayBondPropBase>` class
         * :ref:`OEDisplayBondIdx <OEDepict_OEDisplayBondIdx>` class
         * :ref:`OEDisplayNoBondProp <OEDepict_OEDisplayNoBondProp>` class


   .. _OEDepict_SetBondStereoStyle:


   .. oe:method:: SetBondStereoStyle


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

         .. oe:api::

            void SetBondStereoStyle(unsigned int style)

      .. oe:language:: python

         .. oe:api:: python

            SetBondStereoStyle(style: int) -> None

      Sets the style that controls what bond stereo information is displayed.

      *style*
         This value has to be from the :oe:constns:`OEDepict::OEBondStereoStyle`
         namespace.

      **Example:** (:ref:`Figure: Example of using the SetBondStereoStyle method<figure_OE2DMolDisplayOptions_SetBondStereoStyle>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-STEREO-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-STEREO-STYLE

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-STEREO-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-STEREO-STYLE


      .. _figure_OE2DMolDisplayOptions_SetBondStereoStyle:

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

         **Example of using the SetBondStereoStyle method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetBondStereoStyle` method
         * :oe:constns:`OEDepict::OEBondStereoStyle` namespace


   .. _OEDepict_SetBondSVGMarkupFunctor:


   .. oe:method:: SetBondSVGMarkupFunctor


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

         .. oe:api::

            void SetBondSVGMarkupFunctor(const OEBondSVGMarkupBase& func)

      .. oe:language:: python

         .. oe:api:: python

            SetBondSVGMarkupFunctor(func: OEBondSVGMarkupBase) -> None

      Sets the functor that defines how bonds are marked in :file:`svg` image.
      Drawing elements representing bonds in :file:`svg` image are grouped together
      in the following format in which the ``<group id>`` and ``<class name>``
      strings are defined by the given functor:

      ::

          <g id='<group id>' class='<class name>'>
          ..
          list of drawing elements
          ..
          </g>

      .. note::

         This setting has only effect when generating :file:`.svg`
         images.

      .. seealso::

         * :ref:`OEBondSVGMarkupBase <OEDepict_OEBondSVGMarkupBase>` abstract base class
         * :ref:`OEBondSVGNoMarkup <OEDepict_OEBondSVGNoMarkup>` class
         * :ref:`OEBondSVGBondIdxMarkup <OEDepict_OEBondSVGBondIdxMarkup>` class
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetBondSVGMarkupFunctor` method


   .. _OEDepict_SetBondWidthScaling:


   .. oe:method:: SetBondWidthScaling


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

         .. oe:api::

            void SetBondWidthScaling(bool scale)

      .. oe:language:: python

         .. oe:api:: python

            SetBondWidthScaling(scale: bool) -> None

      Sets whether the line width of the bond are increase or decreased based
      on the molecule scaling factor (:oe:meth:`OEDepict::OE2DMolDisplayOptions::GetScale`).
      See examples in :ref:`Figure: Examples of bond line width <figure_OE2DMolDisplayOptions_BondWidthScaling>`.

      .. note::

         * The line width of the bonds also depends on the default bond pen that
           can be set by using the
           :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetDefaultBondPen` method.

      .. _figure_OE2DMolDisplayOptions_BondWidthScaling:

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

         **Examples of bond line width: (A) scaling the line width of the bonds relative
         to the molecule; (B) using constant line width that does not depend on the
         molecule scaling**

      **Example:** (:ref:`Figure: Example of using the SetBondWithScaling method<figure_OE2DMolDisplayOptions_SetBondWidthScaling>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-WIDTH-SCALING

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-WIDTH-SCALING

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-WIDTH-SCALING

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-BOND-WIDTH-SCALING

      .. _figure_OE2DMolDisplayOptions_SetBondWidthScaling:

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

         **Example of using the SetBondWidthScaling method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetBondWidthScaling` method


   .. _OEDepict_SetDefaultBondPen:


   .. oe:method:: SetDefaultBondPen


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

         .. oe:api::

            void SetDefaultBondPen(const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            SetDefaultBondPen(pen: OEPen) -> None

      Sets the pen that is used to initialize the bond pens
      (:oe:meth:`OEDepict::OE2DBondDisplay::GetBgnPen` and
      :oe:meth:`OEDepict::OE2DBondDisplay::GetEndPen`)

      **Example:** (:ref:`Figure: Example of using the SetDefaultBondPen method<figure_OE2DMolDisplayOptions_SetDefaultBondPen>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-DEFAULT-BOND-PEN

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-DEFAULT-BOND-PEN

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-DEFAULT-BOND-PEN

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-DEFAULT-BOND-PEN


      .. _figure_OE2DMolDisplayOptions_SetDefaultBondPen:

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

         **Example of using the SetDefaultBondPen method**

      .. note::

         * The style of the pens being used to draw bonds also depends on
           the bond display style (:ref:`OE2DBondDisplay <OEDepict_OE2DBondDisplay>`)

         * The color of the pens being used to draw bonds also depends on
           the given atom and bond color styles
           (:oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomColorStyle` and
           :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetBondColorStyle`,
           respectively)

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetDefaultBondPen` method
         * :ref:`OEPen <OEDepict_OEPen>` class


   .. _OEDepict_SetDimensions:


   .. oe:method:: SetDimensions


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

         .. oe:api::

            void SetDimensions(double width, double height, double scale)

      .. oe:language:: python

         .. oe:api:: python

            SetDimensions(width: float, height: float, scale: float) -> None

      Sets parameters that control the size of the depicted molecule.

      *width*
         A non-negative number that controls the horizontal limit.

      *height*
         A non-negative number that controls the vertical limit.

      *scale*
         A non-negative number that controls the magnification of the
         depicted molecule.
         :oe:const:`OEDepict::OEScale::AutoScale` scaling means
         that the molecule is scaled to maximally fit the given dimensions.

      **Example:** (:ref:`Figure: Example of using the SetDimensions method<figure_OE2DMolDisplayOptions_SetDimensions>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-DIMENSIONS

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-DIMENSIONS

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-DIMENSIONS

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-DIMENSIONS


      .. _figure_OE2DMolDisplayOptions_SetDimensions:

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

         **Example of using the SetDimensions method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetHeight` and :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetHeight` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetScale`  and :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetScale` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetWidth`  and :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetWidth` method
         * :ref:`section_mol_display_size` section



   .. _OEDepict_SetExplicitAtomLabelAngle:


   .. oe:method:: SetExplicitAtomLabelAngle


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

         .. oe:api::

            void SetExplicitAtomLabelAngle(const double angle)

      .. oe:language:: python

         .. oe:api:: python

            SetExplicitAtomLabelAngle(angle: float) -> None

      In the case of an almost linear X-C-X bond, an explicit "C" label
      will be drawn if the angle is more that the given angle.
      180.0 degree means that the "C" label will never be drawn.

      .. _figure_OE2DMolDisplayOptions_SetExplicitAtomLabelAngle:

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

         **Example of using the SetExplicitAtomLabelAngle method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetExplicitAtomLabelAngle` method


   .. _OEDepict_SetHeight:


   .. oe:method:: SetHeight


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

         .. oe:api::

            void SetHeight(double height)

      .. oe:language:: python

         .. oe:api:: python

            SetHeight(height: float) -> None

      Sets the vertical limit into which the molecule has to be fitted.

      *height*
         This number has to be non-negative number.

      **Example:** (:ref:`Figure: Example of using the SetHeight method<figure_OE2DMolDisplayOptions_SetHeight>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-HEIGHT

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-HEIGHT

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-HEIGHT

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-HEIGHT

      .. _figure_OE2DMolDisplayOptions_SetHeight:

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

         **Example of using the SetHeight method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetHeight` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetDimensions` method
         * :ref:`section_mol_display_size` section


   .. _OEDepict_SetHydrogenStyle:


   .. oe:method:: SetHydrogenStyle


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

         .. oe:api::

            void SetHydrogenStyle(unsigned int style)

      .. oe:language:: python

         .. oe:api:: python

            SetHydrogenStyle(style: int) -> None

      Sets the style that controls how implicit and explicit
      hydrogens are displayed.

      *style*
         This value has to be from the :oe:constns:`OEDepict::OEHydrogenStyle`
         namespace.

      **Example:** (:ref:`Figure: Example of using the SetHydrogenStyle method<figure_OE2DMolDisplayOptions_SetHydrogenStyle>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-HYDROGEN-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-HYDROGEN-STYLE

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-HYDROGEN-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-HYDROGEN-STYLE


      .. _figure_OE2DMolDisplayOptions_SetHydrogenStyle:

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

         **Example of using the SetHydrogenStyle method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetHydrogenStyle` method
         * :oe:constns:`OEDepict::OEHydrogenStyle` namespace


   .. _OEDepict_SetMargin:


   .. oe:method:: SetMargin


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

         .. oe:api::

            bool SetMargin(unsigned int marginloc, double margin)

      .. oe:language:: python

         .. oe:api:: python

            SetMargin(margin: int, percent: float) -> bool

      Sets the size of a specific margin of the
      :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` object.

      *marginloc*
         This value has to be from the :oe:constns:`OEDepict::OEMargin`
         namespace.

      *margin*
         This number is considered as a percentage of either the width or the height
         of the molecule display and has to be in the range of ``[2.5%, 25.0%]``.
         See example in :ref:`Table: Example of setting specific margins to 5% (default), 15% and 25%
         <table_OE2DMolDisplayLayout_SetMargin>`.
         For example, when setting a margin to 15.0%:

         - in case of the **top** or the **bottom** margins, it means that the margin will be 15% of the total height
           of the molecule display
         - in case of the **left** or the **right** margins, it means that the margin will be 15% of the total width
           of the molecule display

      .. _table_OE2DMolDisplayLayout_SetMargin:

      .. list-table:: **Example of setting specific margins to 5% (default), 15% and 25%**
         :widths: 250 250

         * - **top margin**
           - **bottom margin**
         * - .. image:: ../images/OE2DMolDisplayLayout_SetMargin_Top.*
           - .. image:: ../images/OE2DMolDisplayLayout_SetMargin_Bottom.*

         * - **left margin**
           - **right margin**

         * - .. image:: ../images/OE2DMolDisplayLayout_SetMargin_Left.*
           - .. image:: ../images/OE2DMolDisplayLayout_SetMargin_Right.*


      **Example:** (:ref:`Figure: Example of using the SetMargin method<figure_OE2DMolDisplayOptions_SetMargin>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SETMARGIN

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SETMARGIN

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SETMARGIN

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SETMARGIN

      .. _figure_OE2DMolDisplayOptions_SetMargin:

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

         **Example of using the SetMargin method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetMargin` method
         * :oe:constns:`OEDepict::OEMargin` namespace


   .. _OEDepict_SetMargins:


   .. oe:method:: SetMargins


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

         .. oe:api::

            bool SetMargins(double margin)

      .. oe:language:: python

         .. oe:api:: python

            SetMargins(percent: float) -> bool

      Sets the size of all margins of the
      :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` object.

      *margin*
         This number is considered as a percentage of either the width or the height
         of the molecule display and has to be in the range of ``[2.5%, 25.0%]``.
         For example, 15.0% means, that the left and right margin
         are 15% of the total width of the molecule display, and the top and bottom margins
         are 15% of the total height of the molecule display.
         See example in :ref:`Figure: Example of setting all margins to 5% (default), 15% and 25%
         <figure_OE2DMolDisplayLayout_SetMargins>`.

      .. _figure_OE2DMolDisplayLayout_SetMargins:

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

         **Example of setting all margins to 5% (default), 15% and 25%**


      **Example:** (:ref:`Figure: Example of using the SetMargin method<figure_OE2DMolDisplayOptions_SetMargin>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SETMARGINS

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SETMARGINS

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SETMARGINS

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SETMARGINS

      .. _figure_OE2DMolDisplayOptions_SetMargins:

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

         **Example of using the SetMargins method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetMargin` method
         * :oe:constns:`OEDepict::OEMargin` namespace



   .. _OEDepict_SetProtectiveGroupLabelFont:


   .. oe:method:: SetProtectiveGroupLabelFont


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

         .. oe:api::

            void SetProtectiveGroupLabelFont(const OEFont& font)

      .. oe:language:: python

         .. oe:api:: python

            SetProtectiveGroupLabelFont(font: OEFont) -> None

      Sets the font that is used to display the abbreviations
      of contracted functional groups.

      **Example:** (:ref:`Figure: Example of using the ProtectiveGroupLabelFont method<figure_OE2DMolDisplayOptions_SetProtectiveGroupLabelFont>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-PROTECTIVE-GROUP-LABEL-FONT

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-PROTECTIVE-GROUP-LABEL-FONT

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-PROTECTIVE-GROUP-LABEL-FONT

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-PROTECTIVE-GROUP-LABEL-FONT

      .. _figure_OE2DMolDisplayOptions_SetProtectiveGroupLabelFont:

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

         **Example of using the SetProtectiveGroupLabelFont method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetProtectiveGroupLabelFont` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetProtectiveGroupStyle` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetSuperAtomStyle` method
         * :ref:`OEFont <OEDepict_OEFont>` class

      .. note::

         * The size of the protective group fonts also depends on
           the scaling factor used to fit a molecule to a given dimension
           (:oe:meth:`OEDepict::OE2DMolDisplayOptions::SetScale`).


   .. _OEDepict_SetProtectiveGroupStyle:


   .. oe:method:: SetProtectiveGroupStyle


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

         .. oe:api::

            void SetProtectiveGroupStyle(unsigned int style)

      .. oe:language:: python

         .. oe:api:: python

            SetProtectiveGroupStyle(style: int) -> None

      Sets the style that controls whether or not specific pre-defined
      protective group are contracted and labeled with corresponding
      abbreviations.

      *style*
         This value has to be from the :oe:constns:`OEDepict::OEProtectiveGroupStyle`
         namespace.

      **Example:** (:ref:`Figure: Example of using the SetProtectiveGroupStyle method<figure_OE2DMolDisplayOptions_SetProtectiveGroupStyle>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-PROTECTIVE-GROUP-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-PROTECTIVE-GROUP-STYLE

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-PROTECTIVE-GROUP-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-PROTECTIVE-GROUP-STYLE


      .. _figure_OE2DMolDisplayOptions_SetProtectiveGroupStyle:

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

         **Example of using the SetProtectiveGroupStyle method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::HasProtectiveGroupStyle` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetProtectiveGroupLabelFont` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetSuperAtomStyle` method
         * :oe:constns:`OEDepict::OEProtectiveGroupStyle` namespace


   .. _OEDepict_SetScale:


   .. oe:method:: SetScale


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

         .. oe:api::

            void SetScale(double scale)

      .. oe:language:: python

         .. oe:api:: python

            SetScale(scale: float) -> None

      Sets the scaling factor used to magnify a molecule.

      *scale*
         This number has to be non-negative number.

      **Example:** (:ref:`Figure: Example of using the SetScale method<figure_OE2DMolDisplayOptions_SetScale>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SCALE

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SCALE

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SCALE

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SCALE


      .. _figure_OE2DMolDisplayOptions_SetScale:

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

         **Example of using the SetScale method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetScale` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetDimensions` method
         * :ref:`section_mol_display_size` section


   .. _OEDepict_SetSuperAtomLabelFont:


   .. oe:method:: SetSuperAtomLabelFont


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

         .. oe:api::

            void SetSuperAtomLabelFont(const OEFont& font)

      .. oe:language:: python

         .. oe:api:: python

            SetSuperAtomLabelFont(font: OEFont) -> None

      Sets the font that is used to display the abbreviations
      of contracted functional groups.

      **Example:** (:ref:`Figure: Example of using the SetSuperAtomLabelFont method<figure_OE2DMolDisplayOptions_SetSuperAtomLabelFont>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SUPER-ATOM-LABEL-FONT

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SUPER-ATOM-LABEL-FONT

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SUPER-ATOM-LABEL-FONT

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SUPER-ATOM-LABEL-FONT


      .. _figure_OE2DMolDisplayOptions_SetSuperAtomLabelFont:

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

         **Example of using the SetSuperAtomLabelFont method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetSuperAtomLabelFont` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetSuperAtomStyle` method
         * :ref:`OEFont <OEDepict_OEFont>` class

      .. note::

         * The size of the super atom  fonts also depends on
           the scaling factor used to fit a molecule to a given dimension
           (:oe:meth:`OEDepict::OE2DMolDisplayOptions::SetScale`).

   .. _OEDepict_SetSuperAtomStyle:


   .. oe:method:: SetSuperAtomStyle


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

         .. oe:api::

            void SetSuperAtomStyle(unsigned int style)

      .. oe:language:: python

         .. oe:api:: python

            SetSuperAtomStyle(style: int) -> None

      Sets the style that controls whether or not specific pre-defined
      functional groups are contracted and labeled with corresponding
      abbreviations.

      *style*
         This value has to be from the :oe:constns:`OEDepict::OESuperAtomStyle`
         namespace.

      **Example:** (:ref:`Figure: Example of using the SetSuperAtomStyle method<figure_OE2DMolDisplayOptions_SetSuperAtomStyle>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SUPER-ATOM-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SUPER-ATOM-STYLE

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SUPER-ATOM-STYLE

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-SUPER-ATOM-STYLE


      .. _figure_OE2DMolDisplayOptions_SetSuperAtomStyle:

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

         **Example of using the SetSuperAtomStyle method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetSuperAtomStyle` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetSuperAtomLabelFont` method
         * :oe:constns:`OEDepict::OESuperAtomStyle` namespace


   .. _OEDepict_SetTitleFont:


   .. oe:method:: SetTitleFont


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

         .. oe:api::

            void SetTitleFont(const OEFont& font)

      .. oe:language:: python

         .. oe:api:: python

            SetTitleFont(font: OEFont) -> None

      Sets the font that is used to display the title of the molecule
      (*i.e.* the string returned by the :oe:meth:`OEChem::OEMolBase::GetTitle`
      method).

      **Example:** (:ref:`Figure: Example of using the SetTitleFont method<figure_OE2DMolDisplayOptions_SetTitleFont>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-TITLE-FONT

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-TITLE-FONT

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-TITLE-FONT

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-TITLE-FONT

      .. _figure_OE2DMolDisplayOptions_SetTitleFont:

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

         **Example of using the SetTitleFont method**

      .. note::

         The size of the title font also depends on:

         * the width and height of the molecule display

         * the height of the title area that can be set by :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetTitleHeight`
           method

         * the multiplier that can be set by the :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetTitleFontScale`
           method

         See example in :ref:`Figure: Example of scaling the title along with the molecule
         <figure_OE2DMolDisplayOptions_SetTitleFont_Scaling>`

      .. _figure_OE2DMolDisplayOptions_SetTitleFont_Scaling:

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

         **Example of scaling the title along with molecule**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetTitleFont` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetTitleFontScale` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetTitleHeight` method
         * :ref:`OEFont <OEDepict_OEFont>` class


   .. _OEDepict_SetTitleFontScale:


   .. oe:method:: SetTitleFontScale


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

         .. oe:api::

            void SetTitleFontScale(double scale)

      .. oe:language:: python

         .. oe:api:: python

            SetTitleFontScale(scale: float) -> None

      Sets the multiplier that can be used increase or decrease the
      size of the fonts of the atom labels.

      *scale*
         This value has to be either ``0.0`` or in a range of ``[0.5, 2.0]``.
         See examples in :ref:`Examples of scaling the font of title relative to the molecule
         <figure_OE2DMolDisplayOptions_SetTitleFont_ScalingFactor>`
         In case of ``0.0``, the title is not scaled with the molecule
         but rather fixed font size is used regardless of dimensions of the
         image.
         See example in :ref:`Figure: Example of titles with fixed font size<figure_OE2DMolDisplayOptions_SetTitleFont_NoScaling>`

      .. _figure_OE2DMolDisplayOptions_SetTitleFont_ScalingFactor:

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

         **Examples of scaling the font of title relative to the molecule**

      .. _figure_OE2DMolDisplayOptions_SetTitleFont_NoScaling:

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

         **Example of titles with fixed font size**


      **Example:** (:ref:`Figure: Example of using the SetTitleFontScale method<figure_OE2DMolDisplayOptions_SetTitleFontScale>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-TITLE-FONT-SCALE

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-TITLE-FONT-SCALE

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-TITLE-FONT-SCALE

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-TITLE-FONT-SCALE

      .. _figure_OE2DMolDisplayOptions_SetTitleFontScale:

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

         **Example of using the SetTitleFontScale method**


      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetTitleFontScale` method


   .. _OEDepict_SetTitleLocation:


   .. oe:method:: SetTitleLocation


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

         .. oe:api::

            void SetTitleLocation(unsigned int loc)

      .. oe:language:: python

         .. oe:api:: python

            SetTitleLocation(loc: int) -> None

      Sets the position of the molecule title.

      *loc*
         This value has to be from the :oe:constns:`OEDepict::OETitleLocation`
         namespace.

      **Example:** (:ref:`Figure: Example of using the SetTitleLocation method<figure_OE2DMolDisplayOptions_SetTitleLocation>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-TITLE-LOCATION

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-TITLE-LOCATION

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-TITLE-LOCATION

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-TITLE-LOCATION


      .. _figure_OE2DMolDisplayOptions_SetTitleLocation:

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

         **Example of using the SetTitleLocation method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetTitleLocation` method
         * :oe:constns:`OEDepict::OETitleLocation` namespace


   .. _OEDepict_SetTitleHeight:


   .. oe:method:: SetTitleHeight


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

         .. oe:api::

            bool SetTitleHeight(double height)

      .. oe:language:: python

         .. oe:api:: python

            SetTitleHeight(percent: float) -> bool

      Sets the height of the title area of the
      :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>` object.

      *height*
         This number is considered as a percentage of the height
         of the molecule display and has to be in the range of ``[5.0%, 25.0%]``.
         See example in :ref:`Figure: Example of setting height of the title area to 5%, 10% (default) and 25%
         <figure_OE2DMolDisplayLayout_SetTitleHeight>`.

      .. _figure_OE2DMolDisplayLayout_SetTitleHeight:

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

         **Example of setting height of the title area to 5%, 10% (default) and 25%**

      .. note::

         A molecule display has a title area only if the title location is not
         hidden. See also :oe:constns:`OEDepict::OETitleLocation` namespace.


      **Example:** (:ref:`Figure: Example of using the SetTitleHeight method<figure_OE2DMolDisplayOptions_SetTitleHeight>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-TITLE-HEIGHT


      .. _figure_OE2DMolDisplayOptions_SetTitleHeight:

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

         **Example of using the SetTitleHeight method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetTitleHeight` method


   .. _OEDepict_SetWidth:


   .. oe:method:: SetWidth


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

         .. oe:api::

            void SetWidth(double width)

      .. oe:language:: python

         .. oe:api:: python

            SetWidth(width: float) -> None

      Sets the horizontal limit into which the molecule has to be fitted.

      *width*
         This number has to be non-negative number.

      **Example:** (:ref:`Figure: Example of using the SetWidth method<figure_OE2DMolDisplayOptions_SetWidth>`)

      .. oe:source:: OE2DMolDisplayOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-WIDTH

      .. oe:source:: OE2DMolDisplayOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-WIDTH

      .. oe:source:: OE2DMolDisplayOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-WIDTH

      .. oe:source:: OE2DMolDisplayOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OE2DMOLDISPLAY-OPTIONS-WIDTH


      .. _figure_OE2DMolDisplayOptions_SetWidth:

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

         **Example of using the SetWidth method**

      .. seealso::

         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::GetWidth` method
         * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetDimensions` method
         * :ref:`section_mol_display_size` section
