.. role:: ts-api-decorator

############
NoteOperator
############

.. js:module:: Operators
   :noindex:

.. container:: ts-api-section

   .. js:class:: NoteOperator



.. container:: api-index-section

   .. rubric:: Methods

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

   * :js:meth:`~Operators.NoteOperator.addMapping`
   * :js:meth:`~Operators.NoteOperator.checkPinInstance`
   * :js:meth:`~Operators.NoteOperator.clearMapping`
   * :js:meth:`~Operators.NoteOperator.getNoteTextElement`
   * :js:meth:`~Operators.NoteOperator.setMapping`
   * :js:meth:`~Operators.NoteOperator.setNoteTextElement`





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

Methods
=======

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

addMapping
----------

.. js:method:: NoteOperator.addMapping( button, modifier)

   :param button: None
   :type button: Button
   :param modifier: None
   :type modifier: KeyModifiers


   Adds a button and key modifier mapping for the operator. If no mapping is provided, all combinations are considered valid.
   All mappings require a mouse button, but a key modifier is optional.


   :rtype: void

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

checkPinInstance
----------------

.. js:method:: NoteOperator.checkPinInstance( nodeId)

   :param nodeId: None
   :type nodeId: number


   Returns true if the nodeId is the id of a note pin instance.


   :rtype: boolean

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

clearMapping
------------

.. js:method:: NoteOperator.clearMapping()



   Clears any button and key modifier mappings for the operator.


   :rtype: void

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

getNoteTextElement
------------------

.. js:method:: NoteOperator.getNoteTextElement()





   :returns: a NoteTextElement that can be used to configure the NoteText HTML container.


   :rtype: NoteTextElement

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

setMapping
----------

.. js:method:: NoteOperator.setMapping( button, modifier)

   :param button: None
   :type button: Button
   :param modifier: None
   :type modifier: KeyModifiers


   Sets the button and key modifier mapping for the operator.


   :rtype: void

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

setNoteTextElement
------------------

.. js:method:: NoteOperator.setNoteTextElement( noteTextElement)

   :param noteTextElement: None
   :type noteTextElement: NoteTextElement


   :rtype: void

