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

.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEAddHighlightOverlay

.. _OEDepict_OEAddHighlightOverlay:


.. oe:function:: OEAddHighlightOverlay


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

      .. oe:api::

         void OEAddHighlightOverlay(OE2DMolDisplay& disp,
                                    const OEHighlightOverlayBase& highlight,
                                    OESystem::OEIter<OEChem::OEMatchBase>& matches)
         void OEAddHighlightOverlay(OE2DMolDisplay& disp,
                                    const OEHighlightOverlayBase& highlight,
                                    OESystem::OEIter<OEChem::OEAtomBondSet>& absets)
         void OEAddHighlightOverlay(OE2DMolDisplay& disp,
                                    const OEHighlightOverlayBase& highlight,
                                    OESystem::OEIterBase<OEChem::OEMatchBase>* matches)
         void OEAddHighlightOverlay(OE2DMolDisplay& disp,
                                    const OEHighlightOverlayBase& highlight,
                                    OESystem::OEIterBase<OEChem::OEAtomBondSet>* absets)
         void OEAddHighlightOverlay(OE2DMolDisplay& disp,
                                    const OEHighlightOverlayBase& highlight,
                                    const std::vector<OEChem::OEAtomBondSet>& absets)

   .. oe:language:: python

      .. oe:api:: python

         OEAddHighlightOverlay(disp: OE2DMolDisplay,
                               highlight: OEHighlightOverlayBase,
                               matches: OEMatchBaseIter) -> None
         OEAddHighlightOverlay(disp: OE2DMolDisplay,
                               highlight: OEHighlightOverlayBase,
                               absets: OEAtomBondSetIter) -> None
         OEAddHighlightOverlay(disp: OE2DMolDisplay,
                               highlight: OEHighlightOverlayBase,
                               absets: OEAtomBondSetVector) -> None

   Highlights a set of atoms and/or bonds of the displayed molecule.

   **Parameters :**

   *disp*
      The :ref:`OE2DMolDisplay <OEDepict_OE2DMolDisplay>` object of which atoms
      add/or bonds being highlighted.

   *highlight*
      The :ref:`OEHighlightOverlayBase <OEDepict_OEHighlightOverlayBase>` object that specifies the style of the highlighting.

   *matches*
      The iterator of :ref:`OEMatchBase <OEChem_OEMatchBase>` objects of which
      target atoms and bonds being highlighted.

   *absets*
      The iterator of :ref:`OEAtomBondSet <OEChem_OEAtomBondSet>` objects of which
      atoms and bonds being highlighted.

   .. note::

      Each pattern will be highlighted with a different color returned by the
      :oe:meth:`OEDepict::OEHighlightOverlayBase::GetColors` method.

   .. seealso::

      * :ref:`OEHighlightOverlayBase <OEDepict_OEHighlightOverlayBase>` class
      * :oe:constns:`OEDepict::OEHighlightOverlayStyle` namespace
      * :ref:`section_highlighting_overlap` section

