-
public final class OverlayDomainThis domain provides various functionality related to drawing atop the inspected page.
-
-
Method Summary
Modifier and Type Method Description final Flow<OverlayEvent>events()Subscribes to all events related to this domain. final Flow<OverlayEvent.InspectNodeRequestedEvent>inspectNodeRequested()Fired when the node should be inspected. final Flow<OverlayEvent.NodeHighlightRequestedEvent>nodeHighlightRequested()Fired when the node should be highlighted. final Flow<OverlayEvent.ScreenshotRequestedEvent>screenshotRequested()Fired when user asks to capture screenshot of some area on the page. final Flow<OverlayEvent.InspectModeCanceledEvent>inspectModeCanceled()Fired when user cancels the inspect mode. final Unitdisable()Disables domain notifications. final Unitenable()Enables domain notifications. final GetHighlightObjectForTestResponsegetHighlightObjectForTest(GetHighlightObjectForTestRequest input)For testing. final GetGridHighlightObjectsForTestResponsegetGridHighlightObjectsForTest(GetGridHighlightObjectsForTestRequest input)For Persistent Grid testing. final GetSourceOrderHighlightObjectForTestResponsegetSourceOrderHighlightObjectForTest(GetSourceOrderHighlightObjectForTestRequest input)For Source Order Viewer testing. final UnithideHighlight()Hides any highlight. final UnithighlightFrame(HighlightFrameRequest input)Highlights owner element of the frame with given id. final UnithighlightNode(HighlightNodeRequest input)Highlights DOM node with given id or with the given JavaScript object wrapper. final UnithighlightQuad(HighlightQuadRequest input)Highlights given quad. final UnithighlightRect(HighlightRectRequest input)Highlights given rectangle. final UnithighlightSourceOrder(HighlightSourceOrderRequest input)Highlights the source order of the children of the DOM node with given id or with the given JavaScript object wrapper. final UnitsetInspectMode(SetInspectModeRequest input)Enters the 'inspect' mode. final UnitsetShowAdHighlights(SetShowAdHighlightsRequest input)Highlights owner element of all frames detected to be ads. final UnitsetPausedInDebuggerMessage(SetPausedInDebuggerMessageRequest input)Official doc final UnitsetShowDebugBorders(SetShowDebugBordersRequest input)Requests that backend shows debug borders on layersOfficial doc final UnitsetShowFPSCounter(SetShowFPSCounterRequest input)Requests that backend shows the FPS counterOfficial doc final UnitsetShowGridOverlays(SetShowGridOverlaysRequest input)Highlight multiple elements with the CSS Grid overlay. final UnitsetShowFlexOverlays(SetShowFlexOverlaysRequest input)Official doc final UnitsetShowPaintRects(SetShowPaintRectsRequest input)Requests that backend shows paint rectanglesOfficial doc final UnitsetShowLayoutShiftRegions(SetShowLayoutShiftRegionsRequest input)Requests that backend shows layout shift regionsOfficial doc final UnitsetShowScrollBottleneckRects(SetShowScrollBottleneckRectsRequest input)Requests that backend shows scroll bottleneck rectsOfficial doc final UnitsetShowHitTestBorders(SetShowHitTestBordersRequest input)Requests that backend shows hit-test borders on layersOfficial doc final UnitsetShowWebVitals(SetShowWebVitalsRequest input)Request that backend shows an overlay with web vital metrics. final UnitsetShowViewportSizeOnResize(SetShowViewportSizeOnResizeRequest input)Paints viewport size upon main frame resize. final UnitsetShowHinge(SetShowHingeRequest input)Add a dual screen device hingeOfficial doc -
-
Method Detail
-
events
final Flow<OverlayEvent> events()
Subscribes to all events related to this domain.
-
inspectNodeRequested
final Flow<OverlayEvent.InspectNodeRequestedEvent> inspectNodeRequested()
Fired when the node should be inspected. This happens after call to
setInspectModeor when user manually inspects an element.
-
nodeHighlightRequested
final Flow<OverlayEvent.NodeHighlightRequestedEvent> nodeHighlightRequested()
Fired when the node should be highlighted. This happens after call to
setInspectMode.
-
screenshotRequested
final Flow<OverlayEvent.ScreenshotRequestedEvent> screenshotRequested()
Fired when user asks to capture screenshot of some area on the page.
-
inspectModeCanceled
final Flow<OverlayEvent.InspectModeCanceledEvent> inspectModeCanceled()
Fired when user cancels the inspect mode.
-
getHighlightObjectForTest
final GetHighlightObjectForTestResponse getHighlightObjectForTest(GetHighlightObjectForTestRequest input)
For testing.
-
getGridHighlightObjectsForTest
final GetGridHighlightObjectsForTestResponse getGridHighlightObjectsForTest(GetGridHighlightObjectsForTestRequest input)
For Persistent Grid testing.
-
getSourceOrderHighlightObjectForTest
final GetSourceOrderHighlightObjectForTestResponse getSourceOrderHighlightObjectForTest(GetSourceOrderHighlightObjectForTestRequest input)
For Source Order Viewer testing.
-
hideHighlight
final Unit hideHighlight()
Hides any highlight.
-
highlightFrame
final Unit highlightFrame(HighlightFrameRequest input)
Highlights owner element of the frame with given id.
-
highlightNode
final Unit highlightNode(HighlightNodeRequest input)
Highlights DOM node with given id or with the given JavaScript object wrapper. Either nodeId or objectId must be specified.
-
highlightQuad
final Unit highlightQuad(HighlightQuadRequest input)
Highlights given quad. Coordinates are absolute with respect to the main frame viewport.
-
highlightRect
final Unit highlightRect(HighlightRectRequest input)
Highlights given rectangle. Coordinates are absolute with respect to the main frame viewport.
-
highlightSourceOrder
final Unit highlightSourceOrder(HighlightSourceOrderRequest input)
Highlights the source order of the children of the DOM node with given id or with the given JavaScript object wrapper. Either nodeId or objectId must be specified.
-
setInspectMode
final Unit setInspectMode(SetInspectModeRequest input)
Enters the 'inspect' mode. In this mode, elements that user is hovering over are highlighted. Backend then generates 'inspectNodeRequested' event upon element selection.
-
setShowAdHighlights
final Unit setShowAdHighlights(SetShowAdHighlightsRequest input)
Highlights owner element of all frames detected to be ads.
-
setPausedInDebuggerMessage
final Unit setPausedInDebuggerMessage(SetPausedInDebuggerMessageRequest input)
-
setShowDebugBorders
final Unit setShowDebugBorders(SetShowDebugBordersRequest input)
Requests that backend shows debug borders on layers
-
setShowFPSCounter
final Unit setShowFPSCounter(SetShowFPSCounterRequest input)
Requests that backend shows the FPS counter
-
setShowGridOverlays
final Unit setShowGridOverlays(SetShowGridOverlaysRequest input)
Highlight multiple elements with the CSS Grid overlay.
-
setShowFlexOverlays
final Unit setShowFlexOverlays(SetShowFlexOverlaysRequest input)
-
setShowPaintRects
final Unit setShowPaintRects(SetShowPaintRectsRequest input)
Requests that backend shows paint rectangles
-
setShowLayoutShiftRegions
final Unit setShowLayoutShiftRegions(SetShowLayoutShiftRegionsRequest input)
Requests that backend shows layout shift regions
-
setShowScrollBottleneckRects
final Unit setShowScrollBottleneckRects(SetShowScrollBottleneckRectsRequest input)
Requests that backend shows scroll bottleneck rects
-
setShowHitTestBorders
final Unit setShowHitTestBorders(SetShowHitTestBordersRequest input)
Requests that backend shows hit-test borders on layers
-
setShowWebVitals
final Unit setShowWebVitals(SetShowWebVitalsRequest input)
Request that backend shows an overlay with web vital metrics.
-
setShowViewportSizeOnResize
final Unit setShowViewportSizeOnResize(SetShowViewportSizeOnResizeRequest input)
Paints viewport size upon main frame resize.
-
setShowHinge
final Unit setShowHinge(SetShowHingeRequest input)
Add a dual screen device hinge
-
-
-
-