Chrome DevTools

Emulation Domain

This domain emulates different environments for the page.

Methods

Events

Types

Methods

Chrome DevTools

Emulation.clearDeviceMetricsOverride #

Clears the overridden device metrics.


Chrome DevTools

Emulation.clearGeolocationOverride #

Clears the overridden Geolocation Position and Error.


Chrome DevTools

Emulation.clearIdleOverride #

Clears Idle state overrides.


Chrome DevTools

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).


Chrome DevTools

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
Optional
DOM.RGBA

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


Chrome DevTools

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
Optional
number

Scale to apply to resulting view image.

Experimental
screenWidth
Optional
integer

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

Experimental
screenHeight
Optional
integer

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

Experimental
positionX
Optional
integer

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

Experimental
positionY
Optional
integer

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

Experimental
dontSetVisibleSize
Optional
boolean

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

Experimental
screenOrientation
Optional
ScreenOrientation

Screen orientation override.

viewport
Optional
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
Optional
DisplayFeature

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

Experimental
devicePosture
Optional
DevicePosture

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

ExperimentalDeprecated

Chrome DevTools

Emulation.setEmulatedMedia #

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

Parameters

media
Optional
string

Media type to emulate. Empty string disables the override.

features
Optional
array[ MediaFeature ]

Media features to emulate.


Chrome DevTools

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


Chrome DevTools

Emulation.setGeolocationOverride #

Overrides the Geolocation Position or Error. Omitting any of the parameters emulates position unavailable.

Parameters

latitude
Optional
number

Mock latitude

longitude
Optional
number

Mock longitude

accuracy
Optional
number

Mock accuracy


Chrome DevTools

Emulation.setIdleOverride #

Overrides the Idle state.

Parameters

isUserActive
boolean

Mock isUserActive

isScreenUnlocked
boolean

Mock isScreenUnlocked


Chrome DevTools

Emulation.setScriptExecutionDisabled #

Switches script execution in the page.

Parameters

value
boolean

Whether script execution should be disabled in the page.


Chrome DevTools

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.


Chrome DevTools

Emulation.setTouchEmulationEnabled #

Enables touch on platforms which do not support them.

Parameters

enabled
boolean

Whether the touch event emulation should be enabled.

maxTouchPoints
Optional
integer

Maximum touch points supported. Defaults to one.


Chrome DevTools

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
Optional
string

Browser language to emulate.

platform
Optional
string

The platform navigator.platform should return.

userAgentMetadata
Optional
UserAgentMetadata

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

Experimental

Chrome DevTools

Emulation.canEmulate Deprecated#

Tells whether emulation is supported.

Return object

result
boolean

True if emulation is supported.


Chrome DevTools

Emulation.clearDevicePostureOverride Experimental#

Clears a device posture override set with either setDeviceMetricsOverride() or setDevicePostureOverride() and starts using posture information from the platform again. Does nothing if no override is set.


Chrome DevTools

Emulation.getOverriddenSensorInformation Experimental#

Parameters

Return object

requestedSamplingFrequency
number

Chrome DevTools

Emulation.resetPageScaleFactor Experimental#

Requests that page scale factor is reset to initial values.


Chrome DevTools

Emulation.setAutoDarkModeOverride Experimental#

Automatically render all web contents using a dark theme.

Parameters

enabled
Optional
boolean

Whether to enable or disable automatic dark mode. If not specified, any existing override will be cleared.


Chrome DevTools

Emulation.setAutomationOverride Experimental#

Allows overriding the automation flag.

Parameters

enabled
boolean

Whether the override should be enabled.


Chrome DevTools

Emulation.setDevicePostureOverride Experimental#

Start reporting the given posture value to the Device Posture API. This override can also be set in setDeviceMetricsOverride().

Parameters


Chrome DevTools

Emulation.setDisabledImageTypes Experimental#

Parameters

imageTypes
array[ DisabledImageType ]

Image types to disable.


Chrome DevTools

Emulation.setDocumentCookieDisabled Experimental#

Parameters

disabled
boolean

Whether document.coookie API should be disabled.


Chrome DevTools

Emulation.setEmitTouchEventsForMouse Experimental#

Parameters

enabled
boolean

Whether touch emulation based on mouse input should be enabled.

configuration
Optional
string

Touch/gesture events configuration. Default: current platform.

Allowed values: mobile, desktop


Chrome DevTools

Emulation.setFocusEmulationEnabled Experimental#

Enables or disables simulating a focused and active page.

Parameters

enabled
boolean

Whether to enable to disable focus emulation.


Chrome DevTools

Emulation.setHardwareConcurrencyOverride Experimental#

Parameters

hardwareConcurrency
integer

Hardware concurrency to report


Chrome DevTools

Emulation.setLocaleOverride Experimental#

Overrides default host system locale with the specified one.

Parameters

locale
Optional
string

ICU style C locale (e.g. "en_US"). If not specified or empty, disables the override and restores default host system locale.


Chrome DevTools

Emulation.setPageScaleFactor Experimental#

Sets a specified page scale factor.

Parameters

pageScaleFactor
number

Page scale factor.


Chrome DevTools

Emulation.setScrollbarsHidden Experimental#

Parameters

hidden
boolean

Whether scrollbars should be always hidden.


Chrome DevTools

Emulation.setSensorOverrideEnabled Experimental#

Overrides a platform sensor of a given type. If |enabled| is true, calls to Sensor.start() will use a virtual sensor as backend rather than fetching data from a real hardware sensor. Otherwise, existing virtual sensor-backend Sensor objects will fire an error event and new calls to Sensor.start() will attempt to use a real sensor instead.

Parameters

enabled
boolean
metadata
Optional

Chrome DevTools

Emulation.setSensorOverrideReadings Experimental#

Updates the sensor readings reported by a sensor type previously overridden by setSensorOverrideEnabled.

Parameters


Chrome DevTools

Emulation.setVirtualTimePolicy Experimental#

Turns on virtual time for all frames (replacing real-time with a synthetic time source) and sets the current virtual time policy. Note this supersedes any previous time budget.

Parameters

budget
Optional
number

If set, after this many virtual milliseconds have elapsed virtual time will be paused and a virtualTimeBudgetExpired event is sent.

maxVirtualTimeTaskStarvationCount
Optional
integer

If set this specifies the maximum number of tasks that can be run before virtual is forced forwards to prevent deadlock.

initialVirtualTime
Optional
Network.TimeSinceEpoch

If set, base::Time::Now will be overridden to initially return this value.

Return object

virtualTimeTicksBase
number

Absolute timestamp at which virtual time was first enabled (up time in milliseconds).


Chrome DevTools

Emulation.setNavigatorOverrides ExperimentalDeprecated#

Overrides value returned by the javascript navigator object.

Parameters

platform
string

The platform navigator.platform should return.


Chrome DevTools

Emulation.setVisibleSize ExperimentalDeprecated#

Resizes the frame/viewport of the page. Note that this does not affect the frame's container (e.g. browser window). Can be used to produce screenshots of the specified size. Not supported on Android.

Parameters

width
integer

Frame width (DIP).

height
integer

Frame height (DIP).

Events

Chrome DevTools

Emulation.virtualTimeBudgetExpired Experimental#

Notification sent after the virtual time budget for the current VirtualTimePolicy has run out.

Types

Chrome DevTools

Emulation.DevicePosture #

Type: object

Properties

type
string

Current posture of the device

Allowed values: continuous, folded


Chrome DevTools

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.


Chrome DevTools

Emulation.MediaFeature #

Type: object

Properties

name
string
value
string

Chrome DevTools

Emulation.ScreenOrientation #

Screen orientation.

Type: object

Properties

type
string

Orientation type.

Allowed values: portraitPrimary, portraitSecondary, landscapePrimary, landscapeSecondary

angle
integer

Orientation angle.


Chrome DevTools

Emulation.DisabledImageType Experimental#

Enum of image types that can be disabled.

Type: string

Allowed values: avif, webp


Chrome DevTools

Emulation.SensorMetadata Experimental#

Type: object

Properties

available
Optional
boolean
minimumFrequency
Optional
number
maximumFrequency
Optional
number

Chrome DevTools

Emulation.SensorReading Experimental#

Type: object

Properties

single
Optional
xyz
Optional
quaternion
Optional

Chrome DevTools

Emulation.SensorReadingQuaternion Experimental#

Type: object

Properties

x
number
y
number
z
number
w
number

Chrome DevTools

Emulation.SensorReadingSingle Experimental#

Type: object

Properties

value
number

Chrome DevTools

Emulation.SensorReadingXYZ Experimental#

Type: object

Properties

x
number
y
number
z
number

Chrome DevTools

Emulation.SensorType Experimental#

Used to specify sensor types to emulate. See https://w3c.github.io/sensors/#automation for more information.

Type: string

Allowed values: absolute-orientation, accelerometer, ambient-light, gravity, gyroscope, linear-acceleration, magnetometer, proximity, relative-orientation


Chrome DevTools

Emulation.UserAgentBrandVersion Experimental#

Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints

Type: object

Properties

brand
string
version
string

Chrome DevTools

Emulation.UserAgentMetadata Experimental#

Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints Missing optional values will be filled in by the target with what it would normally use.

Type: object

Properties

brands
Optional
array[ UserAgentBrandVersion ]

Brands appearing in Sec-CH-UA.

fullVersionList
Optional
array[ UserAgentBrandVersion ]

Brands appearing in Sec-CH-UA-Full-Version-List.

fullVersion
Optional
stringDeprecated
platform
string
platformVersion
string
architecture
string
model
string
mobile
boolean
bitness
Optional
string
wow64
Optional
boolean

Chrome DevTools

Emulation.VirtualTimePolicy Experimental#

advance: If the scheduler runs out of immediate work, the virtual time base may fast forward to allow the next delayed task (if any) to run; pause: The virtual time base may not advance; pauseIfNetworkFetchesPending: The virtual time base may not advance if there are any pending resource fetches.

Type: string

Allowed values: advance, pause, pauseIfNetworkFetchesPending