.. role:: clio-inherited
   :class: clio-flag clio-flag-inherited


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

.. js:class:: wv.Operators.NoteOperator

   
   Index
   =====
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~wv.Operators.NoteOperator.addMapping`
   * :js:meth:`~wv.Operators.NoteOperator.checkPinInstance`
   * :js:meth:`~wv.Operators.NoteOperator.clearMapping`
   * :js:meth:`~wv.Operators.NoteOperator.getNoteTextElement`
   * :js:meth:`~wv.Operators.NoteOperator.setMapping`
   * :js:meth:`~wv.Operators.NoteOperator.setNoteTextElement`
   
   



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

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


.. js:method:: wv.Operators.NoteOperator.addMapping

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | addMapping(**button**\ : :js:data:`Button <wv.Button>`\ , **modifier**\ : :js:data:`KeyModifiers <wv.KeyModifiers>`\ ?): *void*
      
      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.
      
      **Parameters**
      
      
         **button**\ : :js:data:`Button <wv.Button>`
      
         **modifier**\ : :js:data:`KeyModifiers <wv.KeyModifiers>` = KeyModifiers.None
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.Operators.NoteOperator.checkPinInstance

      .. rst-class:: sig-pretty-signature
      
         | checkPinInstance(**nodeId**\ : *number*\ ): *boolean*
      
      Returns true if the nodeId is the id of a note pin instance.
      
      **Parameters**
      
      
         **nodeId**\ : *number*
      
      
      **Returns**\ : *boolean*
      



.. js:method:: wv.Operators.NoteOperator.clearMapping

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | clearMapping(): *void*
      
      Clears any button and key modifier mappings for the operator.
      
      **Returns**\ : *void*
      



.. js:method:: wv.Operators.NoteOperator.getNoteTextElement

      .. rst-class:: sig-pretty-signature
      
         | getNoteTextElement(): :js:class:`NoteTextElement <wv.Operators.Markup.Note.NoteTextElement>`
      
      **Returns**\ : :js:class:`NoteTextElement <wv.Operators.Markup.Note.NoteTextElement>`
      
      
         a NoteTextElement that can be used to configure the NoteText HTML container.
      
      



.. js:method:: wv.Operators.NoteOperator.setMapping

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | setMapping(**button**\ : :js:data:`Button <wv.Button>`\ , **modifier**\ : :js:data:`KeyModifiers <wv.KeyModifiers>`\ ?): *void*
      
      Sets the button and key modifier mapping for the operator.
      
      **Parameters**
      
      
         **button**\ : :js:data:`Button <wv.Button>`
      
         **modifier**\ : :js:data:`KeyModifiers <wv.KeyModifiers>` = KeyModifiers.None
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.Operators.NoteOperator.setNoteTextElement

      .. rst-class:: sig-pretty-signature
      
         | setNoteTextElement(**noteTextElement**\ : :js:class:`NoteTextElement <wv.Operators.Markup.Note.NoteTextElement>`\ ): *void*
      
      **Parameters**
      
      
         **noteTextElement**\ : :js:class:`NoteTextElement <wv.Operators.Markup.Note.NoteTextElement>`
      
      
      **Returns**\ : *void*
      




