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

sidebar_label

sidebar_label
ElementHandle.screenshot

ElementHandle.screenshot() method

screenshot(): Promise<string>

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(
    options: Readonly<ScreenshotOptions> & {
      encoding: 'base64';
    },
  ): Promise<string>;
}

Parameters

Parameter	Type	Description
options	Readonly<ScreenshotOptions> & { encoding: 'base64'; }

Returns:

Promise<string>

screenshot(): Promise<Uint8Array>

Signature

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

Parameters

Parameter	Type	Description
options	Readonly<ScreenshotOptions>	(Optional)

Returns:

Promise<Uint8Array>