.. role:: ts-api-decorator

#############
QueryNodeInfo
#############

.. js:module:: cee.ug
   :noindex:

.. container:: ts-api-section

   .. js:class:: QueryNodeInfo

      Query information about nodes for a given frame or all frames



.. container:: api-index-section

   .. rubric:: Constructors

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

   * :js:meth:`~cee.ug.QueryNodeInfo.constructor`



.. container:: api-index-section

   .. rubric:: Accessors

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

   * :js:attr:`~cee.ug.QueryNodeInfo.maxResultCount`



.. container:: api-index-section

   .. rubric:: Methods

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

   * :js:meth:`~cee.ug.QueryNodeInfo.executeQueryByIds`
   * :js:meth:`~cee.ug.QueryNodeInfo.executeQueryByRegion`





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

Constructors
============

.. container:: ts-api-section

   .. js:function:: QueryNodeInfo.constructor( model)

      :param model: None
      :type model: RemoteModel


      :rtype: QueryNodeInfo



Accessors
=========

.. container:: ts-api-section

   .. js:function:: QueryNodeInfo.maxResultCount()



      Maximum number of nodes to be returned in the query.
      Defaults to 1000.


      :rtype: number

   .. js:function:: QueryNodeInfo.maxResultCount( max)

      :param max: None
      :type max: number


      :rtype: void



Methods
=======

.. rst-class:: ts-api-section

executeQueryByIds
-----------------

.. js:method:: QueryNodeInfo.executeQueryByIds( frameIndex, geometryIndex, partId, nodeIdArr, callback)

   :param frameIndex: The index of the frame to get info for. Specify -1 for all frames
   :type frameIndex: number
   :param geometryIndex: 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 for the node ids.
   :type geometryIndex: number
   :param partId: The id of the part containing the nodes. Specify -1 to search in all parts for the node ids.
   :type partId: number
   :param nodeIdArr: Array with ids of the nodes to get information for
   :type nodeIdArr: [number]
   :param callback: Function getting called when the result is received from the server.
   :type callback: QueryNodeInfoCallback


   Executes the query for the given node ids


   :rtype: void

.. rst-class:: ts-api-section

executeQueryByRegion
--------------------

.. js:method:: QueryNodeInfo.executeQueryByRegion( frameIndex, geometryIndex, partId, view, x, y, width, height, callback)

   :param frameIndex: The index of the frame to get info for. Specify -1 for all frames.
   :type frameIndex: number
   :param geometryIndex: 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.
   :type geometryIndex: number
   :param partId: The id of the part containing the nodes. Specify -1 to search in all parts.
   :type partId: number
   :param view: The view which the given region applies to.
   :type view: View
   :param x: The search region's x coordinate.
   :type x: number
   :param y: The search region's y coordinate.
   :type y: number
   :param width: The search region's width.
   :type width: number
   :param height: The search region's height.
   :type height: number
   :param callback: Function getting called when the result is received from the server.
   :type callback: QueryNodeInfoCallback


   Executes the query for the given region.

   The x and y coordinates must be specified in OpenGL style coordinates, which means a right handed coordinate system with the origin in the lower left corner of the window.
   The HTML coordinate system is with origin in top left, so if this is your input (e.g. MouseEvent.offsetY, clientY, pageY, etc.) you will have to flip the Y coordinate.
   The x and y are specified in native pixels, so you will have to adjust the input for the current devicePixelRatio (window.devicePixelRatio).

   The width and height are specified in native pixels. So you will have to adjust the input for the current devicePixelRatio (window.devicePixelRatio).


   :rtype: void

