Class InternalEvent

InternalEvent

Cross-browser DOM event support. For internal event handling, EventSource and the graph event dispatch loop in AbstractGraph are used.

Memory Leaks:

Use this class for adding and removing listeners to/from DOM nodes. The removeAllListeners function is provided to remove all listeners that have been added using addListener. The function should be invoked when the last reference is removed in the JavaScript code, typically when the referenced DOM node is removed from the DOM.

Index

Constructors

constructor

new InternalEvent(): InternalEvent
Returns InternalEvent

Properties

`Static`ACTIVATE

ACTIVATE: string = 'activate'

Specifies the event name for activate.

`Static`ADD

ADD: string = 'add'

Specifies the event name for add.

`Static`ADD_CELLS

ADD_CELLS: string = 'addCells'

Specifies the event name for addCells.

`Static`ADD_OVERLAY

ADD_OVERLAY: string = 'addOverlay'

Specifies the event name for addOverlay.

`Static`ADD_VERTEX

ADD_VERTEX: string = 'addVertex'

Specifies the event name for addVertex.

`Static`AFTER_ADD_VERTEX

AFTER_ADD_VERTEX: string = 'afterAddVertex'

Specifies the event name for afterAddVertex.

`Static`ALIGN_CELLS

ALIGN_CELLS: string = 'alignCells'

Specifies the event name for alignCells.

`Static`BEFORE_ADD_VERTEX

BEFORE_ADD_VERTEX: string = 'beforeAddVertex'

Specifies the event name for beforeAddVertex.

`Static`BEFORE_UNDO

BEFORE_UNDO: string = 'beforeUndo'

Specifies the event name for beforeUndo.

`Static`BEGIN_UPDATE

BEGIN_UPDATE: string = 'beginUpdate'

Specifies the event name for beginUpdate.

`Static`CELL_CONNECTED

CELL_CONNECTED: string = 'cellConnected'

Specifies the event name for cellConnected.

`Static`CELLS_ADDED

CELLS_ADDED: string = 'cellsAdded'

Specifies the event name for cellsAdded.

`Static`CELLS_FOLDED

CELLS_FOLDED: string = 'cellsFolded'

Specifies the event name for cellsFolded.

`Static`CELLS_MOVED

CELLS_MOVED: string = 'cellsMoved'

Specifies the event name for cellsMoved.

`Static`CELLS_ORDERED

CELLS_ORDERED: string = 'cellsOrdered'

Specifies the event name for cellsOrdered.

`Static`CELLS_REMOVED

CELLS_REMOVED: string = 'cellsRemoved'

Specifies the event name for cellsRemoved.

`Static`CELLS_RESIZED

CELLS_RESIZED: string = 'cellsResized'

Specifies the event name for cellsResized.

`Static`CELLS_TOGGLED

CELLS_TOGGLED: string = 'cellsToggled'

Specifies the event name for cellsToggled.

`Static`CHANGE

CHANGE: string = 'change'

Specifies the event name for change.

`Static`CLEAR

CLEAR: string = 'clear'

Specifies the event name for clear.

`Static`CLICK

CLICK: string = 'click'

Specifies the event name for click.

`Static`CLOSE

CLOSE: string = 'close'

Specifies the event name for close.

`Static`CONNECT

CONNECT: string = 'connect'

Specifies the event name for connect.

`Static`CONNECT_CELL

CONNECT_CELL: string = 'connectCell'

Specifies the event name for connectCell.

`Static`CUSTOM_HANDLE

CUSTOM_HANDLE: number = -100

Start index for the custom handles in an mxMouseEvent. This should be a negative value and is the start index which is decremented for each custom handle.

Default

-100

`Static`DESTROY

DESTROY: string = 'destroy'

Specifies the event name for destroy.

`Static`DISCONNECT

DISCONNECT: string = 'disconnect'

Specifies the event name for disconnect.

`Static`DONE

DONE: string = 'done'

Specifies the event name for done.

`Static`DOUBLE_CLICK

DOUBLE_CLICK: string = 'doubleClick'

Specifies the event name for doubleClick.

`Static`DOWN

DOWN: string = 'down'

Specifies the event name for down.

`Static`EDITING_STARTED

EDITING_STARTED: string = 'editingStarted'

Specifies the event name for editingStarted.

`Static`EDITING_STOPPED

EDITING_STOPPED: string = 'editingStopped'

Specifies the event name for editingStopped.

`Static`END_EDIT

END_EDIT: string = 'endEdit'

Specifies the event name for endEdit.

`Static`END_UPDATE

END_UPDATE: string = 'endUpdate'

Specifies the event name for endUpdate.

`Static`ESCAPE

ESCAPE: string = 'escape'

Specifies the event name for escape.

`Static`EXECUTE

EXECUTE: string = 'execute'

Specifies the event name for execute.

`Static`EXECUTED

EXECUTED: string = 'executed'

Specifies the event name for executed.

`Static`FIRE_MOUSE_EVENT

FIRE_MOUSE_EVENT: string = 'fireMouseEvent'

Specifies the event name for fireMouseEvent.

`Static`FIRED

FIRED: string = 'fired'

Specifies the event name for fired.

`Static`FLIP_EDGE

FLIP_EDGE: string = 'flipEdge'

Specifies the event name for flipEdge.

`Static`FOLD_CELLS

FOLD_CELLS: string = 'foldCells'

Specifies the event name for foldCells.

`Static`GESTURE

GESTURE: string = 'gesture'

Specifies the event name for gesture.

`Static`GET

GET: string = 'get'

Specifies the event name for get.

`Static`GROUP_CELLS

GROUP_CELLS: string = 'groupCells'

Specifies the event name for groupCells.

`Static`HIDE

HIDE: string = 'hide'

Specifies the event name for hide.

`Static`LABEL_CHANGED

LABEL_CHANGED: string = 'labelChanged'

Specifies the event name for labelChanged.

`Static`LABEL_HANDLE

LABEL_HANDLE: number = -1

Index for the label handle in an mxMouseEvent. This should be a negative value that does not interfere with any possible handle indices.

Default

-1

`Static`LAYOUT_CELLS

LAYOUT_CELLS: string = 'layoutCells'

Specifies the event name for layoutCells.

`Static`MARK

MARK: string = 'mark'

Specifies the event name for mark.

`Static`MAXIMIZE

MAXIMIZE: string = 'maximize'

Specifies the event name for maximize.

`Static`MINIMIZE

MINIMIZE: string = 'minimize'

Specifies the event name for minimize.

`Static`MOUSE_DOWN

MOUSE_DOWN: string = 'mouseDown'

Specifies the event name for mouseDown.

`Static`MOUSE_MOVE

MOUSE_MOVE: string = 'mouseMove'

Specifies the event name for mouseMove.

`Static`MOUSE_UP

MOUSE_UP: string = 'mouseUp'

Specifies the event name for mouseUp.

`Static`MOVE

MOVE: string = 'move'

Specifies the event name for move.

`Static`MOVE_CELLS

MOVE_CELLS: string = 'moveCells'

Specifies the event name for moveCells.

`Static`MOVE_END

MOVE_END: string = 'moveEnd'

Specifies the event name for moveEnd.

`Static`MOVE_START

MOVE_START: string = 'moveStart'

Specifies the event name for moveStart.

`Static`NORMALIZE

NORMALIZE: string = 'normalize'

Specifies the event name for normalize.

`Static`NOTIFY

NOTIFY: string = 'notify'

Specifies the event name for notify.

`Static`OPEN

OPEN: string = 'open'

Specifies the event name for open.

`Static`ORDER_CELLS

ORDER_CELLS: string = 'orderCells'

Specifies the event name for orderCells.

`Static`PAN

PAN: string = 'pan'

Specifies the event name for pan.

`Static`PAN_END

PAN_END: string = 'panEnd'

Specifies the event name for panEnd.

`Static`PAN_START

PAN_START: string = 'panStart'

Specifies the event name for panStart.

`Static`PINCH_THRESHOLD

PINCH_THRESHOLD: number = 10

Threshold for pinch gestures to fire a mouse wheel event. Default value is 10.

`Static`POST

POST: string = 'post'

Specifies the event name for post.

`Static`RECEIVE

RECEIVE: string = 'receive'

Specifies the event name for receive.

`Static`REDO

REDO: string = 'redo'

Specifies the event name for redo.

`Static`REFRESH

REFRESH: string = 'refresh'

Specifies the event name for refresh.

`Static`REMOVE

REMOVE: string = 'remove'

Specifies the event name for remove.

`Static`REMOVE_CELLS

REMOVE_CELLS: string = 'removeCells'

Specifies the event name for removeCells.

`Static`REMOVE_CELLS_FROM_PARENT

REMOVE_CELLS_FROM_PARENT: string = 'removeCellsFromParent'

Specifies the event name for removeCellsFromParent.

`Static`REMOVE_OVERLAY

REMOVE_OVERLAY: string = 'removeOverlay'

Specifies the event name for removeOverlay.

`Static`RESET

RESET: string = 'reset'

Specifies the event name for reset.

`Static`RESIZE

RESIZE: string = 'resize'

Specifies the event name for resize.

`Static`RESIZE_CELLS

RESIZE_CELLS: string = 'resizeCells'

Specifies the event name for resizeCells.

`Static`RESIZE_END

RESIZE_END: string = 'resizeEnd'

Specifies the event name for resizeEnd.

`Static`RESIZE_START

RESIZE_START: string = 'resizeStart'

Specifies the event name for resizeStart.

`Static`RESUME

RESUME: string = 'resume'

Specifies the event name for suspend.

`Static`ROOT

ROOT: string = 'root'

Specifies the event name for root.

`Static`ROTATION_HANDLE

ROTATION_HANDLE: number = -2

Index for the rotation handle in an mxMouseEvent. This should be a negative value that does not interfere with any possible handle indices.

Default

-2

`Static`SAVE

SAVE: string = 'save'

Specifies the event name for open.

`Static`SCALE

SCALE: string = 'scale'

Specifies the event name for scale.

`Static`SCALE_AND_TRANSLATE

SCALE_AND_TRANSLATE: string = 'scaleAndTranslate'

Specifies the event name for scaleAndTranslate.

`Static`SELECT

SELECT: string = 'select'

Specifies the event name for select.

`Static`SHOW

SHOW: string = 'show'

Specifies the event name for show.

`Static`SIZE

SIZE: string = 'size'

Specifies the event name for size.

`Static`SPLIT_EDGE

SPLIT_EDGE: string = 'splitEdge'

Specifies the event name for splitEdge.

`Static`START

START: string = 'start'

Specifies the event name for start.

`Static`START_EDIT

START_EDIT: string = 'startEdit'

Specifies the event name for startEdit.

`Static`START_EDITING

START_EDITING: string = 'startEditing'

Specifies the event name for startEditing.

`Static`SUSPEND

SUSPEND: string = 'suspend'

Specifies the event name for suspend.

`Static`TAP_AND_HOLD

TAP_AND_HOLD: string = 'tapAndHold'

Specifies the event name for tapAndHold.

`Static`TOGGLE_CELLS

TOGGLE_CELLS: string = 'toggleCells'

Specifies the event name for toggleCells.

`Static`TRANSLATE

TRANSLATE: string = 'translate'

Specifies the event name for translate.

`Static`UNDO

UNDO: string = 'undo'

Specifies the event name for undo.

`Static`UNGROUP_CELLS

UNGROUP_CELLS: string = 'ungroupCells'

Specifies the event name for ungroupCells.

`Static`UP

UP: string = 'up'

Specifies the event name for up.

`Static`UPDATE_CELL_SIZE

UPDATE_CELL_SIZE: string = 'updateCellSize'

Specifies the event name for updateCellSize.

`Static`VIRTUAL_HANDLE

VIRTUAL_HANDLE: number = -100000

Start index for the virtual handles in an mxMouseEvent. This should be a negative value and is the start index which is decremented for each virtual handle. This assumes that there are no more than VIRTUAL_HANDLE - CUSTOM_HANDLE custom handles.

Default

-100000

Methods

`Static`addGestureListeners

addGestureListeners(
    node: Listenable,
    startListener?: null | MouseEventListener,
    moveListener?: null | MouseEventListener,
    endListener?: null | MouseEventListener,
): void
Adds the given listeners for touch, mouse and/or pointer events. If <Client.IS_POINTER> is true then pointer events will be registered, else the respective mouse events will be registered. If <Client.IS_POINTER> is false and <Client.IS_TOUCH> is true then the respective touch events will be registered as well as the mouse events.
Parameters
- node: Listenable
- startListener: null | MouseEventListener = null
- moveListener: null | MouseEventListener = null
- endListener: null | MouseEventListener = null
Returns void
- Defined in view/event/InternalEvent.ts:137

`Static`addListener

addListener(
    element: Listenable,
    eventName: string,
    funct: MouseEventListener | KeyboardEventListener,
): void
Binds the function to the specified event on the given element.
Parameters
- element: Listenable
- eventName: string
- funct: MouseEventListener | KeyboardEventListener
Returns void
- Defined in view/event/InternalEvent.ts:73

`Static`addMouseWheelListener

addMouseWheelListener(
    funct: (
        event: Event,
        up: boolean,
        force?: boolean,
        cx?: number,
        cy?: number,
    ) => void,
    target: Listenable,
): void
Installs the given function as a handler for mouse wheel events. The function has two arguments: the mouse event and a boolean that specifies if the wheel was moved up or down.

This has been tested with IE 6 and 7, Firefox (all versions), Opera and Safari. It does currently not work on Safari for Mac.

Example
Parameters
- funct: (event: Event, up: boolean, force?: boolean, cx?: number, cy?: number) => void
  Handler function that takes the event argument and a boolean up argument for the mousewheel direction.
- target: Listenable
  Target for installing the listener in Google Chrome. See https://www.chromestatus.com/features/6662647093133312.
Returns void
Example
```
mxEvent.addMouseWheelListener(function (evt, up)
{
  GlobalConfig.logger.show();
  GlobalConfig.logger.debug('mouseWheel: up='+up);
});
```
- Defined in view/event/InternalEvent.ts:343

`Static`consume

consume(evt: Event, preventDefault?: boolean, stopPropagation?: boolean): void
Consumes the given event.
Parameters
- evt: Event
  Native event to be consumed.
- OptionalpreventDefault: boolean = true
  Optional boolean to prevent the default for the event. Default is true.
- OptionalstopPropagation: boolean = true
  Option boolean to stop event propagation. Default is true.
Returns void
- Defined in view/event/InternalEvent.ts:465

`Static`disableContextMenu

disableContextMenu(element: Listenable): void
Disables the context menu for the given element.
Parameters
- element: Listenable
Returns void
- Defined in view/event/InternalEvent.ts:447

`Static`redirectMouseEvents

redirectMouseEvents(
    node: Listenable,
    graph: AbstractGraph,
    state?: null | CellState | ((evt: Event) => null | CellState),
    down?: null | MouseEventListener,
    move?: null | MouseEventListener,
    up?: null | MouseEventListener,
    dblClick?: null | MouseEventListener,
): void
Redirects the mouse events from the given DOM node to the graph dispatch loop using the event and given state as event arguments. State can either be an instance of or a function that returns an . The down, move, up and dblClick arguments are optional functions that take the trigger event as arguments and replace the default behaviour.
Parameters
- node: Listenable
- graph: AbstractGraph
- state: null | CellState | ((evt: Event) => null | CellState) = null
- down: null | MouseEventListener = null
- move: null | MouseEventListener = null
- up: null | MouseEventListener = null
- dblClick: null | MouseEventListener = null
Returns void
- Defined in view/event/InternalEvent.ts:239

`Static`release

release(element: Listenable): void
Removes the known listeners from the given DOM node and its descendants.
Parameters
- element: Listenable
  DOM node to remove the listeners from.
Returns void
- Defined in view/event/InternalEvent.ts:301

`Static`removeAllListeners

removeAllListeners(element: Listenable): void
Removes all listeners from the given element.
Parameters
- element: Listenable
Returns void
- Defined in view/event/InternalEvent.ts:119

`Static`removeGestureListeners

removeGestureListeners(
    node: Listenable,
    startListener: null | MouseEventListener,
    moveListener: null | MouseEventListener,
    endListener: null | MouseEventListener,
): void
Removes the given listeners from mousedown, mousemove, mouseup and the respective touch events if <Client.IS_TOUCH> is true.
Parameters
- node: Listenable
- startListener: null | MouseEventListener
- moveListener: null | MouseEventListener
- endListener: null | MouseEventListener
Returns void
- Defined in view/event/InternalEvent.ts:186

`Static`removeListener

removeListener(
    element: Listenable,
    eventName: string,
    funct: MouseEventListener | KeyboardEventListener,
): void
Removes the specified listener from the given element.
Parameters
- element: Listenable
- eventName: string
- funct: MouseEventListener | KeyboardEventListener
Returns void
- Defined in view/event/InternalEvent.ts:95

Class InternalEvent

Memory Leaks:

Index

Constructors

Properties

Methods

Constructors

constructor

Returns InternalEvent

Properties

StaticACTIVATE

StaticADD

StaticADD_CELLS

StaticADD_OVERLAY

StaticADD_VERTEX

StaticAFTER_ADD_VERTEX

StaticALIGN_CELLS

StaticBEFORE_ADD_VERTEX

StaticBEFORE_UNDO

StaticBEGIN_UPDATE

StaticCELL_CONNECTED

StaticCELLS_ADDED

StaticCELLS_FOLDED

StaticCELLS_MOVED

StaticCELLS_ORDERED

StaticCELLS_REMOVED

StaticCELLS_RESIZED

StaticCELLS_TOGGLED

StaticCHANGE

StaticCLEAR

StaticCLICK

StaticCLOSE

StaticCONNECT

StaticCONNECT_CELL

StaticCUSTOM_HANDLE

Default

StaticDESTROY

StaticDISCONNECT

StaticDONE

StaticDOUBLE_CLICK

StaticDOWN

StaticEDITING_STARTED

StaticEDITING_STOPPED

StaticEND_EDIT

StaticEND_UPDATE

StaticESCAPE

StaticEXECUTE

StaticEXECUTED

StaticFIRE_MOUSE_EVENT

StaticFIRED

StaticFLIP_EDGE

StaticFOLD_CELLS

StaticGESTURE

StaticGET

StaticGROUP_CELLS

StaticHIDE

StaticLABEL_CHANGED

StaticLABEL_HANDLE

Default

StaticLAYOUT_CELLS

StaticMARK

StaticMAXIMIZE

StaticMINIMIZE

StaticMOUSE_DOWN

StaticMOUSE_MOVE

StaticMOUSE_UP

StaticMOVE

StaticMOVE_CELLS

StaticMOVE_END

StaticMOVE_START

StaticNORMALIZE

StaticNOTIFY

StaticOPEN

StaticORDER_CELLS

StaticPAN

StaticPAN_END

StaticPAN_START

StaticPINCH_THRESHOLD

StaticPOST

StaticRECEIVE

`Static`ACTIVATE

`Static`ADD

`Static`ADD_CELLS

`Static`ADD_OVERLAY

`Static`ADD_VERTEX

`Static`AFTER_ADD_VERTEX

`Static`ALIGN_CELLS

`Static`BEFORE_ADD_VERTEX

`Static`BEFORE_UNDO

`Static`BEGIN_UPDATE

`Static`CELL_CONNECTED

`Static`CELLS_ADDED

`Static`CELLS_FOLDED

`Static`CELLS_MOVED

`Static`CELLS_ORDERED

`Static`CELLS_REMOVED

`Static`CELLS_RESIZED

`Static`CELLS_TOGGLED

`Static`CHANGE

`Static`CLEAR

`Static`CLICK

`Static`CLOSE

`Static`CONNECT

`Static`CONNECT_CELL

`Static`CUSTOM_HANDLE

`Static`DESTROY

`Static`DISCONNECT

`Static`DONE

`Static`DOUBLE_CLICK

`Static`DOWN

`Static`EDITING_STARTED

`Static`EDITING_STOPPED

`Static`END_EDIT

`Static`END_UPDATE

`Static`ESCAPE

`Static`EXECUTE

`Static`EXECUTED

`Static`FIRE_MOUSE_EVENT

`Static`FIRED

`Static`FLIP_EDGE

`Static`FOLD_CELLS

`Static`GESTURE

`Static`GET

`Static`GROUP_CELLS

`Static`HIDE

`Static`LABEL_CHANGED

`Static`LABEL_HANDLE

`Static`LAYOUT_CELLS

`Static`MARK

`Static`MAXIMIZE

`Static`MINIMIZE

`Static`MOUSE_DOWN

`Static`MOUSE_MOVE

`Static`MOUSE_UP

`Static`MOVE

`Static`MOVE_CELLS

`Static`MOVE_END

`Static`MOVE_START

`Static`NORMALIZE

`Static`NOTIFY

`Static`OPEN

`Static`ORDER_CELLS

`Static`PAN

`Static`PAN_END

`Static`PAN_START

`Static`PINCH_THRESHOLD

`Static`POST

`Static`RECEIVE

`Static`REDO

`Static`REFRESH

`Static`REMOVE

`Static`REMOVE_CELLS

`Static`REMOVE_CELLS_FROM_PARENT

`Static`REMOVE_OVERLAY

`Static`RESET

`Static`RESIZE

`Static`RESIZE_CELLS

`Static`RESIZE_END

`Static`RESIZE_START

`Static`RESUME