Chrome DevTools Protocol

Methods

Emulation.clearDeviceMetricsOverride

Clears the overridden device metrics.

Emulation.clearGeolocationOverride

Clears the overridden Geolocation Position and Error.

Emulation.clearIdleOverride

Clears Idle state overrides.

Emulation.setCPUThrottlingRate

Enables CPU throttling to emulate slow CPUs.

parameters
rate
number

Throttling rate as a slowdown factor (1 is no throttle, 2 is 2x slowdown, etc).

Emulation.setDefaultBackgroundColorOverride

Sets or clears an override of the default background color of the frame. This override is used if the content does not specify one.

parameters
color
DOM.RGBA

RGBA of the default background color. If not specified, any existing override will be cleared.

Emulation.setDeviceMetricsOverride

Overrides the values of device screen dimensions (window.screen.width, window.screen.height, window.innerWidth, window.innerHeight, and "device-width"/"device-height"-related CSS media query results).

parameters
width
integer

Overriding width value in pixels (minimum 0, maximum 10000000). 0 disables the override.

height
integer

Overriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override.

deviceScaleFactor
number

Overriding device scale factor value. 0 disables the override.

mobile
boolean

Whether to emulate mobile device. This includes viewport meta tag, overlay scrollbars, text autosizing and more.

scale
number

Scale to apply to resulting view image.

Experimental
screenWidth
integer

Overriding screen width value in pixels (minimum 0, maximum 10000000).

Experimental
screenHeight
integer

Overriding screen height value in pixels (minimum 0, maximum 10000000).

Experimental
positionX
integer

Overriding view X position on screen in pixels (minimum 0, maximum 10000000).

Experimental
positionY
integer

Overriding view Y position on screen in pixels (minimum 0, maximum 10000000).

Experimental
dontSetVisibleSize
boolean

Do not set visible view size, rely upon explicit setVisibleSize call.

Experimental
screenOrientation
ScreenOrientation

Screen orientation override.

viewport
Page.Viewport

If set, the visible area of the page will be overridden to this viewport. This viewport change is not observed by the page, e.g. viewport-relative elements do not change positions.

Experimental
displayFeature
DisplayFeature

If set, the display feature of a multi-segment screen. If not set, multi-segment support is turned-off. Deprecated, use Emulation.setDisplayFeaturesOverride.

ExperimentalDeprecated
devicePosture
DevicePosture

If set, the posture of a foldable device. If not set the posture is set to continuous. Deprecated, use Emulation.setDevicePostureOverride.

ExperimentalDeprecated
scrollbarType
string

Scrollbar type. Default: default.

Allowed Values: overlay, default
Experimental
screenOrientationLockEmulation
boolean

If set to true, enables screen orientation lock emulation, which intercepts screen.orientation.lock() calls from the page and reports orientation changes via screenOrientationLockChanged events. This is useful for emulating mobile device orientation lock behavior in responsive design mode.

Experimental

Emulation.setEmulatedMedia

Emulates the given media type or media feature for CSS media queries.

parameters
media
string

Media type to emulate. Empty string disables the override.

features
array[ MediaFeature ]

Media features to emulate.

Emulation.setEmulatedOSTextScale

Emulates the given OS text scale.

parameters
scale
number

Emulation.setEmulatedVisionDeficiency

Emulates the given vision deficiency.

parameters
type
string

Vision deficiency to emulate. Order: best-effort emulations come first, followed by any physiologically accurate emulations for medically recognized color vision deficiencies.

Allowed Values: none, blurredVision, reducedContrast, achromatopsia, deuteranopia, protanopia, tritanopia

Emulation.setGeolocationOverride

Overrides the Geolocation Position or Error. Omitting latitude, longitude or accuracy emulates position unavailable.

parameters
latitude
number

Mock latitude

longitude
number

Mock longitude

accuracy
number

Mock accuracy

altitude
number

Mock altitude

altitudeAccuracy
number

Mock altitudeAccuracy

heading
number

Mock heading

speed
number

Mock speed

Emulation.setIdleOverride

Overrides the Idle state.

parameters
isUserActive
boolean

Mock isUserActive

isScreenUnlocked
boolean

Mock isScreenUnlocked

Emulation.setScriptExecutionDisabled

Switches script execution in the page.

parameters
value
boolean

Whether script execution should be disabled in the page.

Emulation.setTimezoneOverride

Overrides default host system timezone with the specified one.

parameters
timezoneId
string

The timezone identifier. List of supported timezones: https://source.chromium.org/chromium/chromium/deps/icu.git/+/faee8bc70570192d82d2978a71e2a615788597d1:source/data/misc/metaZones.txt If empty, disables the override and restores default host system timezone.

Emulation.setTouchEmulationEnabled

Enables touch on platforms which do not support them.

parameters
enabled
boolean

Whether the touch event emulation should be enabled.

maxTouchPoints
integer

Maximum touch points supported. Defaults to one.

Emulation.setUserAgentOverride

Allows overriding user agent with the given string. userAgentMetadata must be set for Client Hint headers to be sent.

parameters
userAgent
string

User agent to use.

acceptLanguage
string

Browser language to emulate.

platform
string

The platform navigator.platform should return.

userAgentMetadata
UserAgentMetadata

To be sent in Sec-CH-UA-* headers and returned in navigator.userAgentData

Experimental

Types

Emulation.DevicePosture

Type: object

properties
type
string

Current posture of the device

Allowed Values: continuous, folded

Emulation.DisplayFeature

Type: object

properties
orientation
string

Orientation of a display feature in relation to screen

Allowed Values: vertical, horizontal
offset
integer

The offset from the screen origin in either the x (for vertical orientation) or y (for horizontal orientation) direction.

maskLength
integer

A display feature may mask content such that it is not physically displayed - this length along with the offset describes this area. A display feature that only splits content will have a 0 mask_length.

Emulation.MediaFeature

Type: object

properties
name
string
value
string

Emulation.ScreenOrientation

Screen orientation.

Type: object

properties
type
string

Orientation type.

Allowed Values: portraitPrimary, portraitSecondary, landscapePrimary, landscapeSecondary
angle
integer

Orientation angle.