Hide navigation sidebar
Hide table of contents sidebar
Back to top
Toggle table of contents sidebar

# Overlay

This domain provides various functionality related to drawing atop the inspected page.

This CDP domain is experimental.

- Types

- Commands

- Events

## Types

Generally, you do not need to instantiate CDP types yourself. Instead, the API creates objects for you as return values from commands, and then you can use those objects as arguments to other commands.

class SourceOrderConfig(parent_outline_color, child_outline_color)

  Configuration data for drawing the source order of an elements children.

  parent_outline_color: `RGBA`

    the color to outline the given element in.

  child_outline_color: `RGBA`

    the color to outline the child elements in.

class GridHighlightConfig(show_grid_extension_lines=None, show_positive_line_numbers=None, show_negative_line_numbers=None, show_area_names=None, show_line_names=None, show_track_sizes=None, grid_border_color=None, cell_border_color=None, row_line_color=None, column_line_color=None, grid_border_dash=None, cell_border_dash=None, row_line_dash=None, column_line_dash=None, row_gap_color=None, row_hatch_color=None, column_gap_color=None, column_hatch_color=None, area_border_color=None, grid_background_color=None)

  Configuration data for the highlighting of Grid elements.

  show_grid_extension_lines: `Optional`[`bool`] = None

    false).

    Type:

      Whether the extension lines from grid cells to the rulers should be shown (default

  show_positive_line_numbers: `Optional`[`bool`] = None

    false).

    Type:

      Show Positive line number labels (default

  show_negative_line_numbers: `Optional`[`bool`] = None

    false).

    Type:

      Show Negative line number labels (default

  show_area_names: `Optional`[`bool`] = None

    false).

    Type:

      Show area name labels (default

  show_line_names: `Optional`[`bool`] = None

    false).

    Type:

      Show line name labels (default

  show_track_sizes: `Optional`[`bool`] = None

    false).

    Type:

      Show track size labels (default

  grid_border_color: `Optional`[`RGBA`] = None

    transparent).

    Type:

      The grid container border highlight color (default

  cell_border_color: `Optional`[`RGBA`] = None

    transparent). Deprecated, please use rowLineColor and columnLineColor instead.

    Type:

      The cell border color (default

  row_line_color: `Optional`[`RGBA`] = None

    transparent).

    Type:

      The row line color (default

  column_line_color: `Optional`[`RGBA`] = None

    transparent).

    Type:

      The column line color (default

  grid_border_dash: `Optional`[`bool`] = None

    false).

    Type:

      Whether the grid border is dashed (default

  cell_border_dash: `Optional`[`bool`] = None

    false). Deprecated, please us rowLineDash and columnLineDash instead.

    Type:

      Whether the cell border is dashed (default

  row_line_dash: `Optional`[`bool`] = None

    false).

    Type:

      Whether row lines are dashed (default

  column_line_dash: `Optional`[`bool`] = None

    false).

    Type:

      Whether column lines are dashed (default

  row_gap_color: `Optional`[`RGBA`] = None

    transparent).

    Type:

      The row gap highlight fill color (default

  row_hatch_color: `Optional`[`RGBA`] = None

    transparent).

    Type:

      The row gap hatching fill color (default

  column_gap_color: `Optional`[`RGBA`] = None

    transparent).

    Type:

      The column gap highlight fill color (default

  column_hatch_color: `Optional`[`RGBA`] = None

    transparent).

    Type:

      The column gap hatching fill color (default

  area_border_color: `Optional`[`RGBA`] = None

    transparent).

    Type:

      The named grid areas border color (Default

  grid_background_color: `Optional`[`RGBA`] = None

    transparent).

    Type:

      The grid container background color (Default

class FlexContainerHighlightConfig(container_border=None, line_separator=None, item_separator=None, main_distributed_space=None, cross_distributed_space=None, row_gap_space=None, column_gap_space=None, cross_alignment=None)

  Configuration data for the highlighting of Flex container elements.

  container_border: `Optional`[`LineStyle`] = None

    The style of the container border

  line_separator: `Optional`[`LineStyle`] = None

    The style of the separator between lines

  item_separator: `Optional`[`LineStyle`] = None

    The style of the separator between items

  main_distributed_space: `Optional`[`BoxStyle`] = None

    Style of content-distribution space on the main axis (justify-content).

  cross_distributed_space: `Optional`[`BoxStyle`] = None

    Style of content-distribution space on the cross axis (align-content).

  row_gap_space: `Optional`[`BoxStyle`] = None

    Style of empty space caused by row gaps (gap/row-gap).

  column_gap_space: `Optional`[`BoxStyle`] = None

    Style of empty space caused by columns gaps (gap/column-gap).

  cross_alignment: `Optional`[`LineStyle`] = None

    Style of the self-alignment line (align-items).

class FlexItemHighlightConfig(base_size_box=None, base_size_border=None, flexibility_arrow=None)

  Configuration data for the highlighting of Flex item elements.

  base_size_box: `Optional`[`BoxStyle`] = None

    Style of the box representing the item’s base size

  base_size_border: `Optional`[`LineStyle`] = None

    Style of the border around the box representing the item’s base size

  flexibility_arrow: `Optional`[`LineStyle`] = None

    Style of the arrow representing if the item grew or shrank

class LineStyle(color=None, pattern=None)

  Style information for drawing a line.

  color: `Optional`[`RGBA`] = None

    transparent)

    Type:

      The color of the line (default

  pattern: `Optional`[`str`] = None

    solid)

    Type:

      The line pattern (default

class BoxStyle(fill_color=None, hatch_color=None)

  Style information for drawing a box.

  fill_color: `Optional`[`RGBA`] = None

    transparent)

    Type:

      The background color for the box (default

  hatch_color: `Optional`[`RGBA`] = None

    transparent)

    Type:

      The hatching color for the box (default

class ContrastAlgorithm(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
  AA = 'aa'
  AAA = 'aaa'
  APCA = 'apca'

class HighlightConfig(show_info=None, show_styles=None, show_rulers=None, show_accessibility_info=None, show_extension_lines=None, content_color=None, padding_color=None, border_color=None, margin_color=None, event_target_color=None, shape_color=None, shape_margin_color=None, css_grid_color=None, color_format=None, grid_highlight_config=None, flex_container_highlight_config=None, flex_item_highlight_config=None, contrast_algorithm=None, container_query_container_highlight_config=None)

  Configuration data for the highlighting of page elements.

  show_info: `Optional`[`bool`] = None

    false).

    Type:

      Whether the node info tooltip should be shown (default

  show_styles: `Optional`[`bool`] = None

    false).

    Type:

      Whether the node styles in the tooltip (default

  show_rulers: `Optional`[`bool`] = None

    false).

    Type:

      Whether the rulers should be shown (default

  show_accessibility_info: `Optional`[`bool`] = None

    true).

    Type:

      Whether the a11y info should be shown (default

  show_extension_lines: `Optional`[`bool`] = None

    false).

    Type:

      Whether the extension lines from node to the rulers should be shown (default

  content_color: `Optional`[`RGBA`] = None

    transparent).

    Type:

      The content box highlight fill color (default

  padding_color: `Optional`[`RGBA`] = None

    transparent).

    Type:

      The padding highlight fill color (default

  border_color: `Optional`[`RGBA`] = None

    transparent).

    Type:

      The border highlight fill color (default

  margin_color: `Optional`[`RGBA`] = None

    transparent).

    Type:

      The margin highlight fill color (default

  event_target_color: `Optional`[`RGBA`] = None

    transparent).

    Type:

      The event target element highlight fill color (default

  shape_color: `Optional`[`RGBA`] = None

    transparent).

    Type:

      The shape outside fill color (default

  shape_margin_color: `Optional`[`RGBA`] = None

    transparent).

    Type:

      The shape margin fill color (default

  css_grid_color: `Optional`[`RGBA`] = None

    transparent).

    Type:

      The grid layout color (default

  color_format: `Optional`[`ColorFormat`] = None

    hex).

    Type:

      The color format used to format color styles (default

  grid_highlight_config: `Optional`[`GridHighlightConfig`] = None

    all transparent).

    Type:

      The grid layout highlight configuration (default

  flex_container_highlight_config: `Optional`[`FlexContainerHighlightConfig`] = None

    all transparent).

    Type:

      The flex container highlight configuration (default

  flex_item_highlight_config: `Optional`[`FlexItemHighlightConfig`] = None

    all transparent).

    Type:

      The flex item highlight configuration (default

  contrast_algorithm: `Optional`[`ContrastAlgorithm`] = None

    aa).

    Type:

      The contrast algorithm to use for the contrast ratio (default

  container_query_container_highlight_config: `Optional`[`ContainerQueryContainerHighlightConfig`] = None

    all transparent).

    Type:

      The container query container highlight configuration (default

class ColorFormat(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
  RGB = 'rgb'
  HSL = 'hsl'
  HWB = 'hwb'
  HEX_ = 'hex'

class GridNodeHighlightConfig(grid_highlight_config, node_id)

  Configurations for Persistent Grid Highlight

  grid_highlight_config: `GridHighlightConfig`

    A descriptor for the highlight appearance.

  node_id: `NodeId`

    Identifier of the node to highlight.

class FlexNodeHighlightConfig(flex_container_highlight_config, node_id)
  flex_container_highlight_config: `FlexContainerHighlightConfig`

    A descriptor for the highlight appearance of flex containers.

  node_id: `NodeId`

    Identifier of the node to highlight.

class ScrollSnapContainerHighlightConfig(snapport_border=None, snap_area_border=None, scroll_margin_color=None, scroll_padding_color=None)
  snapport_border: `Optional`[`LineStyle`] = None

    transparent)

    Type:

      The style of the snapport border (default

  snap_area_border: `Optional`[`LineStyle`] = None

    transparent)

    Type:

      The style of the snap area border (default

  scroll_margin_color: `Optional`[`RGBA`] = None

    transparent).

    Type:

      The margin highlight fill color (default

  scroll_padding_color: `Optional`[`RGBA`] = None

    transparent).

    Type:

      The padding highlight fill color (default

class ScrollSnapHighlightConfig(scroll_snap_container_highlight_config, node_id)
  scroll_snap_container_highlight_config: `ScrollSnapContainerHighlightConfig`

    A descriptor for the highlight appearance of scroll snap containers.

  node_id: `NodeId`

    Identifier of the node to highlight.

class HingeConfig(rect, content_color=None, outline_color=None)

  Configuration for dual screen hinge

  rect: `Rect`

    A rectangle represent hinge

  content_color: `Optional`[`RGBA`] = None

    a dark color).

    Type:

      The content box highlight fill color (default

  outline_color: `Optional`[`RGBA`] = None

    transparent).

    Type:

      The content box highlight outline color (default

class WindowControlsOverlayConfig(show_css, selected_platform, theme_color)

  Configuration for Window Controls Overlay

  show_css: `bool`

    Whether the title bar CSS should be shown when emulating the Window Controls Overlay.

  selected_platform: `str`

    Selected platforms to show the overlay.

  theme_color: `str`

    The theme color defined in app manifest.

class ContainerQueryHighlightConfig(container_query_container_highlight_config, node_id)
  container_query_container_highlight_config: `ContainerQueryContainerHighlightConfig`

    A descriptor for the highlight appearance of container query containers.

  node_id: `NodeId`

    Identifier of the container node to highlight.

class ContainerQueryContainerHighlightConfig(container_border=None, descendant_border=None)
  container_border: `Optional`[`LineStyle`] = None

    The style of the container border.

  descendant_border: `Optional`[`LineStyle`] = None

    The style of the descendants’ borders.

class IsolatedElementHighlightConfig(isolation_mode_highlight_config, node_id)
  isolation_mode_highlight_config: `IsolationModeHighlightConfig`

    A descriptor for the highlight appearance of an element in isolation mode.

  node_id: `NodeId`

    Identifier of the isolated element to highlight.

class IsolationModeHighlightConfig(resizer_color=None, resizer_handle_color=None, mask_color=None)
  resizer_color: `Optional`[`RGBA`] = None

    transparent).

    Type:

      The fill color of the resizers (default

  resizer_handle_color: `Optional`[`RGBA`] = None

    transparent).

    Type:

      The fill color for resizer handles (default

  mask_color: `Optional`[`RGBA`] = None

    transparent).

    Type:

      The fill color for the mask covering non-isolated elements (default

class InspectMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
  SEARCH_FOR_NODE = 'searchForNode'
  SEARCH_FOR_UA_SHADOW_DOM = 'searchForUAShadowDOM'
  CAPTURE_AREA_SCREENSHOT = 'captureAreaScreenshot'
  NONE = 'none'

## Commands

Each command is a generator function. The return type `Generator[x, y, z]` indicates that the generator yields arguments of type `x`, it must be resumed with an argument of type `y`, and it returns type `z`. In this library, types `x` and `y` are the same for all commands, and `z` is the return type you should pay attention to. For more information, see Getting Started: Commands.

disable()

  Disables domain notifications.

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

enable()

  Enables domain notifications.

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

get_grid_highlight_objects_for_test(node_ids)

  For Persistent Grid testing.

  Parameters:

    node_ids (`List`[`NodeId`]) – Ids of the node to get highlight object for.

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `dict`]

  Returns:

    Grid Highlight data for the node ids provided.

get_highlight_object_for_test(node_id, include_distance=None, include_style=None, color_format=None, show_accessibility_info=None)

  For testing.

  Parameters:

    - node_id (`NodeId`) – Id of the node to get highlight object for.

    - include_distance (`Optional`[`bool`]) – (Optional) Whether to include distance info.

    - include_style (`Optional`[`bool`]) – (Optional) Whether to include style info.

    - color_format (`Optional`[`ColorFormat`]) – (Optional) The color format to get config with (default: hex).

    - show_accessibility_info (`Optional`[`bool`]) – (Optional) Whether to show accessibility info (default: true).

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `dict`]

  Returns:

    Highlight data for the node.

get_source_order_highlight_object_for_test(node_id)

  For Source Order Viewer testing.

  Parameters:

    node_id (`NodeId`) – Id of the node to highlight.

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `dict`]

  Returns:

    Source order highlight data for the node id provided.

hide_highlight()

  Hides any highlight.

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

highlight_frame(frame_id, content_color=None, content_outline_color=None)

  Highlights owner element of the frame with given id. Deprecated: Doesn’t work reliably and cannot be fixed due to process separation (the owner node might be in a different process). Determine the owner node in the client and use highlightNode.

  Deprecated since version 1.3.

  Parameters:

    - frame_id (`FrameId`) – Identifier of the frame to highlight.

    - content_color (`Optional`[`RGBA`]) – (Optional) The content box highlight fill color (default: transparent).

    - content_outline_color (`Optional`[`RGBA`]) – (Optional) The content box highlight outline color (default: transparent).

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

  Deprecated since version 1.3.

highlight_node(highlight_config, node_id=None, backend_node_id=None, object_id=None, selector=None)

  Highlights DOM node with given id or with the given JavaScript object wrapper. Either nodeId or objectId must be specified.

  Parameters:

    - highlight_config (`HighlightConfig`) – A descriptor for the highlight appearance.

    - node_id (`Optional`[`NodeId`]) – (Optional) Identifier of the node to highlight.

    - backend_node_id (`Optional`[`BackendNodeId`]) – (Optional) Identifier of the backend node to highlight.

    - object_id (`Optional`[`RemoteObjectId`]) – (Optional) JavaScript object id of the node to be highlighted.

    - selector (`Optional`[`str`]) – (Optional) Selectors to highlight relevant nodes.

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

highlight_quad(quad, color=None, outline_color=None)

  Highlights given quad. Coordinates are absolute with respect to the main frame viewport.

  Parameters:

    - quad (`Quad`) – Quad to highlight

    - color (`Optional`[`RGBA`]) – (Optional) The highlight fill color (default: transparent).

    - outline_color (`Optional`[`RGBA`]) – (Optional) The highlight outline color (default: transparent).

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

highlight_rect(x, y, width, height, color=None, outline_color=None)

  Highlights given rectangle. Coordinates are absolute with respect to the main frame viewport. Issue: the method does not handle device pixel ratio (DPR) correctly. The coordinates currently have to be adjusted by the client if DPR is not 1 (see crbug.com/437807128).

  Parameters:

    - x (`int`) – X coordinate

    - y (`int`) – Y coordinate

    - width (`int`) – Rectangle width

    - height (`int`) – Rectangle height

    - color (`Optional`[`RGBA`]) – (Optional) The highlight fill color (default: transparent).

    - outline_color (`Optional`[`RGBA`]) – (Optional) The highlight outline color (default: transparent).

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

highlight_source_order(source_order_config, node_id=None, backend_node_id=None, object_id=None)

  Highlights the source order of the children of the DOM node with given id or with the given JavaScript object wrapper. Either nodeId or objectId must be specified.

  Parameters:

    - source_order_config (`SourceOrderConfig`) – A descriptor for the appearance of the overlay drawing.

    - node_id (`Optional`[`NodeId`]) – (Optional) Identifier of the node to highlight.

    - backend_node_id (`Optional`[`BackendNodeId`]) – (Optional) Identifier of the backend node to highlight.

    - object_id (`Optional`[`RemoteObjectId`]) – (Optional) JavaScript object id of the node to be highlighted.

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

set_inspect_mode(mode, highlight_config=None)

  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 (`InspectMode`) – Set an inspection mode.

    - highlight_config (`Optional`[`HighlightConfig`]) – (Optional) A descriptor for the highlight appearance of hovered-over nodes. May be omitted if ``enabled == false``.

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

set_paused_in_debugger_message(message=None)
  Parameters:

    message (`Optional`[`str`]) – (Optional) The message to display, also triggers resume and step over controls.

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

set_show_ad_highlights(show)

  Highlights owner element of all frames detected to be ads.

  Parameters:

    show (`bool`) – True for showing ad highlights

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

set_show_container_query_overlays(container_query_highlight_configs)
  Parameters:

    container_query_highlight_configs (`List`[`ContainerQueryHighlightConfig`]) – An array of node identifiers and descriptors for the highlight appearance.

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

set_show_debug_borders(show)

  Requests that backend shows debug borders on layers

  Parameters:

    show (`bool`) – True for showing debug borders

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

set_show_flex_overlays(flex_node_highlight_configs)
  Parameters:

    flex_node_highlight_configs (`List`[`FlexNodeHighlightConfig`]) – An array of node identifiers and descriptors for the highlight appearance.

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

set_show_fps_counter(show)

  Requests that backend shows the FPS counter

  Parameters:

    show (`bool`) – True for showing the FPS counter

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

set_show_grid_overlays(grid_node_highlight_configs)

  Highlight multiple elements with the CSS Grid overlay.

  Parameters:

    grid_node_highlight_configs (`List`[`GridNodeHighlightConfig`]) – An array of node identifiers and descriptors for the highlight appearance.

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

set_show_hinge(hinge_config=None)

  Add a dual screen device hinge

  Parameters:

    hinge_config (`Optional`[`HingeConfig`]) – (Optional) hinge data, null means hideHinge

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

set_show_hit_test_borders(show)

  Deprecated, no longer has any effect.

  Deprecated since version 1.3.

  Parameters:

    show (`bool`) – True for showing hit-test borders

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

  Deprecated since version 1.3.

set_show_isolated_elements(isolated_element_highlight_configs)

  Show elements in isolation mode with overlays.

  Parameters:

    isolated_element_highlight_configs (`List`[`IsolatedElementHighlightConfig`]) – An array of node identifiers and descriptors for the highlight appearance.

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

set_show_layout_shift_regions(result)

  Requests that backend shows layout shift regions

  Parameters:

    result (`bool`) – True for showing layout shift regions

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

set_show_paint_rects(result)

  Requests that backend shows paint rectangles

  Parameters:

    result (`bool`) – True for showing paint rectangles

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

set_show_scroll_bottleneck_rects(show)

  Requests that backend shows scroll bottleneck rects

  Parameters:

    show (`bool`) – True for showing scroll bottleneck rects

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

set_show_scroll_snap_overlays(scroll_snap_highlight_configs)
  Parameters:

    scroll_snap_highlight_configs (`List`[`ScrollSnapHighlightConfig`]) – An array of node identifiers and descriptors for the highlight appearance.

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

set_show_viewport_size_on_resize(show)

  Paints viewport size upon main frame resize.

  Parameters:

    show (`bool`) – Whether to paint size or not.

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

set_show_web_vitals(show)

  Deprecated, no longer has any effect.

  Deprecated since version 1.3.

  Parameters:

    show (`bool`) –

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

  Deprecated since version 1.3.

set_show_window_controls_overlay(window_controls_overlay_config=None)

  Show Window Controls Overlay for PWA

  Parameters:

    window_controls_overlay_config (`Optional`[`WindowControlsOverlayConfig`]) – (Optional) Window Controls Overlay data, null means hide Window Controls Overlay

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

## Events

Generally, you do not need to instantiate CDP events yourself. Instead, the API creates events for you and then you use the event’s attributes.

class InspectNodeRequested(backend_node_id)

  Fired when the node should be inspected. This happens after call to `setInspectMode` or when user manually inspects an element.

  backend_node_id: `BackendNodeId`

    Id of the node to inspect.

class NodeHighlightRequested(node_id)

  Fired when the node should be highlighted. This happens after call to `setInspectMode`.

  node_id: `NodeId`

class ScreenshotRequested(viewport)

  Fired when user asks to capture screenshot of some area on the page.

  viewport: `Viewport`

    Viewport to capture, in device independent pixels (dip).

class InspectModeCanceled

  Fired when user cancels the inspect mode.