chromiumoxide::cdp::browser_protocol

Module overlay

Source
Expand description

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

Structs§

BoxStyle
Style information for drawing a box. BoxStyle
BoxStyleBuilder
ContainerQueryContainerHighlightConfig
ContainerQueryContainerHighlightConfigBuilder
ContainerQueryHighlightConfig
ContainerQueryHighlightConfigBuilder
DisableParams
Disables domain notifications. disable
DisableReturns
Disables domain notifications. disable
EnableParams
Enables domain notifications. enable
EnableReturns
Enables domain notifications. enable
EventInspectModeCanceled
Fired when user cancels the inspect mode. inspectModeCanceled
EventInspectNodeRequested
Fired when the node should be inspected. This happens after call to setInspectMode or when user manually inspects an element. inspectNodeRequested
EventNodeHighlightRequested
Fired when the node should be highlighted. This happens after call to setInspectMode. nodeHighlightRequested
EventScreenshotRequested
Fired when user asks to capture screenshot of some area on the page. screenshotRequested
FlexContainerHighlightConfig
Configuration data for the highlighting of Flex container elements. FlexContainerHighlightConfig
FlexContainerHighlightConfigBuilder
FlexItemHighlightConfig
Configuration data for the highlighting of Flex item elements. FlexItemHighlightConfig
FlexItemHighlightConfigBuilder
FlexNodeHighlightConfig
FlexNodeHighlightConfigBuilder
GetGridHighlightObjectsForTestParams
For Persistent Grid testing. getGridHighlightObjectsForTest
GetGridHighlightObjectsForTestParamsBuilder
GetGridHighlightObjectsForTestReturns
For Persistent Grid testing. getGridHighlightObjectsForTest
GetGridHighlightObjectsForTestReturnsBuilder
GetHighlightObjectForTestParams
For testing. getHighlightObjectForTest
GetHighlightObjectForTestParamsBuilder
GetHighlightObjectForTestReturns
For testing. getHighlightObjectForTest
GetHighlightObjectForTestReturnsBuilder
GetSourceOrderHighlightObjectForTestParams
For Source Order Viewer testing. getSourceOrderHighlightObjectForTest
GetSourceOrderHighlightObjectForTestParamsBuilder
GetSourceOrderHighlightObjectForTestReturns
For Source Order Viewer testing. getSourceOrderHighlightObjectForTest
GetSourceOrderHighlightObjectForTestReturnsBuilder
GridHighlightConfig
Configuration data for the highlighting of Grid elements. GridHighlightConfig
GridHighlightConfigBuilder
GridNodeHighlightConfig
Configurations for Persistent Grid Highlight GridNodeHighlightConfig
GridNodeHighlightConfigBuilder
HideHighlightParams
Hides any highlight. hideHighlight
HideHighlightReturns
Hides any highlight. hideHighlight
HighlightConfig
Configuration data for the highlighting of page elements. HighlightConfig
HighlightConfigBuilder
HighlightNodeParams
Highlights DOM node with given id or with the given JavaScript object wrapper. Either nodeId or objectId must be specified. highlightNode
HighlightNodeParamsBuilder
HighlightNodeReturns
Highlights DOM node with given id or with the given JavaScript object wrapper. Either nodeId or objectId must be specified. highlightNode
HighlightQuadParams
Highlights given quad. Coordinates are absolute with respect to the main frame viewport. highlightQuad
HighlightQuadParamsBuilder
HighlightQuadReturns
Highlights given quad. Coordinates are absolute with respect to the main frame viewport. highlightQuad
HighlightRectParams
Highlights given rectangle. Coordinates are absolute with respect to the main frame viewport. highlightRect
HighlightRectParamsBuilder
HighlightRectReturns
Highlights given rectangle. Coordinates are absolute with respect to the main frame viewport. highlightRect
HighlightSourceOrderParams
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. highlightSourceOrder
HighlightSourceOrderParamsBuilder
HighlightSourceOrderReturns
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. highlightSourceOrder
HingeConfig
Configuration for dual screen hinge HingeConfig
HingeConfigBuilder
IsolatedElementHighlightConfig
IsolatedElementHighlightConfigBuilder
IsolationModeHighlightConfig
IsolationModeHighlightConfigBuilder
LineStyle
Style information for drawing a line. LineStyle
LineStyleBuilder
ScrollSnapContainerHighlightConfig
ScrollSnapContainerHighlightConfigBuilder
ScrollSnapHighlightConfig
ScrollSnapHighlightConfigBuilder
SetInspectModeParams
Enters the ‘inspect’ mode. In this mode, elements that user is hovering over are highlighted. Backend then generates ‘inspectNodeRequested’ event upon element selection. setInspectMode
SetInspectModeParamsBuilder
SetInspectModeReturns
Enters the ‘inspect’ mode. In this mode, elements that user is hovering over are highlighted. Backend then generates ‘inspectNodeRequested’ event upon element selection. setInspectMode
SetPausedInDebuggerMessageParams
SetPausedInDebuggerMessageParamsBuilder
SetPausedInDebuggerMessageReturns
SetShowAdHighlightsParams
Highlights owner element of all frames detected to be ads. setShowAdHighlights
SetShowAdHighlightsParamsBuilder
SetShowAdHighlightsReturns
Highlights owner element of all frames detected to be ads. setShowAdHighlights
SetShowContainerQueryOverlaysParams
SetShowContainerQueryOverlaysParamsBuilder
SetShowContainerQueryOverlaysReturns
SetShowDebugBordersParams
Requests that backend shows debug borders on layers setShowDebugBorders
SetShowDebugBordersParamsBuilder
SetShowDebugBordersReturns
Requests that backend shows debug borders on layers setShowDebugBorders
SetShowFlexOverlaysParams
SetShowFlexOverlaysParamsBuilder
SetShowFlexOverlaysReturns
SetShowFpsCounterParams
Requests that backend shows the FPS counter setShowFPSCounter
SetShowFpsCounterParamsBuilder
SetShowFpsCounterReturns
Requests that backend shows the FPS counter setShowFPSCounter
SetShowGridOverlaysParams
Highlight multiple elements with the CSS Grid overlay. setShowGridOverlays
SetShowGridOverlaysParamsBuilder
SetShowGridOverlaysReturns
Highlight multiple elements with the CSS Grid overlay. setShowGridOverlays
SetShowHingeParams
Add a dual screen device hinge setShowHinge
SetShowHingeParamsBuilder
SetShowHingeReturns
Add a dual screen device hinge setShowHinge
SetShowIsolatedElementsParams
Show elements in isolation mode with overlays. setShowIsolatedElements
SetShowIsolatedElementsParamsBuilder
SetShowIsolatedElementsReturns
Show elements in isolation mode with overlays. setShowIsolatedElements
SetShowLayoutShiftRegionsParams
Requests that backend shows layout shift regions setShowLayoutShiftRegions
SetShowLayoutShiftRegionsParamsBuilder
SetShowLayoutShiftRegionsReturns
Requests that backend shows layout shift regions setShowLayoutShiftRegions
SetShowPaintRectsParams
Requests that backend shows paint rectangles setShowPaintRects
SetShowPaintRectsParamsBuilder
SetShowPaintRectsReturns
Requests that backend shows paint rectangles setShowPaintRects
SetShowScrollBottleneckRectsParams
Requests that backend shows scroll bottleneck rects setShowScrollBottleneckRects
SetShowScrollBottleneckRectsParamsBuilder
SetShowScrollBottleneckRectsReturns
Requests that backend shows scroll bottleneck rects setShowScrollBottleneckRects
SetShowScrollSnapOverlaysParams
SetShowScrollSnapOverlaysParamsBuilder
SetShowScrollSnapOverlaysReturns
SetShowViewportSizeOnResizeParams
Paints viewport size upon main frame resize. setShowViewportSizeOnResize
SetShowViewportSizeOnResizeParamsBuilder
SetShowViewportSizeOnResizeReturns
Paints viewport size upon main frame resize. setShowViewportSizeOnResize
SetShowWebVitalsParams
Request that backend shows an overlay with web vital metrics. setShowWebVitals
SetShowWebVitalsParamsBuilder
SetShowWebVitalsReturns
Request that backend shows an overlay with web vital metrics. setShowWebVitals
SetShowWindowControlsOverlayParams
Show Window Controls Overlay for PWA setShowWindowControlsOverlay
SetShowWindowControlsOverlayParamsBuilder
SetShowWindowControlsOverlayReturns
Show Window Controls Overlay for PWA setShowWindowControlsOverlay
SourceOrderConfig
Configuration data for drawing the source order of an elements children. SourceOrderConfig
SourceOrderConfigBuilder
WindowControlsOverlayConfig
Configuration for Window Controls Overlay WindowControlsOverlayConfig
WindowControlsOverlayConfigBuilder

Enums§

ColorFormat
ContrastAlgorithm
InspectMode
LineStylePattern
The line pattern (default: solid)