.. oe:namespace:: OEGrapheme


.. meta::
   :keywords: OEColorGradientDisplayOptions, ColorGradientDisplayOptions


.. _OEGrapheme_OEColorGradientDisplayOptions:

.. oe:class:: OEColorGradientDisplayOptions

   .. oe:api::

      class OEColorGradientDisplayOptions

   This class represents the :ref:`OEColorGradientDisplayOptions <OEGrapheme_OEColorGradientDisplayOptions>`
   class that holds properties that determine how a color gradient is rendered.

   .. seealso::

      * :oe:func:`OEGrapheme::OEDrawColorGradient` function

   .. oe:method:: Constructors

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

         .. oe:api::

            OEColorGradientDisplayOptions()

      .. oe:language:: python

         .. oe:api:: python

            OEColorGradientDisplayOptions() -> OEColorGradientDisplayOptions

      Default constructor.

      .. _figure_OEColorGradientDisplayOptions_Default:

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

         **Example of drawing a color gradient with default options**

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

         .. oe:api::

            OEColorGradientDisplayOptions(const OEColorGradientDisplayOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEColorGradientDisplayOptions(rhs: OEColorGradientDisplayOptions) -> OEColorGradientDisplayOptions

      Copy constructor.


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

      .. oe:api::

         OEColorGradientDisplayOptions &operator=(const OEColorGradientDisplayOptions &rhs)

      Assignment operator.

   .. oe:method:: AddLabel

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

         .. oe:api::

            void AddLabel(const OEColorGradientLabel& label)

      .. oe:language:: python

         .. oe:api:: python

            AddLabel(label: OEColorGradientLabel) -> None

      Adds an additional label that will be rendered on the strip of the
      color gradient.

      *label*
         The :ref:`OEColorGradientLabel <OEGrapheme_OEColorGradientLabel>` object that
         defines the label and the position where the label
         is going to be rendered to the color gradient.

      **Example:**

      .. oe:source:: OEColorGradientDispOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-ADDLABEL

      ..    oe:language:: python

            :ref:`Full listing. <listing-OEColorGradientDispOpts.py>`


      .. oe:source:: OEColorGradientDispOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-ADDLABEL

      .. oe:source:: OEColorGradientDispOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-ADDLABEL

      .. oe:source:: OEColorGradientDispOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-ADDLABEL


      .. _figure_OEColorGradientDisplayOptions_AddLabel:

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

         **Example of using the AddLabel method**

      .. seealso::

         * :ref:`OEColorGradientLabel <OEGrapheme_OEColorGradientLabel>` class
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetLabels` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::ClearLabels` method


   .. oe:method:: AddMarkedValue

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

         .. oe:api::

            void AddMarkedValue(double value)

      .. oe:language:: python

         .. oe:api:: python

            AddMarkedValue(value: float) -> None

      Adds an additional value that will be marked on the strip of the color
      gradient along with the label of the value above the strip.

      **Example:**

      .. oe:source:: OEColorGradientDispOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-ADDMARKEDVALUE

      ..    oe:language:: python

            :ref:`Full listing. <listing-OEColorGradientDispOpts.py>`


      .. oe:source:: OEColorGradientDispOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-ADDMARKEDVALUE

      .. oe:source:: OEColorGradientDispOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-ADDMARKEDVALUE

      .. oe:source:: OEColorGradientDispOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-ADDMARKEDVALUE

      .. _figure_OEColorGradientDisplayOptions_AddMarkedValue:

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

         **Example of using the AddMarkedValue method**

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::AddMarkedValues` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetMarkedValues` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetMarkedValues` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::ClearMarkedValues` method


   .. oe:method:: AddMarkedValues

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

         .. oe:api::

            void AddMarkedValues(const std::vector<double>& values)

      .. oe:language:: python

         .. oe:api:: python

            AddMarkedValues(values: OEDoubleVector) -> None

      Adds additional values that will be marked on the strip of the color gradient
      along with their labels above the strip.

      **Example:**

      .. oe:source:: OEColorGradientDispOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-ADDMARKEDVALUES

      ..    oe:language:: python

          :ref:`Full listing. <listing-OEColorGradientDispOpts.py>`


      .. oe:source:: OEColorGradientDispOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-ADDMARKEDVALUES

      .. oe:source:: OEColorGradientDispOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-ADDMARKEDVALUES

      .. oe:source:: OEColorGradientDispOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-ADDMARKEDVALUES

      .. _figure_OEColorGradientDisplayOptions_AddMarkedValues:

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

         **Example of using the AddMarkedValues method**

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::AddMarkedValue` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::ClearMarkedValues` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetMarkedValues` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetMarkedValues` method


   .. oe:method:: ClearBoxRange

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

         .. oe:api::

            void ClearBoxRange()

      .. oe:language:: python

         .. oe:api:: python

            ClearBoxRange() -> None

      Removes the range previously set to be marked on the color gradient.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetBoxRange` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetBoxRangeMax` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetBoxRangeMin` method


   .. oe:method:: ClearLabels

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

         .. oe:api::

            void ClearLabels()

      .. oe:language:: python

         .. oe:api:: python

            ClearLabels() -> None

      Removes labels previously set by the
      :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::AddLabel` method
      to be marked on the color gradient.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::AddLabel` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetLabels` method


   .. oe:method:: ClearMarkedValues

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

         .. oe:api::

            void ClearMarkedValues()

      .. oe:language:: python

         .. oe:api:: python

            ClearMarkedValues() -> None

      Removes any values previously set to be marked on the color gradient.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::AddMarkedValue` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::AddMarkedValues` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetMarkedValues` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetMarkedValues` method


   .. oe:method:: GetBoxRangeMax

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

         .. oe:api::

            double GetBoxRangeMax() const

      .. oe:language:: python

         .. oe:api:: python

            GetBoxRangeMax() -> float

      Returns the minimum value of the range being marked on the color gradient.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::ClearBoxRange` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetBoxRange` method


   .. oe:method:: GetBoxRangeMin

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

         .. oe:api::

            double GetBoxRangeMin() const

      .. oe:language:: python

         .. oe:api:: python

            GetBoxRangeMin() -> float

      Returns the maximum value of the range being marked on the color gradient.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::ClearBoxRange` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetBoxRange` method


   .. oe:method:: GetBoxRangePen

      Returns the pen used to draw the box to mark the range set by the
      :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetBoxRange` method.

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

         .. oe:api::

            const OEDepict::OEPen& GetBoxRangePen() const

      .. oe:language:: python

         .. oe:api:: python

            GetBoxRangePen() -> OEPen

      .. seealso::

         * :ref:`OEPen <OEDepict_OEPen>` class
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetBoxRange`
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetBoxRangePen` method


   .. oe:method:: GetColorStopLabelFont

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

         .. oe:api::

            const OEDepict::OEFont& GetColorStopLabelFont() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorStopLabelFont() -> OEFont

      Returns the font that is used to render the color stops of the
      color gradient.

      .. seealso::

         * :ref:`OEFont <OEDepict_OEFont>` class
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetColorStopLabelFont` method

   .. oe:method:: GetColorStopLabelFontScale

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

         .. oe:api::

            double GetColorStopLabelFontScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorStopLabelFontScale() -> float

      Returns the multiplier that can be used to increase or decrease
      the size of the color stop label fonts.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetColorStopLabelFontScale` method

   .. oe:method:: GetColorStopPrecision

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

         .. oe:api::

            unsigned int GetColorStopPrecision() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorStopPrecision() -> int

      Returns the precision of the color stop labels *i.e.* the number of digits that is
      written to express the floating-point values.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetColorStopPrecision` method

   .. oe:method:: GetColorStopVisibility

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

         .. oe:api::

            bool GetColorStopVisibility() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorStopVisibility() -> bool

      Returns whether the color stop labels are rendered.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetColorStopVisibility` method


   .. oe:method:: GetLabels

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

         .. oe:api::

            OESystem::OEIterBase<OEColorGradientLabel>* GetLabels() const

      .. oe:language:: python

         .. oe:api:: python

            GetLabels() -> Iterable[OEColorGradientLabel]

      Returns an iterator over the labels that are being rendered onto
      the color gradient.

      .. seealso::

         * :ref:`OEColorGradientLabel <OEGrapheme_OEColorGradientLabel>` class
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::AddLabel` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::ClearLabels` method


   .. oe:method:: GetMarkedValuePen

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

         .. oe:api::

            const OEDepict::OEPen& GetMarkedValuePen() const

      .. oe:language:: python

         .. oe:api:: python

            GetMarkedValuePen() -> OEPen

      Returns the pen that is used to draw the lines for the marked values.

      .. seealso::

         * :ref:`OEPen <OEDepict_OEPen>` class
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetMarkedValuePen` method


   .. oe:method:: GetMarkedValuePrecision

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

         .. oe:api::

            unsigned int GetMarkedValuePrecision() const

      .. oe:language:: python

         .. oe:api:: python

            GetMarkedValuePrecision() -> int

      Returns the precision of the marked value labels *i.e.* the number
      of digits that is written to express the floating-point values.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetMarkedValuePrecision` method


   .. oe:method:: GetMarkedValues

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

         .. oe:api::

            OESystem::OEIterBase<double>* GetMarkedValues() const

      .. oe:language:: python

         .. oe:api:: python

            GetMarkedValues() -> Iterable[float]

      Returns an iterator over the values that are being marked on the
      color gradient.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::AddMarkedValue` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::AddMarkedValues` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::ClearMarkedValues` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetMarkedValues` method


   .. oe:method:: SetBoxRange

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

         .. oe:api::

            void SetBoxRange(double minvalue, double maxvalue)

      .. oe:language:: python

         .. oe:api:: python

            SetBoxRange(minvalue: float, maxvalue: float) -> None

      Sets the range being marked on the color gradient.

      *minvalue, maxvalue*
         The minimum and maximum value of the range.

      **Example:**

      .. oe:source:: OEColorGradientDispOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-BOXRANGE

      :ref:`Full listing. <listing-OEColorGradientDispOpts.py>`


      .. oe:source:: OEColorGradientDispOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-BOXRANGE

      .. oe:source:: OEColorGradientDispOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-BOXRANGE

      .. oe:source:: OEColorGradientDispOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-BOXRANGE

      .. _figure_OEColorGradientDisplayOptions_SetBoxRange:

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

         **Example of using the SetBoxRange method**

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::ClearBoxRange` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetBoxRangeMax` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetBoxRangeMin` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetBoxRange` method


   .. oe:method:: SetBoxRangePen

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

         .. oe:api::

            void SetBoxRangePen(const OEDepict::OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            SetBoxRangePen(pen: OEPen) -> None

      Sets the pen used to mark a specified range on the color gradient.

      **Example:**

      .. oe:source:: OEColorGradientDispOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-BOXRANGEPEN

      ..    oe:language:: python

            :ref:`Full listing. <listing-OEColorGradientDispOpts.py>`

      .. oe:source:: OEColorGradientDispOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-BOXRANGEPEN

      .. oe:source:: OEColorGradientDispOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-BOXRANGEPEN

      .. oe:source:: OEColorGradientDispOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-BOXRANGEPEN

      .. _figure_OEColorGradientDisplayOptions_SetBoxRangePen:

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

         **Example of using the SetBoxRangePen method**

      .. seealso::

         * :ref:`OEPen <OEDepict_OEPen>` class
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetBoxRangePen` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetBoxRange` method


   .. oe:method:: SetColorStopLabelFont

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

         .. oe:api::

            void SetColorStopLabelFont(const OEDepict::OEFont& font)

      .. oe:language:: python

         .. oe:api:: python

            SetColorStopLabelFont(font: OEFont) -> None

      Sets the font that is used to render color stops of the color gradient.

      **Example:**

      .. oe:source:: OEColorGradientDispOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPLABELFONT

      :ref:`Full listing. <listing-OEColorGradientDispOpts.py>`


      .. oe:source:: OEColorGradientDispOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPLABELFONT

      .. oe:source:: OEColorGradientDispOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPLABELFONT

      .. oe:source:: OEColorGradientDispOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPLABELFONT

      .. _figure_OEColorGradientDisplayOptions_SetColorStopLabelFont:

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

         **Example of using the SetColorStopLabelFont method**

      .. note::

         The size of font also depends on dimensions of the image
         into which the color gradient is rendered.
         See also :oe:func:`OEGrapheme::OEDrawColorGradient` function.

      .. seealso::

         * :ref:`OEFont <OEDepict_OEFont>` class
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetColorStopLabelFont` method

   .. oe:method:: SetColorStopLabelFontScale

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

         .. oe:api::

            void SetColorStopLabelFontScale(double scale)

      .. oe:language:: python

         .. oe:api:: python

            SetColorStopLabelFontScale(scale: float) -> None

      Sets the multiplier that can be used increase or decrease the
      size of the fonts of the color stop labels.

      *scale*
         This value has to be in the range of ``[0.5, 3.0]``.

      **Example:**

      .. oe:source:: OEColorGradientDispOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPLABELFONTSCALE

      ..    oe:language:: python

            :ref:`Full listing. <listing-OEColorGradientDispOpts.py>`


      .. oe:source:: OEColorGradientDispOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPLABELFONTSCALE

      .. oe:source:: OEColorGradientDispOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPLABELFONTSCALE

      .. oe:source:: OEColorGradientDispOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPLABELFONTSCALE

      .. _figure_OEColorGradientDisplayOptions_SetColorStopLabelFontScale:

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

         **Example of using the SetColorStopLabelFontScale method**

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetColorStopLabelFontScale` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetColorStopLabelFont` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetColorStopLabelFont` method

   .. oe:method:: SetColorStopPrecision

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

         .. oe:api::

            void SetColorStopPrecision(unsigned int precision)

      .. oe:language:: python

         .. oe:api:: python

            SetColorStopPrecision(precision: int) -> None

      Sets the precision of the color stop labels *i.e.* the number of digits that is
      written to express the floating-point values.

      *precision*
          The zero value means that the precision is determined by the lowest
          significant digits of the color stop values that is in the range of [1,4].

      **Example:**

      .. oe:source:: OEColorGradientDispOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPPRECISION

      ..    oe:language:: python

            :ref:`Full listing. <listing-OEColorGradientDispOpts.py>`


      .. oe:source:: OEColorGradientDispOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPPRECISION

      .. oe:source:: OEColorGradientDispOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPPRECISION

      .. oe:source:: OEColorGradientDispOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPPRECISION

      .. _figure_OEColorGradientDisplayOptions_SetColorStopPrecision:

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

         **Example of using the SetColorStopPrecision method**

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetColorStopPrecision` method

   .. oe:method:: SetColorStopVisibility

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

         .. oe:api::

            void SetColorStopVisibility(bool visible)

      .. oe:language:: python

         .. oe:api:: python

            SetColorStopVisibility(visible: bool) -> None

      Sets whether the color stop labels are rendered.

      **Example:**

      .. oe:source:: OEColorGradientDispOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPVISIBILITY

      ..    oe:language:: python

            :ref:`Full listing. <listing-OEColorGradientDispOpts.py>`


      .. oe:source:: OEColorGradientDispOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPVISIBILITY

      .. oe:source:: OEColorGradientDispOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPVISIBILITY

      .. oe:source:: OEColorGradientDispOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-COLORSTOPVISIBILITY

      .. _figure_OEColorGradientDisplayOptions_SetColorStopVisibility:

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

         **Example of using the SetColorStopVisibility method**

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetColorStopVisibility` method


   .. oe:method:: SetMarkedValuePen

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

         .. oe:api::

            void SetMarkedValuePen(const OEDepict::OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            SetMarkedValuePen(pen: OEPen) -> None

      Sets the pen that is used to draw the lines for the marked values.

      **Example:**

      .. oe:source:: OEColorGradientDispOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-MARKEDVALUEPEN

      ..    oe:language:: python

            :ref:`Full listing. <listing-OEColorGradientDispOpts.py>`


      .. oe:source:: OEColorGradientDispOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-MARKEDVALUEPEN

      .. oe:source:: OEColorGradientDispOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-MARKEDVALUEPEN

      .. oe:source:: OEColorGradientDispOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-MARKEDVALUEPEN

      .. _figure_OEColorGradientDisplayOptions_SetMarkedValuePen:

      .. figure:: ../images/OEColorGradientDisplayOptions_ SetMarkedValuePen.*
         :align:  center

         **Example of using the SetMarkedValuePen method**

      .. seealso::

         * :ref:`OEPen <OEDepict_OEPen>` class
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetMarkedValuePen` method


   .. oe:method:: SetMarkedValuePrecision

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

         .. oe:api::

            void SetMarkedValuePrecision(unsigned int precision)

      .. oe:language:: python

         .. oe:api:: python

            SetMarkedValuePrecision(precision: int) -> None

      Sets the precision of the marked value labels *i.e.* the number of digits that is
      written to express the floating-point values.
      Decreasing the precision can result in collapsing that labels of two or more
      distinct values into one label.

      **Example:**

      .. oe:source:: OEColorGradientDispOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-MARKEDVALUEPRECISION

      ..    oe:language:: python

            :ref:`Full listing. <listing-OEColorGradientDispOpts.py>`


      .. oe:source:: OEColorGradientDispOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-MARKEDVALUEPRECISION

      .. oe:source:: OEColorGradientDispOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-MARKEDVALUEPRECISION

      .. oe:source:: OEColorGradientDispOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-MARKEDVALUEPRECISION

      .. _figure_OEColorGradientDisplayOptions_SetMarkedValuePrecision:

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

         **Example of using the SetMarkedValuePrecision method**

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::GetMarkedValuePrecision` method


   .. oe:method:: SetMarkedValues

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

         .. oe:api::

            void SetMarkedValues(const std::vector<double>& values)

      .. oe:language:: python

         .. oe:api:: python

            SetMarkedValues(values: OEDoubleVector) -> None

      Initializes values that will be marked on the strip of the color gradient
      along with the value labels above the strip.
      :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::SetMarkedValues` method
      discards the list of values set in prior calls.

      **Example:**

      .. oe:source:: OEColorGradientDispOpts.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-SETMARKEDVALUES

      ..    oe:language:: python

            :ref:`Full listing. <listing-OEColorGradientDispOpts.py>`



      .. oe:source:: OEColorGradientDispOpts.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-SETMARKEDVALUES

      .. oe:source:: OEColorGradientDispOpts.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-SETMARKEDVALUES

      .. oe:source:: OEColorGradientDispOpts.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OECOLORGRADIENTDISPLAYOPTIONS-SETMARKEDVALUES

      .. _figure_OEColorGradientDisplayOptions_SetMarkedValues:

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

         **Example of using the SetMarkedValues method**

      .. seealso::

         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::AddMarkedValue` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::AddMarkedValues` method
         * :oe:meth:`OEGrapheme::OEColorGradientDisplayOptions::ClearMarkedValues` method
