API Docs for: 0.2.7
Show:

GlobalMouse Class

Defined in: lib/globalMouse.js:11
Module: Interaction
Parent Module: WebDriver

Global mouse object handling global mouse commands

Constructor

GlobalMouse

(
  • driver
)

Defined in lib/globalMouse.js:11

Parameters:

Methods

_logMethodCall

(
  • event
)
private

Defined in lib/globalMouse.js:29

Logs a method call by an event

Parameters:

_moveTo

(
  • elementId
  • xOffset
  • yOffset
)
protected

Defined in lib/globalMouse.js:73

Move the mouse by an offset of the specified element. If no element is specified, the move is relative to the current mouse cursor. If an element is provided but no offset, the mouse will be moved to the center of the element. If the element is not visible, it will be scrolled into view.

Parameters:

_requestJSON

(
  • method
  • path
  • [body]
)
private

Defined in lib/globalMouse.js:42

Performs a context dependent JSON request for the current session. The result is parsed for errors.

Parameters:

Returns:

:

buttonDown

(
  • [button=Mouse.BUTTON_LEFT]
)

Defined in lib/globalMouse.js:162

Click and hold the any mouse button at the current location of the mouse cursor

Parameters:

  • [button=Mouse.BUTTON_LEFT] Number optional

buttonDownAt

(
  • xOffset
  • yOffset
  • [button=Mouse.BUTTON_LEFT]
)

Defined in lib/globalMouse.js:174

Click and hold the any mouse button relative to the current location of the mouse cursor

Parameters:

buttonUp

(
  • [button=Mouse.BUTTON_LEFT]
)

Defined in lib/globalMouse.js:189

Releases the mouse button previously held at the current location of the mouse cursor

Parameters:

  • [button=Mouse.BUTTON_LEFT] Number optional

buttonUpAt

(
  • xOffset
  • yOffset
  • [button=Mouse.BUTTON_LEFT]
)

Defined in lib/globalMouse.js:201

Releases the mouse button previously held at the current location of the mouse cursor

Parameters:

click

(
  • [button=Mouse.BUTTON_LEFT]
)

Defined in lib/globalMouse.js:113

Click any mouse button at the current location of the mouse cursor

Parameters:

  • [button=Mouse.BUTTON_LEFT] Number optional

clickAt

(
  • xOffset
  • yOffset
  • [button=Mouse.BUTTON_LEFT]
)

Defined in lib/globalMouse.js:125

Click any mouse button at an offset relative to the current location of the mouse cursor

Parameters:

doubleClick

()

Defined in lib/globalMouse.js:139

Double-clicks at the current location of the mouse cursor

doubleClickAt

(
  • x
  • y
)

Defined in lib/globalMouse.js:148

Double-clicks at the current location of the mouse cursor

Parameters:

moveTo

(
  • xOffset
  • yOffset
)

Defined in lib/globalMouse.js:99

Move the mouse by an offset relative to the current mouse cursor position

Parameters: