.. oe:namespace:: OEGrapheme



.. meta::
   :keywords: OEColorForceFieldLegendDisplayOptions, ColorForceFieldLegendDisplayOptions


.. _OEGrapheme_OEColorForceFieldLegendDisplayOptions:

.. oe:class:: OEColorForceFieldLegendDisplayOptions

   .. oe:api::

      class OEColorForceFieldLegendDisplayOptions

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

   .. seealso::

      * :ref:`OEColorForceFieldDisplay <OEGrapheme_OEColorForceFieldDisplay>` class
      * :oe:func:`OEGrapheme::OEDrawColorForceFieldLegend` function


   .. oe:method:: Constructors

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

         .. oe:api::

            OEColorForceFieldLegendDisplayOptions(unsigned int rows,
                                                  unsigned int cols)

      .. oe:language:: python

         .. oe:api:: python

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

      Creates an :ref:`OEColorForceFieldLegendDisplayOptions <OEGrapheme_OEColorForceFieldLegendDisplayOptions>`
      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::

            OEColorForceFieldLegendDisplayOptions(const OEColorForceFieldLegendDisplayOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEColorForceFieldLegendDisplayOptions(rhs: OEColorForceFieldLegendDisplayOptions) -> OEColorForceFieldLegendDisplayOptions

      Copy constructor.


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

      .. oe:api::

         OEColorForceFieldLegendDisplayOptions &operator=(const OEColorForceFieldLegendDisplayOptions &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

      Returns the number of rows of the legend.
