Interface DOMSnapshot

All Known Implementing Classes:
DOMSnapshotImpl

public interface DOMSnapshot
This domain facilitates obtaining document snapshots with DOM, layout, and style information
  • Method Summary

    Modifier and Type Method Description
    CaptureSnapshotResult captureSnapshot​(java.util.List<java.lang.String> computedStyles)
    Returns a document snapshot, including the full DOM tree of the root node (including iframes, template contents, and imported documents) in a flattened array, as well as layout and white-listed computed style information for the nodes.
    CaptureSnapshotResult captureSnapshot​(java.util.List<java.lang.String> computedStyles, java.lang.Boolean includePaintOrder, java.lang.Boolean includeDOMRects)
    Returns a document snapshot, including the full DOM tree of the root node (including iframes, template contents, and imported documents) in a flattened array, as well as layout and white-listed computed style information for the nodes.
    void disable()
    Disables DOM snapshot agent for the given page.
    void enable()
    Enables DOM snapshot agent for the given page.
    GetSnapshotResult getSnapshot​(java.util.List<java.lang.String> computedStyleWhitelist)
    Returns a document snapshot, including the full DOM tree of the root node (including iframes, template contents, and imported documents) in a flattened array, as well as layout and white-listed computed style information for the nodes.
    GetSnapshotResult getSnapshot​(java.util.List<java.lang.String> computedStyleWhitelist, java.lang.Boolean includeEventListeners, java.lang.Boolean includePaintOrder, java.lang.Boolean includeUserAgentShadowTree)
    Returns a document snapshot, including the full DOM tree of the root node (including iframes, template contents, and imported documents) in a flattened array, as well as layout and white-listed computed style information for the nodes.
  • Method Details

    • disable

      void disable()
      Disables DOM snapshot agent for the given page.
    • enable

      void enable()
      Enables DOM snapshot agent for the given page.
    • getSnapshot

      GetSnapshotResult getSnapshot​(java.util.List<java.lang.String> computedStyleWhitelist, java.lang.Boolean includeEventListeners, java.lang.Boolean includePaintOrder, java.lang.Boolean includeUserAgentShadowTree)
      Returns a document snapshot, including the full DOM tree of the root node (including iframes, template contents, and imported documents) in a flattened array, as well as layout and white-listed computed style information for the nodes. Shadow DOM in the returned DOM tree is flattened.
      Parameters:
      computedStyleWhitelist - Whitelist of computed styles to return.
      includeEventListeners - Whether or not to retrieve details of DOM listeners (default false).
      includePaintOrder - Whether to determine and include the paint order index of LayoutTreeNodes (default false).
      includeUserAgentShadowTree - Whether to include UA shadow tree in the snapshot (default false).
      Returns:
      GetSnapshotResult
    • captureSnapshot

      CaptureSnapshotResult captureSnapshot​(java.util.List<java.lang.String> computedStyles, java.lang.Boolean includePaintOrder, java.lang.Boolean includeDOMRects)
      Returns a document snapshot, including the full DOM tree of the root node (including iframes, template contents, and imported documents) in a flattened array, as well as layout and white-listed computed style information for the nodes. Shadow DOM in the returned DOM tree is flattened.
      Parameters:
      computedStyles - Whitelist of computed styles to return.
      includePaintOrder - Whether to include layout object paint orders into the snapshot.
      includeDOMRects - Whether to include DOM rectangles (offsetRects, clientRects, scrollRects) into the snapshot
      Returns:
      CaptureSnapshotResult
    • getSnapshot

      GetSnapshotResult getSnapshot​(java.util.List<java.lang.String> computedStyleWhitelist)
      Returns a document snapshot, including the full DOM tree of the root node (including iframes, template contents, and imported documents) in a flattened array, as well as layout and white-listed computed style information for the nodes. Shadow DOM in the returned DOM tree is flattened.
      Parameters:
      computedStyleWhitelist - Whitelist of computed styles to return.
      Returns:
      GetSnapshotResult
    • captureSnapshot

      CaptureSnapshotResult captureSnapshot​(java.util.List<java.lang.String> computedStyles)
      Returns a document snapshot, including the full DOM tree of the root node (including iframes, template contents, and imported documents) in a flattened array, as well as layout and white-listed computed style information for the nodes. Shadow DOM in the returned DOM tree is flattened.
      Parameters:
      computedStyles - Whitelist of computed styles to return.
      Returns:
      CaptureSnapshotResult