.. include:: ../substitutions

.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEConfigure2DMolDisplayOptions

.. _OEDepict_OEConfigure2DMolDisplayOptions:


.. oe:function:: OEConfigure2DMolDisplayOptions


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

      .. oe:api::

         bool OEConfigure2DMolDisplayOptions(OESystem::OEInterface& itf,
                                             unsigned int config = OE2DMolDisplaySetup::All)

   .. oe:language:: python

      .. oe:api:: python

         OEConfigure2DMolDisplayOptions(itf: OEInterface, config: int) -> bool

   Configures the given interface to add molecule depiction style
   parameters.

   *itf*
      The interface being configured.

   *config*
      The option that specifies which parameters will be added to the
      interface
      This value has to be from the
      :oe:constns:`OEDepict::OE2DMolDisplaySetup` namespace.

   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :oe:constns:`OEDepict::OE2DMolDisplaySetup` namespace
      * :oe:func:`OEDepict::OESetup2DMolDisplayOptions` function


   :oe:func:`OEDepict::OEConfigure2DMolDisplayOptions` is the utility function
   that allows to easily generate consistent command line interface for
   depiction examples and applications.
   For each command line options the generated interface will include
   information about related APIs in **OEDepict TK**, For example:

   .. oe:language:: c++

      .. code-block:: console

         prompt> mol2img --help -aromstyle

   .. oe:language:: python

      .. code-block:: console

         prompt> python mol2img.py --help -aromstyle

   .. oe:language:: java

      .. code-block:: console

         prompt> java Mol2Img --help -aromstyle

   .. oe:language:: csharp

      .. code-block:: console

         prompt> Mol2Img --help -aromstyle

   will reveals that the `-aromstyle` command line parameter is related to the
   :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAromaticStyle` method and the
   :oe:constns:`OEDepict::OEAromaticStyle` namespace
   (see the "Details" section below):

   .. code-block:: console

      Contents of parameter -aromstyle
       Aliases : -astl
       Type : string
       Allow list : false
       Default : Kekule
       Simple : true
       Required : false
       Legal values : Kekule Circle Dash
       Brief : Aromatic ring display style
       Detail

      API : OE2DMolDisplayOptions::SetAromaticStyle method and OEAromaticStyle namespace

   When generating an html help file:

   .. oe:language:: c++

      .. code-block:: console

         prompt> mol2img --help html

         Creating 'mol2img.py_help.html'

   .. oe:language:: python

      .. code-block:: console

         prompt> python mol2img.py --help html

         Creating 'mol2img.py_help.html'

   .. oe:language:: java

      .. code-block:: console

         prompt> java Mol2Img --help html
         Creating 'mol2img.py_help.html'

   .. oe:language:: csharp

      .. code-block:: console

         prompt> Mol2Img --help html

         Creating 'mol2img.py_help.html'

   The generated 'mol2img.py_help.html' file will contain hyperlinks to
   related APIs in the **OEDepict TK** documentation.

   .. seealso::

      * :ref:`section_examples_summary_mol2img`
