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


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

.. js:class:: Operators.NoteOperator

   
   Index
   =====
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :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
=======

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

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



.. js:method:: 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:: 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:: Operators.NoteOperator.getNoteTextElement

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



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

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



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

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





