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

.. oe:namespace:: OEDepict

.. _OEDepict_OEAddInteractiveIcon:


.. oe:function:: OEAddInteractiveIcon


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

      .. oe:api::

         void OEAddInteractiveIcon(OE2DMolDisplay& disp,
                                   unsigned int loc = OEIconLocation::Default,
                                   double scale = 1.0)
         void OEAddInteractiveIcon(OEImageBase& image,
                                   unsigned int loc = OEIconLocation::Default,
                                   double scale = 1.0)

   .. oe:language:: python

      .. oe:api:: python

         OEAddInteractiveIcon(disp: OE2DMolDisplay, loc: int,
                              scale: float = 1.0) -> None
         OEAddInteractiveIcon(image: OEImageBase, loc: int, scale: float = 1.0) -> None

   Adds an icon to an image or a molecule display that indicates that the image
   is interactive.

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

   *scale*
      The multiplier that can be used to increase or decrease the size of the icon.
      This value has to be in the range of ``[0.5, 2.0]``.

.. only:: oehtml

   .. raw:: html

      <p align="center">
      <b>hover the mouse over on the rectangle below</b>
      </p>

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

      <p align="center">
      <b>Example of adding the logo to an interactive SVG image</b>
      <p>

   .. image:: ../../depicttk/images/AddSVGHover.svg
      :width: 1pt

   .. only:: oepdf

      |NOPDFIMAGE|
