.. include:: ../substitutions

.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEConfigureImageGridNumColumns

.. _OEDepict_OEConfigureImageGridNumColumns:


.. oe:function:: OEConfigureImageGridNumColumns


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

      .. oe:api::

         bool OEConfigureImageGridNumColumns(OESystem::OEInterface& itf,
                                             std::string name = OEImageGridParamName::NumColumns,
                                             std::string alias = "-cols")
         bool OEConfigureImageGridNumColumns(OESystem::OEInterface& itf,
                                             unsigned int defnumcols,
                                             std::string = OEImageGridParamName::NumColumns,
                                             std::string alias = "-cols")

   .. oe:language:: python

      .. oe:api:: python

         OEConfigureImageGridNumColumns(itf: OEInterface, name: str,
                                        alias: str = "-cols") -> bool
         OEConfigureImageGridNumColumns(itf: OEInterface, defnumcols: int,
                                        arg3: str, alias: str = "-cols") -> bool

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

   *itf*
      The interface being configured.

   *defnumcols*
      The default number of columns.

   *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::NumColumns` constant
      * :oe:const:`OEDepict::OEImageGridParamName::NumColumns` constant
      * :oe:func:`OEDepict::OEConfigureImageGridParams` function
      * :oe:func:`OEDepict::OEGetImageGridNumColumns` function
