50 lines
3.3 KiB
Markdown
50 lines
3.3 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Overlay](./puppeteer.protocol.overlay.md)
|
|
|
|
## Protocol.Overlay namespace
|
|
|
|
This domain provides various functionality related to drawing atop the inspected page.
|
|
|
|
<b>Signature:</b>
|
|
|
|
```typescript
|
|
export namespace Overlay
|
|
```
|
|
|
|
## Interfaces
|
|
|
|
| Interface | Description |
|
|
| --- | --- |
|
|
| [GetHighlightObjectForTestRequest](./puppeteer.protocol.overlay.gethighlightobjectfortestrequest.md) | |
|
|
| [GetHighlightObjectForTestResponse](./puppeteer.protocol.overlay.gethighlightobjectfortestresponse.md) | |
|
|
| [GridHighlightConfig](./puppeteer.protocol.overlay.gridhighlightconfig.md) | Configuration data for the highlighting of Grid elements. |
|
|
| [HighlightConfig](./puppeteer.protocol.overlay.highlightconfig.md) | Configuration data for the highlighting of page elements. |
|
|
| [HighlightFrameRequest](./puppeteer.protocol.overlay.highlightframerequest.md) | |
|
|
| [HighlightNodeRequest](./puppeteer.protocol.overlay.highlightnoderequest.md) | |
|
|
| [HighlightQuadRequest](./puppeteer.protocol.overlay.highlightquadrequest.md) | |
|
|
| [HighlightRectRequest](./puppeteer.protocol.overlay.highlightrectrequest.md) | |
|
|
| [HingeConfig](./puppeteer.protocol.overlay.hingeconfig.md) | Configuration for dual screen hinge |
|
|
| [InspectNodeRequestedEvent](./puppeteer.protocol.overlay.inspectnoderequestedevent.md) | Fired when the node should be inspected. This happens after call to <code>setInspectMode</code> or when user manually inspects an element. |
|
|
| [NodeHighlightRequestedEvent](./puppeteer.protocol.overlay.nodehighlightrequestedevent.md) | Fired when the node should be highlighted. This happens after call to <code>setInspectMode</code>. |
|
|
| [ScreenshotRequestedEvent](./puppeteer.protocol.overlay.screenshotrequestedevent.md) | Fired when user asks to capture screenshot of some area on the page. |
|
|
| [SetInspectModeRequest](./puppeteer.protocol.overlay.setinspectmoderequest.md) | |
|
|
| [SetPausedInDebuggerMessageRequest](./puppeteer.protocol.overlay.setpausedindebuggermessagerequest.md) | |
|
|
| [SetShowAdHighlightsRequest](./puppeteer.protocol.overlay.setshowadhighlightsrequest.md) | |
|
|
| [SetShowDebugBordersRequest](./puppeteer.protocol.overlay.setshowdebugbordersrequest.md) | |
|
|
| [SetShowFPSCounterRequest](./puppeteer.protocol.overlay.setshowfpscounterrequest.md) | |
|
|
| [SetShowHingeRequest](./puppeteer.protocol.overlay.setshowhingerequest.md) | |
|
|
| [SetShowHitTestBordersRequest](./puppeteer.protocol.overlay.setshowhittestbordersrequest.md) | |
|
|
| [SetShowLayoutShiftRegionsRequest](./puppeteer.protocol.overlay.setshowlayoutshiftregionsrequest.md) | |
|
|
| [SetShowPaintRectsRequest](./puppeteer.protocol.overlay.setshowpaintrectsrequest.md) | |
|
|
| [SetShowScrollBottleneckRectsRequest](./puppeteer.protocol.overlay.setshowscrollbottleneckrectsrequest.md) | |
|
|
| [SetShowViewportSizeOnResizeRequest](./puppeteer.protocol.overlay.setshowviewportsizeonresizerequest.md) | |
|
|
|
|
## Type Aliases
|
|
|
|
| Type Alias | Description |
|
|
| --- | --- |
|
|
| [ColorFormat](./puppeteer.protocol.overlay.colorformat.md) | |
|
|
| [InspectMode](./puppeteer.protocol.overlay.inspectmode.md) | |
|
|
|