overlay

Documentation

Overview

Package overlay provides type definitions for use with the Chrome Overlay protocol

https://chromedevtools.github.io/devtools-protocol/tot/Overlay/

Index

• Variables
• type DisableResult
• type EnableResult
• type GetHighlightObjectForTestParams
• type GetHighlightObjectForTestResult
• type HideHighlightResult
• type HighlightConfig
• type HighlightFrameParams
• type HighlightFrameResult
• type HighlightNodeParams
• type HighlightNodeResult
• type HighlightQuadParams
• type HighlightQuadResult
• type HighlightRectParams
• type HighlightRectResult
• type InspectModeEnum
  • func (enum InspectModeEnum) MarshalJSON() ([]byte, error)
  • func (enum InspectModeEnum) String() string
  • func (enum *InspectModeEnum) UnmarshalJSON(bytes []byte) error
• type InspectNodeRequestedEvent
• type NodeHighlightRequestedEvent
• type ScreenshotRequestedEvent
• type SetInspectModeParams
• type SetInspectModeResult
• type SetPausedInDebuggerMessageParams
• type SetPausedInDebuggerMessageResult
• type SetShowDebugBordersParams
• type SetShowDebugBordersResult
• type SetShowFPSCounterParams
• type SetShowFPSCounterResult
• type SetShowPaintRectsParams
• type SetShowPaintRectsResult
• type SetShowScrollBottleneckRectsParams
• type SetShowScrollBottleneckRectsResult
• type SetShowViewportSizeOnResizeParams
• type SetShowViewportSizeOnResizeResult
• type SetSuspendedParams
• type SetSuspendedResult

Variables

var InspectMode = inspectModeEnum{
	SearchForNode:        inspectModeSearchForNode,
	SearchForUAShadowDOM: inspectModeSearchForUAShadowDOM,
	None:                 inspectModeNone,
}

InspectMode provides named acces to the InspectModeEnum values.

Types

type DisableResult

type DisableResult struct {
	// Error information related to executing this method
	Err error `json:"-"`
}

DisableResult represents the result of calls to Overlay.disable.

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

type EnableResult

type EnableResult struct {
	// Error information related to executing this method
	Err error `json:"-"`
}

EnableResult represents the result of calls to Overlay.enable.

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

type GetHighlightObjectForTestParams

type GetHighlightObjectForTestParams struct {
	// ID of the node to get highlight object for.
	NodeID dom.NodeID `json:"nodeId"`
}

GetHighlightObjectForTestParams represents Overlay.getHighlightObjectForTest parameters.

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

type GetHighlightObjectForTestResult

type GetHighlightObjectForTestResult struct {
	// Highlight data for the node.
	Highlight map[string]string `json:"highlight"`

	// Error information related to executing this method
	Err error `json:"-"`
}

GetHighlightObjectForTestResult represents the result of calls to Overlay.getHighlightObjectForTest.

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

type HideHighlightResult

type HideHighlightResult struct {
	// Error information related to executing this method
	Err error `json:"-"`
}

HideHighlightResult represents the result of calls to Overlay.hideHighlight.

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

type HighlightConfig

type HighlightConfig struct {
	// Optional. Whether the node info tooltip should be shown (default: false).
	ShowInfo bool `json:"showInfo,omitempty"`

	// Optional. Whether the rulers should be shown (default: false).
	ShowRulers bool `json:"showRulers,omitempty"`

	// Optional. Whether the extension lines from node to the rulers should be
	// shown (default: false).
	ShowExtensionLines bool `json:"showExtensionLines,omitempty"`

	// Optional. Display as material.
	DisplayAsMaterial bool `json:"displayAsMaterial,omitempty"`

	// Optional. The content box highlight fill color (default: transparent).
	ContentColor *dom.RGBA `json:"contentColor,omitempty"`

	// Optional. The padding highlight fill color (default: transparent).
	PaddingColor *dom.RGBA `json:"paddingColor,omitempty"`

	// Optional. The border highlight fill color (default: transparent).
	BorderColor *dom.RGBA `json:"borderColor,omitempty"`

	// Optional. The margin highlight fill color (default: transparent).
	MarginColor *dom.RGBA `json:"marginColor,omitempty"`

	// Optional. The event target element highlight fill color (default:
	// transparent).
	EventTargetColor *dom.RGBA `json:"eventTargetColor,omitempty"`

	// Optional. The shape outside fill color (default: transparent).
	ShapeColor *dom.RGBA `json:"shapeColor,omitempty"`

	// Optional. The shape margin fill color (default: transparent).
	ShapeMarginColor *dom.RGBA `json:"shapeMarginColor,omitempty"`

	// Optional. Selectors to highlight relevant nodes.
	SelectorList string `json:"selectorList,omitempty"`

	// Optional. The grid layout color (default: transparent).
	CSSGridColor *dom.RGBA `json:"cssGridColor,omitempty"`
}

HighlightConfig is configuration data for the highlighting of page elements.

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

type HighlightFrameParams

type HighlightFrameParams struct {
	// Identifier of the frame to highlight.
	FrameID page.FrameID `json:"frameId"`

	// Optional. The content box highlight fill color (default: transparent).
	ContentColor *dom.RGBA `json:"contentColor,omitempty"`

	// Optional. The content box highlight outline color (default: transparent).
	ContentOutlineColor *dom.RGBA `json:"contentOutlineColor,omitempty"`
}

HighlightFrameParams represents Overlay.highlightFrame parameters.

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

type HighlightFrameResult

type HighlightFrameResult struct {
	// Error information related to executing this method
	Err error `json:"-"`
}

HighlightFrameResult represents the result of calls to Overlay.highlightFrame.

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

type HighlightNodeParams

type HighlightNodeParams struct {
	// A descriptor for the highlight appearance.
	HighlightConfig *HighlightConfig `json:"highlightConfig"`

	// Optional. Identifier of the node to highlight.
	NodeID dom.NodeID `json:"nodeId,omitempty"`

	// Optional. Identifier of the backend node to highlight.
	BackendNodeID dom.BackendNodeID `json:"backendNodeId,omitempty"`

	// Optional. JavaScript object ID of the node to be highlighted.
	ObjectID runtime.RemoteObjectID `json:"objectId,omitempty"`
}

HighlightNodeParams represents Overlay.highlightNode parameters.

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

type HighlightNodeResult

type HighlightNodeResult struct {
	// Error information related to executing this method
	Err error `json:"-"`
}

HighlightNodeResult represents the result of calls to Overlay.highlightNode.

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

type HighlightQuadParams

type HighlightQuadParams struct {
	// Quad to highlight.
	Quad dom.Quad `json:"quad"`

	// Optional. The highlight fill color (default: transparent).
	Color *dom.RGBA `json:"color,omitempty"`

	// Optional. The highlight outline color (default: transparent).
	OutlineColor *dom.RGBA `json:"outlineColor,omitempty"`
}

HighlightQuadParams represents Overlay.highlightQuad parameters.

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

type HighlightQuadResult

type HighlightQuadResult struct {
	// Error information related to executing this method
	Err error `json:"-"`
}

HighlightQuadResult represents the result of calls to Overlay.highlightQuad.

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

type HighlightRectParams

type HighlightRectParams struct {
	// X coordinate.
	X int `json:"x"`

	// Y coordinate.
	Y int `json:"y"`

	// Rectangle width.
	Width int `json:"width"`

	// Rectangle height.
	Height int `json:"height"`

	// Optional. The highlight fill color (default: transparent).
	Color *dom.RGBA `json:"color,omitempty"`

	// Optional. The highlight outline color (default: transparent).
	OutlineColor *dom.RGBA `json:"outlineColor,omitempty"`
}

HighlightRectParams represents Overlay.highlightRect parameters.

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

type HighlightRectResult

type HighlightRectResult struct {
	// Error information related to executing this method
	Err error `json:"-"`
}

HighlightRectResult represents the result of calls to Overlay.highlightRect.

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

type InspectModeEnum

type InspectModeEnum int

InspectModeEnum represents the inspect mode. Allowed values:

• InspectMode.SearchForNode "searchForNode"
• InspectMode.SearchForUAShadowDOM "searchForUAShadowDOM"
• InspectMode.None "none"

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

func (InspectModeEnum) MarshalJSON

func (enum InspectModeEnum) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (InspectModeEnum) String

func (enum InspectModeEnum) String() string

String implements Stringer

func (*InspectModeEnum) UnmarshalJSON

func (enum *InspectModeEnum) UnmarshalJSON(bytes []byte) error

UnmarshalJSON implements json.Unmarshaler

type InspectNodeRequestedEvent

type InspectNodeRequestedEvent struct {
	// ID of the node to inspect.
	BackendNodeID dom.BackendNodeID `json:"backendNodeId"`

	// Error information related to this event
	Err error `json:"-"`
}

InspectNodeRequestedEvent represents Overlay.inspectNodeRequested event data.

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

type NodeHighlightRequestedEvent

type NodeHighlightRequestedEvent struct {
	// ID of the node to highlight.
	NodeID dom.NodeID `json:"nodeId"`

	// Error information related to this event
	Err error `json:"-"`
}

NodeHighlightRequestedEvent represents Overlay.nodeHighlightRequested event data.

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

type ScreenshotRequestedEvent

type ScreenshotRequestedEvent struct {
	// Viewport to capture, in CSS.
	Viewport *page.Viewport `json:"viewport"`

	// Error information related to this event
	Err error `json:"-"`
}

ScreenshotRequestedEvent represents Overlay.screenshotRequested event data.

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

type SetInspectModeParams

type SetInspectModeParams struct {
	// Set an inspection mode. Allowed values:
	//	- InspectMode.SearchForNode
	//	- InspectMode.SearchForUAShadowDOM
	//	- InspectMode.None
	Mode InspectModeEnum `json:"mode"`

	// Optional. A descriptor for the highlight appearance of hovered-over nodes.
	// May be omitted if `enabled == false`.
	HighlightConfig *HighlightConfig `json:"highlightConfig,omitempty"`
}

SetInspectModeParams represents Overlay.setInspectMode parameters.

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

type SetInspectModeResult

type SetInspectModeResult struct {
	// Error information related to executing this method
	Err error `json:"-"`
}

SetInspectModeResult represents the result of calls to Overlay.setInspectMode.

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

type SetPausedInDebuggerMessageParams

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

SetPausedInDebuggerMessageParams represents Overlay.setPausedInDebuggerMessage parameters.

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

type SetPausedInDebuggerMessageResult

type SetPausedInDebuggerMessageResult struct {
	// Error information related to executing this method
	Err error `json:"-"`
}

SetPausedInDebuggerMessageResult represents the result of calls to Overlay.setPausedInDebuggerMessage.

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

type SetShowDebugBordersParams

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

SetShowDebugBordersParams represents Overlay.setShowDebugBorders parameters.

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

type SetShowDebugBordersResult

type SetShowDebugBordersResult struct {
	// Error information related to executing this method
	Err error `json:"-"`
}

SetShowDebugBordersResult represents the result of calls to Overlay.setShowDebugBorders.

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

type SetShowFPSCounterParams

type SetShowFPSCounterParams struct {
	// True for showing paint rectangles.
	Show bool `json:"show"`
}

SetShowFPSCounterParams represents Overlay.setShowFPSCounter parameters.

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

type SetShowFPSCounterResult

type SetShowFPSCounterResult struct {
	// Error information related to executing this method
	Err error `json:"-"`
}

SetShowFPSCounterResult represents the result of calls to Overlay.setShowFPSCounter.

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

type SetShowPaintRectsParams

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

SetShowPaintRectsParams represents Overlay.setShowPaintRects parameters.

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

type SetShowPaintRectsResult

type SetShowPaintRectsResult struct {
	// Error information related to executing this method
	Err error `json:"-"`
}

SetShowPaintRectsResult represents the result of calls to Overlay.setShowPaintRects.

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

type SetShowScrollBottleneckRectsParams

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

SetShowScrollBottleneckRectsParams represents Overlay.setShowScrollBottleneckRects parameters.

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

type SetShowScrollBottleneckRectsResult

type SetShowScrollBottleneckRectsResult struct {
	// Error information related to executing this method
	Err error `json:"-"`
}

SetShowScrollBottleneckRectsResult represents the result of calls to Overlay.SetShowScrollBottleneckRects.

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

type SetShowViewportSizeOnResizeParams

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

SetShowViewportSizeOnResizeParams represents Overlay.setShowViewportSizeOnResize parameters.

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

type SetShowViewportSizeOnResizeResult

type SetShowViewportSizeOnResizeResult struct {
	// Error information related to executing this method
	Err error `json:"-"`
}

SetShowViewportSizeOnResizeResult represents the result of calls to Overlay.SetShowViewportSizeOnResize.

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

type SetSuspendedParams

type SetSuspendedParams struct {
	// Whether overlay should be suspended and not consume any resources until
	// resumed.
	Suspended bool `json:"suspended"`
}

SetSuspendedParams represents Overlay.setSuspended parameters.

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

type SetSuspendedResult

type SetSuspendedResult struct {
	// Error information related to executing this method
	Err error `json:"-"`
}

SetSuspendedResult represents the result of calls to Overlay.setSuspended.

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