mxEvent

Cross-browser DOM event support. For internal event handling, mxEventSource and the graph event dispatch loop in mxGraph 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.

Summary

mxEvent	Cross-browser DOM event support.
Functions
addListener	Binds the function to the specified event on the given element.
removeListener	Removes the specified listener from the given element.
removeAllListeners	Removes all listeners from the given element.
addGestureListeners	Adds the given listeners for touch, mouse and/or pointer events.
removeGestureListeners	Removes the given listeners from mousedown, mousemove, mouseup and the respective touch events if mxClient.IS_TOUCH is true.
redirectMouseEvents	Redirects the mouse events from the given DOM node to the graph dispatch loop using the event and given state as event arguments.
release	Removes the known listeners from the given DOM node and its descendants.
disableContextMenu	Disables the context menu for the given element.
getSource	Returns the event’s target or srcElement depending on the browser.
isConsumed	Returns true if the event has been consumed using consume.
isTouchEvent	Returns true if the event was generated using a touch device (not a pen or mouse).
isPenEvent	Returns true if the event was generated using a pen (not a touch device or mouse).
isMultiTouchEvent	Returns true if the event was generated using a touch device (not a pen or mouse).
isMouseEvent	Returns true if the event was generated using a mouse (not a pen or touch device).
isLeftMouseButton	Returns true if the left mouse button is pressed for the given event.
isMiddleMouseButton	Returns true if the middle mouse button is pressed for the given event.
isRightMouseButton	Returns true if the right mouse button was pressed.
isPopupTrigger	Returns true if the event is a popup trigger.
isShiftDown	Returns true if the shift key is pressed for the given event.
isAltDown	Returns true if the alt key is pressed for the given event.
isControlDown	Returns true if the control key is pressed for the given event.
isMetaDown	Returns true if the meta key is pressed for the given event.
getMainEvent	Returns the touch or mouse event that contains the mouse coordinates.
getClientX	Returns true if the meta key is pressed for the given event.
getClientY	Returns true if the meta key is pressed for the given event.
consume	Consumes the given event.
Variables
LABEL_HANDLE	Index for the label handle in an mxMouseEvent.
ROTATION_HANDLE	Index for the rotation handle in an mxMouseEvent.
CUSTOM_HANDLE	Start index for the custom handles in an mxMouseEvent.
VIRTUAL_HANDLE	Start index for the virtual handles in an mxMouseEvent.
MOUSE_DOWN	Specifies the event name for mouseDown.
MOUSE_MOVE	Specifies the event name for mouseMove.
MOUSE_UP	Specifies the event name for mouseUp.
ACTIVATE	Specifies the event name for activate.
RESIZE_START	Specifies the event name for resizeStart.
RESIZE	Specifies the event name for resize.
RESIZE_END	Specifies the event name for resizeEnd.
MOVE_START	Specifies the event name for moveStart.
MOVE	Specifies the event name for move.
MOVE_END	Specifies the event name for moveEnd.
PAN_START	Specifies the event name for panStart.
PAN	Specifies the event name for pan.
PAN_END	Specifies the event name for panEnd.
MINIMIZE	Specifies the event name for minimize.
NORMALIZE	Specifies the event name for normalize.
MAXIMIZE	Specifies the event name for maximize.
HIDE	Specifies the event name for hide.
SHOW	Specifies the event name for show.
CLOSE	Specifies the event name for close.
DESTROY	Specifies the event name for destroy.
REFRESH	Specifies the event name for refresh.
SIZE	Specifies the event name for size.
SELECT	Specifies the event name for select.
FIRED	Specifies the event name for fired.
FIRE_MOUSE_EVENT	Specifies the event name for fireMouseEvent.
GESTURE	Specifies the event name for gesture.
TAP_AND_HOLD	Specifies the event name for tapAndHold.
GET	Specifies the event name for get.
RECEIVE	Specifies the event name for receive.
CONNECT	Specifies the event name for connect.
DISCONNECT	Specifies the event name for disconnect.
SUSPEND	Specifies the event name for suspend.
RESUME	Specifies the event name for suspend.
MARK	Specifies the event name for mark.
ROOT	Specifies the event name for root.
POST	Specifies the event name for post.
OPEN	Specifies the event name for open.
SAVE	Specifies the event name for open.
BEFORE_ADD_VERTEX	Specifies the event name for beforeAddVertex.
ADD_VERTEX	Specifies the event name for addVertex.
AFTER_ADD_VERTEX	Specifies the event name for afterAddVertex.
DONE	Specifies the event name for done.
EXECUTE	Specifies the event name for execute.
EXECUTED	Specifies the event name for executed.
BEGIN_UPDATE	Specifies the event name for beginUpdate.
START_EDIT	Specifies the event name for startEdit.
END_UPDATE	Specifies the event name for endUpdate.
END_EDIT	Specifies the event name for endEdit.
BEFORE_UNDO	Specifies the event name for beforeUndo.
UNDO	Specifies the event name for undo.
REDO	Specifies the event name for redo.
CHANGE	Specifies the event name for change.
NOTIFY	Specifies the event name for notify.
LAYOUT_CELLS	Specifies the event name for layoutCells.
CLICK	Specifies the event name for click.
SCALE	Specifies the event name for scale.
TRANSLATE	Specifies the event name for translate.
SCALE_AND_TRANSLATE	Specifies the event name for scaleAndTranslate.
UP	Specifies the event name for up.
DOWN	Specifies the event name for down.
ADD	Specifies the event name for add.
REMOVE	Specifies the event name for remove.
CLEAR	Specifies the event name for clear.
ADD_CELLS	Specifies the event name for addCells.
CELLS_ADDED	Specifies the event name for cellsAdded.
MOVE_CELLS	Specifies the event name for moveCells.
CELLS_MOVED	Specifies the event name for cellsMoved.
RESIZE_CELLS	Specifies the event name for resizeCells.
CELLS_RESIZED	Specifies the event name for cellsResized.
TOGGLE_CELLS	Specifies the event name for toggleCells.
CELLS_TOGGLED	Specifies the event name for cellsToggled.
ORDER_CELLS	Specifies the event name for orderCells.
CELLS_ORDERED	Specifies the event name for cellsOrdered.
REMOVE_CELLS	Specifies the event name for removeCells.
CELLS_REMOVED	Specifies the event name for cellsRemoved.
GROUP_CELLS	Specifies the event name for groupCells.
UNGROUP_CELLS	Specifies the event name for ungroupCells.
REMOVE_CELLS_FROM_PARENT	Specifies the event name for removeCellsFromParent.
FOLD_CELLS	Specifies the event name for foldCells.
CELLS_FOLDED	Specifies the event name for cellsFolded.
ALIGN_CELLS	Specifies the event name for alignCells.
LABEL_CHANGED	Specifies the event name for labelChanged.
CONNECT_CELL	Specifies the event name for connectCell.
CELL_CONNECTED	Specifies the event name for cellConnected.
SPLIT_EDGE	Specifies the event name for splitEdge.
FLIP_EDGE	Specifies the event name for flipEdge.
START_EDITING	Specifies the event name for startEditing.
EDITING_STARTED	Specifies the event name for editingStarted.
EDITING_STOPPED	Specifies the event name for editingStopped.
ADD_OVERLAY	Specifies the event name for addOverlay.
REMOVE_OVERLAY	Specifies the event name for removeOverlay.
UPDATE_CELL_SIZE	Specifies the event name for updateCellSize.
ESCAPE	Specifies the event name for escape.
DOUBLE_CLICK	Specifies the event name for doubleClick.
START	Specifies the event name for start.
RESET	Specifies the event name for reset.
PINCH_THRESHOLD	Threshold for pinch gestures to fire a mouse wheel event.

Functions

addListener

addListener: function()

Binds the function to the specified event on the given element. Use mxUtils.bind in order to bind the “this” keyword inside the function to a given execution scope.

removeListener

removeListener: function()

Removes the specified listener from the given element.

removeAllListeners

removeAllListeners: function( element )

Removes all listeners from the given element.

addGestureListeners

addGestureListeners: function( node,
startListener,
moveListener,
endListener )

Adds the given listeners for touch, mouse and/or pointer events. If mxClient.IS_POINTER is true then pointer events will be registered, else the respective mouse events will be registered. If mxClient.IS_POINTER is false and mxClient.IS_TOUCH is true then the respective touch events will be registered as well as the mouse events.

removeGestureListeners

removeGestureListeners: function( node,
startListener,
moveListener,
endListener )

Removes the given listeners from mousedown, mousemove, mouseup and the respective touch events if mxClient.IS_TOUCH is true.

redirectMouseEvents

redirectMouseEvents: function( node,
graph,
state,
down,
move,
up,
dblClick )

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 mxCellState or a function that returns an mxCellState. The down, move, up and dblClick arguments are optional functions that take the trigger event as arguments and replace the default behaviour.

release

release: function( element )

Removes the known listeners from the given DOM node and its descendants.

Parameters

element

DOM node to remove the listeners from.

disableContextMenu

disableContextMenu: function( element )

Disables the context menu for the given element.

getSource

getSource: function( evt )

Returns the event’s target or srcElement depending on the browser.

isConsumed

isConsumed: function( evt )

Returns true if the event has been consumed using consume.

isTouchEvent

isTouchEvent: function( evt )

Returns true if the event was generated using a touch device (not a pen or mouse).

isPenEvent

isPenEvent: function( evt )

Returns true if the event was generated using a pen (not a touch device or mouse).

isMultiTouchEvent

isMultiTouchEvent: function( evt )

Returns true if the event was generated using a touch device (not a pen or mouse).

isMouseEvent

isMouseEvent: function( evt )

Returns true if the event was generated using a mouse (not a pen or touch device).

isLeftMouseButton

isLeftMouseButton: function( evt )

Returns true if the left mouse button is pressed for the given event. To check if a button is pressed during a mouseMove you should use the mxGraph.isMouseDown property. Note that this returns true in Firefox for control+left-click on the Mac.

isMiddleMouseButton

isMiddleMouseButton: function( evt )

Returns true if the middle mouse button is pressed for the given event. To check if a button is pressed during a mouseMove you should use the mxGraph.isMouseDown property.

isRightMouseButton

isRightMouseButton: function( evt )

Returns true if the right mouse button was pressed. Note that this button might not be available on some systems. For handling a popup trigger isPopupTrigger should be used.

isPopupTrigger

isPopupTrigger: function( evt )

Returns true if the event is a popup trigger. This implementation returns true if the right button or the left button and control was pressed on a Mac.

isShiftDown

isShiftDown: function( evt )

Returns true if the shift key is pressed for the given event.

isAltDown

isAltDown: function( evt )

Returns true if the alt key is pressed for the given event.

isControlDown

isControlDown: function( evt )

Returns true if the control key is pressed for the given event.

isMetaDown

isMetaDown: function( evt )

Returns true if the meta key is pressed for the given event.

getMainEvent

getMainEvent: function( e )

Returns the touch or mouse event that contains the mouse coordinates.

getClientX

getClientX: function( e )

Returns true if the meta key is pressed for the given event.

getClientY

getClientY: function( e )

Returns true if the meta key is pressed for the given event.

consume

consume: function( evt,
preventDefault,
stopPropagation )

Consumes the given event.

Parameters

evt	Native event to be consumed.
preventDefault	Optional boolean to prevent the default for the event. Default is true.
stopPropagation	Option boolean to stop event propagation. Default is true.

Variables

LABEL_HANDLE

LABEL_HANDLE: -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 is -1.

ROTATION_HANDLE

ROTATION_HANDLE: -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 is -2.

CUSTOM_HANDLE

CUSTOM_HANDLE: -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 is -100.

VIRTUAL_HANDLE

VIRTUAL_HANDLE: -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. Default is -100000. This assumes that there are no more than VIRTUAL_HANDLE - CUSTOM_HANDLE custom handles.

MOUSE_DOWN

MOUSE_DOWN: 'mouseDown'

Specifies the event name for mouseDown.

MOUSE_MOVE

MOUSE_MOVE: 'mouseMove'

Specifies the event name for mouseMove.

MOUSE_UP

MOUSE_UP: 'mouseUp'

Specifies the event name for mouseUp.

ACTIVATE

ACTIVATE: 'activate'

Specifies the event name for activate.

RESIZE_START

RESIZE_START: 'resizeStart'

Specifies the event name for resizeStart.

RESIZE

RESIZE: 'resize'

Specifies the event name for resize.

RESIZE_END

RESIZE_END: 'resizeEnd'

Specifies the event name for resizeEnd.

MOVE_START

MOVE_START: 'moveStart'

Specifies the event name for moveStart.

MOVE

MOVE: 'move'

Specifies the event name for move.

MOVE_END

MOVE_END: 'moveEnd'

Specifies the event name for moveEnd.

PAN_START

PAN_START: 'panStart'

Specifies the event name for panStart.

PAN

PAN: 'pan'

Specifies the event name for pan.

PAN_END

PAN_END: 'panEnd'

Specifies the event name for panEnd.

MINIMIZE

MINIMIZE: 'minimize'

Specifies the event name for minimize.

NORMALIZE

NORMALIZE: 'normalize'

Specifies the event name for normalize.

MAXIMIZE

MAXIMIZE: 'maximize'

Specifies the event name for maximize.

HIDE

HIDE: 'hide'

Specifies the event name for hide.

SHOW

SHOW: 'show'

Specifies the event name for show.

CLOSE

CLOSE: 'close'

Specifies the event name for close.

DESTROY

DESTROY: 'destroy'

Specifies the event name for destroy.

REFRESH

REFRESH: 'refresh'

Specifies the event name for refresh.

SIZE

SIZE: 'size'

Specifies the event name for size.

SELECT

SELECT: 'select'

Specifies the event name for select.

FIRED

FIRED: 'fired'

Specifies the event name for fired.

FIRE_MOUSE_EVENT

FIRE_MOUSE_EVENT: 'fireMouseEvent'

Specifies the event name for fireMouseEvent.

GESTURE

GESTURE: 'gesture'

Specifies the event name for gesture.

TAP_AND_HOLD

TAP_AND_HOLD: 'tapAndHold'

Specifies the event name for tapAndHold.

GET

GET: 'get'

Specifies the event name for get.

RECEIVE

RECEIVE: 'receive'

Specifies the event name for receive.

CONNECT

CONNECT: 'connect'

Specifies the event name for connect.

DISCONNECT

DISCONNECT: 'disconnect'

Specifies the event name for disconnect.

SUSPEND

SUSPEND: 'suspend'

Specifies the event name for suspend.

RESUME

RESUME: 'resume'

Specifies the event name for suspend.

MARK

MARK: 'mark'

Specifies the event name for mark.

ROOT

ROOT: 'root'

Specifies the event name for root.

POST

POST: 'post'

Specifies the event name for post.

OPEN

OPEN: 'open'

Specifies the event name for open.

SAVE

SAVE: 'save'

Specifies the event name for open.

BEFORE_ADD_VERTEX

BEFORE_ADD_VERTEX: 'beforeAddVertex'

Specifies the event name for beforeAddVertex.

ADD_VERTEX

ADD_VERTEX: 'addVertex'

Specifies the event name for addVertex.

AFTER_ADD_VERTEX

AFTER_ADD_VERTEX: 'afterAddVertex'

Specifies the event name for afterAddVertex.

DONE

DONE: 'done'

Specifies the event name for done.

EXECUTE

EXECUTE: 'execute'

Specifies the event name for execute.

EXECUTED

EXECUTED: 'executed'

Specifies the event name for executed.

BEGIN_UPDATE

BEGIN_UPDATE: 'beginUpdate'

Specifies the event name for beginUpdate.

START_EDIT

START_EDIT: 'startEdit'

Specifies the event name for startEdit.

END_UPDATE

END_UPDATE: 'endUpdate'

Specifies the event name for endUpdate.

END_EDIT

END_EDIT: 'endEdit'

Specifies the event name for endEdit.

BEFORE_UNDO

BEFORE_UNDO: 'beforeUndo'

Specifies the event name for beforeUndo.

UNDO

UNDO: 'undo'

Specifies the event name for undo.

REDO

REDO: 'redo'

Specifies the event name for redo.

CHANGE

CHANGE: 'change'

Specifies the event name for change.

NOTIFY

NOTIFY: 'notify'

Specifies the event name for notify.

LAYOUT_CELLS

LAYOUT_CELLS: 'layoutCells'

Specifies the event name for layoutCells.

CLICK

CLICK: 'click'

Specifies the event name for click.

SCALE

SCALE: 'scale'

Specifies the event name for scale.

TRANSLATE

TRANSLATE: 'translate'

Specifies the event name for translate.

SCALE_AND_TRANSLATE

SCALE_AND_TRANSLATE: 'scaleAndTranslate'

Specifies the event name for scaleAndTranslate.

UP

UP: 'up'

Specifies the event name for up.

DOWN

DOWN: 'down'

Specifies the event name for down.

ADD

ADD: 'add'

Specifies the event name for add.

REMOVE

REMOVE: 'remove'

Specifies the event name for remove.

CLEAR

CLEAR: 'clear'

Specifies the event name for clear.

ADD_CELLS

ADD_CELLS: 'addCells'

Specifies the event name for addCells.

CELLS_ADDED

CELLS_ADDED: 'cellsAdded'

Specifies the event name for cellsAdded.

MOVE_CELLS

MOVE_CELLS: 'moveCells'

Specifies the event name for moveCells.

CELLS_MOVED

CELLS_MOVED: 'cellsMoved'

Specifies the event name for cellsMoved.

RESIZE_CELLS

RESIZE_CELLS: 'resizeCells'

Specifies the event name for resizeCells.

CELLS_RESIZED

CELLS_RESIZED: 'cellsResized'

Specifies the event name for cellsResized.

TOGGLE_CELLS

TOGGLE_CELLS: 'toggleCells'

Specifies the event name for toggleCells.

CELLS_TOGGLED

CELLS_TOGGLED: 'cellsToggled'

Specifies the event name for cellsToggled.

ORDER_CELLS

ORDER_CELLS: 'orderCells'

Specifies the event name for orderCells.

CELLS_ORDERED

CELLS_ORDERED: 'cellsOrdered'

Specifies the event name for cellsOrdered.

REMOVE_CELLS

REMOVE_CELLS: 'removeCells'

Specifies the event name for removeCells.

CELLS_REMOVED

CELLS_REMOVED: 'cellsRemoved'

Specifies the event name for cellsRemoved.

GROUP_CELLS

GROUP_CELLS: 'groupCells'

Specifies the event name for groupCells.

UNGROUP_CELLS

UNGROUP_CELLS: 'ungroupCells'

Specifies the event name for ungroupCells.

REMOVE_CELLS_FROM_PARENT

REMOVE_CELLS_FROM_PARENT: 'removeCellsFromParent'

Specifies the event name for removeCellsFromParent.

FOLD_CELLS

FOLD_CELLS: 'foldCells'

Specifies the event name for foldCells.

CELLS_FOLDED

CELLS_FOLDED: 'cellsFolded'

Specifies the event name for cellsFolded.

ALIGN_CELLS

ALIGN_CELLS: 'alignCells'

Specifies the event name for alignCells.

LABEL_CHANGED

LABEL_CHANGED: 'labelChanged'

Specifies the event name for labelChanged.

CONNECT_CELL

CONNECT_CELL: 'connectCell'

Specifies the event name for connectCell.

CELL_CONNECTED

CELL_CONNECTED: 'cellConnected'

Specifies the event name for cellConnected.

SPLIT_EDGE

SPLIT_EDGE: 'splitEdge'

Specifies the event name for splitEdge.

FLIP_EDGE

FLIP_EDGE: 'flipEdge'

Specifies the event name for flipEdge.

START_EDITING

START_EDITING: 'startEditing'

Specifies the event name for startEditing.

EDITING_STARTED

EDITING_STARTED: 'editingStarted'

Specifies the event name for editingStarted.

EDITING_STOPPED

EDITING_STOPPED: 'editingStopped'

Specifies the event name for editingStopped.

ADD_OVERLAY

ADD_OVERLAY: 'addOverlay'

Specifies the event name for addOverlay.

REMOVE_OVERLAY

REMOVE_OVERLAY: 'removeOverlay'

Specifies the event name for removeOverlay.

UPDATE_CELL_SIZE

UPDATE_CELL_SIZE: 'updateCellSize'

Specifies the event name for updateCellSize.

ESCAPE

ESCAPE: 'escape'

Specifies the event name for escape.

DOUBLE_CLICK

DOUBLE_CLICK: 'doubleClick'

Specifies the event name for doubleClick.

START

START: 'start'

Specifies the event name for start.

RESET

RESET: 'reset'

Specifies the event name for reset.

PINCH_THRESHOLD

PINCH_THRESHOLD: 10

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