.. include:: ../substitutions

.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEConfigureImageGridNumRows

.. _OEDepict_OEConfigureImageGridNumRows:


.. oe:function:: OEConfigureImageGridNumRows


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

      .. oe:api::

         bool OEConfigureImageGridNumRows(OESystem::OEInterface& itf,
                                          std::string name = OEImageGridParamName::NumRows,
                                          std::string alias = "-rows")
         bool OEConfigureImageGridNumRows(OESystem::OEInterface& itf,
                                          unsigned int defnumrows,
                                          std::string = OEImageGridParamName::NumRows,
                                          std::string alias = "-rows")

   .. oe:language:: python

      .. oe:api:: python

         OEConfigureImageGridNumRows(itf: OEInterface, name: str,
                                     alias: str = "-rows") -> bool
         OEConfigureImageGridNumRows(itf: OEInterface, defnumrows: int,
                                     arg3: str, alias: str = "-rows") -> bool


   Adds a parameter to the given interface to allows the configuration
   of the number of grid rows.

   *itf*
      The interface being configured.

   *defnumrows*
      The default number of rows.

   *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::OEImageGridSetup::NumRows` constant
      * :oe:const:`OEDepict::OEImageGridParamName::NumRows` constant
      * :oe:func:`OEDepict::OEConfigureImageGridParams` function
      * :oe:func:`OEDepict::OEGetImageGridNumRows` function
