diff --git a/zh-cn/application-dev/reference/apis/js-apis-uitest.md b/zh-cn/application-dev/reference/apis/js-apis-uitest.md index 3b1df63fcc4bcb7d8ab3cebc929da49eef18eeee..0e824de04cfa4dd1de206838d519ace19d934ce2 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-uitest.md +++ b/zh-cn/application-dev/reference/apis/js-apis-uitest.md @@ -39,16 +39,16 @@ text(txt: string, pattern?: MatchPattern): By **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------------ | ---- | ------------------------------------------------- | -| txt | string | 是 | 指定控件文本，用于匹配目标控件文本。 | -| pattern | MatchPattern | 否 | 指定的文本匹配模式，默认为[EQUALS](#matchpattern) | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------------ | ---- | --------------------------------------------------- | +| txt | string | 是 | 指定控件文本，用于匹配目标控件文本。 | +| pattern | MatchPattern | 否 | 指定的文本匹配模式，默认为[EQUALS](#matchpattern)。 | **返回值：** -| 类型 | 说明 | -| ---- | -------------- | -| By | 返回By对象自身 | +| 类型 | 说明 | +| --------- | ---------------------------------- | +| [By](#by) | 返回指定目标控件文本属性的By对象。 | **示例：** @@ -73,9 +73,9 @@ key(key: string): By **返回值：** -| 类型 | 说明 | -| ---- | ---------------- | -| By | 返回By对象自身。 | +| 类型 | 说明 | +| --------- | ----------------------------------- | +| [By](#by) | 返回指定目标控件key值属性的By对象。 | **示例：** @@ -100,9 +100,9 @@ id(id: number): By **返回值：** -| 类型 | 说明 | -| ---- | ---------------- | -| By | 返回By对象自身。 | +| 类型 | 说明 | +| --------- | -------------------------------- | +| [By](#by) | 返回指定目标控件id属性的By对象。 | **示例：** @@ -127,9 +127,9 @@ type(tp: string): By **返回值：** -| 类型 | 说明 | -| ---- | ---------------- | -| By | 返回By对象自身。 | +| 类型 | 说明 | +| --------- | ---------------------------------------- | +| [By](#by) | 返回指定目标控件的控件类型属性的By对象。 | **示例：** @@ -150,13 +150,13 @@ clickable(b?: boolean): By | 参数名 | 类型 | 必填 | 说明 | | ------ | ---- | ---- | -------------------------------- | -| b | boolean | 否 | 指定控件可点击状态，默认为true。 | +| b | boolean | 否 | 指定控件可点击状态，true：可点击，false：不可点击。默认为true。 | **返回值：** -| 类型 | 说明 | -| ---- | ---------------- | -| By | 返回By对象自身。 | +| 类型 | 说明 | +| --------- | ------------------------------------------ | +| [By](#by) | 返回指定目标控件的可点击状态属性的By对象。 | **示例：** @@ -176,13 +176,13 @@ longClickable(b?: boolean): By | 参数名 | 类型 | 必填 | 说明 | | ------ | ---- | ---- | ------------------------------------ | -| b | boolean | 否 | 指定控件可长按点击状态，默认为true。 | +| b | boolean | 否 | 指定控件可长按点击状态，true：可长按点击，false：不可长按点击。默认为true。 | **返回值：** -| 类型 | 说明 | -| ---- | ---------------- | -| By | 返回By对象自身。 | +| 类型 | 说明 | +| --------- | ---------------------------------------------- | +| [By](#by) | 返回指定目标控件的可长按点击状态属性的By对象。 | **示例：** @@ -203,13 +203,13 @@ scrollable(b?: boolean): By | 参数名 | 类型 | 必填 | 说明 | | ------ | ---- | ---- | ---------------------------- | -| b | boolean | 否 | 控件可滑动状态，默认为true。 | +| b | boolean | 否 | 控件可滑动状态，true：可滑动，false：不可滑动。默认为true。 | **返回值：** -| 类型 | 说明 | -| ---- | ---------------- | -| By | 返回By对象自身。 | +| 类型 | 说明 | +| --------- | ------------------------------------------ | +| [By](#by) | 返回指定目标控件的可滑动状态属性的By对象。 | **示例：** @@ -229,13 +229,13 @@ enabled(b?: boolean): By | 参数名 | 类型 | 必填 | 说明 | | ------ | ---- | ---- | ------------------------------ | -| b | boolean | 否 | 指定控件使能状态，默认为true。 | +| b | boolean | 否 | 指定控件使能状态，true：使能，false：未使能。默认为true。 | **返回值：** -| 类型 | 说明 | -| ---- | ---------------- | -| By | 返回By对象自身。 | +| 类型 | 说明 | +| --------- | ---------------------------------------- | +| [By](#by) | 返回指定目标控件的使能状态属性的By对象。 | **示例：** @@ -255,13 +255,13 @@ focused(b?: boolean): By | 参数名 | 类型 | 必填 | 说明 | | ------ | ---- | ---- | -------------------------- | -| b | boolean | 否 | 控件获焦状态，默认为true。 | +| b | boolean | 否 | 控件获焦状态，true：获焦，false：未获焦。默认为true。 | **返回值：** -| 类型 | 说明 | -| ---- | ---------------- | -| By | 返回By对象自身。 | +| 类型 | 说明 | +| --------- | ---------------------------------------- | +| [By](#by) | 返回指定目标控件的获焦状态属性的By对象。 | **示例：** @@ -281,13 +281,13 @@ selected(b?: boolean): By | 参数名 | 类型 | 必填 | 说明 | | ------ | ---- | ---- | -------------------------------- | -| b | boolean | 否 | 指定控件被选中状态，默认为true。 | +| b | boolean | 否 | 指定控件被选中状态，true：被选中，false：未被选中。默认为true。 | **返回值：** -| 类型 | 说明 | -| ---- | ---------------- | -| By | 返回By对象自身。 | +| 类型 | 说明 | +| --------- | ------------------------------------------ | +| [By](#by) | 返回指定目标控件的被选中状态属性的By对象。 | **示例：** @@ -307,13 +307,13 @@ checked(b?: boolean): By | 参数名 | 类型 | 必填 | 说明 | | ------ | ---- | ---- | --------------------------------- | -| b | boolean | 否 | 指定控件被勾选状态，默认为false。 | +| b | boolean | 否 | 指定控件被勾选状态，true：被勾选，false：未被勾选。默认为false。 | **返回值：** -| 类型 | 说明 | -| ---- | -------------- | -| By | 返回By对象自身 | +| 类型 | 说明 | +| --------- | ------------------------------------------ | +| [By](#by) | 返回指定目标控件的被勾选状态属性的By对象。 | **示例：** @@ -333,13 +333,13 @@ checkable(b?: boolean): By | 参数名 | 类型 | 必填 | 说明 | | ------ | ---- | ---- | ------------------------------------- | -| b | boolean | 否 | 指定控件能否被勾选状态，默认为false。 | +| b | boolean | 否 | 指定控件能否被勾选状态，true：能被勾选，false：不能被勾选。默认为false。 | **返回值：** -| 类型 | 说明 | -| ---- | ---------------- | -| By | 返回By对象自身。 | +| 类型 | 说明 | +| --------- | -------------------------------------------- | +| [By](#by) | 返回指定目标控件能否被勾选状态属性的By对象。 | **示例：** @@ -357,15 +357,15 @@ isBefore(by: By): By **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ---- | ---- | ---------------- | -| by | By | 是 | 特征控件的属性。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | --------- | ---- | ---------------- | +| by | [By](#by) | 是 | 特征控件的属性。 | **返回值：** -| 类型 | 说明 | -| ---- | ---------------- | -| By | 返回By对象自身。 | +| 类型 | 说明 | +| --------- | ---------------------------------------------------- | +| [By](#by) | 返回指定目标控件位于给出的特征属性控件之前的By对象。 | **示例：** @@ -383,15 +383,15 @@ isAfter(by: By): By **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ---- | ---- | ---------------- | -| by | By | 是 | 特征控件的属性。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | --------- | ---- | ---------------- | +| by | [By](#by) | 是 | 特征控件的属性。 | **返回值：** -| 类型 | 说明 | -| ---- | ---------------- | -| By | 返回By对象自身。 | +| 类型 | 说明 | +| --------- | ---------------------------------------------------- | +| [By](#by) | 返回指定目标控件位于给出的特征属性控件之后的By对象。 | **示例：** @@ -588,9 +588,9 @@ getBounds(): Promise\ **返回值：** -| 类型 | 说明 | -| -------------- | ------------------------------------- | -| Promise\ | 以Promise形式返回控件对象的边框信息。 | +| 类型 | 说明 | +| ------------------------ | ------------------------------------- | +| Promise\<[Rect](#rect9)> | 以Promise形式返回控件对象的边框信息。 | **示例：** @@ -612,9 +612,9 @@ getBoundsCenter(): Promise\ **返回值：** -| 类型 | 说明 | -| --------------- | --------------------------------------- | -| Promise\ | 以Promise形式返回控件对象的中心点信息。 | +| 类型 | 说明 | +| -------------------------- | --------------------------------------- | +| Promise\<[Point](#point9)> | 以Promise形式返回控件对象的中心点信息。 | **示例：** @@ -638,7 +638,7 @@ isClickable(): Promise\ | 类型 | 说明 | | -------------- | ------------------------------------- | -| Promise\ | 以Promise形式返回控件对象可点击状态。 | +| Promise\ | 以Promise形式返回控件对象可点击状态，true：可点击，false：不可点击。 | **示例：** @@ -667,7 +667,7 @@ isLongClickable(): Promise\ | 类型 | 说明 | | -------------- | ------------------------------------------- | -| Promise\ | 以Promise形式返回控件对象能否长按点击状态。 | +| Promise\ | 以Promise形式返回控件对象能否长按点击状态，true：可长按点击，false：不可长按点击。 | **示例：** @@ -696,7 +696,7 @@ isChecked(): Promise\ | 类型 | 说明 | | -------------- | ------------------------------------- | -| Promise\ | 以Promise形式返回控件对象被勾选状态。 | +| Promise\ | 以Promise形式返回控件对象被勾选状态，true：被勾选，false：未被勾选。 | **示例：** @@ -725,7 +725,7 @@ isCheckable(): Promise\ | 类型 | 说明 | | -------------- | ------------------------------------------- | -| Promise\ | 以Promise形式返回控件对象能否被勾选的属性。 | +| Promise\ | 以Promise形式返回控件对象能否被勾选的属性，true：可被勾选，false：不可被勾选。 | **示例：** @@ -754,7 +754,7 @@ isScrollable(): Promise\ | 类型 | 说明 | | -------------- | ------------------------------------- | -| Promise\ | 以Promise形式返回控件对象可滑动状态。 | +| Promise\ | 以Promise形式返回控件对象可滑动状态，true：可滑动，false：不可滑动。 | **示例：** @@ -784,7 +784,7 @@ isEnabled(): Promise\ | 类型 | 说明 | | -------------- | ------------------------------- | -| Promise\ | 以Promise形式返回控件使能状态。 | +| Promise\ | 以Promise形式返回控件使能状态，true：使能，false：未使能。 | **示例：** @@ -814,7 +814,7 @@ isFocused(): Promise\ | 类型 | 说明 | | -------------- | ----------------------------------- | -| Promise\ | 以Promise形式返回控件对象是否获焦。 | +| Promise\ | 以Promise形式返回控件对象是否获焦，true：获焦，false：未获焦。 | **示例：** @@ -843,7 +843,7 @@ isSelected(): Promise\ | 类型 | 说明 | | -------------- | -------------------- | -| Promise\ | 控件对象被选中的状态 | +| Promise\ | 控件对象被选中的状态，true：被选中，false：未被选中。 | **示例：** @@ -912,15 +912,15 @@ scrollSearch(by: By): Promise\ **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ---- | ---- | -------------------- | -| by | By | 是 | 目标控件的属性要求。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | --------- | ---- | -------------------- | +| by | [By](#by) | 是 | 目标控件的属性要求。 | **返回值：** -| 类型 | 说明 | -| --------------------- | ------------------------------------- | -| Promise\ | 以Promise形式返回找到的目标控件对象。 | +| 类型 | 说明 | +| ------------------------------------- | ------------------------------------- | +| Promise\<[UiComponent](#uicomponent)> | 以Promise形式返回找到的目标控件对象。 | **示例：** @@ -990,9 +990,9 @@ dragTo(target: UiComponent): Promise\ **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ----------- | ---- | ---------- | -| target | UiComponent | 是 | 目标控件。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | --------------------------- | ---- | ---------- | +| target | [UiComponent](#uicomponent) | 是 | 目标控件。 | **示例：** @@ -1015,9 +1015,9 @@ pinchOut(scale: number): Promise\ **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ----------- | ---- | ---------- | -| scale | number | 是 | 指定比例 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ---------------- | +| scale | number | 是 | 指定放大的比例。 | **示例：** @@ -1039,9 +1039,9 @@ pinchIn(scale: number): Promise\ **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ----------- | ---- | ---------- | -| scale | number | 是 | 指定比例 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ---------------- | +| scale | number | 是 | 指定缩小的比例。 | **示例：** @@ -1113,15 +1113,15 @@ findComponent(by: By): Promise\ **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ---- | ---- | -------------------- | -| by | By | 是 | 目标控件的属性要求。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | --------- | ---- | -------------------- | +| by | [By](#by) | 是 | 目标控件的属性要求。 | **返回值：** -| 类型 | 说明 | -| --------------------- | --------------------------------- | -| Promise\ | 以Promise形式返回找到的控件对象。 | +| 类型 | 说明 | +| ------------------------------------- | --------------------------------- | +| Promise\<[UiComponent](#uicomponent)> | 以Promise形式返回找到的控件对象。 | **示例：** @@ -1142,15 +1142,15 @@ findComponents(by: By): Promise\> **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ---- | ---- | -------------------- | -| by | By | 是 | 目标控件的属性要求。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | --------- | ---- | -------------------- | +| by | [By](#by) | 是 | 目标控件的属性要求。 | **返回值：** -| 类型 | 说明 | -| ----------------------------- | --------------------------------------- | -| Promise\> | 以Promise形式返回找到的控件对象的列表。 | +| 类型 | 说明 | +| --------------------------------------------- | --------------------------------------- | +| Promise\> | 以Promise形式返回找到的控件对象的列表。 | **示例：** @@ -1200,16 +1200,16 @@ waitForComponent(by: By, time: number): Promise\ **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | -------------------------------- | -| by | By | 是 | 目标控件的属性要求。 | -| time | number | 是 | 查找目标控件的持续时间。单位ms。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | --------- | ---- | -------------------------------- | +| by | [By](#by) | 是 | 目标控件的属性要求。 | +| time | number | 是 | 查找目标控件的持续时间。单位ms。 | **返回值：** -| 类型 | 说明 | -| --------------------- | --------------------------------- | -| Promise\ | 以Promise形式返回找到的控件对象。 | +| 类型 | 说明 | +| ------------------------------------- | --------------------------------- | +| Promise\<[UiComponent](#uicomponent)> | 以Promise形式返回找到的控件对象。 | **示例：** @@ -1230,9 +1230,9 @@ assertComponentExist(by: By): Promise\ **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ---- | ---- | -------------------- | -| by | By | 是 | 目标控件的属性要求。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | --------- | ---- | -------------------- | +| by | [By](#by) | 是 | 目标控件的属性要求。 | **示例：** @@ -1522,7 +1522,7 @@ setDisplayRotationEnabled(enabled: boolean): Promise\ | 参数名 | 类型 | 必填 | 说明 | | ------- | ---- | ---- | -------------------- | -| enabled | boolean | 是 | 能否旋转屏幕的标识。 | +| enabled | boolean | 是 | 能否旋转屏幕的标识，true：可以旋转，false：不可以旋转。 | **示例：** @@ -1757,9 +1757,9 @@ getBounds(): Promise\ **返回值：** -| 类型 | 说明 | -| -------------- | --------------------------------- | -| Promise\ | 以Promise形式返回窗口的边框信息。 | +| 类型 | 说明 | +| ------------------------ | --------------------------------- | +| Promise\<[Rect](#rect9)> | 以Promise形式返回窗口的边框信息。 | **示例：** @@ -1831,7 +1831,7 @@ isFocused(): Promise\ | 类型 | 说明 | | -------------- | ----------------------------------- | -| Promise\ | 以Promise形式返回窗口对象是否获焦。 | +| Promise\ | 以Promise形式返回窗口对象是否获焦，true：获焦，false：未获焦。 | **示例：** @@ -1855,7 +1855,7 @@ isActived(): Promise\ | 类型 | 说明 | | -------------- | --------------------------------------------- | -| Promise\ | 以Promise形式返回窗口对象是否为用户交互窗口。 | +| Promise\ | 以Promise形式返回窗口对象是否为用户交互窗口，true：交互窗口，false：非交互窗口。 | **示例：** @@ -1879,7 +1879,7 @@ focus(): Promise\ | 类型 | 说明 | | -------------- | ----------------------------------- | -| Promise\ | 以Promise形式返回操作是否成功完成。 | +| Promise\ | 以Promise形式返回操作是否成功完成，true：操作已完成，false：操作未完成。 | **示例：** @@ -1910,7 +1910,7 @@ moveTo(x: number, y: number): Promise\ | 类型 | 说明 | | -------------- | ----------------------------------- | -| Promise\ | 以Promise形式返回操作是否成功完成。 | +| Promise\ | 以Promise形式返回操作是否成功完成，true：操作已完成，false：操作未完成。 | **示例：** @@ -1942,7 +1942,7 @@ resize(wide: number, height: number, direction: ResizeDirection): Promise\ | 以Promise形式返回操作是否成功完成。 | +| Promise\ | 以Promise形式返回操作是否成功完成，true：操作已完成，false：操作未完成。 | **示例：** @@ -1966,7 +1966,7 @@ split(): Promise\ | 类型 | 说明 | | -------------- | ----------------------------------- | -| Promise\ | 以Promise形式返回操作是否成功完成。 | +| Promise\ | 以Promise形式返回操作是否成功完成，true：操作已完成，false：操作未完成。 | **示例：** @@ -1990,7 +1990,7 @@ maximize(): Promise\ | 类型 | 说明 | | -------------- | ----------------------------------- | -| Promise\ | 以Promise形式返回操作是否成功完成。 | +| Promise\ | 以Promise形式返回操作是否成功完成，true：操作已完成，false：操作未完成。 | **示例：** @@ -2014,7 +2014,7 @@ minimize(): Promise\ | 类型 | 说明 | | -------------- | ----------------------------------- | -| Promise\ | 以Promise形式返回操作是否成功完成。 | +| Promise\ | 以Promise形式返回操作是否成功完成，true：操作已完成，false：操作未完成。 | **示例：** @@ -2038,7 +2038,7 @@ resume(): Promise\ | 类型 | 说明 | | -------------- | ----------------------------------- | -| Promise\ | 以Promise形式返回操作是否成功完成。 | +| Promise\ | 以Promise形式返回操作是否成功完成，true：操作已完成，false：操作未完成。 | **示例：** @@ -2062,7 +2062,7 @@ close(): Promise\ | 类型 | 说明 | | -------------- | ----------------------------------- | -| Promise\ | 以Promise形式返回操作是否成功完成。 | +| Promise\ | 以Promise形式返回操作是否成功完成，true：操作已完成，false：操作未完成。 | **示例：** @@ -2095,9 +2095,9 @@ static create(fingers: number, steps: number): PointerMatrix **返回值：** -| 类型 | 说明 | -| ------------- | ----------------------------- | -| PointerMatrix | 返回构造的PointerMatrix对象。 | +| 类型 | 说明 | +| -------------------------------- | ----------------------------- | +| [PointerMatrix](#pointermatrix9) | 返回构造的PointerMatrix对象。 | **示例：** @@ -2188,9 +2188,9 @@ async function demo() { 设备显示器的显示方向。 -| 名称 | 说明 | -| ------------ | ------------------------------------ | -| ROTATION_0 | 设备显示器不旋转，初始形态垂直显示。 | -| ROTATION_90 | 设备显顺时针旋转90°，水平显示。 | -| ROTATION_180 | 设备显顺时针旋转180°，逆向垂直显示。 | -| ROTATION_270 | 设备显顺时针旋转270°，逆向水平显示。 | +| 名称 | 说明 | +| ------------ | ---------------------------------------- | +| ROTATION_0 | 设备显示器不旋转，初始形态垂直显示。 | +| ROTATION_90 | 设备显示器顺时针旋转90°，水平显示。 | +| ROTATION_180 | 设备显示器顺时针旋转180°，逆向垂直显示。 | +| ROTATION_270 | 设备显示器顺时针旋转270°，逆向水平显示。 |