MouseActionApi | @sakuli/legacy

Hierarchy

MouseActionApi
- ActionApi

Index

Methods

_check

_check(query: SahiElementQueryOrWebElement): Promise<void>

- Defined in src/context/sahi/action/mouse-action/mouse-action-api.interface.ts:102
Performs a click on a checkbox input and forces its state to be checked

Parameters
- query: SahiElementQueryOrWebElement
Returns Promise<void>

_click

_click(query: SahiElementQueryOrWebElement, combo?: undefined | string | ClickOptions, options?: undefined | ClickOptions): Promise<void>

- Defined in src/context/sahi/action/mouse-action/mouse-action-api.interface.ts:32
_click simulates a user's click on the given element.
example
```
_click(_button("Click Me"));
_click(_button("Click Me"), "CTRL"); // clicks with CTRL key pressed
_click(_button("Click Me"), "CTRL|SHIFT"); // clicks with CTRL and SHIFT keys pressed
_click(_button("Click Me"), {force: true}); // clicks without validation
_click(_button("Click Me"), "CTRL", {force: true}); //clicks with CTRL without validation
```
Parameters
- query: SahiElementQueryOrWebElement
  
  query to the Element to click on
- Optional combo: undefined | string | ClickOptions
  
  Optional combo key(s): can be CTRL, SHIFT, ALT or META; Can also be two or more keys together like "CTRL|SHIFT"
- Optional options: undefined | ClickOptions
  
  disables validations prior to the click action to enforce clicks where an element e.g. is covered
Returns Promise<void>

Resolves after the click is invoked, doesn't wait for further actions on the website which are possibly invoked after the click

_dragDrop

_dragDrop(eSource: SahiElementQueryOrWebElement, eTarget: SahiElementQueryOrWebElement): Promise<void>

- Defined in src/context/sahi/action/mouse-action/mouse-action-api.interface.ts:121
Performs a mouse down on eSource, than moves the mouse to the position of element eTarget and releases the mouse button at this position.

This implementation uses Webdriver actions which does not always behave as expected.

For a more reliable experience ThenableRegion.dragAndDropTo is recommended.

Parameters
- eSource: SahiElementQueryOrWebElement
- eTarget: SahiElementQueryOrWebElement
Returns Promise<void>

_dragDropXY

_dragDropXY(q: SahiElementQueryOrWebElement, x: number, y: number, $isRelative?: undefined | false | true): Promise<void>

- Defined in src/context/sahi/action/mouse-action/mouse-action-api.interface.ts:138
Performs a mouse down on eSource, than moves the mouse to the position P(x,y) in the browsers' viewport and releases the mouse button at this position.

This implementation uses Webdriver actions which does not always behave as expected.

For a more reliable experience ThenableRegion.dragAndDropTo is recommended.

Parameters
- q: SahiElementQueryOrWebElement
- x: number
- y: number
- Optional $isRelative: undefined | false | true
Returns Promise<void>

_mouseDown

_mouseDown(query: SahiElementQueryOrWebElement, isRight?: undefined | false | true, combo?: undefined | string): Promise<void>

- Defined in src/context/sahi/action/mouse-action/mouse-action-api.interface.ts:49
Performs a press action on the element

see

https://seleniumhq.github.io/selenium/docs/api/javascript/module/selenium-webdriver/lib/input_exports_Actions.html

Parameters
- query: SahiElementQueryOrWebElement
- Optional isRight: undefined | false | true
  
  Indicates that the right mousebutton is pressed
- Optional combo: undefined | string
  
  Any combo key: can be "CTRL", "SHIFT", "ALT" or "META"; Can also be two or more keys together like "CTRL|SHIFT"
Returns Promise<void>

_mouseOver

_mouseOver(query: SahiElementQueryOrWebElement, combo?: undefined | string): Promise<void>

- Defined in src/context/sahi/action/mouse-action/mouse-action-api.interface.ts:92
Invokes a mouse over on the queried element. Can be combined with a key combo.

Parameters
- query: SahiElementQueryOrWebElement
- Optional combo: undefined | string
  
  Optional combo key(s): can be CTRL, SHIFT, ALT or META; Can also be two or more keys together like "CTRL|SHIFT"
Returns Promise<void>

_mouseUp

_mouseUp(query: SahiElementQueryOrWebElement, isRight?: undefined | false | true, combo?: undefined | string): Promise<void>

- Defined in src/context/sahi/action/mouse-action/mouse-action-api.interface.ts:67
Performs a release action on the element. Release is the action when a user releases his finger from the mouse button.

see

https://seleniumhq.github.io/selenium/docs/api/javascript/module/selenium-webdriver/lib/input_exports_Actions.html

Parameters
- query: SahiElementQueryOrWebElement
- Optional isRight: undefined | false | true
  
  Indicates that the right mousebutton is released
- Optional combo: undefined | string
  
  Optional combo key(s): can be CTRL, SHIFT, ALT or META; Can also be two or more keys together like "CTRL|SHIFT"
Returns Promise<void>

_rightClick

_rightClick(query: SahiElementQueryOrWebElement, combo?: undefined | string): Promise<void>

- Defined in src/context/sahi/action/mouse-action/mouse-action-api.interface.ts:80
Performs a right click on the queried element. Can be combined with a key combo.

Parameters
- query: SahiElementQueryOrWebElement
- Optional combo: undefined | string
  
  Any combo key: can be "CTRL", "SHIFT", "ALT" or "META"; Can also be two or more keys together like "CTRL|SHIFT"
Returns Promise<void>

_setSelected

_setSelected(query: SahiElementQueryOrWebElement, optionToSelect: string | number | string[] | number[], isMultiple?: undefined | false | true): Promise<void>

- Defined in src/context/sahi/action/mouse-action/mouse-action-api.interface.ts:170
Sets the options within a <select> element. Selection can be done by the actual values of an option or its zero-based element index.

This action will invoke a click on the option element which means that the selected state is not enforced. If an option is already selected, it will be unselected.
example
Assume this HTML-snippet:
```
<select multiple="multiple" name="cities">
    <option value="muc">Munich</option>
    <option value="vie">Vienna</option>
    <option value="dus">Dusseldorf</option>
</select>
```
```
await _setSelected(_select('cities'), 'vie') // -> select the option Vienna
await _setSelected(_select('cities'), 0) // -> select the option Dusseldorf
```
Parameters
- query: SahiElementQueryOrWebElement
- optionToSelect: string | number | string[] | number[]
- Optional isMultiple: undefined | false | true
Returns Promise<void>

_uncheck

_uncheck(query: SahiElementQueryOrWebElement): Promise<void>

- Defined in src/context/sahi/action/mouse-action/mouse-action-api.interface.ts:109
Performs a click on a checkbox input and forces its state not to be checked

Parameters
- query: SahiElementQueryOrWebElement
Returns Promise<void>

_xy

_xy(): Promise<never>

- Defined in src/context/sahi/action/mouse-action/mouse-action-api.interface.ts:9
deprecated

throws

Error - Not implemented error

Returns Promise<never>

Hierarchy

Index

Methods

Methods

_check

Parameters

query: SahiElementQueryOrWebElement

Returns Promise<void>

_click

Parameters

query: SahiElementQueryOrWebElement

Optional combo: undefined | string | ClickOptions

Optional options: undefined | ClickOptions

Returns Promise<void>

_dragDrop

Parameters

eSource: SahiElementQueryOrWebElement

eTarget: SahiElementQueryOrWebElement

Returns Promise<void>

_dragDropXY

Parameters

q: SahiElementQueryOrWebElement

x: number

y: number

Optional $isRelative: undefined | false | true

Returns Promise<void>

_mouseDown

Parameters

query: SahiElementQueryOrWebElement

Optional isRight: undefined | false | true

Optional combo: undefined | string

Returns Promise<void>

_mouseOver

Parameters

query: SahiElementQueryOrWebElement

Optional combo: undefined | string

Returns Promise<void>

_mouseUp

Parameters

query: SahiElementQueryOrWebElement

Optional isRight: undefined | false | true

Optional combo: undefined | string

Returns Promise<void>

_rightClick

Parameters

query: SahiElementQueryOrWebElement

Optional combo: undefined | string

Returns Promise<void>

_setSelected

Parameters

query: SahiElementQueryOrWebElement

optionToSelect: string | number | string[] | number[]

Optional isMultiple: undefined | false | true

Returns Promise<void>

_uncheck

Parameters

query: SahiElementQueryOrWebElement

Returns Promise<void>

_xy

Returns Promise<never>