NoteOperator

class Communicator.Operator.NoteOperator()

Methods

addMapping
checkPinInstance
clearMapping
getNoteTextElement
setMapping
setNoteTextElement

Methods

addMapping

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 (Button) –
modifier (KeyModifiers) – optional

Return type

void

checkPinInstance

NoteOperator.checkPinInstance(nodeId)

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

Arguments

nodeId (NodeId) –

Return type

boolean

clearMapping

NoteOperator.clearMapping()

Clears any button and key modifier mappings for the operator.

Return type: void

getNoteTextElement

NoteOperator.getNoteTextElement()

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

setMapping

NoteOperator.setMapping(button[, modifier])

Sets the button and key modifier mapping for the operator.

Arguments

button (Button) –
modifier (KeyModifiers) – optional

Return type

void

setNoteTextElement

NoteOperator.setNoteTextElement(noteTextElement)

Arguments

noteTextElement (NoteTextElement) –

Return type

void