puppeteer/website/versioned_docs/version-17.1.0/api/puppeteer.elementhandle.screenshot.md
release-please[bot] f9e758e31d
chore(main): release 17.1.0 (#8894)
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2022-09-02 11:28:00 +00:00

924 B

sidebar_label
ElementHandle.screenshot

ElementHandle.screenshot() method

This method scrolls element into view if needed, and then uses Page.screenshot() to take a screenshot of the element. If the element is detached from DOM, the method throws an error.

Signature:

class ElementHandle {
  screenshot(
    this: ElementHandle<Element>,
    options?: ScreenshotOptions
  ): Promise<string | Buffer>;
}

Parameters

Parameter Type Description
this ElementHandle<Element>
options ScreenshotOptions (Optional)

Returns:

Promise<string | Buffer>