!18307 示例代码检查与接口一致性

Merge pull request !18307 from 田雨/master

!18307 示例代码检查与接口一致性
Merge pull request !18307 from 田雨/master
4b4e54c7 · openharmony_ci · Gitee · f264de98 · 8c462a9f · 4b4e54c7
7 changed file
--- a/zh-cn/application-dev/reference/apis/js-apis-arkui-componentSnapshot.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-arkui-componentSnapshot.md
@@ -49,7 +49,7 @@ struct SnapshotExample {
      // ...Components
      Button("click to generate UI snapshot")
        .onClick(() => {
-          componentSnapshot.get("root", (error: BusinessError, pixmap: image.PixelMap) => {
+          componentSnapshot.get("root", (error: Error, pixmap: image.PixelMap) => {
                 this.pixmap = pixmap
                 // save pixmap to file
                 // ....
@@ -85,6 +85,12 @@ get(id: string): Promise<image.PixelMap>
 | ----------------------------- | -------------- |
 | Promise&lt;image.PixelMap&gt; | 截图返回的结果。 |

+**错误码：** 
+
+| 错误码ID | 错误信息            |
+| -------- | ------------------- |
+| 100001   | if id is not valid. |
+
 **示例：**

 ```js
@@ -139,9 +145,10 @@ createFromBuilder(builder: CustomBuilder, callback: AsyncCallback<image.PixelMap

 **示例：**

-```js
+```ts
 import componentSnapshot from '@ohos.arkui.componentSnapshot'
 import image from '@ohos.multimedia.image'
+
 @Entry
 @Component
 struct OffscreenSnapshotExample {
@@ -149,7 +156,7 @@ struct OffscreenSnapshotExample {

  @Builder
  RandomBuilder() {
-    Flex({ direction: FlexDirection.Column, justifyContent: FlexAlign.Center,   alignItems: ItemAlign.Center }) {
+    Flex({ direction: FlexDirection.Column, justifyContent: FlexAlign.Center, alignItems: ItemAlign.Center }) {
      Text('Test menu item 1')
        .fontSize(20)
        .width(100)
@@ -163,16 +170,17 @@ struct OffscreenSnapshotExample {
        .textAlign(TextAlign.Center)
    }.width(100)
  }
+
  build() {
    Column() {
      Button("click to generate offscreen UI snapshot")
-        .onClick(()=> {
-             componentSnapshot.createFromBuilder(this.RandomBuilder.bind(this),
-                        (error: BusinessError, pixmap: image.PixelMap) => {
-                 this.pixmap = pixmap
-                 // save pixmap to file
-                 // ....
-             })
+        .onClick(() => {
+          componentSnapshot.createFromBuilder(this.RandomBuilder.bind(this),
+            (error: Error, pixmap: image.PixelMap) => {
+              this.pixmap = pixmap
+              // save pixmap to file
+              // ....
+            })
        })
    }.width('80%').margin({ left: 10, top: 5, bottom: 5 }).height(200)
    .border({ color: '#880606', width: 2 })
@@ -200,11 +208,18 @@ createFromBuilder(builder: CustomBuilder): Promise<image.PixelMap>
 | ----------------------------- | -------------- |
 | Promise&lt;image.PixelMap&gt; | 截图返回的结果。 |

+**错误码：** 
+
+| 错误码ID | 错误信息                                  |
+| -------- | ----------------------------------------- |
+| 100001   | if builder is not a valid build function. |
+
 **示例：**

-```js
+```ts
 import componentSnapshot from '@ohos.arkui.componentSnapshot'
 import image from '@ohos.multimedia.image'
+
 @Entry
 @Component
 struct OffscreenSnapshotExample {
@@ -212,7 +227,7 @@ struct OffscreenSnapshotExample {

  @Builder
  RandomBuilder() {
-    Flex({ direction: FlexDirection.Column, justifyContent: FlexAlign.Center,   alignItems: ItemAlign.Center }) {
+    Flex({ direction: FlexDirection.Column, justifyContent: FlexAlign.Center, alignItems: ItemAlign.Center }) {
      Text('Test menu item 1')
        .fontSize(20)
        .width(100)
@@ -226,16 +241,17 @@ struct OffscreenSnapshotExample {
        .textAlign(TextAlign.Center)
    }.width(100)
  }
+
  build() {
    Column() {
      Button("click to generate offscreen UI snapshot")
-        .onClick(()=> {
-             componentSnapshot.createFromBuilder(this.RandomBuilder.bind(this))
-             .then((pixmap: image.PixelMap) {
-                 this.pixmap = pixmap
-                 // save pixmap to file
-                 // ....
-             })
+        .onClick(() => {
+          componentSnapshot.createFromBuilder(this.RandomBuilder.bind(this))
+            .then((pixmap: image.PixelMap) => {
+              this.pixmap = pixmap
+              // save pixmap to file
+              // ....
+            })
        })
    }.width('80%').margin({ left: 10, top: 5, bottom: 5 }).height(200)
    .border({ color: '#880606', width: 2 })

--- a/zh-cn/application-dev/reference/apis/js-apis-arkui-drawableDescriptor.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-arkui-drawableDescriptor.md
@@ -32,16 +32,25 @@ constructor()
 当传入资源id或name为包含前景和背景资源的json文件时，生成LayeredDrawableDescriptor对象。

 **示例：**
-```js
+```ts
+// xxx.ets
+import { DrawableDescriptor, LayeredDrawableDescriptor } from '@ohos.arkui.drawableDescriptor'
+
 @Entry
 @Component
 struct Index {
  private resManager = getContext().resourceManager
-  let drawable1 = resManager.getDrawableDescriptor($r('app.media.icon').id)
-  let drawable2 = resManager.getDrawableDescriptorByName(icon)
-  let layeredDrawable1 = resManager.getDrawableDescriptor($r('app.media.file').id)
-  let layeredDrawable1 = resManager.getDrawableDescriptor(file)
- }
+
+  build() {
+    Row() {
+      Column() {
+        Image((<LayeredDrawableDescriptor> (this.resManager.getDrawableDescriptor($r('app.media.icon').id))))
+        Image(((<LayeredDrawableDescriptor> (this.resManager.getDrawableDescriptor($r('app.media.icon')
+          .id))).getForeground()).getPixelMap())
+      }.height('50%')
+    }.width('50%')
+  }
+}
 ```

 ## DrawableDescriptor.getPixelMap
@@ -58,8 +67,8 @@ getPixelMap(): image.PixelMap;
 | [image.PixelMap](../apis/js-apis-image.md#pixelmap7) | PixelMap |

 **示例：**
-  ```js
-  @State pixmap: PixelMap = drawable1.getPixelMap();
+  ```ts
+pixmap: PixelMap = drawable1.getPixelMap();
  ```

 ## LayeredDrawableDescriptor.getPixelMap
@@ -76,8 +85,8 @@ getPixelMap(): image.PixelMap;
 | [image.PixelMap](../apis/js-apis-image.md#pixelmap7) | PixelMap |

 **示例：**
-  ```js
-  @State pixmap: PixelMap = layeredDrawable1.getPixelMap();
+  ```ts
+pixmap: PixelMap = layeredDrawable1.getPixelMap();
  ```

 ## LayeredDrawableDescriptor.getForeground
@@ -94,8 +103,8 @@ getForeground(): DrawableDescriptor;
 | [DrawableDescriptor](#drawabledescriptor) | DrawableDescriptor对象 |

 **示例：**
-  ```js
-  @State drawable: DrawableDescriptor = layeredDrawable1.getForeground();
+  ```ts
+drawable: DrawableDescriptor = layeredDrawable1.getForeground();
  ```

 ## LayeredDrawableDescriptor.getBackground
@@ -112,8 +121,8 @@ getBackground(): DrawableDescriptor;
 | [DrawableDescriptor](#drawabledescriptor) | DrawableDescriptor对象 |

 **示例：**
-  ```js
-  @State drawable: DrawableDescriptor = layeredDrawable1.getBackground();
+  ```ts
+drawable: DrawableDescriptor = layeredDrawable1.getBackground();
  ```

 ## LayeredDrawableDescriptor.getMask
@@ -130,6 +139,6 @@ getMask(): DrawableDescriptor;
 | [DrawableDescriptor](#drawabledescriptor) | DrawableDescriptor对象 |

 **示例：**
-  ```js
-  @State drawable: DrawableDescriptor = layeredDrawable1.getMask();
+  ```ts
+drawable: DrawableDescriptor = layeredDrawable1.getMask();
  ```
--- a/zh-cn/application-dev/reference/apis/js-apis-measure.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-measure.md
@@ -112,7 +112,7 @@ struct Index {

 | 名称           | 类型                                                                                                | 必填 | 说明                      |
 | -------------- | -------------------------------------------------------------------------------------------------- | ---- | ----------------------------------------------- |
-| textContent    | string                                                                                             | 是   | 设置被计算文本内容。                                  |
+| textContent<sup>10+</sup> | string                                                                                             | 是   | 设置被计算文本内容。                                  |
 | constraintWidth<sup>10+</sup> | number&nbsp;\|&nbsp;string&nbsp;\|&nbsp;[Resource](../arkui-ts/ts-types.md#resource)   | 否   | 设置被计算文本布局宽度。<br/>**说明：** 默认单位为vp                               |
 | fontSize       | number&nbsp;\|&nbsp;string&nbsp;\|&nbsp;[Resource](../arkui-ts/ts-types.md#resource)               | 否   | 设置被计算文本字体大小，fontSize为number类型时，使用fp单位。<br/>默认值：16fp。<br/>**说明：** 不支持设置百分比字符串。    |
 | fontStyle      | number&nbsp;\|&nbsp;[FontStyle](../arkui-ts/ts-appendix-enums.md#fontstyle)                        | 否   | 设置被计算文本字体样式。<br>默认值：FontStyle.Normal            |

--- a/zh-cn/application-dev/reference/apis/js-apis-plugincomponent.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-plugincomponent.md
@@ -155,11 +155,11 @@ OnPushEventCallback = (source: Want, template: PluginComponentTemplate, data: KV

 ```js
 function onPushListener(source, template, data, extraData) {
-    console.log("onPushListener template.source=" + template.source)
-    console.log("onPushListener source=" + JSON.stringify(source))
-    console.log("onPushListener template=" + JSON.stringify(template))
-    console.log("onPushListener data=" + JSON.stringify(data))
-    console.log("onPushListener extraData=" + JSON.stringify(extraData))
+  console.log("onPushListener template.source=" + template.source)
+  console.log("onPushListener source=" + JSON.stringify(source))
+  console.log("onPushListener template=" + JSON.stringify(template))
+  console.log("onPushListener data=" + JSON.stringify(data))
+  console.log("onPushListener extraData=" + JSON.stringify(extraData))
 }
 ```

@@ -181,14 +181,13 @@ OnRequestEventCallback = (source: Want, name: string, data: KVObject) => Request
 **示例：**

 ```js
-function onRequestListener(source, name, data)
-{
-    console.error("onRequestListener");
-    console.log("onRequestListener source=" + JSON.stringify(source));
-    console.log("onRequestListener name=" + name);
-    console.log("onRequestListener data=" + JSON.stringify(data));
+function onRequestListener(source, name, data) {
+  console.error("onRequestListener");
+  console.log("onRequestListener source=" + JSON.stringify(source));
+  console.log("onRequestListener name=" + name);
+  console.log("onRequestListener data=" + JSON.stringify(data));

-    return {template:"ets/pages/plugin.js", data:data};
+  return { template: "ets/pages/plugin.js", data: data };
 }
 ```

@@ -210,24 +209,24 @@ push(param: PushParameters , callback: AsyncCallback&lt;void&gt;): void

 ```js
 pluginComponentManager.push(
-{
+  {
    want: {
-        bundleName: "com.example.provider",
-        abilityName: "com.example.provider.MainAbility",
+      bundleName: "com.example.provider",
+      abilityName: "com.example.provider.MainAbility",
    },
    name: "plugintemplate",
    data: {
-        "key_1": "plugin component test",
-        "key_2": 34234
+      "key_1": "plugin component test",
+      "key_2": 34234
    },
    extraData: {
-        "extra_str": "this is push event"
+      "extra_str": "this is push event"
    },
    jsonPath: "",
-    },
-    (err, data) => {
-        console.log("push_callback: push ok!");
-    }
+  },
+  (err, data) => {
+    console.log("push_callback: push ok!");
+  }
 )
 ```

@@ -251,30 +250,30 @@ push(param: PushParameterForStage, callback: AsyncCallback&lt;void&gt;): void

 ```js
 pluginComponentManager.push(
-    {
-        owner:{
-            bundleName:"com.example.provider",
-            abilityName:"com.example.provider.MainAbility"
-        },
-        target: {
-            bundleName: "com.example.provider",
-            abilityName: "com.example.provider.MainAbility",
-        },
-        name: "ets/pages/plugin2.js",
-        data: {
-            "js": "ets/pages/plugin.js",
-            "key_1": 1111, ,
-        },
-        extraData: {
-            "extra_str": "this is push event"
-        },
-        jsonPath: "",
+  {
+    owner: {
+      bundleName: "com.example.provider",
+      abilityName: "com.example.provider.MainAbility"
+    },
+    target: {
+      bundleName: "com.example.provider",
+      abilityName: "com.example.provider.MainAbility",
+    },
+    name: "ets/pages/plugin2.js",
+    data: {
+      "js": "ets/pages/plugin.js",
+      "key_1": 1111, ,
+    },
+    extraData: {
+      "extra_str": "this is push event"
    },
-    (err, data) => {
-        console.log("push_callback:err: " ,JSON.stringify(err));
-        console.log("push_callback:data: " , JSON.stringify(data));
-        console.log("push_callback: push ok!");
-    }
+    jsonPath: "",
+  },
+  (err, data) => {
+    console.log("push_callback:err: ", JSON.stringify(err));
+    console.log("push_callback:data: ", JSON.stringify(data));
+    console.log("push_callback: push ok!");
+  }
 )
 ```

@@ -299,24 +298,24 @@ request(param: RequestParameters, callback: AsyncCallback&lt;RequestCallbackPara

 ```js
 pluginComponentManager.request(
-    {
-        want: {
-            bundleName: "com.example.provider",
-            abilityName: "com.example.provider.MainAbility",
-        },
-        name: "plugintemplate",
-        data: {
-            "key_1": "plugin component test",
-            "key_2": 1111111
-        },
-        jsonPath: "",
+  {
+    want: {
+      bundleName: "com.example.provider",
+      abilityName: "com.example.provider.MainAbility",
    },
-    (err, data) => {
-        console.log("request_callback: componentTemplate.ability=" + data.componentTemplate.ability)
-        console.log("request_callback: componentTemplate.source=" + data.componentTemplate.source)
-        console.log("request_callback: data=" + JSON.stringify(data.data))
-        console.log("request_callback: extraData=" + JSON.stringify(data.extraData))
-    }
+    name: "plugintemplate",
+    data: {
+      "key_1": "plugin component test",
+      "key_2": 1111111
+    },
+    jsonPath: "",
+  },
+  (err, data) => {
+    console.log("request_callback: componentTemplate.ability=" + data.componentTemplate.ability)
+    console.log("request_callback: componentTemplate.source=" + data.componentTemplate.source)
+    console.log("request_callback: data=" + JSON.stringify(data.data))
+    console.log("request_callback: extraData=" + JSON.stringify(data.extraData))
+  }
 )
 ```

@@ -342,25 +341,25 @@ request(param: RequestParameterForStage, callback: AsyncCallback&lt;RequestCallb

 ```js
 pluginComponentManager.request(
-    {
-        owner:{
-            bundleName:"com.example.provider",
-            abilityName:"com.example.provider.MainAbility"
-            },
-        target: {
-            bundleName: "com.example.provider",
-            abilityName: "ets/pages/plugin2.js",
-            },
-        name: "plugintemplate",
-        data: {
-                "key_1": " myapplication plugin component test",
-                },
-        jsonPath: "",
+  {
+    owner: {
+      bundleName: "com.example.provider",
+      abilityName: "com.example.provider.MainAbility"
+    },
+    target: {
+      bundleName: "com.example.provider",
+      abilityName: "ets/pages/plugin2.js",
    },
-    (err, data) => {
-        console.log("request_callback: componentTemplate.ability=" + data.componentTemplate.ability)
-        console.log("request_callback: componentTemplate.source=" + data.componentTemplate.source)
-    }
+    name: "plugintemplate",
+    data: {
+      "key_1": " myapplication plugin component test",
+    },
+    jsonPath: "",
+  },
+  (err, data) => {
+    console.log("request_callback: componentTemplate.ability=" + data.componentTemplate.ability)
+    console.log("request_callback: componentTemplate.source=" + data.componentTemplate.source)
+  }
 )
 ```

@@ -381,8 +380,8 @@ on(eventType: string, callback: OnPushEventCallback | OnRequestEventCallback ):
 **示例：**

 ```js
-    pluginComponentManager.on("push", onPushListener)
-    pluginComponentManager.on("request", onRequestListener)
+pluginComponentManager.on("push", onPushListener)
+pluginComponentManager.on("request", onRequestListener)
 ```

 ## external.json文件说明
@@ -396,3 +395,5 @@ external.json文件由开发者创建。external.json中以键值对形式存放
  "PluginProviderExample": "ets/pages/PluginProviderExample.js",
  "plugintemplate2": "ets/pages/plugintemplate2.js"
 }
+
+```
\ No newline at end of file
--- a/zh-cn/application-dev/reference/apis/js-apis-router.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-router.md
@@ -320,7 +320,7 @@ replaceUrl(options: RouterOptions, mode: RouterMode): Promise&lt;void&gt;

 | 错误码ID   | 错误信息 |
 | --------- | ------- |
-| 100001    | if UI execution context not found, only throw in standard system. |
+| 100001    | if can not get the delegate, only throw in standard system. |
 | 200002    | if the uri is not exist. |

 **示例：**
@@ -362,7 +362,7 @@ replaceUrl(options: RouterOptions, mode: RouterMode, callback: AsyncCallback&lt;

 | 错误码ID   | 错误信息 |
 | --------- | ------- |
-| 100001    | if can not get the delegate, only throw in standard system. |
+| 100001    | if UI execution context not found, only throw in standard system. |
 | 200002    | if the uri is not exist. |

 **示例：**
@@ -660,8 +660,8 @@ struct Second {
  private content: string = "这是第二页"
  @State text: string = router.getParams()['text']
  @State data: object = router.getParams()['data']
-  @State secondData : string = ''
-  
+  @State secondData: string = ''
+
  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
      Text(`${this.content}`)
@@ -669,14 +669,14 @@ struct Second {
        .fontWeight(FontWeight.Bold)
      Text(this.text)
        .fontSize(30)
-        .onClick(()=>{
+        .onClick(() => {
          this.secondData = (this.data.['array'][1]).toString()
        })
-      .margin({top:20})
+        .margin({ top: 20 })
      Text(`第一页传来的数值:${this.secondData}`)
        .fontSize(20)
-        .margin({top:20})
-        .backgroundColor('red')      
+        .margin({ top: 20 })
+        .backgroundColor('red')
    }
    .width('100%')
    .height('100%')
@@ -761,9 +761,9 @@ enableAlertBeforeBackPage(options: EnableAlertOptions): void
 **示例：**

  ```js        
-  router.enableAlertBeforeBackPage({            
-    message: 'Message Info'        
-  });    
+router.enableAlertBeforeBackPage({            
+  message: 'Message Info'        
+});    
  ```

 ## router.disableAlertBeforeBackPage<sup>(deprecated)</sup>

--- a/zh-cn/application-dev/reference/apis/js-apis-system-router.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-system-router.md
@@ -341,8 +341,8 @@ export default {

 | 名称   | 类型 | 必填 | 说明                                                         |
 | ------ | -------- | ---- | ------------------------------------------------------------ |
-| uri    | string   | 是   | 目标页面的uri，可以是以下的两种格式：<br/>1. 页面的绝对路径，由config.json文件中的页面列表提供。例如：<br/>- pages/index/index<br/> -pages/detail/detail<br/>2. 特定路径。如果URI为斜杠（/），则显示主页。 |
-| params | object   | 否   | 表示路由跳转时要同时传递到目标页面的数据。跳转到目标页面后，使用router.getParams()获取传递的参数，此外，在类web范式中，参数也可以在页面中直接使用，如this.keyValue(keyValue为跳转时params参数中的key值)，如果目标页面中已有该字段，则其值会被传入的字段值覆盖。 |
+| uri<sup>7+</sup> | string   | 是   | 目标页面的uri，可以是以下的两种格式：<br/>1. 页面的绝对路径，由config.json文件中的页面列表提供。例如：<br/>- pages/index/index<br/> -pages/detail/detail<br/>2. 特定路径。如果URI为斜杠（/），则显示主页。 |
+| params<sup>7+</sup> | object   | 否   | 表示路由跳转时要同时传递到目标页面的数据。跳转到目标页面后，使用router.getParams()获取传递的参数，此外，在类web范式中，参数也可以在页面中直接使用，如this.keyValue(keyValue为跳转时params参数中的key值)，如果目标页面中已有该字段，则其值会被传入的字段值覆盖。 |


 ## BackRouterOptions
@@ -353,8 +353,8 @@ export default {

 | 名称   | 类型 | 必填 | 说明                                                         |
 | ------ | -------- | ---- | ------------------------------------------------------------ |
-| uri    | string   | 否   | 返回到指定uri的界面，如果页面栈上没有uri页面，则不响应该情况。如果uri未设置，则返回上一页。 <br>**系统能力：** SystemCapability.ArkUI.ArkUI.Full |
-| params | object   | 否   | 跳转时要同时传递到目标页面的数据。 <br>**系统能力：** SystemCapability.ArkUI.ArkUI.Lite |
+| uri<sup>7+</sup> | string   | 否   | 返回到指定uri的界面，如果页面栈上没有uri页面，则不响应该情况。如果uri未设置，则返回上一页。 <br>**系统能力：** SystemCapability.ArkUI.ArkUI.Full |
+| params<sup>7+</sup> | object   | 否   | 跳转时要同时传递到目标页面的数据。 <br>**系统能力：** SystemCapability.ArkUI.ArkUI.Lite |

 ## RouterState


--- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-sharp-clipping.md
+++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-sharp-clipping.md
@@ -105,7 +105,7 @@ struct ClipAndMaskExample {
 ```ts
 @Entry
 @Component
-struct ProgressMask {
+struct ProgressMaskExample {
  @State progressflag1: boolean = true;
  @State color: Color = 0x01006CDE;
  @State value: number = 10.0;