Expand description
This domain emulates different environments for the page.
Structs§
- AddScreen
Params - Add a new screen to the device. Only supported in headless mode.
- AddScreen
Params Builder - AddScreen
Returns - Add a new screen to the device. Only supported in headless mode.
- AddScreen
Returns Builder - CanEmulate
Params - CanEmulate
Returns - Tells whether emulation is supported.
- CanEmulate
Returns Builder - Clear
Device Metrics Override Params - Clear
Device Posture Override Params - Clear
Display Features Override Params - Clear
Geolocation Override Params - Clear
Idle Override Params - Device
Posture - Device
Posture Builder - Display
Feature - Display
Feature Builder - GetOverridden
Sensor Information Params - GetOverridden
Sensor Information Params Builder - GetOverridden
Sensor Information Returns - GetOverridden
Sensor Information Returns Builder - GetScreen
Infos Params - GetScreen
Infos Returns - Returns device’s screen configuration. In headful mode, the physical screens configuration is returned, whereas in headless mode, a virtual headless screen configuration is provided instead.
- GetScreen
Infos Returns Builder - Media
Feature - Media
Feature Builder - Pressure
Metadata - Pressure
Metadata Builder - Remove
Screen Params - Remove screen from the device. Only supported in headless mode.
- Remove
Screen Params Builder - Reset
Page Scale Factor Params - Safe
Area Insets - Safe
Area Insets Builder - Screen
Info - Screen information similar to the one returned by window.getScreenDetails() method, see https://w3c.github.io/window-management/#screendetailed.
- Screen
Info Builder - Screen
Orientation - Screen orientation.
- Screen
Orientation Builder - Sensor
Metadata - Sensor
Metadata Builder - Sensor
Reading - Sensor
Reading Builder - Sensor
Reading Quaternion - Sensor
Reading Quaternion Builder - Sensor
Reading Single - Sensor
Reading Single Builder - Sensor
ReadingXYZ - Sensor
ReadingXYZ Builder - SetAuto
Dark Mode Override Params - Automatically render all web contents using a dark theme.
- SetAuto
Dark Mode Override Params Builder - SetAutomation
Override Params - Allows overriding the automation flag.
- SetAutomation
Override Params Builder - SetCPU
Throttling Rate Params - Enables CPU throttling to emulate slow CPUs.
- SetCPU
Throttling Rate Params Builder - SetData
Saver Override Params - Override the value of navigator.connection.saveData
- SetData
Saver Override Params Builder - SetDefault
Background Color Override Params - Sets or clears an override of the default background color of the frame. This override is used if the content does not specify one.
- SetDefault
Background Color Override Params Builder - SetDevice
Metrics Override Params - 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).
- SetDevice
Metrics Override Params Builder - SetDevice
Posture Override Params - Start reporting the given posture value to the Device Posture API. This override can also be set in setDeviceMetricsOverride().
- SetDevice
Posture Override Params Builder - SetDisabled
Image Types Params - SetDisabled
Image Types Params Builder - SetDisplay
Features Override Params - Start using the given display features to pupulate the Viewport Segments API. This override can also be set in setDeviceMetricsOverride().
- SetDisplay
Features Override Params Builder - SetDocument
Cookie Disabled Params - SetDocument
Cookie Disabled Params Builder - SetEmit
Touch Events ForMouse Params - SetEmit
Touch Events ForMouse Params Builder - SetEmulated
Media Params - Emulates the given media type or media feature for CSS media queries.
- SetEmulated
Media Params Builder - SetEmulatedOS
Text Scale Params - Emulates the given OS text scale.
- SetEmulatedOS
Text Scale Params Builder - SetEmulated
Vision Deficiency Params - Emulates the given vision deficiency.
- SetEmulated
Vision Deficiency Params Builder - SetFocus
Emulation Enabled Params - Enables or disables simulating a focused and active page.
- SetFocus
Emulation Enabled Params Builder - SetGeolocation
Override Params - Overrides the Geolocation Position or Error. Omitting latitude, longitude or accuracy emulates position unavailable.
- SetGeolocation
Override Params Builder - SetHardware
Concurrency Override Params - SetHardware
Concurrency Override Params Builder - SetIdle
Override Params - Overrides the Idle state.
- SetIdle
Override Params Builder - SetLocale
Override Params - Overrides default host system locale with the specified one.
- SetLocale
Override Params Builder - SetNavigator
Overrides Params - Overrides value returned by the javascript navigator object.
- SetNavigator
Overrides Params Builder - SetPage
Scale Factor Params - Sets a specified page scale factor.
- SetPage
Scale Factor Params Builder - SetPressure
Data Override Params - Provides a given pressure data set that will be processed and eventually be delivered to PressureObserver users. |source| must have been previously overridden by setPressureSourceOverrideEnabled.
- SetPressure
Data Override Params Builder - SetPressure
Source Override Enabled Params - Overrides a pressure source of a given type, as used by the Compute Pressure API, so that updates to PressureObserver.observe() are provided via setPressureStateOverride instead of being retrieved from platform-provided telemetry data.
- SetPressure
Source Override Enabled Params Builder - SetPressure
State Override Params - TODO: OBSOLETE: To remove when setPressureDataOverride is merged. Provides a given pressure state that will be processed and eventually be delivered to PressureObserver users. |source| must have been previously overridden by setPressureSourceOverrideEnabled.
- SetPressure
State Override Params Builder - SetPrimary
Screen Params - Set primary screen. Only supported in headless mode. Note that this changes the coordinate system origin to the top-left of the new primary screen, updating the bounds and work areas of all existing screens accordingly.
- SetPrimary
Screen Params Builder - SetSafe
Area Insets Override Params - Overrides the values for env(safe-area-inset-) and env(safe-area-max-inset-). Unset values will cause the respective variables to be undefined, even if previously overridden.
- SetSafe
Area Insets Override Params Builder - SetScript
Execution Disabled Params - Switches script execution in the page.
- SetScript
Execution Disabled Params Builder - SetScrollbars
Hidden Params - SetScrollbars
Hidden Params Builder - SetSensor
Override Enabled Params - 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.
- SetSensor
Override Enabled Params Builder - SetSensor
Override Readings Params - Updates the sensor readings reported by a sensor type previously overridden by setSensorOverrideEnabled.
- SetSensor
Override Readings Params Builder - SetSmall
Viewport Height Difference Override Params - Allows overriding the difference between the small and large viewport sizes, which determine the value of the ‘svh’ and ‘lvh’ unit, respectively. Only supported for top-level frames.
- SetSmall
Viewport Height Difference Override Params Builder - SetTimezone
Override Params - Overrides default host system timezone with the specified one.
- SetTimezone
Override Params Builder - SetTouch
Emulation Enabled Params - Enables touch on platforms which do not support them.
- SetTouch
Emulation Enabled Params Builder - SetUser
Agent Override Params - Allows overriding user agent with the given string. ‘userAgentMetadata’ must be set for Client Hint headers to be sent.
- SetUser
Agent Override Params Builder - SetVirtual
Time Policy Params - 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.
- SetVirtual
Time Policy Params Builder - SetVirtual
Time Policy Returns - 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.
- SetVirtual
Time Policy Returns Builder - SetVisible
Size Params - 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.
- SetVisible
Size Params Builder - Update
Screen Params - Updates specified screen parameters. Only supported in headless mode.
- Update
Screen Params Builder - Update
Screen Returns - Updates specified screen parameters. Only supported in headless mode.
- Update
Screen Returns Builder - User
Agent Brand Version - Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints
- User
Agent Brand Version Builder - User
Agent Metadata - 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.
- User
Agent Metadata Builder - Work
Area Insets - Work
Area Insets Builder
Enums§
- Disabled
Image Type - Enum of image types that can be disabled.
- Pressure
Source - Pressure
State - Sensor
Type - Used to specify sensor types to emulate. See https://w3c.github.io/sensors/#automation for more information.
- Virtual
Time Policy - 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.