.. role:: ts-api-decorator

#################
ScalarFieldUpdate
#################

.. js:module:: cee.pt
   :noindex:

.. container:: ts-api-section

   .. js:class:: ScalarFieldUpdate

      Subset of DatasetInfo returned when switching or clearing the active scalar field.



.. container:: api-index-section

   .. rubric:: Properties

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

   * :js:attr:`~cee.pt.ScalarFieldUpdate.activeScalarField`
   * :js:attr:`~cee.pt.ScalarFieldUpdate.hasScalarData`
   * :js:attr:`~cee.pt.ScalarFieldUpdate.modelKey`
   * :js:attr:`~cee.pt.ScalarFieldUpdate.scalarFieldNames`
   * :js:attr:`~cee.pt.ScalarFieldUpdate.scalarRange`





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

Properties
==========

.. container:: ts-api-section

   .. js:attribute:: ScalarFieldUpdate.activeScalarField

      :type: string





.. container:: ts-api-section

   .. js:attribute:: ScalarFieldUpdate.hasScalarData

      :type: boolean

      Whether frames include scalar data in the wire format.
       - true  -- 12 BPP: id(4) + qx(2) + qy(2) + qz(2) + qScalar(2).
       - false -- 10 BPP: id(4) + qx(2) + qy(2) + qz(2).



.. container:: ts-api-section

   .. js:attribute:: ScalarFieldUpdate.modelKey

      :type: string





.. container:: ts-api-section

   .. js:attribute:: ScalarFieldUpdate.scalarFieldNames

      :type: [string]





.. container:: ts-api-section

   .. js:attribute:: ScalarFieldUpdate.scalarRange

      :type: ScalarRange :ts-api-decorator:`optional`





