github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
96f3d439f5
puppeteer/new-docs/puppeteer.protocol.overlay.md

58 lines
4.2 KiB
Markdown
Raw Normal View History

chore: generate docs for the protocol (#6213)
2020-07-13 13:01:35 +00:00
<!-- 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; [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 |
| --- | --- |
feat(chromium): roll Chromium to r800071 (#6407) * roll Chromium to version 86, r800071 * roll Chrome DevTools protocol version to 0.0.799653 * fix HTTPRequest.continue after * CDP: accept post data in the binary form in Fetch.continueRequest. https://chromium-review.googlesource.com/c/chromium/src/+/2315239 * update new-docs
2020-09-09 19:23:46 +00:00
| [GetGridHighlightObjectsForTestRequest](./puppeteer.protocol.overlay.getgridhighlightobjectsfortestrequest.md) | |
| [GetGridHighlightObjectsForTestResponse](./puppeteer.protocol.overlay.getgridhighlightobjectsfortestresponse.md) | |
chore: generate docs for the protocol (#6213)
2020-07-13 13:01:35 +00:00
| [GetHighlightObjectForTestRequest](./puppeteer.protocol.overlay.gethighlightobjectfortestrequest.md) | |
| [GetHighlightObjectForTestResponse](./puppeteer.protocol.overlay.gethighlightobjectfortestresponse.md) | |
feat(chromium): roll Chromium to r800071 (#6407) * roll Chromium to version 86, r800071 * roll Chrome DevTools protocol version to 0.0.799653 * fix HTTPRequest.continue after * CDP: accept post data in the binary form in Fetch.continueRequest. https://chromium-review.googlesource.com/c/chromium/src/+/2315239 * update new-docs
2020-09-09 19:23:46 +00:00
| [GetSourceOrderHighlightObjectForTestRequest](./puppeteer.protocol.overlay.getsourceorderhighlightobjectfortestrequest.md) | |
| [GetSourceOrderHighlightObjectForTestResponse](./puppeteer.protocol.overlay.getsourceorderhighlightobjectfortestresponse.md) | |
chore: generate docs for the protocol (#6213)
2020-07-13 13:01:35 +00:00
| [GridHighlightConfig](./puppeteer.protocol.overlay.gridhighlightconfig.md) | Configuration data for the highlighting of Grid elements. |
feat(chromium): roll Chromium to r800071 (#6407) * roll Chromium to version 86, r800071 * roll Chrome DevTools protocol version to 0.0.799653 * fix HTTPRequest.continue after * CDP: accept post data in the binary form in Fetch.continueRequest. https://chromium-review.googlesource.com/c/chromium/src/+/2315239 * update new-docs
2020-09-09 19:23:46 +00:00
| [GridNodeHighlightConfig](./puppeteer.protocol.overlay.gridnodehighlightconfig.md) | Configurations for Persistent Grid Highlight |
chore: generate docs for the protocol (#6213)
2020-07-13 13:01:35 +00:00
| [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) | |
feat(chromium): roll Chromium to r800071 (#6407) * roll Chromium to version 86, r800071 * roll Chrome DevTools protocol version to 0.0.799653 * fix HTTPRequest.continue after * CDP: accept post data in the binary form in Fetch.continueRequest. https://chromium-review.googlesource.com/c/chromium/src/+/2315239 * update new-docs
2020-09-09 19:23:46 +00:00
| [HighlightSourceOrderRequest](./puppeteer.protocol.overlay.highlightsourceorderrequest.md) | |
chore: generate docs for the protocol (#6213)
2020-07-13 13:01:35 +00:00
| [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) | |
feat(chromium): roll Chromium to r800071 (#6407) * roll Chromium to version 86, r800071 * roll Chrome DevTools protocol version to 0.0.799653 * fix HTTPRequest.continue after * CDP: accept post data in the binary form in Fetch.continueRequest. https://chromium-review.googlesource.com/c/chromium/src/+/2315239 * update new-docs
2020-09-09 19:23:46 +00:00
| [SetShowGridOverlaysRequest](./puppeteer.protocol.overlay.setshowgridoverlaysrequest.md) | |
chore: generate docs for the protocol (#6213)
2020-07-13 13:01:35 +00:00
| [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) | |
feat(chromium): roll Chromium to r800071 (#6407) * roll Chromium to version 86, r800071 * roll Chrome DevTools protocol version to 0.0.799653 * fix HTTPRequest.continue after * CDP: accept post data in the binary form in Fetch.continueRequest. https://chromium-review.googlesource.com/c/chromium/src/+/2315239 * update new-docs
2020-09-09 19:23:46 +00:00
| [SourceOrderConfig](./puppeteer.protocol.overlay.sourceorderconfig.md) | Configuration data for drawing the source order of an elements children. |
chore: generate docs for the protocol (#6213)
2020-07-13 13:01:35 +00:00
## Type Aliases
| Type Alias | Description |
| --- | --- |
| [ColorFormat](./puppeteer.protocol.overlay.colorformat.md) | |
| [InspectMode](./puppeteer.protocol.overlay.inspectmode.md) | |
Reference in New Issue Copy Permalink