Package org.openqa.selenium.devtools.overlay

Class Overlay

  • @Beta
public class Overlay
extends java.lang.Object
    This domain provides various functionality related to drawing atop the inspected page.

    • Constructor Detail

      • Overlay

        public Overlay()

    • Method Detail

      • disable

        public static Command<java.lang.Void> disable()
        Disables domain notifications.

      • enable

        public static Command<java.lang.Void> enable()
        Enables domain notifications.

      • getHighlightObjectForTest

        public static Command<java.util.Map<java.lang.String,​java.lang.Object>> getHighlightObjectForTest​(NodeId nodeId,
                                                                                                        java.util.Optional<java.lang.Boolean> includeDistance,
                                                                                                        java.util.Optional<java.lang.Boolean> includeStyle)
        For testing.

      • hideHighlight

        public static Command<java.lang.Void> hideHighlight()
        Hides any highlight.

      • highlightFrame

        public static Command<java.lang.Void> highlightFrame​(FrameId frameId,
                                                     java.util.Optional<RGBA> contentColor,
                                                     java.util.Optional<RGBA> contentOutlineColor)
        Highlights owner element of the frame with given id.

      • highlightNode

        public static Command<java.lang.Void> highlightNode​(HighlightConfig highlightConfig,
                                                    java.util.Optional<NodeId> nodeId,
                                                    java.util.Optional<BackendNodeId> backendNodeId,
                                                    java.util.Optional<RemoteObjectId> objectId,
                                                    java.util.Optional<java.lang.String> selector)
        Highlights DOM node with given id or with the given JavaScript object wrapper. Either nodeId or objectId must be specified.

      • highlightQuad

        public static Command<java.lang.Void> highlightQuad​(Quad quad,
                                                    java.util.Optional<RGBA> color,
                                                    java.util.Optional<RGBA> outlineColor)
        Highlights given quad. Coordinates are absolute with respect to the main frame viewport.

      • highlightRect

        public static Command<java.lang.Void> highlightRect​(java.lang.Integer x,
                                                    java.lang.Integer y,
                                                    java.lang.Integer width,
                                                    java.lang.Integer height,
                                                    java.util.Optional<RGBA> color,
                                                    java.util.Optional<RGBA> outlineColor)
        Highlights given rectangle. Coordinates are absolute with respect to the main frame viewport.

      • setInspectMode

        public static Command<java.lang.Void> setInspectMode​(InspectMode mode,
                                                     java.util.Optional<HighlightConfig> highlightConfig)
        Enters the 'inspect' mode. In this mode, elements that user is hovering over are highlighted. Backend then generates 'inspectNodeRequested' event upon element selection.

      • setShowAdHighlights

        public static Command<java.lang.Void> setShowAdHighlights​(java.lang.Boolean show)
        Highlights owner element of all frames detected to be ads.

      • setPausedInDebuggerMessage

        public static Command<java.lang.Void> setPausedInDebuggerMessage​(java.util.Optional<java.lang.String> message)

      • setShowDebugBorders

        public static Command<java.lang.Void> setShowDebugBorders​(java.lang.Boolean show)
        Requests that backend shows debug borders on layers

      • setShowFPSCounter

        public static Command<java.lang.Void> setShowFPSCounter​(java.lang.Boolean show)
        Requests that backend shows the FPS counter

      • setShowPaintRects

        public static Command<java.lang.Void> setShowPaintRects​(java.lang.Boolean result)
        Requests that backend shows paint rectangles

      • setShowLayoutShiftRegions

        public static Command<java.lang.Void> setShowLayoutShiftRegions​(java.lang.Boolean result)
        Requests that backend shows layout shift regions

      • setShowScrollBottleneckRects

        public static Command<java.lang.Void> setShowScrollBottleneckRects​(java.lang.Boolean show)
        Requests that backend shows scroll bottleneck rects

      • setShowHitTestBorders

        public static Command<java.lang.Void> setShowHitTestBorders​(java.lang.Boolean show)
        Requests that backend shows hit-test borders on layers

      • setShowViewportSizeOnResize

        public static Command<java.lang.Void> setShowViewportSizeOnResize​(java.lang.Boolean show)
        Paints viewport size upon main frame resize.

      • nodeHighlightRequested

        public static Event<NodeId> nodeHighlightRequested()

      • screenshotRequested

        public static Event<Viewport> screenshotRequested()

      • inspectModeCanceled

        public static Event<java.lang.Void> inspectModeCanceled()