clj-chrome-devtools.commands.overlay — adstage-lab/clj-chrome-devtools 20190328

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

disable clj

(disable)

(disable {:as params :keys []})

(disable connection {:as params :keys []})

Disables domain notifications.

enable clj

(enable)

(enable {:as params :keys []})

(enable connection {:as params :keys []})

Enables domain notifications.

get-highlight-object-for-test clj

(get-highlight-object-for-test)

(get-highlight-object-for-test {:as params :keys [node-id]})

(get-highlight-object-for-test connection {:as params :keys [node-id]})

For testing.

Parameters map keys:

Key	Description
:node-id	Id of the node to get highlight object for.

Return map keys:

Key	Description
:highlight	Highlight data for the node.

hide-highlight clj

(hide-highlight)

(hide-highlight {:as params :keys []})

(hide-highlight connection {:as params :keys []})

Hides any highlight.

highlight-frame clj

(highlight-frame)

(highlight-frame {:as params
                  :keys [frame-id content-color content-outline-color]})

(highlight-frame connection
                 {:as params
                  :keys [frame-id content-color content-outline-color]})

Highlights owner element of the frame with given id.

Parameters map keys:

Key	Description
:frame-id	Identifier of the frame to highlight.
:content-color	The content box highlight fill color (default: transparent). (optional)
:content-outline-color	The content box highlight outline color (default: transparent). (optional)

highlight-node clj

(highlight-node)

(highlight-node {:as params
                 :keys [highlight-config node-id backend-node-id object-id]})

(highlight-node connection
                {:as params
                 :keys [highlight-config node-id backend-node-id object-id]})

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

Parameters map keys:

Key	Description
:highlight-config	A descriptor for the highlight appearance.
:node-id	Identifier of the node to highlight. (optional)
:backend-node-id	Identifier of the backend node to highlight. (optional)
:object-id	JavaScript object id of the node to be highlighted. (optional)

highlight-quad clj

(highlight-quad)

(highlight-quad {:as params :keys [quad color outline-color]})

(highlight-quad connection {:as params :keys [quad color outline-color]})

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

Parameters map keys:

Key	Description
:quad	Quad to highlight
:color	The highlight fill color (default: transparent). (optional)
:outline-color	The highlight outline color (default: transparent). (optional)

highlight-rect clj

(highlight-rect)

(highlight-rect {:as params :keys [x y width height color outline-color]})

(highlight-rect connection
                {:as params :keys [x y width height color outline-color]})

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

Parameters map keys:

Key	Description
:x	X coordinate
:y	Y coordinate
:width	Rectangle width
:height	Rectangle height
:color	The highlight fill color (default: transparent). (optional)
:outline-color	The highlight outline color (default: transparent). (optional)

set-inspect-mode clj

(set-inspect-mode)

(set-inspect-mode {:as params :keys [mode highlight-config]})

(set-inspect-mode connection {:as params :keys [mode highlight-config]})

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

Parameters map keys:

Key	Description
:mode	Set an inspection mode.
:highlight-config	A descriptor for the highlight appearance of hovered-over nodes. May be omitted if enabled == false. (optional)

set-paused-in-debugger-message clj

(set-paused-in-debugger-message)

(set-paused-in-debugger-message {:as params :keys [message]})

(set-paused-in-debugger-message connection {:as params :keys [message]})

Parameters map keys:

Key	Description
:message	The message to display, also triggers resume and step over controls. (optional)

set-show-debug-borders clj

(set-show-debug-borders)

(set-show-debug-borders {:as params :keys [show]})

(set-show-debug-borders connection {:as params :keys [show]})

Requests that backend shows debug borders on layers

Parameters map keys:

Key	Description
:show	True for showing debug borders

set-show-fps-counter clj

(set-show-fps-counter)

(set-show-fps-counter {:as params :keys [show]})

(set-show-fps-counter connection {:as params :keys [show]})

Requests that backend shows the FPS counter

Parameters map keys:

Key	Description
:show	True for showing the FPS counter

set-show-paint-rects clj

(set-show-paint-rects)

(set-show-paint-rects {:as params :keys [result]})

(set-show-paint-rects connection {:as params :keys [result]})

Requests that backend shows paint rectangles

Parameters map keys:

Key	Description
:result	True for showing paint rectangles

set-show-scroll-bottleneck-rects clj

(set-show-scroll-bottleneck-rects)

(set-show-scroll-bottleneck-rects {:as params :keys [show]})

(set-show-scroll-bottleneck-rects connection {:as params :keys [show]})

Requests that backend shows scroll bottleneck rects

Parameters map keys:

Key	Description
:show	True for showing scroll bottleneck rects

set-show-viewport-size-on-resize clj

(set-show-viewport-size-on-resize)

(set-show-viewport-size-on-resize {:as params :keys [show]})

(set-show-viewport-size-on-resize connection {:as params :keys [show]})

Paints viewport size upon main frame resize.

Parameters map keys:

Key	Description
:show	Whether to paint size or not.

set-suspended clj

(set-suspended)

(set-suspended {:as params :keys [suspended]})

(set-suspended connection {:as params :keys [suspended]})

Parameters map keys:

Key	Description
:suspended	Whether overlay should be suspended and not consume any resources until resumed.