Module cdp::overlay

[Experimental] This domain provides various functionality related to drawing atop the inspected page.

Overlay

Commands

• Overlay.enable Experimental

  Enables domain notifications.

• Overlay.disable Experimental

  Disables domain notifications.

• Overlay.setShowPaintRects Experimental

  Requests that backend shows paint rectangles

• Overlay.setShowDebugBorders Experimental

  Requests that backend shows debug borders on layers

• Overlay.setShowFPSCounter Experimental

  Requests that backend shows the FPS counter

• Overlay.setShowScrollBottleneckRects Experimental

  Requests that backend shows scroll bottleneck rects

• Overlay.setShowViewportSizeOnResize Experimental

  Paints viewport size upon main frame resize.

• Overlay.setPausedInDebuggerMessage Experimental

• Overlay.setSuspended Experimental

• Overlay.setInspectMode Experimental

  Enters the 'inspect' mode. In this mode, elements that user is hovering over are highlighted. Backend then generates 'inspectNodeRequested' event upon element selection.

• Overlay.highlightRect Experimental

  Highlights given rectangle. Coordinates are absolute with respect to the main frame viewport.

• Overlay.highlightQuad Experimental

  Highlights given quad. Coordinates are absolute with respect to the main frame viewport.

• Overlay.highlightNode Experimental

  Highlights DOM node with given id or with the given JavaScript object wrapper. Either nodeId or objectId must be specified.

• Overlay.highlightFrame Experimental

  Highlights owner element of the frame with given id.

• Overlay.hideHighlight Experimental

  Hides any highlight.

• Overlay.getHighlightObjectForTest Experimental

  For testing.

Events

• Overlay.nodeHighlightRequested Experimental

  Fired when the node should be highlighted. This happens after call to setInspectMode.

• Overlay.inspectNodeRequested Experimental

  Fired when the node should be inspected. This happens after call to setInspectMode or when user manually inspects an element.

• Overlay.screenshotRequested Experimental

  Fired when user asks to capture screenshot of some area on the page.

Types

• HighlightConfig Experimental

  Configuration data for the highlighting of page elements.

• InspectMode Experimental

Structs

DisableCommand	[Experimental] Disables domain notifications.
DisableResponse	[Experimental] Disables domain notifications.
EnableCommand	[Experimental] Enables domain notifications.
EnableResponse	[Experimental] Enables domain notifications.
GetHighlightObjectForTestCommand	[Experimental] For testing.
GetHighlightObjectForTestResponse	[Experimental] For testing.
HideHighlightCommand	[Experimental] Hides any highlight.
HideHighlightResponse	[Experimental] Hides any highlight.
HighlightConfig	[Experimental] Configuration data for the highlighting of page elements.
HighlightFrameCommand	[Experimental] Highlights owner element of the frame with given id.
HighlightFrameResponse	[Experimental] Highlights owner element of the frame with given id.
HighlightNodeCommand	[Experimental] Highlights DOM node with given id or with the given JavaScript object wrapper. Either nodeId or objectId must be specified.
HighlightNodeResponse	[Experimental] Highlights DOM node with given id or with the given JavaScript object wrapper. Either nodeId or objectId must be specified.
HighlightQuadCommand	[Experimental] Highlights given quad. Coordinates are absolute with respect to the main frame viewport.
HighlightQuadResponse	[Experimental] Highlights given quad. Coordinates are absolute with respect to the main frame viewport.
HighlightRectCommand	[Experimental] Highlights given rectangle. Coordinates are absolute with respect to the main frame viewport.
HighlightRectResponse	[Experimental] Highlights given rectangle. Coordinates are absolute with respect to the main frame viewport.
InspectNodeRequestedEvent	[Experimental] Fired when the node should be inspected. This happens after call to setInspectMode or when user manually inspects an element.
NodeHighlightRequestedEvent	[Experimental] Fired when the node should be highlighted. This happens after call to setInspectMode.
ScreenshotRequestedEvent	[Experimental] Fired when user asks to capture screenshot of some area on the page.
SetInspectModeCommand	[Experimental] Enters the 'inspect' mode. In this mode, elements that user is hovering over are highlighted. Backend then generates 'inspectNodeRequested' event upon element selection.
SetInspectModeResponse	[Experimental] Enters the 'inspect' mode. In this mode, elements that user is hovering over are highlighted. Backend then generates 'inspectNodeRequested' event upon element selection.
SetPausedInDebuggerMessageCommand	[Experimental]
SetPausedInDebuggerMessageResponse	[Experimental]
SetShowDebugBordersCommand	[Experimental] Requests that backend shows debug borders on layers
SetShowDebugBordersResponse	[Experimental] Requests that backend shows debug borders on layers
SetShowFpsCounterCommand	[Experimental] Requests that backend shows the FPS counter
SetShowFpsCounterResponse	[Experimental] Requests that backend shows the FPS counter
SetShowPaintRectsCommand	[Experimental] Requests that backend shows paint rectangles
SetShowPaintRectsResponse	[Experimental] Requests that backend shows paint rectangles
SetShowScrollBottleneckRectsCommand	[Experimental] Requests that backend shows scroll bottleneck rects
SetShowScrollBottleneckRectsResponse	[Experimental] Requests that backend shows scroll bottleneck rects
SetShowViewportSizeOnResizeCommand	[Experimental] Paints viewport size upon main frame resize.
SetShowViewportSizeOnResizeResponse	[Experimental] Paints viewport size upon main frame resize.
SetSuspendedCommand	[Experimental]
SetSuspendedResponse	[Experimental]

Enums

InspectMode

[Experimental]