puppeteer/docs/api/puppeteer.elementhandle.screenshot.md

1016 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?: Readonly<ElementScreenshotOptions>
  ): Promise<string | Buffer>;
}

Parameters

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

Returns:

Promise<string | Buffer>