Skip to content

D
Docs

OpenHarmony / Docs
12 个月 前同步成功

通知 159
Star 292
Fork 28
D
Docs

体验新版 GitCode，发现更多精彩内容 >>

提交 36e6c8d9 编写于 作者: Z zhengjiangliang
浏览文件
操作

窗口子系统display错误码文档更新 

Change-Id: I6fc1804b01cd19e1f70a2b4ae315c3c44532bb87
Signed-off-by: Nzhengjiangliang <zhengjiangliang@huawei.com>
上级 8865fe84
隐藏空白更改
内联 并排
Showing with 429 addition and 259 deletion
zh-cn/application-dev/reference/apis/js-apis-display.md
浏览文件 @ 36e6c8d9
...@@ -11,7 +11,6 @@ ...@@ -11,7 +11,6 @@
import display from '@ohos.display'; import display from '@ohos.display';
``` ```
## DisplayState ## DisplayState
显示设备的状态枚举。 显示设备的状态枚举。
...@@ -65,61 +64,6 @@ import display from '@ohos.display'; ...@@ -65,61 +64,6 @@ import display from '@ohos.display';
| boundingRects | Array\<[Rect](#rect9)> | 是 | 否 | 挖孔、刘海等区域的边界矩形。 | | boundingRects | Array\<[Rect](#rect9)> | 是 | 否 | 挖孔、刘海等区域的边界矩形。 |
| waterfallDisplayAreaRects | [WaterfallDisplayAreaRects](#waterfalldisplayarearects9) | 是 | 否 | 瀑布屏曲面部分显示区域。 | | waterfallDisplayAreaRects | [WaterfallDisplayAreaRects](#waterfalldisplayarearects9) | 是 | 否 | 瀑布屏曲面部分显示区域。 |
## display.getDefaultDisplay
getDefaultDisplay(callback: AsyncCallback&lt;Display&gt;): void
获取当前默认的display对象，使用callback异步回调。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;[Display](#display)&gt; | 是 | 回调函数。返回当前默认的display对象。 |
**示例：**
```js
var displayClass = null;
display.getDefaultDisplay((err, data) => {
if (err.code) {
console.error('Failed to obtain the default display object. Code: ' + JSON.stringify(err));
return;
}
console.info('Succeeded in obtaining the default display object. Data:' + JSON.stringify(data));
displayClass = data;
});
```
## display.getDefaultDisplay
getDefaultDisplay(): Promise&lt;Display&gt;
获取当前默认的display对象，使用Promise异步回调。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core
**返回值：**
| 类型 | 说明 |
| ---------------------------------- | ---------------------------------------------- |
| Promise&lt;[Display](#display)&gt; | Promise对象。返回当前默认的display对象。 |
**示例：**
```js
var displayClass = null;
let promise = display.getDefaultDisplay();
promise.then((data) => {
displayClass = data;
console.info('Succeeded in obtaining the default display object. Data:' + JSON.stringify(data));
}).catch((err) => {
console.error('Failed to obtain the default display object. Code: ' + JSON.stringify(err));
});
```
## display.getDefaultDisplaySync<sup>9+</sup> ## display.getDefaultDisplaySync<sup>9+</sup>
getDefaultDisplaySync(): Display getDefaultDisplaySync(): Display
...@@ -137,12 +81,16 @@ getDefaultDisplaySync(): Display ...@@ -137,12 +81,16 @@ getDefaultDisplaySync(): Display
**示例：** **示例：**
```js ```js
var displayClass = display.getDefaultDisplaySync(); try {
let displayClass = display.getDefaultDisplaySync();
} catch (exception) {
console.error('Failed to obtain the default display object. Code: ' + JSON.stringify(exception));
};
``` ```
## display.getAllDisplay ## display.getAllDisplays<sup>9+</sup>
getAllDisplay(callback: AsyncCallback&lt;Array&lt;Display&gt;&gt;): void getAllDisplays(callback: AsyncCallback&lt;Array&lt;Display&gt;&gt;): void
获取当前所有的display对象，使用callback异步回调。 获取当前所有的display对象，使用callback异步回调。
...@@ -150,14 +98,14 @@ getAllDisplay(callback: AsyncCallback&lt;Array&lt;Display&gt;&gt;): void ...@@ -150,14 +98,14 @@ getAllDisplay(callback: AsyncCallback&lt;Array&lt;Display&gt;&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------------------- | ---- | ------------------------------- | | -------- | ---------------------------------------------------- | ---- | ------------------------------- |
| callback | AsyncCallback&lt;Array&lt;[Display](#display)&gt;&gt; | 是 | 回调函数。返回当前所有的display对象。 | | callback | AsyncCallback&lt;Array&lt;[Display](#display)&gt;&gt; | 是 | 回调函数。返回当前所有的display对象。 |
**示例：** **示例：**
```js ```js
display.getAllDisplay((err, data) => { display.getAllDisplays((err, data) => {
if (err.code) { if (err.code) {
console.error('Failed to obtain all the display objects. Code: ' + JSON.stringify(err)); console.error('Failed to obtain all the display objects. Code: ' + JSON.stringify(err));
return; return;
...@@ -166,9 +114,9 @@ display.getAllDisplay((err, data) => { ...@@ -166,9 +114,9 @@ display.getAllDisplay((err, data) => {
}); });
``` ```
## display.getAllDisplay ## display.getAllDisplays<sup>9+</sup>
getAllDisplay(): Promise&lt;Array&lt;Display&gt;&gt; getAllDisplays(): Promise&lt;Array&lt;Display&gt;&gt;
获取当前所有的display对象，使用Promise异步回调。 获取当前所有的display对象，使用Promise异步回调。
...@@ -176,14 +124,14 @@ getAllDisplay(): Promise&lt;Array&lt;Display&gt;&gt; ...@@ -176,14 +124,14 @@ getAllDisplay(): Promise&lt;Array&lt;Display&gt;&gt;
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------------------- | ------------------------------------------------------- | | ----------------------------------------------- | ------------------------------------------------------- |
| Promise&lt;Array&lt;[Display](#display)&gt;&gt; | Promise对象。返回当前所有的display对象。 | | Promise&lt;Array&lt;[Display](#display)&gt;&gt; | Promise对象。返回当前所有的display对象。 |
**示例：** **示例：**
```js ```js
let promise = display.getAllDisplay(); let promise = display.getAllDisplays();
promise.then((data) => { promise.then((data) => {
console.info('Succeeded in obtaining all the display objects. Data: ' + JSON.stringify(data)); console.info('Succeeded in obtaining all the display objects. Data: ' + JSON.stringify(data));
}).catch((err) => { }).catch((err) => {
...@@ -216,25 +164,27 @@ hasPrivateWindow(displayId: number): boolean ...@@ -216,25 +164,27 @@ hasPrivateWindow(displayId: number): boolean
**示例：** **示例：**
```js ```js
var displayClass = null; let displayClass = null;
display.getDefaultDisplay((err, data) => { try {
if (err.code) { displayClass = display.getDefaultDisplaySync();
console.error('Failed to obtain the default display object. Code: ' + JSON.stringify(err)); } catch (exception) {
console.error('Failed to obtain the default display object. Code: ' + JSON.stringify(exception));
return; return;
} };
console.info('Succeeded in obtaining the default display object. Data:' + JSON.stringify(data));
displayClass = data;
});
var ret = display.hasPrivateWindow(displayClass.id); try {
let ret = display.hasPrivateWindow(displayClass.id);
} catch (exception) {
console.error('Failed to check has privateWindow or not. Code: ' + JSON.stringify(exception));
};
if (ret == undefined) { if (ret == undefined) {
console.log("Failed to check has privateWindow or not."); console.log("Failed to check has privateWindow or not.");
} }
if (ret) { if (ret) {
console.log("There has privateWindow."); console.log("There has privateWindow.");
} else if (!ret) { } else if (!ret) {
console.log("There has no privateWindow."); console.log("There has no privateWindow.");
} };
``` ```
## display.on('add'|'remove'|'change') ## display.on('add'|'remove'|'change')
...@@ -255,10 +205,14 @@ on(type: 'add'|'remove'|'change', callback: Callback&lt;number&gt;): void ...@@ -255,10 +205,14 @@ on(type: 'add'|'remove'|'change', callback: Callback&lt;number&gt;): void
**示例：** **示例：**
```js ```js
var callback = (data) => { let callback = (data) => {
console.info('Listening enabled. Data: ' + JSON.stringify(data)); console.info('Listening enabled. Data: ' + JSON.stringify(data));
} }
display.on("add", callback); try {
display.on("add", callback);
} catch (exception) {
console.error('Failed to register callback. Code: ' + JSON.stringify(exception));
};
``` ```
## display.off('add'|'remove'|'change') ## display.off('add'|'remove'|'change')
...@@ -279,7 +233,129 @@ off(type: 'add'|'remove'|'change', callback?: Callback&lt;number&gt;): void ...@@ -279,7 +233,129 @@ off(type: 'add'|'remove'|'change', callback?: Callback&lt;number&gt;): void
**示例：** **示例：**
```js ```js
display.off("remove"); try {
display.off("remove");
} catch (exception) {
console.error('Failed to unregister callback. Code: ' + JSON.stringify(exception));
};
```
## display.getDefaultDisplay<sup>(deprecated)</sup>
getDefaultDisplay(callback: AsyncCallback&lt;Display&gt;): void
获取当前默认的display对象，使用callback异步回调。
> **说明：**
> 从 API version 7开始支持，从API version 9开始废弃，推荐使用[getDefaultDisplaySync()](#displaygetdefaultdisplaysync9)。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;[Display](#display)&gt; | 是 | 回调函数。返回当前默认的display对象。 |
**示例：**
```js
var displayClass = null;
display.getDefaultDisplay((err, data) => {
if (err.code) {
console.error('Failed to obtain the default display object. Code: ' + JSON.stringify(err));
return;
}
console.info('Succeeded in obtaining the default display object. Data:' + JSON.stringify(data));
displayClass = data;
});
```
## display.getDefaultDisplay<sup>(deprecated)</sup>
getDefaultDisplay(): Promise&lt;Display&gt;
获取当前默认的display对象，使用Promise异步回调。
> **说明：**
> 从 API version 7开始支持，从API version 9开始废弃，推荐使用[getDefaultDisplaySync()](#displaygetdefaultdisplaysync9)。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core
**返回值：**
| 类型 | 说明 |
| ---------------------------------- | ---------------------------------------------- |
| Promise&lt;[Display](#display)&gt; | Promise对象。返回当前默认的display对象。 |
**示例：**
```js
var displayClass = null;
let promise = display.getDefaultDisplay();
promise.then((data) => {
displayClass = data;
console.info('Succeeded in obtaining the default display object. Data:' + JSON.stringify(data));
}).catch((err) => {
console.error('Failed to obtain the default display object. Code: ' + JSON.stringify(err));
});
```
## display.getAllDisplay<sup>(deprecated)</sup>
getAllDisplay(callback: AsyncCallback&lt;Array&lt;Display&gt;&gt;): void
获取当前所有的display对象，使用callback异步回调。
> **说明：**
> 从 API version 7开始支持，从API version 9开始废弃，推荐使用[getAllDisplays()](#displaygetalldisplays9)。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------------------- | ---- | ------------------------------- |
| callback | AsyncCallback&lt;Array&lt;[Display](#display)&gt;&gt; | 是 | 回调函数。返回当前所有的display对象。 |
**示例：**
```js
display.getAllDisplay((err, data) => {
if (err.code) {
console.error('Failed to obtain all the display objects. Code: ' + JSON.stringify(err));
return;
}
console.info('Succeeded in obtaining all the display objects. Data: ' + JSON.stringify(data));
});
```
## display.getAllDisplay<sup>(deprecated)</sup>
getAllDisplay(): Promise&lt;Array&lt;Display&gt;&gt;
获取当前所有的display对象，使用Promise异步回调。
> **说明：**
> 从 API version 7开始支持，从API version 9开始废弃，推荐使用[getAllDisplays()](#displaygetalldisplays9-1)。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core
**返回值：**
| 类型 | 说明 |
| ----------------------------------------------- | ------------------------------------------------------- |
| Promise&lt;Array&lt;[Display](#display)&gt;&gt; | Promise对象。返回当前所有的display对象。 |
**示例：**
```js
let promise = display.getAllDisplay();
promise.then((data) => {
console.info('Succeeded in obtaining all the display objects. Data: ' + JSON.stringify(data));
}).catch((err) => {
console.error('Failed to obtain all the display objects. Code: ' + JSON.stringify(err));
});
``` ```
## Display ## Display
...@@ -312,6 +388,8 @@ getCutoutInfo(callback: AsyncCallback&lt;CutoutInfo&gt;): void ...@@ -312,6 +388,8 @@ getCutoutInfo(callback: AsyncCallback&lt;CutoutInfo&gt;): void
**系统能力：** SystemCapability.WindowManager.WindowManager.Core **系统能力：** SystemCapability.WindowManager.WindowManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | --------------------------- | ---- | ------------------------------------------------------------ | | ----------- | --------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback&lt;[CutoutInfo](#cutoutinfo9)&gt; | 是 | 回调函数。当获取信息成功，err为undefined，data为获取到的CutoutInfo对象；否则err为错误对象。 | | callback | AsyncCallback&lt;[CutoutInfo](#cutoutinfo9)&gt; | 是 | 回调函数。当获取信息成功，err为undefined，data为获取到的CutoutInfo对象；否则err为错误对象。 |
...@@ -321,11 +399,11 @@ getCutoutInfo(callback: AsyncCallback&lt;CutoutInfo&gt;): void ...@@ -321,11 +399,11 @@ getCutoutInfo(callback: AsyncCallback&lt;CutoutInfo&gt;): void
```js ```js
displayClass.getCutoutInfo((err, data) => { displayClass.getCutoutInfo((err, data) => {
if (err.code) { if (err.code) {
console.error('Failed to get cutoutInfo. Cause: ' + JSON.stringify(err)); console.error('Failed to get cutoutInfo. Code: ' + JSON.stringify(err));
return; return;
} }
console.info('Succeeded in getting cutoutInfo. data: ' + JSON.stringify(data)); console.info('Succeeded in getting cutoutInfo. data: ' + JSON.stringify(data));
}) });
``` ```
### getCutoutInfo<sup>9+</sup> ### getCutoutInfo<sup>9+</sup>
getCutoutInfo(): Promise&lt;CutoutInfo&gt; getCutoutInfo(): Promise&lt;CutoutInfo&gt;
...@@ -347,4 +425,4 @@ let promise = displayClass.getCutoutInfo(); ...@@ -347,4 +425,4 @@ let promise = displayClass.getCutoutInfo();
promise.then((data) => { promise.then((data) => {
console.info('Succeeded in getting cutoutInfo. Data: ' + JSON.stringify(data)); console.info('Succeeded in getting cutoutInfo. Data: ' + JSON.stringify(data));
}); });
``` ```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-screen.md
浏览文件 @ 36e6c8d9
...@@ -87,10 +87,14 @@ on(eventType: 'connect' | 'disconnect' | 'change', callback: Callback&lt;number& ...@@ -87,10 +87,14 @@ on(eventType: 'connect' | 'disconnect' | 'change', callback: Callback&lt;number&
**示例：** **示例：**
```js ```js
var callback = (data) => { try {
console.info('Register the callback for screen changes. Data: ' + JSON.stringify(data)) let callback = (data) => {
console.info('Register the callback for screen changes. Data: ' + JSON.stringify(data))
};
screen.on('connect', callback);
} catch (exception) {
console.error('Failed to register the callback for screen changes. Code: ' + JSON.stringify(exception));
}; };
screen.on("connect", callback);
``` ```
## screen.off('connect' | 'disconnect' | 'change') ## screen.off('connect' | 'disconnect' | 'change')
...@@ -111,10 +115,14 @@ off(eventType: 'connect' | 'disconnect' | 'change', callback?: Callback&lt;numbe ...@@ -111,10 +115,14 @@ off(eventType: 'connect' | 'disconnect' | 'change', callback?: Callback&lt;numbe
**示例：** **示例：**
```js ```js
var callback = (data) => { try {
console.info('Unregister the callback for screen changes. Data: ' + JSON.stringify(data)) let callback = (data) => {
console.info('Unregister the callback for screen changes. Data: ' + JSON.stringify(data))
};
screen.off('connect', callback);
} catch (exception) {
console.error('Failed to register the callback for screen changes. Code: ' + JSON.stringify(exception));
}; };
screen.off("connect", callback);
``` ```
## screen.makeExpand ## screen.makeExpand
...@@ -135,15 +143,19 @@ makeExpand(options:Array&lt;ExpandOption&gt;, callback: AsyncCallback&lt;number& ...@@ -135,15 +143,19 @@ makeExpand(options:Array&lt;ExpandOption&gt;, callback: AsyncCallback&lt;number&
**示例：** **示例：**
```js ```js
var groupId = null; try {
screen.makeExpand([{screenId: 0, startX: 0, startY: 0}, {screenId: 1, startX: 1080, startY: 0}], (err, data) => { let groupId = null;
if (err.code) { screen.makeExpand([{screenId: 0, startX: 0, startY: 0}, {screenId: 1, startX: 1080, startY: 0}], (err, data) => {
console.error('Failed to make screens as expand-screen. Cause:' + JSON.stringify(err)); if (err.code) {
return; console.error('Failed to make screens as expand-screen. Code:' + JSON.stringify(err));
} return;
groupId = data; }
console.info('Succeeded in making screens as expand-screen.Data:' + JSON.stringify(data)); groupId = data;
}); console.info('Succeeded in making screens as expand-screen. Data: ' + JSON.stringify(data));
});
} catch (exception) {
console.error('Failed to make screens as expand-screen. Code: ' + JSON.stringify(exception));
};
``` ```
## screen.makeExpand ## screen.makeExpand
...@@ -169,11 +181,15 @@ makeExpand(options:Array&lt;ExpandOption&gt;): Promise&lt;number&gt; ...@@ -169,11 +181,15 @@ makeExpand(options:Array&lt;ExpandOption&gt;): Promise&lt;number&gt;
**示例：** **示例：**
```js ```js
screen.makeExpand([{screenId: 0, startX: 0, startY: 0}, {screenId: 1, startX: 1080, startY: 0}]).then((data) => { try {
console.info('Succeeded in making screens as expand-screen.Data:' + JSON.stringify(data)); screen.makeExpand([{screenId: 0, startX: 0, startY: 0}, {screenId: 1, startX: 1080, startY: 0}]).then((data) => {
}).catch((err) => { console.info('Succeeded in making screens as expand-screen. Data: ' + JSON.stringify(data));
console.error('Failed to make screens as expand-screen. Cause:' + JSON.stringify(err)); }).catch((err) => {
}); console.error('Failed to make screens as expand-screen. Code:' + JSON.stringify(err));
});
} catch (exception) {
console.error('Failed to make screens as expand-screen. Code: ' + JSON.stringify(exception));
};
``` ```
## screen.makeMirror ## screen.makeMirror
...@@ -195,15 +211,19 @@ makeMirror(mainScreen:number, mirrorScreen:Array&lt;number&gt;, callback: AsyncC ...@@ -195,15 +211,19 @@ makeMirror(mainScreen:number, mirrorScreen:Array&lt;number&gt;, callback: AsyncC
**示例：** **示例：**
```js ```js
var mainScreenId = 0; let mainScreenId = 0;
var mirrorScreenIds = [1, 2, 3]; let mirrorScreenIds = [1, 2, 3];
screen.makeMirror(mainScreenId, mirrorScreenIds, (err, data) => { try {
if (err.code) { screen.makeMirror(mainScreenId, mirrorScreenIds, (err, data) => {
console.error('Failed to make screens as mirror-screen.Cause:' + JSON.stringify(err)); if (err.code) {
return; console.error('Failed to make screens as mirror-screen. Code: ' + JSON.stringify(err));
} return;
console.info('Succeeded in making screens as mirror-screen.Data:' + JSON.stringify(data)); }
}); console.info('Succeeded in making screens as mirror-screen. Data: ' + JSON.stringify(data));
});
} catch (exception) {
console.error('Failed to make screens as mirror-screen. Code: ' + JSON.stringify(exception));
};
``` ```
## screen.makeMirror ## screen.makeMirror
...@@ -230,13 +250,17 @@ makeMirror(mainScreen:number, mirrorScreen:Array&lt;number&gt;): Promise&lt;numb ...@@ -230,13 +250,17 @@ makeMirror(mainScreen:number, mirrorScreen:Array&lt;number&gt;): Promise&lt;numb
**示例：** **示例：**
```js ```js
var mainScreenId = 0; let mainScreenId = 0;
var mirrorScreenIds = [1, 2, 3]; let mirrorScreenIds = [1, 2, 3];
screen.makeMirror(mainScreenId, mirrorScreenIds).then((data) => { try {
console.info('Succeeded in making screens as mirror-screen.Data:' + JSON.stringify(data)); screen.makeMirror(mainScreenId, mirrorScreenIds).then((data) => {
}).catch((err) => { console.info('Succeeded in making screens as mirror-screen. Data: ' + JSON.stringify(data));
console.error('Failed to make screens as mirror-screen.Cause:' + JSON.stringify(err)); }).catch((err) => {
}); console.error('Failed to make screens as mirror-screen. Code: ' + JSON.stringify(err));
});
} catch (exception) {
console.error('Failed to make screens as mirror-screen. Code: ' + JSON.stringify(exception));
};
``` ```
## screen.createVirtualScreen ## screen.createVirtualScreen
...@@ -259,21 +283,25 @@ createVirtualScreen(options:VirtualScreenOption, callback: AsyncCallback&lt;Scre ...@@ -259,21 +283,25 @@ createVirtualScreen(options:VirtualScreenOption, callback: AsyncCallback&lt;Scre
**示例：** **示例：**
```js ```js
var screenClass = null; let screenClass = null;
screen.createVirtualScreen({ try {
name: 'screen01', screen.createVirtualScreen({
width: 1080, name: 'screen01',
height: 2340, width: 1080,
density: 2, height: 2340,
surfaceId: '' density: 2,
}, (err, data) => { surfaceId: ''
if (err.code) { }, (err, data) => {
console.error('Failed to create virtual screen.Cause:' + JSON.stringify(err)); if (err.code) {
return; console.error('Failed to create virtual screen. Code: ' + JSON.stringify(err));
} return;
screenClass = data; }
console.info('Succeeded in creating virtual screen.Data:' + JSON.stringify(data)); screenClass = data;
}); console.info('Succeeded in creating virtual screen. Data: ' + JSON.stringify(data));
});
} catch (exception) {
console.error('Failed to create virtual screen. Code: ' + JSON.stringify(exception));
};
``` ```
## screen.createVirtualScreen ## screen.createVirtualScreen
...@@ -301,19 +329,23 @@ createVirtualScreen(options:VirtualScreenOption): Promise&lt;Screen&gt; ...@@ -301,19 +329,23 @@ createVirtualScreen(options:VirtualScreenOption): Promise&lt;Screen&gt;
**示例：** **示例：**
```js ```js
var screenClass = null; let screenClass = null;
screen.createVirtualScreen({ try {
name: 'screen01', screen.createVirtualScreen({
width: 1080, name: 'screen01',
height: 2340, width: 1080,
density: 2, height: 2340,
surfaceId: '' density: 2,
}).then((data) => { surfaceId: ''
screenClass = data; }).then((data) => {
console.info('Succeeded in creating virtual screen.Data:' + JSON.stringify(data)); screenClass = data;
}).catch((err) => { console.info('Succeeded in creating virtual screen. Data: ' + JSON.stringify(data));
console.error('Failed to create virtual screen.Cause:' + JSON.stringify(err)); }).catch((err) => {
}); console.error('Failed to create virtual screen. Code: ' + JSON.stringify(err));
});
} catch (exception) {
console.error('Failed to create virtual screen. Code: ' + JSON.stringify(exception));
};
``` ```
## screen.destroyVirtualScreen ## screen.destroyVirtualScreen
...@@ -334,14 +366,18 @@ destroyVirtualScreen(screenId:number, callback: AsyncCallback&lt;void&gt;): void ...@@ -334,14 +366,18 @@ destroyVirtualScreen(screenId:number, callback: AsyncCallback&lt;void&gt;): void
**示例：** **示例：**
```js ```js
var screenId = 1; let screenId = 1;
screen.destroyVirtualScreen(screenId, (err,data) => { try {
if (err.code) { screen.destroyVirtualScreen(screenId, (err,data) => {
console.error('Failed to destroy virtual screen.Cause:' + JSON.stringify(err)); if (err.code) {
return; console.error('Failed to destroy virtual screen. Code: ' + JSON.stringify(err));
} return;
console.info('Succeeded in destroying virtual screen.'); }
}); console.info('Succeeded in destroying virtual screen.');
});
} catch (exception) {
console.error('Failed to destroy virtual screen. Code: ' + JSON.stringify(exception));
};
``` ```
## screen.destroyVirtualScreen ## screen.destroyVirtualScreen
...@@ -367,12 +403,16 @@ destroyVirtualScreen(screenId:number): Promise&lt;void&gt; ...@@ -367,12 +403,16 @@ destroyVirtualScreen(screenId:number): Promise&lt;void&gt;
**示例：** **示例：**
```js ```js
var screenId = 1; let screenId = 1;
screen.destroyVirtualScreen(screenId).then((data) => { try {
console.info('Succeeded in destroying virtual screen.'); screen.destroyVirtualScreen(screenId).then((data) => {
}).catch((err) => { console.info('Succeeded in destroying virtual screen.');
console.error('Failed to destroy virtual screen.Cause:' + JSON.stringify(err)); }).catch((err) => {
}); console.error('Failed to destroy virtual screen. Code: ' + JSON.stringify(err));
});
} catch (exception) {
console.error('Failed to destroy virtual screen. Code: ' + JSON.stringify(exception));
};
``` ```
## screen.setVirtualScreenSurface ## screen.setVirtualScreenSurface
...@@ -396,15 +436,19 @@ setVirtualScreenSurface(screenId:number, surfaceId: string, callback: AsyncCallb ...@@ -396,15 +436,19 @@ setVirtualScreenSurface(screenId:number, surfaceId: string, callback: AsyncCallb
**示例：** **示例：**
```js ```js
var screenId = 1; let screenId = 1;
var surfaceId = '2048'; let surfaceId = '2048';
screen.setVirtualScreenSurface(screenId, surfaceId, (err,data) => { try {
if (err.code) { screen.setVirtualScreenSurface(screenId, surfaceId, (err,data) => {
console.error('Failed to Set surface for the virtual screen.Cause:' + JSON.stringify(err)); if (err.code) {
return; console.error('Failed to Set surface for the virtual screen. Code: ' + JSON.stringify(err));
} return;
console.info('Succeeded in setting surface for the virtual screen.'); }
}); console.info('Succeeded in setting surface for the virtual screen.');
});
} catch (exception) {
console.error('Failed to Set surface for the virtual screen. Code: ' + JSON.stringify(exception));
};
``` ```
## screen.setVirtualScreenSurface ## screen.setVirtualScreenSurface
...@@ -433,13 +477,17 @@ setVirtualScreenSurface(screenId:number, surfaceId: string): Promise&lt;void&gt; ...@@ -433,13 +477,17 @@ setVirtualScreenSurface(screenId:number, surfaceId: string): Promise&lt;void&gt;
**示例：** **示例：**
```js ```js
var screenId = 1; let screenId = 1;
var surfaceId = '2048'; let surfaceId = '2048';
screen.setVirtualScreenSurface(screenId, surfaceId).then((data) => { try {
console.info('Succeeded in setting surface for the virtual screen.'); screen.setVirtualScreenSurface(screenId, surfaceId).then((data) => {
}).catch((err) => { console.info('Succeeded in setting surface for the virtual screen.');
console.error('Failed to Set surface for the virtual screen.Cause:' + JSON.stringify(err)); }).catch((err) => {
}); console.error('Failed to Set surface for the virtual screen. Code: ' + JSON.stringify(err));
});
} catch (exception) {
console.error('Failed to Set surface for the virtual screen. Code: ' + JSON.stringify(exception));
};
``` ```
## screen.isScreenRotationLocked ## screen.isScreenRotationLocked
...@@ -515,12 +563,16 @@ setScreenRotationLocked(isLocked: boolean): Promise&lt;void&gt; ...@@ -515,12 +563,16 @@ setScreenRotationLocked(isLocked: boolean): Promise&lt;void&gt;
**示例：** **示例：**
```js ```js
var isLocked = false; let isLocked = false;
screen.setScreenRotationLocked(isLocked).then((data) => { try {
console.info('Succeeded in setting whether to lock screen rotation'); screen.setScreenRotationLocked(isLocked).then((data) => {
}).catch((err) => { console.info('Succeeded in setting whether to lock screen rotation');
console.error('Failed to set whether to lock screen rotation. Cause:' + JSON.stringify(err)); }).catch((err) => {
}); console.error('Failed to set whether to lock screen rotation. Code: ' + JSON.stringify(err));
});
} catch (exception) {
console.error('Failed to set whether to lock screen rotation. Code: ' + JSON.stringify(exception));
};
``` ```
## screen.setScreenRotationLocked ## screen.setScreenRotationLocked
...@@ -541,14 +593,18 @@ setScreenRotationLocked(isLocked: boolean, callback: AsyncCallback&lt;void&gt;): ...@@ -541,14 +593,18 @@ setScreenRotationLocked(isLocked: boolean, callback: AsyncCallback&lt;void&gt;):
**示例：** **示例：**
```js ```js
var isLocked = false; let isLocked = false;
screen.setScreenRotationLocked(isLocked, (err, data) => { try {
if (err.code) { screen.setScreenRotationLocked(isLocked, (err, data) => {
console.error('Failed to set whether to lock screen rotation. Cause:' + JSON.stringify(err)); if (err.code) {
return; console.error('Failed to set whether to lock screen rotation. Cause:' + JSON.stringify(err));
} return;
console.info('Succeeded in setting whether to lock screen rotation.'); }
}); console.info('Succeeded in setting whether to lock screen rotation.');
});
} catch (exception) {
console.error('Failed to set whether to lock screen rotation. Code: ' + JSON.stringify(exception));
};
``` ```
## ExpandOption ## ExpandOption
...@@ -609,13 +665,17 @@ setOrientation(orientation: Orientation, callback: AsyncCallback&lt;void&gt;): v ...@@ -609,13 +665,17 @@ setOrientation(orientation: Orientation, callback: AsyncCallback&lt;void&gt;): v
**示例：** **示例：**
```js ```js
screenClass.setOrientation(screen.Orientation.VERTICAL, (err, data) => { try {
if (err.code) { screenClass.setOrientation(screen.Orientation.VERTICAL, (err, data) => {
console.error('Failed to setOrientation VERTICAL. Cause: ' + JSON.stringify(err)); if (err.code) {
return; console.error('Failed to set Orientation VERTICAL. Code: ' + JSON.stringify(err));
} return;
console.info('Succeeded in setting Orientation VERTICAL. data: ' + JSON.stringify(data)); }
}) console.info('Succeeded in setting Orientation VERTICAL. data: ' + JSON.stringify(data));
});
} catch (exception) {
console.error('Failed to set Orientation VERTICAL. Code: ' + JSON.stringify(exception));
};
``` ```
### setOrientation ### setOrientation
...@@ -639,12 +699,16 @@ setOrientation(orientation: Orientation): Promise&lt;void&gt; ...@@ -639,12 +699,16 @@ setOrientation(orientation: Orientation): Promise&lt;void&gt;
**示例：** **示例：**
```js ```js
let promise = screenClass.setOrientation(screen.Orientation.VERTICAL); try {
promise.then((data) => { let promise = screenClass.setOrientation(screen.Orientation.VERTICAL);
console.info('Succeeded in setting Orientation VERTICAL. Data: ' + JSON.stringify(data)); promise.then((data) => {
}).catch((err) => { console.info('Succeeded in setting Orientation VERTICAL. Data: ' + JSON.stringify(data));
console.error('Failed to set Orientation VERTICAL. Cause: ' + JSON.stringify(err)); }).catch((err) => {
}) console.error('Failed to set Orientation VERTICAL. Cause: ' + JSON.stringify(err));
});
} catch (exception) {
console.error('Failed to set Orientation VERTICAL. Code: ' + JSON.stringify(exception));
};
``` ```
### setScreenActiveMode ### setScreenActiveMode
...@@ -663,14 +727,18 @@ setScreenActiveMode(modeIndex: number, callback: AsyncCallback&lt;void&gt;): voi ...@@ -663,14 +727,18 @@ setScreenActiveMode(modeIndex: number, callback: AsyncCallback&lt;void&gt;): voi
**示例：** **示例：**
```js ```js
var modeIndex = 0; let modeIndex = 0;
screenClass.setScreenActiveMode(modeIndex, (err, data) => { try {
if (err.code) { screenClass.setScreenActiveMode(modeIndex, (err, data) => {
console.error('Failed to set ScreenActiveMode 0. Cause: ' + JSON.stringify(err)); if (err.code) {
return; console.error('Failed to set ScreenActiveMode 0. Code: ' + JSON.stringify(err));
} return;
console.info('Succeeded in setting ScreenActiveMode 0. data: ' + JSON.stringify(data)); }
}) console.info('Succeeded in setting ScreenActiveMode 0. data: ' + JSON.stringify(data));
});
} catch (exception) {
console.error('Failed to set ScreenActiveMode 0. Code: ' + JSON.stringify(exception));
};
``` ```
### setScreenActiveMode ### setScreenActiveMode
...@@ -694,13 +762,17 @@ setScreenActiveMode(modeIndex: number): Promise&lt;void&gt; ...@@ -694,13 +762,17 @@ setScreenActiveMode(modeIndex: number): Promise&lt;void&gt;
**示例：** **示例：**
```js ```js
var modeIndex = 0; let modeIndex = 0;
let promise = screenClass.setScreenActiveMode(modeIndex); try {
promise.then((data) => { let promise = screenClass.setScreenActiveMode(modeIndex);
console.info('Succeeded in setting ScreenActiveMode 0. Data: ' + JSON.stringify(data)); promise.then((data) => {
}).catch((err) => { console.info('Succeeded in setting ScreenActiveMode 0. Data: ' + JSON.stringify(data));
console.error('Failed to set ScreenActiveMode 0. Cause: ' + JSON.stringify(err)); }).catch((err) => {
}) console.error('Failed to set ScreenActiveMode 0. Code: ' + JSON.stringify(err));
});
} catch (exception) {
console.error('Failed to set ScreenActiveMode 0. Code: ' + JSON.stringify(exception));
};
``` ```
### setDensityDpi ### setDensityDpi
...@@ -719,14 +791,18 @@ setDensityDpi(densityDpi: number, callback: AsyncCallback&lt;void&gt;): void; ...@@ -719,14 +791,18 @@ setDensityDpi(densityDpi: number, callback: AsyncCallback&lt;void&gt;): void;
**示例：** **示例：**
```js ```js
var densityDpi = 320; let densityDpi = 320;
screenClass.setDensityDpi(densityDpi, (err, data) => { try {
if (err.code) { screenClass.setDensityDpi(densityDpi, (err, data) => {
console.error('Failed to set DensityDpi 320. Cause: ' + JSON.stringify(err)); if (err.code) {
return; console.error('Failed to set DensityDpi 320. Code: ' + JSON.stringify(err));
} return;
console.info('Succeed in setting DensityDpi 320. data: ' + JSON.stringify(data)); }
}) console.info('Succeed in setting DensityDpi 320. data: ' + JSON.stringify(data));
});
} catch (exception) {
console.error('Failed to set DensityDpi 320. Code: ' + JSON.stringify(exception));
};
``` ```
### setDensityDpi ### setDensityDpi
...@@ -750,13 +826,17 @@ setDensityDpi(densityDpi: number): Promise&lt;void&gt; ...@@ -750,13 +826,17 @@ setDensityDpi(densityDpi: number): Promise&lt;void&gt;
**示例：** **示例：**
```js ```js
var densityDpi = 320; let densityDpi = 320;
var promise = screenClass.setDensityDpi(densityDpi); try {
promise.then((data) => { let promise = screenClass.setDensityDpi(densityDpi);
console.info('Succeeded in setting DensityDpi 320. Data: ' + JSON.stringify(data)); promise.then((data) => {
}).catch((err) => { console.info('Succeeded in setting DensityDpi 320. Data: ' + JSON.stringify(data));
console.error('Failed to set DensityDpi 320. Cause: ' + JSON.stringify(err)); }).catch((err) => {
}) console.error('Failed to set DensityDpi 320. Code: ' + JSON.stringify(err));
});
} catch (exception) {
console.error('Failed to set DensityDpi 320. Code: ' + JSON.stringify(exception));
};
``` ```
## Orientation ## Orientation
......
zh-cn/application-dev/reference/apis/js-apis-screenshot.md
浏览文件 @ 36e6c8d9
...@@ -73,7 +73,7 @@ save(options: ScreenshotOptions, callback: AsyncCallback&lt;image.PixelMap&gt;): ...@@ -73,7 +73,7 @@ save(options: ScreenshotOptions, callback: AsyncCallback&lt;image.PixelMap&gt;):
**示例：** **示例：**
```js ```js
var screenshotOptions = { let screenshotOptions = {
"screenRect": { "screenRect": {
"left": 200, "left": 200,
"top": 100, "top": 100,
...@@ -85,14 +85,18 @@ save(options: ScreenshotOptions, callback: AsyncCallback&lt;image.PixelMap&gt;): ...@@ -85,14 +85,18 @@ save(options: ScreenshotOptions, callback: AsyncCallback&lt;image.PixelMap&gt;):
"rotation": 0, "rotation": 0,
"displayId": 0 "displayId": 0
}; };
screenshot.save(screenshotOptions, (err, pixelMap) => { try {
if (err) { screenshot.save(screenshotOptions, (err, pixelMap) => {
console.log('Failed to save screenshot: ' + JSON.stringify(err)); if (err) {
return; console.log('Failed to save screenshot. Code: ' + JSON.stringify(err));
} return;
console.log('Succeeded in saving sreenshot. Pixel bytes number: ' + pixelMap.getPixelBytesNumber()); }
pixelMap.release(); // PixelMap使用完后及时释放内存 console.log('Succeeded in saving sreenshot. Pixel bytes number: ' + pixelMap.getPixelBytesNumber());
}); pixelMap.release(); // PixelMap使用完后及时释放内存
});
} catch (exception) {
console.error('Failed to save screenshot. Code: ' + JSON.stringify(exception));
};
``` ```
## screenshot.save ## screenshot.save
...@@ -114,14 +118,18 @@ save(callback: AsyncCallback&lt;image.PixelMap&gt;): void ...@@ -114,14 +118,18 @@ save(callback: AsyncCallback&lt;image.PixelMap&gt;): void
**示例：** **示例：**
```js ```js
screenshot.save((err, pixelMap) => { try {
if (err) { screenshot.save((err, pixelMap) => {
console.log('Failed to save screenshot: ' + JSON.stringify(err)); if (err) {
return; console.log('Failed to save screenshot. Code: ' + JSON.stringify(err));
} return;
console.log('Succeeded in saving sreenshot. Pixel bytes number: ' + pixelMap.getPixelBytesNumber()); }
pixelMap.release(); // PixelMap使用完后及时释放内存 console.log('Succeeded in saving sreenshot. Pixel bytes number: ' + pixelMap.getPixelBytesNumber());
}); pixelMap.release(); // PixelMap使用完后及时释放内存
});
} catch (exception) {
console.error('Failed to save screenshot. Code: ' + JSON.stringify(exception));
};
``` ```
## screenshot.save ## screenshot.save
...@@ -149,7 +157,7 @@ save(options?: ScreenshotOptions): Promise&lt;image.PixelMap&gt; ...@@ -149,7 +157,7 @@ save(options?: ScreenshotOptions): Promise&lt;image.PixelMap&gt;
**示例：** **示例：**
```js ```js
var screenshotOptions = { let screenshotOptions = {
"screenRect": { "screenRect": {
"left": 200, "left": 200,
"top": 100, "top": 100,
...@@ -161,11 +169,15 @@ save(options?: ScreenshotOptions): Promise&lt;image.PixelMap&gt; ...@@ -161,11 +169,15 @@ save(options?: ScreenshotOptions): Promise&lt;image.PixelMap&gt;
"rotation": 0, "rotation": 0,
"displayId": 0 "displayId": 0
}; };
let promise = screenshot.save(screenshotOptions); try {
promise.then((pixelMap) => { let promise = screenshot.save(screenshotOptions);
console.log('Succeeded in saving sreenshot. Pixel bytes number: ' + pixelMap.getPixelBytesNumber()); promise.then((pixelMap) => {
pixelMap.release(); // PixelMap使用完后及时释放内存 console.log('Succeeded in saving sreenshot. Pixel bytes number: ' + pixelMap.getPixelBytesNumber());
}).catch((err) => { pixelMap.release(); // PixelMap使用完后及时释放内存
console.log('Failed to save screenshot: ' + JSON.stringify(err)); }).catch((err) => {
}); console.log('Failed to save screenshot. Code: ' + JSON.stringify(err));
});
} catch (exception) {
console.error('Failed to save screenshot. Code: ' + JSON.stringify(exception));
};
``` ```
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或