class Selenium::DevTools::V92::Overlay

Constants

EVENTS

Public Class Methods

new(devtools) click to toggle source
# File lib/selenium/devtools/v92/overlay.rb, line 32
def initialize(devtools)
  @devtools = devtools
end

Public Instance Methods

disable() click to toggle source
# File lib/selenium/devtools/v92/overlay.rb, line 41
def disable
  @devtools.send_cmd('Overlay.disable')
end
enable() click to toggle source
# File lib/selenium/devtools/v92/overlay.rb, line 45
def enable
  @devtools.send_cmd('Overlay.enable')
end
get_grid_highlight_objects_for_test(node_ids:) click to toggle source
# File lib/selenium/devtools/v92/overlay.rb, line 58
def get_grid_highlight_objects_for_test(node_ids:)
  @devtools.send_cmd('Overlay.getGridHighlightObjectsForTest',
                     nodeIds: node_ids)
end
get_highlight_object_for_test(node_id:, include_distance: nil, include_style: nil, color_format: nil, show_accessibility_info: nil) click to toggle source
# File lib/selenium/devtools/v92/overlay.rb, line 49
def get_highlight_object_for_test(node_id:, include_distance: nil, include_style: nil, color_format: nil, show_accessibility_info: nil)
  @devtools.send_cmd('Overlay.getHighlightObjectForTest',
                     nodeId: node_id,
                     includeDistance: include_distance,
                     includeStyle: include_style,
                     colorFormat: color_format,
                     showAccessibilityInfo: show_accessibility_info)
end
get_source_order_highlight_object_for_test(node_id:) click to toggle source
# File lib/selenium/devtools/v92/overlay.rb, line 63
def get_source_order_highlight_object_for_test(node_id:)
  @devtools.send_cmd('Overlay.getSourceOrderHighlightObjectForTest',
                     nodeId: node_id)
end
hide_highlight() click to toggle source
# File lib/selenium/devtools/v92/overlay.rb, line 68
def hide_highlight
  @devtools.send_cmd('Overlay.hideHighlight')
end
highlight_frame(frame_id:, content_color: nil, content_outline_color: nil) click to toggle source
# File lib/selenium/devtools/v92/overlay.rb, line 72
def highlight_frame(frame_id:, content_color: nil, content_outline_color: nil)
  @devtools.send_cmd('Overlay.highlightFrame',
                     frameId: frame_id,
                     contentColor: content_color,
                     contentOutlineColor: content_outline_color)
end
highlight_node(highlight_config:, node_id: nil, backend_node_id: nil, object_id: nil, selector: nil) click to toggle source
# File lib/selenium/devtools/v92/overlay.rb, line 79
def highlight_node(highlight_config:, node_id: nil, backend_node_id: nil, object_id: nil, selector: nil)
  @devtools.send_cmd('Overlay.highlightNode',
                     highlightConfig: highlight_config,
                     nodeId: node_id,
                     backendNodeId: backend_node_id,
                     objectId: object_id,
                     selector: selector)
end
highlight_quad(quad:, color: nil, outline_color: nil) click to toggle source
# File lib/selenium/devtools/v92/overlay.rb, line 88
def highlight_quad(quad:, color: nil, outline_color: nil)
  @devtools.send_cmd('Overlay.highlightQuad',
                     quad: quad,
                     color: color,
                     outlineColor: outline_color)
end
highlight_rect(x:, y:, width:, height:, color: nil, outline_color: nil) click to toggle source
# File lib/selenium/devtools/v92/overlay.rb, line 95
def highlight_rect(x:, y:, width:, height:, color: nil, outline_color: nil)
  @devtools.send_cmd('Overlay.highlightRect',
                     x: x,
                     y: y,
                     width: width,
                     height: height,
                     color: color,
                     outlineColor: outline_color)
end
highlight_source_order(source_order_config:, node_id: nil, backend_node_id: nil, object_id: nil) click to toggle source
# File lib/selenium/devtools/v92/overlay.rb, line 105
def highlight_source_order(source_order_config:, node_id: nil, backend_node_id: nil, object_id: nil)
  @devtools.send_cmd('Overlay.highlightSourceOrder',
                     sourceOrderConfig: source_order_config,
                     nodeId: node_id,
                     backendNodeId: backend_node_id,
                     objectId: object_id)
end
on(event, &block) click to toggle source
# File lib/selenium/devtools/v92/overlay.rb, line 36
def on(event, &block)
  event = EVENTS[event] if event.is_a?(Symbol)
  @devtools.callbacks["Overlay.#{event}"] << block
end
set_inspect_mode(mode:, highlight_config: nil) click to toggle source
# File lib/selenium/devtools/v92/overlay.rb, line 113
def set_inspect_mode(mode:, highlight_config: nil)
  @devtools.send_cmd('Overlay.setInspectMode',
                     mode: mode,
                     highlightConfig: highlight_config)
end
set_paused_in_debugger_message(message: nil) click to toggle source
# File lib/selenium/devtools/v92/overlay.rb, line 124
def set_paused_in_debugger_message(message: nil)
  @devtools.send_cmd('Overlay.setPausedInDebuggerMessage',
                     message: message)
end
set_show_ad_highlights(show:) click to toggle source
# File lib/selenium/devtools/v92/overlay.rb, line 119
def set_show_ad_highlights(show:)
  @devtools.send_cmd('Overlay.setShowAdHighlights',
                     show: show)
end
set_show_debug_borders(show:) click to toggle source
# File lib/selenium/devtools/v92/overlay.rb, line 129
def set_show_debug_borders(show:)
  @devtools.send_cmd('Overlay.setShowDebugBorders',
                     show: show)
end
set_show_flex_overlays(flex_node_highlight_configs:) click to toggle source
# File lib/selenium/devtools/v92/overlay.rb, line 144
def set_show_flex_overlays(flex_node_highlight_configs:)
  @devtools.send_cmd('Overlay.setShowFlexOverlays',
                     flexNodeHighlightConfigs: flex_node_highlight_configs)
end
set_show_fps_counter(show:) click to toggle source
# File lib/selenium/devtools/v92/overlay.rb, line 134
def set_show_fps_counter(show:)
  @devtools.send_cmd('Overlay.setShowFPSCounter',
                     show: show)
end
set_show_grid_overlays(grid_node_highlight_configs:) click to toggle source
# File lib/selenium/devtools/v92/overlay.rb, line 139
def set_show_grid_overlays(grid_node_highlight_configs:)
  @devtools.send_cmd('Overlay.setShowGridOverlays',
                     gridNodeHighlightConfigs: grid_node_highlight_configs)
end
set_show_hinge(hinge_config: nil) click to toggle source
# File lib/selenium/devtools/v92/overlay.rb, line 184
def set_show_hinge(hinge_config: nil)
  @devtools.send_cmd('Overlay.setShowHinge',
                     hingeConfig: hinge_config)
end
set_show_hit_test_borders(show:) click to toggle source
# File lib/selenium/devtools/v92/overlay.rb, line 169
def set_show_hit_test_borders(show:)
  @devtools.send_cmd('Overlay.setShowHitTestBorders',
                     show: show)
end
set_show_layout_shift_regions(result:) click to toggle source
# File lib/selenium/devtools/v92/overlay.rb, line 159
def set_show_layout_shift_regions(result:)
  @devtools.send_cmd('Overlay.setShowLayoutShiftRegions',
                     result: result)
end
set_show_paint_rects(result:) click to toggle source
# File lib/selenium/devtools/v92/overlay.rb, line 154
def set_show_paint_rects(result:)
  @devtools.send_cmd('Overlay.setShowPaintRects',
                     result: result)
end
set_show_scroll_bottleneck_rects(show:) click to toggle source
# File lib/selenium/devtools/v92/overlay.rb, line 164
def set_show_scroll_bottleneck_rects(show:)
  @devtools.send_cmd('Overlay.setShowScrollBottleneckRects',
                     show: show)
end
set_show_scroll_snap_overlays(scroll_snap_highlight_configs:) click to toggle source
# File lib/selenium/devtools/v92/overlay.rb, line 149
def set_show_scroll_snap_overlays(scroll_snap_highlight_configs:)
  @devtools.send_cmd('Overlay.setShowScrollSnapOverlays',
                     scrollSnapHighlightConfigs: scroll_snap_highlight_configs)
end
set_show_viewport_size_on_resize(show:) click to toggle source
# File lib/selenium/devtools/v92/overlay.rb, line 179
def set_show_viewport_size_on_resize(show:)
  @devtools.send_cmd('Overlay.setShowViewportSizeOnResize',
                     show: show)
end
set_show_web_vitals(show:) click to toggle source
# File lib/selenium/devtools/v92/overlay.rb, line 174
def set_show_web_vitals(show:)
  @devtools.send_cmd('Overlay.setShowWebVitals',
                     show: show)
end