chrome-devtools-kotlin / org.hildan.chrome.devtools.domains.overlay / OverlayDomain

OverlayDomain

class OverlayDomain

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

Official doc

Functions

disable

Disables domain notifications.

suspend fun disable(): Unit

enable

Enables domain notifications.

suspend fun enable(): Unit

events

Subscribes to all events related to this domain.

fun events(): Flow<OverlayEvent>

getGridHighlightObjectsForTest

For Persistent Grid testing.

suspend fun getGridHighlightObjectsForTest(input: GetGridHighlightObjectsForTestRequest): GetGridHighlightObjectsForTestResponse

getHighlightObjectForTest

For testing.

suspend fun getHighlightObjectForTest(input: GetHighlightObjectForTestRequest): GetHighlightObjectForTestResponse

getSourceOrderHighlightObjectForTest

For Source Order Viewer testing.

suspend fun getSourceOrderHighlightObjectForTest(input: GetSourceOrderHighlightObjectForTestRequest): GetSourceOrderHighlightObjectForTestResponse

hideHighlight

Hides any highlight.

suspend fun hideHighlight(): Unit

highlightFrame

Highlights owner element of the frame with given id.

suspend fun highlightFrame(input: HighlightFrameRequest): Unit

highlightNode

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

suspend fun highlightNode(input: HighlightNodeRequest): Unit

highlightQuad

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

suspend fun highlightQuad(input: HighlightQuadRequest): Unit

highlightRect

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

suspend fun highlightRect(input: HighlightRectRequest): Unit

highlightSourceOrder

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.

suspend fun highlightSourceOrder(input: HighlightSourceOrderRequest): Unit

inspectModeCanceled

Fired when user cancels the inspect mode.

fun inspectModeCanceled(): Flow<InspectModeCanceledEvent>

inspectNodeRequested

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

fun inspectNodeRequested(): Flow<InspectNodeRequestedEvent>

nodeHighlightRequested

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

fun nodeHighlightRequested(): Flow<NodeHighlightRequestedEvent>

screenshotRequested

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

fun screenshotRequested(): Flow<ScreenshotRequestedEvent>

setInspectMode

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

suspend fun setInspectMode(input: SetInspectModeRequest): Unit

setPausedInDebuggerMessage

Official doc

suspend fun setPausedInDebuggerMessage(input: SetPausedInDebuggerMessageRequest): Unit

setShowAdHighlights

Highlights owner element of all frames detected to be ads.

suspend fun setShowAdHighlights(input: SetShowAdHighlightsRequest): Unit

setShowDebugBorders

Requests that backend shows debug borders on layers

suspend fun setShowDebugBorders(input: SetShowDebugBordersRequest): Unit

setShowFlexOverlays

Official doc

suspend fun setShowFlexOverlays(input: SetShowFlexOverlaysRequest): Unit

setShowFPSCounter

Requests that backend shows the FPS counter

suspend fun setShowFPSCounter(input: SetShowFPSCounterRequest): Unit

setShowGridOverlays

Highlight multiple elements with the CSS Grid overlay.

suspend fun setShowGridOverlays(input: SetShowGridOverlaysRequest): Unit

setShowHinge

Add a dual screen device hinge

suspend fun setShowHinge(input: SetShowHingeRequest): Unit

setShowHitTestBorders

Requests that backend shows hit-test borders on layers

suspend fun setShowHitTestBorders(input: SetShowHitTestBordersRequest): Unit

setShowLayoutShiftRegions

Requests that backend shows layout shift regions

suspend fun setShowLayoutShiftRegions(input: SetShowLayoutShiftRegionsRequest): Unit

setShowPaintRects

Requests that backend shows paint rectangles

suspend fun setShowPaintRects(input: SetShowPaintRectsRequest): Unit

setShowScrollBottleneckRects

Requests that backend shows scroll bottleneck rects

suspend fun setShowScrollBottleneckRects(input: SetShowScrollBottleneckRectsRequest): Unit

setShowViewportSizeOnResize

Paints viewport size upon main frame resize.

suspend fun setShowViewportSizeOnResize(input: SetShowViewportSizeOnResizeRequest): Unit