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.
| mxPanningHandler | Event handler that pans and creates popupmenus. |
| Functions | |
| mxPanningHandler | Constructs an event handler that creates a mxPopupMenu and pans the graph. |
| Events | |
| mxEvent. | Fires when the panning handler changes its <active> state to true. |
| mxEvent.PAN | Fires while handle is processing events. |
| mxEvent. | Fires when the panning handler changes its <active> state to false. |
| Variables | |
| graph | Reference to the enclosing mxGraph. |
| usePopupTrigger | Specifies if the <isPopupTrigger> should also be used for panning. |
| useLeftButtonForPanning | Specifies if panning should be active for the left mouse button. |
| selectOnPopup | Specifies if cells should be selected if a popupmenu is displayed for them. |
| clearSelectionOnBackground | Specifies if cells should be deselected if a popupmenu is displayed for the diagram background. |
| 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. |
| init | Initializes the shapes required for this vertex handler. |
| isPanningTrigger | Returns true if the given event is a panning trigger for the optional given cell. |
| mouseDown | Handles the event by initiating the panning. |
| 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. |
| getCellForPopupEvent | Hook to return the cell for the mouse up popup trigger handling. |
| panGraph | Pans graph by the given amount. |
| destroy | Destroys the handler and all its resources and DOM nodes. |
Constructs an event handler that creates a mxPopupMenu and pans the graph.
Fires when the panning handler changes its <active> state to true. The <code>event</code> property contains the corresponding mxMouseEvent.
Fires while handle is processing events. The <code>event</code> property contains the corresponding mxMouseEvent.
Fires when the panning handler changes its <active> state to false. The <code>event</code> property contains the corresponding mxMouseEvent.
mxPanningHandler.prototype.graph
Reference to the enclosing mxGraph.
mxPanningHandler.prototype.usePopupTrigger
Specifies if the <isPopupTrigger> should also be used for panning. To avoid conflicts, the panning is only activated if the mouse was moved more than mxGraph.tolerance, otherwise, a single click is assumed and the popupmenu is displayed. Default is true.
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.
mxPanningHandler.prototype.isPanningEnabled = function()
Returns panningEnabled.
mxPanningHandler.prototype.setPanningEnabled = function( value )
Sets panningEnabled.
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.
mxPanningHandler.prototype.panGraph = function( dx, dy )
Pans graph by the given amount.
Reference to the enclosing mxGraph.
mxPanningHandler.prototype.graph
Specifies if the isPopupTrigger should also be used for panning.
mxPanningHandler.prototype.usePopupTrigger
Specifies if panning should be active for the left mouse button.
mxPanningHandler.prototype.useLeftButtonForPanning
Specifies if cells should be selected if a popupmenu is displayed for them.
mxPanningHandler.prototype.selectOnPopup
Specifies if cells should be deselected if a popupmenu is displayed for the diagram background.
mxPanningHandler.prototype.clearSelectionOnBackground
Specifies if panning should be active even if there is a cell under the mousepointer.
mxPanningHandler.prototype.ignoreCell
Specifies if the panning should be previewed.
mxPanningHandler.prototype.previewEnabled
Specifies if the panning steps should be aligned to the grid size.
mxPanningHandler.prototype.useGrid
Specifies if panning should be enabled.
mxPanningHandler.prototype.panningEnabled
Returns panningEnabled.
mxPanningHandler.prototype.isPanningEnabled = function()
Sets panningEnabled.
mxPanningHandler.prototype.setPanningEnabled = function( value )
Initializes the shapes required for this vertex handler.
mxPanningHandler.prototype.init = function()
Returns true if the given event is a panning trigger for the optional given cell.
mxPanningHandler.prototype.isPanningTrigger = function( me )
Handles the event by initiating the panning.
mxPanningHandler.prototype.mouseDown = function( sender, me )
Handles the event by updating the panning on the graph.
mxPanningHandler.prototype.mouseMove = function( sender, me )
Handles the event by setting the translation on the view or showing the popupmenu.
mxPanningHandler.prototype.mouseUp = function( sender, me )
Hook to return the cell for the mouse up popup trigger handling.
mxPanningHandler.prototype.getCellForPopupEvent = function( me )
Pans graph by the given amount.
mxPanningHandler.prototype.panGraph = function( dx, dy )
Destroys the handler and all its resources and DOM nodes.
mxPanningHandler.prototype.destroy = function()
Specifies if panning should be enabled.
mxGraph.prototype.setPanning = function( enabled )
Tolerance for a move to be handled as a single click.
mxGraph.prototype.tolerance