github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
8d026042db
puppeteer/docs/api/puppeteer.page.screenshot.md
Alex Rudenko 6847f8835f
fix: improve screenshot method types (#9529) 
The only drawback of adding overrides is that our documentation
generator would generate a page for each overload which might be hard to
read/find on the documentation website.

Closes #9512 #9385
2023-01-18 14:06:20 +00:00

2.6 KiB
Raw Blame History

sidebar_label
Page.screenshot

Page.screenshot() method

Signature:

class Page {
  screenshot(
    options: ScreenshotOptions & {
      encoding: 'base64';
    }
  ): Promise<string>;
}

Parameters

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

Returns:

Promise<string>

Promise which resolves to buffer or a base64 string (depending on the value of encoding) with captured screenshot.

Remarks

Options object which might have the following properties:

  • path : The file path to save the image to. The screenshot type will be inferred from file extension. If path is a relative path, then it is resolved relative to current working directory. If no path is provided, the image won't be saved to the disk.

  • type : Specify screenshot type, can be either jpeg or png. Defaults to 'png'.

  • quality : The quality of the image, between 0-100. Not applicable to png images.

  • fullPage : When true, takes a screenshot of the full scrollable page. Defaults to false.

  • clip : An object which specifies clipping region of the page. Should have the following fields:
    - x : x-coordinate of top-left corner of clip area.
    - y : y-coordinate of top-left corner of clip area.
    - width : width of clipping area.
    - height : height of clipping area.

  • omitBackground : Hides default white background and allows capturing screenshots with transparency. Defaults to false.

  • encoding : The encoding of the image, can be either base64 or binary. Defaults to binary.

  • captureBeyondViewport : When true, captures screenshot beyond the viewport. When false, falls back to old behaviour, and cuts the screenshot by the viewport size. Defaults to true.

  • fromSurface : When true, captures screenshot from the surface rather than the view. When false, works only in headful mode and ignores page viewport (but not browser window's bounds). Defaults to true.

NOTE: Screenshots take at least 1/6 second on OS X. See https://crbug.com/741689 for discussion.