chrome-devtools-kotlin/org.hildan.chrome.devtools.domains.emulation/SetDeviceMetricsOverrideRequest

SetDeviceMetricsOverrideRequest

@Serializable

data class SetDeviceMetricsOverrideRequest(val width: Int, val height: Int, val deviceScaleFactor: Double, val mobile: Boolean, val scale: Double? = null, val screenWidth: Int? = null, val screenHeight: Int? = null, val positionX: Int? = null, val positionY: Int? = null, val dontSetVisibleSize: Boolean? = null, val screenOrientation: ScreenOrientation? = null, val viewport: Viewport? = null, val displayFeature: DisplayFeature? = null, val devicePosture: DevicePosture? = null)

Request object containing input parameters for the EmulationDomain.setDeviceMetricsOverride command.

Constructors

constructor(width: Int, height: Int, deviceScaleFactor: Double, mobile: Boolean, scale: Double? = null, screenWidth: Int? = null, screenHeight: Int? = null, positionX: Int? = null, positionY: Int? = null, dontSetVisibleSize: Boolean? = null, screenOrientation: ScreenOrientation? = null, viewport: Viewport? = null, displayFeature: DisplayFeature? = null, devicePosture: DevicePosture? = null)

Types

Builder

class Builder(val width: Int, val height: Int, val deviceScaleFactor: Double, val mobile: Boolean)

A builder for SetDeviceMetricsOverrideRequest, which allows setting the optional parameters of the EmulationDomain.setDeviceMetricsOverride command via a lambda.

Properties

devicePosture

val ~~devicePosture~~: DevicePosture?

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

deviceScaleFactor

val deviceScaleFactor: Double

Overriding device scale factor value. 0 disables the override.

displayFeature

val ~~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.

dontSetVisibleSize

val dontSetVisibleSize: Boolean?

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

height

val height: Int

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

mobile

val mobile: Boolean

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

positionX

val positionX: Int?

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

positionY

val positionY: Int?

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

scale

val scale: Double?

Scale to apply to resulting view image.

screenHeight

val screenHeight: Int?

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

screenOrientation

val screenOrientation: ScreenOrientation?

Screen orientation override.

screenWidth

val screenWidth: Int?

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

viewport

val viewport: 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.

width

val width: Int

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