.. role:: ts-api-decorator

########################
VectorSettingsProperties
########################

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

.. container:: ts-api-section

   .. js:class:: VectorSettingsProperties

      Plain Old JavaScript Object (POJO) containing the properties of a ``VectorSettings``



.. container:: api-index-section

   .. rubric:: Properties

   .. rst-class:: api-index-list-item api-kind-property api-parent-kind-interface

   * :js:attr:`~cee.ug.VectorSettingsProperties.anisotropicScaleFactor`
   * :js:attr:`~cee.ug.VectorSettingsProperties.arrowHeadRelativeLength`
   * :js:attr:`~cee.ug.VectorSettingsProperties.arrowHeadRelativeRadius`
   * :js:attr:`~cee.ug.VectorSettingsProperties.arrowShaftRelativeRadius`
   * :js:attr:`~cee.ug.VectorSettingsProperties.clampingRangeMaximum`
   * :js:attr:`~cee.ug.VectorSettingsProperties.clampingRangeMinimum`
   * :js:attr:`~cee.ug.VectorSettingsProperties.colorMode`
   * :js:attr:`~cee.ug.VectorSettingsProperties.drawMaxCount`
   * :js:attr:`~cee.ug.VectorSettingsProperties.drawMode`
   * :js:attr:`~cee.ug.VectorSettingsProperties.drawSkipBy`
   * :js:attr:`~cee.ug.VectorSettingsProperties.dynamicSymmetricArrowsScalarId`
   * :js:attr:`~cee.ug.VectorSettingsProperties.enableClamping`
   * :js:attr:`~cee.ug.VectorSettingsProperties.enableFiltering`
   * :js:attr:`~cee.ug.VectorSettingsProperties.filteringRangeMaximum`
   * :js:attr:`~cee.ug.VectorSettingsProperties.filteringRangeMinimum`
   * :js:attr:`~cee.ug.VectorSettingsProperties.mapScalarResultId`
   * :js:attr:`~cee.ug.VectorSettingsProperties.nodeAveragedValues`
   * :js:attr:`~cee.ug.VectorSettingsProperties.projectVectorsOnSurface`
   * :js:attr:`~cee.ug.VectorSettingsProperties.resultId`
   * :js:attr:`~cee.ug.VectorSettingsProperties.scaleFactor`
   * :js:attr:`~cee.ug.VectorSettingsProperties.scaleMode`
   * :js:attr:`~cee.ug.VectorSettingsProperties.singleVectorColor`
   * :js:attr:`~cee.ug.VectorSettingsProperties.vectorType`





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

Properties
==========

.. container:: ts-api-section

   .. js:attribute:: VectorSettingsProperties.anisotropicScaleFactor

      :type: Vec3Like

      See ``VectorSettings.anisotropicScaleFactor``



.. container:: ts-api-section

   .. js:attribute:: VectorSettingsProperties.arrowHeadRelativeLength

      :type: number

      See ``VectorSettings.arrowHeadRelativeLength``



.. container:: ts-api-section

   .. js:attribute:: VectorSettingsProperties.arrowHeadRelativeRadius

      :type: number

      See ``VectorSettings.arrowHeadRelativeRadius``



.. container:: ts-api-section

   .. js:attribute:: VectorSettingsProperties.arrowShaftRelativeRadius

      :type: number

      See ``VectorSettings.arrowShaftRelativeRadius``



.. container:: ts-api-section

   .. js:attribute:: VectorSettingsProperties.clampingRangeMaximum

      :type: number

      See ``VectorSettings.clampingRangeMaximum``



.. container:: ts-api-section

   .. js:attribute:: VectorSettingsProperties.clampingRangeMinimum

      :type: number

      See ``VectorSettings.clampingRangeMinimum``



.. container:: ts-api-section

   .. js:attribute:: VectorSettingsProperties.colorMode

      :type: VectorColorMode

      See ``VectorSettings.colorMode``



.. container:: ts-api-section

   .. js:attribute:: VectorSettingsProperties.drawMaxCount

      :type: number

      See ``VectorSettings.drawMaxCount``



.. container:: ts-api-section

   .. js:attribute:: VectorSettingsProperties.drawMode

      :type: VectorDrawMode

      See ``VectorSettings.drawMode``



.. container:: ts-api-section

   .. js:attribute:: VectorSettingsProperties.drawSkipBy

      :type: number

      See ``VectorSettings.drawSkipBy``



.. container:: ts-api-section

   .. js:attribute:: VectorSettingsProperties.dynamicSymmetricArrowsScalarId

      :type: number

      See ``VectorSettings.setVectorTypeDynamicSymmetricArrow``



.. container:: ts-api-section

   .. js:attribute:: VectorSettingsProperties.enableClamping

      :type: boolean

      Whether to enable clamping, see ``VectorSettings.setClampingRange``



.. container:: ts-api-section

   .. js:attribute:: VectorSettingsProperties.enableFiltering

      :type: boolean

      Whether to enable filtering, see ``VectorSettings.setFilteringRange``



.. container:: ts-api-section

   .. js:attribute:: VectorSettingsProperties.filteringRangeMaximum

      :type: number

      See ``VectorSettings.filteringRangeMaximum``



.. container:: ts-api-section

   .. js:attribute:: VectorSettingsProperties.filteringRangeMinimum

      :type: number

      See ``VectorSettings.filteringRangeMinimum``



.. container:: ts-api-section

   .. js:attribute:: VectorSettingsProperties.mapScalarResultId

      :type: number

      See ``VectorSettings.mapScalarResultId``



.. container:: ts-api-section

   .. js:attribute:: VectorSettingsProperties.nodeAveragedValues

      :type: boolean

      See ``VectorSettings.nodeAveragedValues``



.. container:: ts-api-section

   .. js:attribute:: VectorSettingsProperties.projectVectorsOnSurface

      :type: boolean

      See ``VectorSettings.projectVectorsOnSurface``



.. container:: ts-api-section

   .. js:attribute:: VectorSettingsProperties.resultId

      :type: number

      See ``VectorSettings.resultId``



.. container:: ts-api-section

   .. js:attribute:: VectorSettingsProperties.scaleFactor

      :type: number

      See ``VectorSettings.scaleFactor``



.. container:: ts-api-section

   .. js:attribute:: VectorSettingsProperties.scaleMode

      :type: VectorScaleMode

      See ``VectorSettings.scaleMode``



.. container:: ts-api-section

   .. js:attribute:: VectorSettingsProperties.singleVectorColor

      :type: Color3Like

      See ``VectorSettings.singleVectorColor``



.. container:: ts-api-section

   .. js:attribute:: VectorSettingsProperties.vectorType

      :type: VectorType

      See ``VectorSettings.vectorType``



