Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

通知 159
Star 292
Fork 28
D
Docs
未验证 提交 9893a792 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!1677 修改display接口资料，增加screenshot接口资料 

Merge pull request !1677 from youqijing/master
上级 cf016872 1dc52ad1
隐藏空白更改
内联 并排
Showing with 191 addition and 6 deletion
zh-cn/application-dev/reference/apis/Readme-CN.md
浏览文件 @ 9893a792
......@@ -74,6 +74,7 @@
- [动画](js-apis-basic-features-animator.md)
- [WebGL](js-apis-webgl.md)
- [WebGL2](js-apis-webgl2.md)
- [屏幕截图](js-apis-screenshot.md)
- DFX
- [应用打点](js-apis-hiappevent.md)
- [性能打点](js-apis-hitracemeter.md)
......
zh-cn/application-dev/reference/apis/js-apis-display.md
浏览文件 @ 9893a792
# 显示设备属性
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
......@@ -34,7 +34,7 @@ import display from '@ohos.display';
| id | number | 是 | 否 | 显示设备的id号。<br/>**系统能力**：SystemCapability.WindowManager.WindowManager.Core |
| name | string | 是 | 否 | 显示设备的名称。<br/>**系统能力**：SystemCapability.WindowManager.WindowManager.Core |
| alive | boolean | 是 | 否 | 显示设备是否启用。<br/>**系统能力**：SystemCapability.WindowManager.WindowManager.Core |
| state | DisplayState | 是 | 否 | 显示设备的状态。<br/>**系统能力**：SystemCapability.WindowManager.WindowManager.Core |
| state | [DisplayState](#DisplayState) | 是 | 否 | 显示设备的状态。<br/>**系统能力**：SystemCapability.WindowManager.WindowManager.Core |
| refreshRate | number | 是 | 否 | 显示设备的刷新率。<br/>**系统能力**：SystemCapability.WindowManager.WindowManager.Core |
| rotation | number | 是 | 否 | 显示设备的屏幕旋转角度。<br/>**系统能力**：SystemCapability.WindowManager.WindowManager.Core |
| width | number | 是 | 否 | 显示设备的宽度，单位为像素。<br/>**系统能力**：SystemCapability.WindowManager.WindowManager.Core |
......@@ -52,10 +52,12 @@ getDefaultDisplay(callback: AsyncCallback&lt;Display&gt;): void
获取当前默认的display对象。
**系统能力**：SystemCapability.WindowManager.WindowManager.Core
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;Display&gt; | 是 | 回调返回当前默认的display对象。 |
| callback | AsyncCallback&lt;[Display](#Display)&gt; | 是 | 回调返回当前默认的display对象。 |
- 示例
```
......@@ -70,17 +72,44 @@ getDefaultDisplay(callback: AsyncCallback&lt;Display&gt;): void
});
```
## display.getDefaultDisplay
getDefaultDisplay(): Promise&lt;Display&gt;
获取当前默认的display对象。
**系统能力**：SystemCapability.WindowManager.WindowManager.Core
- 返回值
| 类型 | 说明 |
| ---------------------------------- | ---------------------------------------------- |
| Promise&lt;[Display](#Display)&gt; | 以Promise形式返回结果，返回默认的display对象。 |
- 示例
```
let promise = display.getDefaultDisplay();
promise.then(() => {
console.log('getDefaultDisplay success');
}).catch((err) => {
console.log('getDefaultDisplay fail: ' + JSON.stringify(err));
});
```
## display.getAllDisplay
getAllDisplay(callback: AsyncCallback&lt;Array&lt;Display&gt;&gt;): void
获取当前所有的display对象。
**系统能力**：SystemCapability.WindowManager.WindowManager.Core
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------- | ---- | ------------------------------- |
| callback | AsyncCallback&lt;Array&lt;Display&gt;&gt; | 是 | 回调返回当前所有的display对象。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------------------- | ---- | ------------------------------- |
| callback | AsyncCallback&lt;Array&lt;[Display](Display)&gt;&gt; | 是 | 回调返回当前所有的display对象。 |
- 示例
......@@ -94,12 +123,39 @@ getAllDisplay(callback: AsyncCallback&lt;Array&lt;Display&gt;&gt;): void
});
```
## display.getAllDisplay
getAllDisplay(): Promise&lt;Array&lt;Display&gt;&gt;
获取当前所有的display对象。
**系统能力**：SystemCapability.WindowManager.WindowManager.Core
- 返回值
| 类型 | 说明 |
| ----------------------------------------------- | ------------------------------------------------------- |
| Promise&lt;Array&lt;[Display](#Display)&gt;&gt; | 以Promise形式返回结果，返回包含所有Display对象的Array。 |
- 示例
```
let promise = display.getAllDisplay();
promise.then(() => {
console.log('getAllDisplay success');
}).catch((err) => {
console.log('getAllDisplay fail: ' + JSON.stringify(err));
});
```
## display.on('add'|'remove'|'change')
on(type: 'add'|'remove'|'change', callback: Callback&lt;number&gt;): void
开启监听。
**系统能力**：SystemCapability.WindowManager.WindowManager.Core
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
......@@ -122,6 +178,8 @@ off(type: 'add'|'remove'|'change', callback?: Callback&lt;number&gt;): void
关闭监听。
**系统能力**：SystemCapability.WindowManager.WindowManager.Core
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
......
zh-cn/application-dev/reference/apis/js-apis-screenshot.md 0 → 100644
浏览文件 @ 9893a792
# 屏幕截图
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
```
import screenshot from '@ohos.screenshot';
```
## ScreenshotOptions
设置截取图像的信息。
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------- | ---- | ------------------------------------------------------------ |
| screenRect | [Rect](#Rect) | 否 | 表示截取图像的区域，不传值默认为全屏。<br/>**系统能力**：SystemCapability.WindowManager.WindowManager.Core |
| imageSize | [Size](#Size) | 否 | 表示截取图像的大小，不传值默认为全屏。<br/>**系统能力**：SystemCapability.WindowManager.WindowManager.Core |
| rotation | number | 否 | 表示截取图像的旋转角度，取值可为0、90、180、270，默认值为0。<br/>**系统能力**：SystemCapability.WindowManager.WindowManager.Core |
## Rect
表示截取图像的区域。
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| left | number | 是 | 表示截取图像区域的左边界。<br/>**系统能力**：SystemCapability.WindowManager.WindowManager.Core |
| top | number | 是 | 表示截取图像区域的上边界。<br/>**系统能力**：SystemCapability.WindowManager.WindowManager.Core |
| width | number | 是 | 表示截取图像区域的宽度。<br/>**系统能力**：SystemCapability.WindowManager.WindowManager.Core |
| height | number | 是 | 表示截取图像区域的高度。<br/>**系统能力**：SystemCapability.WindowManager.WindowManager.Core |
## Size
表示截取图像的大小。
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| width | number | 是 | 表示截取图像的宽度。<br/>**系统能力**：SystemCapability.WindowManager.WindowManager.Core |
| height | number | 是 | 表示截取图像的高度。<br/>**系统能力**：SystemCapability.WindowManager.WindowManager.Core |
## screenshot.save
save(options?: ScreenshotOptions, callback: AsyncCallback&lt;image.PixelMap&gt;): void
获取屏幕截图。
**系统能力**：SystemCapability.WindowManager.WindowManager.Core
**需要权限**：ohos.permission.CAPTURE_SCREEN
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [ScreenshotOptions](#ScreenshotOptions) | 否 | 该类型的参数包含screenRect，imageSize，rotation三个参数，需要分别设置这三个参数。 |
| callback | AsyncCallback&lt;image.PixelMap&gt; | 是 | 回调返回一个PixelMap对象。 |
- 示例
```
var ScreenshotOptions = {
"screenRect": {
"left": 200,
"top": 100,
"width": 200,
"height": 200},
"imageSize": {
"width": 300,
"height": 300},
"rotation": 0
};
screenshot.save(ScreenshotOptions, (err, data) => {
if (err) {
console.error('Failed to save the screenshot. Error: ' + JSON.stringify(err));
return;
}
console.info('Screenshot saved. Data: ' + JSON.stringify(data));
});
```
## screenshot.save
save(options?: ScreenshotOptions): Promise&lt;image.PixelMap&gt;
获取屏幕截图。
**系统能力**：SystemCapability.WindowManager.WindowManager.Core
**需要权限**：ohos.permission.CAPTURE_SCREEN
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [ScreenshotOptions](#ScreenshotOptions) | 否 | 该类型的参数包含screenRect，imageSize，rotation三个参数，需要分别设置这三个参数。 |
- 返回值
| 类型 | 说明 |
| ----------------------------- | ----------------------------------------------- |
| Promise&lt;image.PixelMap&gt; | 以Promise形式返回结果，返回image.PixelMap对象。 |
- 示例
```
var ScreenshotOptions = {
"screenRect": {
"left": 200,
"top": 100,
"width": 200,
"height": 200},
"imageSize": {
"width": 300,
"height": 300},
"rotation": 0
};
let promise = screenshot.save(ScreenshotOptions);
promise.then(() => {
console.log('screenshot save success');
}).catch((err) => {
console.log('screenshot save fail: ' + JSON.stringify(err));
});
```
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或