Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

Properties

dx

dx: number

Variable: dx

Holds the current horizontal offset.

dy

dy: number

Variable: dy

Holds the current vertical offset.

eventListeners

eventListeners: any[]

Variable: eventListeners

Holds the event names and associated listeners in an array. The array contains the event name followed by the respective listener for each registered listener.

eventSource

eventSource: any

Variable: eventSource

Optional source for events. Default is null.

eventsEnabled

eventsEnabled: boolean

Variable: eventsEnabled

Specifies if events can be fired. Default is true.

graph

graph: mxGraph

Variable: graph

Reference to the enclosing .

ignoreCell

ignoreCell: boolean

Variable: ignoreCell

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

maxScale

maxScale: number

Variable: maxScale

Specifies the maximum scale. Default is 8.

minScale

minScale: number

Variable: minScale

Specifies the minimum scale. Default is 0.01.

panningEnabled

panningEnabled: boolean

Variable: panningEnabled

Specifies if panning should be enabled. Default is true.

pinchEnabled

pinchEnabled: boolean

Variable: pinchEnabled

Specifies if pinch gestures should be handled as zoom. Default is true.

previewEnabled

previewEnabled: boolean

Variable: previewEnabled

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

startX

startX: number

Variable: startX

Holds the x-coordinate of the start point.

startY

startY: number

Variable: startY

Holds the y-coordinate of the start point.

useGrid

useGrid: boolean

Variable: useGrid

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

useLeftButtonForPanning

useLeftButtonForPanning: boolean

Variable: useLeftButtonForPanning

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

usePopupTrigger

usePopupTrigger: boolean

Variable: usePopupTrigger

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

Methods

addListener

  • addListener(name: string, funct: (...args: any[]) => any): void
  • Function: addListener

    Binds the specified function to the given event name. If no event name is given, then the listener is registered for all events.

    The parameters of the listener are the sender and an .

    Parameters

    • name: string
    • funct: (...args: any[]) => any
        • (...args: any[]): any
        • Parameters

          • Rest ...args: any[]

          Returns any

    Returns void

consumePanningTrigger

  • Function: consumePanningTrigger

    Consumes the given if it was a panning trigger in . 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:

    (code) consumePanningTrigger(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; } }; (end)

    Parameters

    Returns void

destroy

  • destroy(): void

fireEvent

  • Function: fireEvent

    Dispatches the given event to the listeners which are registered for the event. The sender argument is optional. The current execution scope ("this") is used for the listener invocation (see <mxUtils.bind>).

    Example:

    (code) fireEvent(new mxEventObject("eventName", key1, val1, .., keyN, valN)) (end)

    Parameters:

    evt - that represents the event. sender - Optional sender to be passed to the listener. Default value is the return value of .

    Parameters

    Returns void

getEventSource

  • getEventSource(): any

isActive

  • isActive(): boolean

isEventsEnabled

  • isEventsEnabled(): boolean

isForcePanningEvent

  • Function: isForcePanningEvent

    Returns true if the given should start panning. This implementation always returns true if is true or for multi touch events.

    Parameters

    Returns boolean

isPanningEnabled

  • isPanningEnabled(): boolean

isPanningTrigger

  • Function: isPanningTrigger

    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 is true and the event is a popup trigger.

    Parameters

    Returns boolean

isPinchEnabled

  • isPinchEnabled(): boolean

mouseDown

  • Function: mouseDown

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

    Parameters

    Returns void

mouseMove

mouseUp

panGraph

  • panGraph(dx: number, dy: number): void

removeListener

  • removeListener(funct: (...args: any[]) => any): void
  • Function: removeListener

    Removes all occurrences of the given listener from .

    Parameters

    • funct: (...args: any[]) => any
        • (...args: any[]): any
        • Parameters

          • Rest ...args: any[]

          Returns any

    Returns void

reset

  • reset(): void

setEventSource

  • setEventSource(value: any): void

setEventsEnabled

  • setEventsEnabled(value: boolean): void

setPanningEnabled

  • setPanningEnabled(value: boolean): void

setPinchEnabled

  • setPinchEnabled(value: boolean): void

start

Generated using TypeDoc