Back to Puppeteer

ElementHandle.screenshot() method

website/versioned_docs/version-24.40.0/api/puppeteer.elementhandle.screenshot.md

19.2.21.3 KB
Original Source

ElementHandle.screenshot() method

<h2 id="overload-1">screenshot(): Promise&lt;string&gt;</h2>

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

typescript
class ElementHandle {
  screenshot(
    options: Readonly<ScreenshotOptions> & {
      encoding: 'base64';
    },
  ): Promise<string>;
}

Parameters

<table><thead><tr><th>

Parameter

</th><th>

Type

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

options

</td><td>

Readonly<ScreenshotOptions> & { encoding: 'base64'; }

</td><td> </td></tr> </tbody></table>

Returns:

Promise<string>

<h2 id="overload-2">screenshot(): Promise&lt;Uint8Array&gt;</h2>

Signature

typescript
class ElementHandle {
  screenshot(options?: Readonly<ScreenshotOptions>): Promise<Uint8Array>;
}

Parameters

<table><thead><tr><th>

Parameter

</th><th>

Type

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

options

</td><td>

Readonly<ScreenshotOptions>

</td><td>

(Optional)

</td></tr> </tbody></table>

Returns:

Promise<Uint8Array>