.. role:: clio-inherited
   :class: clio-flag clio-flag-inherited

.. role:: clio-optional
   :class: clio-flag clio-flag-optional


###########
DatasetInfo
###########

.. js:class:: cee.pt.DatasetInfo

   Metadata about a particle dataset, fetched from the server on open.
   
   
   Index
   =====
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~cee.pt.DatasetInfo.activeScalarField`
   * :js:data:`~cee.pt.DatasetInfo.boundingBox`
   * :js:data:`~cee.pt.DatasetInfo.frameCount`
   * :js:data:`~cee.pt.DatasetInfo.hasScalarData`
   * :js:data:`~cee.pt.DatasetInfo.maxParticleCount`
   * :js:data:`~cee.pt.DatasetInfo.modelKey`
   * :js:data:`~cee.pt.DatasetInfo.scalarFieldNames`
   * :js:data:`~cee.pt.DatasetInfo.scalarRange`
   
   



.. rst-class:: kind-group kind-properties

.. rubric:: Properties
   :class: kind-group-title


.. js:data:: cee.pt.DatasetInfo.activeScalarField

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | activeScalarField: *string*
      



.. js:data:: cee.pt.DatasetInfo.boundingBox

      .. rst-class:: sig-pretty-signature
      
         | boundingBox: :js:class:`BoundingBox <cee.BoundingBox>`
      
      Bounding box across all frames. Used for initial view framing.
      



.. js:data:: cee.pt.DatasetInfo.frameCount

      .. rst-class:: sig-pretty-signature
      
         | frameCount: *number*
      
      Total number of time-step frames.
      



.. js:data:: cee.pt.DatasetInfo.hasScalarData

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | hasScalarData: *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).
      



.. js:data:: cee.pt.DatasetInfo.maxParticleCount

      .. rst-class:: sig-pretty-signature
      
         | maxParticleCount: *number*
      
      Max particle count across all frames. Used to pre-allocate buffers.
      



.. js:data:: cee.pt.DatasetInfo.modelKey

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | modelKey: *string*
      



.. js:data:: cee.pt.DatasetInfo.scalarFieldNames

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | scalarFieldNames: *string*\ []
      



.. js:data:: cee.pt.DatasetInfo.scalarRange

      .. rst-class:: clio-flags
      
         :clio-optional:`optional`
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | scalarRange: :js:class:`ScalarRange <cee.pt.ScalarRange>`
      




