未验证 提交 c8c2607d 编写于 作者: O openharmony_ci 提交者: Gitee

!2380 Done! 2206 syscap按最新要求添加/修改

Merge pull request !2380 from wusongqing/TR2206
...@@ -14,36 +14,40 @@ import display from '@ohos.display'; ...@@ -14,36 +14,40 @@ import display from '@ohos.display';
Provides the state of a display. Provides the state of a display.
**System capability**: SystemCapability.WindowManager.WindowManager.Core
| Name| Default Value| Description| | Name| Default Value| Description|
| -------- | -------- | -------- | | -------- | -------- | -------- |
| STATE_UNKNOWN | 0 | Unknown. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core| | STATE_UNKNOWN | 0 | Unknown.|
| STATE_OFF | 1 | The display is shut down. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core| | STATE_OFF | 1 | The display is shut down.|
| STATE_ON | 2 | The display is powered on. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core| | STATE_ON | 2 | The display is powered on.|
| STATE_DOZE | 3 | The display is in sleep mode. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core| | STATE_DOZE | 3 | The display is in sleep mode.|
| STATE_DOZE_SUSPEND | 4 | The display is in sleep mode, and the CPU is suspended. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core| | STATE_DOZE_SUSPEND | 4 | The display is in sleep mode, and the CPU is suspended.|
| STATE_VR | 5 | The display is in VR mode. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core| | STATE_VR | 5 | The display is in VR mode.|
| STATE_ON_SUSPEND | 6 | The display is powered on, and the CPU is suspended. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core| | STATE_ON_SUSPEND | 6 | The display is powered on, and the CPU is suspended.|
## Display ## Display
Describes the attributes of a display. Describes the attributes of a display.
**System capability**: SystemCapability.WindowManager.WindowManager.Core
| Name| Type| Readable| Writable| Description| | Name| Type| Readable| Writable| Description|
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| id | number | Yes| No| ID of the display. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core| | id | number | Yes| No| ID of the display.|
| name | string | Yes| No| Name of the display. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core| | name | string | Yes| No| Name of the display.|
| alive | boolean | Yes| No| Whether the display is alive. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core| | alive | boolean | Yes| No| Whether the display is alive.|
| state | [DisplayState](#DisplayState) | Yes| No| State of the display. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core| | state | [DisplayState](#DisplayState) | Yes| No| State of the display.|
| refreshRate | number | Yes| No| Refresh rate of the display. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core| | refreshRate | number | Yes| No| Refresh rate of the display.|
| rotation | number | Yes| No| Screen rotation angle of the display. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core| | rotation | number | Yes| No| Screen rotation angle of the display.|
| width | number | Yes| No| Width of the display, in pixels. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core| | width | number | Yes| No| Width of the display, in pixels.|
| height | number | Yes| No| Height of the display, in pixels. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core| | height | number | Yes| No| Height of the display, in pixels.|
| densityDPI | number | Yes| No| Screen density of the display, in DPI. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core| | densityDPI | number | Yes| No| Screen density of the display, in DPI.|
| densityPixels | number | Yes| No| Screen density of the display, in pixels. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core| | densityPixels | number | Yes| No| Screen density of the display, in pixels.|
| scaledDensity | number | Yes| No| Scaling factor for fonts displayed on the display. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core| | scaledDensity | number | Yes| No| Scaling factor for fonts displayed on the display.|
| xDPI | number | Yes| No| Exact physical dots per inch of the screen in the horizontal direction. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core| | xDPI | number | Yes| No| Exact physical dots per inch of the screen in the horizontal direction.|
| yDPI | number | Yes| No| Exact physical dots per inch of the screen in the vertical direction. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core| | yDPI | number | Yes| No| Exact physical dots per inch of the screen in the vertical direction.|
## display.getDefaultDisplay ## display.getDefaultDisplay
...@@ -82,7 +86,7 @@ Obtains the default display object. ...@@ -82,7 +86,7 @@ Obtains the default display object.
- Return value - Return value
| Type| Description| | Type | Description |
| ---------------------------------- | ---------------------------------------------- | | ---------------------------------- | ---------------------------------------------- |
| Promise&lt;[Display](#Display)&gt; | Promise used to return the default display object.| | Promise&lt;[Display](#Display)&gt; | Promise used to return the default display object.|
...@@ -107,9 +111,9 @@ Obtains all the display objects. ...@@ -107,9 +111,9 @@ Obtains all the display objects.
- Parameters - Parameters
| Name| Type| Mandatory| Description| | Name | Type | Mandatory| Description |
| -------- | ---------------------------------------------------- | ---- | ------------------------------- | | -------- | ---------------------------------------------------- | ---- | ------------------------------- |
| callback | AsyncCallback&lt;Array&lt;[Display](Display)&gt;&gt; | Yes| Callback used to return all the display objects.| | callback | AsyncCallback&lt;Array&lt;[Display](Display)&gt;&gt; | Yes | Callback used to return all the display objects.|
- Example - Example
...@@ -133,7 +137,7 @@ Obtains all the display objects. ...@@ -133,7 +137,7 @@ Obtains all the display objects.
- Return value - Return value
| Type| Description| | Type | Description |
| ----------------------------------------------- | ------------------------------------------------------- | | ----------------------------------------------- | ------------------------------------------------------- |
| Promise&lt;Array&lt;[Display](#Display)&gt;&gt; | Promise used to return an array containing all the display objects.| | Promise&lt;Array&lt;[Display](#Display)&gt;&gt; | Promise used to return an array containing all the display objects.|
...@@ -159,7 +163,7 @@ Enables listening. ...@@ -159,7 +163,7 @@ Enables listening.
- Parameters - Parameters
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes| Listening type. The available values are as follows: <br/>-&nbsp;**add**: listening for whether a display is added <br/>-&nbsp;**remove**: listening for whether a display is removed <br/>-&nbsp;**change**: listening for whether a display is changed| | type | string | Yes| Listening type. The available values are as follows:<br>-&nbsp;**add**: listening for whether a display is added<br>-&nbsp;**remove**: listening for whether a display is removed<br>-&nbsp;**change**: listening for whether a display is changed|
| callback | Callback&lt;number&gt; | Yes| Callback used to return the ID of the display.| | callback | Callback&lt;number&gt; | Yes| Callback used to return the ID of the display.|
- Example - Example
...@@ -183,7 +187,7 @@ Disables listening. ...@@ -183,7 +187,7 @@ Disables listening.
- Parameters - Parameters
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | Yes| Listening type. The available values are as follows: <br/>-&nbsp;**add**: listening for whether a display is added <br/>-&nbsp;**remove**: listening for whether a display is removed <br/>-&nbsp;**change**: listening for whether a display is changed| | type | string | Yes| Listening type. The available values are as follows:<br>-&nbsp;**add**: listening for whether a display is added<br>-&nbsp;**remove**: listening for whether a display is removed<br>-&nbsp;**change**: listening for whether a display is changed|
| callback | Callback&lt;number&gt; | No| Callback used to return the ID of the display.| | callback | Callback&lt;number&gt; | No| Callback used to return the ID of the display.|
- Example - Example
......
...@@ -13,33 +13,40 @@ import screenshot from '@ohos.screenshot'; ...@@ -13,33 +13,40 @@ import screenshot from '@ohos.screenshot';
Describes screenshot options. Describes screenshot options.
| Name| Type| Mandatory| Description| **System capability**: SystemCapability.WindowManager.WindowManager.Core
| Name | Type | Mandatory| Description |
| ---------- | ------------- | ---- | ------------------------------------------------------------ | | ---------- | ------------- | ---- | ------------------------------------------------------------ |
| screenRect | [Rect](#Rect) | No| Region of the screen to capture. If this parameter is null, the full screen will be captured. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core| | screenRect | [Rect](#Rect) | No | Region of the screen to capture. If this parameter is null, the full screen will be captured.|
| imageSize | [Size](#Size) | No| Size of the screen region to capture. If this parameter is null, the full screen will be captured. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core| | imageSize | [Size](#Size) | No | Size of the screen region to capture. If this parameter is null, the full screen will be captured.|
| rotation | number | No| Rotation angle of the screenshot. The value can be **0**, **90**, **180**, or **270**. The default value is **0**. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core| | rotation | number | No | Rotation angle of the screenshot. Currently, the value can be **0** only. The default value is **0**.|
## Rect ## Rect
Describes the region of the screen to capture. Describes the region of the screen to capture.
| Name| Type| Mandatory| Description| **System capability**: SystemCapability.WindowManager.WindowManager.Core
| Name| Type | Mandatory| Description |
| ------ | ------ | ---- | ------------------------------------------------------------ | | ------ | ------ | ---- | ------------------------------------------------------------ |
| left | number | Yes| Left boundary of the screen region to capture. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core| | left | number | Yes | Left boundary of the screen region to capture.|
| top | number | Yes| Top boundary of the screen region to capture. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core| | top | number | Yes | Top boundary of the screen region to capture.|
| width | number | Yes| Width of the screen region to capture. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core| | width | number | Yes | Width of the screen region to capture.|
| height | number | Yes| Height of the screen region to capture. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core| | height | number | Yes | Height of the screen region to capture.|
## Size ## Size
Describes the size of the screen region to capture. Describes the size of the screen region to capture.
| Name| Type| Mandatory| Description| **System capability**: SystemCapability.WindowManager.WindowManager.Core
| Name| Type | Mandatory| Description |
| ------ | ------ | ---- | ------------------------------------------------------------ | | ------ | ------ | ---- | ------------------------------------------------------------ |
| width | number | Yes| Width of the screen region to capture. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core| | width | number | Yes | Width of the screen region to capture.|
| height | number | Yes| Height of the screen region to capture. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core| | height | number | Yes | Height of the screen region to capture.|
## screenshot.save ## screenshot.save
...@@ -53,10 +60,10 @@ Takes a screenshot and saves it as a **PixelMap** object. This method uses a cal ...@@ -53,10 +60,10 @@ Takes a screenshot and saves it as a **PixelMap** object. This method uses a cal
- Parameters - Parameters
| Name| Type| Mandatory| Description| | Name | Type | Mandatory| Description |
| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [ScreenshotOptions](#ScreenshotOptions) | No| Screenshot options, which consist of **screenRect**, **imageSize**, and **rotation**. You need to set these parameters.| | options | [ScreenshotOptions](#ScreenshotOptions) | No | Screenshot options, which consist of **screenRect**, **imageSize**, and **rotation**. You need to set these parameters.|
| callback | AsyncCallback&lt;image.PixelMap&gt; | Yes| Callback used to return a **PixelMap** object.| | callback | AsyncCallback&lt;image.PixelMap&gt; | Yes | Callback used to return a **PixelMap** object. |
- Example - Example
...@@ -93,13 +100,13 @@ Takes a screenshot and saves it as a **PixelMap** object. This method uses a pro ...@@ -93,13 +100,13 @@ Takes a screenshot and saves it as a **PixelMap** object. This method uses a pro
- Parameters - Parameters
| Name| Type| Mandatory| Description| | Name | Type | Mandatory| Description |
| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ | | ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [ScreenshotOptions](#ScreenshotOptions) | No| Screenshot options, which consist of **screenRect**, **imageSize**, and **rotation**. You need to set these parameters.| | options | [ScreenshotOptions](#ScreenshotOptions) | No | Screenshot options, which consist of **screenRect**, **imageSize**, and **rotation**. You need to set these parameters.|
- Return value - Return value
| Type| Description| | Type | Description |
| ----------------------------- | ----------------------------------------------- | | ----------------------------- | ----------------------------------------------- |
| Promise&lt;image.PixelMap&gt; | Promise used to return an **image.PixelMap** object.| | Promise&lt;image.PixelMap&gt; | Promise used to return an **image.PixelMap** object.|
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册