
.. include:: ../substitutions

.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEConfigureImageWidth

.. _OEDepict_OEConfigureImageWidth:


.. oe:function:: OEConfigureImageWidth


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

      .. oe:api::

         bool OEConfigureImageWidth (OESystem::OEInterface& itf,
                                     double defwidth = 0.0,
                                     std::string = OEImageParamName::Width,
                                     std::string alias = "-w")

   .. oe:language:: python

      .. oe:api:: python

         OEConfigureImageWidth(itf: OEInterface, defwidth: float = 0.0,
                               arg3: str, alias: str = "-w") -> bool

   Adds a parameter to the given interface to allows the configuration
   of the image width.

   *itf*
      The interface being configured.

   *defwidth*
      Default width value.

   *name*
      The name of the parameter.

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

   .. seealso::

      * :ref:`OEInterface <OESystem_OEInterface>` class in the **OEChem TK** manual
      * :oe:const:`OEDepict::OEImageSetup::Width` constant
      * :oe:const:`OEDepict::OEImageParamName::Width` constant
      * :oe:func:`OEDepict::OEConfigureImageOptions` function
      * :oe:func:`OEDepict::OEGetImageWidth` function
