snapshot

Documentation

Overview

Package snapshot provides type definitions for use with the Chrome DOMSnapshot protocol

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

Index

• type ComputedStyle
• type DOMNode
• type DisableResult
• type EnableResult
• type GetParams
• type GetResult
• type InlineTextBox
• type LayoutTreeNode
• type NameValue

Types

type ComputedStyle

type ComputedStyle struct {
	// Name/value pairs of computed style properties.
	Properties []*NameValue `json:"properties"`
}

ComputedStyle is a subset of the full ComputedStyle as defined by the request whitelist.

https://chromedevtools.github.io/devtools-protocol/tot/DOMSnapshot/#type-ComputedStyle

type DOMNode

type DOMNode struct {
	// Node's nodeType.
	NodeType int64 `json:"nodeType"`

	// Node's nodeName.
	NodeName string `json:"nodeName"`

	// Node's nodeValue.
	NodeValue string `json:"nodeValue"`

	// Optional. Only set for textarea elements, contains the text value.
	TextValue string `json:"textValue,omitempty"`

	// Optional. Only set for input elements, contains the input's associated
	// text value.
	InputValue string `json:"inputValue,omitempty"`

	// Optional. Only set for radio and checkbox input elements, indicates if
	// the element has been checked.
	InputChecked bool `json:"inputChecked,omitempty"`

	// Optional. Only set for option elements, indicates if the element has been
	// selected.
	OptionSelected bool `json:"optionSelected,omitempty"`

	// Optional. Node's ID, corresponds to DOM.Node.backendNodeID.
	BackendNodeID dom.BackendNodeID `json:"backendNodeId,omitempty"`

	// Optional. The indexes of the node's child nodes in the domNodes array
	// returned by getSnapshot, if any.
	ChildNodeIndexes []int64 `json:"childNodeIndexes,omitempty"`

	// Optional. Attributes of an Element node.
	Attributes []*NameValue `json:"attributes,omitempty"`

	// Optional. Indexes of pseudo elements associated with this node in the
	// domNodes array returned by getSnapshot, if any.
	PseudoElementIndexes []int64 `json:"pseudoElementIndexes,omitempty"`

	// Optional. The index of the node's related layout tree node in the
	// layoutTreeNodes array returned by getSnapshot, if any.
	LayoutNodeIndex int64 `json:"layoutNodeIndex,omitempty"`

	// Optional. Document URL that Document or FrameOwner node points to.
	DocumentURL string `json:"documentURL,omitempty"`

	// Optional. Base URL that Document or FrameOwner node uses for URL
	// completion.
	BaseURL string `json:"baseURL,omitempty"`

	// Optional. Only set for documents, contains the document's content
	// language.
	ContentLanguage string `json:"contentLanguage,omitempty"`

	// Optional. Only set for documents, contains the document's character set
	// encoding.
	DocumentEncoding string `json:"documentEncoding,omitempty"`

	// Optional. DocumentType node's publicId.
	PublicID string `json:"publicId,omitempty"`

	// Optional. DocumentType node's systemId.
	SystemID string `json:"systemId,omitempty"`

	// Optional. Frame ID for frame owner elements and also for the document
	// node.
	FrameID page.FrameID `json:"frameId,omitempty"`

	// Optional. The index of a frame owner element's content document in the
	// domNodes array returned by getSnapshot, if any.
	ContentDocumentIndex int64 `json:"contentDocumentIndex,omitempty"`

	// Optional. Index of the imported document's node of a link element in the
	// domNodes array returned by getSnapshot, if any.
	ImportedDocumentIndex int64 `json:"importedDocumentIndex,omitempty"`

	// Optional. Index of the content node of a template element in the domNodes
	// array returned by getSnapshot.
	TemplateContentIndex int64 `json:"templateContentIndex,omitempty"`

	// Optional. Type of a pseudo element node.
	PseudoType dom.PseudoType `json:"pseudoType,omitempty"`

	// Optional. Whether this DOM node responds to mouse clicks. This includes
	// nodes that have had click event listeners attached via JavaScript as well
	// as anchor tags that naturally navigate when clicked.
	IsClickable bool `json:"isClickable,omitempty"`
}

DOMNode is a Node in the DOM tree.

https://chromedevtools.github.io/devtools-protocol/tot/DOMSnapshot/#type-DOMNode

type DisableResult

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

DisableResult represents the result of calls to DOMSnapshot.disable.

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

type EnableResult

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

EnableResult represents the result of calls to DOMSnapshot.enable.

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

type GetParams

type GetParams struct {
	// Whitelist of computed styles to return.
	ComputedStyleWhitelist []string `json:"computedStyleWhitelist"`
}

GetParams represents DOMSnapshot.getSnapshot parameters.

https://chromedevtools.github.io/devtools-protocol/tot/DOMSnapshot/#method-getSnapshot

type GetResult

type GetResult struct {
	// The nodes in the DOM tree. The DOMNode at index 0 corresponds to the root
	// document.
	DOMNodes []*DOMNode `json:"domNodes"`

	// The nodes in the layout tree.
	LayoutTreeNodes []*LayoutTreeNode `json:"layoutTreeNodes"`

	// Whitelisted ComputedStyle properties for each node in the layout tree.
	ComputedStyles []*ComputedStyle `json:"computedStyles"`

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

GetResult represents the result of calls to DOMSnapshot.getSnapshot.

https://chromedevtools.github.io/devtools-protocol/tot/DOMSnapshot/#method-getSnapshot

type InlineTextBox

type InlineTextBox struct {
	// The absolute position bounding box.
	BoundingBox *dom.Rect `json:"boundingBox"`

	// The starting index in characters, for this post layout textbox substring.
	StartCharacterIndex int64 `json:"startCharacterIndex"`

	// The number of characters in this post layout textbox substring.
	NumCharacters int64 `json:"numCharacters"`
}

InlineTextBox contains details of post layout rendered text positions. The exact layout should not be regarded as stable and may change between versions.

https://chromedevtools.github.io/devtools-protocol/tot/DOMSnapshot/#type-InlineTextBox

type LayoutTreeNode

type LayoutTreeNode struct {
	// The index of the related DOM node in the domNodes array returned by getSnapshot.
	DomNodeIndex int64 `json:"domNodeIndex"`

	// The absolute position bounding box.
	BoundingBox *dom.Rect `json:"boundingBox"`

	// Optional. Contents of the LayoutText, if any.
	LayoutText string `json:"layoutText,omitempty"`

	// Optional. The post-layout inline text nodes, if any.
	InlineTextNodes []*InlineTextBox `json:"inlineTextNodes,omitempty"`

	// Optional. Index into the computedStyles array returned by getSnapshot.
	StyleIndex int64 `json:"styleIndex,omitempty"`
}

LayoutTreeNode contains details of an element in the DOM tree with a LayoutObject.

https://chromedevtools.github.io/devtools-protocol/tot/DOMSnapshot/#type-LayoutTreeNode

type NameValue

type NameValue struct {
	// Attribute/property name.
	Name string `json:"name"`

	// Attribute/property value.
	Value string `json:"value"`
}

NameValue is a name/value pair.

https://chromedevtools.github.io/devtools-protocol/tot/DOMSnapshot/#type-NameValue