Tungsten

v0.1.0

Tungsten v0.1.0 Tungsten.CDP.Overlay View Source

Overlay

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

Link to this section Summary

Types

cdp_highlight_config_type()

Overlay.HighlightConfig

cdp_inspect_mode_type()

Overlay.InspectMode

Functions

disable(session, parameters \\ %{}, options \\ [])

Overlay.disable

enable(session, parameters \\ %{}, options \\ [])

Overlay.enable

get_highlight_object_for_test(session, parameters, options \\ [])

Overlay.getHighlightObjectForTest

hide_highlight(session, parameters \\ %{}, options \\ [])

Overlay.hideHighlight

highlight_frame(session, parameters, options \\ [])

Overlay.highlightFrame

highlight_node(session, parameters, options \\ [])

Overlay.highlightNode

highlight_quad(session, parameters, options \\ [])

Overlay.highlightQuad

highlight_rect(session, parameters, options \\ [])

Overlay.highlightRect

set_inspect_mode(session, parameters, options \\ [])

Overlay.setInspectMode

set_paused_in_debugger_message(session, parameters \\ %{}, options \\ [])

Overlay.setPausedInDebuggerMessage

set_show_ad_highlights(session, parameters, options \\ [])

Overlay.setShowAdHighlights

set_show_debug_borders(session, parameters, options \\ [])

Overlay.setShowDebugBorders

set_show_fps_counter(session, parameters, options \\ [])

Overlay.setShowFPSCounter

set_show_hit_test_borders(session, parameters, options \\ [])

Overlay.setShowHitTestBorders

set_show_paint_rects(session, parameters, options \\ [])

Overlay.setShowPaintRects

set_show_scroll_bottleneck_rects(session, parameters, options \\ [])

Overlay.setShowScrollBottleneckRects

set_show_viewport_size_on_resize(session, parameters, options \\ [])

Overlay.setShowViewportSizeOnResize

Link to this section Types

Link to this type

cdp_highlight_config_type() View Source 
cdp_highlight_config_type() :: %{
  optional(:show_info) => boolean(),
  optional(:show_styles) => boolean(),
  optional(:show_rulers) => boolean(),
  optional(:show_extension_lines) => boolean(),
  optional(:content_color) => Tungsten.CDP.DOM.cdp_rgba_type(),
  optional(:padding_color) => Tungsten.CDP.DOM.cdp_rgba_type(),
  optional(:border_color) => Tungsten.CDP.DOM.cdp_rgba_type(),
  optional(:margin_color) => Tungsten.CDP.DOM.cdp_rgba_type(),
  optional(:event_target_color) => Tungsten.CDP.DOM.cdp_rgba_type(),
  optional(:shape_color) => Tungsten.CDP.DOM.cdp_rgba_type(),
  optional(:shape_margin_color) => Tungsten.CDP.DOM.cdp_rgba_type(),
  optional(:css_grid_color) => Tungsten.CDP.DOM.cdp_rgba_type()
}

Overlay.HighlightConfig

Configuration data for the highlighting of page elements.

Link to this type

cdp_inspect_mode_type() View Source 
cdp_inspect_mode_type() ::
  :none
  | :show_distances
  | :capture_area_screenshot
  | :search_for_ua_shadow_dom
  | :search_for_node

Overlay.InspectMode

This type has no documentation

Link to this section Functions

Link to this function

disable(session, parameters \\ %{}, options \\ []) View Source 
disable(GenServer.server(), map(), Tungsten.Connection.exec_options()) ::
  {:ok, map()} | {:error, term()}

Overlay.disable

Disables domain notifications.

Link to this function

enable(session, parameters \\ %{}, options \\ []) View Source 
enable(GenServer.server(), map(), Tungsten.Connection.exec_options()) ::
  {:ok, map()} | {:error, term()}

Overlay.enable

Enables domain notifications.

Link to this function

get_highlight_object_for_test(session, parameters, options \\ []) View Source 
get_highlight_object_for_test(
  GenServer.server(),
  %{node_id: Tungsten.CDP.DOM.cdp_node_id_type()},
  Tungsten.Connection.exec_options()
) :: {:ok, %{highlight: map()}} | {:error, term()}

Overlay.getHighlightObjectForTest

For testing.

Link to this function

hide_highlight(session, parameters \\ %{}, options \\ []) View Source 
hide_highlight(GenServer.server(), map(), Tungsten.Connection.exec_options()) ::
  {:ok, map()} | {:error, term()}

Overlay.hideHighlight

Hides any highlight.

Link to this function

highlight_frame(session, parameters, options \\ []) View Source 
highlight_frame(
  GenServer.server(),
  %{
    :frame_id => Tungsten.CDP.Page.cdp_frame_id_type(),
    optional(:content_color) => Tungsten.CDP.DOM.cdp_rgba_type(),
    optional(:content_outline_color) => Tungsten.CDP.DOM.cdp_rgba_type()
  },
  Tungsten.Connection.exec_options()
) :: {:ok, map()} | {:error, term()}

Overlay.highlightFrame

Highlights owner element of the frame with given id.

Link to this function

highlight_node(session, parameters, options \\ []) View Source 
highlight_node(
  GenServer.server(),
  %{
    :highlight_config => cdp_highlight_config_type(),
    optional(:node_id) => Tungsten.CDP.DOM.cdp_node_id_type(),
    optional(:backend_node_id) => Tungsten.CDP.DOM.cdp_backend_node_id_type(),
    optional(:object_id) => Tungsten.CDP.Runtime.cdp_remote_object_id_type(),
    optional(:selector) => String.t()
  },
  Tungsten.Connection.exec_options()
) :: {:ok, map()} | {:error, term()}

Overlay.highlightNode

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

Link to this function

highlight_quad(session, parameters, options \\ []) View Source 
highlight_quad(
  GenServer.server(),
  %{
    :quad => Tungsten.CDP.DOM.cdp_quad_type(),
    optional(:color) => Tungsten.CDP.DOM.cdp_rgba_type(),
    optional(:outline_color) => Tungsten.CDP.DOM.cdp_rgba_type()
  },
  Tungsten.Connection.exec_options()
) :: {:ok, map()} | {:error, term()}

Overlay.highlightQuad

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

Link to this function

highlight_rect(session, parameters, options \\ []) View Source 
highlight_rect(
  GenServer.server(),
  %{
    :x => integer(),
    :y => integer(),
    :width => integer(),
    :height => integer(),
    optional(:color) => Tungsten.CDP.DOM.cdp_rgba_type(),
    optional(:outline_color) => Tungsten.CDP.DOM.cdp_rgba_type()
  },
  Tungsten.Connection.exec_options()
) :: {:ok, map()} | {:error, term()}

Overlay.highlightRect

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

Link to this function

set_inspect_mode(session, parameters, options \\ []) View Source 
set_inspect_mode(
  GenServer.server(),
  %{
    :mode => cdp_inspect_mode_type(),
    optional(:highlight_config) => cdp_highlight_config_type()
  },
  Tungsten.Connection.exec_options()
) :: {:ok, map()} | {:error, term()}

Overlay.setInspectMode

Enters the 'inspect' mode. In this mode, elements that user is hovering over are highlighted. Backend then generates 'inspectNodeRequested' event upon element selection.

Link to this function

set_paused_in_debugger_message(session, parameters \\ %{}, options \\ []) View Source 
set_paused_in_debugger_message(
  GenServer.server(),
  %{optional(:message) => String.t()},
  Tungsten.Connection.exec_options()
) :: {:ok, map()} | {:error, term()}

Overlay.setPausedInDebuggerMessage

This command has no documentation

Link to this function

set_show_ad_highlights(session, parameters, options \\ []) View Source 
set_show_ad_highlights(
  GenServer.server(),
  %{show: boolean()},
  Tungsten.Connection.exec_options()
) :: {:ok, map()} | {:error, term()}

Overlay.setShowAdHighlights

Highlights owner element of all frames detected to be ads.

Link to this function

set_show_debug_borders(session, parameters, options \\ []) View Source 
set_show_debug_borders(
  GenServer.server(),
  %{show: boolean()},
  Tungsten.Connection.exec_options()
) :: {:ok, map()} | {:error, term()}

Overlay.setShowDebugBorders

Requests that backend shows debug borders on layers

Link to this function

set_show_fps_counter(session, parameters, options \\ []) View Source 
set_show_fps_counter(
  GenServer.server(),
  %{show: boolean()},
  Tungsten.Connection.exec_options()
) :: {:ok, map()} | {:error, term()}

Overlay.setShowFPSCounter

Requests that backend shows the FPS counter

Link to this function

set_show_hit_test_borders(session, parameters, options \\ []) View Source 
set_show_hit_test_borders(
  GenServer.server(),
  %{show: boolean()},
  Tungsten.Connection.exec_options()
) :: {:ok, map()} | {:error, term()}

Overlay.setShowHitTestBorders

Requests that backend shows hit-test borders on layers

Link to this function

set_show_paint_rects(session, parameters, options \\ []) View Source 
set_show_paint_rects(
  GenServer.server(),
  %{result: boolean()},
  Tungsten.Connection.exec_options()
) :: {:ok, map()} | {:error, term()}

Overlay.setShowPaintRects

Requests that backend shows paint rectangles

Link to this function

set_show_scroll_bottleneck_rects(session, parameters, options \\ []) View Source 
set_show_scroll_bottleneck_rects(
  GenServer.server(),
  %{show: boolean()},
  Tungsten.Connection.exec_options()
) :: {:ok, map()} | {:error, term()}

Overlay.setShowScrollBottleneckRects

Requests that backend shows scroll bottleneck rects

Link to this function

set_show_viewport_size_on_resize(session, parameters, options \\ []) View Source 
set_show_viewport_size_on_resize(
  GenServer.server(),
  %{show: boolean()},
  Tungsten.Connection.exec_options()
) :: {:ok, map()} | {:error, term()}

Overlay.setShowViewportSizeOnResize

Paints viewport size upon main frame resize.