public interface DOM
Note that `iframe` owner elements will return corresponding document elements as their child nodes.
| Modifier and Type | Method and Description |
|---|---|
List<String> |
collectClassNamesFromSubtree(Integer nodeId)
Collects class names for the node with given id and all of it's child nodes.
|
Integer |
copyTo(Integer nodeId,
Integer targetNodeId)
Creates a deep copy of the specified node and places it into the target container before the
given anchor.
|
Integer |
copyTo(Integer nodeId,
Integer targetNodeId,
Integer insertBeforeNodeId)
Creates a deep copy of the specified node and places it into the target container before the
given anchor.
|
Node |
describeNode()
Describes node given its id, does not require domain to be enabled.
|
Node |
describeNode(Integer nodeId,
Integer backendNodeId,
String objectId,
Integer depth,
Boolean pierce)
Describes node given its id, does not require domain to be enabled.
|
void |
disable()
Disables DOM agent for the given page.
|
void |
discardSearchResults(String searchId)
Discards search results from the session with the given id.
|
void |
enable()
Enables DOM agent for the given page.
|
void |
focus()
Focuses the given element.
|
void |
focus(Integer nodeId,
Integer backendNodeId,
String objectId)
Focuses the given element.
|
List<String> |
getAttributes(Integer nodeId)
Returns attributes for the specified node.
|
BoxModel |
getBoxModel()
Returns boxes for the given node.
|
BoxModel |
getBoxModel(Integer nodeId,
Integer backendNodeId,
String objectId)
Returns boxes for the given node.
|
List<List<Double>> |
getContentQuads()
Returns quads that describe node position on the page.
|
List<List<Double>> |
getContentQuads(Integer nodeId,
Integer backendNodeId,
String objectId)
Returns quads that describe node position on the page.
|
Node |
getDocument()
Returns the root DOM node (and optionally the subtree) to the caller.
|
Node |
getDocument(Integer depth,
Boolean pierce)
Returns the root DOM node (and optionally the subtree) to the caller.
|
String |
getFileInfo(String objectId)
Returns file information for the given File wrapper.
|
List<Node> |
getFlattenedDocument()
Returns the root DOM node (and optionally the subtree) to the caller.
|
List<Node> |
getFlattenedDocument(Integer depth,
Boolean pierce)
Returns the root DOM node (and optionally the subtree) to the caller.
|
FrameOwner |
getFrameOwner(String frameId)
Returns iframe node that owns iframe with the given domain.
|
NodeForLocation |
getNodeForLocation(Integer x,
Integer y)
Returns node id at given location.
|
NodeForLocation |
getNodeForLocation(Integer x,
Integer y,
Boolean includeUserAgentShadowDOM)
Returns node id at given location.
|
StackTrace |
getNodeStackTraces(Integer nodeId)
Gets stack traces associated with a Node.
|
String |
getOuterHTML()
Returns node's HTML markup.
|
String |
getOuterHTML(Integer nodeId,
Integer backendNodeId,
String objectId)
Returns node's HTML markup.
|
Integer |
getRelayoutBoundary(Integer nodeId)
Returns the id of the nearest ancestor that is a relayout boundary.
|
List<Integer> |
getSearchResults(String searchId,
Integer fromIndex,
Integer toIndex)
Returns search results from given `fromIndex` to given `toIndex` from the search with the given
identifier.
|
void |
markUndoableState()
Marks last undoable state.
|
Integer |
moveTo(Integer nodeId,
Integer targetNodeId)
Moves node into the new container, places it before the given anchor.
|
Integer |
moveTo(Integer nodeId,
Integer targetNodeId,
Integer insertBeforeNodeId)
Moves node into the new container, places it before the given anchor.
|
EventListener |
onAttributeModified(EventHandler<AttributeModified> eventListener)
Fired when `Element`'s attribute is modified.
|
EventListener |
onAttributeRemoved(EventHandler<AttributeRemoved> eventListener)
Fired when `Element`'s attribute is removed.
|
EventListener |
onCharacterDataModified(EventHandler<CharacterDataModified> eventListener)
Mirrors `DOMCharacterDataModified` event.
|
EventListener |
onChildNodeCountUpdated(EventHandler<ChildNodeCountUpdated> eventListener)
Fired when `Container`'s child node count has changed.
|
EventListener |
onChildNodeInserted(EventHandler<ChildNodeInserted> eventListener)
Mirrors `DOMNodeInserted` event.
|
EventListener |
onChildNodeRemoved(EventHandler<ChildNodeRemoved> eventListener)
Mirrors `DOMNodeRemoved` event.
|
EventListener |
onDistributedNodesUpdated(EventHandler<DistributedNodesUpdated> eventListener)
Called when distrubution is changed.
|
EventListener |
onDocumentUpdated(EventHandler<DocumentUpdated> eventListener)
Fired when `Document` has been totally updated.
|
EventListener |
onInlineStyleInvalidated(EventHandler<InlineStyleInvalidated> eventListener)
Fired when `Element`'s inline style is modified via a CSS property modification.
|
EventListener |
onPseudoElementAdded(EventHandler<PseudoElementAdded> eventListener)
Called when a pseudo element is added to an element.
|
EventListener |
onPseudoElementRemoved(EventHandler<PseudoElementRemoved> eventListener)
Called when a pseudo element is removed from an element.
|
EventListener |
onSetChildNodes(EventHandler<SetChildNodes> eventListener)
Fired when backend wants to provide client with the missing DOM structure.
|
EventListener |
onShadowRootPopped(EventHandler<ShadowRootPopped> eventListener)
Called when shadow root is popped from the element.
|
EventListener |
onShadowRootPushed(EventHandler<ShadowRootPushed> eventListener)
Called when shadow root is pushed into the element.
|
PerformSearch |
performSearch(String query)
Searches for a given string in the DOM tree.
|
PerformSearch |
performSearch(String query,
Boolean includeUserAgentShadowDOM)
Searches for a given string in the DOM tree.
|
Integer |
pushNodeByPathToFrontend(String path)
Requests that the node is sent to the caller given its path.
|
List<Integer> |
pushNodesByBackendIdsToFrontend(List<Integer> backendNodeIds)
Requests that a batch of nodes is sent to the caller given their backend node ids.
|
Integer |
querySelector(Integer nodeId,
String selector)
Executes `querySelector` on a given node.
|
List<Integer> |
querySelectorAll(Integer nodeId,
String selector)
Executes `querySelectorAll` on a given node.
|
void |
redo()
Re-does the last undone action.
|
void |
removeAttribute(Integer nodeId,
String name)
Removes attribute with given name from an element with given id.
|
void |
removeNode(Integer nodeId)
Removes node with given id.
|
void |
requestChildNodes(Integer nodeId)
Requests that children of the node with given id are returned to the caller in form of
`setChildNodes` events where not only immediate children are retrieved, but all children down
to the specified depth.
|
void |
requestChildNodes(Integer nodeId,
Integer depth,
Boolean pierce)
Requests that children of the node with given id are returned to the caller in form of
`setChildNodes` events where not only immediate children are retrieved, but all children down
to the specified depth.
|
Integer |
requestNode(String objectId)
Requests that the node is sent to the caller given the JavaScript node object reference.
|
RemoteObject |
resolveNode()
Resolves the JavaScript node object for a given NodeId or BackendNodeId.
|
RemoteObject |
resolveNode(Integer nodeId,
Integer backendNodeId,
String objectGroup,
Integer executionContextId)
Resolves the JavaScript node object for a given NodeId or BackendNodeId.
|
void |
setAttributesAsText(Integer nodeId,
String text)
Sets attributes on element with given id.
|
void |
setAttributesAsText(Integer nodeId,
String text,
String name)
Sets attributes on element with given id.
|
void |
setAttributeValue(Integer nodeId,
String name,
String value)
Sets attribute for an element with given id.
|
void |
setFileInputFiles(List<String> files)
Sets files for the given file input element.
|
void |
setFileInputFiles(List<String> files,
Integer nodeId,
Integer backendNodeId,
String objectId)
Sets files for the given file input element.
|
void |
setInspectedNode(Integer nodeId)
Enables console to refer to the node with given id via $x (see Command Line API for more
details $x functions).
|
Integer |
setNodeName(Integer nodeId,
String name)
Sets node name for a node with given id.
|
void |
setNodeStackTracesEnabled(Boolean enable)
Sets if stack traces should be captured for Nodes.
|
void |
setNodeValue(Integer nodeId,
String value)
Sets node value for a node with given id.
|
void |
setOuterHTML(Integer nodeId,
String outerHTML)
Sets node HTML markup, returns new node id.
|
void |
undo()
Undoes the last performed action.
|
List<String> collectClassNamesFromSubtree(Integer nodeId)
nodeId - Id of the node to collect class names.Integer copyTo(Integer nodeId, Integer targetNodeId)
nodeId - Id of the node to copy.targetNodeId - Id of the element to drop the copy into.Integer copyTo(Integer nodeId, Integer targetNodeId, Integer insertBeforeNodeId)
nodeId - Id of the node to copy.targetNodeId - Id of the element to drop the copy into.insertBeforeNodeId - Drop the copy before this node (if absent, the copy becomes the last
child of `targetNodeId`).Node describeNode()
Node describeNode(Integer nodeId, Integer backendNodeId, String objectId, Integer depth, Boolean pierce)
nodeId - Identifier of the node.backendNodeId - Identifier of the backend node.objectId - JavaScript object id of the node wrapper.depth - The maximum depth at which children should be retrieved, defaults to 1. Use -1 for
the entire subtree or provide an integer larger than 0.pierce - Whether or not iframes and shadow roots should be traversed when returning the
subtree (default is false).void disable()
void discardSearchResults(String searchId)
searchId - Unique search session identifier.void enable()
void focus()
void focus(Integer nodeId, Integer backendNodeId, String objectId)
nodeId - Identifier of the node.backendNodeId - Identifier of the backend node.objectId - JavaScript object id of the node wrapper.List<String> getAttributes(Integer nodeId)
nodeId - Id of the node to retrieve attibutes for.BoxModel getBoxModel()
BoxModel getBoxModel(Integer nodeId, Integer backendNodeId, String objectId)
nodeId - Identifier of the node.backendNodeId - Identifier of the backend node.objectId - JavaScript object id of the node wrapper.List<List<Double>> getContentQuads()
List<List<Double>> getContentQuads(Integer nodeId, Integer backendNodeId, String objectId)
nodeId - Identifier of the node.backendNodeId - Identifier of the backend node.objectId - JavaScript object id of the node wrapper.Node getDocument()
Node getDocument(Integer depth, Boolean pierce)
depth - The maximum depth at which children should be retrieved, defaults to 1. Use -1 for
the entire subtree or provide an integer larger than 0.pierce - Whether or not iframes and shadow roots should be traversed when returning the
subtree (default is false).List<Node> getFlattenedDocument()
List<Node> getFlattenedDocument(Integer depth, Boolean pierce)
depth - The maximum depth at which children should be retrieved, defaults to 1. Use -1 for
the entire subtree or provide an integer larger than 0.pierce - Whether or not iframes and shadow roots should be traversed when returning the
subtree (default is false).NodeForLocation getNodeForLocation(Integer x, Integer y)
x - X coordinate.y - Y coordinate.NodeForLocation getNodeForLocation(Integer x, Integer y, Boolean includeUserAgentShadowDOM)
x - X coordinate.y - Y coordinate.includeUserAgentShadowDOM - False to skip to the nearest non-UA shadow root ancestor
(default: false).String getOuterHTML()
String getOuterHTML(Integer nodeId, Integer backendNodeId, String objectId)
nodeId - Identifier of the node.backendNodeId - Identifier of the backend node.objectId - JavaScript object id of the node wrapper.Integer getRelayoutBoundary(Integer nodeId)
nodeId - Id of the node.List<Integer> getSearchResults(String searchId, Integer fromIndex, Integer toIndex)
searchId - Unique search session identifier.fromIndex - Start index of the search result to be returned.toIndex - End index of the search result to be returned.void markUndoableState()
Integer moveTo(Integer nodeId, Integer targetNodeId)
nodeId - Id of the node to move.targetNodeId - Id of the element to drop the moved node into.Integer moveTo(Integer nodeId, Integer targetNodeId, Integer insertBeforeNodeId)
nodeId - Id of the node to move.targetNodeId - Id of the element to drop the moved node into.insertBeforeNodeId - Drop node before this one (if absent, the moved node becomes the last
child of `targetNodeId`).PerformSearch performSearch(String query)
query - Plain text or query selector or XPath search query.PerformSearch performSearch(String query, Boolean includeUserAgentShadowDOM)
query - Plain text or query selector or XPath search query.includeUserAgentShadowDOM - True to search in user agent shadow DOM.Integer pushNodeByPathToFrontend(String path)
path - Path to node in the proprietary format.List<Integer> pushNodesByBackendIdsToFrontend(List<Integer> backendNodeIds)
backendNodeIds - The array of backend node ids.Integer querySelector(Integer nodeId, String selector)
nodeId - Id of the node to query upon.selector - Selector string.List<Integer> querySelectorAll(Integer nodeId, String selector)
nodeId - Id of the node to query upon.selector - Selector string.void redo()
void removeAttribute(Integer nodeId, String name)
nodeId - Id of the element to remove attribute from.name - Name of the attribute to remove.void removeNode(Integer nodeId)
nodeId - Id of the node to remove.void requestChildNodes(Integer nodeId)
nodeId - Id of the node to get children for.void requestChildNodes(Integer nodeId, Integer depth, Boolean pierce)
nodeId - Id of the node to get children for.depth - The maximum depth at which children should be retrieved, defaults to 1. Use -1 for
the entire subtree or provide an integer larger than 0.pierce - Whether or not iframes and shadow roots should be traversed when returning the
sub-tree (default is false).Integer requestNode(String objectId)
objectId - JavaScript object id to convert into node.RemoteObject resolveNode()
RemoteObject resolveNode(Integer nodeId, Integer backendNodeId, String objectGroup, Integer executionContextId)
nodeId - Id of the node to resolve.backendNodeId - Backend identifier of the node to resolve.objectGroup - Symbolic group name that can be used to release multiple objects.executionContextId - Execution context in which to resolve the node.void setAttributeValue(Integer nodeId, String name, String value)
nodeId - Id of the element to set attribute for.name - Attribute name.value - Attribute value.void setAttributesAsText(Integer nodeId, String text)
nodeId - Id of the element to set attributes for.text - Text with a number of attributes. Will parse this text using HTML parser.void setAttributesAsText(Integer nodeId, String text, String name)
nodeId - Id of the element to set attributes for.text - Text with a number of attributes. Will parse this text using HTML parser.name - Attribute name to replace with new attributes derived from text in case text parsed
successfully.void setFileInputFiles(List<String> files)
files - Array of file paths to set.void setFileInputFiles(List<String> files, Integer nodeId, Integer backendNodeId, String objectId)
files - Array of file paths to set.nodeId - Identifier of the node.backendNodeId - Identifier of the backend node.objectId - JavaScript object id of the node wrapper.void setNodeStackTracesEnabled(Boolean enable)
enable - Enable or disable.StackTrace getNodeStackTraces(Integer nodeId)
nodeId - Id of the node to get stack traces for.String getFileInfo(String objectId)
objectId - JavaScript object id of the node wrapper.void setInspectedNode(Integer nodeId)
nodeId - DOM node id to be accessible by means of $x command line API.Integer setNodeName(Integer nodeId, String name)
nodeId - Id of the node to set name for.name - New node's name.void setNodeValue(Integer nodeId, String value)
nodeId - Id of the node to set value for.value - New node's value.void setOuterHTML(Integer nodeId, String outerHTML)
nodeId - Id of the node to set markup for.outerHTML - Outer HTML markup to set.void undo()
FrameOwner getFrameOwner(String frameId)
frameId - EventListener onAttributeModified(EventHandler<AttributeModified> eventListener)
EventListener onAttributeRemoved(EventHandler<AttributeRemoved> eventListener)
EventListener onCharacterDataModified(EventHandler<CharacterDataModified> eventListener)
EventListener onChildNodeCountUpdated(EventHandler<ChildNodeCountUpdated> eventListener)
EventListener onChildNodeInserted(EventHandler<ChildNodeInserted> eventListener)
EventListener onChildNodeRemoved(EventHandler<ChildNodeRemoved> eventListener)
EventListener onDistributedNodesUpdated(EventHandler<DistributedNodesUpdated> eventListener)
EventListener onDocumentUpdated(EventHandler<DocumentUpdated> eventListener)
EventListener onInlineStyleInvalidated(EventHandler<InlineStyleInvalidated> eventListener)
EventListener onPseudoElementAdded(EventHandler<PseudoElementAdded> eventListener)
EventListener onPseudoElementRemoved(EventHandler<PseudoElementRemoved> eventListener)
EventListener onSetChildNodes(EventHandler<SetChildNodes> eventListener)
EventListener onShadowRootPopped(EventHandler<ShadowRootPopped> eventListener)
EventListener onShadowRootPushed(EventHandler<ShadowRootPushed> eventListener)
Copyright © 2020. All rights reserved.