.. role:: ts-api-decorator

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

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

.. container:: ts-api-section

   .. js:class:: DatasetInfo

      Metadata about a particle dataset, fetched from the server on open.



.. container:: api-index-section

   .. rubric:: Properties

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

   * :js:attr:`~cee.pt.DatasetInfo.activeScalarField`
   * :js:attr:`~cee.pt.DatasetInfo.boundingBox`
   * :js:attr:`~cee.pt.DatasetInfo.frameCount`
   * :js:attr:`~cee.pt.DatasetInfo.hasScalarData`
   * :js:attr:`~cee.pt.DatasetInfo.maxParticleCount`
   * :js:attr:`~cee.pt.DatasetInfo.modelKey`
   * :js:attr:`~cee.pt.DatasetInfo.scalarFieldNames`
   * :js:attr:`~cee.pt.DatasetInfo.scalarRange`





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

Properties
==========

.. container:: ts-api-section

   .. js:attribute:: DatasetInfo.activeScalarField

      :type: string





.. container:: ts-api-section

   .. js:attribute:: DatasetInfo.boundingBox

      :type: BoundingBox

      Bounding box across all frames. Used for initial view framing.



.. container:: ts-api-section

   .. js:attribute:: DatasetInfo.frameCount

      :type: number

      Total number of time-step frames.



.. container:: ts-api-section

   .. js:attribute:: DatasetInfo.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:: DatasetInfo.maxParticleCount

      :type: number

      Max particle count across all frames. Used to pre-allocate buffers.



.. container:: ts-api-section

   .. js:attribute:: DatasetInfo.modelKey

      :type: string





.. container:: ts-api-section

   .. js:attribute:: DatasetInfo.scalarFieldNames

      :type: [string]





.. container:: ts-api-section

   .. js:attribute:: DatasetInfo.scalarRange

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





