NoteOperator

class Operators.NoteOperator()

Methods

Methods

addMapping

NoteOperator.addMapping(button, modifier)
Arguments:
  • button (Button()) – None
  • modifier (KeyModifiers()) – None

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.

Return type:void

checkPinInstance

NoteOperator.checkPinInstance(nodeId)
Arguments:
  • nodeId (number()) – None

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

Return type:boolean

clearMapping

NoteOperator.clearMapping()

Clears any button and key modifier mappings for the operator.

Return type:void

getNoteTextElement

NoteOperator.getNoteTextElement()
Returns:a NoteTextElement that can be used to configure the NoteText HTML container.
Return type:NoteTextElement

setMapping

NoteOperator.setMapping(button, modifier)
Arguments:
  • button (Button()) – None
  • modifier (KeyModifiers()) – None

Sets the button and key modifier mapping for the operator.

Return type:void

setNoteTextElement

NoteOperator.setNoteTextElement(noteTextElement)
Arguments:
  • noteTextElement (NoteTextElement()) – None
Return type:

void