class

Playwright::Page::ScreenshotOptions

Inherits JSON::Serializable / Reference / Object

Constructors

new(path : Path | Nil = nil, type : Playwright::Page::ScreenshotOptions::Type | Nil = nil, quality : Int32 | Nil = nil, full_page : Bool | Nil = nil, clip : Nil | Playwright::Page::ScreenshotOptions::Clip = nil, omit_background : Bool | Nil = nil, timeout : Int32 | Nil = nil)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

clip

An object which specifies clipping of the resulting image. Should have the following fields:

Source
clip=(clip : Clip | Nil)

An object which specifies clipping of the resulting image. Should have the following fields:

Source
full_page

When true, takes a screenshot of the full scrollable page, instead of the currently visible viewport. Defaults to false.

Source
full_page=(full_page : Bool | Nil)

When true, takes a screenshot of the full scrollable page, instead of the currently visible viewport. Defaults to false.

Source
omit_background

Hides default white background and allows capturing screenshots with transparency. Not applicable to jpeg images. Defaults to false.

Source
omit_background=(omit_background : Bool | Nil)

Hides default white background and allows capturing screenshots with transparency. Not applicable to jpeg images. Defaults to false.

Source
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 the current working directory. If no path is provided, the image won't be saved to the disk.

Source
path=(path : Path | Nil)

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 the current working directory. If no path is provided, the image won't be saved to the disk.

Source
quality

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

Source
quality=(quality : Int32 | Nil)

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

Source
timeout

Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

Source
timeout=(timeout : Int32 | Nil)

Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

Source
type

Specify screenshot type, defaults to png.

Source
type=(type : Type | Nil)

Specify screenshot type, defaults to png.

Source

Nested types