Menu
WebdriverIODocsAPIHelpVersionsContributeGitHub
WebdriverIO
  • Docs
  • API
  • Help
  • Versions
  • Contribute
  • GitHub
  • Introduction
    • API Docs
  • Protocols
    • Webdriver Protocol
    • Appium
    • JSON Wire Protocol
    • Mobile JSON Wire Protocol
    • Chromium
    • Sauce Labs
    • Selenium Standalone
  • Testrunner
    • Expect
  • browser
    • $$
    • $
    • call
    • custom$$
    • custom$
    • debug
    • deleteCookies
    • execute
    • executeAsync
    • getCookies
    • getWindowSize
    • keys
    • newWindow
    • pause
    • react$$
    • react$
    • reloadSession
    • saveRecordingScreen
    • saveScreenshot
    • setCookies
    • setTimeout
    • setWindowSize
    • switchWindow
    • touchAction
    • uploadFile
    • url
    • waitUntil
  • element
    • $$
    • $
    • addValue
    • clearValue
    • click
    • custom$$
    • custom$
    • doubleClick
    • dragAndDrop
    • getAttribute
    • getCSSProperty
    • getHTML
    • getLocation
    • getProperty
    • getSize
    • getTagName
    • getText
    • getValue
    • isClickable
    • isDisplayed
    • isDisplayedInViewport
    • isEnabled
    • isEqual
    • isExisting
    • isFocused
    • isSelected
    • moveTo
    • react$$
    • react$
    • saveScreenshot
    • scrollIntoView
    • selectByAttribute
    • selectByIndex
    • selectByVisibleText
    • setValue
    • shadow$$
    • shadow$
    • touchAction
    • waitForClickable
    • waitForDisplayed
    • waitForEnabled
    • waitForExist
    • waitUntil

saveScreenshot

Save a screenshot of the current browsing context to a PNG file on your OS. Be aware that some browser drivers take screenshots of the whole document (e.g. Geckodriver with Firefox) and others only of the current viewport (e.g. Chromedriver with Chrome).

Usage#
browser.saveScreenshot(filepath)
Parameters#
NameTypeDetails
filepathStringpath to the generated image (.png suffix is required) relative to the execution directory
Example#
it('should save a screenshot of the browser view', function () {
browser.saveScreenshot('./some/path/screenshot.png');
});
Edit this page
Previous
« saveRecordingScreen
Next
setCookies »

Community

  • Twitter
Copyright © 2020 OpenJS Foundation