.. include:: ../../common/cookbook/cookbook-hyperlinks
.. include:: ../substitutions

.. oe:namespace:: OEGrapheme

.. oe:function:: OEDrawUnpairedInteractionMapLegend

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

      .. oe:api::

         void OEDrawUnpairedInteractionMapLegend(OEDepict::OEImageBase& image,
                                                 const OE2DActiveSiteDisplay& adisp,
                                                 const OE2DActiveSiteLegendDisplayOptions& opts)

   .. oe:language:: python

      .. oe:api:: python

         OEDrawUnpairedInteractionMapLegend(image: OEImageBase,
                                            adisp: OE2DActiveSiteDisplay,
                                            opts: OE2DActiveSiteLegendDisplayOptions) -> None

   Draws legend for unpaired interaction map.

   *image*
      The image in which the color gradient is drawn.

   *adisp*
      The :ref:`OE2DActiveSiteDisplay <OEGrapheme_OE2DActiveSiteDisplay>` object that holds the
      data necessary to depict the B-factor information of an active site.

   *opts*
      The :ref:`OE2DActiveSiteLegendDisplayOptions <OEGrapheme_OE2DActiveSiteLegendDisplayOptions>` object that
      determines how the legend is depicted.

   **Example:**

   .. oe:source:: RenderUnpairedMap.py
      :language: python
      :noindent:
      :frag:     SNIPPET-DRAW-UNPAIREDMAP-LEGEND

   .. oe:source:: RenderUnpairedMap.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-DRAW-UNPAIREDMAP-LEGEND

   .. oe:source:: RenderUnpairedMap.java
      :language: java
      :noindent:
      :frag:     SNIPPET-DRAW-UNPAIREDMAP-LEGEND

   .. oe:source:: RenderUnpairedMap.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-DRAW-UNPAIREDMAP-LEGEND

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

      **Example of using the OEDrawUnpairedInteractionMapLegend function**

   .. seealso::

      * :oe:func:`OEGrapheme::OERenderUnpairedInteractionMap` function

   .. admonition:: Code Example

      * `Visualizing Protein-Ligand Unpaired Interactions`_ **OpenEye Python Cookbook** recipe
