.. include:: ../../common/cookbook/cookbook-hyperlinks

.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OE2DActiveSiteLegendDisplayOptions, 2DActiveSiteLegendDisplayOptions


.. _OEGrapheme_OE2DActiveSiteLegendDisplayOptions:

.. oe:class:: OE2DActiveSiteLegendDisplayOptions

   .. oe:api::

      class OE2DActiveSiteLegendDisplayOptions

   This class represents :ref:`OE2DActiveSiteLegendDisplayOptions <OEGrapheme_OE2DActiveSiteLegendDisplayOptions>` that encapsulates
   properties that determine how the legend of a color force field is depicted by
   the :oe:func:`OEGrapheme::OEDrawActiveSiteLegend` function.

   .. seealso::

      * :oe:func:`OEGrapheme::OE2DActiveSiteDisplay` class
      * :oe:func:`OEGrapheme::OEDrawActiveSiteLegend` function

   .. admonition:: Code Example

      * :ref:`section_examples_summary_complex2img` example
      * `Visualizing Protein-Ligand Interactions`_ **OpenEye Python Cookbook** recipe


   .. oe:method:: Constructors

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

         .. oe:api::

            OE2DActiveSiteLegendDisplayOptions(unsigned int rows,
                                               unsigned int cols)

      .. oe:language:: python

         .. oe:api:: python

            OE2DActiveSiteLegendDisplayOptions(rows: int, cols: int) -> OE2DActiveSiteLegendDisplayOptions

      Creates an :ref:`OE2DActiveSiteLegendDisplayOptions <OEGrapheme_OE2DActiveSiteLegendDisplayOptions>` object with the
      specified number of rows and columns..

      *rows*
        The number of rows in the legend.

      *cols*
         The number of columns in the legend.

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

         .. oe:api::

            OE2DActiveSiteLegendDisplayOptions(const OE2DActiveSiteLegendDisplayOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OE2DActiveSiteLegendDisplayOptions(rhs: OE2DActiveSiteLegendDisplayOptions) -> OE2DActiveSiteLegendDisplayOptions

      Copy constructor.


   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OE2DActiveSiteLegendDisplayOptions &operator=(const OE2DActiveSiteLegendDisplayOptions &rhs)

      Assignment operator.


   .. oe:method:: NumCols

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

         .. oe:api::

            unsigned int NumCols() const

      .. oe:language:: python

         .. oe:api:: python

            NumCols() -> int

      Returns the number of columns of the legend.


   .. oe:method:: NumRows

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

         .. oe:api::

            unsigned int NumRows() const

      .. oe:language:: python

         .. oe:api:: python

            NumRows() -> int

