diff --git a/zh-cn/application-dev/reference/apis/js-apis-arkui-UIContext.md b/zh-cn/application-dev/reference/apis/js-apis-arkui-UIContext.md index 0f52d5aaa02450e0fc443e12fac8aa56aa7f9bc9..89f8be570ba9647a627094af35d5ced1d23c4674 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-arkui-UIContext.md +++ b/zh-cn/application-dev/reference/apis/js-apis-arkui-UIContext.md @@ -139,11 +139,13 @@ animateTo(value: AnimateParam, event: () => void): void 提供animateTo接口来指定由于闭包代码导致的状态变化插入过渡动效。 +**系统能力：** SystemCapability.ArkUI.ArkUI.Full + 从API version 9开始，该接口支持在ArkTS卡片中使用。 **参数：** -| 参数名 | 类型 | 是否必填 | 描述 | +| 参数名 | 类型 | 必填 | 说明 | | ---------------- | ------------ | -------------------- | -------------------- | | value | [AnimateParam](../arkui-ts/ts-explicit-animation.md#animateparam对象说明) | 是 | 设置动画效果相关参数。 | | event | () => void | 是 | 指定显示动效的闭包函数，在闭包函数中导致的状态变化系统会自动插入过渡动画。 | @@ -216,11 +218,13 @@ showAlertDialog(options: AlertDialogParamWithConfirm | AlertDialogParamWithButto 显示警告弹窗组件，可设置文本内容与响应回调。 +**系统能力：** SystemCapability.ArkUI.ArkUI.Full + **参数：** -| 参数名 | 参数类型 | 参数描述 | -| ---- | --------------- | -------- | -| options | [AlertDialogParamWithConfirm](../arkui-ts/ts-methods-alert-dialog-box.md#alertdialogparamwithconfirm对象说明) \| [AlertDialogParamWithButtons](../arkui-ts/ts-methods-alert-dialog-box.md#alertdialogparamwithbuttons对象说明) | 定义并显示AlertDialog组件。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | --------------- | -------- | -------- | +| options | [AlertDialogParamWithConfirm](../arkui-ts/ts-methods-alert-dialog-box.md#alertdialogparamwithconfirm对象说明) \| [AlertDialogParamWithButtons](../arkui-ts/ts-methods-alert-dialog-box.md#alertdialogparamwithbuttons对象说明) | 是 | 定义并显示AlertDialog组件。 | **示例：** @@ -252,9 +256,11 @@ showActionSheet(value: ActionSheetOptions): void 定义列表弹窗并弹出。 +**系统能力：** SystemCapability.ArkUI.ArkUI.Full + **ActionSheetOptions参数：** -| 参数名 | 参数类型 | 必填 | 参数描述 | +| 参数名 | 类型 | 必填 | 说明 | | ---------- | -------------------------- | ------- | ----------------------------- | | title | [Resource](../arkui-ts/ts-types.md#resource) \| string | 是 | 弹窗标题。 | | message | [Resource](../arkui-ts/ts-types.md#resource) \| string | 是 | 弹窗内容。 | @@ -267,7 +273,7 @@ showActionSheet(value: ActionSheetOptions): void **SheetInfo接口说明：** -| 参数名 | 参数类型 | 必填 | 参数描述 | +| 参数名 | 类型 | 必填 | 说明 | | ------ | ------------------------------------------------------------ | ---- | ----------------- | | title | [ResourceStr](../arkui-ts/ts-types.md#resourcestr) | 是 | 选项的文本内容。 | | icon | [ResourceStr](../arkui-ts/ts-types.md#resourcestr) | 否 | 选项的图标，默认无图标显示。 | @@ -320,22 +326,24 @@ showDatePickerDialog(options: DatePickerDialogOptions): void 定义日期滑动选择器弹窗并弹出。 +**系统能力：** SystemCapability.ArkUI.ArkUI.Full + **DatePickerDialogOptions参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| -------- | -------- | -------- | -------- | -------- | -| start | Date | 否 | Date('1970-1-1') | 设置选择器的起始日期。 | -| end | Date | 否 | Date('2100-12-31') | 设置选择器的结束日期。 | -| selected | Date | 否 | 当前系统日期 | 设置当前选中的日期。 | -| lunar | boolean | 否 | false | 日期是否显示为农历。 | -| showTime | boolean | 否 | false | 是否展示时间项。 | -| useMilitaryTime | boolean | 否 | false | 展示时间是否为24小时制。 | -| disappearTextStyle | [PickerTextStyle](../arkui-ts/ts-basic-components-datepicker.md#pickertextstyle10类型说明) | 否 | - | 设置所有选项中最上和最下两个选项的文本颜色、字号、字体粗细。 | -| textStyle | [PickerTextStyle](../arkui-ts/ts-basic-components-datepicker.md#pickertextstyle10类型说明) | 否 | - | 设置所有选项中除了最上、最下及选中项以外的文本颜色、字号、字体粗细。 | -| selectedTextStyle | [PickerTextStyle](../arkui-ts/ts-basic-components-datepicker.md#pickertextstyle10类型说明) | 否 | - | 设置选中项的文本颜色、字号、字体粗细。 | -| onAccept | (value: [DatePickerResult](../arkui-ts/ts-basic-components-datepicker.md#datepickerresult对象说明)) => void | 否 | - | 点击弹窗中的“确定”按钮时触发该回调。 | -| onCancel | () => void | 否 | - | 点击弹窗中的“取消”按钮时触发该回调。 | -| onChange | (value: [DatePickerResult](../arkui-ts/ts-basic-components-datepicker.md#datepickerresult对象说明)) => void | 否 | - | 滑动弹窗中的滑动选择器使当前选中项改变时触发该回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| start | Date | 否 | 设置选择器的起始日期。
默认值：Date('1970-1-1') | +| end | Date | 否 | 设置选择器的结束日期。
默认值：Date('2100-12-31') | +| selected | Date | 否 | 设置当前选中的日期。
默认值：当前系统日期 | +| lunar | boolean | 否 | 日期是否显示为农历。
默认值：false | +| showTime | boolean | 否 | 是否展示时间项。
默认值：false | +| useMilitaryTime | boolean | 否 | 展示时间是否为24小时制。
默认值：false | +| disappearTextStyle | [PickerTextStyle](../arkui-ts/ts-basic-components-datepicker.md#pickertextstyle10类型说明) | 否 | 设置所有选项中最上和最下两个选项的文本颜色、字号、字体粗细。 | +| textStyle | [PickerTextStyle](../arkui-ts/ts-basic-components-datepicker.md#pickertextstyle10类型说明) | 否 | 设置所有选项中除了最上、最下及选中项以外的文本颜色、字号、字体粗细。 | +| selectedTextStyle | [PickerTextStyle](../arkui-ts/ts-basic-components-datepicker.md#pickertextstyle10类型说明) | 否 | 设置选中项的文本颜色、字号、字体粗细。 | +| onAccept | (value: [DatePickerResult](../arkui-ts/ts-basic-components-datepicker.md#datepickerresult对象说明)) => void | 否 | 点击弹窗中的“确定”按钮时触发该回调。 | +| onCancel | () => void | 否 | 点击弹窗中的“取消”按钮时触发该回调。 | +| onChange | (value: [DatePickerResult](../arkui-ts/ts-basic-components-datepicker.md#datepickerresult对象说明)) => void | 否 | 滑动弹窗中的滑动选择器使当前选中项改变时触发该回调。 | **示例：** @@ -365,9 +373,11 @@ showTimePickerDialog(options: TimePickerDialogOptions): void 定义时间滑动选择器弹窗并弹出。 +**系统能力：** SystemCapability.ArkUI.ArkUI.Full + **TimePickerDialogOptions参数：** -| 参数名 | 参数类型 | 必填 | 参数描述 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | selected | Date | 否 | 设置当前选中的时间。
默认值：当前系统时间 | | useMilitaryTime | boolean | 否 | 展示时间是否为24小时制，默认为12小时制。
默认值：false | @@ -404,9 +414,11 @@ showTextPickerDialog(options: TextPickerDialogOptions): void 定义文本滑动选择器弹窗并弹出。 +**系统能力：** SystemCapability.ArkUI.ArkUI.Full + **TextPickerDialogOptions参数：** -| 参数名 | 参数类型 | 必填 | 参数描述 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | range | string[] \| [Resource](../arkui-ts/ts-types.md#resource)\|[TextPickerRangeContent](../arkui-ts/ts-basic-components-textpicker.md#textpickerrangecontent10类型说明)[] | 是 | 设置文本选择器的选择范围。不可设置为空数组，若设置为空数组，则不弹出弹窗。 | | selected | number | 否 | 设置选中项的索引值。
默认值：0 | @@ -515,9 +527,9 @@ registerFont(options: FontOptions): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | --------------------------- | ---- | ----------- | -| options | [FontOptions](js-apis-font.md#fontoptions) | 是 | 注册的自定义字体信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ----------------------------------------------- | ---- | ---------------------- | +| options | [font.FontOptions](js-apis-font.md#fontoptions) | 是 | 注册的自定义字体信息。 | **示例：** @@ -528,13 +540,61 @@ font.registerFont({ familySrc: '/font/medium.ttf' }); ``` +### getStstemFontList + +getSystemFontList(): Array\ + +获取系统支持的字体名称列表。 + +**系统能力：** SystemCapability.ArkUI.ArkUI.Full + +**返回值：** + +| 类型 | 说明 | +| -------------- | ------------------ | +| Array\ | 系统的字体名列表。 | + +**示例：** + +```ts +let font = uiContext.getFont(); +font.getSystemFontList() +``` + +### getFontByName + +getFontByName(fontName: string): font.FontInfo + +根据传入的系统字体名称获取系统字体的相关信息。 + +**系统能力：** SystemCapability.ArkUI.ArkUI.Full + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | -------------- | +| fontName | string | 是 | 系统的字体名。 | + +**返回值：** + +| 类型 | 说明 | +| ------------------------------------ | -------------- | +| [FontInfo](js-apis-font.md#fontinfo) | 字体的详细信息 | + +**示例：** + +```ts +let font = uiContext.getFont(); +font.getFontByName('Sans Italic') +``` + ## ComponentUtils 以下API需先使用UIContext中的[getComponentUtils()](#getcomponentutils)方法获取到ComponentUtils对象，再通过该对象调用对应方法。 ### getRectangleById -getRectangleById(key: string): ComponentInfo +getRectangleById(id: string): ComponentUtils.ComponentInfo 获取组件大小、位置、平移缩放旋转及仿射矩阵属性信息。 @@ -544,7 +604,7 @@ getRectangleById(key: string): ComponentInfo | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ---------------- | -| key | string | 是 | 组件唯一标识id。 | +| id | string | 是 | 组件唯一标识id。 | **返回值：** @@ -567,7 +627,7 @@ let localOffsetHeight = modePosition.size.height; ### createComponentObserver -createComponentObserver(id: string): ComponentObserver +createComponentObserver(id: string): inspector.ComponentObserver 注册组件布局和绘制完成回调通知。 @@ -581,8 +641,8 @@ createComponentObserver(id: string): ComponentObserver **返回值：** -| 类型 | 说明 | -| --------------------------------------- | -------------------------------------------------- | +| 类型 | 说明 | +| ------------------------------------------------------------ | -------------------------------------------------- | | [ComponentObserver](js-apis-arkui-inspector.md#componentobserver) | 组件回调事件监听句柄，用于注册和取消注册监听回调。 | **示例：** @@ -598,7 +658,7 @@ let listener = inspector.createComponentObserver('COMPONENT_ID'); ### matchMediaSync -matchMediaSync(condition: string): MediaQueryListener +matchMediaSync(condition: string): mediaQuery.MediaQueryListener 设置媒体查询的查询条件，并返回对应的监听句柄。 @@ -629,7 +689,7 @@ let listener = mediaquery.matchMediaSync('(orientation: landscape)'); //监听 ### pushUrl -pushUrl(options: RouterOptions): Promise<void> +pushUrl(options: router.RouterOptions): Promise<void> 跳转到应用内的指定页面。 @@ -637,9 +697,9 @@ pushUrl(options: RouterOptions): Promise<void> **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------------------------------- | ---- | --------- | -| options | [RouterOptions](js-apis-router.md#routeroptions) | 是 | 跳转页面描述信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------------------------------------------------------- | ---- | ------------------ | +| options | [router.RouterOptions](js-apis-router.md#routeroptions) | 是 | 跳转页面描述信息。 | **返回值：** @@ -680,7 +740,7 @@ router.pushUrl({ ### pushUrl -pushUrl(options: RouterOptions, callback: AsyncCallback<void>): void +pushUrl(options: router.RouterOptions, callback: AsyncCallback<void>): void 跳转到应用内的指定页面。 @@ -690,7 +750,7 @@ pushUrl(options: RouterOptions, callback: AsyncCallback<void>): void | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------------------- | ---- | --------- | -| options | [RouterOptions](js-apis-router.md#routeroptions) | 是 | 跳转页面描述信息。 | +| options | [router.RouterOptions](js-apis-router.md#routeroptions) | 是 | 跳转页面描述信息。 | | callback | AsyncCallback<void> | 是 | 异常响应回调。 | **错误码：** @@ -726,7 +786,7 @@ router.pushUrl({ ### pushUrl -pushUrl(options: RouterOptions, mode: RouterMode): Promise<void> +pushUrl(options: router.RouterOptions, mode: router.RouterMode): Promise<void> 跳转到应用内的指定页面。 @@ -734,10 +794,10 @@ pushUrl(options: RouterOptions, mode: RouterMode): Promise<void> **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------------------------------- | ---- | ---------- | -| options | [RouterOptions](js-apis-router.md#routeroptions) | 是 | 跳转页面描述信息。 | -| mode | [RouterMode](js-apis-router.md#routermode9) | 是 | 跳转页面使用的模式。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------------------------------------------------------- | ---- | -------------------- | +| options | [router.RouterOptions](js-apis-router.md#routeroptions) | 是 | 跳转页面描述信息。 | +| mode | [router.RouterMode](js-apis-router.md#routermode9) | 是 | 跳转页面使用的模式。 | **返回值：** @@ -778,7 +838,7 @@ router.pushUrl({ ### pushUrl -pushUrl(options: RouterOptions, mode: RouterMode, callback: AsyncCallback<void>): void +pushUrl(options: router.RouterOptions, mode: router.RouterMode, callback: AsyncCallback<void>): void 跳转到应用内的指定页面。 @@ -788,8 +848,8 @@ pushUrl(options: RouterOptions, mode: RouterMode, callback: AsyncCallback<voi | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------------------- | ---- | ---------- | -| options | [RouterOptions](js-apis-router.md#routeroptions) | 是 | 跳转页面描述信息。 | -| mode | [RouterMode](js-apis-router.md#routermode9) | 是 | 跳转页面使用的模式。 | +| options | [router.RouterOptions](js-apis-router.md#routeroptions) | 是 | 跳转页面描述信息。 | +| mode | [router.RouterMode](js-apis-router.md#routermode9) | 是 | 跳转页面使用的模式。 | | callback | AsyncCallback<void> | 是 | 异常响应回调。 | **错误码：** @@ -825,17 +885,17 @@ router.pushUrl({ ### replaceUrl -replaceUrl(options: RouterOptions): Promise<void> +replaceUrl(options: router.RouterOptions): Promise<void> 用应用内的某个页面替换当前页面，并销毁被替换的页面。 -**系统能力：** SystemCapability.ArkUI.ArkUI.Lite +**系统能力：** SystemCapability.ArkUI.ArkUI.Full **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------------------------------- | ---- | ------------------ | -| options | [RouterOptions](js-apis-router.md#routeroptions) | 是 | 替换页面描述信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------------------------------------------------------- | ---- | ------------------ | +| options | [router.RouterOptions](js-apis-router.md#routeroptions) | 是 | 替换页面描述信息。 | **返回值：** @@ -876,13 +936,13 @@ replaceUrl(options: RouterOptions, callback: AsyncCallback<void>): void 用应用内的某个页面替换当前页面，并销毁被替换的页面。 -**系统能力：** SystemCapability.ArkUI.ArkUI.Lite +**系统能力：** SystemCapability.ArkUI.ArkUI.Full **参数：** | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------------------- | ---- | ------------------ | -| options | [RouterOptions](js-apis-router.md#routeroptions) | 是 | 替换页面描述信息。 | +| options | [router.RouterOptions](js-apis-router.md#routeroptions) | 是 | 替换页面描述信息。 | | callback | AsyncCallback<void> | 是 | 异常响应回调。 | **错误码：** @@ -914,18 +974,18 @@ router.replaceUrl({ ### replaceUrl -replaceUrl(options: RouterOptions, mode: RouterMode): Promise<void> +replaceUrl(options: router.RouterOptions, mode: router.RouterMode): Promise<void> 用应用内的某个页面替换当前页面，并销毁被替换的页面。 -**系统能力：** SystemCapability.ArkUI.ArkUI.Lite +**系统能力：** SystemCapability.ArkUI.ArkUI.Full **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------------------------------- | ---- | ---------- | -| options | [RouterOptions](js-apis-router.md#routeroptions) | 是 | 替换页面描述信息。 | -| mode | [RouterMode](js-apis-router.md#routermode9) | 是 | 跳转页面使用的模式。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------------------------------------------------------- | ---- | -------------------- | +| options | [router.RouterOptions](js-apis-router.md#routeroptions) | 是 | 替换页面描述信息。 | +| mode | [router.RouterMode](js-apis-router.md#routermode9) | 是 | 跳转页面使用的模式。 | **返回值：** @@ -962,18 +1022,18 @@ router.replaceUrl({ ### replaceUrl -replaceUrl(options: RouterOptions, mode: RouterMode, callback: AsyncCallback<void>): void +replaceUrl(options: router.RouterOptions, mode: router.RouterMode, callback: AsyncCallback<void>): void 用应用内的某个页面替换当前页面，并销毁被替换的页面。 -**系统能力：** SystemCapability.ArkUI.ArkUI.Lite +**系统能力：** SystemCapability.ArkUI.ArkUI.Full **参数：** | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------------------- | ---- | ---------- | -| options | [RouterOptions](js-apis-router.md#routeroptions) | 是 | 替换页面描述信息。 | -| mode | [RouterMode](js-apis-router.md#routermode9) | 是 | 跳转页面使用的模式。 | +| options | [router.RouterOptions](js-apis-router.md#routeroptions) | 是 | 替换页面描述信息。 | +| mode | [router.RouterMode](js-apis-router.md#routermode9) | 是 | 跳转页面使用的模式。 | | callback | AsyncCallback<void> | 是 | 异常响应回调。 | **错误码：** @@ -1005,7 +1065,7 @@ router.replaceUrl({ ### pushNamedRoute -pushNamedRoute(options: NamedRouterOptions): Promise<void> +pushNamedRoute(options: router.NamedRouterOptions): Promise<void> 跳转到指定的命名路由页面。 @@ -1013,9 +1073,9 @@ pushNamedRoute(options: NamedRouterOptions): Promise<void> **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------------------------------- | ---- | --------- | -| options | [NamedRouterOptions](js-apis-router.md#namedrouteroptions10) | 是 | 跳转页面描述信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------------------------------------------------------------ | ---- | ------------------ | +| options | [router.NamedRouterOptions](js-apis-router.md#namedrouteroptions10) | 是 | 跳转页面描述信息。 | **返回值：** @@ -1056,7 +1116,7 @@ router.pushNamedRoute({ ### pushNamedRoute -pushNamedRoute(options: NamedRouterOptions, callback: AsyncCallback<void>): void +pushNamedRoute(options: router.NamedRouterOptions, callback: AsyncCallback<void>): void 跳转到指定的命名路由页面。 @@ -1066,7 +1126,7 @@ pushNamedRoute(options: NamedRouterOptions, callback: AsyncCallback<void>) | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------------------- | ---- | --------- | -| options | [NamedRouterOptions](js-apis-router.md#namedrouteroptions10) | 是 | 跳转页面描述信息。 | +| options | [router.NamedRouterOptions](js-apis-router.md#namedrouteroptions10) | 是 | 跳转页面描述信息。 | | callback | AsyncCallback<void> | 是 | 异常响应回调。 | **错误码：** @@ -1101,7 +1161,7 @@ router.pushNamedRoute({ ``` ### pushNamedRoute -pushNamedRoute(options: NamedRouterOptions, mode: RouterMode): Promise<void> +pushNamedRoute(options: router.NamedRouterOptions, mode: router.RouterMode): Promise<void> 跳转到指定的命名路由页面。 @@ -1109,10 +1169,10 @@ pushNamedRoute(options: NamedRouterOptions, mode: RouterMode): Promise<void&g **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------------------------------- | ---- | ---------- | -| options | [NamedRouterOptions](js-apis-router.md#namedrouteroptions10) | 是 | 跳转页面描述信息。 | -| mode | [RouterMode](js-apis-router.md#routermode9) | 是 | 跳转页面使用的模式。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------------------------------------------------------------ | ---- | -------------------- | +| options | [router.NamedRouterOptions](js-apis-router.md#namedrouteroptions10) | 是 | 跳转页面描述信息。 | +| mode | [router.RouterMode](js-apis-router.md#routermode9) | 是 | 跳转页面使用的模式。 | **返回值：** @@ -1163,8 +1223,8 @@ pushNamedRoute(options: NamedRouterOptions, mode: RouterMode, callback: AsyncCal | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------------------- | ---- | ---------- | -| options | [NamedRouterOptions](js-apis-router.md#namedrouteroptions10) | 是 | 跳转页面描述信息。 | -| mode | [RouterMode](js-apis-router.md#routermode9) | 是 | 跳转页面使用的模式。 | +| options | [router.NamedRouterOptions](js-apis-router.md#namedrouteroptions10) | 是 | 跳转页面描述信息。 | +| mode | [router.RouterMode](js-apis-router.md#routermode9) | 是 | 跳转页面使用的模式。 | | callback | AsyncCallback<void> | 是 | 异常响应回调。 | **错误码：** @@ -1200,7 +1260,7 @@ router.pushNamedRoute({ ### replaceNamedRoute -replaceNamedRoute(options: NamedRouterOptions): Promise<void> +replaceNamedRoute(options: router.NamedRouterOptions): Promise<void> 用指定的命名路由页面替换当前页面，并销毁被替换的页面。 @@ -1208,9 +1268,9 @@ replaceNamedRoute(options: NamedRouterOptions): Promise<void> **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------------------------------- | ---- | ------------------ | -| options | [NamedRouterOptions](js-apis-router.md#namedrouteroptions10) | 是 | 替换页面描述信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------------------------------------------------------------ | ---- | ------------------ | +| options | [router.NamedRouterOptions](js-apis-router.md#namedrouteroptions10) | 是 | 替换页面描述信息。 | **返回值：** @@ -1224,7 +1284,7 @@ replaceNamedRoute(options: NamedRouterOptions): Promise<void> | 错误码ID | 错误信息 | | --------- | ------- | -| 100001 | if UI execution context not found. | +| 100001 | if UI execution context not found, only throw in standard system. | | 100004 | if the named route is not exist. | **示例：** @@ -1247,7 +1307,7 @@ router.replaceNamedRoute({ ### replaceNamedRoute -replaceNamedRoute(options: NamedRouterOptions, callback: AsyncCallback<void>): void +replaceNamedRoute(options: router.NamedRouterOptions, callback: AsyncCallback<void>): void 用指定的命名路由页面替换当前页面，并销毁被替换的页面。 @@ -1257,7 +1317,7 @@ replaceNamedRoute(options: NamedRouterOptions, callback: AsyncCallback<void&g | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------------------- | ---- | ------------------ | -| options | [NamedRouterOptions](js-apis-router.md#namedrouteroptions10) | 是 | 替换页面描述信息。 | +| options | [router.NamedRouterOptions](js-apis-router.md#namedrouteroptions10) | 是 | 替换页面描述信息。 | | callback | AsyncCallback<void> | 是 | 异常响应回调。 | **错误码：** @@ -1266,7 +1326,7 @@ replaceNamedRoute(options: NamedRouterOptions, callback: AsyncCallback<void&g | 错误码ID | 错误信息 | | --------- | ------- | -| 100001 | if UI execution context not found. | +| 100001 | if UI execution context not found, only throw in standard system. | | 100004 | if the named route is not exist. | **示例：** @@ -1289,7 +1349,7 @@ router.replaceNamedRoute({ ### replaceNamedRoute -replaceNamedRoute(options: NamedRouterOptions, mode: RouterMode): Promise<void> +replaceNamedRoute(options: router.NamedRouterOptions, mode: router.RouterMode): Promise<void> 用指定的命名路由页面替换当前页面，并销毁被替换的页面。 @@ -1297,10 +1357,10 @@ replaceNamedRoute(options: NamedRouterOptions, mode: RouterMode): Promise<voi **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------------------------------- | ---- | ---------- | -| options | [NamedRouterOptions](js-apis-router.md#namedrouteroptions10) | 是 | 替换页面描述信息。 | -| mode | [RouterMode](js-apis-router.md#routermode9) | 是 | 跳转页面使用的模式。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------------------------------------------------------------ | ---- | -------------------- | +| options | [router.NamedRouterOptions](js-apis-router.md#namedrouteroptions10) | 是 | 替换页面描述信息。 | +| mode | [router.RouterMode](js-apis-router.md#routermode9) | 是 | 跳转页面使用的模式。 | **返回值：** @@ -1315,7 +1375,7 @@ replaceNamedRoute(options: NamedRouterOptions, mode: RouterMode): Promise<voi | 错误码ID | 错误信息 | | --------- | ------- | -| 100001 | if can not get the delegate. | +| 100001 | if the pages are pushed too much. | | 100004 | if the named route is not exist. | **示例：** @@ -1348,8 +1408,8 @@ replaceNamedRoute(options: NamedRouterOptions, mode: RouterMode, callback: Async | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------------------- | ---- | ---------- | -| options | [NamedRouterOptions](js-apis-router.md#namedrouteroptions10) | 是 | 替换页面描述信息。 | -| mode | [RouterMode](js-apis-router.md#routermode9) | 是 | 跳转页面使用的模式。 | +| options | [router.NamedRouterOptions](js-apis-router.md#namedrouteroptions10) | 是 | 替换页面描述信息。 | +| mode | [router.RouterMode](js-apis-router.md#routermode9) | 是 | 跳转页面使用的模式。 | | callback | AsyncCallback<void> | 是 | 异常响应回调。 | **错误码：** @@ -1358,7 +1418,7 @@ replaceNamedRoute(options: NamedRouterOptions, mode: RouterMode, callback: Async | 错误码ID | 错误信息 | | --------- | ------- | -| 100001 | if UI execution context not found. | +| 100001 | if UI execution context not found, only throw in standard system. | | 100004 | if the named route is not exist. | **示例：** @@ -1381,7 +1441,7 @@ router.replaceNamedRoute({ ### back -back(options?: RouterOptions ): void +back(options?: router.RouterOptions ): void 返回上一页面或指定的页面。 @@ -1389,9 +1449,9 @@ back(options?: RouterOptions ): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------------------------------- | ---- | ------------------------------------------------------------ | -| options | [RouterOptions](js-apis-router.md#routeroptions) | 否 | 返回页面描述信息，其中参数url指路由跳转时会返回到指定url的界面，如果页面栈上没有url页面，则不响应该情况。如果url未设置，则返回上一页，页面不会重新构建，页面栈里面的page不会回收，出栈后会被回收。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ | +| options | [router.RouterOptions](js-apis-router.md#routeroptions) | 否 | 返回页面描述信息，其中参数url指路由跳转时会返回到指定url的界面，如果页面栈上没有url页面，则不响应该情况。如果url未设置，则返回上一页，页面不会重新构建，页面栈里面的page不会回收，出栈后会被回收。 | **示例：** @@ -1439,7 +1499,7 @@ console.log('pages stack size = ' + size); ### getState -getState(): RouterState +getState(): router.RouterState 获取当前页面的状态信息。 @@ -1463,7 +1523,7 @@ console.log('current path = ' + page.path); ### showAlertBeforeBackPage -showAlertBeforeBackPage(options: EnableAlertOptions): void +showAlertBeforeBackPage(options: router.EnableAlertOptions): void 开启页面返回询问对话框。 @@ -1471,9 +1531,9 @@ showAlertBeforeBackPage(options: EnableAlertOptions): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ---------------------------------------- | ---- | --------- | -| options | [EnableAlertOptions](js-apis-router.md#enablealertoptions) | 是 | 文本弹窗信息描述。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------------------------------------------------------------ | ---- | ------------------ | +| options | [router.EnableAlertOptions](js-apis-router.md#enablealertoptions) | 是 | 文本弹窗信息描述。 | **错误码：** @@ -1538,7 +1598,7 @@ router.getParams(); ### showToast -showToast(options: ShowToastOptions): void +showToast(options: promptAction.ShowToastOptions): void 创建并显示文本提示框。 @@ -1546,9 +1606,9 @@ showToast(options: ShowToastOptions): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------------------------------------- | ---- | ------- | -| options | [ShowToastOptions](js-apis-promptAction.md#showtoastoptions) | 是 | 文本弹窗选项。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------------------------------------------------------------ | ---- | -------------- | +| options | [promptAction.ShowToastOptions](js-apis-promptAction.md#showtoastoptions) | 是 | 文本弹窗选项。 | **错误码：** @@ -1574,7 +1634,7 @@ try { ### showDialog -showDialog(options: ShowDialogOptions, callback: AsyncCallback<ShowDialogSuccessResponse<): void +showDialog(options: promptAction.ShowDialogOptions, callback: AsyncCallback<ShowDialogSuccessResponse<): void 创建并显示对话框，对话框响应结果异步返回。 @@ -1582,10 +1642,10 @@ showDialog(options: ShowDialogOptions, callback: AsyncCallback<ShowDialogSucc **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------------- | ---- | ------------ | -| options | [ShowDialogOptions](js-apis-promptAction.md#showdialogoptions) | 是 | 页面显示对话框信息描述。 | -| callback | AsyncCallback<[ShowDialogSuccessResponse](js-apis-promptAction.md#showdialogsuccessresponse)> | 是 | 对话框响应结果回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ------------------------ | +| options | [promptAction.ShowDialogOptions](js-apis-promptAction.md#showdialogoptions) | 是 | 页面显示对话框信息描述。 | +| callback | AsyncCallback<[promptAction.ShowDialogSuccessResponse](js-apis-promptAction.md#showdialogsuccessresponse)> | 是 | 对话框响应结果回调。 | **错误码：** @@ -1627,7 +1687,7 @@ try { ### showDialog -showDialog(options: ShowDialogOptions): Promise<ShowDialogSuccessResponse> +showDialog(options: promptAction.ShowDialogOptions): Promise<promptAction.ShowDialogSuccessResponse> 创建并显示对话框，对话框响应后同步返回结果。 @@ -1635,15 +1695,15 @@ showDialog(options: ShowDialogOptions): Promise<ShowDialogSuccessResponse> **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | --------------------------------------- | ---- | ------ | -| options | [ShowDialogOptions](js-apis-promptAction.md#showdialogoptions) | 是 | 对话框选项。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------------------------------------------------------------ | ---- | ------------ | +| options | [promptAction.ShowDialogOptions](js-apis-promptAction.md#showdialogoptions) | 是 | 对话框选项。 | **返回值：** -| 类型 | 说明 | -| ---------------------------------------- | -------- | -| Promise<[ShowDialogSuccessResponse](js-apis-promptAction.md#showdialogsuccessresponse)> | 对话框响应结果。 | +| 类型 | 说明 | +| ------------------------------------------------------------ | ---------------- | +| Promise<[promptAction.ShowDialogSuccessResponse](js-apis-promptAction.md#showdialogsuccessresponse)> | 对话框响应结果。 | **错误码：** @@ -1685,7 +1745,7 @@ try { ### showActionMenu -showActionMenu(options: ActionMenuOptions, callback: AsyncCallback<ActionMenuSuccessResponse>):void +showActionMenu(options: promptAction.ActionMenuOptions, callback: AsyncCallback<promptAction.ActionMenuSuccessResponse>):void 创建并显示操作菜单，菜单响应结果异步返回。 @@ -1693,10 +1753,10 @@ showActionMenu(options: ActionMenuOptions, callback: AsyncCallback<ActionMenu **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------------- | ---- | --------- | -| options | [ActionMenuOptions](js-apis-promptAction.md#actionmenuoptions) | 是 | 操作菜单选项。 | -| callback | AsyncCallback<[ActionMenuSuccessResponse](js-apis-promptAction.md#actionmenusuccessresponse)> | 是 | 菜单响应结果回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ------------------ | +| options | [promptAction.ActionMenuOptions](js-apis-promptAction.md#actionmenuoptions) | 是 | 操作菜单选项。 | +| callback | AsyncCallback<[promptAction.ActionMenuSuccessResponse](js-apis-promptAction.md#actionmenusuccessresponse)> | 是 | 菜单响应结果回调。 | **错误码：** @@ -1737,7 +1797,7 @@ try { ### showActionMenu -showActionMenu(options: ActionMenuOptions): Promise<ActionMenuSuccessResponse> +showActionMenu(options: promptAction.ActionMenuOptions): Promise<promptAction.ActionMenuSuccessResponse> 创建并显示操作菜单，菜单响应后同步返回结果。 @@ -1745,15 +1805,15 @@ showActionMenu(options: ActionMenuOptions): Promise<ActionMenuSuccessResponse **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | --------------------------------------- | ---- | ------- | -| options | [ActionMenuOptions](js-apis-promptAction.md#actionmenuoptions) | 是 | 操作菜单选项。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------------------------------------------------------------ | ---- | -------------- | +| options | [promptAction.ActionMenuOptions](js-apis-promptAction.md#actionmenuoptions) | 是 | 操作菜单选项。 | **返回值：** -| 类型 | 说明 | -| ---------------------------------------- | ------- | -| Promise<[ActionMenuSuccessResponse](js-apis-promptAction.md#actionmenusuccessresponse)> | 菜单响应结果。 | +| 类型 | 说明 | +| ------------------------------------------------------------ | -------------- | +| Promise<[promptAction.ActionMenuSuccessResponse](js-apis-promptAction.md#actionmenusuccessresponse)> | 菜单响应结果。 | **错误码：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-arkui-drawableDescriptor.md b/zh-cn/application-dev/reference/apis/js-apis-arkui-drawableDescriptor.md index 04db0491c8840ebceb20d97923b72b3f5c2e6ea0..2edb2c86cf6b78a3c9f31b2267780a1a711b03e0 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-arkui-drawableDescriptor.md +++ b/zh-cn/application-dev/reference/apis/js-apis-arkui-drawableDescriptor.md @@ -80,7 +80,8 @@ getPixelMap(): image.PixelMap; **示例：** ```ts -pixmap: PixelMap = ( (this.resManager.getDrawableDescriptor($r('app.media.icon') +let resManager = getContext().resourceManager +pixmap: PixelMap = ( (resManager.getDrawableDescriptor($r('app.media.icon') .id))).getPixelMap(); ``` @@ -99,7 +100,8 @@ getPixelMap(): image.PixelMap; **示例：** ```ts -pixmap: PixelMap = ( (this.resManager.getDrawableDescriptor($r('app.media.drawable') +let resManager = getContext().resourceManager +pixmap: PixelMap = ( (resManager.getDrawableDescriptor($r('app.media.drawable') .id))).getPixelMap(); ``` @@ -118,7 +120,8 @@ getForeground(): DrawableDescriptor; **示例：** ```ts -drawable: DrawableDescriptor = ( (this.resManager.getDrawableDescriptor($r('app.media.drawable') +let resManager = getContext().resourceManager +drawable: DrawableDescriptor = ( (resManager.getDrawableDescriptor($r('app.media.drawable') .id))).getForeground(); ``` @@ -137,7 +140,8 @@ getBackground(): DrawableDescriptor; **示例：** ```ts -drawable: DrawableDescriptor = ( (this.resManager.getDrawableDescriptor($r('app.media.drawable') +let resManager = getContext().resourceManager +drawable: DrawableDescriptor = ( (resManager.getDrawableDescriptor($r('app.media.drawable') .id))).getBackground(); ``` @@ -156,7 +160,8 @@ getMask(): DrawableDescriptor; **示例：** ```ts -drawable: DrawableDescriptor = ( (this.resManager.getDrawableDescriptor($r('app.media.drawable') +let resManager = getContext().resourceManager +drawable: DrawableDescriptor = ( (resManager.getDrawableDescriptor($r('app.media.drawable') .id))).getMask(); ``` ## LayeredDrawableDescriptor.getMashClipPath diff --git a/zh-cn/application-dev/reference/apis/js-apis-arkui-inspector.md b/zh-cn/application-dev/reference/apis/js-apis-arkui-inspector.md index 8fb448542e1e272f929928266abd1e7f30bb9d56..856650219b920e72fe0c190f6a6326c9d705ca5a 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-arkui-inspector.md +++ b/zh-cn/application-dev/reference/apis/js-apis-arkui-inspector.md @@ -48,7 +48,7 @@ let listener = inspector.createComponentObserver('COMPONENT_ID'); //监听id为C on(type: 'layout', callback: () => void): void -通过句柄向对应的查询条件注册回调，当组件布局或者绘制完成时会触发该回调。 +通过句柄向对应的查询条件注册回调，当组件布局完成时会触发该回调。 **系统能力：** SystemCapability.ArkUI.ArkUI.Full @@ -63,7 +63,7 @@ on(type: 'layout', callback: () => void): void off(type: 'layout', callback?: () => void): void -通过句柄向对应的查询条件取消注册回调，当组件布局或者绘制完成时不在触发指定的回调。 +通过句柄向对应的查询条件取消注册回调，当组件布局完成时不在触发指定的回调。 **系统能力：** SystemCapability.ArkUI.ArkUI.Full @@ -71,9 +71,39 @@ off(type: 'layout', callback?: () => void): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | -------------------------------------------- | -| type | string | 是 | 必须填写字符串'layout'或‘draw’。
layout: 组件布局完成。
draw: 组件绘制完成。 | +| type | string | 是 | 必须填写字符串'layout'或'draw'。
layout: 组件布局完成。
draw: 组件绘制完成。 | | callback | void | 否 | 需要取消注册的回调，如果参数缺省则取消注册该句柄下所有的回调。| +### on + +on(type: 'draw', callback: () => void): void + +通过句柄向对应的查询条件注册回调，当组件绘制完成时会触发该回调。 + +**系统能力：** SystemCapability.ArkUI.ArkUI.Full + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | ------------------------------------------------------------ | +| type | string | 是 | 必须填写字符串'layout'或'draw'。
layout: 组件布局完成。
draw: 组件绘制完成。 | +| callback | void | 是 | 监听layout或draw的回调。 | + +### off + +off(type: 'draw', callback?: () => void): void + +通过句柄向对应的查询条件取消注册回调，当组件绘制完成时不在触发指定的回调。 + +**系统能力：** SystemCapability.ArkUI.ArkUI.Full + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | ------------------------------------------------------------ | +| type | string | 是 | 必须填写字符串'layout'或'draw'。
layout: 组件布局完成。
draw: 组件绘制完成。 | +| callback | void | 否 | 需要取消注册的回调，如果参数缺省则取消注册该句柄下所有的回调。 | + **示例：** ```ts diff --git a/zh-cn/application-dev/reference/apis/js-apis-componentUtils.md b/zh-cn/application-dev/reference/apis/js-apis-componentUtils.md index 62f58c3d7b8b52cc81e64f8cdc5fa6c5a5a4cdb0..2487571099713a649765f6f9b1b7792376147290 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-componentUtils.md +++ b/zh-cn/application-dev/reference/apis/js-apis-componentUtils.md @@ -43,80 +43,100 @@ let modePosition = componentUtils.getRectangleById("onClick"); ## ComponentInfo -| 名称 | 类型 | 说明 | -| ---------------|------------ | -----------------------------| -| size | [Size](#size) | 组件大小。 | -| localOffset | [Offset](#offset) | 组件相对于父组件信息。 | -| windowOffset | [Offset](#offset) | 组件相对于窗口信息。 | -| screenOffset | [Offset](#offset) | 组件相对于屏幕信息。 | -| translate | [TranslateResult](#translateresult) | 组件平移信息。 | -| scale | [ScaleResult](#scaleresult) | 组件缩放信息。 | -| rotate | [RotateResult](#rotateresult) | 组件旋转信息。 | -| transform | [Matrix4Result](#matrix4result) | 仿射矩阵信息，根据入参创建的四阶矩阵对象。 | +**系统能力：** SystemCapability.ArkUI.ArkUI.Full + +| 名称 | 类型 | 必填 | 说明 | +| ---------------|------------ | -----------------------------| -----------------------------| +| size | [Size](#size) | 是 | 组件大小。 | +| localOffset | [Offset](#offset) | 是 | 组件相对于父组件信息。 | +| windowOffset | [Offset](#offset) | 是 | 组件相对于窗口信息。 | +| screenOffset | [Offset](#offset) | 是 | 组件相对于屏幕信息。 | +| translate | [TranslateResult](#translateresult) | 是 | 组件平移信息。 | +| scale | [ScaleResult](#scaleresult) | 是 | 组件缩放信息。 | +| rotate | [RotateResult](#rotateresult) | 是 | 组件旋转信息。 | +| transform | [Matrix4Result](#matrix4result) | 是 | 仿射矩阵信息，根据入参创建的四阶矩阵对象。 | ### Size -| 名称 | 类型 | 说明 | -| -------- | ---- | ----------------------------------| -| width | number | 组件宽度。 | -| height | number | 组件高度。 | +**系统能力：** SystemCapability.ArkUI.ArkUI.Full + +| 名称 | 类型 | 必填 | 说明 | +| -------- | ---- | ----------------------------------| ----------------------------------| +| width | number | 是 | 组件宽度。 | +| height | number | 是 | 组件高度。 | ### Offset -| 名称 | 类型 | 说明 | -| --------| ---- | -----------------------------------| -| x | number | x点坐标。 | -| y | number | y点坐标。 | +**系统能力：** SystemCapability.ArkUI.ArkUI.Full + +| 名称 | 类型 | 必填 | 说明 | +| --------| ---- | -----------------------------------| -----------------------------------| +| x | number | 是 | x点坐标。 | +| y | number | 是 | y点坐标。 | ### TranslateResult -| 名称 | 类型 | 说明 | -| --------| ---- | -----------------------------------| -| x | number | x轴平移距离。 | -| y | number | y轴平移距离。 | -| z | number | z轴平移距离。 | +**系统能力：** SystemCapability.ArkUI.ArkUI.Full + +| 名称 | 类型 | 必填 | 说明 | +| --------| ---- | -----------------------------------| -----------------------------------| +| x | number | 是 | x轴平移距离。 | +| y | number | 是 | y轴平移距离。 | +| z | number | 是 | z轴平移距离。 | ### ScaleResult -| 名称 | 类型 | 说明 | -| --------| ---- | -----------------------------------| -| x | number | x轴缩放倍数。 | -| y | number | y轴缩放倍数。 | -| z | number | z轴缩放倍数。 | -| centerX | number | 变换中心点x轴坐标。 | -| centerY | number | 变换中心点y轴坐标。。 | +**系统能力：** SystemCapability.ArkUI.ArkUI.Full + +| 名称 | 类型 | 必填 | 说明 | +| --------| ---- | -----------------------------------| -----------------------------------| +| x | number | 是 | x轴缩放倍数。 | +| y | number | 是 | y轴缩放倍数。 | +| z | number | 是 | z轴缩放倍数。 | +| centerX | number | 是 | 变换中心点x轴坐标。 | +| centerY | number | 是 | 变换中心点y轴坐标。。 | ### RotateResult -| 名称 | 类型 | 说明 | -| --------| ---- | -----------------------------------| -| x | number | 旋转轴向量x坐标。 | -| y | number | 旋转轴向量y坐标。 | -| z | number | 旋转轴向量z坐标。 | -| angle | number | 旋转角度。 | -| centerX | number | 变换中心点x轴坐标。 | -| centerY | number | 变换中心点y轴坐标。 | +**系统能力：** SystemCapability.ArkUI.ArkUI.Full + +| 名称 | 类型 | 必填 | 说明 | +| --------| ---- | -----------------------------------| -----------------------------------| +| x | number | 是 | 旋转轴向量x坐标。 | +| y | number | 是 | 旋转轴向量y坐标。 | +| z | number | 是 | 旋转轴向量z坐标。 | +| angle | number | 是 | 旋转角度。 | +| centerX | number | 是 | 变换中心点x轴坐标。 | +| centerY | number | 是 | 变换中心点y轴坐标。 | ### Matrix4Result -| 名称 | 类型 | 说明 | -| --------| ---- | -----------------------------------| -| number | number | x轴缩放值，单位矩阵默认为1。 | -| number | number | 第2个值，xyz轴旋转会影响这个值。 | -| number | number | 第3个值，xyz轴旋转会影响这个值。 | -| number | number | 无实际意义。 | -| number | number | 第5个值，xyz轴旋转会影响这个值。 | -| number | number | y轴缩放值，单位矩阵默认为1。 | -| number | number | 第7个值，xyz轴旋转会影响这个值。 | -| number | number | 无实际意义。 | -| number | number | 第9个值，xyz轴旋转会影响这个值。 | -| number | number | 第10个值，xyz轴旋转会影响这个值。 | -| number | number | z轴缩放值，单位矩阵默认为1。 | -| number | number | 无实际意义。 | -| number | number | x轴平移值，单位矩阵默认为0。 | -| number | number | y轴平移值，单位矩阵默认为0。 | -| number | number | z轴平移值，单位矩阵默认为0。 | -| number | number | 齐次坐标下生效，产生透视投影效果。 | +**系统能力：** SystemCapability.ArkUI.ArkUI.Full + +| 取值范围 | 说明 | +| --------| -----------------------------------| +| [number,number,number,number,
number,number,number,number,
number,number,number,number,
number,number,number,number] | 取值范围为长度为16（4\*4）的number数组, 详情见四阶矩阵说明。 | + +**四阶矩阵说明：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------------ | +| m00 | number | 是 | x轴缩放值，单位矩阵默认为1。 | +| m01 | number | 是 | 第2个值，xyz轴旋转会影响这个值。 | +| m02 | number | 是 | 第3个值，xyz轴旋转会影响这个值。 | +| m03 | number | 是 | 无实际意义。 | +| m10 | number | 是 | 第5个值，xyz轴旋转会影响这个值。 | +| m11 | number | 是 | y轴缩放值，单位矩阵默认为1。 | +| m12 | number | 是 | 第7个值，xyz轴旋转会影响这个值。 | +| m13 | number | 是 | 无实际意义。 | +| m20 | number | 是 | 第9个值，xyz轴旋转会影响这个值。 | +| m21 | number | 是 | 第10个值，xyz轴旋转会影响这个值。 | +| m22 | number | 是 | z轴缩放值，单位矩阵默认为1。 | +| m23 | number | 是 | 无实际意义。 | +| m30 | number | 是 | x轴平移值，单位px，单位矩阵默认为0。 | +| m31 | number | 是 | y轴平移值，单位px，单位矩阵默认为0。 | +| m32 | number | 是 | z轴平移值，单位px，单位矩阵默认为0。 | +| m33 | number | 是 | 齐次坐标下生效，产生透视投影效果。 | **示例：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-curve.md b/zh-cn/application-dev/reference/apis/js-apis-curve.md index e4613c22133d79781486ca2e11bd04f0843b493c..4b2bbe26b3515deb3ad24289406350645272e038 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-curve.md +++ b/zh-cn/application-dev/reference/apis/js-apis-curve.md @@ -41,7 +41,7 @@ initCurve(curve?: Curve): ICurve **系统能力：** SystemCapability.ArkUI.ArkUI.Full -| 名称 | 描述 | +| 名称 | 说明 | | ------------------- | ------------------------------------------------------------ | | Linear | 表示动画从头到尾的速度都是相同的。 | | Ease | 表示动画以低速开始，然后加快，在结束前变慢，CubicBezier(0.25, 0.1, 0.25, 1.0)。 | @@ -282,7 +282,7 @@ import Curves from '@ohos.curves' interpolate(fraction) { return Math.sqrt(fraction); } -private curve = Curves.customCurve(this.interpolate) // 创建一个用户自定义插值曲线 +let curve = Curves.customCurve(interpolate) // 创建一个用户自定义插值曲线 ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-font.md b/zh-cn/application-dev/reference/apis/js-apis-font.md index 0cd35ce7ca5352a1eb4affb0a5d9a58c33406976..dc84f048f7998c5ebfa0492af21ed4dab2add110 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-font.md +++ b/zh-cn/application-dev/reference/apis/js-apis-font.md @@ -138,7 +138,7 @@ getFontByName(fontName: string): FontInfo; | ---------------- | ---------------------------- | | FontInfo | 字体的详细信息 | -## FontInfo +## FontInfo10+ **系统能力：** SystemCapability.ArkUI.ArkUI.Full @@ -170,7 +170,7 @@ struct FontExample { Column() { Button("getFontByName") .onClick(() => { - this.fontInfo = font.getFontByName('HarmonyOS Sans Italic') + this.fontInfo = font.getFontByName('Sans Italic') console.log("getFontByName(): path = " + this.fontInfo.path) console.log("getFontByName(): postScriptName = " + this.fontInfo.postScriptName) console.log("getFontByName(): fullName = " + this.fontInfo.fullName) diff --git a/zh-cn/application-dev/reference/apis/js-apis-matrix4.md b/zh-cn/application-dev/reference/apis/js-apis-matrix4.md index 28c94b5cc90b09fe7d691cc9f00230bd2cabbc96..5600a5521366ff4bb9bd2c578d8222e28d681d62 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-matrix4.md +++ b/zh-cn/application-dev/reference/apis/js-apis-matrix4.md @@ -27,7 +27,7 @@ Matrix的构造函数，可以通过传入的参数创建一个四阶矩阵， | 参数名 | 类型 | 必填 | 说明 | | ------ | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| option | [number,number,number,number,number,number,number,number,number,number,number,number,number,number,number,number] | 是 | 参数为长度为16（4\*4）的number数组, 详情见四阶矩阵说明。
默认值：
[1, 0, 0, 0,
0, 1, 0, 0,
0, 0, 1, 0,
0, 0, 0, 1] | +| option | [number,number,number,number,
number,number,number,number,
number,number,number,number,
number,number,number,number] | 是 | 参数为长度为16（4\*4）的number数组, 详情见四阶矩阵说明。
默认值：
[1, 0, 0, 0,
0, 1, 0, 0,
0, 0, 1, 0,
0, 0, 0, 1] | **返回值：** @@ -170,6 +170,132 @@ struct Test { ![zh-cn_image_0000001219744181](figures/zh-cn_image_0000001219744181.png) +## matrix4.invert(deprecated) + +invert(): Matrix4Transit + +Matrix的逆函数，可以返回一个当前矩阵对象的逆矩阵，即效果正好相反。 + +该接口从Api 10开始废弃。 + +**系统能力：** SystemCapability.ArkUI.ArkUI.Full + +**返回值：** + +| 类型 | 说明 | +| --------------------------------- | ---------------------- | +| [Matrix4Transit](#matrix4transit) | 当前矩阵的逆矩阵对象。 | + +## matrix4.combine(deprecated) + +combine(options: Matrix4Transit): Matrix4Transit + +Matrix的叠加函数，可以将两个矩阵的效果叠加起来生成一个新的矩阵对象。 + +该接口从Api 10开始废弃。 + +**系统能力：** SystemCapability.ArkUI.ArkUI.Full + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | --------------------------------- | ---- | ------------------ | +| option | [Matrix4Transit](#matrix4transit) | 是 | 待叠加的矩阵对象。 | + +**返回值：** + +| 类型 | 说明 | +| --------------------------------- | ---------------------- | +| [Matrix4Transit](#matrix4transit) | 当前矩阵的逆矩阵对象。 | + +## matrix4.translate(deprecated) + +translate(options: TranslateOption): Matrix4Transit + +Matrix的平移函数，可以为当前矩阵增加x轴/y轴/z轴平移效果。 + +该接口从Api 10开始废弃。 + +**系统能力：** SystemCapability.ArkUI.ArkUI.Full + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ----------------------------------- | ---- | -------------- | +| option | [TranslateOption](#translateoption) | 是 | 设置平移参数。 | + +**返回值：** + +| 类型 | 说明 | +| --------------------------------- | ---------------------- | +| [Matrix4Transit](#matrix4transit) | 当前矩阵的逆矩阵对象。 | + +## matrix4.scale(deprecated) + +scale(options: ScaleOption): Matrix4Transit + +Matrix的缩放函数，可以为当前矩阵增加x轴/y轴/z轴缩放效果。 + +该接口从Api 10开始废弃。 + +**系统能力：** SystemCapability.ArkUI.ArkUI.Full + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | --------------------------- | ---- | -------------- | +| option | [ScaleOption](#scaleoption) | 是 | 设置缩放参数。 | + +**返回值：** + +| 类型 | 说明 | +| --------------------------------- | ---------------------- | +| [Matrix4Transit](#matrix4transit) | 当前矩阵的逆矩阵对象。 | + +## matrix4.rotate(deprecated) + +rotate(options: RotateOption): Matrix4Transit + +Matrix的旋转函数，可以为当前矩阵增加x轴/y轴/z轴旋转效果。 + +该接口从Api 10开始废弃。 + +**系统能力：** SystemCapability.ArkUI.ArkUI.Full + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ----------------------------- | ---- | -------------- | +| option | [RotateOption](#rotateoption) | 是 | 设置旋转参数。 | + +**返回值：** + +| 类型 | 说明 | +| --------------------------------- | ---------------------- | +| [Matrix4Transit](#matrix4transit) | 当前矩阵的逆矩阵对象。 | + +## matrix4.transformPoint(deprecated) + +transformPoint(options: [number, number]): [number, number] + +Matrix的坐标点转换函数，可以将当前的变换效果作用到一个坐标点上。 + +该接口从Api 10开始废弃。 + +**系统能力：** SystemCapability.ArkUI.ArkUI.Full + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ---------------- | ---- | ------------------ | +| option | [number, number] | 是 | 需要转换的坐标点。 | + +**返回值：** + +| 类型 | 说明 | +| ---------------- | --------------------------- | +| [number, number] | 返回矩阵变换后的Point对象。 | + ## Matrix4Transit @@ -330,7 +456,6 @@ Matrix的缩放函数，可以为当前矩阵增加x轴/y轴/z轴缩放效果。 | ------ | --------------------------- | ---- | -------------- | | option | [ScaleOption](#scaleoption) | 是 | 设置缩放参数。 | - **返回值：** | 类型 | 说明 | @@ -375,7 +500,6 @@ Matrix的旋转函数，可以为当前矩阵增加x轴/y轴/z轴旋转效果。 | ------ | ----------------------------- | ---- | -------------- | | option | [RotateOption](#rotateoption) | 是 | 设置旋转参数。 | - **返回值：** | 类型 | 说明 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-router.md b/zh-cn/application-dev/reference/apis/js-apis-router.md index 6e695436e1cc0e61c9dcc4cd8a7ea3f0b8519f80..253c08240f07df3036f627b30a3d66a20434d782 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-router.md +++ b/zh-cn/application-dev/reference/apis/js-apis-router.md @@ -693,7 +693,7 @@ replaceNamedRoute(options: NamedRouterOptions, mode: RouterMode): Promise<voi | 错误码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. | | 100004 | if the named route is not exist. | **示例：**