diff --git a/zh-cn/application-dev/reference/apis/Readme-CN.md b/zh-cn/application-dev/reference/apis/Readme-CN.md index 6de6ed329ebd40cebb034a9a80dfa66b8ca8aa46..d2d2b8b140eff271208998905f76ea00c173fd3d 100644 --- a/zh-cn/application-dev/reference/apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/apis/Readme-CN.md @@ -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) diff --git a/zh-cn/application-dev/reference/apis/js-apis-display.md b/zh-cn/application-dev/reference/apis/js-apis-display.md index 81b71545a7c3dd16a97281a52bd6818c5a0f386c..ffc1c7cf5f35674f95be38a44c4dcd42a663bef9 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-display.md +++ b/zh-cn/application-dev/reference/apis/js-apis-display.md @@ -1,7 +1,7 @@ # 显示设备属性 > ![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号。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | | name | string | 是 | 否 | 显示设备的名称。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | | alive | boolean | 是 | 否 | 显示设备是否启用。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | -| state | DisplayState | 是 | 否 | 显示设备的状态。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +| state | [DisplayState](#DisplayState) | 是 | 否 | 显示设备的状态。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | | refreshRate | number | 是 | 否 | 显示设备的刷新率。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | | rotation | number | 是 | 否 | 显示设备的屏幕旋转角度。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | | width | number | 是 | 否 | 显示设备的宽度,单位为像素。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | @@ -52,10 +52,12 @@ getDefaultDisplay(callback: AsyncCallback<Display>): void 获取当前默认的display对象。 +**系统能力**:SystemCapability.WindowManager.WindowManager.Core + - 参数 | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<Display> | 是 | 回调返回当前默认的display对象。 | + | callback | AsyncCallback<[Display](#Display)> | 是 | 回调返回当前默认的display对象。 | - 示例 ``` @@ -70,17 +72,44 @@ getDefaultDisplay(callback: AsyncCallback<Display>): void }); ``` +## display.getDefaultDisplay + +getDefaultDisplay(): Promise<Display> + +获取当前默认的display对象。 + +**系统能力**:SystemCapability.WindowManager.WindowManager.Core + +- 返回值 + + | 类型 | 说明 | + | ---------------------------------- | ---------------------------------------------- | + | Promise<[Display](#Display)> | 以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<Array<Display>>): void 获取当前所有的display对象。 +**系统能力**:SystemCapability.WindowManager.WindowManager.Core + - 参数 - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ----------------------------------------- | ---- | ------------------------------- | - | callback | AsyncCallback<Array<Display>> | 是 | 回调返回当前所有的display对象。 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | ---------------------------------------------------- | ---- | ------------------------------- | + | callback | AsyncCallback<Array<[Display](Display)>> | 是 | 回调返回当前所有的display对象。 | - 示例 @@ -94,12 +123,39 @@ getAllDisplay(callback: AsyncCallback<Array<Display>>): void }); ``` +## display.getAllDisplay + +getAllDisplay(): Promise<Array<Display>> + +获取当前所有的display对象。 + +**系统能力**:SystemCapability.WindowManager.WindowManager.Core + +- 返回值 + + | 类型 | 说明 | + | ----------------------------------------------- | ------------------------------------------------------- | + | Promise<Array<[Display](#Display)>> | 以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<number>): void 开启监听。 +**系统能力**:SystemCapability.WindowManager.WindowManager.Core + - 参数 | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -122,6 +178,8 @@ off(type: 'add'|'remove'|'change', callback?: Callback<number>): void 关闭监听。 +**系统能力**:SystemCapability.WindowManager.WindowManager.Core + - 参数 | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | diff --git a/zh-cn/application-dev/reference/apis/js-apis-screenshot.md b/zh-cn/application-dev/reference/apis/js-apis-screenshot.md new file mode 100644 index 0000000000000000000000000000000000000000..881f2751dcf2612f30a1aebc9ac834b7bf380588 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-screenshot.md @@ -0,0 +1,126 @@ +# 屏幕截图 + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 + +## 导入模块 + +``` +import screenshot from '@ohos.screenshot'; +``` + +## ScreenshotOptions + +设置截取图像的信息。 + +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------------- | ---- | ------------------------------------------------------------ | +| screenRect | [Rect](#Rect) | 否 | 表示截取图像的区域,不传值默认为全屏。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +| imageSize | [Size](#Size) | 否 | 表示截取图像的大小,不传值默认为全屏。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +| rotation | number | 否 | 表示截取图像的旋转角度,取值可为0、90、180、270,默认值为0。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | + + +## Rect + +表示截取图像的区域。 + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------------------------------------ | +| left | number | 是 | 表示截取图像区域的左边界。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +| top | number | 是 | 表示截取图像区域的上边界。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +| width | number | 是 | 表示截取图像区域的宽度。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +| height | number | 是 | 表示截取图像区域的高度。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | + + +## Size + +表示截取图像的大小。 + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------------------------------------ | +| width | number | 是 | 表示截取图像的宽度。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | +| height | number | 是 | 表示截取图像的高度。
**系统能力**:SystemCapability.WindowManager.WindowManager.Core | + +## screenshot.save + +save(options?: ScreenshotOptions, callback: AsyncCallback<image.PixelMap>): void + +获取屏幕截图。 + +**系统能力**:SystemCapability.WindowManager.WindowManager.Core + +**需要权限**:ohos.permission.CAPTURE_SCREEN + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | --------------------------------------- | ---- | ------------------------------------------------------------ | + | options | [ScreenshotOptions](#ScreenshotOptions) | 否 | 该类型的参数包含screenRect,imageSize,rotation三个参数,需要分别设置这三个参数。 | + | callback | AsyncCallback<image.PixelMap> | 是 | 回调返回一个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<image.PixelMap> + +获取屏幕截图。 + +**系统能力**:SystemCapability.WindowManager.WindowManager.Core + +**需要权限**:ohos.permission.CAPTURE_SCREEN + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | ------- | --------------------------------------- | ---- | ------------------------------------------------------------ | + | options | [ScreenshotOptions](#ScreenshotOptions) | 否 | 该类型的参数包含screenRect,imageSize,rotation三个参数,需要分别设置这三个参数。 | + +- 返回值 + + | 类型 | 说明 | + | ----------------------------- | ----------------------------------------------- | + | Promise<image.PixelMap> | 以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)); + }); + ```