From 3c0bf4d3052140613126edb7f39057c048896fe6 Mon Sep 17 00:00:00 2001 From: lixinnan Date: Mon, 4 Sep 2023 08:49:53 +0800 Subject: [PATCH] lixinnan1@huawei.com update UIContext Signed-off-by: lixinnan --- .../reference/apis/js-apis-animator.md | 28 +- .../reference/apis/js-apis-arkui-UIContext.md | 250 +++++++++++++----- .../apis/js-apis-arkui-componentSnapshot.md | 4 +- .../apis/js-apis-arkui-dragController.md | 40 +-- .../apis/js-apis-arkui-drawableDescriptor.md | 16 +- .../reference/apis/js-apis-arkui-inspector.md | 18 +- .../reference/apis/js-apis-system-app.md | 27 +- .../reference/apis/js-apis-uiappearance.md | 10 +- 8 files changed, 275 insertions(+), 118 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-animator.md b/zh-cn/application-dev/reference/apis/js-apis-animator.md index 85c18a6f42..8f522db3cc 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-animator.md +++ b/zh-cn/application-dev/reference/apis/js-apis-animator.md @@ -15,7 +15,7 @@ ## 导入模块 ```js -import animator from '@ohos.animator'; +import animator, { AnimatorResult } from '@ohos.animator'; ``` ## create9+ @@ -40,7 +40,7 @@ create(options: AnimatorOptions): AnimatorResult **示例：** ```js -import animator, { AnimatorOptions } from '@ohos.animator'; +import animator, { AnimatorResult } from '@ohos.animator'; let options: AnimatorOptions = { // xxx.js文件中不需要强调显式类型AnimatorOptions duration: 1500, @@ -328,7 +328,7 @@ export default { ### 基于TS扩展的声明式开发范式 ```ts -import animator from '@ohos.animator'; +import animator, { AnimatorResult } from '@ohos.animator'; @Entry @Component @@ -459,16 +459,18 @@ struct AnimatorTest { .onClick(() => { if (this.flag) { this.flag = false - this.backAnimator.reset({ - duration: 5000, - easing: "ease-in", - delay: 0, - fill: "none", - direction: "normal", - iterations: 4, - begin: 100, - end: 300 - }) + if(this.backAnimator){ + this.backAnimator.reset({ + duration: 5000, + easing: "ease-in", + delay: 0, + fill: "none", + direction: "normal", + iterations: 4, + begin: 100, + end: 300 + }) + } } else { console.info(this.TAG, 'Animation not ended') } 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 d3d0fe0f8b..3afa6875ef 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 @@ -356,7 +356,7 @@ uiContext.showDatePickerDialog({ selected: selectedDate, onAccept: (value: DatePickerResult) => { // 通过Date的setFullYear方法设置按下确定按钮时的日期，这样当弹窗再次弹出时显示选中的是上一次确定的日期 - selectedDate.setFullYear(value.year, value.month, value.day) + selectedDate.setFullYear(Number(value.year), Number(value.month), Number(value.day)) console.info("DatePickerDialog:onAccept()" + JSON.stringify(value)) }, onCancel: () => { @@ -500,6 +500,7 @@ createAnimator(options: AnimatorOptions): AnimatorResult **示例：** ```ts +import { AnimatorOptions } from '@ohos.animator'; let options:AnimatorOptions = { duration: 1500, easing: "friction", @@ -558,6 +559,7 @@ registerFont(options: font.FontOptions): void **示例：** ```ts +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; let font:Font = uiContext.getFont(); font.registerFont({ familyName: 'medium', @@ -581,7 +583,8 @@ getSystemFontList(): Array\ **示例：** ```ts -let font:Font = uiContext.getFont(); +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; +let font:Font|undefined = uiContext.getFont(); font.getSystemFontList() ``` @@ -608,7 +611,8 @@ getFontByName(fontName: string): font.FontInfo **示例：** ```ts -let font:Font = uiContext.getFont(); +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; +let font:Font|undefined = uiContext.getFont(); font.getFontByName('Sans Italic') ``` @@ -639,10 +643,11 @@ getRectangleById(id: string): componentUtils.ComponentInfo **示例：** ```ts +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; let componentUtils:ComponentUtils = uiContext.getComponentUtils(); -let modePosition:componentUtils.ComponentInfo = componentUtils.getRectangleById("onClick"); -let localOffsetWidth:object = modePosition.size.width; -let localOffsetHeight:object = modePosition.size.height; +let modePosition = componentUtils.getRectangleById("onClick"); +let localOffsetWidth = modePosition.size.width; +let localOffsetHeight = modePosition.size.height; ``` ## UIInspector @@ -672,6 +677,7 @@ createComponentObserver(id: string): inspector.ComponentObserver **示例：** ```ts +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; let inspector:UIInspector = uiContext.getUIInspector(); let listener = inspector.createComponentObserver('COMPONENT_ID'); ``` @@ -703,6 +709,7 @@ matchMediaSync(condition: string): mediaQuery.MediaQueryListener **示例：** ```ts +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; let mediaquery: MediaQuery = uiContext.getMediaQuery(); let listener = mediaquery.matchMediaSync('(orientation: landscape)'); //监听横屏事件 ``` @@ -744,6 +751,8 @@ pushUrl(options: router.RouterOptions): Promise<void> **示例：** ```ts +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; +import { BusinessError } from '@ohos.base'; let router = uiContext.getRouter(); try { router.pushUrl({ @@ -790,6 +799,8 @@ pushUrl(options: router.RouterOptions, callback: AsyncCallback<void>): voi **示例：** ```ts +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; +import { BusinessError } from '@ohos.base'; let router = uiContext.getRouter(); router.pushUrl({ url: 'pages/routerpage2', @@ -801,7 +812,9 @@ router.pushUrl({ } }, (err: Error) => { if (err) { - console.error(`pushUrl failed, code is ${err.code}, message is ${err.message}`); + let message = (err as BusinessError).message; + let code = (err as BusinessError).code; + console.error(`pushUrl failed, code is ${code}, message is ${message}`); return; } console.info('pushUrl success'); @@ -842,9 +855,16 @@ pushUrl(options: router.RouterOptions, mode: router.RouterMode): Promise<void **示例：** ```ts -let router = uiContext.getRouter(); +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; +import { BusinessError } from '@ohos.base'; +import router from '@ohos.router'; +let routerF:Router = uiContext.getRouter(); +class routerTmp{ + Standard:router.RouterMode = router.RouterMode.Standard +} +let rtm:routerTmp = new routerTmp() try { - router.pushUrl({ + routerF.pushUrl({ url: 'pages/routerpage2', params: { data1: 'message', @@ -852,7 +872,7 @@ try { data3: [123, 456, 789] } } - }, router.RouterMode.Standard) + }, rtm.Standard) } catch (err) { let message = (err as BusinessError).message; let code = (err as BusinessError).code; @@ -889,8 +909,15 @@ pushUrl(options: router.RouterOptions, mode: router.RouterMode, callback: AsyncC **示例：** ```ts -let router = uiContext.getRouter(); -router.pushUrl({ +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; +import { BusinessError } from '@ohos.base'; +import router from '@ohos.router'; +let routerF:Router = uiContext.getRouter(); +class routerTmp{ + Standard:router.RouterMode = router.RouterMode.Standard +} +let rtm:routerTmp = new routerTmp() +routerF.pushUrl({ url: 'pages/routerpage2', params: { data1: 'message', @@ -898,9 +925,11 @@ router.pushUrl({ data3: [123, 456, 789] } } -}, router.RouterMode.Standard, (err) => { +}, rtm.Standard, (err) => { if (err) { - console.error(`pushUrl failed, code is ${err.code}, message is ${err.message}`); + let message = (err as BusinessError).message; + let code = (err as BusinessError).code; + console.error(`pushUrl failed, code is ${code}, message is ${message}`); return; } console.info('pushUrl success'); @@ -939,6 +968,8 @@ replaceUrl(options: router.RouterOptions): Promise<void> **示例：** ```ts +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; +import { BusinessError } from '@ohos.base'; let router = uiContext.getRouter(); try { router.replaceUrl({ @@ -981,6 +1012,8 @@ replaceUrl(options: router.RouterOptions, callback: AsyncCallback<void>): **示例：** ```ts +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; +import { BusinessError } from '@ohos.base'; let router = uiContext.getRouter(); router.replaceUrl({ url: 'pages/detail', @@ -989,7 +1022,9 @@ router.replaceUrl({ } }, (err: Error) => { if (err) { - console.error(`replaceUrl failed, code is ${err.code}, message is ${err.message}`); + let message = (err as BusinessError).message; + let code = (err as BusinessError).code; + console.error(`replaceUrl failed, code is ${code}, message is ${message}`); return; } console.info('replaceUrl success'); @@ -1029,14 +1064,21 @@ replaceUrl(options: router.RouterOptions, mode: router.RouterMode): Promise<v **示例：** ```ts -let router = uiContext.getRouter(); +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; +import { BusinessError } from '@ohos.base'; +import router from '@ohos.router'; +let routerF:Router = uiContext.getRouter(); +class routerTmp{ + Standard:router.RouterMode = router.RouterMode.Standard +} +let rtm:routerTmp = new routerTmp() try { - router.replaceUrl({ + routerF.replaceUrl({ url: 'pages/detail', params: { data1: 'message' } - }, router.RouterMode.Standard) + }, rtm.Standard) } catch (err) { let message = (err as BusinessError).message; let code = (err as BusinessError).code; @@ -1072,15 +1114,24 @@ replaceUrl(options: router.RouterOptions, mode: router.RouterMode, callback: Asy **示例：** ```ts -let router = uiContext.getRouter(); -router.replaceUrl({ +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; +import { BusinessError } from '@ohos.base'; +import router from '@ohos.router'; +let routerF:Router = uiContext.getRouter(); +class routerTmp{ + Standard:router.RouterMode = router.RouterMode.Standard +} +let rtm:routerTmp = new routerTmp() +routerF.replaceUrl({ url: 'pages/detail', params: { data1: 'message' } -}, router.RouterMode.Standard, (err: Error) => { +}, rtm.Standard, (err: Error) => { if (err) { - console.error(`replaceUrl failed, code is ${err.code}, message is ${err.message}`); + let message = (err as BusinessError).message; + let code = (err as BusinessError).code; + console.error(`replaceUrl failed, code is ${code}, message is ${message}`); return; } console.info('replaceUrl success'); @@ -1120,6 +1171,8 @@ pushNamedRoute(options: router.NamedRouterOptions): Promise<void> **示例：** ```ts +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; +import { BusinessError } from '@ohos.base'; let router = uiContext.getRouter(); try { router.pushNamedRoute({ @@ -1166,6 +1219,8 @@ pushNamedRoute(options: router.NamedRouterOptions, callback: AsyncCallback<vo **示例：** ```ts +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; +import { BusinessError } from '@ohos.base'; let router = uiContext.getRouter(); router.pushNamedRoute({ name: 'myPage', @@ -1177,7 +1232,9 @@ router.pushNamedRoute({ } }, (err: Error) => { if (err) { - console.error(`pushNamedRoute failed, code is ${err.code}, message is ${err.message}`); + let message = (err as BusinessError).message; + let code = (err as BusinessError).code; + console.error(`pushNamedRoute failed, code is ${code}, message is ${message}`); return; } console.info('pushNamedRoute success'); @@ -1217,9 +1274,16 @@ pushNamedRoute(options: router.NamedRouterOptions, mode: router.RouterMode): Pro **示例：** ```ts -let router = uiContext.getRouter(); +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; +import { BusinessError } from '@ohos.base'; +import router from '@ohos.router'; +let routerF:Router = uiContext.getRouter(); +class routerTmp{ + Standard:router.RouterMode = router.RouterMode.Standard +} +let rtm:routerTmp = new routerTmp() try { - router.pushNamedRoute({ + routerF.pushNamedRoute({ name: 'myPage', params: { data1: 'message', @@ -1227,7 +1291,7 @@ try { data3: [123, 456, 789] } } - }, router.RouterMode.Standard) + }, rtm.Standard) } catch (err) { let message = (err as BusinessError).message; let code = (err as BusinessError).code; @@ -1264,8 +1328,15 @@ pushNamedRoute(options: router.NamedRouterOptions, mode: router.RouterMode, call **示例：** ```ts -let router = uiContext.getRouter(); -router.pushNamedRoute({ +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; +import { BusinessError } from '@ohos.base'; +import router from '@ohos.router'; +let routerF:Router = uiContext.getRouter(); +class routerTmp{ + Standard:router.RouterMode = router.RouterMode.Standard +} +let rtm:routerTmp = new routerTmp() +routerF.pushNamedRoute({ name: 'myPage', params: { data1: 'message', @@ -1273,9 +1344,11 @@ router.pushNamedRoute({ data3: [123, 456, 789] } } -}, router.RouterMode.Standard, (err: Error) => { +}, rtm.Standard, (err: Error) => { if (err) { - console.error(`pushNamedRoute failed, code is ${err.code}, message is ${err.message}`); + let message = (err as BusinessError).message; + let code = (err as BusinessError).code; + console.error(`pushNamedRoute failed, code is ${code}, message is ${message}`); return; } console.info('pushNamedRoute success'); @@ -1314,6 +1387,8 @@ replaceNamedRoute(options: router.NamedRouterOptions): Promise<void> **示例：** ```ts +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; +import { BusinessError } from '@ohos.base'; let router = uiContext.getRouter(); try { router.replaceNamedRoute({ @@ -1356,6 +1431,8 @@ replaceNamedRoute(options: router.NamedRouterOptions, callback: AsyncCallback< **示例：** ```ts +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; +import { BusinessError } from '@ohos.base'; let router = uiContext.getRouter(); router.replaceNamedRoute({ name: 'myPage', @@ -1364,7 +1441,9 @@ router.replaceNamedRoute({ } }, (err: Error) => { if (err) { - console.error(`replaceNamedRoute failed, code is ${err.code}, message is ${err.message}`); + let message = (err as BusinessError).message; + let code = (err as BusinessError).code; + console.error(`replaceNamedRoute failed, code is ${code}, message is ${message}`); return; } console.info('replaceNamedRoute success'); @@ -1405,14 +1484,21 @@ replaceNamedRoute(options: router.NamedRouterOptions, mode: router.RouterMode): **示例：** ```ts -let router = uiContext.getRouter(); +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; +import { BusinessError } from '@ohos.base'; +import router from '@ohos.router'; +let routerF:Router = uiContext.getRouter(); +class routerTmp{ + Standard:router.RouterMode = router.RouterMode.Standard +} +let rtm:routerTmp = new routerTmp() try { - router.replaceNamedRoute({ + routerF.replaceNamedRoute({ name: 'myPage', params: { data1: 'message' } - }, router.RouterMode.Standard) + }, rtm.Standard) } catch (err) { let message = (err as BusinessError).message; let code = (err as BusinessError).code; @@ -1448,15 +1534,24 @@ replaceNamedRoute(options: router.NamedRouterOptions, mode: router.RouterMode, c **示例：** ```ts -let router = uiContext.getRouter(); -router.replaceNamedRoute({ +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; +import { BusinessError } from '@ohos.base'; +import router from '@ohos.router'; +let routerF:Router = uiContext.getRouter(); +class routerTmp{ + Standard:router.RouterMode = router.RouterMode.Standard +} +let rtm:routerTmp = new routerTmp() +routerF.replaceNamedRoute({ name: 'myPage', params: { data1: 'message' } -}, router.RouterMode.Standard, (err: Error) => { +}, rtm.Standard, (err: Error) => { if (err) { - console.error(`replaceNamedRoute failed, code is ${err.code}, message is ${err.message}`); + let message = (err as BusinessError).message; + let code = (err as BusinessError).code; + console.error(`replaceNamedRoute failed, code is ${code}, message is ${message}`); return; } console.info('replaceNamedRoute success'); @@ -1480,6 +1575,8 @@ back(options?: router.RouterOptions ): void **示例：** ```ts +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; +import { BusinessError } from '@ohos.base'; let router: Router = uiContext.getRouter(); router.back({url:'pages/detail'}); ``` @@ -1495,6 +1592,8 @@ clear(): void **示例：** ```ts +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; +import { BusinessError } from '@ohos.base'; let router: Router = uiContext.getRouter(); router.clear(); ``` @@ -1516,6 +1615,8 @@ getLength(): string **示例：** ```ts +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; +import { BusinessError } from '@ohos.base'; let router: Router = uiContext.getRouter(); let size = router.getLength(); console.log('pages stack size = ' + size); @@ -1538,6 +1639,8 @@ getState(): router.RouterState **示例：** ```ts +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; +import { BusinessError } from '@ohos.base'; let router: Router = uiContext.getRouter(); let page = router.getState(); console.log('current index = ' + page.index); @@ -1570,6 +1673,8 @@ showAlertBeforeBackPage(options: router.EnableAlertOptions): void **示例：** ```ts +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; +import { BusinessError } from '@ohos.base'; let router: Router = uiContext.getRouter(); try { router.showAlertBeforeBackPage({ @@ -1593,6 +1698,8 @@ hideAlertBeforeBackPage(): void **示例：** ```ts +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; +import { BusinessError } from '@ohos.base'; let router: Router = uiContext.getRouter(); router.hideAlertBeforeBackPage(); ``` @@ -1614,6 +1721,8 @@ getParams(): Object **示例：** ```ts +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; +import { BusinessError } from '@ohos.base'; let router: Router = uiContext.getRouter(); router.getParams(); ``` @@ -1647,6 +1756,8 @@ showToast(options: promptAction.ShowToastOptions): void **示例：** ```ts +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; +import { BusinessError } from '@ohos.base'; let promptAction: PromptAction = uiContext.getPromptAction(); try { promptAction.showToast({ @@ -1686,6 +1797,8 @@ showDialog(options: promptAction.ShowDialogOptions, callback: AsyncCallback<p **示例：** ```ts +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; +import { BusinessError } from '@ohos.base'; class buttonsMoabl { text: string = "" color: string = "" @@ -1713,7 +1826,9 @@ try { console.info('showDialog success callback, click button: ' + data.index); }); } catch (error) { - console.error(`showDialog args error code is ${error.code}, message is ${error.message}`); + let message = (error as BusinessError).message; + let code = (error as BusinessError).code; + console.error(`showDialog args error code is ${code}, message is ${message}`); }; ``` @@ -1748,6 +1863,8 @@ showDialog(options: promptAction.ShowDialogOptions): Promise<promptAction.Sho **示例：** ```ts +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; +import { BusinessError } from '@ohos.base'; let promptAction: PromptAction = uiContext.getPromptAction(); try { promptAction.showDialog({ @@ -1803,27 +1920,40 @@ showActionMenu(options: promptAction.ActionMenuOptions, callback:promptAction.Ac **示例：** ```ts -let promptAction: PromptAction = uiContext.getPromptAction(); +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; +import promptAction from '@ohos.promptAction'; +import { BusinessError } from '@ohos.base'; +class buttonsMoabl { + text: string = "" + color: string = "" +} +class dataR{ + err:Error = new Error; + data:promptAction.ActionMenuSuccessResponse | undefined = undefined; +} +let dataAMSR:dataR = new dataR() +let promptActionF: PromptAction = uiContext.getPromptAction(); try { - promptAction.showActionMenu({ - title: 'Title Info', - buttons: [ - { - text: 'item1', - color: '#666666' - }, - { - text: 'item2', - color: '#000000' - }, - ] - }, (err:Error, data:promptAction.ActionMenuSuccessResponse) => { - if (err) { - console.info('showActionMenu err: ' + err); - return; + if(dataAMSR.data){ + promptActionF.showActionMenu({ + title: 'Title Info', + buttons: [ + { + text: 'item1', + color: '#666666' + } as buttonsMoabl, + { + text: 'item2', + color: '#000000' + } as buttonsMoabl + ] + }, (dataAMSR.data)) + if (dataAMSR.err) { + console.info('showActionMenu err: ' + dataAMSR.err); + }else{ + console.info('showActionMenu success callback, click button: ' + dataAMSR.data.index); } - console.info('showActionMenu success callback, click button: ' + data.index); - }) + } } catch (error) { let message = (error as BusinessError).message; let code = (error as BusinessError).code; @@ -1862,6 +1992,8 @@ showActionMenu(options: promptAction.ActionMenuOptions): Promise<promptAction **示例：** ```ts +import { ComponentUtils, Font, PromptAction, Router, UIInspector, MediaQuery } from '@ohos.arkui.UIContext'; +import { BusinessError } from '@ohos.base'; let promptAction: PromptAction = uiContext.getPromptAction(); try { promptAction.showActionMenu({ @@ -1888,4 +2020,4 @@ try { let code = (error as BusinessError).code; console.error(`showActionMenu args error code is ${code}, message is ${message}`); }; -``` +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-arkui-componentSnapshot.md b/zh-cn/application-dev/reference/apis/js-apis-arkui-componentSnapshot.md index f25d600c78..1bce56f123 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-arkui-componentSnapshot.md +++ b/zh-cn/application-dev/reference/apis/js-apis-arkui-componentSnapshot.md @@ -203,7 +203,7 @@ struct OffscreenSnapshotExample { Column() { Button("click to generate offscreen UI snapshot") .onClick(() => { - componentSnapshot.createFromBuilder(this.RandomBuilder.bind(this), + componentSnapshot.createFromBuilder(this.RandomBuilder(), (error: Error, pixmap: image.PixelMap) => { this.pixmap = pixmap // save pixmap to file @@ -280,7 +280,7 @@ struct OffscreenSnapshotExample { Column() { Button("click to generate offscreen UI snapshot") .onClick(() => { - componentSnapshot.createFromBuilder(this.RandomBuilder.bind(this)) + componentSnapshot.createFromBuilder(this.RandomBuilder()) .then((pixmap: image.PixelMap) => { this.pixmap = pixmap // save pixmap to file diff --git a/zh-cn/application-dev/reference/apis/js-apis-arkui-dragController.md b/zh-cn/application-dev/reference/apis/js-apis-arkui-dragController.md index 7934d66878..73bbc4b1cd 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-arkui-dragController.md +++ b/zh-cn/application-dev/reference/apis/js-apis-arkui-dragController.md @@ -37,7 +37,7 @@ executeDrag(custom: CustomBuilder | DragItemInfo, dragInfo: DragInfo, callback: ```ts import dragController from "@ohos.arkui.dragController" -import UDC from '@ohos.data.unifiedDataChannel'; +import UDMF from '@ohos.data.unifiedDataChannel'; @Entry @Component @@ -57,18 +57,23 @@ struct DragControllerPage { .onTouch((event?:TouchEvent) => { if(event){ if (event.type == TouchType.Down) { - let text:object = new UDMF.Text() - let unifiedData:object = new UDMF.UnifiedData(text) + let text = new UDMF.Text() + let unifiedData = new UDMF.UnifiedData(text) let dragInfo: dragController.DragInfo = { pointerId: 0, data: unifiedData, extraParams: '' } - dragController.executeDrag(this.DraggingBuilder.bind(this), dragInfo, (err, {event, extraParams}) => { - if (event.getResult() == DragResult.DRAG_SUCCESSFUL) { + class tmp{ + event:DragResult|undefined = undefined + extraParams:string = '' + } + let eve:tmp = new tmp() + dragController.executeDrag(this.DraggingBuilder(), dragInfo, (err, eve) => { + if (eve.event.getResult() == DragResult.DRAG_SUCCESSFUL) { // ... - } else if (event.getResult() == DragResult.DRAG_FAILED) { + } else if (eve.event.getResult() == DragResult.DRAG_FAILED) { // ... } }) @@ -107,7 +112,7 @@ executeDrag(custom: CustomBuilder | DragItemInfo, dragInfo: DragInfo): Promise&l import dragController from "@ohos.arkui.dragController" import componentSnapshot from '@ohos.arkui.componentSnapshot'; import image from '@ohos.multimedia.image'; -import UDC from '@ohos.data.unifiedDataChannel'; +import UDMF from '@ohos.data.unifiedDataChannel'; @Entry @Component @@ -138,31 +143,36 @@ struct DragControllerPage { .onTouch((event?:TouchEvent) => { if(event){ if (event.type == TouchType.Down) { - let text:object = new UDMF.Text() - let unifiedData:object = new UDMF.UnifiedData(text) + let text = new UDMF.Text() + let unifiedData = new UDMF.UnifiedData(text) let dragInfo: dragController.DragInfo = { pointerId: 0, data: unifiedData, extraParams: '' } - componentSnapshot.createFromBuilder(this.PixmapBuilder.bind(this)).then((pix: image.PixelMap) => { + componentSnapshot.createFromBuilder(this.PixmapBuilder()).then((pix: image.PixelMap) => { this.pixmap = pix; let dragItemInfo: DragItemInfo = { pixelMap: this.pixmap, - builder: this.DraggingBuilder.bind(this), + builder: this.DraggingBuilder(), extraInfo: "DragItemInfoTest" } + class tmp{ + event:DragResult|undefined = undefined + extraParams:string = '' + } + let eve:tmp = new tmp() dragController.executeDrag(dragItemInfo, dragInfo) - .then(({event, extraParams}) => { - if (event.getResult() == DragResult.DRAG_SUCCESSFUL) { + .then((eve) => { + if (eve.event.getResult() == DragResult.DRAG_SUCCESSFUL) { // ... - } else if (event.getResult() == DragResult.DRAG_FAILED) { + } else if (eve.event.getResult() == DragResult.DRAG_FAILED) { // ... } }) - .catch((err) => { + .catch((err:Error) => { }) }) } 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 fe16d841e7..02e7973dbd 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,10 +80,11 @@ getPixelMap(): image.PixelMap; **示例：** ```ts +import { DrawableDescriptor, LayeredDrawableDescriptor } from '@ohos.arkui.drawableDescriptor' let resManager = getContext().resourceManager let pixmap: DrawableDescriptor = (resManager.getDrawableDescriptor($r('app.media.icon') .id)) as DrawableDescriptor; -let pixmapNew: DrawableDescriptor = pixmap.getPixelMap() +let pixmapNew: object = pixmap.getPixelMap() ``` ## LayeredDrawableDescriptor.getPixelMap @@ -101,10 +102,11 @@ getPixelMap(): image.PixelMap; **示例：** ```ts +import { DrawableDescriptor, LayeredDrawableDescriptor } from '@ohos.arkui.drawableDescriptor' let resManager = getContext().resourceManager let pixmap: LayeredDrawableDescriptor = (resManager.getDrawableDescriptor($r('app.media.icon') .id)) as LayeredDrawableDescriptor; -let pixmapNew: LayeredDrawableDescriptor = pixmap.getPixelMap() +let pixmapNew: object = pixmap.getPixelMap() ``` ## LayeredDrawableDescriptor.getForeground @@ -122,10 +124,11 @@ getForeground(): DrawableDescriptor; **示例：** ```ts +import { DrawableDescriptor, LayeredDrawableDescriptor } from '@ohos.arkui.drawableDescriptor' let resManager = getContext().resourceManager let drawable: LayeredDrawableDescriptor = (resManager.getDrawableDescriptor($r('app.media.icon') .id)) as LayeredDrawableDescriptor; -let drawableNew: LayeredDrawableDescriptor =drawable.getForeground() +let drawableNew: object =drawable.getForeground() ``` ## LayeredDrawableDescriptor.getBackground @@ -143,10 +146,11 @@ getBackground(): DrawableDescriptor; **示例：** ```ts +import { DrawableDescriptor, LayeredDrawableDescriptor } from '@ohos.arkui.drawableDescriptor' let resManager = getContext().resourceManager let drawable: LayeredDrawableDescriptor = (resManager.getDrawableDescriptor($r('app.media.icon') .id)) as LayeredDrawableDescriptor; -let drawableNew: LayeredDrawableDescriptor =drawable.getBackground() +let drawableNew: object =drawable.getBackground() ``` ## LayeredDrawableDescriptor.getMask @@ -164,10 +168,11 @@ getMask(): DrawableDescriptor; **示例：** ```ts +import { DrawableDescriptor, LayeredDrawableDescriptor } from '@ohos.arkui.drawableDescriptor' let resManager = getContext().resourceManager let drawable: LayeredDrawableDescriptor = (resManager.getDrawableDescriptor($r('app.media.icon') .id)) as LayeredDrawableDescriptor; -let drawableNew: LayeredDrawableDescriptor =drawable.getMask() +let drawableNew: object =drawable.getMask() ``` ## LayeredDrawableDescriptor.getMaskClipPath static getMaskClipPath(): string @@ -184,6 +189,7 @@ LayeredDrawableDescriptor的静态方法，获取系统内置的裁切路径参 **示例：** ```ts +import { DrawableDescriptor, LayeredDrawableDescriptor } from '@ohos.arkui.drawableDescriptor' Image($r('app.media.icon')) .width('200px').height('200px') .clip(new Path({commands:LayeredDrawableDescriptor.getMaskClipPath()})) 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 c31e46948a..b955261668 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 @@ -129,19 +129,17 @@ off(type: 'draw', callback?: () => void): void listener:inspector.ComponentObserver = inspector.createComponentObserver('IMAGE_ID') aboutToAppear() { - let FuncLayout = this.onLayoutComplete.bind(this) // bind current js instance - let FuncDraw = this.onDrawComplete.bind(this) // bind current js instance + let onLayoutComplete:()=>void=():void=>{ + // do something here + } + let onDrawComplete:()=>void=():void=>{ + // do something here + } + let FuncLayout = onLayoutComplete // bind current js instance + let FuncDraw = onDrawComplete // bind current js instance this.listener.on('layout', FuncLayout) this.listener.on('draw', FuncDraw) } - - onLayoutComplete() { - // do something here - } - - onDrawComplete() { - // do something here - } } ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-app.md b/zh-cn/application-dev/reference/apis/js-apis-system-app.md index c749b29910..d1e4cbcca8 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-app.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-app.md @@ -9,7 +9,7 @@ ```ts -import app from '@system.app' +import app, { AppResponse } from '@system.app' ``` ## App @@ -33,9 +33,10 @@ static getInfo(): AppResponse **示例：** ```ts -export default { +import app, { AppResponse } from '@system.app' +export default class Info { getInfo() { - let info = app.getInfo() + let info:AppResponse = app.getInfo() console.log(JSON.stringify(info)) } } @@ -54,7 +55,8 @@ static terminate(): void **示例：** ```ts -export default { +import app, { AppResponse } from '@system.app' +export default class TerM { terminate() { app.terminate() } @@ -78,9 +80,9 @@ static setImageCacheCount(value: number): void ```ts // app.ets -import app from '@system.app' +import app, { AppResponse } from '@system.app' -export default { +export default class OnC { onCreate() { app.setImageCacheCount(100) // 设置解码后图片内存缓存上限为100张 console.info('Application onCreate') @@ -109,9 +111,9 @@ static setImageRawDataCacheSize(value: number): void ```ts // app.ets -import app from '@system.app' +import app, { AppResponse } from '@system.app' -export default { +export default class OnC { onCreate() { app.setImageRawDataCacheSize(104857600) // 设置解码前图片数据内存缓存上限为100MB (100MB=100*1024*1024B=104857600B) @@ -141,9 +143,9 @@ static setImageFileCacheSize(value: number): void ```ts // app.ets -import app from '@system.app' +import app, { AppResponse } from '@system.app' -export default { +export default class OnC { onCreate() { app.setImageFileCacheSize(209715200) // 设置图片文件数据缓存上限为200MB (200MB=200*1024*1024B=209715200B) @@ -188,13 +190,14 @@ static requestFullWindow(options?: RequestFullWindowOptions): void **示例：** ```ts -export default { +import app, { AppResponse } from '@system.app' +export default class Req { requestFullWindow() { app.requestFullWindow({ duration: 200 }) } -} +} ``` ## AppResponse diff --git a/zh-cn/application-dev/reference/apis/js-apis-uiappearance.md b/zh-cn/application-dev/reference/apis/js-apis-uiappearance.md index 16cc4ef9e0..8708b091a3 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-uiappearance.md +++ b/zh-cn/application-dev/reference/apis/js-apis-uiappearance.md @@ -57,6 +57,8 @@ setDarkMode(mode: DarkMode, callback: AsyncCallback\): void **示例：** ```ts +import uiAppearance from '@ohos.uiAppearance' +import { BusinessError } from '@ohos.base'; try { uiAppearance.setDarkMode(uiAppearance.DarkMode.ALWAYS_DARK, (error) => { if (error) { @@ -105,10 +107,12 @@ setDarkMode(mode: DarkMode): Promise\; **示例：** ```ts +import uiAppearance from '@ohos.uiAppearance' +import { BusinessError } from '@ohos.base'; try { uiAppearance.setDarkMode(uiAppearance.DarkMode.ALWAYS_DARK).then(() => { console.info('Set dark-mode successfully.'); - }).catch((error) => { + }).catch((error:Error) => { console.error('Set dark-mode failed, ' + error.message); }); } catch (error) { @@ -145,9 +149,11 @@ getDarkMode(): DarkMode; **示例：** ```ts +import uiAppearance from '@ohos.uiAppearance' +import { BusinessError } from '@ohos.base'; try { let darkMode = uiAppearance.getDarkMode(); - console.info('Get dark-mode ' + mode); + console.info('Get dark-mode ' + darkMode); } catch (error) { let message = (error as BusinessError).message; console.error('Get dark-mode failed, ' + message); -- GitLab