updated docs

Signed-off-by: N wusongqing <wusongqing@huawei.com>

updated docs
Signed-off-by: N wusongqing <wusongqing@huawei.com>
be6644cd · wusongqing · 8d5fb164 · be6644cd
隐藏空白更改
内联并排

Showing with 86 addition and 34 deletion

en/application-dev/reference/apis/js-apis-display.md en/application-dev/reference/apis/js-apis-display.md +86 -34

未找到文件。
--- a/en/application-dev/reference/apis/js-apis-display.md
+++ b/en/application-dev/reference/apis/js-apis-display.md
 # Display

-> ![icon-note.gif](public_sys-resources/icon-note.gif) **Note:**
+> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**
 > The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.

-
 ## Modules to Import

 ```
@@ -11,24 +10,19 @@ import display from '@ohos.display';
 ```


-## Required Permissions
-
-None
-
-
 ## DisplayState

 Provides the state of a display.

 | Name| Default Value| Description|
 | -------- | -------- | -------- |
-| STATE_UNKNOWN | 0 | Unknown.|
-| STATE_OFF | 1 | The display is shut down.|
-| STATE_ON | 2 | The display is powered on.|
-| STATE_DOZE | 3 | The display is in sleep mode.|
-| STATE_DOZE_SUSPEND | 4 | The display is in sleep mode, and the CPU is suspended.|
-| STATE_VR | 5 | The display is in VR mode.|
-| STATE_ON_SUSPEND | 6 | The display is powered on, and the CPU is suspended.|
+| STATE_UNKNOWN | 0 | Unknown. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core|
+| STATE_OFF | 1 | The display is shut down. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core|
+| STATE_ON | 2 | The display is powered on. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core|
+| STATE_DOZE | 3 | The display is in sleep mode. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core|
+| STATE_DOZE_SUSPEND | 4 | The display is in sleep mode, and the CPU is suspended. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core|
+| STATE_VR | 5 | The display is in VR mode. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core|
+| STATE_ON_SUSPEND | 6 | The display is powered on, and the CPU is suspended. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core|


 ## Display
@@ -37,31 +31,33 @@ Describes the attributes of a display.

 | Name| Type| Readable| Writable| Description|
 | -------- | -------- | -------- | -------- | -------- |
-| id | number | Yes| No| ID of the display.|
-| name | string | Yes| No| Name of the display.|
-| alive | boolean | Yes| No| Whether the display is alive.|
-| state | [DisplayState](#displaystate) | Yes| No| State of the display.|
-| refreshRate | number | Yes| No| Refresh rate of the display.|
-| rotation | number | Yes| No| Screen rotation angle of the display.|
-| width | number | Yes| No| Width of the display, in pixels.|
-| height | number | Yes| No| Height of the display, in pixels.|
-| densityDPI | number | Yes| No| Screen density of the display, in DPI.|
-| densityPixels | number | Yes| No| Screen density of the display, in pixels.|
-| 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.|
-| yDPI | number | Yes| No| Exact physical dots per inch of the screen in the vertical direction.|
+| id | number | Yes| No| ID of the display. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core|
+| name | string | Yes| No| Name of the display. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core|
+| alive | boolean | Yes| No| Whether the display is alive. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core|
+| state | [DisplayState](#DisplayState) | Yes| No| State of the display. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core|
+| refreshRate | number | Yes| No| Refresh rate of the display. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core|
+| rotation | number | Yes| No| Screen rotation angle of the display. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core|
+| width | number | Yes| No| Width of the display, in pixels. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core|
+| height | number | Yes| No| Height of the display, in pixels. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core|
+| densityDPI | number | Yes| No| Screen density of the display, in DPI. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core|
+| densityPixels | number | Yes| No| Screen density of the display, in pixels. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core|
+| scaledDensity | number | Yes| No| Scaling factor for fonts displayed on the display. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core|
+| xDPI | number | Yes| No| Exact physical dots per inch of the screen in the horizontal direction. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core|
+| yDPI | number | Yes| No| Exact physical dots per inch of the screen in the vertical direction. <br/>**System capabilities**: SystemCapability.WindowManager.WindowManager.Core|


 ## display.getDefaultDisplay

-getDefaultDisplay(callback: AsyncCallback&lt;Display&gt;): void;
+getDefaultDisplay(callback: AsyncCallback&lt;Display&gt;): void

 Obtains the default display object.

+**System capabilities**: SystemCapability.WindowManager.WindowManager.Core
+
 - Parameters
  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
-  | callback | AsyncCallback&lt;[Display](#display)&gt; | Yes| Callback used to return the attributes of the default display.|
+  | callback | AsyncCallback&lt;[Display](#Display)&gt; | Yes| Callback used to return the default display object.|

 - Example
  ```
@@ -76,19 +72,47 @@ Obtains the default display object.
  });
  ```

+## display.getDefaultDisplay
+
+getDefaultDisplay(): Promise&lt;Display&gt;
+
+Obtains the default display object.
+
+**System capabilities**: SystemCapability.WindowManager.WindowManager.Core
+
+- Return value
+
+  | Type| Description|
+  | ---------------------------------- | ---------------------------------------------- |
+  | Promise&lt;[Display](#Display)&gt; | Promise used to return the default display object.|
+
+- Example
+
+  ```
+  let promise = display.getDefaultDisplay();
+  promise.then(() => {
+      console.log('getDefaultDisplay success');
+  }).catch((err) => {
+      console.log('getDefaultDisplay fail: ' + JSON.stringify(err));
+  });
+  ```

 ## display.getAllDisplay

-getAllDisplay(callback: AsyncCallback&lt;Array&lt;Display&gt;&gt;): void;
+getAllDisplay(callback: AsyncCallback&lt;Array&lt;Display&gt;&gt;): void

 Obtains all the display objects.

+**System capabilities**: SystemCapability.WindowManager.WindowManager.Core
+
 - Parameters
+
  | Name| Type| Mandatory| Description|
-  | -------- | -------- | -------- | -------- |
-  | callback | AsyncCallback&lt;Array&lt;[Display](#display)&gt;&gt; | Yes| Callback used to return the attributes of all displays.|
+  | -------- | ---------------------------------------------------- | ---- | ------------------------------- |
+  | callback | AsyncCallback&lt;Array&lt;[Display](Display)&gt;&gt; | Yes| Callback used to return all the display objects.|

 - Example
+
  ```
  display.getAllDisplay((err, data) => {
      if (err) {
@@ -99,13 +123,39 @@ Obtains all the display objects.
  });
  ```

+## display.getAllDisplay
+
+getAllDisplay(): Promise&lt;Array&lt;Display&gt;&gt;
+
+Obtains all the display objects.
+
+**System capabilities**: SystemCapability.WindowManager.WindowManager.Core
+
+- Return value
+
+  | Type| Description|
+  | ----------------------------------------------- | ------------------------------------------------------- |
+  | Promise&lt;Array&lt;[Display](#Display)&gt;&gt; | Promise used to return an array containing all the display objects.|
+
+- Example
+
+  ```
+  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&lt;number&gt;): void;
+on(type: 'add'|'remove'|'change', callback: Callback&lt;number&gt;): void

 Enables listening.

+**System capabilities**: SystemCapability.WindowManager.WindowManager.Core
+
 - Parameters
  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
@@ -124,10 +174,12 @@ Enables listening.

 ## display.off('add'|'remove'|'change')

-off(type: 'add'|'remove'|'change', callback?: Callback&lt;number&gt;): void;
+off(type: 'add'|'remove'|'change', callback?: Callback&lt;number&gt;): void

 Disables listening.

+**System capabilities**: SystemCapability.WindowManager.WindowManager.Core
+
 - Parameters
  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |