puppeteer/docs/api/puppeteer.elementhandle.screenshot.md
jrandolf f07ad2c661
fix: update documentation on configuring puppeteer (#9150)
This PR updates the docs regarding configuring puppeteer. In addition,
some changes have been made to the documentation generator to show
default values on the documentation site.

Also fixes: https://github.com/puppeteer/puppeteer/pull/9144
2022-10-24 09:07:05 +02:00

925 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>