Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
86bb9c00
D
Docs
项目概览
OpenHarmony
/
Docs
大约 2 年 前同步成功
通知
161
Star
293
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
86bb9c00
编写于
6月 30, 2022
作者:
O
openharmony_ci
提交者:
Gitee
6月 30, 2022
浏览文件
操作
浏览文件
下载
差异文件
!5940 add screen.md
Merge pull request !5940 from 张必荣/master
上级
1ca062cd
cb3ff71b
变更
2
显示空白变更内容
内联
并排
Showing
2 changed file
with
644 addition
and
12 deletion
+644
-12
zh-cn/application-dev/reference/apis/js-apis-display.md
zh-cn/application-dev/reference/apis/js-apis-display.md
+32
-12
zh-cn/application-dev/reference/apis/js-apis-screen.md
zh-cn/application-dev/reference/apis/js-apis-screen.md
+612
-0
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-display.md
浏览文件 @
86bb9c00
...
...
@@ -14,11 +14,11 @@ import display from '@ohos.display';
## DisplayState
用于表示显示设备的状态
。
显示设备的状态枚举
。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
| 名称 |
默认
值 | 说明 |
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| STATE_UNKNOWN | 0 | 表示显示设备状态未知。|
| STATE_OFF | 1 | 表示显示设备状态为关闭。 |
...
...
@@ -56,7 +56,7 @@ import display from '@ohos.display';
getDefaultDisplay(callback: AsyncCallback
<
Display
>
): void
获取当前默认的display对象。
获取当前默认的display对象
,使用callback异步回调
。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
...
...
@@ -82,7 +82,7 @@ getDefaultDisplay(callback: AsyncCallback<Display>): void
getDefaultDisplay(): Promise
<
Display
>
获取当前默认的display对象。
获取当前默认的display对象
,使用Promise异步回调
。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
...
...
@@ -103,11 +103,31 @@ getDefaultDisplay(): Promise<Display>
});
```
## display.getDefaultDisplaySync<sup>9+</sup>
getDefaultDisplaySync(): Display
获取当前默认的display对象。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**返回值:**
| 类型 | 说明 |
| ------------------------------| ----------------------------------------------|
|
[
Display
](
#display
)
| 返回默认的display对象。 |
**示例:**
```
js
var
displayClass
=
display
.
getDefaultDisplaySync
();
```
## display.getAllDisplay
getAllDisplay(callback: AsyncCallback
<
Array
<
Display
>>
): void
获取当前所有的display对象。
获取当前所有的display对象
,使用callback异步回调
。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
...
...
@@ -133,7 +153,7 @@ getAllDisplay(callback: AsyncCallback<Array<Display>>): void
getAllDisplay(): Promise
<
Array
<
Display
>>
获取当前所有的display对象。
获取当前所有的display对象
,使用Promise异步回调
。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
...
...
@@ -158,15 +178,15 @@ getAllDisplay(): Promise<Array<Display>>
on(type: 'add'|'remove'|'change', callback: Callback
<
number
>
): void
开启监听。
开启
显示设备变化的
监听。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置监听类型。
<br/>
-
type为"add",表示监听增加显示设备。
<br/>
-
type为"remove",表示监听移除显示设备。
<br/>
-
type为"change",表示监听改变显示设备
。 |
| callback | Callback
<
number
>
| 是 | 回调函数。返回监听到的显示设备的id。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 监听事件。
<br/>
-
type为"add",表示增加显示设备事件。
<br/>
-
type为"remove",表示移除显示设备事件。
<br/>
-
type为"change",表示改变显示设备事件
。 |
| callback | Callback
<
number
>
| 是 | 回调函数。返回监听到的显示设备的id。 |
**示例:**
```
js
...
...
@@ -181,7 +201,7 @@ on(type: 'add'|'remove'|'change', callback: Callback<number>): void
off(type: 'add'|'remove'|'change', callback?: Callback
<
number
>
): void
关闭监听。
关闭
显示设备变化的
监听。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
...
...
zh-cn/application-dev/reference/apis/js-apis-screen.md
0 → 100644
浏览文件 @
86bb9c00
# 屏幕
本模块提供管理屏幕的一些基础能力,包括获取屏幕对象,监听屏幕变化,创建和销毁虚拟屏幕等。
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> 本模块接口为系统接口。
## 导入模块
```
js
import
screen
from
'
@ohos.screen
'
;
```
## screen.getAllScreens
getAllScreens(callback: AsyncCallback
<
Array
<
Screen
>>
): void
获取所有的屏幕,使用callback异步回调。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------- | ---- | -------------------------------------- |
| callback | AsyncCallback
<
Array
<
[Screen](#screen)
>>
| 是 | 回调函数。返回当前获取的屏幕对象集合。 |
**示例:**
```
js
var
screenClass
=
null
;
screen
.
getAllScreens
((
err
,
data
)
=>
{
if
(
err
.
code
)
{
console
.
error
(
'
Failed to get all screens . Cuase:
'
+
JSON
.
stringify
(
err
));
return
;
}
console
.
info
(
'
Succeeded in getting all screens . Data:
'
+
JSON
.
stringify
(
data
));
screenClass
=
data
[
0
];
});
```
## screen.getAllScreens
getAllScreens(): Promise
<
Array
<
Screen
>>
获取所有的屏幕,使用Promise异步回调。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**返回值:**
| 类型 | 说明 |
| --------------------------------------------- | ----------------------------------------- |
| Promise
<
Array
<
[Screen](#screen)
>>
| Promise对象。返回当前创建的屏幕对象集合。 |
**示例:**
```
js
var
screenClass
=
null
;
let
promise
=
screen
.
getAllScreen
();
promise
.
then
((
data
)
=>
{
screenClass
=
data
[
0
];
console
.
log
(
'
Succeeded in getting all screens . Data:
'
+
JSON
.
stringify
(
data
));
}).
catch
((
err
)
=>
{
console
.
log
(
'
Failed to get all screens . Cause:
'
+
JSON
.
stringify
(
err
));
});
```
## screen.on('connect' | 'disconnect' | 'change')
on(eventType: 'connect' | 'disconnect' | 'change', callback: Callback
<
number
>
): void
开启屏幕状态变化的监听。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------- | ---- | ------------------------------------------------------------ |
| eventType | string | 是 | 监听事件。
<br/>
-eventType为"connect"表示屏幕连接事件。
<br/>
-eventType为"disconnect"表示断开屏幕连接事件。
<br/>
-eventType为"change"表示屏幕状态改变事件。 |
| callback | Callback
<
number
>
| 是 | 回调函数。返回屏幕的id。 |
**示例:**
```
js
var
callback
=
(
data
)
=>
{
console
.
info
(
'
Register the callback for screen changes. Data:
'
+
JSON
.
stringify
(
data
))
};
screen
.
on
(
"
connect
"
,
callback
);
```
## screen.off('connect' | 'disconnect' | 'change')
off(eventType: 'connect' | 'disconnect' | 'change', callback?: Callback
<
number
>
): void
关闭屏幕状态变化的监听。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------- | ---- | ------------------------------------------------------------ |
| eventType | string | 是 | 监听事件。
<br/>
-eventType为"connect"表示屏幕连接事件。
<br/>
-eventType为"disconnect"表示断开屏幕连接事件。
<br/>
-eventType为"change"表示屏幕状态改变事件。 |
| callback | Callback
<
number
>
| 否 | 回调函数。返回屏幕的id。 |
**示例:**
```
js
var
callback
=
(
data
)
=>
{
console
.
info
(
'
Unegister the callback for screen changes. Data:
'
+
JSON
.
stringify
(
data
))
};
screen
.
off
(
"
connect
"
,
callback
);
```
## screen.makeExpand
makeExpand(options:Array
<
ExpandOption
>
, callback: AsyncCallback
<
number
>
): void
将屏幕设置为扩展模式,使用callback异步回调。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------ | ---- | -------------------------------- |
| options | Array
<
[ExpandOption](#expandoption)
>
| 是 | 设置扩展屏幕的参数集合。 |
| callback | Callback
<
number
>
| 是 | 回调函数。返回扩展屏幕的群组id。 |
**示例:**
```
js
var
groupId
=
null
;
screen
.
makeExpand
([{
screenId
:
0
,
startX
:
0
,
startY
:
0
},
{
screenId
:
1
,
startX
:
1080
,
startY
:
0
}],
(
err
,
data
)
=>
{
if
(
err
.
code
)
{
console
.
error
(
'
Failed to make screens as expand-screen. Cause:
'
+
JSON
.
stringify
(
err
));
return
;
}
groupId
=
data
;
console
.
info
(
'
Succeeded in making screens as expand-screen.Data:
'
+
JSON
.
stringify
(
data
));
});
```
## screen.makeExpand
makeExpand(options:Array
<
ExpandOption
>
): Promise
<
number
>
将屏幕设置为扩展模式,使用Promise异步回调。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------------------ | ---- | ------------------------ |
| options | Array
<
[ExpandOption](#expandoption)
>
| 是 | 设置扩展屏幕的参数集合。 |
**返回值:**
| 类型 | 说明 |
| --------------------- | ----------------------------------- |
| Promise
<
number
>
| Promise对象。返回扩展屏幕的群组id。 |
**示例:**
```
js
screen
.
makeExpand
([{
screenId
:
0
,
startX
:
0
,
startY
:
0
},
{
screenId
:
1
,
startX
:
1080
,
startY
:
0
}]).
then
((
data
)
=>
{
console
.
info
(
'
Succeeded in making screens as expand-screen.Data:
'
+
JSON
.
stringify
(
data
));
}).
catch
((
err
)
=>
{
console
.
error
(
'
Failed to make screens as expand-screen. Cause:
'
+
JSON
.
stringify
(
err
));
});
```
## screen.makeMirror
makeMirror(mainScreen:number, mirrorScreen:Array
<
number
>
, callback: AsyncCallback
<
number
>
): void
将屏幕设置为镜像模式,使用callback异步回调。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | --------------------------- | ---- |-----------------|
| mainScreen | number | 是 | 主屏幕id。 |
| mirrorScreen | Array
<
number
>
| 是 | 镜像屏幕id集合。 |
| callback | AsyncCallback
<
number
>
| 是 | 回调函数。返回镜像屏幕的群组id。 |
**示例:**
```
js
var
mainScreenId
=
0
;
var
mirrorScreenIds
=
[
1
,
2
,
3
];
screen
.
makeMirror
(
mainScreenId
,
mirrorScreenIds
,
(
err
,
data
)
=>
{
if
(
err
.
code
)
{
console
.
error
(
'
Failed to make screens as mirror-screen.Cause:
'
+
JSON
.
stringify
(
err
));
return
;
}
console
.
info
(
'
Succeeded in making screens as mirror-screen.Data:
'
+
JSON
.
stringify
(
data
));
});
```
## screen.makeMirror
makeMirror(mainScreen:number, mirrorScreen:Array
<
number
>
): Promise
<
number
>
将屏幕设置为镜像模式,使用Promise异步回调。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ------------------- | ---- |-----------|
| mainScreen | number | 是 | 主屏幕id。 |
| mirrorScreen | Array
<
number
>
| 是 | 镜像屏幕id集合。 |
**返回值:**
| 类型 | 说明 |
| --------------------- | ----------------------------------- |
| Promise
<
number
>
| Promise对象。返回镜像屏幕的群组id。 |
**示例:**
```
js
var
mainScreenId
=
0
;
var
mirrorScreenIds
=
[
1
,
2
,
3
];
screen
.
makeMirror
(
mainScreenId
,
mirrorScreenIds
).
then
((
data
)
=>
{
console
.
info
(
'
Succeeded in making screens as mirror-screen.Data:
'
+
JSON
.
stringify
(
data
));
}).
catch
((
err
)
=>
{
console
.
error
(
'
Failed to make screens as mirror-screen.Cause:
'
+
JSON
.
stringify
(
err
));
});
```
## screen.createVirtualScreen
createVirtualScreen(options:VirtualScreenOption, callback: AsyncCallback
<
Screen
>
): void
创建虚拟屏幕,使用callback异步回调。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------- | ---- | ---------------------------------- |
| options |
[
VirtualScreenOption
](
#virtualscreenoption
)
| 是 | 用于创建虚拟屏幕的参数。 |
| callback | AsyncCallback
<
[Screen](#screen)
>
| 是 | 回调函数,返回创建的虚拟屏幕对象。 |
**示例:**
```
js
var
screenClass
=
null
;
screen
.
createVirtualScreen
({
name
:
'
screen01
'
,
width
:
1080
,
height
:
2340
,
density
:
2
,
surfaceId
:
''
},
(
err
,
data
)
=>
{
if
(
err
.
code
)
{
console
.
error
(
'
Failed to create virtual screen.Cause:
'
+
JSON
.
stringify
(
err
));
return
;
}
screenClass
=
data
;
console
.
info
(
'
Succeeded in creating virtual screen.Data:
'
+
JSON
.
stringify
(
data
));
});
```
## screen.createVirtualScreen
createVirtualScreen(options:VirtualScreenOption): Promise
<
Screen
>
创建虚拟屏幕,使用Promise异步回调。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------------------- | ---- | ------------------------ |
| options |
[
VirtualScreenOption
](
#virtualscreenoption
)
| 是 | 用于创建虚拟屏幕的参数。 |
**返回值:**
| 类型 | 说明 |
| -------------------------------- | ------------------------------------- |
| Promise
<
[Screen](#screen)
>
| Promise对象。返回创建的虚拟屏幕对象。 |
**示例:**
```
js
var
screenClass
=
null
;
screen
.
createVirtualScreen
({
name
:
'
screen01
'
,
width
:
1080
,
height
:
2340
,
density
:
2
,
surfaceId
:
''
}).
then
((
data
)
=>
{
screenClass
=
data
;
console
.
info
(
'
Succeeded in creating virtual screen.Data:
'
+
JSON
.
stringify
(
data
));
}).
catch
((
err
)
=>
{
console
.
error
(
'
Failed to create virtual screen.Cause:
'
+
JSON
.
stringify
(
err
));
});
```
## screen.destroyVirtualScreen
destroyVirtualScreen(screenId:number, callback: AsyncCallback
<
void
>
): void
销毁虚拟屏幕,使用callback异步回调。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| screenId | number | 是 | 屏幕的id。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。当销毁虚拟屏幕成功,err为undefined,否则为错误对象。 |
**示例:**
```
js
var
screenId
=
1
;
screen
.
destroyVirtualScreen
(
screenId
,
(
err
,
data
)
=>
{
if
(
err
.
code
)
{
console
.
error
(
'
Failed to destroy virtual screen.Cause:
'
+
JSON
.
stringify
(
err
));
return
;
}
console
.
info
(
'
Succeeded in destroying virtual screen.
'
);
});
```
## screen.destroyVirtualScreen
destroyVirtualScreen(screenId:number): Promise
<
void
>
销毁虚拟屏幕,使用Promise异步回调。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---------- |
| screenId | number | 是 | 屏幕的id。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ------------------------- |
| Promise
<
void
>
| 无返回结果的Promise对象。 |
**示例:**
```
js
var
screenId
=
1
;
screen
.
destroyVirtualScreen
(
screenId
).
then
((
data
)
=>
{
console
.
info
(
'
Succeeded in destroying virtual screen.
'
);
}).
catch
((
err
)
=>
{
console
.
error
(
'
Failed to destroy virtual screen.Cause:
'
+
JSON
.
stringify
(
err
));
});
```
## screen.setVirtualScreenSurface
setVirtualScreenSurface(screenId:number, surfaceId: string, callback: AsyncCallback
<
void
>
): void
设置虚拟屏幕的surface,使用callback异步回调。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------- | ---- | ------------------------------------------------------------ |
| screenId | number | 是 | 屏幕的id。 |
| surfaceId | string | 是 | surface的id。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。当设置虚拟屏幕surface成功,err为undefined,否则为错误对象。 |
**示例:**
```
js
var
screenId
=
1
;
var
surfaceId
=
'
2048
'
;
screen
.
setVirtualScreenSurface
(
screenId
,
surfaceId
,
(
err
,
data
)
=>
{
if
(
err
.
code
)
{
console
.
error
(
'
Failed to Set surface for the virtual screen.Cause:
'
+
JSON
.
stringify
(
err
));
return
;
}
console
.
info
(
'
Succeeded in setting surface for the virtual screen.
'
);
});
```
## screen.setVirtualScreenSurface
setVirtualScreenSurface(screenId:number, surfaceId: string): Promise
<
void
>
设置虚拟屏幕的surface,使用Promise异步回调。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ------------- |
| screenId | number | 是 | 屏幕的id。 |
| surfaceId | string | 是 | surface的id。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ------------------------- |
| Promise
<
void
>
| 无返回结果的Promise对象。 |
**示例:**
```
js
var
screenId
=
1
;
var
surfaceId
=
'
2048
'
;
screen
.
setVirtualScreenSurface
(
screenId
,
surfaceId
).
then
((
data
)
=>
{
console
.
info
(
'
Succeeded in setting surface for the virtual screen.
'
);
}).
catch
((
err
)
=>
{
console
.
error
(
'
Failed to Set surface for the virtual screen.Cause:
'
+
JSON
.
stringify
(
err
));
});
```
## ExpandOption
扩展屏幕的参数。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | ---- | ---- | ------------------- |
| screenId | number | 是 | 是 | 屏幕的id。 |
| startX | number | 是 | 是 | 屏幕的起始X轴坐标。 |
| startY | number | 是 | 是 | 屏幕的起始Y轴坐标。 |
## VirtualScreenOption
创建虚拟屏幕的参数。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| --------- | -------- | ---- | ---- | ------------------------- |
| name | string | 是 | 是 | 指定虚拟屏幕的名称。 |
| width | number | 是 | 是 | 指定虚拟屏幕的宽度。 |
| height | number | 是 | 是 | 指定虚拟屏幕的高度。 |
| density | number | 是 | 是 | 指定虚拟屏幕的密度。 |
| surfaceId | string | 是 | 是 | 指定虚拟屏幕的surfaceId。 |
## Screen
屏幕实例。
下列API示例中都需先使用
[
getAllScreens()
](
#screengetallscreens
)
、
[
createVirtualScreen()
](
#screencreatevirtualscreen
)
中的任一方法获取到Screen实例,再通过此实例调用对应方法。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ----------------- | ---------------------------------------------- | ---- | ---- | ---------------------- |
| id | number | 是 | 否 | 屏幕的id。 |
| parent | number | 是 | 否 | 屏幕所属群组的id。 |
| supportedModeInfo | Array
<
[ScreenModeInfo](#screenmodeinfo)
>
| 是 | 否 | 屏幕支持的模式集合。 |
| activeModeIndex | number | 是 | 否 | 当前屏幕所处模式索引。 |
| orientation |
[
Orientation
](
#rientation
)
| 是 | 否 | 屏幕方向。 |
### setOrientation
setOrientation(orientation: Orientation, callback: AsyncCallback
<
void
>
): void
设置屏幕方向,使用callback异步回调。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | --------------------------- | ---- | ------------------------------------------------------------ |
| orientation |
[
Orientation
](
#orientation
)
| 是 | 屏幕方向。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。当设置屏幕方向成功,err为undefined,否则为错误对象。 |
**示例:**
```
js
screenClass
.
setOrientation
(
screen
.
Orientation
.
VERTICAL
,
(
err
,
data
)
=>
{
if
(
err
.
code
)
{
console
.
error
(
'
Failed to setOrientation VERTICAL. Cause:
'
+
JSON
.
stringify
(
err
));
return
;
}
console
.
info
(
'
Succeeded in setting Orientation VERTICAL. data:
'
+
JSON
.
stringify
(
data
));
})
```
### setOrientation
setOrientation(orientation: Orientation): Promise
<
void
>
设置屏幕方向,使用Promise异步回调。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | --------------------------- | ---- | ---------- |
| orientation |
[
Orientation
](
#orientation
)
| 是 | 屏幕方向。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ------------------------- |
| Promise
<
void
>
| 无返回结果的Promise对象。 |
**示例:**
```
js
let
promise
=
screenClass
.
setOrientation
(
screen
.
Orientation
.
VERTICAL
);
promise
.
then
((
data
)
=>
{
console
.
info
(
'
Succeeded in setting Orientation VERTICAL. Data:
'
+
JSON
.
stringify
(
data
));
}).
catch
((
err
)
=>
{
console
.
error
(
'
Failed to set Orientation VERTICAL. Cause:
'
+
JSON
.
stringify
(
err
));
})
```
### setScreenActiveMode
setScreenActiveMode(modeIndex: number, callback: AsyncCallback
<
void
>
): void
设置屏幕当前显示模式,使用callback异步回调。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------- | ---- | ------------------------------------------------------------ |
| modeIndex | number | 是 | 模式索引。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。当设置屏幕当前显示模式成功,err为undefined,否则为错误对象。 |
**示例:**
```
js
var
modeIndex
=
0
;
screenClass
.
setScreenActiveMode
(
modeIndex
,
(
err
,
data
)
=>
{
if
(
err
.
code
)
{
console
.
error
(
'
Failed to set ScreenActiveMode 0. Cause:
'
+
JSON
.
stringify
(
err
));
return
;
}
console
.
info
(
'
Succeeded in setting ScreenActiveMode 0. data:
'
+
JSON
.
stringify
(
data
));
})
```
### setScreenActiveMode
setScreenActiveMode(modeIndex: number): Promise
<
void
>
设置屏幕当前显示模式,使用Promise异步回调。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ---------- |
| modeIndex | number | 是 | 模式索引。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ------------------------- |
| Promise
<
void
>
| 无返回结果的Promise对象。 |
**示例:**
```
js
var
modeIndex
=
0
;
let
promise
=
screenClass
.
setScreenActiveMode
(
modeIndex
);
promise
.
then
((
data
)
=>
{
console
.
info
(
'
Succeeded in setting ScreenActiveMode 0. Data:
'
+
JSON
.
stringify
(
data
));
}).
catch
((
err
)
=>
{
console
.
error
(
'
Failed to set ScreenActiveMode 0. Cause:
'
+
JSON
.
stringify
(
err
));
})
```
### setDensityDpi
setDensityDpi(densityDpi: number, callback: AsyncCallback
<
void
>
): void;
设置屏幕的像素密度,使用callback异步回调。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------- | ---- | ------------------------------------------------------------ |
| densityDpi | number | 是 | 像素密度。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。当设置屏幕的像素密度成功,err为undefined,否则为错误对象。 |
**示例:**
```
js
var
densityDpi
=
320
;
screenClass
.
setDensityDpi
(
densityDpi
,
(
err
,
data
)
=>
{
if
(
err
.
code
)
{
console
.
error
(
'
Failed to set DensityDpi 320. Cause:
'
+
JSON
.
stringify
(
err
));
return
;
}
console
.
info
(
'
Succeed in setting DensityDpi 320. data:
'
+
JSON
.
stringify
(
data
));
})
```
### setDensityDpi
setDensityDpi(densityDpi: number): Promise
<
void
>
设置屏幕的像素密度,使用Promise异步回调。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ---------- |
| densityDpi | number | 是 | 像素密度。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ------------------------- |
| Promise
<
void
>
| 无返回结果的Promise对象。 |
**示例:**
```
js
var
densityDpi
=
320
;
var
promise
=
screenClass
.
setDensityDpi
(
densityDpi
);
promise
.
then
((
data
)
=>
{
console
.
info
(
'
Succeeded in setting DensityDpi 320. Data:
'
+
JSON
.
stringify
(
data
));
}).
catch
((
err
)
=>
{
console
.
error
(
'
Failed to set DensityDpi 320. Cause:
'
+
JSON
.
stringify
(
err
));
})
```
## Orientation
屏幕方向枚举。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
| 名称 | 值 | 说明 |
| ------------------ | ---- | -------------------------------- |
| UNSPECIFIED | 0 | 表示未指定屏幕方向,由系统指定。 |
| VERTICAL | 1 | 表示指定屏幕为垂直方向。 |
| HORIZONTAL | 2 | 表示指定屏幕为水平方向。 |
| REVERSE_VERTICAL | 3 | 表示指定屏幕为反向垂直方向。 |
| REVERSE_HORIZONTAL | 4 | 表示指定屏幕为反向水平方向。 |
| SENSOR | 5 | 表示屏幕方向跟随传感器方向。 |
| SENSOR_VERTICAL | 6 | 表示屏幕方向垂直跟随传感器方向。 |
| SENSOR_HORIZONTAL | 7 | 表示屏幕方向水平跟随传感器方向。 |
## ScreenModeInfo
屏幕显示模式信息。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ----------- | -------- | ---- | ---- | -------------------------------------------------- |
| id | number | 是 | 是 | 模式id,所支持的模式由具体设备分辨率和刷新率决定。 |
| width | number | 是 | 是 | 屏幕的宽度。 |
| height | number | 是 | 是 | 屏幕的高度。 |
| refreshRate | number | 是 | 是 | 屏幕的刷新率。 |
\ No newline at end of file
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录