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

.. oe:namespace:: OEDepict

.. oe:constnamespace:: OELegendInteractiveStyle

   This namespace contains constants that define built-in legend interactive styles.

   .. seealso::

      * :ref:`OELegendLayout <OEDepict_OELegendLayout>` class
      * :ref:`OELegendLayoutOptions <OEDepict_OELegendLayoutOptions>` class
      * :oe:constns:`OEDepict::OELegendLayoutStyle` namespace
      * :oe:constns:`OEDepict::OELegendColorStyle` namespace


   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Default

      The default legend interactive style is
      :oe:const:`OEDepict::OELegendInteractiveStyle::Hover`.

   .. oe:constant:: Hover

      .. note::

         This style is **only available** for :file:`.svg` image format.

   .. only:: oehtml

      .. raw:: html

         <p align="center">
         <b>hover mouse over the "Legend" label</b>
         </p>

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

         <p align="center">
         <b>Example of using the 'Hover' interactive style</b>
         <p>

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

      .. only:: oepdf

         |NOPDFIMAGE|

   .. oe:constant:: Permanent

   .. only:: oehtml

      .. figure:: ../../depicttk/images/OELegendInteractiveStyle_Permanent.svg
         :align:  center
         :width: 300 pt

         **Example of using the 'Permanent' style (not interactive)**

      .. only:: oepdf

         |NOPDFIMAGE|

   .. oe:constant:: Toggle

      .. note::

         This style is **only available** for :file:`.svg` image format.

   .. only:: oehtml

      .. raw:: html

         <p align="center">
         <b>click on the "Legend" label</b>
         </p>

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

         <p align="center">
         <b>Example of using the 'Toggle' interactive style</b>
         <p>

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

      .. only:: oepdf

         |NOPDFIMAGE|
