.. oe:namespace:: OEDepict


.. _OEDepict_OEImageTableOptions:

.. oe:class:: OEImageTableOptions

   .. oe:api::

      class OEImageTableOptions

   This class represents the :ref:`OEImageTableOptions <OEDepict_OEImageTableOptions>` class
   that encapsulates properties that determine how an image table is depicted.

   The :ref:`OEImageTableOptions <OEDepict_OEImageTableOptions>` class stores the following properties:

   .. list-table::
      :widths: 100 100 100 150
      :header-rows: 1

      * - Property
        - Get method
        - Set method
        - Corresponding namespace / class / type

      * - number of columns
        - :oe:meth:`NumColumns<OEDepict::OEImageTableOptions::NumColumns>`
        -
        - integer greater than 0

      * - number of rows
        - :oe:meth:`NumRows<OEDepict::OEImageTableOptions::NumRows>`
        -
        - integer greater than 1

      * - width of columns
        -
        - :oe:meth:`SetColumnWidths<OEDepict::OEImageTableOptions::SetColumnWidths>`
        - vector of non zero integers

      * - height of rows
        -
        - :oe:meth:`SetRowHeights<OEDepict::OEImageTableOptions::SetRowHeights>`
        - vector of non zero integers

      * - cell font size
        -
        - :oe:meth:`SetBaseFontSize<OEDepict::OEImageTableOptions::SetBaseFontSize>`
        - positive non-zero integer

      * - pen used around cells cells
        - :oe:meth:`GetCellBorderPen<OEDepict::OEImageTableOptions::GetCellBorderPen>`
        - :oe:meth:`SetCellBorderPen<OEDepict::OEImageTableOptions::SetCellBorderPen>`
        - :ref:`OEPen <OEDepict_OEPen>`

      * - table cell color
        - :oe:meth:`GetCellColor<OEDepict::OEImageTableOptions::GetCellColor>`
        - :oe:meth:`SetCellColor<OEDepict::OEImageTableOptions::SetCellColor>`
        - :ref:`OEColor <OESystem_OEColor>`

      * - table cell font
        - :oe:meth:`GetCellFont<OEDepict::OEImageTableOptions::GetCellFont>`
        - :oe:meth:`SetCellFont<OEDepict::OEImageTableOptions::SetCellFont>`
        - :ref:`OEFont <OEDepict_OEFont>`

      * - header
        - :oe:meth:`HasHeader<OEDepict::OEImageTableOptions::HasHeader>`
        - :oe:meth:`SetHeader<OEDepict::OEImageTableOptions::SetHeader>`
        - boolean

      * - header color
        - :oe:meth:`GetHeaderColor<OEDepict::OEImageTableOptions::GetHeaderColor>`
        - :oe:meth:`SetHeaderColor<OEDepict::OEImageTableOptions::SetHeaderColor>`
        - :ref:`OEColor <OESystem_OEColor>`

      * - header font
        - :oe:meth:`GetHeaderFont<OEDepict::OEImageTableOptions::GetHeaderFont>`
        - :oe:meth:`SetHeaderFont<OEDepict::OEImageTableOptions::SetHeaderFont>`
        - :ref:`OEFont <OEDepict_OEFont>`

      * - table margins
        - :oe:meth:`GetMargin<OEDepict::OEImageTableOptions::GetMargin>`
        - :oe:meth:`SetMargin<OEDepict::OEImageTableOptions::SetMargin>` / :oe:meth:`SetMargins<OEDepict::OEImageTableOptions::SetMargins>`
        - positive floating point number in the range of :math:`[0.0, 25.0]`

      * - stub column
        - :oe:meth:`HasStubColumn<OEDepict::OEImageTableOptions::HasStubColumn>`
        - :oe:meth:`SetStubColumn<OEDepict::OEImageTableOptions::SetStubColumn>`
        - boolean

      * - stub column color
        - :oe:meth:`GetStubColumnColor<OEDepict::OEImageTableOptions::GetStubColumnColor>`
        - :oe:meth:`SetStubColumnColor<OEDepict::OEImageTableOptions::SetStubColumnColor>`
        - :ref:`OEColor <OESystem_OEColor>`

      * - stub column font
        - :oe:meth:`GetStubColumnFont<OEDepict::OEImageTableOptions::GetStubColumnFont>`
        - :oe:meth:`SetStubColumnFont<OEDepict::OEImageTableOptions::SetStubColumnFont>`
        - :ref:`OEFont <OEDepict_OEFont>`

   .. seealso::

      * :ref:`section_image_layout_table` section
      * :ref:`OEImageTable <OEDepict_OEImageTable>` class


   .. oe:method:: Constructors

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

         .. oe:api::

            OEImageTableOptions(unsigned int rows, unsigned int cols,
                                unsigned int style = OEImageTableStyle::Default)

      .. oe:language:: python

         .. oe:api:: python

            OEImageTableOptions(rows: int, cols: int, style: int) -> OEImageTableOptions

      Creates an :ref:`OEImageTableOptions <OEDepict_OEImageTableOptions>` object with
      the given parameters.

      **rows**
         The total number of rows in the table including the header.

      **cols**
         The total number of columns in the table including the stub column.

      **style**
         This value has to be from the :oe:constns:`OEDepict::OEImageTableStyle`
         namespace.

      .. note::

         By default, the columns and rows of a table are created with equal
         widths and heights.
         The relative width and height ratio of the columns and rows can be adjusted using the
         :oe:meth:`OEDepict::OEImageTableOptions::SetColumnWidths` and
         :oe:meth:`OEDepict::OEImageTableOptions::SetRowHeights` methods,
         respectively.

      **Example** (:ref:`figure_OEImageTableOptions_Default`)

      .. oe:source:: OEImageTableOpts_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-DEFAULT

      .. oe:source:: OEImageTableOpts_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-DEFAULT

      .. oe:source:: OEImageTableOpts_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-DEFAULT

      .. oe:source:: OEImageTableOpts_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-DEFAULT

      .. _figure_OEImageTableOptions_Default:

      .. figure:: ../images/OEImageTableOptions_Default.*
         :align:  center

         **Example of generating a 4 x 4 image table with header and 'MediumBlue' style**

      .. seealso::

         * :oe:constns:`OEDepict::OEImageTableStyle` namespace
         * :oe:meth:`OEDepict::OEImageTableOptions::NumRows` method
         * :oe:meth:`OEDepict::OEImageTableOptions::NumColumns` method

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

         .. oe:api::

            OEImageTableOptions(const OEImageTableOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEImageTableOptions(arg2: OEImageTableOptions) -> OEImageTableOptions

      Copy constructor.

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

      .. oe:api::

         OEImageTableOptions &operator=(const OEImageTableOptions &)

      Assignment operator.


   .. oe:method:: GetCellBorderPen

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

         .. oe:api::

            const OEPen& GetCellBorderPen() const

      .. oe:language:: python

         .. oe:api:: python

            GetCellBorderPen() -> OEPen

      Returns the pen that is used to mark the border of the cells in the table.

      .. seealso::

         * :ref:`OEPen <OEDepict_OEPen>` class
         * :oe:meth:`OEDepict::OEImageTableOptions::SetCellBorderPen` method


   .. oe:method:: GetCellColor

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

         .. oe:api::

            const OESystem::OEColor GetCellColor(bool even = true) const

      .. oe:language:: python

         .. oe:api:: python

            GetCellColor(even: bool = True) -> OEColor

      .. seealso::

         * :oe:meth:`OEDepict::OEImageTableOptions::SetCellColor` method

      Returns the color used to highlight the 'body' cells in the table.
      A cell is considered to be part of the 'body' of the table if it is neither
      in the header nor in the stub column.

      *even*
        This parameter determines whether to return the color of the even or odd
        rows in the table.

      .. seealso::

         * :ref:`OEColor <OESystem_OEColor>` class
         * :oe:meth:`OEDepict::OEImageTableOptions::SetCellColor` method


   .. oe:method:: GetCellFont

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

         .. oe:api::

            const OEFont GetCellFont() const

      .. oe:language:: python

         .. oe:api:: python

            GetCellFont() -> OEFont

      Returns the font used by the :oe:meth:`OEDepict::OEImageTable::DrawText`
      method to draw text on the 'body' cells.

      .. seealso::

         * :ref:`OEFont <OEDepict_OEFont>` class
         * :oe:meth:`OEDepict::OEImageTableOptions::SetCellFont` method


   .. oe:method:: GetHeaderColor

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

         .. oe:api::

            const OESystem::OEColor GetHeaderColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetHeaderColor() -> OEColor

      Returns the color used to highlight the 'header' cells in the table.

      .. seealso::

         * :ref:`OEColor <OESystem_OEColor>` class
         * :oe:meth:`OEDepict::OEImageTableOptions::SetHeaderColor` method


   .. oe:method:: GetHeaderFont

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

         .. oe:api::

            const OEFont GetHeaderFont() const

      .. oe:language:: python

         .. oe:api:: python

            GetHeaderFont() -> OEFont

      Returns the font used by the :oe:meth:`OEDepict::OEImageTable::DrawText`
      method to draw text on the 'header' cells.

      .. seealso::

         * :ref:`OEFont <OEDepict_OEFont>` class
         * :oe:meth:`OEDepict::OEImageTableOptions::SetHeaderFont` method


   .. oe:method:: GetMargin

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

         .. oe:api::

            double GetMargin(unsigned int margin) const

      .. oe:language:: python

         .. oe:api:: python

            GetMargin(margin: int) -> float

      Returns the ratio of a specific margin of the table.

      *margin*
         This value has to be from the :oe:constns:`OEDepict::OEMargin`
         namespace.

      .. seealso::

         * :oe:meth:`OEDepict::OEImageTableOptions::SetMargin` method
         * :oe:meth:`OEDepict::OEImageTableOptions::SetMargins` method


   .. oe:method:: GetStubColumnColor

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

         .. oe:api::

            const OESystem::OEColor GetStubColumnColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetStubColumnColor() -> OEColor

      Returns the color used to highlight the 'stub column' cells in the table.

      .. seealso::

         * :ref:`OEColor <OESystem_OEColor>` class
         * :oe:meth:`OEDepict::OEImageTableOptions::SetStubColumnColor` method


   .. oe:method:: GetStubColumnFont

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

         .. oe:api::

            const OEFont GetStubColumnFont() const

      .. oe:language:: python

         .. oe:api:: python

            GetStubColumnFont() -> OEFont

      Returns the font used by the :oe:meth:`OEDepict::OEImageTable::DrawText`
      method to draw text on the 'stub column' cells.

      .. seealso::

         * :ref:`OEFont <OEDepict_OEFont>` class
         * :oe:meth:`OEDepict::OEImageTableOptions::SetStubColumnFont` method


   .. oe:method:: HasHeader

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

         .. oe:api::

            bool HasHeader() const

      .. oe:language:: python

         .. oe:api:: python

            HasHeader() -> bool

      Returns whether a table has a 'header' row.
      By default, a table is generated with a 'header' row.

      .. seealso::

         * :oe:meth:`OEDepict::OEImageTableOptions::SetHeader` method
         * :oe:meth:`OEDepict::OEImageTableOptions::HasStubColumn` method
         * :oe:meth:`OEDepict::OEImageTableOptions::SetStubColumn` method


   .. oe:method:: HasStubColumn

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

         .. oe:api::

            bool HasStubColumn() const

      .. oe:language:: python

         .. oe:api:: python

            HasStubColumn() -> bool

      Returns whether the table has a 'stub' column.
      By default, a table is generated without a 'stub' column.

      .. seealso::

         * :oe:meth:`OEDepict::OEImageTableOptions::SetStubColumn` method
         * :oe:meth:`OEDepict::OEImageTableOptions::HasHeader` method
         * :oe:meth:`OEDepict::OEImageTableOptions::SetHeader` method


   .. oe:method:: NumColumns

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

         .. oe:api::

            unsigned int NumColumns() const

      .. oe:language:: python

         .. oe:api:: python

            NumColumns() -> int

      Returns the total number of columns in the table including the
      stub column.


   .. oe:method:: NumRows

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

         .. oe:api::

            unsigned int NumRows() const

      .. oe:language:: python

         .. oe:api:: python

            NumRows() -> int

      Returns the total number of rows in the table including the
      header row.


   .. oe:method:: SetBaseFontSize

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

         .. oe:api::

            void SetBaseFontSize(unsigned int fontsize)

      .. oe:language:: python

         .. oe:api:: python

            SetBaseFontSize(fsize: int) -> None

      Controls the font size in add table cells (including cells of header,
      stub column and body).

      .. seealso::

         The other properties of the used fonts can be controlled with
         the following methods:

         * :oe:meth:`OEDepict::OEImageTableOptions::SetCellFont` method
         * :oe:meth:`OEDepict::OEImageTableOptions::SetHeaderFont` method
         * :oe:meth:`OEDepict::OEImageTableOptions::SetStubColumnFont` method


   .. oe:method:: SetCellBorderPen

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

         .. oe:api::

            void SetCellBorderPen(const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            SetCellBorderPen(p: OEPen) -> None

      Sets the pen that is used to mark the border of the cells in the table.

      **Example** (:ref:`figure_OEImageTableOptions_SetCellBorderPen`)

      .. oe:source:: OEImageTableOpts_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETCELLBORDERPEN

      .. oe:source:: OEImageTableOpts_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETCELLBORDERPEN

      .. oe:source:: OEImageTableOpts_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETCELLBORDERPEN

      .. oe:source:: OEImageTableOpts_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETCELLBORDERPEN

      .. _figure_OEImageTableOptions_SetCellBorderPen:

      .. figure:: ../images/OEImageTableOptions_SetCellBorderPen.*
         :align:  center

         **Example of using the SetCellBorderPen method**

      .. seealso::

         * :ref:`OEPen <OEDepict_OEPen>` class
         * :oe:meth:`OEDepict::OEImageTableOptions::GetCellBorderPen` method


   .. oe:method:: SetCellColor

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

         .. oe:api::

            void SetCellColor(const OESystem::OEColor& color, bool even = true)

      .. oe:language:: python

         .. oe:api:: python

            SetCellColor(arg2: OEColor, even: bool = True) -> None

      Sets the color used to highlight the 'body' cells in the table.
      A cell is considered to be part of the 'body' of the table if it is neither
      in the header nor in the stub column.

      *color*
        The color of the cells.

      *even*
        This parameter determines whether the color is applied to the even or to
        the odd rows of the table.

      **Example** (:ref:`figure_OEImageTableOptions_SetCellColor`)

      .. oe:source:: OEImageTableOpts_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETCELLCOLOR

      .. oe:source:: OEImageTableOpts_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETCELLCOLOR

      .. oe:source:: OEImageTableOpts_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETCELLCOLOR

      .. oe:source:: OEImageTableOpts_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETCELLCOLOR

      .. _figure_OEImageTableOptions_SetCellColor:

      .. figure:: ../images/OEImageTableOptions_SetCellColor.*
         :align:  center

         **Example of using the SetCellColor method**

      .. seealso::

         * :ref:`OEColor <OESystem_OEColor>` class
         * :oe:meth:`OEDepict::OEImageTableOptions::GetCellColor` method


   .. oe:method:: SetCellFont

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

         .. oe:api::

            void SetCellFont(const OEFont& font)

      .. oe:language:: python

         .. oe:api:: python

            SetCellFont(arg2: OEFont) -> None

      Sets the font used by the :oe:meth:`OEDepict::OEImageTable::DrawText`
      method to draw text on the 'body' cells.
      A cell is considered to be part of the 'body' of the table if it is neither
      in the header nor in the stub column.

      **Example** (:ref:`figure_OEImageTableOptions_SetCellFont`)

      .. oe:source:: OEImageTableOpts_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETCELLFONT

      .. _figure_OEImageTableOptions_SetCellFont:

      .. figure:: ../images/OEImageTableOptions_SetCellFont.*
         :align:  center

         **Example of using the SetCellFont method**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageTableOptions::GetCellFont` method


   .. oe:method:: SetColumnWidths

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

         .. oe:api::

            bool SetColumnWidths(const std::vector<unsigned int>& widths)

      .. oe:language:: python

         .. oe:api:: python

            SetColumnWidths(arg2: OEUIntVector) -> bool

      Sets the relative widths of the columns.

      **widths**
        The relative widths of the columns.
        The size of the vector has to be :oe:meth:`OEDepict::OEImageTableOptions::NumColumns()<OEDepict::OEImageTable::NumColumns>`.

      **Example** (:ref:`figure_OEImageTableOptions_SetColumnWidths`)

      The following example show how to adjust the width ratio of the columns.

      .. oe:source:: OEImageTableOpts_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETCOLUMNWIDTHS

      .. oe:source:: OEImageTableOpts_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETCOLUMNWIDTHS

      .. oe:source:: OEImageTableOpts_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETCOLUMNWIDTHS

      .. oe:source:: OEImageTableOpts_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETCOLUMNWIDTHS

      .. _figure_OEImageTableOptions_SetColumnWidths:

      .. figure:: ../images/OEImageTableOptions_SetColumnWidths.*
         :align:  center

         **Example of using the SetColumnWidths method**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageTableOptions::SetRowHeights` method


   .. oe:method:: SetHeader

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

         .. oe:api::

            bool SetHeader(bool has)

      .. oe:language:: python

         .. oe:api:: python

            SetHeader(has: bool) -> bool

      Sets whether to have a 'header' row in the table.

      **Example** (:ref:`figure_OEImageTableOptions_SetHeader`)

      By default, a table is generated with a header row on the top.
      The following example show how to remove the header.

      .. oe:source:: OEImageTableOpts_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETHEADER

      .. oe:source:: OEImageTableOpts_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETHEADER

      .. oe:source:: OEImageTableOpts_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETHEADER

      .. oe:source:: OEImageTableOpts_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETHEADER

      .. _figure_OEImageTableOptions_SetHeader:

      .. figure:: ../images/OEImageTableOptions_SetHeader.*
         :align:  center

         **Example of using the SetHeader method**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageTableOptions::HasHeader` method
         * :oe:meth:`OEDepict::OEImageTableOptions::HasStubColumn` method
         * :oe:meth:`OEDepict::OEImageTableOptions::SetStubColumn` method


   .. oe:method:: SetHeaderColor

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

         .. oe:api::

            void SetHeaderColor(const OESystem::OEColor& color)

      .. oe:language:: python

         .. oe:api:: python

            SetHeaderColor(arg2: OEColor) -> None

      Sets the color used to highlight the 'header' cells in the table.

      **Example** (:ref:`figure_OEImageTableOptions_SetHeaderColor`)

      .. oe:source:: OEImageTableOpts_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETHEADERCOLOR

      .. oe:source:: OEImageTableOpts_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETHEADERCOLOR

      .. oe:source:: OEImageTableOpts_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETHEADERCOLOR

      .. oe:source:: OEImageTableOpts_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETHEADERCOLOR

      .. _figure_OEImageTableOptions_SetHeaderColor:

      .. figure:: ../images/OEImageTableOptions_SetHeaderColor.*
         :align:  center

         **Example of using the SetHeaderColor method**

      .. seealso::

         * :ref:`OEColor <OESystem_OEColor>` class
         * :oe:meth:`OEDepict::OEImageTableOptions::GetHeaderColor` method


   .. oe:method:: SetHeaderFont

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

         .. oe:api::

            void SetHeaderFont(const OEFont& font)

      .. oe:language:: python

         .. oe:api:: python

            SetHeaderFont(arg2: OEFont) -> None

      Sets the font used by the :oe:meth:`OEDepict::OEImageTable::DrawText`
      method to draw text on the 'header' cells.

      **Example** (:ref:`figure_OEImageTableOptions_SetHeaderFont`)

      .. oe:source:: OEImageTableOpts_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETHEADERFONT

      .. oe:source:: OEImageTableOpts_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETHEADERFONT

      .. oe:source:: OEImageTableOpts_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETHEADERFONT

      .. oe:source:: OEImageTableOpts_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETHEADERFONT

      .. _figure_OEImageTableOptions_SetHeaderFont:

      .. figure:: ../images/OEImageTableOptions_SetHeaderFont.*
         :align:  center

         **Example of using the SetHeaderFont method**

      .. seealso::

         * :ref:`OEFont <OEDepict_OEFont>` class
         * :oe:meth:`OEDepict::OEImageTableOptions::GetHeaderFont` method


   .. oe:method:: SetMargin

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

         .. oe:api::

            bool SetMargin(unsigned int marginloc, double margin)

      .. oe:language:: python

         .. oe:api:: python

            SetMargin(margin: int, percent: float) -> bool

      Sets the size of a specific margin of the table.

      *marginloc*
         This value has to be from the :oe:constns:`OEDepict::OEMargin`
         namespace.

      *margin*
         This number is considered as a percentage of either the width or the height
         of image on which the table will be drawn and has to be in the range of :math:`[0.0, 25.0]`.
         For example, 10.0% means, that the left and right margin
         are 10% of the total width of the image, and the top and bottom margins
         are 10% of the total height of the image.

      **Example** (:ref:`figure_OEImageTableOptions_SetMargin`)

      .. oe:source:: OEImageTableOpts_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETMARGIN

      .. oe:source:: OEImageTableOpts_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETMARGIN

      .. oe:source:: OEImageTableOpts_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETMARGIN

      .. oe:source:: OEImageTableOpts_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETMARGIN

      .. _figure_OEImageTableOptions_SetMargin:

      .. figure:: ../images/OEImageTableOptions_SetMargin.*
         :align:  center

         **Example of using the SetMargin method**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageTableOptions::GetMargin` method
         * :oe:meth:`OEDepict::OEImageTableOptions::SetMargins` method


   .. oe:method:: SetMargins

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

         .. oe:api::

            bool SetMargins(double margin)

      .. oe:language:: python

         .. oe:api:: python

            SetMargins(percent: float) -> bool

      Sets the size of all margins of the table.

      *margin*
         This number is considered as a percentage of either the width or the height
         of image on which the table will be drawn and has to be in the range of :math:`[0.0, 25.0]`.
         For example, 10.0% means, that the left and right margin
         are 10% of the total width of the image, and the top and bottom margins
         are 10% of the total height of the image.

      **Example** (:ref:`figure_OEImageTableOptions_SetMargins`)

      .. oe:source:: OEImageTableOpts_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETMARGINS

      .. oe:source:: OEImageTableOpts_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETMARGINS

      .. oe:source:: OEImageTableOpts_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETMARGINS

      .. oe:source:: OEImageTableOpts_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETMARGINS

      .. _figure_OEImageTableOptions_SetMargins:

      .. figure:: ../images/OEImageTableOptions_SetMargins.*
         :align:  center

         **Example of using the SetMargins method**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageTableOptions::GetMargin` method
         * :oe:meth:`OEDepict::OEImageTableOptions::SetMargin` method


   .. oe:method:: SetRowHeights

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

         .. oe:api::

            bool SetRowHeights(const std::vector<unsigned int>& heights)

      .. oe:language:: python

         .. oe:api:: python

            SetRowHeights(arg2: OEUIntVector) -> bool

      Sets the relative heights of the rows.

      **heights**
        The relative heights of the rows.
        The size of the vector has to be :oe:meth:`OEDepict::OEImageTableOptions::NumRows()<OEDepict::OEImageTable::NumRows>`.

      **Example** (:ref:`figure_OEImageTableOptions_SetRowHeights`)

      The following example show how to adjust the height ratio of the rows.

      .. oe:source:: OEImageTableOpts_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETROWHEIGHTS

      .. oe:source:: OEImageTableOpts_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETROWHEIGHTS

      .. oe:source:: OEImageTableOpts_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETROWHEIGHTS

      .. oe:source:: OEImageTableOpts_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETROWHEIGHTS

      .. _figure_OEImageTableOptions_SetRowHeights:

      .. figure:: ../images/OEImageTableOptions_SetRowHeights.*
         :align:  center

         **Example of using the SetRowHeights method**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageTableOptions::SetColumnWidths` method


   .. oe:method:: SetStubColumn

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

         .. oe:api::

            bool SetStubColumn(bool has)

      .. oe:language:: python

         .. oe:api:: python

            SetStubColumn(has: bool) -> bool

      Sets whether to have a 'stub' column in the table.

      **Example** (:ref:`figure_OEImageTableOptions_SetStubColumn`)

      By default, a table is generated without a 'stub' column.
      The following example show how to add one on the left.

      .. oe:source:: OEImageTableOpts_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETSTUBCOLUMN

      .. oe:source:: OEImageTableOpts_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETSTUBCOLUMN

      .. oe:source:: OEImageTableOpts_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETSTUBCOLUMN

      .. oe:source:: OEImageTableOpts_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETSTUBCOLUMN

      .. _figure_OEImageTableOptions_SetStubColumn:

      .. figure:: ../images/OEImageTableOptions_SetStubColumn.*
         :align:  center

         **Example of using the SetStubColumn method**

      .. seealso::

         * :oe:meth:`OEDepict::OEImageTableOptions::HasStubColumn` method
         * :oe:meth:`OEDepict::OEImageTableOptions::HasHeader` method
         * :oe:meth:`OEDepict::OEImageTableOptions::SetHeader` method

   .. oe:method:: SetStubColumnColor

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

         .. oe:api::

            void SetStubColumnColor(const OESystem::OEColor & color)

      .. oe:language:: python

         .. oe:api:: python

            SetStubColumnColor(arg2: OEColor) -> None

      Sets the color used to highlight the 'stub' cells in the table.

      **Example** (:ref:`figure_OEImageTableOptions_SetStubColumnColor`)

      .. oe:source:: OEImageTableOpts_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETSTUBCOLUMNCOLOR

      .. oe:source:: OEImageTableOpts_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETSTUBCOLUMNCOLOR

      .. oe:source:: OEImageTableOpts_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETSTUBCOLUMNCOLOR

      .. oe:source:: OEImageTableOpts_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETSTUBCOLUMNCOLOR

      .. _figure_OEImageTableOptions_SetStubColumnColor:

      .. figure:: ../images/OEImageTableOptions_SetStubColumnColor.*
         :align:  center

         **Example of using the SetStubColumnColor method**

      .. seealso::

         * :ref:`OEColor <OESystem_OEColor>` class
         * :oe:meth:`OEDepict::OEImageTableOptions::GetStubColumnColor` method


   .. oe:method:: SetStubColumnFont

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

         .. oe:api::

            void SetStubColumnFont(const OEFont& font)

      .. oe:language:: python

         .. oe:api:: python

            SetStubColumnFont(arg2: OEFont) -> None

      Sets the font used by the :oe:meth:`OEDepict::OEImageTable::DrawText`
      method to draw text on the 'stub column' cells.

      **Example** (:ref:`figure_OEImageTableOptions_SetStubColumnFont`)

      .. oe:source:: OEImageTableOpts_SetProps.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETSTUBCOLUMNFONT

      .. oe:source:: OEImageTableOpts_SetProps.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETSTUBCOLUMNFONT

      .. oe:source:: OEImageTableOpts_SetProps.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETSTUBCOLUMNFONT

      .. oe:source:: OEImageTableOpts_SetProps.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEIMAGETABLEOPTIONS-SETSTUBCOLUMNFONT

      .. _figure_OEImageTableOptions_SetStubColumnFont:

      .. figure:: ../images/OEImageTableOptions_SetStubColumnFont.*
         :align:  center

         **Example of using the SetStubColumnFont method**

      .. seealso::

         * :ref:`OEFont <OEDepict_OEFont>` class
         * :oe:meth:`OEDepict::OEImageTableOptions::GetStubColumnFont` method
