From dae4d43975f86173c00d2a11bd5f5aa37fc11486 Mon Sep 17 00:00:00 2001 From: xpeng Date: Wed, 3 Aug 2022 15:40:36 +0800 Subject: [PATCH] add doc for getting cutout info Signed-off-by: xpeng Change-Id: Ib1d4eb2d7cd2008545286db095dda6ff4db930d9 --- .../reference/apis/js-apis-display.md | 157 +++++++++++++----- 1 file changed, 117 insertions(+), 40 deletions(-) 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 22e041d0a4..1ac535aa0a 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-display.md +++ b/zh-cn/application-dev/reference/apis/js-apis-display.md @@ -12,46 +12,6 @@ import display from '@ohos.display'; ``` -## DisplayState - -显示设备的状态枚举。 - -**系统能力：** SystemCapability.WindowManager.WindowManager.Core - -| 名称 | 值 | 说明 | -| -------- | -------- | -------- | -| STATE_UNKNOWN | 0 | 表示显示设备状态未知。| -| STATE_OFF | 1 | 表示显示设备状态为关闭。 | -| STATE_ON | 2 | 表示显示设备状态为开启。| -| STATE_DOZE | 3 | 表示显示设备为低电耗模式。| -| STATE_DOZE_SUSPEND | 4 | 表示显示设备为睡眠模式，CPU为挂起状态。 | -| STATE_VR | 5 | 表示显示设备为VR模式。| -| STATE_ON_SUSPEND | 6 | 表示显示设备为开启状态，CPU为挂起状态。 | - - -## Display - -描述display对象的属性。 - -**系统能力：** SystemCapability.WindowManager.WindowManager.Core - -| 名称 | 参数类型 | 可读 | 可写 | 说明 | -| -------- | -------- | -------- | -------- | -------- | -| id | number | 是 | 否 | 显示设备的id号。| -| name | string | 是 | 否 | 显示设备的名称。| -| alive | boolean | 是 | 否 | 显示设备是否启用。| -| state | [DisplayState](#displaystate) | 是 | 否 | 显示设备的状态。| -| refreshRate | number | 是 | 否 | 显示设备的刷新率。| -| rotation | number | 是 | 否 | 显示设备的屏幕旋转角度。| -| width | number | 是 | 否 | 显示设备的宽度，单位为像素。| -| height | number | 是 | 否 | 显示设备的高度，单位为像素。| -| densityDPI | number | 是 | 否 | 显示设备的屏幕密度，单位为DPI。| -| densityPixels | number | 是 | 否 | 显示设备的屏幕密度，单位为像素。| -| scaledDensity | number | 是 | 否 | 显示设备的显示字体的缩放因子。| -| xDPI | number | 是 | 否 | x方向中每英寸屏幕的确切物理像素值。 | -| yDPI | number | 是 | 否 | y方向中每英寸屏幕的确切物理像素值。| - - ## display.getDefaultDisplay getDefaultDisplay(callback: AsyncCallback<Display>): void @@ -252,3 +212,120 @@ off(type: 'add'|'remove'|'change', callback?: Callback<number>): void display.off("remove"); ``` + +## Display +屏幕实例。描述display对象的属性和方法。 + +下列API示例中都需先使用[getAllDisplay()](#displaygetalldisplay)、[getDefaultDisplay()](#displaygetdefaultdisplay)、[getDefaultDisplaySync()](#displaygetdefaultdisplaysync)中的任一方法获取到Display实例，再通过此实例调用对应方法。 + +**系统能力：** SystemCapability.WindowManager.WindowManager.Core + +| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| -------- | -------- | -------- | -------- | -------- | +| id | number | 是 | 否 | 显示设备的id号。| +| name | string | 是 | 否 | 显示设备的名称。| +| alive | boolean | 是 | 否 | 显示设备是否启用。| +| state | [DisplayState](#displaystate) | 是 | 否 | 显示设备的状态。| +| refreshRate | number | 是 | 否 | 显示设备的刷新率。| +| rotation | number | 是 | 否 | 显示设备的屏幕旋转角度。| +| width | number | 是 | 否 | 显示设备的宽度，单位为像素。| +| height | number | 是 | 否 | 显示设备的高度，单位为像素。| +| densityDPI | number | 是 | 否 | 显示设备的屏幕密度，单位为DPI。| +| densityPixels | number | 是 | 否 | 显示设备的屏幕密度，单位为像素。| +| scaledDensity | number | 是 | 否 | 显示设备的显示字体的缩放因子。| +| xDPI | number | 是 | 否 | x方向中每英寸屏幕的确切物理像素值。 | +| yDPI | number | 是 | 否 | y方向中每英寸屏幕的确切物理像素值。| + +### DisplayState + +显示设备的状态枚举。 + +**系统能力：** SystemCapability.WindowManager.WindowManager.Core + +| 名称 | 值 | 说明 | +| -------- | -------- | -------- | +| STATE_UNKNOWN | 0 | 表示显示设备状态未知。| +| STATE_OFF | 1 | 表示显示设备状态为关闭。 | +| STATE_ON | 2 | 表示显示设备状态为开启。| +| STATE_DOZE | 3 | 表示显示设备为低电耗模式。| +| STATE_DOZE_SUSPEND | 4 | 表示显示设备为睡眠模式，CPU为挂起状态。 | +| STATE_VR | 5 | 表示显示设备为VR模式。| +| STATE_ON_SUSPEND | 6 | 表示显示设备为开启状态，CPU为挂起状态。 | + +### Rect9+ + +矩形区域。 + +**系统能力：** SystemCapability.WindowManager.WindowManager.Core + +| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| ------ | -------- | ---- | ---- | ------------------ | +| left | number | 是 | 是 | 矩形区域的左边界。 | +| top | number | 是 | 是 | 矩形区域的上边界。 | +| width | number | 是 | 是 | 矩形区域的宽度。 | +| height | number | 是 | 是 | 矩形区域的高度。 | + +### WaterfallDisplayAreaRects9+ + +瀑布屏曲面部分显示区域。 + +**系统能力：** SystemCapability.WindowManager.WindowManager.Core + +| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| ------ | ------------- | ---- | ---- | ------------------ | +| left | [Rect](#rect9) | 是 | 否 | 瀑布区域的左侧矩形区域。 | +| top | [Rect](#rect9) | 是 | 否 | 瀑布区域的顶部矩形区域。 | +| width | [Rect](#rect9) | 是 | 否 | 瀑布区域的右侧矩形区域。 | +| height | [Rect](#rect9) | 是 | 否 | 瀑布区域的底部矩形区域。 | + +### CutoutInfo9+ + +不可用屏幕区域信息。 + +**系统能力：** SystemCapability.WindowManager.WindowManager.Core + +| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| --------------------------- | ------------- | ---- | ---- | ------------------ | +| boudingRects | Array\<[Rect](#rect9)> | 是 | 否 | 挖孔区域的边界矩形。 | +| waterfallDisplayAreaRects | [WaterfallDisplayAreaRects](#waterfallDisplayAreaRects9) | 是 | 否 | 瀑布屏曲面部分显示区域。 | + +### getCutoutInfo9+ +getCutoutInfo(callback: AsyncCallback<[CutoutInfo](#cutoutinfo9)>): void + +获取挖孔屏、刘海屏、瀑布屏等不可用屏幕区域信息。使用callback异步回调。 + +**系统能力：** SystemCapability.WindowManager.WindowManager.Core + +| 参数名 | 类型 | 必填 | 说明 | +| ----------- | --------------------------- | ---- | ------------------------------------------------------------ | +| callback | AsyncCallback<[CutoutInfo](#cutoutinfo9)> | 是 | 回调函数。当获取信息成功，err为undefined，data为获取到的CutoutInfo对象；否则为错误对象。 | + +**示例：** +```js +displayClass.getCutoutInfo((err, data) => { + if (err.code) { + console.error('Failed to get cutoutInfo. Cause: ' + JSON.stringify(err)); + return; + } + console.info('Succeeded in getting cutoutInfo. data: ' + JSON.stringify(data)); +}) +``` +### getCutoutInfo9+ +getCutoutInfo(): Promise<[CutoutInfo](#cutoutinfo9)> + +获取挖孔屏、刘海屏、瀑布屏等不可用屏幕区域信息。使用Promise异步回调。 + +**系统能力：** SystemCapability.WindowManager.WindowManager.Core + +**返回值：** +| 类型 | 说明 | +| ------------------- | ------------------------- | +| Promise<[CutoutInfo](#cutoutinfo9)> | Promise对象，返回描述不可用屏幕区域的CutoutInfo对象。 | + +**示例：** +```js +let promise = displayClass.getCutoutInfo(); +promise.then((data) => { + console.info('Succeeded in getting cutoutInfo. Data: ' + JSON.stringify(data)); +}); +``` \ No newline at end of file -- GitLab