← Back to Page domain

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

Domain: Page deprecated

Parameters

NameTypeDescription
widthintegerOverriding width value in pixels (minimum 0, maximum 10000000). 0 disables the override.
heightintegerOverriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override.
deviceScaleFactornumberOverriding device scale factor value. 0 disables the override.
mobilebooleanWhether to emulate mobile device. This includes viewport meta tag, overlay scrollbars, text autosizing and more.
scale (optional)numberScale to apply to resulting view image.
screenWidth (optional)integerOverriding screen width value in pixels (minimum 0, maximum 10000000).
screenHeight (optional)integerOverriding screen height value in pixels (minimum 0, maximum 10000000).
positionX (optional)integerOverriding view X position on screen in pixels (minimum 0, maximum 10000000).
positionY (optional)integerOverriding view Y position on screen in pixels (minimum 0, maximum 10000000).
dontSetVisibleSize (optional)booleanDo not set visible view size, rely upon explicit setVisibleSize call.
screenOrientation (optional)Emulation.ScreenOrientationScreen orientation override.
viewport (optional)ViewportThe viewport dimensions and scale. If not set, the override is cleared.

Example Request

{
  "id": 1,
  "method": "Page.setDeviceMetricsOverride",
  "params": {
    "width": 1280,
    "height": 720,
    "deviceScaleFactor": 1.0,
    "mobile": true
  }
}

Example Response

{
  "id": 1,
  "result": {}
}

Usage in Node.js

const result = await send('Page.setDeviceMetricsOverride', {"width": 1280, "height": 720, "deviceScaleFactor": 1.0, "mobile": true});
console.log(result);