.. role:: ts-api-decorator

#########
FrameInfo
#########

.. js:module:: cee.cug
   :noindex:

.. container:: ts-api-section

   .. js:class:: FrameInfo

      Information about each frame in the ConstantRemoteModel



.. container:: api-index-section

   .. rubric:: Accessors

   .. rst-class:: api-index-list-item api-kind-accessor api-parent-kind-class

   * :js:attr:`~cee.cug.FrameInfo.fringesMaximumValue`
   * :js:attr:`~cee.cug.FrameInfo.fringesMinimumValue`
   * :js:attr:`~cee.cug.FrameInfo.name`
   * :js:attr:`~cee.cug.FrameInfo.referenceValue`
   * :js:attr:`~cee.cug.FrameInfo.stateId`





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

Accessors
=========

.. container:: ts-api-section

   .. js:function:: FrameInfo.fringesMaximumValue()



      Maximum value of the scalar result shown as fringes on the model in this frame


      :rtype: number



.. container:: ts-api-section

   .. js:function:: FrameInfo.fringesMinimumValue()



      Minimum value of the scalar result shown as fringes on the model in this frame


      :rtype: number



.. container:: ts-api-section

   .. js:function:: FrameInfo.name()



      The name of the current frame


      :rtype: string



.. container:: ts-api-section

   .. js:function:: FrameInfo.referenceValue()



      The reference value of the current frame

      The reference value is provided by the CAE reader/data provider and is simulation specific.


      :rtype: number



.. container:: ts-api-section

   .. js:function:: FrameInfo.stateId()



      The state id of the current frame


      :rtype: number



