NoteOperator

class Communicator.Operator.NoteOperator()

Methods

addMapping

Communicator.Operator.NoteOperator.addMapping(button, modifier)

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.

Arguments
  • button (Communicator.Button()) –

  • modifier (Communicator.KeyModifiers()) –

Return type

void

checkPinInstance

Communicator.Operator.NoteOperator.checkPinInstance(nodeId)

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

Arguments
  • nodeId (Communicator.NodeId()) –

Return type

boolean

clearMapping

Communicator.Operator.NoteOperator.clearMapping()

Clears any button and key modifier mappings for the operator.

Return type

void

getNoteTextElement

Communicator.Operator.NoteOperator.getNoteTextElement()
Return type

Communicator.Markup.Note.NoteTextElement

Returns

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

setMapping

Communicator.Operator.NoteOperator.setMapping(button, modifier)

Sets the button and key modifier mapping for the operator.

Arguments
  • button (Communicator.Button()) –

  • modifier (Communicator.KeyModifiers()) –

Return type

void

setNoteTextElement

Communicator.Operator.NoteOperator.setNoteTextElement(noteTextElement)
Arguments
  • noteTextElement (Communicator.Markup.Note.NoteTextElement()) –

Return type

void