Chrome Remote Interface v0.2.0 ChromeRemoteInterface.RPC.Overlay View Source

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

Link to this section Summary

Functions

Disables domain notifications

Enables domain notifications

Hides any highlight

Highlights owner element of the frame with given id

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

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

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

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

Requests that backend shows debug borders on layers

Requests that backend shows the FPS counter

Requests that backend shows paint rectangles

Requests that backend shows scroll bottleneck rects

Paints viewport size upon main frame resize

Link to this section Functions

Disables domain notifications.

Parameters:

Link to this function disable(page_pid, parameters) View Source
Link to this function disable(page_pid, parameters, opts) View Source

Enables domain notifications.

Parameters:

Link to this function enable(page_pid, parameters) View Source
Link to this function enable(page_pid, parameters, opts) View Source
Link to this function getHighlightObjectForTest(page_pid) View Source

For testing.

Parameters: nodeId - - Id of the node to get highlight object for.

Link to this function getHighlightObjectForTest(page_pid, parameters) View Source
Link to this function getHighlightObjectForTest(page_pid, parameters, opts) View Source

Hides any highlight.

Parameters:

Link to this function hideHighlight(page_pid, parameters) View Source
Link to this function hideHighlight(page_pid, parameters, opts) View Source
Link to this function highlightFrame(page_pid) View Source

Highlights owner element of the frame with given id.

Parameters: frameId - - Identifier of the frame to highlight.contentColor - - The content box highlight fill color (default: transparent).contentOutlineColor - - The content box highlight outline color (default: transparent).

Link to this function highlightFrame(page_pid, parameters) View Source
Link to this function highlightFrame(page_pid, parameters, opts) View Source

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

Parameters: highlightConfig - - A descriptor for the highlight appearance.nodeId - - Identifier of the node to highlight.backendNodeId - - Identifier of the backend node to highlight.objectId - - JavaScript object id of the node to be highlighted.

Link to this function highlightNode(page_pid, parameters) View Source
Link to this function highlightNode(page_pid, parameters, opts) View Source

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

Parameters: quad - - Quad to highlightcolor - - The highlight fill color (default: transparent).outlineColor - - The highlight outline color (default: transparent).

Link to this function highlightQuad(page_pid, parameters) View Source
Link to this function highlightQuad(page_pid, parameters, opts) View Source

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

Parameters: x - - X coordinatey - - Y coordinatewidth - - Rectangle widthheight - - Rectangle heightcolor - - The highlight fill color (default: transparent).outlineColor - - The highlight outline color (default: transparent).

Link to this function highlightRect(page_pid, parameters) View Source
Link to this function highlightRect(page_pid, parameters, opts) View Source
Link to this function setInspectMode(page_pid) View Source

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

Parameters: mode - - Set an inspection mode.highlightConfig - - A descriptor for the highlight appearance of hovered-over nodes. May be omitted if enabled == false.

Link to this function setInspectMode(page_pid, parameters) View Source
Link to this function setInspectMode(page_pid, parameters, opts) View Source
Link to this function setPausedInDebuggerMessage(page_pid) View Source

Parameters: message - - The message to display, also triggers resume and step over controls.

Link to this function setPausedInDebuggerMessage(page_pid, parameters) View Source
Link to this function setPausedInDebuggerMessage(page_pid, parameters, opts) View Source
Link to this function setShowDebugBorders(page_pid) View Source

Requests that backend shows debug borders on layers

Parameters: show - - True for showing debug borders

Link to this function setShowDebugBorders(page_pid, parameters) View Source
Link to this function setShowDebugBorders(page_pid, parameters, opts) View Source
Link to this function setShowFPSCounter(page_pid) View Source

Requests that backend shows the FPS counter

Parameters: show - - True for showing the FPS counter

Link to this function setShowFPSCounter(page_pid, parameters) View Source
Link to this function setShowFPSCounter(page_pid, parameters, opts) View Source
Link to this function setShowPaintRects(page_pid) View Source

Requests that backend shows paint rectangles

Parameters: result - - True for showing paint rectangles

Link to this function setShowPaintRects(page_pid, parameters) View Source
Link to this function setShowPaintRects(page_pid, parameters, opts) View Source
Link to this function setShowScrollBottleneckRects(page_pid) View Source

Requests that backend shows scroll bottleneck rects

Parameters: show - - True for showing scroll bottleneck rects

Link to this function setShowScrollBottleneckRects(page_pid, parameters) View Source
Link to this function setShowScrollBottleneckRects(page_pid, parameters, opts) View Source
Link to this function setShowViewportSizeOnResize(page_pid) View Source

Paints viewport size upon main frame resize.

Parameters: show - - Whether to paint size or not.

Link to this function setShowViewportSizeOnResize(page_pid, parameters) View Source
Link to this function setShowViewportSizeOnResize(page_pid, parameters, opts) View Source

Parameters: suspended - - Whether overlay should be suspended and not consume any resources until resumed.

Link to this function setSuspended(page_pid, parameters) View Source
Link to this function setSuspended(page_pid, parameters, opts) View Source