Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
ee2d1a68
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看板
提交
ee2d1a68
编写于
6月 14, 2023
作者:
I
ineoui
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
半角全角问题,以及一些范围的格式书写问题
Signed-off-by:
N
ineoui
<
xiazhiqi1@huawei.com
>
上级
5c184f1b
变更
4
显示空白变更内容
内联
并排
Showing
4 changed file
with
215 addition
and
215 deletion
+215
-215
zh-cn/application-dev/reference/apis/js-apis-display.md
zh-cn/application-dev/reference/apis/js-apis-display.md
+26
-26
zh-cn/application-dev/reference/apis/js-apis-screen.md
zh-cn/application-dev/reference/apis/js-apis-screen.md
+69
-69
zh-cn/application-dev/reference/apis/js-apis-screenshot.md
zh-cn/application-dev/reference/apis/js-apis-screenshot.md
+8
-8
zh-cn/application-dev/reference/apis/js-apis-window.md
zh-cn/application-dev/reference/apis/js-apis-window.md
+112
-112
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-display.md
浏览文件 @
ee2d1a68
...
...
@@ -49,10 +49,10 @@ import display from '@ohos.display';
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | -------- | ---- | ---- | ------------------ |
| left | number | 是 | 是 | 矩形区域的左边界,单位为像素。 |
| top | number | 是 | 是 | 矩形区域的上边界,单位为像素。 |
| width | number | 是 | 是 | 矩形区域的宽度,单位为像素。 |
| height | number | 是 | 是 | 矩形区域的高度,单位为像素。 |
| left | number | 是 | 是 | 矩形区域的左边界,单位为像素
,该参数应为整数
。 |
| top | number | 是 | 是 | 矩形区域的上边界,单位为像素
,该参数应为整数
。 |
| width | number | 是 | 是 | 矩形区域的宽度,单位为像素
,该参数应为整数
。 |
| height | number | 是 | 是 | 矩形区域的高度,单位为像素
,该参数应为整数
。 |
## WaterfallDisplayAreaRects<sup>9+</sup>
...
...
@@ -196,7 +196,7 @@ hasPrivateWindow(displayId: number): boolean
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------------- | ---- |----------|
| id | number | 是 | 显示设备的id。 |
| id | number | 是 | 显示设备的id
,该参数仅支持整数输入
。 |
**返回值:**
...
...
@@ -249,9 +249,9 @@ on(type: 'add'|'remove'|'change', callback: Callback<number>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- |
--------
|
| -------- | -------- | -------- |
---------------------------------------------------------------------------------------------------------------------------------
|
| type | string | 是 | 监听事件。
<br/>
- type为"add",表示增加显示设备事件。例如:插入显示器。
<br/>
- type为"remove",表示移除显示设备事件。例如:移除显示器。
<br/>
- type为"change",表示改变显示设备事件。例如:显示器方向改变。 |
| callback | Callback
<
number
>
| 是 | 回调函数。返回监听到的显示设备的id
。
|
| callback | Callback
<
number
>
| 是 | 回调函数。返回监听到的显示设备的id
,该参数应为整数。
|
**示例:**
...
...
@@ -279,7 +279,7 @@ off(type: 'add'|'remove'|'change', callback?: Callback<number>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 监听事件。
<br/>
- type为"add",表示增加显示设备事件。例如:插入显示器。
<br/>
- type为"remove",表示移除显示设备事件。例如:移除显示器。
<br/>
- type为"change",表示改变显示设备事件。例如:显示器方向改变。 |
| callback | Callback
<
number
>
| 否 | 回调函数。返回监听到的显示设备的id。 |
| callback | Callback
<
number
>
| 否 | 回调函数。返回监听到的显示设备的id
,该参数应为整数
。 |
**示例:**
...
...
@@ -480,21 +480,21 @@ promise.then((data) => {
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- |
--------
|
| id | number | 是 | 否 | 显示设备的id号
。
|
| name | string | 是 | 否 | 显示设备的名称。|
| alive | boolean | 是 | 否 | 显示设备是否启用。|
| state |
[
DisplayState
](
#displaystate
)
| 是 | 否 | 显示设备的状态。|
| refreshRate | number | 是 | 否 | 显示设备的刷新率
。
|
| rotation | number | 是 | 否 | 显示设备的屏幕旋转角度。
<br>
值为0时,表示显示设备屏幕旋转为0°;
<br>
值为1时,表示显示设备屏幕旋转为90°;
<br>
值为2时,表示显示设备屏幕旋转为180°;
<br>
值为3时,表示显示设备屏幕旋转为270°。|
| width | number | 是 | 否 | 显示设备的宽度,单位为像素
。
|
| height | number | 是 | 否 | 显示设备的高度,单位为像素
。
|
| densityDPI | number | 是 | 否 | 显示设备的屏幕密度,表示每英寸点数。
一般取值160,480等。
|
| -------- | -------- | -------- | -------- |
---------------------------------------------------------------------------------------------------------------
|
| id | number | 是 | 否 | 显示设备的id号
,该参数应为整数。
|
| name | string | 是 | 否 | 显示设备的名称。
|
| alive | boolean | 是 | 否 | 显示设备是否启用。
|
| state |
[
DisplayState
](
#displaystate
)
| 是 | 否 | 显示设备的状态。
|
| refreshRate | number | 是 | 否 | 显示设备的刷新率
,该参数应为整数。
|
| rotation | number | 是 | 否 | 显示设备的屏幕旋转角度。
<br>
值为0时,表示显示设备屏幕旋转为0°;
<br>
值为1时,表示显示设备屏幕旋转为90°;
<br>
值为2时,表示显示设备屏幕旋转为180°;
<br>
值为3时,表示显示设备屏幕旋转为270°。
|
| width | number | 是 | 否 | 显示设备的宽度,单位为像素
,该参数应为整数。
|
| height | number | 是 | 否 | 显示设备的高度,单位为像素
,该参数应为整数。
|
| densityDPI | number | 是 | 否 | 显示设备的屏幕密度,表示每英寸点数。
该参数为浮点数,一般取值160.0、480.0等。
|
| orientation
<sup>
10+
</sup>
|
[
Orientation
](
#orientation10
)
| 是 | 否 | 表示屏幕当前显示的方向。 |
| densityPixels | number | 是 | 否 | 显示设备的逻辑密度,是像素单位无关的缩放系数。
一般取值1,3等。
|
| scaledDensity | number | 是 | 否 | 显示设备的显示字体的缩放因子。
通常与densityPixels相同。
|
| xDPI | number | 是 | 否 | x方向中每英寸屏幕的确切物理像素值
。
|
| yDPI | number | 是 | 否 | y方向中每英寸屏幕的确切物理像素值
。
|
| densityPixels | number | 是 | 否 | 显示设备的逻辑密度,是像素单位无关的缩放系数。
该参数为浮点数,一般取值1.0、3.0等。
|
| scaledDensity | number | 是 | 否 | 显示设备的显示字体的缩放因子。
该参数为浮点数,通常与densityPixels相同。
|
| xDPI | number | 是 | 否 | x方向中每英寸屏幕的确切物理像素值
,该参数为浮点数。
|
| yDPI | number | 是 | 否 | y方向中每英寸屏幕的确切物理像素值
,该参数为浮点数。
|
### getCutoutInfo<sup>9+</sup>
getCutoutInfo(callback: AsyncCallback
<
CutoutInfo
>
): void
...
...
@@ -507,7 +507,7 @@ getCutoutInfo(callback: AsyncCallback<CutoutInfo>): void
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | --------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback
<
[CutoutInfo](#cutoutinfo9)
>
| 是 | 回调函数。返回描述不可用屏幕区域的CutoutInfo对象。
。
|
| callback | AsyncCallback
<
[CutoutInfo](#cutoutinfo9)
>
| 是 | 回调函数。返回描述不可用屏幕区域的CutoutInfo对象。 |
**错误码:**
...
...
zh-cn/application-dev/reference/apis/js-apis-screen.md
浏览文件 @
ee2d1a68
...
...
@@ -96,9 +96,9 @@ on(eventType: 'connect' | 'disconnect' | 'change', callback: Callback<number&
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------- | ---- | -----------------------------------------------------------
-
|
| --------- | ---------------------- | ---- | ----------------------------------------------------------- |
| eventType | string | 是 | 监听事件。
<br/>
-eventType为"connect"表示屏幕连接事件。
<br/>
-eventType为"disconnect"表示断开屏幕连接事件。
<br/>
-eventType为"change"表示屏幕状态改变事件。 |
| callback | Callback
<
number
>
| 是 | 回调函数。返回屏幕的id
。
|
| callback | Callback
<
number
>
| 是 | 回调函数。返回屏幕的id
,该参数应为整数。
|
**示例:**
...
...
@@ -126,7 +126,7 @@ off(eventType: 'connect' | 'disconnect' | 'change', callback?: Callback<numbe
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------- | ---- | ------------------------------------------------------------ |
| eventType | string | 是 | 监听事件。
<br/>
-eventType为"connect"表示屏幕连接事件。
<br/>
-eventType为"disconnect"表示断开屏幕连接事件。
<br/>
-eventType为"change"表示屏幕状态改变事件。 |
| callback | Callback
<
number
>
| 否 | 回调函数。返回屏幕的id。 |
| callback | Callback
<
number
>
| 否 | 回调函数。返回屏幕的id
,该参数应为整数
。 |
**示例:**
...
...
@@ -152,9 +152,9 @@ makeExpand(options:Array<ExpandOption>, callback: AsyncCallback<number&
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------ | ---- |
--------------------------------
|
| -------- | ------------------------------------------ | ---- |
----------------------------
|
| options | Array
<
[ExpandOption](#expandoption)
>
| 是 | 设置扩展屏幕的参数集合。 |
| callback | AsyncCallback
<
number
>
| 是 | 回调函数。返回扩展屏幕的群组id。 |
| callback | AsyncCallback
<
number
>
| 是 | 回调函数。返回扩展屏幕的群组id
,其中id应为整数
。 |
**错误码:**
...
...
@@ -199,8 +199,8 @@ makeExpand(options:Array<ExpandOption>): Promise<number>
**返回值:**
| 类型 | 说明 |
| --------------------- |
-----------------------------------
|
| Promise
<
number
>
| Promise对象。返回扩展屏幕的群组id。 |
| --------------------- |
---------------------------------
|
| Promise
<
number
>
| Promise对象。返回扩展屏幕的群组id
,其中id应为整数
。 |
**错误码:**
...
...
@@ -235,8 +235,8 @@ stopExpand(expandScreen:Array<number>, callback: AsyncCallback<void>
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | --------------------------- | --- |
--------------------------------------------------------------
|
| expandScreen | Array
<
number
>
| 是 | 扩展屏幕id集合
。
|
| ------------ | --------------------------- | --- |
-----------------------------------------
|
| expandScreen | Array
<
number
>
| 是 | 扩展屏幕id集合
,其中id应为整数。
|
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。当停止屏幕扩展模式成功,err为undefined,否则为错误对象。 |
**错误码:**
...
...
@@ -275,8 +275,8 @@ stopExpand(expandScreen:Array<number>): Promise<void>
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ------------------- | --- |
---------------
|
| expandScreen | Array
<
number
>
| 是 | 扩展屏幕id集合。 |
| ------------ | ------------------- | --- |
--------------------
|
| expandScreen | Array
<
number
>
| 是 | 扩展屏幕id集合
,其中id应为整数
。 |
**返回值:**
...
...
@@ -318,10 +318,10 @@ makeMirror(mainScreen:number, mirrorScreen:Array<number>, callback: AsyncC
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | --------------------------- | ---- |-----------------|
| mainScreen | number | 是 | 主屏幕id
。
|
| mirrorScreen | Array
<
number
>
| 是 | 镜像屏幕id集合
。
|
| callback | AsyncCallback
<
number
>
| 是 | 回调函数。返回镜像屏幕的群组id
。
|
| ------------ | --------------------------- | ---- |-----------------
---
|
| mainScreen | number | 是 | 主屏幕id
,该参数仅支持整数输入。
|
| mirrorScreen | Array
<
number
>
| 是 | 镜像屏幕id集合
,其中id应为整数。
|
| callback | AsyncCallback
<
number
>
| 是 | 回调函数。返回镜像屏幕的群组id
,其中id应为整数。
|
**错误码:**
...
...
@@ -360,15 +360,15 @@ makeMirror(mainScreen:number, mirrorScreen:Array<number>): Promise<numb
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ------------------- | ---- |-----------|
| mainScreen | number | 是 | 主屏幕id
。
|
| mirrorScreen | Array
<
number
>
| 是 | 镜像屏幕id集合。 |
| ------------ | ------------------- | ---- |-----------
---------
|
| mainScreen | number | 是 | 主屏幕id
,该参数仅支持整数输入。
|
| mirrorScreen | Array
<
number
>
| 是 | 镜像屏幕id集合。
其中id应为整数。
|
**返回值:**
| 类型 | 说明 |
| --------------------- |
-----------------------------------
|
| Promise
<
number
>
| Promise对象。返回镜像屏幕的群组id。 |
| --------------------- |
---------------------------------
|
| Promise
<
number
>
| Promise对象。返回镜像屏幕的群组id
,其中id应为整数
。 |
**错误码:**
...
...
@@ -405,8 +405,8 @@ stopMirror(mirrorScreen:Array<number>, callback: AsyncCallback<void>
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | --------------------------- | --- |
--------------------------------------------------------------
|
| mirrorScreen | Array
<
number
>
| 是 | 镜像屏幕id集合
。
|
| ------------ | --------------------------- | --- |
-----------------------------------------
|
| mirrorScreen | Array
<
number
>
| 是 | 镜像屏幕id集合
,其中id应为整数。
|
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。当停止屏幕镜像模式成功,err为undefined,否则为错误对象。 |
**错误码:**
...
...
@@ -445,8 +445,8 @@ stopMirror(mirrorScreen:Array<number>): Promise<void>
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ------------------- | --- |
---------------
|
| mirrorScreen | Array
<
number
>
| 是 | 镜像屏幕id集合。 |
| ------------ | ------------------- | --- |
--------------------
|
| mirrorScreen | Array
<
number
>
| 是 | 镜像屏幕id集合
,其中id应为整数
。 |
**返回值:**
...
...
@@ -590,7 +590,7 @@ destroyVirtualScreen(screenId:number, callback: AsyncCallback<void>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| screenId | number | 是 | 屏幕的id。 |
| screenId | number | 是 | 屏幕的id
,该参数仅支持整数输入
。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。当销毁虚拟屏幕成功,err为undefined,否则为错误对象。 |
**错误码:**
...
...
@@ -630,7 +630,7 @@ destroyVirtualScreen(screenId:number): Promise<void>
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---------- |
| screenId | number | 是 | 屏幕的id。 |
| screenId | number | 是 | 屏幕的id
,该参数仅支持整数输入
。 |
**返回值:**
...
...
@@ -675,7 +675,7 @@ setVirtualScreenSurface(screenId:number, surfaceId: string, callback: AsyncCallb
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------- | ---- | ------------------------------------------------------------ |
| screenId | number | 是 | 屏幕的id。 |
| screenId | number | 是 | 屏幕的id
,该参数仅支持整数输入
。 |
| surfaceId | string | 是 | surface的id。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。当设置虚拟屏幕surface成功,err为undefined,否则为错误对象。 |
...
...
@@ -719,7 +719,7 @@ setVirtualScreenSurface(screenId:number, surfaceId: string): Promise<void>
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ------------- |
| screenId | number | 是 | 屏幕的id。 |
| screenId | number | 是 | 屏幕的id
,该参数仅支持整数输入
。 |
| surfaceId | string | 是 | surface的id。 |
**返回值:**
...
...
@@ -877,9 +877,9 @@ try {
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | ---- | ---- | ------------------- |
| screenId | number | 是 | 是 | 屏幕的id。 |
| startX | number | 是 | 是 | 屏幕的起始X轴坐标。 |
| startY | number | 是 | 是 | 屏幕的起始Y轴坐标。 |
| screenId | number | 是 | 是 | 屏幕的id
,该参数应为整数
。 |
| startX | number | 是 | 是 | 屏幕的起始X轴坐标
,该参数应为整数
。 |
| startY | number | 是 | 是 | 屏幕的起始Y轴坐标
,该参数应为整数
。 |
## VirtualScreenOption
...
...
@@ -888,11 +888,11 @@ try {
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| --------- | -------- | ---- | ---- |
-------------------------
|
| --------- | -------- | ---- | ---- |
--------------------------
|
| name | string | 是 | 是 | 指定虚拟屏幕的名称。 |
| width | number | 是 | 是 | 指定虚拟屏幕的宽度,单位为像素。 |
| height | number | 是 | 是 | 指定虚拟屏幕的高度,单位为像素。 |
| density | number | 是 | 是 | 指定虚拟屏幕的密度
。
|
| width | number | 是 | 是 | 指定虚拟屏幕的宽度,单位为像素
,该参数应为整数
。 |
| height | number | 是 | 是 | 指定虚拟屏幕的高度,单位为像素
,该参数应为整数
。 |
| density | number | 是 | 是 | 指定虚拟屏幕的密度
,该参数为浮点数。
|
| surfaceId | string | 是 | 是 | 指定虚拟屏幕的surfaceId。 |
## Screen
...
...
@@ -906,11 +906,11 @@ try {
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------------- | ---------------------------------------------- | ---- | ---- |
----------------------
|
| id | number | 是 | 否 | 屏幕的id
。
|
| parent | number | 是 | 否 | 屏幕所属群组的id
。
|
| ----------------- | ---------------------------------------------- | ---- | ---- |
-------------------------------------------------------------
|
| id | number | 是 | 否 | 屏幕的id
,该参数应为整数。
|
| parent | number | 是 | 否 | 屏幕所属群组的id
,该参数应为整数。
|
| supportedModeInfo | Array
<
[ScreenModeInfo](#screenmodeinfo)
>
| 是 | 否 | 屏幕支持的模式集合。 |
| activeModeIndex | number | 是 | 否 | 当前屏幕所处模式索引。模式索引的当前值和值的范围,会根据屏幕当前分辨率、刷新率和设备硬件差异产生变化。 |
| activeModeIndex | number | 是 | 否 | 当前屏幕所处模式索引。模式索引的当前值和值的范围,会根据屏幕当前分辨率、刷新率和设备硬件差异产生变化。
该参数应为整数。
|
| orientation |
[
Orientation
](
#orientation
)
| 是 | 否 | 屏幕方向。 |
| sourceMode
<sup>
10+
</sup>
|
[
ScreenSourceMode
](
#screensourcemode10
)
| 是 | 否 | 屏幕来源模式。 |
...
...
@@ -1002,7 +1002,7 @@ setScreenActiveMode(modeIndex: number, callback: AsyncCallback<void>): voi
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------- | ---- | ------------------------------------------------------------ |
| modeIndex | number | 是 | 模式索引。模式索引的当前值和值的范围,会根据屏幕当前分辨率、刷新率和设备硬件差异产生变化。 |
| modeIndex | number | 是 | 模式索引。模式索引的当前值和值的范围,会根据屏幕当前分辨率、刷新率和设备硬件差异产生变化
,该参数仅支持整数输入
。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。当设置屏幕当前显示模式成功,err为undefined,否则为错误对象。 |
**错误码:**
...
...
@@ -1040,7 +1040,7 @@ setScreenActiveMode(modeIndex: number): Promise<void>
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ---------- |
| modeIndex | number | 是 | 模式索引。模式索引的当前值和值的范围,会根据屏幕当前分辨率、刷新率和设备硬件差异产生变化。 |
| modeIndex | number | 是 | 模式索引。模式索引的当前值和值的范围,会根据屏幕当前分辨率、刷新率和设备硬件差异产生变化
,该参数仅支持整数输入
。 |
**返回值:**
...
...
@@ -1081,8 +1081,8 @@ setDensityDpi(densityDpi: number, callback: AsyncCallback<void>): void;
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------- | ---- |
------------------------------------------------------------
|
| densityDpi | number | 是 | 像素密度。支持的输入范围为
80-640。
|
| ---------- | ------------------------- | ---- |
------------------------------------------
|
| densityDpi | number | 是 | 像素密度。支持的输入范围为
[80, 640],该参数仅支持整数输入。
|
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。当设置屏幕的像素密度成功,err为undefined,否则为错误对象。 |
**错误码:**
...
...
@@ -1119,8 +1119,8 @@ setDensityDpi(densityDpi: number): Promise<void>
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- |
----------------------------------
|
| densityDpi | number | 是 | 像素密度。支持的输入范围为
80-640
。 |
| ---------- | ------ | ---- |
------------------------------------
|
| densityDpi | number | 是 | 像素密度。支持的输入范围为
[80, 640],该参数仅支持整数输入
。 |
**返回值:**
...
...
@@ -1187,7 +1187,7 @@ try {
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------- | -------- | ---- | ---- | -------------------------------------------------- |
| id | number | 是 | 是 | 模式id,所支持的模式由具体设备分辨率和刷新率决定。 |
| width | number | 是 | 是 | 屏幕的宽度,单位为像素。 |
| height | number | 是 | 是 | 屏幕的高度,单位为像素。 |
| refreshRate | number | 是 | 是 | 屏幕的刷新率。 |
\ No newline at end of file
| id | number | 是 | 是 | 模式id,所支持的模式由具体设备分辨率和刷新率决定,该参数应为整数。 |
| width | number | 是 | 是 | 屏幕的宽度,单位为像素,该参数应为整数。 |
| height | number | 是 | 是 | 屏幕的高度,单位为像素,该参数应为整数。 |
| refreshRate | number | 是 | 是 | 屏幕的刷新率,该参数应为整数,该参数应为整数。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-screenshot.md
浏览文件 @
ee2d1a68
...
...
@@ -25,8 +25,8 @@ import screenshot from '@ohos.screenshot';
| ---------------------- | ------------- | ---- | ------------------------------------------------------------ |
| screenRect |
[
Rect
](
#rect
)
| 否 | 表示截取图像的区域,不传值默认为全屏。 |
| imageSize |
[
Size
](
#size
)
| 否 | 表示截取图像的大小,不传值默认为全屏。 |
| rotation | number | 否 | 表示截取图像的旋转角度,当前仅支持输入值为0,默认值为0。 |
| displayId
<sup>
8+
</sup>
| number | 否 | 表示截取图像的显示设备
[
Display
](
js-apis-display.md#display
)
的ID号。 |
| rotation | number | 否 | 表示截取图像的旋转角度,当前仅支持输入值为0,默认值为0
,该参数应为整数
。 |
| displayId
<sup>
8+
</sup>
| number | 否 | 表示截取图像的显示设备
[
Display
](
js-apis-display.md#display
)
的ID号
,该参数应为整数
。 |
## Rect
...
...
@@ -37,10 +37,10 @@ import screenshot from '@ohos.screenshot';
| 名称 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| left | number | 是 | 表示截取图像区域的左边界,单位为像素。 |
| top | number | 是 | 表示截取图像区域的上边界,单位为像素。 |
| width | number | 是 | 表示截取图像区域的宽度,单位为像素。 |
| height | number | 是 | 表示截取图像区域的高度,单位为像素。 |
| left | number | 是 | 表示截取图像区域的左边界,单位为像素
,该参数应为整数
。 |
| top | number | 是 | 表示截取图像区域的上边界,单位为像素
,该参数应为整数
。 |
| width | number | 是 | 表示截取图像区域的宽度,单位为像素
,该参数应为整数
。 |
| height | number | 是 | 表示截取图像区域的高度,单位为像素
,该参数应为整数
。 |
## Size
...
...
@@ -51,8 +51,8 @@ import screenshot from '@ohos.screenshot';
| 名称 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| width | number | 是 | 表示截取图像的宽度,单位为像素。 |
| height | number | 是 | 表示截取图像的高度,单位为像素。 |
| width | number | 是 | 表示截取图像的宽度,单位为像素
,该参数应为整数
。 |
| height | number | 是 | 表示截取图像的高度,单位为像素
,该参数应为整数
。 |
## screenshot.save
...
...
zh-cn/application-dev/reference/apis/js-apis-window.md
浏览文件 @
ee2d1a68
...
...
@@ -51,12 +51,12 @@ import window from '@ohos.window';
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
| 名称 | 类型 | 必填 | 说明 |
| ---------- | -------------------------- | -- |
-----------------------------------
|
| ---------- | -------------------------- | -- |
-----------------------------------------------------------------------------
|
| name | string | 是 | 窗口名字。 |
| windowType |
[
WindowType
](
#windowtype7
)
| 是 | 窗口类型。 |
| ctx |
[
BaseContext
](
js-apis-inner-application-baseContext.md
)
| 否 | 当前应用上下文信息。不设置,则默认为空。
<br>
FA模型下不需要使用该参数,即可创建子窗口。
<br>
Stage模型下需要使用该参数,用于创建系统窗口。 |
| displayId | number | 否 | 当前物理屏幕id。不设置,则默认为-1
。
|
| parentId | number | 否 | 父窗口id。不设置,则默认为-1
。
|
| displayId | number | 否 | 当前物理屏幕id。不设置,则默认为-1
,该参数应为整数。
|
| parentId | number | 否 | 父窗口id。不设置,则默认为-1
,该参数应为整数。
|
## AvoidAreaType<sup>7+</sup>
...
...
@@ -177,7 +177,7 @@ import window from '@ohos.window';
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ---------- | --------------------------------------------------- | ---- | ---- | ---------------------------- |
| displayId | number | 是 | 否 | 当前物理屏幕id。 |
| displayId | number | 是 | 否 | 当前物理屏幕id
,该参数应为整数
。 |
| regionTint | Array
<
[
SystemBarRegionTint
](
#systembarregiontint8
)
>
| 是 | 否 | 当前已改变的所有系统栏信息。 |
## Rect<sup>7+</sup>
...
...
@@ -188,10 +188,10 @@ import window from '@ohos.window';
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | -------- | ---- | ---- | ------------------ |
| left | number | 是 | 是 | 矩形区域的左边界,单位为px。 |
| top | number | 是 | 是 | 矩形区域的上边界,单位为px。 |
| width | number | 是 | 是 | 矩形区域的宽度,单位为px。 |
| height | number | 是 | 是 | 矩形区域的高度,单位为px。 |
| left | number | 是 | 是 | 矩形区域的左边界,单位为px
,该参数为整数
。 |
| top | number | 是 | 是 | 矩形区域的上边界,单位为px
,该参数应为整数
。 |
| width | number | 是 | 是 | 矩形区域的宽度,单位为px
,该参数应为整数
。 |
| height | number | 是 | 是 | 矩形区域的高度,单位为px
,该参数应为整数
。 |
## AvoidArea<sup>7+</sup>
...
...
@@ -215,8 +215,8 @@ import window from '@ohos.window';
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | -------- | ---- | ---- | ---------- |
| width | number | 是 | 是 | 窗口宽度,单位为px。 |
| height | number | 是 | 是 | 窗口高度,单位为px。 |
| width | number | 是 | 是 | 窗口宽度,单位为px
,该参数应为整数
。 |
| height | number | 是 | 是 | 窗口高度,单位为px
,该参数应为整数
。 |
## WindowProperties
...
...
@@ -225,20 +225,20 @@ import window from '@ohos.window';
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------------------------- | ------------------------- | ---- | ---- |
------------------------------------------------------------
|
| ------------------------------------- | ------------------------- | ---- | ---- |
--------------------------------------------------------------------------------------------------------
|
| windowRect
<sup>
7+
</sup>
|
[
Rect
](
#rect7
)
| 是 | 是 | 窗口尺寸。 |
| type
<sup>
7+
</sup>
|
[
WindowType
](
#windowtype7
)
| 是 | 是 | 窗口类型。 |
| isFullScreen | boolean | 是 | 是 | 是否全屏,默认为false。true表示全屏;false表示非全屏。 |
| isLayoutFullScreen
<sup>
7+
</sup>
| boolean | 是 | 是 | 窗口是否为沉浸式,默认为false。true表示沉浸式;false表示非沉浸式。 |
| focusable
<sup>
7+
</sup>
| boolean | 是 | 否 | 窗口是否可聚焦,默认为true。true表示可聚焦;false表示不可聚焦。 |
| touchable
<sup>
7+
</sup>
| boolean | 是 | 否 | 窗口是否可触摸,默认为true。true表示可触摸;false表示不可触摸。 |
| brightness | number | 是 | 是 | 屏幕亮度
, 可设置的亮度范围为0~1,其中1表示最大亮度值。如果窗口没有设置亮度值,表示亮度跟随系统,此时获取到的亮度值为-1。
|
| dimBehindValue
<sup>
(deprecated)
</sup>
| number | 是 | 是 | 靠后窗口的暗度值
,取值范围为0~1,1
表示最暗。
<br>
-
**说明:**
从API version 9开始废弃。
<br>
- 从 API version 7开始支持。 |
| brightness | number | 是 | 是 | 屏幕亮度
。该参数为浮点数,可设置的亮度范围为[0.0, 1.0],其取1.0时表示最大亮度值。如果窗口没有设置亮度值,表示亮度跟随系统,此时获取到的亮度值为-1。
|
| dimBehindValue
<sup>
(deprecated)
</sup>
| number | 是 | 是 | 靠后窗口的暗度值
。该参数为浮点数,取值范围为[0.0, 1.0],其取1.0
表示最暗。
<br>
-
**说明:**
从API version 9开始废弃。
<br>
- 从 API version 7开始支持。 |
| isKeepScreenOn | boolean | 是 | 是 | 屏幕是否常亮,默认为false。true表示常亮;false表示不常亮。 |
| isPrivacyMode
<sup>
7+
</sup>
| boolean | 是 | 是 | 隐私模式,默认为false。true表示模式开启;false表示模式关闭。 |
| isRoundCorner
<sup>
(deprecated)
</sup>
| boolean | 是 | 是 | 窗口是否为圆角。默认为false。true表示圆角;false表示非圆角。
<br>
-
**说明:**
从API version 9开始废弃。
<br/>
- 从 API version 7开始支持。 |
| isTransparent
<sup>
7+
</sup>
| boolean | 是 | 是 | 窗口是否透明。默认为false。true表示透明;false表示不透明。 |
| id
<sup>
9+
</sup>
| number | 是 | 否 | 窗口ID,默认值为0
.0。
|
| id
<sup>
9+
</sup>
| number | 是 | 否 | 窗口ID,默认值为0
,该参数应为整数。
|
## ColorSpace<sup>8+</sup>
...
...
@@ -260,11 +260,11 @@ import window from '@ohos.window';
**系统能力**
:SystemCapability.WindowManager.WindowManager.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | -------- | ---- | ---- |
--------------------------------------------------
|
| x | number | 否 | 是 | X轴的缩放参数
,默认值为1.0。
|
| y | number | 否 | 是 | Y轴的缩放参数
,默认值为1.0。
|
| pivotX | number | 否 | 是 | 缩放中心点X轴坐标
,默认值为0.5, 取值范围0.0~1.0
。 |
| pivotY | number | 否 | 是 | 缩放中心点Y轴坐标
,默认值为0.5, 取值范围0.0~1.0
。 |
| ------ | -------- | ---- | ---- |
--------------------------------------------
|
| x | number | 否 | 是 | X轴的缩放参数
。该参数为浮点数,默认值为1.0。
|
| y | number | 否 | 是 | Y轴的缩放参数
。该参数为浮点数,默认值为1.0。
|
| pivotX | number | 否 | 是 | 缩放中心点X轴坐标
。该参数为浮点数,默认值为0.5, 取值范围[0.0, 1.0]
。 |
| pivotY | number | 否 | 是 | 缩放中心点Y轴坐标
。该参数为浮点数,默认值为0.5, 取值范围[0.0, 1.0]
。 |
## RotateOptions<sup>9+</sup>
...
...
@@ -275,12 +275,12 @@ import window from '@ohos.window';
**系统能力**
:SystemCapability.WindowManager.WindowManager.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | -------- | ---- | ---- |
--------------------------------------------------
|
| x | number | 否 | 是 | 绕X轴的旋转角度
,默认值为0.0。
|
| y | number | 否 | 是 | 绕Y轴的旋转角度
,默认值为0.0。
|
| z | number | 否 | 是 | 绕Z轴的旋转角度
,默认值为0.0。
|
| pivotX | number | 否 | 是 | 旋转中心点X轴坐标
,默认值为0.5, 取值范围0.0~1.0
。 |
| pivotY | number | 否 | 是 | 旋转中心点Y轴坐标
,默认值为0.5, 取值范围0.0~1.0。
|
| ------ | -------- | ---- | ---- |
---------------------------------------------
|
| x | number | 否 | 是 | 绕X轴的旋转角度
。该参数为浮点数,默认值为0.0。
|
| y | number | 否 | 是 | 绕Y轴的旋转角度
。该参数为浮点数,默认值为0.0。
|
| z | number | 否 | 是 | 绕Z轴的旋转角度
。该参数为浮点数,默认值为0.0。
|
| pivotX | number | 否 | 是 | 旋转中心点X轴坐标
。该参数为浮点数,默认值为0.5, 取值范围为[0.0, 1.0]
。 |
| pivotY | number | 否 | 是 | 旋转中心点Y轴坐标
。该参数为浮点数,默认值为0.5, 取值范围为[0.0, 1.0]。
|
## TranslateOptions<sup>9+</sup>
...
...
@@ -292,9 +292,9 @@ import window from '@ohos.window';
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ---- | -------- | ---- | ---- | ---------------------------- |
| x | number | 否 | 是 | X轴的平移参数,默认值为0.0。 |
| y | number | 否 | 是 | Y轴的平移参数,默认值为0.0。 |
| z | number | 否 | 是 | Z轴的平移参数,默认值为0.0。 |
| x | number | 否 | 是 | X轴的平移参数
。该参数为浮点数
,默认值为0.0。 |
| y | number | 否 | 是 | Y轴的平移参数
。该参数为浮点数
,默认值为0.0。 |
| z | number | 否 | 是 | Z轴的平移参数
。该参数为浮点数
,默认值为0.0。 |
## WindowEventType<sup>10+</sup>
...
...
@@ -544,7 +544,7 @@ minimizeAll(id: number, callback: AsyncCallback<void>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | -------------- |
| id | number | 是 | 显示设备
[
Display
](
js-apis-display.md#display
)
的ID号。 |
| id | number | 是 | 显示设备
[
Display
](
js-apis-display.md#display
)
的ID号
,该参数仅支持整数输入
。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调信息。 |
**错误码:**
...
...
@@ -593,7 +593,7 @@ minimizeAll(id: number): Promise<void>
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | -------------- |
| id | number | 是 | 显示设备
[
Display
](
js-apis-display.md#display
)
的ID号。 |
| id | number | 是 | 显示设备
[
Display
](
js-apis-display.md#display
)
的ID号
,该参数仅支持整数输入
。 |
**返回值:**
...
...
@@ -1719,8 +1719,8 @@ moveWindowTo(x: number, y: number, callback: AsyncCallback<void>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | -- | --------------------------------------------- |
| x | number | 是 | 窗口在x轴方向移动的值,值为正表示右移,单位为px。 |
| y | number | 是 | 窗口在y轴方向移动的值,值为正表示下移,单位为px。 |
| x | number | 是 | 窗口在x轴方向移动的值,值为正表示右移,单位为px
,该参数仅支持整数输入
。 |
| y | number | 是 | 窗口在y轴方向移动的值,值为正表示下移,单位为px
,该参数仅支持整数输入
。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
**错误码:**
...
...
@@ -1762,8 +1762,8 @@ moveWindowTo(x: number, y: number): Promise<void>
| 参数名 | 类型 | 必填 | 说明 |
| -- | ----- | -- | --------------------------------------------- |
| x | number | 是 | 窗口在x轴方向移动的值,值为正表示右移,单位为px。 |
| y | number | 是 | 窗口在y轴方向移动的值,值为正表示下移,单位为px。 |
| x | number | 是 | 窗口在x轴方向移动的值,值为正表示右移,单位为px
,该参数仅支持整数输入
。 |
| y | number | 是 | 窗口在y轴方向移动的值,值为正表示下移,单位为px
,该参数仅支持整数输入
。 |
**返回值:**
...
...
@@ -1815,8 +1815,8 @@ resize(width: number, height: number, callback: AsyncCallback<void>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | -- | ------------------------ |
| width | number | 是 | 目标窗口的宽度,单位为px。 |
| height | number | 是 | 目标窗口的高度,单位为px。 |
| width | number | 是 | 目标窗口的宽度,单位为px
,该参数仅支持整数输入
。 |
| height | number | 是 | 目标窗口的高度,单位为px
,该参数仅支持整数输入
。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
**错误码:**
...
...
@@ -1864,8 +1864,8 @@ resize(width: number, height: number): Promise<void>
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | -- | ------------------------ |
| width | number | 是 | 目标窗口的宽度,单位为px。 |
| height | number | 是 | 目标窗口的高度,单位为px。 |
| width | number | 是 | 目标窗口的宽度,单位为px
,该参数仅支持整数输入
。 |
| height | number | 是 | 目标窗口的高度,单位为px
,该参数仅支持整数输入
。 |
**返回值:**
...
...
@@ -2747,9 +2747,9 @@ on(type: 'keyboardHeightChange', callback: Callback<number>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------- | ---- |
------------------------------------------------------------
|
| -------- | ------------------- | ---- |
-------------------------------------------
|
| type | string | 是 | 监听事件,固定为'keyboardHeightChange',即键盘高度变化事件。 |
| callback | Callback
<
number
>
| 是 | 回调函数。返回当前的键盘高度
。
|
| callback | Callback
<
number
>
| 是 | 回调函数。返回当前的键盘高度
,返回值为整数。
|
**示例:**
...
...
@@ -2776,7 +2776,7 @@ off(type: 'keyboardHeightChange', callback?: Callback<number>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 监听事件,固定为'keyboardHeightChange',即键盘高度变化事件。 |
| callback | Callback
<
number
>
| 否 | 回调函数。返回当前的键盘高度。 |
| callback | Callback
<
number
>
| 否 | 回调函数。返回当前的键盘高度
,返回值为整数
。 |
**示例:**
...
...
@@ -2830,9 +2830,9 @@ off(type: 'touchOutside', callback?: Callback<void>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- |
---------------------- | ---- | ------------------------------------------------------------
|
| -------- |
----------------------| ---- |--------------------------------------
|
| type | string | 是 | 监听事件,固定为'touchOutside',即本窗口范围外的点击事件。 |
| callback | Callback
<
number
>
| 否 | 回调函数。当点击事件发生在本窗口范围之外的回调。
|
| callback | Callback
<
void
>
| 否 | 回调函数。当点击事件发生在本窗口范围之外的回调。
|
**示例:**
...
...
@@ -3525,8 +3525,8 @@ setWindowBrightness(brightness: number, callback: AsyncCallback<void>): vo
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------- | -- |
---------------------------------
|
| brightness | number | 是 | 屏幕亮度值
,值为0-1之间。1
表示最亮。 |
| ---------- | ------------------------- | -- |
-------------------------------------------
|
| brightness | number | 是 | 屏幕亮度值
。该参数为浮点数,取值范围为[0.0, 1.0]。其取1.0时
表示最亮。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
**错误码:**
...
...
@@ -3568,8 +3568,8 @@ setWindowBrightness(brightness: number): Promise<void>
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | -- |
---------------------------------
|
| brightness | number | 是 | 屏幕亮度值
,值为0-1之间。1
表示最亮。 |
| ---------- | ------ | -- |
----------------------------------------
|
| brightness | number | 是 | 屏幕亮度值
。该参数为浮点数,取值范围为[0.0, 1.0]。1.0
表示最亮。 |
**返回值:**
...
...
@@ -4188,8 +4188,8 @@ opacity(opacity: number): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- |
-----------------------------------------------------------
|
| opacity | number | 是 | 不透明度
,范围0.0~1.0
。0.0表示完全透明,1.0表示完全不透明。 |
| ------- | ------ | ---- |
----------------------------------------------------
|
| opacity | number | 是 | 不透明度
。该参数为浮点数,取值范围为[0.0, 1.0]
。0.0表示完全透明,1.0表示完全不透明。 |
**错误码:**
...
...
@@ -4408,8 +4408,8 @@ setBlur(radius: number): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- |
------------------------------------------------------------
|
| radius | number | 是 | 表示窗口模糊的半径值
,取值范围为大于等于0,0
表示关闭窗口模糊。 |
| ------ | ------ | ---- |
--------------------------------------------------
|
| radius | number | 是 | 表示窗口模糊的半径值
。该参数为浮点数,取值范围为
[
0, +∞),取值为0.0时
表示关闭窗口模糊。 |
**错误码:**
...
...
@@ -4443,8 +4443,8 @@ setBackdropBlur(radius: number): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- |
------------------------------------------------------------
|
| radius | number | 是 | 表示窗口背景模糊的半径值
,取值范围为大于等于0,
0表示关闭窗口背景模糊。 |
| ------ | ------ | ---- |
-------------------------------------------------------
|
| radius | number | 是 | 表示窗口背景模糊的半径值
。该参数为浮点数,取值范围为
[
0.0, +∞),取值为0.
0表示关闭窗口背景模糊。 |
**错误码:**
...
...
@@ -4513,11 +4513,11 @@ setShadow(radius: number, color?: string, offsetX?: number, offsetY?: number): v
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- |
------------------------------------------------------------
|
| radius | number | 是 | 表示窗口边缘阴影的模糊半径
,取值范围为大于等于0,0表示关闭窗口边缘阴影。
|
| ------- | ------ | ---- |
-------------------------------------------------------------
|
| radius | number | 是 | 表示窗口边缘阴影的模糊半径
。该参数为浮点数,取值范围为
[
0.0, +∞),取值为0.0时表示关闭窗口边缘阴影。
|
| color | string | 否 | 表示窗口边缘阴影的颜色,为十六进制RGB或ARGB颜色,不区分大小写,例如`#00FF00`或`#FF00FF00`。 |
| offsetX | number | 否 | 表示窗口边缘阴影的X轴的偏移量
,单位为px。
|
| offsetY | number | 否 | 表示窗口边缘阴影的Y轴的偏移量
,单位为px。
|
| offsetX | number | 否 | 表示窗口边缘阴影的X轴的偏移量
。该参数为浮点数,单位为px。
|
| offsetY | number | 否 | 表示窗口边缘阴影的Y轴的偏移量
。该参数为浮点数,单位为px。
|
**错误码:**
...
...
@@ -4551,8 +4551,8 @@ setCornerRadius(cornerRadius: number): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------- | ---- |
--------------------
|
| radius | number | 是 | 表示窗口圆角的半径值
,取值范围为大于等于0,0
表示没有窗口圆角。 |
| ----------- | ------- | ---- |
----------------------------------------------------
|
| radius | number | 是 | 表示窗口圆角的半径值
。该参数为浮点数,取值范围为
[
0.0, +∞),取值为0.0时
表示没有窗口圆角。 |
**错误码:**
...
...
@@ -4662,8 +4662,8 @@ setAspectRatio(ratio: number): Promise<void>
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------------------ | ------- | ---- |
------------------------------------------------------------
|
| ratio | number | 是 | 除边框装饰之外的窗口内容布局的宽高比
,取值范围为大于0
。 |
| ------------------ | ------- | ---- |
-------------------------------------------
|
| ratio | number | 是 | 除边框装饰之外的窗口内容布局的宽高比
。该参数为浮点数,取值范围为(0.0, +∞)
。 |
**返回值:**
...
...
@@ -4709,8 +4709,8 @@ setAspectRatio(ratio: number, callback: AsyncCallback<void>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------------------ | ------- | ---- |
------------------------------------------------------------
|
| ratio | number | 是 | 除边框装饰之外的窗口内容布局的宽高比
,取值范围为大于0
。 |
| ------------------ | ------- | ---- |
--------------------------------------------
|
| ratio | number | 是 | 除边框装饰之外的窗口内容布局的宽高比
。该参数为浮点数,取值范围为(0.0, +∞)
。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
**错误码:**
...
...
@@ -5048,8 +5048,8 @@ moveTo(x: number, y: number, callback: AsyncCallback<void>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------------------- |
| x | number | 是 | 窗口在x轴方向移动的值,值为正表示右移,单位为px。 |
| y | number | 是 | 窗口在y轴方向移动的值,值为正表示下移,单位为px。 |
| x | number | 是 | 窗口在x轴方向移动的值,值为正表示右移,单位为px
,该参数仅支持整数输入
。 |
| y | number | 是 | 窗口在y轴方向移动的值,值为正表示下移,单位为px
,该参数仅支持整数输入
。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
**示例:**
...
...
@@ -5082,8 +5082,8 @@ moveTo(x: number, y: number): Promise<void>
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------- |
| x | number | 是 | 窗口在x轴方向移动的值,值为正表示右移,单位为px。 |
| y | number | 是 | 窗口在y轴方向移动的值,值为正表示下移,单位为px。 |
| x | number | 是 | 窗口在x轴方向移动的值,值为正表示右移,单位为px
,该参数仅支持整数输入
。 |
| y | number | 是 | 窗口在y轴方向移动的值,值为正表示下移,单位为px
,该参数仅支持整数输入
。 |
**返回值:**
...
...
@@ -5126,8 +5126,8 @@ resetSize(width: number, height: number, callback: AsyncCallback<void>): v
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | -------------------------- |
| width | number | 是 | 目标窗口的宽度,单位为px。 |
| height | number | 是 | 目标窗口的高度,单位为px。 |
| width | number | 是 | 目标窗口的宽度,单位为px
,该参数仅支持整数输入
。 |
| height | number | 是 | 目标窗口的高度,单位为px
,该参数仅支持整数输入
。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
**示例:**
...
...
@@ -5166,8 +5166,8 @@ resetSize(width: number, height: number): Promise<void>
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------------------- |
| width | number | 是 | 目标窗口的宽度,单位为px。 |
| height | number | 是 | 目标窗口的高度,单位为px。 |
| width | number | 是 | 目标窗口的宽度,单位为px
,该参数仅支持整数输入
。 |
| height | number | 是 | 目标窗口的高度,单位为px
,该参数仅支持整数输入
。 |
**返回值:**
...
...
@@ -6121,8 +6121,8 @@ setBrightness(brightness: number, callback: AsyncCallback<void>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------- | ---- |
------------------------------------
|
| brightness | number | 是 | 屏幕亮度值
,值为0-1之间。
1表示最亮。 |
| ---------- | ------------------------- | ---- |
---------------------------------------
|
| brightness | number | 是 | 屏幕亮度值
。该参数为浮点数,取值范围为[0.0, 1.0]。,
1表示最亮。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
**示例:**
...
...
@@ -6155,8 +6155,8 @@ setBrightness(brightness: number): Promise<void>
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- |
------------------------------------
|
| brightness | number | 是 | 屏幕亮度值
,值为0-1之间。1
表示最亮。 |
| ---------- | ------ | ---- |
------------------------------------------
|
| brightness | number | 是 | 屏幕亮度值
。该参数为浮点数。取值范围为[0.0, 1.0],取1.0时
表示最亮。 |
**返回值:**
...
...
@@ -6191,8 +6191,8 @@ setDimBehind(dimBehindValue: number, callback: AsyncCallback<void>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------------------------- | ---- |
--------------------------------------------------
|
| dimBehindValue | number | 是 | 表示靠后的窗口的暗度值,取值范围为
0-1,1
表示最暗。 |
| -------------- | ------------------------- | ---- |
----------------------------------------
|
| dimBehindValue | number | 是 | 表示靠后的窗口的暗度值,取值范围为
[0.0, 1.0],取1.0时
表示最暗。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
**示例:**
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录