.. include:: ../substitutions

.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEConfigureHighlightColor

.. _OEDepict_OEConfigureHighlightColor:


.. oe:function:: OEConfigureHighlightColor


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

      .. oe:api::

         bool OEConfigureHighlightColor(OESystem::OEInterface& itf,
                                        std::string name = OEHighlightParamName::Color,
                                        std::string alias = "-hcolor")

   .. oe:language:: python

      .. oe:api:: python

         OEConfigureHighlightColor(itf: OEInterface, name: str,
                                   alias: str = "-hcolor") -> bool

   Adds a *highlighting color* parameter to the given interface.

   *itf*
      The interface being configured.

   *name*
      The name of the color parameter.

   *alias*
      The alternative *i.e.* alias name of the parameter.

   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :ref:`OEColor <OESystem_OEColor>` class
      * :oe:const:`OEDepict::OEHighlightSetup::Color` constant
      * :oe:const:`OEDepict::OEHighlightParamName::Color` constant
      * :oe:func:`OEDepict::OEGetHighlightColor` function
