Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                

Chrome DevTools Protocol

Methods

Emulation.canEmulate

Tells whether emulation is supported.

Return Object
result
boolean

True if emulation is supported.

Emulation.clearDeviceMetricsOverride

Clears the overridden device metrics.

Emulation.clearGeolocationOverride

Clears the overridden Geolocation Position and Error.

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.

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

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

parameters
latitude
number

Mock latitude

longitude
number

Mock longitude

accuracy
number

Mock accuracy

Emulation.setScriptExecutionDisabled

Switches script execution in the page.

parameters
value
boolean

Whether script execution should be disabled in the page.

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.

parameters
userAgent
string

User agent to use.

acceptLanguage
string

Browser langugage 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

Emulation.clearIdleOverride Experimental

Clears Idle state overrides.

Emulation.resetPageScaleFactor Experimental

Requests that page scale factor is reset to initial values.

Emulation.setAutoDarkModeOverride Experimental

Automatically render all web contents using a dark theme.

parameters
enabled
boolean

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

Emulation.setAutomationOverride Experimental

Allows overriding the automation flag.

parameters
enabled
boolean

Whether the override should be enabled.

Emulation.setCPUThrottlingRate Experimental

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.setDisabledImageTypes Experimental

parameters
imageTypes
array[ DisabledImageType ]

Image types to disable.

Emulation.setDocumentCookieDisabled Experimental

parameters
disabled
boolean

Whether document.coookie API should be disabled.

Emulation.setEmitTouchEventsForMouse Experimental

parameters
enabled
boolean

Whether touch emulation based on mouse input should be enabled.

configuration
string

Touch/gesture events configuration. Default: current platform.

Allowed Values: mobile, desktop

Emulation.setEmulatedVisionDeficiency Experimental

Emulates the given vision deficiency.

parameters
type
string

Vision deficiency to emulate.

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

Emulation.setFocusEmulationEnabled Experimental

Enables or disables simulating a focused and active page.

parameters
enabled
boolean

Whether to enable to disable focus emulation.

Emulation.setHardwareConcurrencyOverride Experimental

parameters
hardwareConcurrency
integer

Hardware concurrency to report

Emulation.setIdleOverride Experimental

Overrides the Idle state.

parameters
isUserActive
boolean

Mock isUserActive

isScreenUnlocked
boolean

Mock isScreenUnlocked

Emulation.setLocaleOverride Experimental

Overrides default host system locale with the specified one.

parameters
locale
string

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

Emulation.setPageScaleFactor Experimental

Sets a specified page scale factor.

parameters
pageScaleFactor
number

Page scale factor.

Emulation.setScrollbarsHidden Experimental

parameters
hidden
boolean

Whether scrollbars should be always hidden.

Emulation.setTimezoneOverride Experimental

Overrides default host system timezone with the specified one.

parameters
timezoneId
string

The timezone identifier. If empty, disables the override and restores default host system timezone.

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
policy
VirtualTimePolicy
budget
number

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

maxVirtualTimeTaskStarvationCount
integer

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

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

Emulation.setNavigatorOverrides ExperimentalDeprecated

Overrides value returned by the javascript navigator object.

parameters
platform
string

The platform navigator.platform should return.

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

Emulation.virtualTimeBudgetExpired Experimental

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

Types

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.

Emulation.DisabledImageType Experimental

Enum of image types that can be disabled.

Allowed Values: avif, jxl, webp

Type: string

Emulation.UserAgentBrandVersion Experimental

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

Type: object

properties
brand
string
version
string

Emulation.UserAgentMetadata Experimental

Used to specify User Agent Cient 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
array[ UserAgentBrandVersion ]
fullVersionList
array[ UserAgentBrandVersion ]
fullVersion
string
Deprecated
platform
string
platformVersion
string
architecture
string
model
string
mobile
boolean
bitness
string
wow64
boolean

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.

Allowed Values: advance, pause, pauseIfNetworkFetchesPending

Type: string