Options
All
  • Public
  • Public/Protected
  • All
Menu

Class mxMouseEvent

Hierarchy

  • mxMouseEvent

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

consumed

consumed: boolean

Variable: consumed

Holds the consumed state of this event.

evt

evt: Event

Variable: evt

Holds the inner event object.

graphX

graphX: number

Variable: graphX

Holds the x-coordinate of the event in the graph. This value is set in <mxGraph.fireMouseEvent>.

graphY

graphY: number

Variable: graphY

Holds the y-coordinate of the event in the graph. This value is set in <mxGraph.fireMouseEvent>.

sourceState

sourceState: mxCellState

Variable: sourceState

Holds the that was passed to the constructor. This can be different from depending on the result of <mxGraph.getEventState>.

state

state: mxCellState

Variable: state

Holds the optional associated with this event.

Methods

consume

  • consume(preventDefault?: boolean): void

  • Function: consume

    Sets to true and invokes preventDefault on the native event if such a method is defined. This is used mainly to avoid the cursor from being changed to a text cursor in Webkit. You can use the preventDefault flag to disable this functionality.

    Parameters:

    preventDefault - Specifies if the native event should be canceled. Default is true.

    Parameters

    • Optional preventDefault: boolean

    Returns void

getCell

getEvent

  • getEvent(): MouseEvent

getGraphX

  • getGraphX(): number

getGraphY

  • getGraphY(): number

getSource

  • getSource(): Element

  • Function: getSource

    Returns the target DOM element using <mxEvent.getSource> for .

    Returns Element

getState

getX

  • getX(): number

getY

  • getY(): number

isConsumed

  • isConsumed(): boolean

isPopupTrigger

  • isPopupTrigger(): boolean

isSource

  • isSource(shape: mxShape): boolean

Generated using TypeDoc