overlay

package
Version: v0.0.0-...-5fc0351 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 5, 2019 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Package overlay provides the Chrome DevTools Protocol commands, types, and events for the Overlay domain.

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

Generated by the cdproto-gen command.

Index

Constants

View Source
const (
	CommandDisable                      = "Overlay.disable"
	CommandEnable                       = "Overlay.enable"
	CommandGetHighlightObjectForTest    = "Overlay.getHighlightObjectForTest"
	CommandHideHighlight                = "Overlay.hideHighlight"
	CommandHighlightFrame               = "Overlay.highlightFrame"
	CommandHighlightNode                = "Overlay.highlightNode"
	CommandHighlightQuad                = "Overlay.highlightQuad"
	CommandHighlightRect                = "Overlay.highlightRect"
	CommandSetInspectMode               = "Overlay.setInspectMode"
	CommandSetShowAdHighlights          = "Overlay.setShowAdHighlights"
	CommandSetPausedInDebuggerMessage   = "Overlay.setPausedInDebuggerMessage"
	CommandSetShowDebugBorders          = "Overlay.setShowDebugBorders"
	CommandSetShowFPSCounter            = "Overlay.setShowFPSCounter"
	CommandSetShowPaintRects            = "Overlay.setShowPaintRects"
	CommandSetShowLayoutShiftRegions    = "Overlay.setShowLayoutShiftRegions"
	CommandSetShowScrollBottleneckRects = "Overlay.setShowScrollBottleneckRects"
	CommandSetShowHitTestBorders        = "Overlay.setShowHitTestBorders"
	CommandSetShowViewportSizeOnResize  = "Overlay.setShowViewportSizeOnResize"
)

Command names.

Variables

This section is empty.

Functions

This section is empty.

Types

type DisableParams

type DisableParams struct{}

DisableParams disables domain notifications.

func Disable

func Disable() *DisableParams

Disable disables domain notifications.

See: https://chromedevtools.github.io/devtools-protocol/tot/Overlay#method-disable

func (*DisableParams) Do

func (p *DisableParams) Do(ctx context.Context) (err error)

Do executes Overlay.disable against the provided context.

func (DisableParams) MarshalEasyJSON

func (v DisableParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (DisableParams) MarshalJSON

func (v DisableParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*DisableParams) UnmarshalEasyJSON

func (v *DisableParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*DisableParams) UnmarshalJSON

func (v *DisableParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type EnableParams

type EnableParams struct{}

EnableParams enables domain notifications.

func Enable

func Enable() *EnableParams

Enable enables domain notifications.

See: https://chromedevtools.github.io/devtools-protocol/tot/Overlay#method-enable

func (*EnableParams) Do

func (p *EnableParams) Do(ctx context.Context) (err error)

Do executes Overlay.enable against the provided context.

func (EnableParams) MarshalEasyJSON

func (v EnableParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (EnableParams) MarshalJSON

func (v EnableParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*EnableParams) UnmarshalEasyJSON

func (v *EnableParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*EnableParams) UnmarshalJSON

func (v *EnableParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type EventInspectModeCanceled

type EventInspectModeCanceled struct{}

EventInspectModeCanceled fired when user cancels the inspect mode.

See: https://chromedevtools.github.io/devtools-protocol/tot/Overlay#event-inspectModeCanceled

func (EventInspectModeCanceled) MarshalEasyJSON

func (v EventInspectModeCanceled) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (EventInspectModeCanceled) MarshalJSON

func (v EventInspectModeCanceled) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*EventInspectModeCanceled) UnmarshalEasyJSON

func (v *EventInspectModeCanceled) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*EventInspectModeCanceled) UnmarshalJSON

func (v *EventInspectModeCanceled) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type EventInspectNodeRequested

type EventInspectNodeRequested struct {
	BackendNodeID cdp.BackendNodeID `json:"backendNodeId"` // Id of the node to inspect.
}

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

See: https://chromedevtools.github.io/devtools-protocol/tot/Overlay#event-inspectNodeRequested

func (EventInspectNodeRequested) MarshalEasyJSON

func (v EventInspectNodeRequested) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (EventInspectNodeRequested) MarshalJSON

func (v EventInspectNodeRequested) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*EventInspectNodeRequested) UnmarshalEasyJSON

func (v *EventInspectNodeRequested) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*EventInspectNodeRequested) UnmarshalJSON

func (v *EventInspectNodeRequested) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type EventNodeHighlightRequested

type EventNodeHighlightRequested struct {
	NodeID cdp.NodeID `json:"nodeId"`
}

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

See: https://chromedevtools.github.io/devtools-protocol/tot/Overlay#event-nodeHighlightRequested

func (EventNodeHighlightRequested) MarshalEasyJSON

func (v EventNodeHighlightRequested) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (EventNodeHighlightRequested) MarshalJSON

func (v EventNodeHighlightRequested) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*EventNodeHighlightRequested) UnmarshalEasyJSON

func (v *EventNodeHighlightRequested) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*EventNodeHighlightRequested) UnmarshalJSON

func (v *EventNodeHighlightRequested) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type EventScreenshotRequested

type EventScreenshotRequested struct {
	Viewport *page.Viewport `json:"viewport"` // Viewport to capture, in device independent pixels (dip).
}

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

See: https://chromedevtools.github.io/devtools-protocol/tot/Overlay#event-screenshotRequested

func (EventScreenshotRequested) MarshalEasyJSON

func (v EventScreenshotRequested) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (EventScreenshotRequested) MarshalJSON

func (v EventScreenshotRequested) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*EventScreenshotRequested) UnmarshalEasyJSON

func (v *EventScreenshotRequested) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*EventScreenshotRequested) UnmarshalJSON

func (v *EventScreenshotRequested) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type GetHighlightObjectForTestParams

type GetHighlightObjectForTestParams struct {
	NodeID          cdp.NodeID `json:"nodeId"`                    // Id of the node to get highlight object for.
	IncludeDistance bool       `json:"includeDistance,omitempty"` // Whether to include distance info.
	IncludeStyle    bool       `json:"includeStyle,omitempty"`    // Whether to include style info.
}

GetHighlightObjectForTestParams for testing.

func GetHighlightObjectForTest

func GetHighlightObjectForTest(nodeID cdp.NodeID) *GetHighlightObjectForTestParams

GetHighlightObjectForTest for testing.

See: https://chromedevtools.github.io/devtools-protocol/tot/Overlay#method-getHighlightObjectForTest

parameters:

nodeID - Id of the node to get highlight object for.

func (*GetHighlightObjectForTestParams) Do

Do executes Overlay.getHighlightObjectForTest against the provided context.

returns:

highlight - Highlight data for the node.

func (GetHighlightObjectForTestParams) MarshalEasyJSON

func (v GetHighlightObjectForTestParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetHighlightObjectForTestParams) MarshalJSON

func (v GetHighlightObjectForTestParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*GetHighlightObjectForTestParams) UnmarshalEasyJSON

func (v *GetHighlightObjectForTestParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetHighlightObjectForTestParams) UnmarshalJSON

func (v *GetHighlightObjectForTestParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

func (GetHighlightObjectForTestParams) WithIncludeDistance

func (p GetHighlightObjectForTestParams) WithIncludeDistance(includeDistance bool) *GetHighlightObjectForTestParams

WithIncludeDistance whether to include distance info.

func (GetHighlightObjectForTestParams) WithIncludeStyle

func (p GetHighlightObjectForTestParams) WithIncludeStyle(includeStyle bool) *GetHighlightObjectForTestParams

WithIncludeStyle whether to include style info.

type GetHighlightObjectForTestReturns

type GetHighlightObjectForTestReturns struct {
	Highlight easyjson.RawMessage `json:"highlight,omitempty"`
}

GetHighlightObjectForTestReturns return values.

func (GetHighlightObjectForTestReturns) MarshalEasyJSON

func (v GetHighlightObjectForTestReturns) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (GetHighlightObjectForTestReturns) MarshalJSON

func (v GetHighlightObjectForTestReturns) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*GetHighlightObjectForTestReturns) UnmarshalEasyJSON

func (v *GetHighlightObjectForTestReturns) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*GetHighlightObjectForTestReturns) UnmarshalJSON

func (v *GetHighlightObjectForTestReturns) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type HideHighlightParams

type HideHighlightParams struct{}

HideHighlightParams hides any highlight.

func (*HideHighlightParams) Do

func (p *HideHighlightParams) Do(ctx context.Context) (err error)

Do executes Overlay.hideHighlight against the provided context.

func (HideHighlightParams) MarshalEasyJSON

func (v HideHighlightParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (HideHighlightParams) MarshalJSON

func (v HideHighlightParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*HideHighlightParams) UnmarshalEasyJSON

func (v *HideHighlightParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*HideHighlightParams) UnmarshalJSON

func (v *HideHighlightParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type HighlightConfig

type HighlightConfig struct {
	ShowInfo           bool      `json:"showInfo,omitempty"`           // Whether the node info tooltip should be shown (default: false).
	ShowStyles         bool      `json:"showStyles,omitempty"`         // Whether the node styles in the tooltip (default: false).
	ShowRulers         bool      `json:"showRulers,omitempty"`         // Whether the rulers should be shown (default: false).
	ShowExtensionLines bool      `json:"showExtensionLines,omitempty"` // Whether the extension lines from node to the rulers should be shown (default: false).
	ContentColor       *cdp.RGBA `json:"contentColor,omitempty"`       // The content box highlight fill color (default: transparent).
	PaddingColor       *cdp.RGBA `json:"paddingColor,omitempty"`       // The padding highlight fill color (default: transparent).
	BorderColor        *cdp.RGBA `json:"borderColor,omitempty"`        // The border highlight fill color (default: transparent).
	MarginColor        *cdp.RGBA `json:"marginColor,omitempty"`        // The margin highlight fill color (default: transparent).
	EventTargetColor   *cdp.RGBA `json:"eventTargetColor,omitempty"`   // The event target element highlight fill color (default: transparent).
	ShapeColor         *cdp.RGBA `json:"shapeColor,omitempty"`         // The shape outside fill color (default: transparent).
	ShapeMarginColor   *cdp.RGBA `json:"shapeMarginColor,omitempty"`   // The shape margin fill color (default: transparent).
	CSSGridColor       *cdp.RGBA `json:"cssGridColor,omitempty"`       // The grid layout color (default: transparent).
}

HighlightConfig configuration data for the highlighting of page elements.

See: https://chromedevtools.github.io/devtools-protocol/tot/Overlay#type-HighlightConfig

func (HighlightConfig) MarshalEasyJSON

func (v HighlightConfig) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (HighlightConfig) MarshalJSON

func (v HighlightConfig) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*HighlightConfig) UnmarshalEasyJSON

func (v *HighlightConfig) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*HighlightConfig) UnmarshalJSON

func (v *HighlightConfig) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type HighlightFrameParams

type HighlightFrameParams struct {
	FrameID             cdp.FrameID `json:"frameId"`                       // Identifier of the frame to highlight.
	ContentColor        *cdp.RGBA   `json:"contentColor,omitempty"`        // The content box highlight fill color (default: transparent).
	ContentOutlineColor *cdp.RGBA   `json:"contentOutlineColor,omitempty"` // The content box highlight outline color (default: transparent).
}

HighlightFrameParams highlights owner element of the frame with given id.

func HighlightFrame

func HighlightFrame(frameID cdp.FrameID) *HighlightFrameParams

HighlightFrame highlights owner element of the frame with given id.

See: https://chromedevtools.github.io/devtools-protocol/tot/Overlay#method-highlightFrame

parameters:

frameID - Identifier of the frame to highlight.

func (*HighlightFrameParams) Do

func (p *HighlightFrameParams) Do(ctx context.Context) (err error)

Do executes Overlay.highlightFrame against the provided context.

func (HighlightFrameParams) MarshalEasyJSON

func (v HighlightFrameParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (HighlightFrameParams) MarshalJSON

func (v HighlightFrameParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*HighlightFrameParams) UnmarshalEasyJSON

func (v *HighlightFrameParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*HighlightFrameParams) UnmarshalJSON

func (v *HighlightFrameParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

func (HighlightFrameParams) WithContentColor

func (p HighlightFrameParams) WithContentColor(contentColor *cdp.RGBA) *HighlightFrameParams

WithContentColor the content box highlight fill color (default: transparent).

func (HighlightFrameParams) WithContentOutlineColor

func (p HighlightFrameParams) WithContentOutlineColor(contentOutlineColor *cdp.RGBA) *HighlightFrameParams

WithContentOutlineColor the content box highlight outline color (default: transparent).

type HighlightNodeParams

type HighlightNodeParams struct {
	HighlightConfig *HighlightConfig       `json:"highlightConfig"`         // A descriptor for the highlight appearance.
	NodeID          cdp.NodeID             `json:"nodeId,omitempty"`        // Identifier of the node to highlight.
	BackendNodeID   cdp.BackendNodeID      `json:"backendNodeId,omitempty"` // Identifier of the backend node to highlight.
	ObjectID        runtime.RemoteObjectID `json:"objectId,omitempty"`      // JavaScript object id of the node to be highlighted.
	Selector        string                 `json:"selector,omitempty"`      // Selectors to highlight relevant nodes.
}

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

func HighlightNode

func HighlightNode(highlightConfig *HighlightConfig) *HighlightNodeParams

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

See: https://chromedevtools.github.io/devtools-protocol/tot/Overlay#method-highlightNode

parameters:

highlightConfig - A descriptor for the highlight appearance.

func (*HighlightNodeParams) Do

func (p *HighlightNodeParams) Do(ctx context.Context) (err error)

Do executes Overlay.highlightNode against the provided context.

func (HighlightNodeParams) MarshalEasyJSON

func (v HighlightNodeParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (HighlightNodeParams) MarshalJSON

func (v HighlightNodeParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*HighlightNodeParams) UnmarshalEasyJSON

func (v *HighlightNodeParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*HighlightNodeParams) UnmarshalJSON

func (v *HighlightNodeParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

func (HighlightNodeParams) WithBackendNodeID

func (p HighlightNodeParams) WithBackendNodeID(backendNodeID cdp.BackendNodeID) *HighlightNodeParams

WithBackendNodeID identifier of the backend node to highlight.

func (HighlightNodeParams) WithNodeID

func (p HighlightNodeParams) WithNodeID(nodeID cdp.NodeID) *HighlightNodeParams

WithNodeID identifier of the node to highlight.

func (HighlightNodeParams) WithObjectID

WithObjectID JavaScript object id of the node to be highlighted.

func (HighlightNodeParams) WithSelector

func (p HighlightNodeParams) WithSelector(selector string) *HighlightNodeParams

WithSelector selectors to highlight relevant nodes.

type HighlightQuadParams

type HighlightQuadParams struct {
	Quad         dom.Quad  `json:"quad"`                   // Quad to highlight
	Color        *cdp.RGBA `json:"color,omitempty"`        // The highlight fill color (default: transparent).
	OutlineColor *cdp.RGBA `json:"outlineColor,omitempty"` // The highlight outline color (default: transparent).
}

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

func HighlightQuad

func HighlightQuad(quad dom.Quad) *HighlightQuadParams

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

See: https://chromedevtools.github.io/devtools-protocol/tot/Overlay#method-highlightQuad

parameters:

quad - Quad to highlight

func (*HighlightQuadParams) Do

func (p *HighlightQuadParams) Do(ctx context.Context) (err error)

Do executes Overlay.highlightQuad against the provided context.

func (HighlightQuadParams) MarshalEasyJSON

func (v HighlightQuadParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (HighlightQuadParams) MarshalJSON

func (v HighlightQuadParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*HighlightQuadParams) UnmarshalEasyJSON

func (v *HighlightQuadParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*HighlightQuadParams) UnmarshalJSON

func (v *HighlightQuadParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

func (HighlightQuadParams) WithColor

func (p HighlightQuadParams) WithColor(color *cdp.RGBA) *HighlightQuadParams

WithColor the highlight fill color (default: transparent).

func (HighlightQuadParams) WithOutlineColor

func (p HighlightQuadParams) WithOutlineColor(outlineColor *cdp.RGBA) *HighlightQuadParams

WithOutlineColor the highlight outline color (default: transparent).

type HighlightRectParams

type HighlightRectParams struct {
	X            int64     `json:"x"`                      // X coordinate
	Y            int64     `json:"y"`                      // Y coordinate
	Width        int64     `json:"width"`                  // Rectangle width
	Height       int64     `json:"height"`                 // Rectangle height
	Color        *cdp.RGBA `json:"color,omitempty"`        // The highlight fill color (default: transparent).
	OutlineColor *cdp.RGBA `json:"outlineColor,omitempty"` // The highlight outline color (default: transparent).
}

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

func HighlightRect

func HighlightRect(x int64, y int64, width int64, height int64) *HighlightRectParams

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

See: https://chromedevtools.github.io/devtools-protocol/tot/Overlay#method-highlightRect

parameters:

x - X coordinate
y - Y coordinate
width - Rectangle width
height - Rectangle height

func (*HighlightRectParams) Do

func (p *HighlightRectParams) Do(ctx context.Context) (err error)

Do executes Overlay.highlightRect against the provided context.

func (HighlightRectParams) MarshalEasyJSON

func (v HighlightRectParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (HighlightRectParams) MarshalJSON

func (v HighlightRectParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*HighlightRectParams) UnmarshalEasyJSON

func (v *HighlightRectParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*HighlightRectParams) UnmarshalJSON

func (v *HighlightRectParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

func (HighlightRectParams) WithColor

func (p HighlightRectParams) WithColor(color *cdp.RGBA) *HighlightRectParams

WithColor the highlight fill color (default: transparent).

func (HighlightRectParams) WithOutlineColor

func (p HighlightRectParams) WithOutlineColor(outlineColor *cdp.RGBA) *HighlightRectParams

WithOutlineColor the highlight outline color (default: transparent).

type InspectMode

type InspectMode string

InspectMode [no description].

See: https://chromedevtools.github.io/devtools-protocol/tot/Overlay#type-InspectMode

const (
	InspectModeSearchForNode         InspectMode = "searchForNode"
	InspectModeSearchForUAShadowDOM  InspectMode = "searchForUAShadowDOM"
	InspectModeCaptureAreaScreenshot InspectMode = "captureAreaScreenshot"
	InspectModeShowDistances         InspectMode = "showDistances"
	InspectModeNone                  InspectMode = "none"
)

InspectMode values.

func (InspectMode) MarshalEasyJSON

func (t InspectMode) MarshalEasyJSON(out *jwriter.Writer)

MarshalEasyJSON satisfies easyjson.Marshaler.

func (InspectMode) MarshalJSON

func (t InspectMode) MarshalJSON() ([]byte, error)

MarshalJSON satisfies json.Marshaler.

func (InspectMode) String

func (t InspectMode) String() string

String returns the InspectMode as string value.

func (*InspectMode) UnmarshalEasyJSON

func (t *InspectMode) UnmarshalEasyJSON(in *jlexer.Lexer)

UnmarshalEasyJSON satisfies easyjson.Unmarshaler.

func (*InspectMode) UnmarshalJSON

func (t *InspectMode) UnmarshalJSON(buf []byte) error

UnmarshalJSON satisfies json.Unmarshaler.

type SetInspectModeParams

type SetInspectModeParams struct {
	Mode            InspectMode      `json:"mode"`                      // Set an inspection mode.
	HighlightConfig *HighlightConfig `json:"highlightConfig,omitempty"` // A descriptor for the highlight appearance of hovered-over nodes. May be omitted if enabled == false.
}

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

func SetInspectMode

func SetInspectMode(mode InspectMode) *SetInspectModeParams

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

See: https://chromedevtools.github.io/devtools-protocol/tot/Overlay#method-setInspectMode

parameters:

mode - Set an inspection mode.

func (*SetInspectModeParams) Do

func (p *SetInspectModeParams) Do(ctx context.Context) (err error)

Do executes Overlay.setInspectMode against the provided context.

func (SetInspectModeParams) MarshalEasyJSON

func (v SetInspectModeParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (SetInspectModeParams) MarshalJSON

func (v SetInspectModeParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*SetInspectModeParams) UnmarshalEasyJSON

func (v *SetInspectModeParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*SetInspectModeParams) UnmarshalJSON

func (v *SetInspectModeParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

func (SetInspectModeParams) WithHighlightConfig

func (p SetInspectModeParams) WithHighlightConfig(highlightConfig *HighlightConfig) *SetInspectModeParams

WithHighlightConfig a descriptor for the highlight appearance of hovered-over nodes. May be omitted if enabled == false.

type SetPausedInDebuggerMessageParams

type SetPausedInDebuggerMessageParams struct {
	Message string `json:"message,omitempty"` // The message to display, also triggers resume and step over controls.
}

SetPausedInDebuggerMessageParams [no description].

func SetPausedInDebuggerMessage

func SetPausedInDebuggerMessage() *SetPausedInDebuggerMessageParams

SetPausedInDebuggerMessage [no description].

See: https://chromedevtools.github.io/devtools-protocol/tot/Overlay#method-setPausedInDebuggerMessage

parameters:

func (*SetPausedInDebuggerMessageParams) Do

Do executes Overlay.setPausedInDebuggerMessage against the provided context.

func (SetPausedInDebuggerMessageParams) MarshalEasyJSON

func (v SetPausedInDebuggerMessageParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (SetPausedInDebuggerMessageParams) MarshalJSON

func (v SetPausedInDebuggerMessageParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*SetPausedInDebuggerMessageParams) UnmarshalEasyJSON

func (v *SetPausedInDebuggerMessageParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*SetPausedInDebuggerMessageParams) UnmarshalJSON

func (v *SetPausedInDebuggerMessageParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

func (SetPausedInDebuggerMessageParams) WithMessage

WithMessage the message to display, also triggers resume and step over controls.

type SetShowAdHighlightsParams

type SetShowAdHighlightsParams struct {
	Show bool `json:"show"` // True for showing ad highlights
}

SetShowAdHighlightsParams highlights owner element of all frames detected to be ads.

func SetShowAdHighlights

func SetShowAdHighlights(show bool) *SetShowAdHighlightsParams

SetShowAdHighlights highlights owner element of all frames detected to be ads.

See: https://chromedevtools.github.io/devtools-protocol/tot/Overlay#method-setShowAdHighlights

parameters:

show - True for showing ad highlights

func (*SetShowAdHighlightsParams) Do

Do executes Overlay.setShowAdHighlights against the provided context.

func (SetShowAdHighlightsParams) MarshalEasyJSON

func (v SetShowAdHighlightsParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (SetShowAdHighlightsParams) MarshalJSON

func (v SetShowAdHighlightsParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*SetShowAdHighlightsParams) UnmarshalEasyJSON

func (v *SetShowAdHighlightsParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*SetShowAdHighlightsParams) UnmarshalJSON

func (v *SetShowAdHighlightsParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type SetShowDebugBordersParams

type SetShowDebugBordersParams struct {
	Show bool `json:"show"` // True for showing debug borders
}

SetShowDebugBordersParams requests that backend shows debug borders on layers.

func SetShowDebugBorders

func SetShowDebugBorders(show bool) *SetShowDebugBordersParams

SetShowDebugBorders requests that backend shows debug borders on layers.

See: https://chromedevtools.github.io/devtools-protocol/tot/Overlay#method-setShowDebugBorders

parameters:

show - True for showing debug borders

func (*SetShowDebugBordersParams) Do

Do executes Overlay.setShowDebugBorders against the provided context.

func (SetShowDebugBordersParams) MarshalEasyJSON

func (v SetShowDebugBordersParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (SetShowDebugBordersParams) MarshalJSON

func (v SetShowDebugBordersParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*SetShowDebugBordersParams) UnmarshalEasyJSON

func (v *SetShowDebugBordersParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*SetShowDebugBordersParams) UnmarshalJSON

func (v *SetShowDebugBordersParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type SetShowFPSCounterParams

type SetShowFPSCounterParams struct {
	Show bool `json:"show"` // True for showing the FPS counter
}

SetShowFPSCounterParams requests that backend shows the FPS counter.

func SetShowFPSCounter

func SetShowFPSCounter(show bool) *SetShowFPSCounterParams

SetShowFPSCounter requests that backend shows the FPS counter.

See: https://chromedevtools.github.io/devtools-protocol/tot/Overlay#method-setShowFPSCounter

parameters:

show - True for showing the FPS counter

func (*SetShowFPSCounterParams) Do

func (p *SetShowFPSCounterParams) Do(ctx context.Context) (err error)

Do executes Overlay.setShowFPSCounter against the provided context.

func (SetShowFPSCounterParams) MarshalEasyJSON

func (v SetShowFPSCounterParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (SetShowFPSCounterParams) MarshalJSON

func (v SetShowFPSCounterParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*SetShowFPSCounterParams) UnmarshalEasyJSON

func (v *SetShowFPSCounterParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*SetShowFPSCounterParams) UnmarshalJSON

func (v *SetShowFPSCounterParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type SetShowHitTestBordersParams

type SetShowHitTestBordersParams struct {
	Show bool `json:"show"` // True for showing hit-test borders
}

SetShowHitTestBordersParams requests that backend shows hit-test borders on layers.

func SetShowHitTestBorders

func SetShowHitTestBorders(show bool) *SetShowHitTestBordersParams

SetShowHitTestBorders requests that backend shows hit-test borders on layers.

See: https://chromedevtools.github.io/devtools-protocol/tot/Overlay#method-setShowHitTestBorders

parameters:

show - True for showing hit-test borders

func (*SetShowHitTestBordersParams) Do

Do executes Overlay.setShowHitTestBorders against the provided context.

func (SetShowHitTestBordersParams) MarshalEasyJSON

func (v SetShowHitTestBordersParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (SetShowHitTestBordersParams) MarshalJSON

func (v SetShowHitTestBordersParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*SetShowHitTestBordersParams) UnmarshalEasyJSON

func (v *SetShowHitTestBordersParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*SetShowHitTestBordersParams) UnmarshalJSON

func (v *SetShowHitTestBordersParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type SetShowLayoutShiftRegionsParams

type SetShowLayoutShiftRegionsParams struct {
	Result bool `json:"result"` // True for showing layout shift regions
}

SetShowLayoutShiftRegionsParams requests that backend shows layout shift regions.

func SetShowLayoutShiftRegions

func SetShowLayoutShiftRegions(result bool) *SetShowLayoutShiftRegionsParams

SetShowLayoutShiftRegions requests that backend shows layout shift regions.

See: https://chromedevtools.github.io/devtools-protocol/tot/Overlay#method-setShowLayoutShiftRegions

parameters:

result - True for showing layout shift regions

func (*SetShowLayoutShiftRegionsParams) Do

Do executes Overlay.setShowLayoutShiftRegions against the provided context.

func (SetShowLayoutShiftRegionsParams) MarshalEasyJSON

func (v SetShowLayoutShiftRegionsParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (SetShowLayoutShiftRegionsParams) MarshalJSON

func (v SetShowLayoutShiftRegionsParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*SetShowLayoutShiftRegionsParams) UnmarshalEasyJSON

func (v *SetShowLayoutShiftRegionsParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*SetShowLayoutShiftRegionsParams) UnmarshalJSON

func (v *SetShowLayoutShiftRegionsParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type SetShowPaintRectsParams

type SetShowPaintRectsParams struct {
	Result bool `json:"result"` // True for showing paint rectangles
}

SetShowPaintRectsParams requests that backend shows paint rectangles.

func SetShowPaintRects

func SetShowPaintRects(result bool) *SetShowPaintRectsParams

SetShowPaintRects requests that backend shows paint rectangles.

See: https://chromedevtools.github.io/devtools-protocol/tot/Overlay#method-setShowPaintRects

parameters:

result - True for showing paint rectangles

func (*SetShowPaintRectsParams) Do

func (p *SetShowPaintRectsParams) Do(ctx context.Context) (err error)

Do executes Overlay.setShowPaintRects against the provided context.

func (SetShowPaintRectsParams) MarshalEasyJSON

func (v SetShowPaintRectsParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (SetShowPaintRectsParams) MarshalJSON

func (v SetShowPaintRectsParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*SetShowPaintRectsParams) UnmarshalEasyJSON

func (v *SetShowPaintRectsParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*SetShowPaintRectsParams) UnmarshalJSON

func (v *SetShowPaintRectsParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type SetShowScrollBottleneckRectsParams

type SetShowScrollBottleneckRectsParams struct {
	Show bool `json:"show"` // True for showing scroll bottleneck rects
}

SetShowScrollBottleneckRectsParams requests that backend shows scroll bottleneck rects.

func SetShowScrollBottleneckRects

func SetShowScrollBottleneckRects(show bool) *SetShowScrollBottleneckRectsParams

SetShowScrollBottleneckRects requests that backend shows scroll bottleneck rects.

See: https://chromedevtools.github.io/devtools-protocol/tot/Overlay#method-setShowScrollBottleneckRects

parameters:

show - True for showing scroll bottleneck rects

func (*SetShowScrollBottleneckRectsParams) Do

Do executes Overlay.setShowScrollBottleneckRects against the provided context.

func (SetShowScrollBottleneckRectsParams) MarshalEasyJSON

func (v SetShowScrollBottleneckRectsParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (SetShowScrollBottleneckRectsParams) MarshalJSON

func (v SetShowScrollBottleneckRectsParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*SetShowScrollBottleneckRectsParams) UnmarshalEasyJSON

func (v *SetShowScrollBottleneckRectsParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*SetShowScrollBottleneckRectsParams) UnmarshalJSON

func (v *SetShowScrollBottleneckRectsParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type SetShowViewportSizeOnResizeParams

type SetShowViewportSizeOnResizeParams struct {
	Show bool `json:"show"` // Whether to paint size or not.
}

SetShowViewportSizeOnResizeParams paints viewport size upon main frame resize.

func SetShowViewportSizeOnResize

func SetShowViewportSizeOnResize(show bool) *SetShowViewportSizeOnResizeParams

SetShowViewportSizeOnResize paints viewport size upon main frame resize.

See: https://chromedevtools.github.io/devtools-protocol/tot/Overlay#method-setShowViewportSizeOnResize

parameters:

show - Whether to paint size or not.

func (*SetShowViewportSizeOnResizeParams) Do

Do executes Overlay.setShowViewportSizeOnResize against the provided context.

func (SetShowViewportSizeOnResizeParams) MarshalEasyJSON

func (v SetShowViewportSizeOnResizeParams) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (SetShowViewportSizeOnResizeParams) MarshalJSON

func (v SetShowViewportSizeOnResizeParams) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*SetShowViewportSizeOnResizeParams) UnmarshalEasyJSON

func (v *SetShowViewportSizeOnResizeParams) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*SetShowViewportSizeOnResizeParams) UnmarshalJSON

func (v *SetShowViewportSizeOnResizeParams) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL