
################
QueryElementInfo
################

.. js:class:: cee.ug.QueryElementInfo

   Query information about elements for a given frame or all frames
   
   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~cee.ug.QueryElementInfo.constructor`
   
   .. rubric:: Accessors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~cee.ug.QueryElementInfo.elementIdentType`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~cee.ug.QueryElementInfo.executeQuery`
   * :js:meth:`~cee.ug.QueryElementInfo.executeQueryByClientSideHitItems`
   
   



.. rst-class:: kind-group kind-constructors

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


.. js:method:: cee.ug.QueryElementInfo.constructor

      .. rst-class:: sig-pretty-signature
      
         | QueryElementInfo(**model**\ : :js:class:`RemoteModel <cee.ug.RemoteModel>`\ ): :js:class:`QueryElementInfo <cee.ug.QueryElementInfo>`
      
      **Parameters**
      
      
         **model**\ : :js:class:`RemoteModel <cee.ug.RemoteModel>`
      
      
      **Returns**\ : :js:class:`QueryElementInfo <cee.ug.QueryElementInfo>`
      



.. rst-class:: kind-group kind-accessors

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


.. js:method:: cee.ug.QueryElementInfo.elementIdentType

      .. rst-class:: sig-pretty-signature
      
         | *get* elementIdentType(): :js:data:`RemoteQueryInputIdentType <cee.ug.RemoteQueryInputIdentType>`
      
      Specify whether the ``elementIdentArr`` parameter in :js:meth:`executeQuery <cee.ug.QueryElementInfo.executeQuery>` is to be interpreted as an array of IDs or indices. Defaults to IDs.
      
      **Returns**\ : :js:data:`RemoteQueryInputIdentType <cee.ug.RemoteQueryInputIdentType>`
      
      .. rst-class:: sig-pretty-signature
      
         | *set* elementIdentType(**identType**\ : :js:data:`RemoteQueryInputIdentType <cee.ug.RemoteQueryInputIdentType>`\ ): *void*
      
      **Parameters**
      
      
         **identType**\ : :js:data:`RemoteQueryInputIdentType <cee.ug.RemoteQueryInputIdentType>`
      
      
      **Returns**\ : *void*
      



.. rst-class:: kind-group kind-methods

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


.. js:method:: cee.ug.QueryElementInfo.executeQuery

      .. rst-class:: sig-pretty-signature
      
         | executeQuery(**frameIndex**\ : *number*\ , **geometryIndex**\ : *number*\ , **partId**\ : *number*\ , **elementIdentArr**\ : *number*\ [], **scalarResultId**\ : *number*\ , **vectorResultId**\ : *number*\ , **callback**\ : :js:class:`QueryElementInfoCallback <cee.ug.QueryElementInfoCallback>`\ ): *void*
      
      Executes the query for the given elements.
      
      **Parameters**
      
      
         **frameIndex**\ : *number*
      
      
            The index of the frame to get info for. Specify -1 for all frames
      
      
         **geometryIndex**\ : *number*
      
      
            The index of the geometry the part belongs to. In most cases there is only one geometry and this parameter should be 0. Specify -1 to search in all geometries.
      
      
         **partId**\ : *number*
      
      
            The id of the part containing the elements. Specify -1 to search in all parts.
      
      
         **elementIdentArr**\ : *number*\ []
      
      
            Array with ids or indices of the elements to get information for. Use :js:func:`elementIdentType <cee.ug.QueryElementInfo.elementIdentType>` to specify what this array contains.
      
      
         **scalarResultId**\ : *number*
      
      
            The id of the scalar to use for scalarResult. If -1 then the result currently shown as scalar fringes on the part will be used.
      
      
         **vectorResultId**\ : *number*
      
      
            The id of the vector to use for vectorResults. If -1 then the vector results currently set in the modelSpec will be used.
      
      
         **callback**\ : :js:class:`QueryElementInfoCallback <cee.ug.QueryElementInfoCallback>`
      
      
            Function getting called when the result is received from the server.
      
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.ug.QueryElementInfo.executeQueryByClientSideHitItems

      .. rst-class:: sig-pretty-signature
      
         | executeQueryByClientSideHitItems(**hitItems**\ : :js:class:`ClientSideHitItem <cee.ug.ClientSideHitItem>`\ [], **scalarResultId**\ : *number*\ , **vectorResultId**\ : *number*\ , **callback**\ : :js:class:`QueryElementInfoCallback <cee.ug.QueryElementInfoCallback>`\ ): *void*
      
      Executes the query for the given ClientSideHitItem array.
      
      **Parameters**
      
      
         **hitItems**\ : :js:class:`ClientSideHitItem <cee.ug.ClientSideHitItem>`\ []
      
      
            The client-side hit items to execute the query over. Use :js:meth:`RemoteModel.clientSideRayIntersect <cee.ug.RemoteModel.clientSideRayIntersect>` or :js:class:`TrianglePicker <cee.ug.TrianglePicker>` to create client-side hit items.
      
      
         **scalarResultId**\ : *number*
      
      
            The id of the scalar to use for scalarResult. If -1 then the result currently shown as scalar fringes on the part will be used.
      
      
         **vectorResultId**\ : *number*
      
      
            The id of the vector to use for vectorResults. If -1 then the vector results currently set in the modelSpec will be used.
      
      
         **callback**\ : :js:class:`QueryElementInfoCallback <cee.ug.QueryElementInfoCallback>`
      
      
            Function getting called when the result is received from the server.
      
      
      
      **Returns**\ : *void*
      




