.. role:: ts-api-decorator

.. _cee.ug.VectorColorMode:

###############
VectorColorMode
###############

.. js:module:: cee.ug
   :noindex:

.. container:: ts-api-section

   The color mode for vector arrows.



.. container:: api-index-section

   .. rubric:: Enumeration Members

   .. rst-class:: api-index-list-item api-kind-enummember api-parent-kind-enum

   * :ref:`cee.ug.VectorColorMode.COLOR_BY_FRINGES`
   * :ref:`cee.ug.VectorColorMode.COLOR_BY_MAP_SCALAR`
   * :ref:`cee.ug.VectorColorMode.SINGLE`





------------

Enumeration Members
===================

.. rst-class:: ts-api-section

.. _cee.ug.VectorColorMode.COLOR_BY_FRINGES:

COLOR_BY_FRINGES
----------------

Take color from the scalar on the object on which the vector is mapped

.. rst-class:: ts-api-section

.. _cee.ug.VectorColorMode.COLOR_BY_MAP_SCALAR:

COLOR_BY_MAP_SCALAR
-------------------

Take color from the scalar values referenced by the provided scalar result ID.
The desired scalar ID must be set with ``VectorSettings.mapScalarResultId``.

.. rst-class:: ts-api-section

.. _cee.ug.VectorColorMode.SINGLE:

SINGLE
------

Color vector arrows with single color

