pl.wendigo.chrome.api.overlay / OverlayOperations

OverlayOperations

class OverlayOperations (source)

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

This API is marked as experimental in protocol definition and can change in the future.

Link
Protocol Overlay domain documentation.

Functions

disable	`fun disable(): Single<ResponseFrame>` Disables domain notifications.
enable	`fun enable(): Single<ResponseFrame>` Enables domain notifications.
events	`fun events(): Flowable<Event>` Returns flowable capturing all Overlay domains events.
getHighlightObjectForTest	`fun getHighlightObjectForTest(input: GetHighlightObjectForTestRequest): Single<GetHighlightObjectForTestResponse>` For testing.
hideHighlight	`fun hideHighlight(): Single<ResponseFrame>` Hides any highlight.
highlightFrame	`fun highlightFrame(input: HighlightFrameRequest): Single<ResponseFrame>` Highlights owner element of the frame with given id.
highlightNode	`fun highlightNode(input: HighlightNodeRequest): Single<ResponseFrame>` Highlights DOM node with given id or with the given JavaScript object wrapper. Either nodeId or objectId must be specified.
highlightQuad	`fun highlightQuad(input: HighlightQuadRequest): Single<ResponseFrame>` Highlights given quad. Coordinates are absolute with respect to the main frame viewport.
highlightRect	`fun highlightRect(input: HighlightRectRequest): Single<ResponseFrame>` Highlights given rectangle. Coordinates are absolute with respect to the main frame viewport.
inspectModeCanceled	`fun inspectModeCanceled(): Flowable<Event>` Fired when user cancels the inspect mode.
inspectNodeRequested	`fun inspectNodeRequested(): Flowable<InspectNodeRequestedEvent>` Fired when the node should be inspected. This happens after call to `setInspectMode` or when user manually inspects an element.
nodeHighlightRequested	`fun nodeHighlightRequested(): Flowable<NodeHighlightRequestedEvent>` Fired when the node should be highlighted. This happens after call to `setInspectMode`.
screenshotRequested	`fun screenshotRequested(): Flowable<ScreenshotRequestedEvent>` Fired when user asks to capture screenshot of some area on the page.
setInspectMode	`fun setInspectMode(input: SetInspectModeRequest): Single<ResponseFrame>` Enters the 'inspect' mode. In this mode, elements that user is hovering over are highlighted. Backend then generates 'inspectNodeRequested' event upon element selection.
setPausedInDebuggerMessage	`fun setPausedInDebuggerMessage(input: SetPausedInDebuggerMessageRequest): Single<ResponseFrame>`
setShowAdHighlights	`fun setShowAdHighlights(input: SetShowAdHighlightsRequest): Single<ResponseFrame>` Highlights owner element of all frames detected to be ads.
setShowDebugBorders	`fun setShowDebugBorders(input: SetShowDebugBordersRequest): Single<ResponseFrame>` Requests that backend shows debug borders on layers
setShowFPSCounter	`fun setShowFPSCounter(input: SetShowFPSCounterRequest): Single<ResponseFrame>` Requests that backend shows the FPS counter
setShowHitTestBorders	`fun setShowHitTestBorders(input: SetShowHitTestBordersRequest): Single<ResponseFrame>` Requests that backend shows hit-test borders on layers
setShowLayoutShiftRegions	`fun setShowLayoutShiftRegions(input: SetShowLayoutShiftRegionsRequest): Single<ResponseFrame>` Requests that backend shows layout shift regions
setShowPaintRects	`fun setShowPaintRects(input: SetShowPaintRectsRequest): Single<ResponseFrame>` Requests that backend shows paint rectangles
setShowScrollBottleneckRects	`fun setShowScrollBottleneckRects(input: SetShowScrollBottleneckRectsRequest): Single<ResponseFrame>` Requests that backend shows scroll bottleneck rects
setShowViewportSizeOnResize	`fun setShowViewportSizeOnResize(input: SetShowViewportSizeOnResizeRequest): Single<ResponseFrame>` Paints viewport size upon main frame resize.