diff --git a/zh-cn/application-dev/reference/apis-arkui/js-apis-display.md b/zh-cn/application-dev/reference/apis-arkui/js-apis-display.md index 83fd353861c3e3bc4f429d5c5fc5e43be8330058..54c4d8ff147165660a15a211fa067c59ccf0d66e 100644 --- a/zh-cn/application-dev/reference/apis-arkui/js-apis-display.md +++ b/zh-cn/application-dev/reference/apis-arkui/js-apis-display.md @@ -69,10 +69,10 @@ import { display } from '@kit.ArkUI'; | 名称 | 值 | 说明 | | -------- | -------- | -------- | -| FOLD_STATUS_UNKNOWN10+ | 0 | 表示设备当前折叠状态未知。
**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。| -| FOLD_STATUS_EXPANDED10+ | 1 | 表示设备当前折叠状态为完全展开。如果是双折轴设备，则表示折轴一折叠状态为完全展开，折轴二折叠状态为折叠。
**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。| -| FOLD_STATUS_FOLDED10+ | 2 | 表示设备当前折叠状态为折叠。如果是双折轴设备，则表示折轴一折叠状态为折叠，折轴二折叠状态为折叠。
**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。| -| FOLD_STATUS_HALF_FOLDED10+ | 3 | 表示设备当前折叠状态为半折叠。半折叠指完全展开和折叠之间的状态。如果是双折轴设备，则表示折轴一折叠状态为半折叠，折轴二折叠状态为折叠。
**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。| +| FOLD_STATUS_UNKNOWN | 0 | 表示设备当前折叠状态未知。
**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。| +| FOLD_STATUS_EXPANDED | 1 | 表示设备当前折叠状态为完全展开。如果是双折轴设备，则表示折轴一折叠状态为完全展开，折轴二折叠状态为折叠。
**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。| +| FOLD_STATUS_FOLDED | 2 | 表示设备当前折叠状态为折叠。如果是双折轴设备，则表示折轴一折叠状态为折叠，折轴二折叠状态为折叠。
**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。| +| FOLD_STATUS_HALF_FOLDED | 3 | 表示设备当前折叠状态为半折叠。半折叠指完全展开和折叠之间的状态。如果是双折轴设备，则表示折轴一折叠状态为半折叠，折轴二折叠状态为折叠。
**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。| | FOLD_STATUS_EXPANDED_WITH_SECOND_EXPANDED15+ | 11 | 表示双折轴设备折轴一折叠状态为完全展开，折轴二折叠状态为完全展开。
**原子化服务API：** 从API version 15开始，该接口支持在原子化服务中使用。| | FOLD_STATUS_EXPANDED_WITH_SECOND_HALF_FOLDED15+ | 21 | 表示双折轴设备折轴一折叠状态为完全展开，折轴二折叠状态为半折叠。
**原子化服务API：** 从API version 15开始，该接口支持在原子化服务中使用。| | FOLD_STATUS_FOLDED_WITH_SECOND_EXPANDED15+ | 12 | 表示双折轴设备折轴一折叠状态为折叠，折轴二折叠状态为完全展开。
**原子化服务API：** 从API version 15开始，该接口支持在原子化服务中使用。| @@ -113,7 +113,7 @@ import { display } from '@kit.ArkUI'; **系统能力：** SystemCapability.Window.SessionManager -| 名称 | 类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 只读 | 可选 | 说明 | | ------ | -------- | ---- | ---- | ------------------ | | displayId | number | 是 | 否 | 显示器ID，用于识别折痕所在的屏幕。 | | creaseRects | Array\<[Rect](#rect9)> | 是 | 否 | 折痕区域。 | @@ -126,12 +126,12 @@ import { display } from '@kit.ArkUI'; **系统能力：** SystemCapability.WindowManager.WindowManager.Core -| 名称 | 类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 只读 | 可选 | 说明 | | ------ | -------- | ---- | ---- | ------------------ | -| left | number | 是 | 是 | 矩形区域的左边界，单位为px，该参数为整数。 | -| top | number | 是 | 是 | 矩形区域的上边界，单位为px，该参数为整数。 | -| width | number | 是 | 是 | 矩形区域的宽度，单位为px，该参数为整数。 | -| height | number | 是 | 是 | 矩形区域的高度，单位为px，该参数为整数。 | +| left | number | 否 | 否 | 矩形区域的左边界，单位为px，该参数为整数。 | +| top | number | 否 | 否 | 矩形区域的上边界，单位为px，该参数为整数。 | +| width | number | 否 | 否 | 矩形区域的宽度，单位为px，该参数为整数。 | +| height | number | 否 | 否 | 矩形区域的高度，单位为px，该参数为整数。 | ## WaterfallDisplayAreaRects9+ @@ -141,7 +141,7 @@ import { display } from '@kit.ArkUI'; **系统能力：** SystemCapability.WindowManager.WindowManager.Core -| 名称 | 类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 只读 | 可选 | 说明 | | ------ | ------------- | ---- | ---- | ------------------ | | left | [Rect](#rect9) | 是 | 否 | 瀑布曲面区域的左侧矩形区域。 | | top | [Rect](#rect9) | 是 | 否 | 瀑布曲面区域的顶部矩形区域。 | @@ -156,7 +156,7 @@ import { display } from '@kit.ArkUI'; **系统能力：** SystemCapability.WindowManager.WindowManager.Core -| 名称 | 类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 只读 | 可选 | 说明 | | --------------------------- | ------------- | ---- | ---- | ------------------ | | boundingRects | Array\<[Rect](#rect9)> | 是 | 否 | 挖孔、刘海等区域的边界矩形。如果没有挖孔、刘海等区域，数组返回为空。 | | waterfallDisplayAreaRects | [WaterfallDisplayAreaRects](#waterfalldisplayarearects9) | 是 | 否 | 瀑布屏曲面部分显示区域。 | @@ -250,7 +250,7 @@ try { getAllDisplayPhysicalResolution(): Promise<Array<DisplayPhysicalResolution>> -获取当前折叠设备的显示模式以及对应的物理屏幕分辨率信息对象。 +获取当前折叠设备的显示模式以及对应的物理屏幕分辨率信息对象。使用Promise异步回调。 **原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 @@ -295,10 +295,10 @@ getDefaultDisplaySync(): Display 获取当前默认的display对象。 -**系统能力：** SystemCapability.WindowManager.WindowManager.Core - **原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 +**系统能力：** SystemCapability.WindowManager.WindowManager.Core + **返回值：** | 类型 | 说明 | @@ -332,10 +332,10 @@ getPrimaryDisplaySync(): Display 获取主屏信息。除2in1之外的设备获取的是设备自带屏幕的Display对象；2in1设备外接屏幕时获取的是当前主屏幕的Display对象；2in1设备没有外接屏幕时获取的是自带屏幕的Display对象。 -**系统能力：** SystemCapability.WindowManager.WindowManager.Core - **原子化服务API：** 从API version 14开始，该接口支持在原子化服务中使用。 +**系统能力：** SystemCapability.WindowManager.WindowManager.Core + **返回值：** | 类型 | 说明 | @@ -1348,8 +1348,6 @@ display.makeUnique(screenId).then(() => { ### 属性 -**系统能力：** SystemCapability.WindowManager.WindowManager.Core - | 名称 | 类型 | 只读 | 可选 | 说明 | | -------- | -------- | -------- | -------- |---------------------------------------------------------------------------------------------------------------| | id | number | 是 | 否 | 显示设备的id号，该参数为大于等于0的整数。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core
**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | @@ -1370,7 +1368,7 @@ display.makeUnique(screenId).then(() => { | hdrFormats11+ | Array<[hdrCapability.HDRFormat](../apis-arkgraphics2d/js-apis-hdrCapability.md)> | 是 | 否 | 显示设备支持的所有HDR格式。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core
**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | | availableWidth12+ | number | 是 | 否 | 2in1设备上屏幕的可用区域宽度，单位为px，该参数为大于0的整数。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core
**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | | availableHeight12+ | number | 是 | 否 | 2in1设备上屏幕的可用区域高度，单位为px，该参数为大于0的整数。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core
**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | -| screenShape18+ | [ScreenShape](#screenshape18) | 是 | 是 | 显示设备的屏幕形状，默认值为RECTANGLE。
**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。 | +| screenShape18+ | [ScreenShape](#screenshape18) | 是 | 是 | 显示设备的屏幕形状，默认值为RECTANGLE。
**系统能力：** SystemCapability.WindowManager.WindowManager.Core
**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。 | | sourceMode19+ | [DisplaySourceMode](#displaysourcemode19) | 是 | 是 | 屏幕显示内容的显示模式枚举。
**系统能力：** SystemCapability.Window.SessionManager
**原子化服务API：** 从API version 19开始，该接口支持在原子化服务中使用。 | | x19+ | number | 是 | 是 | 屏幕左上角相对于原点的x轴坐标，原点为主屏左上角，单位为px，该参数为整数。仅DisplaySourceMode为MAIN和EXTEND时返回。
**系统能力：** SystemCapability.Window.SessionManager
**原子化服务API：** 从API version 19开始，该接口支持在原子化服务中使用。 | | y19+ | number | 是 | 是 | 屏幕左上角相对于原点的y轴坐标，原点为主屏左上角，单位为px，该参数为整数。仅DisplaySourceMode为MAIN和EXTEND时返回。
**系统能力：** SystemCapability.Window.SessionManager
**原子化服务API：** 从API version 19开始，该接口支持在原子化服务中使用。 | diff --git a/zh-cn/application-dev/reference/apis-arkui/js-apis-screenshot.md b/zh-cn/application-dev/reference/apis-arkui/js-apis-screenshot.md index 25c1527d426ccc2dd6b97f59a223c3b27fc7c04c..27c4d267a016f05fac706044beef04d2882d7cb3 100644 --- a/zh-cn/application-dev/reference/apis-arkui/js-apis-screenshot.md +++ b/zh-cn/application-dev/reference/apis-arkui/js-apis-screenshot.md @@ -20,12 +20,12 @@ import { screenshot } from '@kit.ArkUI'; **系统能力：** SystemCapability.WindowManager.WindowManager.Core -| 名称 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------------------------------------------------------------ | -| left | number | 是 | 表示截取图像区域的左边界，单位为px，该参数应为整数。 | -| top | number | 是 | 表示截取图像区域的上边界，单位为px，该参数应为整数。 | -| width | number | 是 | 表示截取图像区域的宽度，单位为px，该参数应为整数。 | -| height | number | 是 | 表示截取图像区域的高度，单位为px，该参数应为整数。 | +| 名称 | 类型 | 只读 | 可选 | 说明 | +| ------ | ------ | ---- | ---- | ------------------------------------------------------------ | +| left | number | 否 | 否 | 表示截取图像区域的左边界，单位为px，该参数应为整数。 | +| top | number | 否 | 否 | 表示截取图像区域的上边界，单位为px，该参数应为整数。 | +| width | number | 否 | 否 | 表示截取图像区域的宽度，单位为px，该参数应为整数。 | +| height | number | 否 | 否 | 表示截取图像区域的高度，单位为px，该参数应为整数。 | ## CaptureOption14+ @@ -35,9 +35,9 @@ import { screenshot } from '@kit.ArkUI'; **系统能力：** SystemCapability.WindowManager.WindowManager.Core -| 名称 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------------------------------------------------------------ | -| displayId | number | 否 | 表示截取图像的显示设备[Display](js-apis-display.md#display)的ID号，默认为0，该参数应为大于或等于0的整数，非整数会报参数错误。 | +| 名称 | 类型 | 只读 | 可选 | 说明 | +| ------ | ------ | ---- | ---- | ------------------------------------------------------------ | +| displayId | number | 否 | 是 | 表示截取图像的显示设备[Display](js-apis-display.md#display)的ID号，默认为0，该参数应为大于或等于0的整数，非整数会报参数错误。 | ## PickInfo @@ -47,16 +47,16 @@ import { screenshot } from '@kit.ArkUI'; **系统能力：** SystemCapability.WindowManager.WindowManager.Core -| 名称 | 类型 | 必填 | 说明 | -| -------------------- | ------------- | ---- | ------------------------------------------------------------ | -| pickRect | [Rect](#rect) | 是 | 表示截取图像的区域。 | -| pixelMap | [image.PixelMap](../apis-image-kit/js-apis-image.md#pixelmap7) | 是 | 表示截取的图像PixelMap对象。 | +| 名称 | 类型 | 只读 | 可选 | 说明 | +| -------------------- | ------------- | ---- | ---- | ------------------------------------------------------------ | +| pickRect | [Rect](#rect) | 否 | 否 | 表示截取图像的区域。 | +| pixelMap | [image.PixelMap](../apis-image-kit/js-apis-image.md#pixelmap7) | 否 | 否 | 表示截取的图像PixelMap对象。 | ## screenshot.pick pick(): Promise<PickInfo> -获取屏幕截图。此接口仅可在2in1设备上使用。当前仅支持获取displayId为0的屏幕截图。 +获取屏幕截图。此接口仅可在2in1设备上使用。当前仅支持获取displayId为0的屏幕截图。使用Promise异步回调。 **原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 @@ -89,10 +89,10 @@ try { console.log('pick Rect: ' + pickInfo.pickRect); pickInfo.pixelMap.release(); // PixelMap使用完后及时释放内存 }).catch((err: BusinessError) => { - console.log('Failed to pick. Code: ' + JSON.stringify(err)); + console.log(`Failed to pick. Code: ' + Code: ${err.code}, message: ${err.message}`); }); } catch (exception) { - console.error('Failed to pick Code: ' + JSON.stringify(exception)); + console.error(`Failed to pick Code: ' + Code: ${exception.code}, message: ${exception.message}`); }; ``` @@ -100,7 +100,7 @@ try { capture(options?: CaptureOption): Promise<image.PixelMap> -获取屏幕全屏截图，此接口仅支持在平板和2in1设备上使用。 +获取屏幕全屏截图，此接口仅支持在平板和2in1设备上使用。使用Promise异步回调。 此接口可以通过设置不同的displayId截取不同屏幕的截图，且只能截取全屏；[pick](#screenshotpick)接口可实现区域截屏。 **原子化服务API：** 从API version 14开始，该接口支持在原子化服务中使用。 @@ -147,8 +147,8 @@ try { console.log('Succeeded in saving screenshot. Pixel bytes number: ' + pixelMap.getPixelBytesNumber()); pixelMap.release(); // PixelMap使用完后及时释放内存 }).catch((err: BusinessError) => { - console.log('Failed to save screenshot. Code: ' + JSON.stringify(err)); + console.error(`Failed to save screenshot. Code: ${err.code}, message: ${err.message}`); }); } catch (exception) { - console.error('Failed to save screenshot. Code: ' + JSON.stringify(exception)); + console.error(`Failed to save screenshot. Code: ${exception.code}, message: ${exception.message}`); }; \ No newline at end of file