2022-07-05 13:41:43 +00:00
|
|
|
---
|
|
|
|
sidebar_label: Viewport
|
|
|
|
---
|
|
|
|
|
|
|
|
# Viewport interface
|
|
|
|
|
2022-10-24 07:07:05 +00:00
|
|
|
#### Signature:
|
2022-07-05 13:41:43 +00:00
|
|
|
|
|
|
|
```typescript
|
|
|
|
export interface Viewport
|
|
|
|
```
|
|
|
|
|
|
|
|
## Properties
|
|
|
|
|
2024-03-20 15:03:14 +00:00
|
|
|
<table><thead><tr><th>
|
|
|
|
|
|
|
|
Property
|
|
|
|
|
|
|
|
</th><th>
|
|
|
|
|
|
|
|
Modifiers
|
|
|
|
|
|
|
|
</th><th>
|
|
|
|
|
|
|
|
Type
|
|
|
|
|
|
|
|
</th><th>
|
|
|
|
|
|
|
|
Description
|
|
|
|
|
|
|
|
</th><th>
|
|
|
|
|
|
|
|
Default
|
|
|
|
|
|
|
|
</th></tr></thead>
|
|
|
|
<tbody><tr><td>
|
|
|
|
|
2024-04-11 11:01:13 +00:00
|
|
|
<span id="devicescalefactor">deviceScaleFactor</span>
|
2024-03-20 15:03:14 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
number
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
Specify device scale factor. See [devicePixelRatio](https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio) for more info.
|
|
|
|
|
2024-04-29 12:50:39 +00:00
|
|
|
**Remarks:**
|
|
|
|
|
|
|
|
Setting this value to `0` will reset this value to the system default.
|
|
|
|
|
2024-03-20 15:03:14 +00:00
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`1`
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 11:01:13 +00:00
|
|
|
<span id="hastouch">hasTouch</span>
|
2024-03-20 15:03:14 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
boolean
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
Specify if the viewport supports touch events.
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`false`
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 11:01:13 +00:00
|
|
|
<span id="height">height</span>
|
2024-03-20 15:03:14 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
number
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
The page height in CSS pixels.
|
|
|
|
|
2024-04-29 12:50:39 +00:00
|
|
|
**Remarks:**
|
|
|
|
|
|
|
|
Setting this value to `0` will reset this value to the system default.
|
|
|
|
|
2024-03-20 15:03:14 +00:00
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 11:01:13 +00:00
|
|
|
<span id="islandscape">isLandscape</span>
|
2024-03-20 15:03:14 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
boolean
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
Specifies if the viewport is in landscape mode.
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`false`
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 11:01:13 +00:00
|
|
|
<span id="ismobile">isMobile</span>
|
2024-03-20 15:03:14 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
boolean
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
Whether the `meta viewport` tag is taken into account.
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`false`
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 11:01:13 +00:00
|
|
|
<span id="width">width</span>
|
2024-03-20 15:03:14 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
number
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
The page width in CSS pixels.
|
|
|
|
|
2024-04-29 12:50:39 +00:00
|
|
|
**Remarks:**
|
|
|
|
|
|
|
|
Setting this value to `0` will reset this value to the system default.
|
|
|
|
|
2024-03-20 15:03:14 +00:00
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
</tbody></table>
|