> ## Documentation Index
> Fetch the complete documentation index at: https://docs.extractbase.com/llms.txt
> Use this file to discover all available pages before exploring further.

# ScreenshotOptions

Input options for configuring screenshots taken with the 'screenshot' query.

## Definition

```graphql theme={null}
input ScreenshotOptions {
  type: ScreenshotType
  quality: Int
  fullPage: Boolean
  animations: ScreenshotAnimations
  caret: ScreenshotCaret
  clip: BoxOptions
  omitBackground: Boolean
  scale: ScreenshotScale
  style: String
  timeout: Int
}
```

## Fields

### `type`

[ScreenshotType](/reference/graphql/enums/screenshot-type)

Specifies the image format for the screenshot. Defaults to PNG. See `ScreenshotType` enum.

### `quality`

[Int](/reference/graphql/scalars/int)

The quality of the image, for JPEG format only, between 0 and 100. Higher is better quality. Defaults to system-specific value (e.g., 80-90).

### `fullPage`

[Boolean](/reference/graphql/scalars/boolean)

If true, captures a screenshot of the full scrollable page. If false (default), captures only the visible viewport.
Note: This typically means the full element, even if it's scrollable.

### `animations`

[ScreenshotAnimations](/reference/graphql/enums/screenshot-animations)

Controls animation behavior during screenshotting. See `ScreenshotAnimations` enum. Defaults to 'DISABLED'.

### `caret`

[ScreenshotCaret](/reference/graphql/enums/screenshot-caret)

Controls the visibility of the text input caret (cursor) in the screenshot. See `ScreenshotCaret` enum. Defaults to 'HIDE'.

### `clip`

[BoxOptions](/reference/graphql/inputs/box-options)

An optional box to clip the screenshot to a specific region of the element or page. See `BoxOptions`.

### `omitBackground`

[Boolean](/reference/graphql/scalars/boolean)

If true, omits the default white background from screenshots with transparency (e.g., transparent PNGs). Defaults to false.

### `scale`

[ScreenshotScale](/reference/graphql/enums/screenshot-scale)

Specifies the scaling of the screenshot. See `ScreenshotScale` enum. Defaults to 'CSS'.

### `style`

[String](/reference/graphql/scalars/string)

Custom CSS styles to apply to the page before taking the screenshot. This can be used to alter appearance for the screenshot, e.g., hiding elements.
Example: `"div.cookie-banner { display: none; }"`

### `timeout`

[Int](/reference/graphql/scalars/int)

Maximum time in milliseconds to wait for the page or element to be ready before taking the screenshot. Defaults to a global timeout.