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.
fun disable(): Single<ResponseFrame>
Disables domain notifications. |
|
fun enable(): Single<ResponseFrame>
Enables domain notifications. |
|
fun events(): Flowable<Event>
Returns flowable capturing all Overlay domains events. |
|
fun getHighlightObjectForTest(input: GetHighlightObjectForTestRequest): Single<GetHighlightObjectForTestResponse>
For testing. |
|
fun hideHighlight(): Single<ResponseFrame>
Hides any highlight. |
|
fun highlightFrame(input: HighlightFrameRequest): Single<ResponseFrame>
Highlights owner element of the frame with given id. |
|
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. |
|
fun highlightQuad(input: HighlightQuadRequest): Single<ResponseFrame>
Highlights given quad. Coordinates are absolute with respect to the main frame viewport. |
|
fun highlightRect(input: HighlightRectRequest): Single<ResponseFrame>
Highlights given rectangle. Coordinates are absolute with respect to the main frame viewport. |
|
fun inspectModeCanceled(): Flowable<Event>
Fired when user cancels the inspect mode. |
|
fun inspectModeCanceledTimed(): Flowable<Timed<Event>>
Fired when user cancels the inspect mode. |
|
fun inspectNodeRequested(): Flowable<InspectNodeRequestedEvent>
Fired when the node should be inspected. This happens after call to |
|
fun inspectNodeRequestedTimed(): Flowable<Timed<InspectNodeRequestedEvent>>
Fired when the node should be inspected. This happens after call to |
|
fun nodeHighlightRequested(): Flowable<NodeHighlightRequestedEvent>
Fired when the node should be highlighted. This happens after call to |
|
fun nodeHighlightRequestedTimed(): Flowable<Timed<NodeHighlightRequestedEvent>>
Fired when the node should be highlighted. This happens after call to |
|
fun screenshotRequested(): Flowable<ScreenshotRequestedEvent>
Fired when user asks to capture screenshot of some area on the page. |
|
fun screenshotRequestedTimed(): Flowable<Timed<ScreenshotRequestedEvent>>
Fired when user asks to capture screenshot of some area on the page. |
|
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. |
|
fun setPausedInDebuggerMessage(input: SetPausedInDebuggerMessageRequest): Single<ResponseFrame> |
|
fun setShowAdHighlights(input: SetShowAdHighlightsRequest): Single<ResponseFrame>
Highlights owner element of all frames detected to be ads. |
|
fun setShowDebugBorders(input: SetShowDebugBordersRequest): Single<ResponseFrame>
Requests that backend shows debug borders on layers |
|
fun setShowFPSCounter(input: SetShowFPSCounterRequest): Single<ResponseFrame>
Requests that backend shows the FPS counter |
|
fun setShowHitTestBorders(input: SetShowHitTestBordersRequest): Single<ResponseFrame>
Requests that backend shows hit-test borders on layers |
|
fun setShowLayoutShiftRegions(input: SetShowLayoutShiftRegionsRequest): Single<ResponseFrame>
Requests that backend shows layout shift regions |
|
fun setShowPaintRects(input: SetShowPaintRectsRequest): Single<ResponseFrame>
Requests that backend shows paint rectangles |
|
fun setShowScrollBottleneckRects(input: SetShowScrollBottleneckRectsRequest): Single<ResponseFrame>
Requests that backend shows scroll bottleneck rects |
|
fun setShowViewportSizeOnResize(input: SetShowViewportSizeOnResizeRequest): Single<ResponseFrame>
Paints viewport size upon main frame resize. |