puppeteer/new-docs/puppeteer.protocol.input.dispatchmouseeventrequest.md

29 lines
2.6 KiB
Markdown
Raw Normal View History

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Protocol](./puppeteer.protocol.md) &gt; [Input](./puppeteer.protocol.input.md) &gt; [DispatchMouseEventRequest](./puppeteer.protocol.input.dispatchmouseeventrequest.md)
## Protocol.Input.DispatchMouseEventRequest interface
<b>Signature:</b>
```typescript
export interface DispatchMouseEventRequest
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [button](./puppeteer.protocol.input.dispatchmouseeventrequest.button.md) | [MouseButton](./puppeteer.protocol.input.mousebutton.md) | Mouse button (default: "none"). |
| [buttons](./puppeteer.protocol.input.dispatchmouseeventrequest.buttons.md) | [integer](./puppeteer.protocol.integer.md) | A number indicating which buttons are pressed on the mouse when a mouse event is triggered. Left=1, Right=2, Middle=4, Back=8, Forward=16, None=0. |
| [clickCount](./puppeteer.protocol.input.dispatchmouseeventrequest.clickcount.md) | [integer](./puppeteer.protocol.integer.md) | Number of times the mouse button was clicked (default: 0). |
| [deltaX](./puppeteer.protocol.input.dispatchmouseeventrequest.deltax.md) | number | X delta in CSS pixels for mouse wheel event (default: 0). |
| [deltaY](./puppeteer.protocol.input.dispatchmouseeventrequest.deltay.md) | number | Y delta in CSS pixels for mouse wheel event (default: 0). |
| [modifiers](./puppeteer.protocol.input.dispatchmouseeventrequest.modifiers.md) | [integer](./puppeteer.protocol.integer.md) | Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0). |
| [pointerType](./puppeteer.protocol.input.dispatchmouseeventrequest.pointertype.md) | ('mouse' \| 'pen') | Pointer type (default: "mouse"). |
| [timestamp](./puppeteer.protocol.input.dispatchmouseeventrequest.timestamp.md) | [TimeSinceEpoch](./puppeteer.protocol.input.timesinceepoch.md) | Time at which the event occurred. |
| [type](./puppeteer.protocol.input.dispatchmouseeventrequest.type.md) | ('mousePressed' \| 'mouseReleased' \| 'mouseMoved' \| 'mouseWheel') | Type of the mouse event. |
| [x](./puppeteer.protocol.input.dispatchmouseeventrequest.x.md) | number | X coordinate of the event relative to the main frame's viewport in CSS pixels. |
| [y](./puppeteer.protocol.input.dispatchmouseeventrequest.y.md) | number | Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to the top of the viewport and Y increases as it proceeds towards the bottom of the viewport. |