data class FlexContainerHighlightConfig(val containerBorder: Overlay.LineStyle? = null, val lineSeparator: Overlay.LineStyle? = null, val itemSeparator: Overlay.LineStyle? = null, val mainDistributedSpace: Overlay.BoxStyle? = null, val crossDistributedSpace: Overlay.BoxStyle? = null, val rowGapSpace: Overlay.BoxStyle? = null, val columnGapSpace: Overlay.BoxStyle? = null, val crossAlignment: Overlay.LineStyle? = null)

Configuration data for the highlighting of Flex container elements.

FlexItemHighlightConfig

@Serializable

data class FlexItemHighlightConfig(val baseSizeBox: Overlay.BoxStyle? = null, val baseSizeBorder: Overlay.LineStyle? = null, val flexibilityArrow: Overlay.LineStyle? = null)

Configuration data for the highlighting of Flex item elements.

FlexNodeHighlightConfig

@Serializable

data class FlexNodeHighlightConfig(val flexContainerHighlightConfig: Overlay.FlexContainerHighlightConfig, val nodeId: Int)

GetGridHighlightObjectsForTestParameter

@Serializable

data class GetGridHighlightObjectsForTestParameter(val nodeIds: List<Int>)

GetGridHighlightObjectsForTestReturn

@Serializable

data class GetGridHighlightObjectsForTestReturn(val highlights: Map<String, JsonElement>)

GetHighlightObjectForTestParameter

@Serializable

data class GetHighlightObjectForTestParameter(val nodeId: Int, val includeDistance: Boolean? = null, val includeStyle: Boolean? = null, val colorFormat: Overlay.ColorFormat? = null, val showAccessibilityInfo: Boolean? = null)

GetHighlightObjectForTestReturn

@Serializable

data class GetHighlightObjectForTestReturn(val highlight: Map<String, JsonElement>)

GetSourceOrderHighlightObjectForTestParameter

@Serializable

data class GetSourceOrderHighlightObjectForTestParameter(val nodeId: Int)

GetSourceOrderHighlightObjectForTestReturn

@Serializable

data class GetSourceOrderHighlightObjectForTestReturn(val highlight: Map<String, JsonElement>)

GridHighlightConfig

@Serializable

data class GridHighlightConfig(val showGridExtensionLines: Boolean? = null, val showPositiveLineNumbers: Boolean? = null, val showNegativeLineNumbers: Boolean? = null, val showAreaNames: Boolean? = null, val showLineNames: Boolean? = null, val showTrackSizes: Boolean? = null, val gridBorderColor: DOM.RGBA? = null, val cellBorderColor: DOM.RGBA? = null, val rowLineColor: DOM.RGBA? = null, val columnLineColor: DOM.RGBA? = null, val gridBorderDash: Boolean? = null, val cellBorderDash: Boolean? = null, val rowLineDash: Boolean? = null, val columnLineDash: Boolean? = null, val rowGapColor: DOM.RGBA? = null, val rowHatchColor: DOM.RGBA? = null, val columnGapColor: DOM.RGBA? = null, val columnHatchColor: DOM.RGBA? = null, val areaBorderColor: DOM.RGBA? = null, val gridBackgroundColor: DOM.RGBA? = null)

Configuration data for the highlighting of Grid elements.

GridNodeHighlightConfig

@Serializable

data class GridNodeHighlightConfig(val gridHighlightConfig: Overlay.GridHighlightConfig, val nodeId: Int)

Configurations for Persistent Grid Highlight

HighlightConfig

@Serializable

data class HighlightConfig(val showInfo: Boolean? = null, val showStyles: Boolean? = null, val showRulers: Boolean? = null, val showAccessibilityInfo: Boolean? = null, val showExtensionLines: Boolean? = null, val contentColor: DOM.RGBA? = null, val paddingColor: DOM.RGBA? = null, val borderColor: DOM.RGBA? = null, val marginColor: DOM.RGBA? = null, val eventTargetColor: DOM.RGBA? = null, val shapeColor: DOM.RGBA? = null, val shapeMarginColor: DOM.RGBA? = null, val cssGridColor: DOM.RGBA? = null, val colorFormat: Overlay.ColorFormat? = null, val gridHighlightConfig: Overlay.GridHighlightConfig? = null, val flexContainerHighlightConfig: Overlay.FlexContainerHighlightConfig? = null, val flexItemHighlightConfig: Overlay.FlexItemHighlightConfig? = null, val contrastAlgorithm: Overlay.ContrastAlgorithm? = null, val containerQueryContainerHighlightConfig: Overlay.ContainerQueryContainerHighlightConfig? = null)

Configuration data for the highlighting of page elements.

HighlightFrameParameter

@Serializable

data class HighlightFrameParameter(val frameId: String, val contentColor: DOM.RGBA? = null, val contentOutlineColor: DOM.RGBA? = null)

HighlightNodeParameter

@Serializable

data class HighlightNodeParameter(val highlightConfig: Overlay.HighlightConfig, val nodeId: Int? = null, val backendNodeId: Int? = null, val objectId: String? = null, val selector: String? = null)

HighlightQuadParameter

@Serializable

data class HighlightQuadParameter(val quad: List<Double>, val color: DOM.RGBA? = null, val outlineColor: DOM.RGBA? = null)

HighlightRectParameter

@Serializable

data class HighlightRectParameter(val x: Int, val y: Int, val width: Int, val height: Int, val color: DOM.RGBA? = null, val outlineColor: DOM.RGBA? = null)

HighlightSourceOrderParameter

@Serializable

data class HighlightSourceOrderParameter(val sourceOrderConfig: Overlay.SourceOrderConfig, val nodeId: Int? = null, val backendNodeId: Int? = null, val objectId: String? = null)

HingeConfig

@Serializable

data class HingeConfig(val rect: DOM.Rect, val contentColor: DOM.RGBA? = null, val outlineColor: DOM.RGBA? = null)

Configuration for dual screen hinge

InspectMode

@Serializable

enum InspectMode : Enum<Overlay.InspectMode>

InspectNodeRequestedParameter

@Serializable

data class InspectNodeRequestedParameter(val backendNodeId: Int)

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

IsolatedElementHighlightConfig

@Serializable

data class IsolatedElementHighlightConfig(val isolationModeHighlightConfig: Overlay.IsolationModeHighlightConfig, val nodeId: Int)

IsolationModeHighlightConfig

@Serializable

data class IsolationModeHighlightConfig(val resizerColor: DOM.RGBA? = null, val resizerHandleColor: DOM.RGBA? = null, val maskColor: DOM.RGBA? = null)

LineStyle

@Serializable

data class LineStyle(val color: DOM.RGBA? = null, val pattern: String? = null)

Style information for drawing a line.

NodeHighlightRequestedParameter

@Serializable

data class NodeHighlightRequestedParameter(val nodeId: Int)

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

ScreenshotRequestedParameter

@Serializable

data class ScreenshotRequestedParameter(val viewport: Page.Viewport)

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

ScrollSnapContainerHighlightConfig

@Serializable

data class ScrollSnapContainerHighlightConfig(val snapportBorder: Overlay.LineStyle? = null, val snapAreaBorder: Overlay.LineStyle? = null, val scrollMarginColor: DOM.RGBA? = null, val scrollPaddingColor: DOM.RGBA? = null)

ScrollSnapHighlightConfig

@Serializable

data class ScrollSnapHighlightConfig(val scrollSnapContainerHighlightConfig: Overlay.ScrollSnapContainerHighlightConfig, val nodeId: Int)

SetInspectModeParameter

@Serializable

data class SetInspectModeParameter(val mode: Overlay.InspectMode, val highlightConfig: Overlay.HighlightConfig? = null)

SetPausedInDebuggerMessageParameter

@Serializable

data class SetPausedInDebuggerMessageParameter(val message: String? = null)

SetShowAdHighlightsParameter

@Serializable

data class SetShowAdHighlightsParameter(val show: Boolean)

SetShowContainerQueryOverlaysParameter

@Serializable

data class SetShowContainerQueryOverlaysParameter(val containerQueryHighlightConfigs: List<Overlay.ContainerQueryHighlightConfig>)

SetShowDebugBordersParameter

@Serializable

data class SetShowDebugBordersParameter(val show: Boolean)

SetShowFlexOverlaysParameter

@Serializable

data class SetShowFlexOverlaysParameter(val flexNodeHighlightConfigs: List<Overlay.FlexNodeHighlightConfig>)

SetShowFPSCounterParameter

@Serializable

data class SetShowFPSCounterParameter(val show: Boolean)

SetShowGridOverlaysParameter

@Serializable

data class SetShowGridOverlaysParameter(val gridNodeHighlightConfigs: List<Overlay.GridNodeHighlightConfig>)

SetShowHingeParameter

@Serializable

data class SetShowHingeParameter(val hingeConfig: Overlay.HingeConfig? = null)

SetShowHitTestBordersParameter

@Serializable

data class SetShowHitTestBordersParameter(val show: Boolean)

SetShowIsolatedElementsParameter

@Serializable

data class SetShowIsolatedElementsParameter(val isolatedElementHighlightConfigs: List<Overlay.IsolatedElementHighlightConfig>)

SetShowLayoutShiftRegionsParameter

@Serializable

data class SetShowLayoutShiftRegionsParameter(val result: Boolean)

SetShowPaintRectsParameter

@Serializable

data class SetShowPaintRectsParameter(val result: Boolean)

SetShowScrollBottleneckRectsParameter

@Serializable

data class SetShowScrollBottleneckRectsParameter(val show: Boolean)

SetShowScrollSnapOverlaysParameter

@Serializable

data class SetShowScrollSnapOverlaysParameter(val scrollSnapHighlightConfigs: List<Overlay.ScrollSnapHighlightConfig>)

SetShowViewportSizeOnResizeParameter

@Serializable

data class SetShowViewportSizeOnResizeParameter(val show: Boolean)

SetShowWebVitalsParameter

@Serializable

data class SetShowWebVitalsParameter(val show: Boolean)

SetShowWindowControlsOverlayParameter

@Serializable

data class SetShowWindowControlsOverlayParameter(val windowControlsOverlayConfig: Overlay.WindowControlsOverlayConfig? = null)

SourceOrderConfig

@Serializable

data class SourceOrderConfig(val parentOutlineColor: DOM.RGBA, val childOutlineColor: DOM.RGBA)

Configuration data for drawing the source order of an elements children.

WindowControlsOverlayConfig

@Serializable

data class WindowControlsOverlayConfig(val showCSS: Boolean, val selectedPlatform: String, val themeColor: String)

Configuration for Window Controls Overlay

Properties

inspectModeCanceled

val inspectModeCanceled: Flow<Unit>

Fired when user cancels the inspect mode.

inspectNodeRequested

val inspectNodeRequested: Flow<Overlay.InspectNodeRequestedParameter>

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

nodeHighlightRequested

val nodeHighlightRequested: Flow<Overlay.NodeHighlightRequestedParameter>

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

screenshotRequested

val screenshotRequested: Flow<Overlay.ScreenshotRequestedParameter>

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

Functions

disable

suspend fun disable(mode: CommandMode = CommandMode.DEFAULT)

Disables domain notifications.

enable

suspend fun enable(mode: CommandMode = CommandMode.DEFAULT)

Enables domain notifications.

getGridHighlightObjectsForTest

suspend fun getGridHighlightObjectsForTest(nodeIds: List<Int>): Overlay.GetGridHighlightObjectsForTestReturn

suspend fun getGridHighlightObjectsForTest(args: Overlay.GetGridHighlightObjectsForTestParameter, mode: CommandMode = CommandMode.DEFAULT): Overlay.GetGridHighlightObjectsForTestReturn

For Persistent Grid testing.

getHighlightObjectForTest

suspend fun getHighlightObjectForTest(args: Overlay.GetHighlightObjectForTestParameter, mode: CommandMode = CommandMode.DEFAULT): Overlay.GetHighlightObjectForTestReturn

suspend fun getHighlightObjectForTest(nodeId: Int, includeDistance: Boolean? = null, includeStyle: Boolean? = null, colorFormat: Overlay.ColorFormat? = null, showAccessibilityInfo: Boolean? = null): Overlay.GetHighlightObjectForTestReturn

For testing.

getSourceOrderHighlightObjectForTest

suspend fun getSourceOrderHighlightObjectForTest(nodeId: Int): Overlay.GetSourceOrderHighlightObjectForTestReturn

suspend fun getSourceOrderHighlightObjectForTest(args: Overlay.GetSourceOrderHighlightObjectForTestParameter, mode: CommandMode = CommandMode.DEFAULT): Overlay.GetSourceOrderHighlightObjectForTestReturn

For Source Order Viewer testing.

hideHighlight

suspend fun hideHighlight(mode: CommandMode = CommandMode.DEFAULT)

Hides any highlight.

highlightFrame

suspend fun ~~highlightFrame~~(args: Overlay.HighlightFrameParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun ~~highlightFrame~~(frameId: String, contentColor: DOM.RGBA? = null, contentOutlineColor: DOM.RGBA? = null)

Highlights owner element of the frame with given id. Deprecated: Doesn't work reliably and cannot be fixed due to process separation (the owner node might be in a different process). Determine the owner node in the client and use highlightNode.

highlightNode

suspend fun highlightNode(args: Overlay.HighlightNodeParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun highlightNode(highlightConfig: Overlay.HighlightConfig, nodeId: Int? = null, backendNodeId: Int? = null, objectId: String? = null, selector: String? = null)

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

highlightQuad

suspend fun highlightQuad(args: Overlay.HighlightQuadParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun highlightQuad(quad: List<Double>, color: DOM.RGBA? = null, outlineColor: DOM.RGBA? = null)

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

highlightRect

suspend fun highlightRect(args: Overlay.HighlightRectParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun highlightRect(x: Int, y: Int, width: Int, height: Int, color: DOM.RGBA? = null, outlineColor: DOM.RGBA? = null)

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

highlightSourceOrder

suspend fun highlightSourceOrder(args: Overlay.HighlightSourceOrderParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun highlightSourceOrder(sourceOrderConfig: Overlay.SourceOrderConfig, nodeId: Int? = null, backendNodeId: Int? = null, objectId: String? = null)

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

suspend fun setInspectMode(mode: Overlay.InspectMode, highlightConfig: Overlay.HighlightConfig? = null)

suspend fun setInspectMode(args: Overlay.SetInspectModeParameter, mode: CommandMode = CommandMode.DEFAULT)

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

setPausedInDebuggerMessage

suspend fun setPausedInDebuggerMessage(message: String? = null)

suspend fun setPausedInDebuggerMessage(args: Overlay.SetPausedInDebuggerMessageParameter, mode: CommandMode = CommandMode.DEFAULT)

setShowAdHighlights

suspend fun setShowAdHighlights(show: Boolean)

suspend fun setShowAdHighlights(args: Overlay.SetShowAdHighlightsParameter, mode: CommandMode = CommandMode.DEFAULT)

Highlights owner element of all frames detected to be ads.

setShowContainerQueryOverlays

suspend fun setShowContainerQueryOverlays(containerQueryHighlightConfigs: List<Overlay.ContainerQueryHighlightConfig>)

suspend fun setShowContainerQueryOverlays(args: Overlay.SetShowContainerQueryOverlaysParameter, mode: CommandMode = CommandMode.DEFAULT)

setShowDebugBorders

suspend fun setShowDebugBorders(show: Boolean)

suspend fun setShowDebugBorders(args: Overlay.SetShowDebugBordersParameter, mode: CommandMode = CommandMode.DEFAULT)

Requests that backend shows debug borders on layers

setShowFlexOverlays

suspend fun setShowFlexOverlays(flexNodeHighlightConfigs: List<Overlay.FlexNodeHighlightConfig>)

suspend fun setShowFlexOverlays(args: Overlay.SetShowFlexOverlaysParameter, mode: CommandMode = CommandMode.DEFAULT)

setShowFPSCounter

suspend fun setShowFPSCounter(show: Boolean)

suspend fun setShowFPSCounter(args: Overlay.SetShowFPSCounterParameter, mode: CommandMode = CommandMode.DEFAULT)

Requests that backend shows the FPS counter

setShowGridOverlays

suspend fun setShowGridOverlays(gridNodeHighlightConfigs: List<Overlay.GridNodeHighlightConfig>)

suspend fun setShowGridOverlays(args: Overlay.SetShowGridOverlaysParameter, mode: CommandMode = CommandMode.DEFAULT)

Highlight multiple elements with the CSS Grid overlay.

setShowHinge

suspend fun setShowHinge(hingeConfig: Overlay.HingeConfig? = null)

suspend fun setShowHinge(args: Overlay.SetShowHingeParameter, mode: CommandMode = CommandMode.DEFAULT)

Add a dual screen device hinge

setShowHitTestBorders

suspend fun ~~setShowHitTestBorders~~(show: Boolean)

suspend fun ~~setShowHitTestBorders~~(args: Overlay.SetShowHitTestBordersParameter, mode: CommandMode = CommandMode.DEFAULT)

Deprecated, no longer has any effect.

setShowIsolatedElements

suspend fun setShowIsolatedElements(isolatedElementHighlightConfigs: List<Overlay.IsolatedElementHighlightConfig>)

suspend fun setShowIsolatedElements(args: Overlay.SetShowIsolatedElementsParameter, mode: CommandMode = CommandMode.DEFAULT)

Show elements in isolation mode with overlays.

setShowLayoutShiftRegions

suspend fun setShowLayoutShiftRegions(result: Boolean)

suspend fun setShowLayoutShiftRegions(args: Overlay.SetShowLayoutShiftRegionsParameter, mode: CommandMode = CommandMode.DEFAULT)

Requests that backend shows layout shift regions

setShowPaintRects

suspend fun setShowPaintRects(result: Boolean)

suspend fun setShowPaintRects(args: Overlay.SetShowPaintRectsParameter, mode: CommandMode = CommandMode.DEFAULT)

Requests that backend shows paint rectangles

setShowScrollBottleneckRects

suspend fun setShowScrollBottleneckRects(show: Boolean)

suspend fun setShowScrollBottleneckRects(args: Overlay.SetShowScrollBottleneckRectsParameter, mode: CommandMode = CommandMode.DEFAULT)

Requests that backend shows scroll bottleneck rects

setShowScrollSnapOverlays

suspend fun setShowScrollSnapOverlays(scrollSnapHighlightConfigs: List<Overlay.ScrollSnapHighlightConfig>)

suspend fun setShowScrollSnapOverlays(args: Overlay.SetShowScrollSnapOverlaysParameter, mode: CommandMode = CommandMode.DEFAULT)

setShowViewportSizeOnResize

suspend fun setShowViewportSizeOnResize(show: Boolean)

suspend fun setShowViewportSizeOnResize(args: Overlay.SetShowViewportSizeOnResizeParameter, mode: CommandMode = CommandMode.DEFAULT)

Paints viewport size upon main frame resize.

setShowWebVitals

suspend fun ~~setShowWebVitals~~(show: Boolean)

suspend fun ~~setShowWebVitals~~(args: Overlay.SetShowWebVitalsParameter, mode: CommandMode = CommandMode.DEFAULT)

Deprecated, no longer has any effect.

setShowWindowControlsOverlay

suspend fun setShowWindowControlsOverlay(windowControlsOverlayConfig: Overlay.WindowControlsOverlayConfig? = null)

suspend fun setShowWindowControlsOverlay(args: Overlay.SetShowWindowControlsOverlayParameter, mode: CommandMode = CommandMode.DEFAULT)

Show Window Controls Overlay for PWA