Module: Selenium::WebDriver::TakesScreenshot Private

Included in:
Driver, Element
Defined in:
rb/lib/selenium/webdriver/common/takes_screenshot.rb

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

Instance Method Summary collapse

Instance Method Details

#save_screenshot(png_path, full_page: false) ⇒ Object

Save a PNG screenshot of the viewport to the given path



32
33
34
35
36
37
38
39
40
 
# File 'rb/lib/selenium/webdriver/common/takes_screenshot.rb', line 32

def save_screenshot(png_path, full_page: false)
  extension = File.extname(png_path).downcase
  if extension != '.png'
    WebDriver.logger.warn 'name used for saved screenshot does not match file type. ' \
                          'It should end with .png extension',
                          id: :screenshot
  end
  File.open(png_path, 'wb') { |f| f << screenshot_as(:png, full_page: full_page) }
end

#screenshot_as(format, full_page: false) ⇒ Object

Return a PNG screenshot in the given format as a string

Parameters:

  • format (:base64, :png)
  • full_page (Boolean) (defaults to: false) —

    allows taking full page screenshots if supported

Returns:

  • String screenshot



51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'rb/lib/selenium/webdriver/common/takes_screenshot.rb', line 51

def screenshot_as(format, full_page: false)
  if full_page && !respond_to?(:save_full_page_screenshot)
    raise Error::UnsupportedOperationError, "Full Page Screenshots are not supported for #{inspect}"
  end

  case format
  when :base64
    full_page ? full_screenshot : screenshot
  when :png
    screenshot_as(:base64, full_page: full_page).unpack1('m')
  else
    raise Error::UnsupportedOperationError, "unsupported format: #{format.inspect}"
  end
end