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 22e041d0a45217c562d4c421d82b9a721f0cfcce..f8eb4826175cd2e1caba1f2a0f89878d8163864e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-display.md +++ b/zh-cn/application-dev/reference/apis/js-apis-display.md @@ -28,29 +28,42 @@ import display from '@ohos.display'; | STATE_VR | 5 | 表示显示设备为VR模式。| | STATE_ON_SUSPEND | 6 | 表示显示设备为开启状态,CPU为挂起状态。 | +## Rect9+ -## Display +矩形区域。 + +**系统能力:** SystemCapability.WindowManager.WindowManager.Core + +| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| ------ | -------- | ---- | ---- | ------------------ | +| left | number | 是 | 是 | 矩形区域的左边界。 | +| top | number | 是 | 是 | 矩形区域的上边界。 | +| width | number | 是 | 是 | 矩形区域的宽度。 | +| height | number | 是 | 是 | 矩形区域的高度。 | -描述display对象的属性。 +## WaterfallDisplayAreaRects9+ + +瀑布屏曲面部分显示区域。 **系统能力:** 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方向中每英寸屏幕的确切物理像素值。| +| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| ------ | ------------- | ---- | ---- | ------------------ | +| left | [Rect](#rect9) | 是 | 否 | 瀑布曲面区域的左侧矩形区域。 | +| top | [Rect](#rect9) | 是 | 否 | 瀑布曲面区域的顶部矩形区域。 | +| right | [Rect](#rect9) | 是 | 否 | 瀑布曲面区域的右侧矩形区域。 | +| bottom | [Rect](#rect9) | 是 | 否 | 瀑布曲面区域的底部矩形区域。 | + +## CutoutInfo9+ + +挖孔屏、刘海屏、瀑布屏等不可用屏幕区域信息。 + +**系统能力:** SystemCapability.WindowManager.WindowManager.Core +| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| --------------------------- | ------------- | ---- | ---- | ------------------ | +| boudingRects | Array\<[Rect](#rect9)> | 是 | 否 | 挖孔、刘海等区域的边界矩形。 | +| waterfallDisplayAreaRects | [WaterfallDisplayAreaRects](#waterfalldisplayarearects9) | 是 | 否 | 瀑布屏曲面部分显示区域。 | ## display.getDefaultDisplay @@ -252,3 +265,67 @@ 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方向中每英寸屏幕的确切物理像素值。| + +### getCutoutInfo9+ +getCutoutInfo(callback: AsyncCallback<CutoutInfo>): void + +获取挖孔屏、刘海屏、瀑布屏等不可用屏幕区域信息。使用callback异步回调。 + +**系统能力:** SystemCapability.WindowManager.WindowManager.Core + +| 参数名 | 类型 | 必填 | 说明 | +| ----------- | --------------------------- | ---- | ------------------------------------------------------------ | +| callback | AsyncCallback<[CutoutInfo](#cutoutinfo9)> | 是 | 回调函数。当获取信息成功,err为undefined,data为获取到的CutoutInfo对象;否则err为错误对象。 | + +**示例:** +```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> + +获取挖孔屏、刘海屏、瀑布屏等不可用屏幕区域信息。使用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