Documentation ¶
Overview ¶
Package overlay provides the Chrome Debugging Protocol commands, types, and events for the Overlay domain.
This domain provides various functionality related to drawing atop the inspected page.
Generated by the chromedp-gen command.
Index ¶
- Variables
- type DisableParams
- func (p *DisableParams) Do(ctxt context.Context, h cdp.Handler) (err error)
- func (v DisableParams) MarshalEasyJSON(w *jwriter.Writer)
- func (v DisableParams) MarshalJSON() ([]byte, error)
- func (v *DisableParams) UnmarshalEasyJSON(l *jlexer.Lexer)
- func (v *DisableParams) UnmarshalJSON(data []byte) error
- type EnableParams
- type EventInspectNodeRequested
- type EventNodeHighlightRequested
- type EventScreenshotRequested
- type GetHighlightObjectForTestParams
- func (p *GetHighlightObjectForTestParams) Do(ctxt context.Context, h cdp.Handler) (highlight easyjson.RawMessage, err error)
- func (v GetHighlightObjectForTestParams) MarshalEasyJSON(w *jwriter.Writer)
- func (v GetHighlightObjectForTestParams) MarshalJSON() ([]byte, error)
- func (v *GetHighlightObjectForTestParams) UnmarshalEasyJSON(l *jlexer.Lexer)
- func (v *GetHighlightObjectForTestParams) UnmarshalJSON(data []byte) error
- type GetHighlightObjectForTestReturns
- func (v GetHighlightObjectForTestReturns) MarshalEasyJSON(w *jwriter.Writer)
- func (v GetHighlightObjectForTestReturns) MarshalJSON() ([]byte, error)
- func (v *GetHighlightObjectForTestReturns) UnmarshalEasyJSON(l *jlexer.Lexer)
- func (v *GetHighlightObjectForTestReturns) UnmarshalJSON(data []byte) error
- type HideHighlightParams
- func (p *HideHighlightParams) Do(ctxt context.Context, h cdp.Handler) (err error)
- func (v HideHighlightParams) MarshalEasyJSON(w *jwriter.Writer)
- func (v HideHighlightParams) MarshalJSON() ([]byte, error)
- func (v *HideHighlightParams) UnmarshalEasyJSON(l *jlexer.Lexer)
- func (v *HideHighlightParams) UnmarshalJSON(data []byte) error
- type HighlightConfig
- type HighlightFrameParams
- func (p *HighlightFrameParams) Do(ctxt context.Context, h cdp.Handler) (err error)
- func (v HighlightFrameParams) MarshalEasyJSON(w *jwriter.Writer)
- func (v HighlightFrameParams) MarshalJSON() ([]byte, error)
- func (v *HighlightFrameParams) UnmarshalEasyJSON(l *jlexer.Lexer)
- func (v *HighlightFrameParams) UnmarshalJSON(data []byte) error
- func (p HighlightFrameParams) WithContentColor(contentColor *cdp.RGBA) *HighlightFrameParams
- func (p HighlightFrameParams) WithContentOutlineColor(contentOutlineColor *cdp.RGBA) *HighlightFrameParams
- type HighlightNodeParams
- func (p *HighlightNodeParams) Do(ctxt context.Context, h cdp.Handler) (err error)
- func (v HighlightNodeParams) MarshalEasyJSON(w *jwriter.Writer)
- func (v HighlightNodeParams) MarshalJSON() ([]byte, error)
- func (v *HighlightNodeParams) UnmarshalEasyJSON(l *jlexer.Lexer)
- func (v *HighlightNodeParams) UnmarshalJSON(data []byte) error
- func (p HighlightNodeParams) WithBackendNodeID(backendNodeID cdp.BackendNodeID) *HighlightNodeParams
- func (p HighlightNodeParams) WithNodeID(nodeID cdp.NodeID) *HighlightNodeParams
- func (p HighlightNodeParams) WithObjectID(objectID runtime.RemoteObjectID) *HighlightNodeParams
- type HighlightQuadParams
- func (p *HighlightQuadParams) Do(ctxt context.Context, h cdp.Handler) (err error)
- func (v HighlightQuadParams) MarshalEasyJSON(w *jwriter.Writer)
- func (v HighlightQuadParams) MarshalJSON() ([]byte, error)
- func (v *HighlightQuadParams) UnmarshalEasyJSON(l *jlexer.Lexer)
- func (v *HighlightQuadParams) UnmarshalJSON(data []byte) error
- func (p HighlightQuadParams) WithColor(color *cdp.RGBA) *HighlightQuadParams
- func (p HighlightQuadParams) WithOutlineColor(outlineColor *cdp.RGBA) *HighlightQuadParams
- type HighlightRectParams
- func (p *HighlightRectParams) Do(ctxt context.Context, h cdp.Handler) (err error)
- func (v HighlightRectParams) MarshalEasyJSON(w *jwriter.Writer)
- func (v HighlightRectParams) MarshalJSON() ([]byte, error)
- func (v *HighlightRectParams) UnmarshalEasyJSON(l *jlexer.Lexer)
- func (v *HighlightRectParams) UnmarshalJSON(data []byte) error
- func (p HighlightRectParams) WithColor(color *cdp.RGBA) *HighlightRectParams
- func (p HighlightRectParams) WithOutlineColor(outlineColor *cdp.RGBA) *HighlightRectParams
- type InspectMode
- type SetInspectModeParams
- func (p *SetInspectModeParams) Do(ctxt context.Context, h cdp.Handler) (err error)
- func (v SetInspectModeParams) MarshalEasyJSON(w *jwriter.Writer)
- func (v SetInspectModeParams) MarshalJSON() ([]byte, error)
- func (v *SetInspectModeParams) UnmarshalEasyJSON(l *jlexer.Lexer)
- func (v *SetInspectModeParams) UnmarshalJSON(data []byte) error
- func (p SetInspectModeParams) WithHighlightConfig(highlightConfig *HighlightConfig) *SetInspectModeParams
- type SetPausedInDebuggerMessageParams
- func (p *SetPausedInDebuggerMessageParams) Do(ctxt context.Context, h cdp.Handler) (err error)
- func (v SetPausedInDebuggerMessageParams) MarshalEasyJSON(w *jwriter.Writer)
- func (v SetPausedInDebuggerMessageParams) MarshalJSON() ([]byte, error)
- func (v *SetPausedInDebuggerMessageParams) UnmarshalEasyJSON(l *jlexer.Lexer)
- func (v *SetPausedInDebuggerMessageParams) UnmarshalJSON(data []byte) error
- func (p SetPausedInDebuggerMessageParams) WithMessage(message string) *SetPausedInDebuggerMessageParams
- type SetShowDebugBordersParams
- func (p *SetShowDebugBordersParams) Do(ctxt context.Context, h cdp.Handler) (err error)
- func (v SetShowDebugBordersParams) MarshalEasyJSON(w *jwriter.Writer)
- func (v SetShowDebugBordersParams) MarshalJSON() ([]byte, error)
- func (v *SetShowDebugBordersParams) UnmarshalEasyJSON(l *jlexer.Lexer)
- func (v *SetShowDebugBordersParams) UnmarshalJSON(data []byte) error
- type SetShowFPSCounterParams
- func (p *SetShowFPSCounterParams) Do(ctxt context.Context, h cdp.Handler) (err error)
- func (v SetShowFPSCounterParams) MarshalEasyJSON(w *jwriter.Writer)
- func (v SetShowFPSCounterParams) MarshalJSON() ([]byte, error)
- func (v *SetShowFPSCounterParams) UnmarshalEasyJSON(l *jlexer.Lexer)
- func (v *SetShowFPSCounterParams) UnmarshalJSON(data []byte) error
- type SetShowPaintRectsParams
- func (p *SetShowPaintRectsParams) Do(ctxt context.Context, h cdp.Handler) (err error)
- func (v SetShowPaintRectsParams) MarshalEasyJSON(w *jwriter.Writer)
- func (v SetShowPaintRectsParams) MarshalJSON() ([]byte, error)
- func (v *SetShowPaintRectsParams) UnmarshalEasyJSON(l *jlexer.Lexer)
- func (v *SetShowPaintRectsParams) UnmarshalJSON(data []byte) error
- type SetShowScrollBottleneckRectsParams
- func (p *SetShowScrollBottleneckRectsParams) Do(ctxt context.Context, h cdp.Handler) (err error)
- func (v SetShowScrollBottleneckRectsParams) MarshalEasyJSON(w *jwriter.Writer)
- func (v SetShowScrollBottleneckRectsParams) MarshalJSON() ([]byte, error)
- func (v *SetShowScrollBottleneckRectsParams) UnmarshalEasyJSON(l *jlexer.Lexer)
- func (v *SetShowScrollBottleneckRectsParams) UnmarshalJSON(data []byte) error
- type SetShowViewportSizeOnResizeParams
- func (p *SetShowViewportSizeOnResizeParams) Do(ctxt context.Context, h cdp.Handler) (err error)
- func (v SetShowViewportSizeOnResizeParams) MarshalEasyJSON(w *jwriter.Writer)
- func (v SetShowViewportSizeOnResizeParams) MarshalJSON() ([]byte, error)
- func (v *SetShowViewportSizeOnResizeParams) UnmarshalEasyJSON(l *jlexer.Lexer)
- func (v *SetShowViewportSizeOnResizeParams) UnmarshalJSON(data []byte) error
- type SetSuspendedParams
- func (p *SetSuspendedParams) Do(ctxt context.Context, h cdp.Handler) (err error)
- func (v SetSuspendedParams) MarshalEasyJSON(w *jwriter.Writer)
- func (v SetSuspendedParams) MarshalJSON() ([]byte, error)
- func (v *SetSuspendedParams) UnmarshalEasyJSON(l *jlexer.Lexer)
- func (v *SetSuspendedParams) UnmarshalJSON(data []byte) error
Constants ¶
This section is empty.
Variables ¶
var EventTypes = []cdp.MethodType{ cdp.EventOverlayNodeHighlightRequested, cdp.EventOverlayInspectNodeRequested, cdp.EventOverlayScreenshotRequested, }
EventTypes all event types in the domain.
Functions ¶
This section is empty.
Types ¶
type DisableParams ¶
type DisableParams struct{}
DisableParams disables domain notifications.
func (*DisableParams) Do ¶
Do executes Overlay.disable against the provided context and target handler.
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 (*EnableParams) Do ¶
Do executes Overlay.enable against the provided context and target handler.
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 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.
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 ¶
EventNodeHighlightRequested fired when the node should be highlighted. This happens after call to setInspectMode.
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 CSS.
}
EventScreenshotRequested fired when user asks to capture screenshot of some area on the page.
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.
}
GetHighlightObjectForTestParams for testing.
func GetHighlightObjectForTest ¶
func GetHighlightObjectForTest(nodeID cdp.NodeID) *GetHighlightObjectForTestParams
GetHighlightObjectForTest for testing.
parameters:
nodeID - Id of the node to get highlight object for.
func (*GetHighlightObjectForTestParams) Do ¶
func (p *GetHighlightObjectForTestParams) Do(ctxt context.Context, h cdp.Handler) (highlight easyjson.RawMessage, err error)
Do executes Overlay.getHighlightObjectForTest against the provided context and target handler.
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
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 ¶
Do executes Overlay.hideHighlight against the provided context and target handler.
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). 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). DisplayAsMaterial bool `json:"displayAsMaterial,omitempty"` 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). SelectorList string `json:"selectorList,omitempty"` // Selectors to highlight relevant nodes. }
HighlightConfig configuration data for the highlighting of page elements.
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.
parameters:
frameID - Identifier of the frame to highlight.
func (*HighlightFrameParams) Do ¶
Do executes Overlay.highlightFrame against the provided context and target handler.
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. }
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.
parameters:
highlightConfig - A descriptor for the highlight appearance.
func (*HighlightNodeParams) Do ¶
Do executes Overlay.highlightNode against the provided context and target handler.
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 ¶
func (p HighlightNodeParams) WithObjectID(objectID runtime.RemoteObjectID) *HighlightNodeParams
WithObjectID javaScript object id of the node to be highlighted.
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.
parameters:
quad - Quad to highlight
func (*HighlightQuadParams) Do ¶
Do executes Overlay.highlightQuad against the provided context and target handler.
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.
parameters:
x - X coordinate y - Y coordinate width - Rectangle width height - Rectangle height
func (*HighlightRectParams) Do ¶
Do executes Overlay.highlightRect against the provided context and target handler.
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].
const ( InspectModeSearchForNode InspectMode = "searchForNode" InspectModeSearchForUAShadowDOM InspectMode = "searchForUAShadowDOM" 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.
parameters:
mode - Set an inspection mode.
func (*SetInspectModeParams) Do ¶
Do executes Overlay.setInspectMode against the provided context and target handler.
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].
parameters:
func (*SetPausedInDebuggerMessageParams) Do ¶
Do executes Overlay.setPausedInDebuggerMessage against the provided context and target handler.
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 ¶
func (p SetPausedInDebuggerMessageParams) WithMessage(message string) *SetPausedInDebuggerMessageParams
WithMessage the message to display, also triggers resume and step over controls.
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.
parameters:
show - True for showing debug borders
func (*SetShowDebugBordersParams) Do ¶
Do executes Overlay.setShowDebugBorders against the provided context and target handler.
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.
parameters:
show - True for showing the FPS counter
func (*SetShowFPSCounterParams) Do ¶
Do executes Overlay.setShowFPSCounter against the provided context and target handler.
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 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.
parameters:
result - True for showing paint rectangles
func (*SetShowPaintRectsParams) Do ¶
Do executes Overlay.setShowPaintRects against the provided context and target handler.
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.
parameters:
show - True for showing scroll bottleneck rects
func (*SetShowScrollBottleneckRectsParams) Do ¶
Do executes Overlay.setShowScrollBottleneckRects against the provided context and target handler.
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.
parameters:
show - Whether to paint size or not.
func (*SetShowViewportSizeOnResizeParams) Do ¶
Do executes Overlay.setShowViewportSizeOnResize against the provided context and target handler.
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
type SetSuspendedParams ¶
type SetSuspendedParams struct {
Suspended bool `json:"suspended"` // Whether overlay should be suspended and not consume any resources until resumed.
}
SetSuspendedParams [no description].
func SetSuspended ¶
func SetSuspended(suspended bool) *SetSuspendedParams
SetSuspended [no description].
parameters:
suspended - Whether overlay should be suspended and not consume any resources until resumed.
func (*SetSuspendedParams) Do ¶
Do executes Overlay.setSuspended against the provided context and target handler.
func (SetSuspendedParams) MarshalEasyJSON ¶
func (v SetSuspendedParams) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (SetSuspendedParams) MarshalJSON ¶
func (v SetSuspendedParams) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*SetSuspendedParams) UnmarshalEasyJSON ¶
func (v *SetSuspendedParams) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*SetSuspendedParams) UnmarshalJSON ¶
func (v *SetSuspendedParams) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface