mxPanningHandler

Event handler that pans and creates popupmenus. To use the left mousebutton for panning without interfering with cell moving and resizing, use <isUseLeftButton> and <isIgnoreCell>. For grid size steps while panning, use useGrid. This handler is built-into <mxGraph.panningHandler> and enabled using mxGraph.setPanning.

Summary

mxPanningHandler	Event handler that pans and creates popupmenus.
Functions
mxPanningHandler	Constructs an event handler that creates a mxPopupMenu and pans the graph.
Events
mxEvent.PAN_START	Fires when the panning handler changes its <active> state to true.
mxEvent.PAN	Fires while handle is processing events.
mxEvent.PAN_END	Fires when the panning handler changes its <active> state to false.
Variables
graph	Reference to the enclosing mxGraph.
useLeftButtonForPanning	Specifies if panning should be active for the left mouse button.
usePopupTrigger	Specifies if mxEvent.isPopupTrigger should also be used for panning.
ignoreCell	Specifies if panning should be active even if there is a cell under the mousepointer.
previewEnabled	Specifies if the panning should be previewed.
useGrid	Specifies if the panning steps should be aligned to the grid size.
panningEnabled	Specifies if panning should be enabled.
Functions
isPanningEnabled	Returns panningEnabled.
setPanningEnabled	Sets panningEnabled.
isPanningTrigger	Returns true if the given event is a panning trigger for the optional given cell.
mouseDown	Handles the event by initiating the panning.
consumePanningTrigger	Consumes the given mxMouseEvent if it was a panning trigger in mouseDown.
mouseMove	Handles the event by updating the panning on the graph.
mouseUp	Handles the event by setting the translation on the view or showing the popupmenu.
scaleGraph	Handles pinch events on touch devices.
panGraph	Pans graph by the given amount.
destroy	Destroys the handler and all its resources and DOM nodes.

Functions

mxPanningHandler

Constructs an event handler that creates a mxPopupMenu and pans the graph.

Events

mxEvent.PAN_START

Fires when the panning handler changes its <active> state to true. The <code>event</code> property contains the corresponding mxMouseEvent.

mxEvent.PAN

Fires while handle is processing events. The <code>event</code> property contains the corresponding mxMouseEvent.

mxEvent.PAN_END

Fires when the panning handler changes its <active> state to false. The <code>event</code> property contains the corresponding mxMouseEvent.

Variables

graph

mxPanningHandler.prototype.graph

Reference to the enclosing mxGraph.

useLeftButtonForPanning

mxPanningHandler.prototype.useLeftButtonForPanning

Specifies if panning should be active for the left mouse button. Setting this to true may conflict with mxRubberband. Default is false.

usePopupTrigger

mxPanningHandler.prototype.usePopupTrigger

Specifies if mxEvent.isPopupTrigger should also be used for panning.

ignoreCell

mxPanningHandler.prototype.ignoreCell

Specifies if panning should be active even if there is a cell under the mousepointer. Default is false.

previewEnabled

mxPanningHandler.prototype.previewEnabled

Specifies if the panning should be previewed. Default is true.

useGrid

mxPanningHandler.prototype.useGrid

Specifies if the panning steps should be aligned to the grid size. Default is false.

panningEnabled

mxPanningHandler.prototype.panningEnabled

Specifies if panning should be enabled. Default is true.

Functions

isPanningEnabled

mxPanningHandler.prototype.isPanningEnabled = function()

Returns panningEnabled.

setPanningEnabled

mxPanningHandler.prototype.setPanningEnabled = function( value )

Sets panningEnabled.

isPanningTrigger

mxPanningHandler.prototype.isPanningTrigger = function( me )

Returns true if the given event is a panning trigger for the optional given cell. This returns true if control-shift is pressed or if usePopupTrigger is true and the event is a popup trigger.

mouseDown

mxPanningHandler.prototype.mouseDown = function( sender,
me )

Handles the event by initiating the panning. By consuming the event all subsequent events of the gesture are redirected to this handler.

consumePanningTrigger

mxPanningHandler.prototype.consumePanningTrigger = function( me )

Consumes the given mxMouseEvent if it was a panning trigger in mouseDown. The default is to invoke mxMouseEvent.consume. Note that this will block any further event processing. If you haven’t disabled built-in context menus and require immediate selection of the cell on mouseDown in Safari and/or on the Mac, then use the following code:

mxPanningHandler.prototype.consumePanningTrigger = function(me)
{
  if (me.evt.preventDefault)
  {
    me.evt.preventDefault();
  }

  // Stops event processing in IE
  me.evt.returnValue = false;

  // Sets local consumed state
  if (!mxClient.IS_SF && !mxClient.IS_MAC)
  {
    me.consumed = true;
  }
};

mouseMove

mxPanningHandler.prototype.mouseMove = function( sender,
me )

Handles the event by updating the panning on the graph.

mouseUp

mxPanningHandler.prototype.mouseUp = function( sender,
me )

Handles the event by setting the translation on the view or showing the popupmenu.

scaleGraph

mxPanningHandler.prototype.scaleGraph = function( scale,
preview )

Handles pinch events on touch devices.

panGraph

mxPanningHandler.prototype.panGraph = function( dx,
dy )

Pans graph by the given amount.

destroy

mxPanningHandler.prototype.destroy = function()

Destroys the handler and all its resources and DOM nodes.