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


###################
NodePropertyAdapter
###################

.. js:class:: ui.nodeProperties.NodePropertyAdapter

   This class serves as a proxy to the Model class. It is used by the NodeProperties to communicate with the Model.
   
   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~ui.nodeProperties.NodePropertyAdapter.constructor`
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~ui.nodeProperties.NodePropertyAdapter.formatProperty`
   * :js:data:`~ui.nodeProperties.NodePropertyAdapter.formatUserData`
   * :js:data:`~ui.nodeProperties.NodePropertyAdapter.model`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~ui.nodeProperties.NodePropertyAdapter.getNodeName`
   * :js:meth:`~ui.nodeProperties.NodePropertyAdapter.getProperties`
   * :js:meth:`~ui.nodeProperties.NodePropertyAdapter.getUserData`
   
   



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

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


.. js:method:: ui.nodeProperties.NodePropertyAdapter.constructor

      .. rst-class:: sig-pretty-signature
      
         | NodePropertyAdapter(): :js:class:`NodePropertyAdapter <ui.nodeProperties.NodePropertyAdapter>`
      
      **Returns**\ : :js:class:`NodePropertyAdapter <ui.nodeProperties.NodePropertyAdapter>`
      



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

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


.. js:data:: ui.nodeProperties.NodePropertyAdapter.formatProperty

      .. rst-class:: clio-flags
      
         :clio-optional:`optional`
      
      .. rst-class:: sig-pretty-signature
      
         | formatProperty: (**key**\ : *string*\ , **value**\ : *string*\ ) => [*HTMLTemplateResult*\ , *HTMLTemplateResult*\ ]
      
      This callback can be used to format properties before adding them to the DOM
      



.. js:data:: ui.nodeProperties.NodePropertyAdapter.formatUserData

      .. rst-class:: clio-flags
      
         :clio-optional:`optional`
      
      .. rst-class:: sig-pretty-signature
      
         | formatUserData: (**key**\ : *string*\ , **value**\ : *string*\ ) => [*HTMLTemplateResult*\ , *HTMLTemplateResult*\ ]
      
      This callback can be used to format user data before adding them to the DOM
      



.. js:data:: ui.nodeProperties.NodePropertyAdapter.model

      .. rst-class:: clio-flags
      
         :clio-optional:`optional`
      
      .. rst-class:: sig-pretty-signature
      
         | model: :js:class:`IModel <ui.nodeProperties.IModel>`
      
      The Model where the node will be queried.
      



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

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


.. js:method:: ui.nodeProperties.NodePropertyAdapter.getNodeName

      .. rst-class:: sig-pretty-signature
      
         | getNodeName(**nodeId**\ : *number*\ ): *string*
      
      Get the name of the node
      
      **Parameters**
      
      
         **nodeId**\ : *number*
      
      
            The node to gather information from
      
      
      
      **Returns**\ : *string*
      
      
         The name of the node
      
      



.. js:method:: ui.nodeProperties.NodePropertyAdapter.getProperties

      .. rst-class:: sig-pretty-signature
      
         | getProperties(**nodeId**\ : *number*\ ): *Promise*
      
      Collects all the properties from a given node
      
      **Parameters**
      
      
         **nodeId**\ : *number*
      
      
            The id of the node
      
      
      
      **Returns**\ : *Promise*
      
      
         A table containing the properties as [name, value] tuples
      
      



.. js:method:: ui.nodeProperties.NodePropertyAdapter.getUserData

      .. rst-class:: sig-pretty-signature
      
         | getUserData(**nodeId**\ : *number*\ ): *Promise*
      
      Collects all the user data from a given node
      
      **Parameters**
      
      
         **nodeId**\ : *number*
      
      
            The id of the node
      
      
      
      **Returns**\ : *Promise*
      
      
         A table containing the user data as [name, value] tuples
      
      




