diff --git a/en/application-dev/application-dev-website.md b/en/application-dev/application-dev-website.md index eb1f7ff92a420cf62724b8697af56d26076e7cf1..d15949228c257024e6b1505febace0c02484b320 100644 --- a/en/application-dev/application-dev-website.md +++ b/en/application-dev/application-dev-website.md @@ -1,25 +1,21 @@ -- [Application Development Overview](application-dev-guide.md) +# Application Development +- [Application Development Overview](application-dev-guide.md) - Quick Start - - Getting Started - - [Preparations](quick-start/start-overview.md) - - [Getting Started with eTS](quick-start/start-with-ets.md) - - [Getting Started with JavaScript in the Traditional Coding Approach](quick-start/start-with-js.md) - - [Getting Started with JavaScript in the Low-Code Approach](quick-start/start-with-js-low-code.md) - - Development Fundamentals - - [Directory Structure](quick-start/package-structure.md) - - [Resource File Categories](quick-start/basic-resource-file-categories.md) - + - [Directory Structure](quick-start/package-structure.md) + - [Resource File Categories](quick-start/basic-resource-file-categories.md) - Development - [Ability Development](ability/Readme-EN.md) - - [FA Model Overview](ability/fa-brief.md) - - [Page Ability Development](ability/fa-pageability.md) - - [Service Ability Development](ability/fa-serviceability.md) - - [Data Ability Development](ability/fa-dataability.md) - - [FA Widget Development](ability/fa-formability.md) + - [Ability Framework Overview](ability/ability-brief.md) + - FA Model + - [FA Model Overview](ability/fa-brief.md) + - [Page Ability Development](ability/fa-pageability.md) + - [Service Ability Development](ability/fa-serviceability.md) + - [Data Ability Development](ability/fa-dataability.md) + - [FA Widget Development](ability/fa-formability.md) + - Other - [Ability Assistant Usage](ability/ability-assistant-guidelines.md) - - [UI](ui/Readme-EN.md) - [ArkUI Overview](arkui-overview.md) - JavaScript-based Web-Like Development Paradigm @@ -135,7 +131,6 @@ - [Building a Food Category List Layout](ui/ui-ts-building-category-list-layout.md) - [Building a Food Category Grid Layout](ui/ui-ts-building-category-grid-layout.md) - [Implementing Page Redirection and Data Transmission](ui/ui-ts-page-redirection-data-transmission.md) - - Basic Functions - Window Manager - Window @@ -200,6 +195,9 @@ - Sensor - [Sensor Overview](device/sensor-overview.md) - [Sensor Development](device/sensor-guidelines.md) + - Sensor + - [Sensor Overview](device/sensor-overview.md) + - [Sensor Development](device/sensor-guidelines.md) - Vibrator - [vibrator-Overview.md](device/vibrator-overview.md) - [Vibrator Development](device/vibrator-guidelines.md) @@ -216,13 +214,14 @@ - Distributed Call Chain Tracing - [Overview of Distributed Call Chain Tracing](dfx/hitracechain-overview.md) - [Development of Distributed Call Chain Tracing](dfx/hitracechain-guidelines.md) - + - Internationalization + - [Overview](internationalization/international-overview.md) + - [Internationalization Development (intl)](internationalization/intl-guidelines.md) + - [Internationalization Development (i18n)](internationalization/i18n-guidelines.md) - Tools - [DevEco Studio (OpenHarmony) User Guide](quick-start/deveco-studio-user-guide-for-openharmony.md) - - Hands-On Tutorials - [Samples](https://gitee.com/openharmony/app_samples/blob/master/README.md) - - API References - Compent Reference (JavaScript-based Web-like Development Paradigm) - Components @@ -385,6 +384,7 @@ - [ImageAnimator](reference/arkui-ts/ts-basic-components-imageanimator.md) - [LoadingProgress](reference/arkui-ts/ts-basic-components-loadingprogress.md) - [Marquee](reference/arkui-ts/ts-basic-components-marquee.md) + - [Navigation](reference/arkui-ts/ts-basic-components-navigation.md) - [PatternLock](reference/arkui-ts/ts-basic-components-patternlock.md) - [PluginComponent](reference/arkui-ts/ts-basic-components-plugincomponent.md) - [Progress](reference/arkui-ts/ts-basic-components-progress.md) @@ -392,6 +392,7 @@ - [Radio](reference/arkui-ts/ts-basic-components-radio.md) - [Rating](reference/arkui-ts/ts-basic-components-rating.md) - [RichText](reference/arkui-ts/ts-basic-components-richtext.md) + - [ScrollBar](reference/arkui-ts/ts-basic-components-scrollbar.md) - [Search](reference/arkui-ts/ts-basic-components-search.md) - [Select](reference/arkui-ts/ts-basic-components-select.md) - [Slider](reference/arkui-ts/ts-basic-components-slider.md) @@ -420,14 +421,12 @@ - [GridItem](reference/arkui-ts/ts-container-griditem.md) - [List](reference/arkui-ts/ts-container-list.md) - [ListItem](reference/arkui-ts/ts-container-listitem.md) - - [Navigator](reference/arkui-ts/ts-container-navigator.md) - - [Navigation](reference/arkui-ts/ts-basic-components-navigation.md) + - [Navigator](reference/arkui-ts/ts-container-navigator.md) - [Panel](reference/arkui-ts/ts-container-panel.md) - [Refresh](reference/arkui-ts/ts-container-refresh.md) - [Row](reference/arkui-ts/ts-container-row.md) - [RowSplit](reference/arkui-ts/ts-container-rowsplit.md) - [Scroll](reference/arkui-ts/ts-container-scroll.md) - - [ScrollBar](reference/arkui-ts/ts-basic-components-scrollbar.md) - [SideBarContainer](reference/arkui-ts/ts-container-sidebarcontainer.md) - [Stack](reference/arkui-ts/ts-container-stack.md) - [Swiper](reference/arkui-ts/ts-container-swiper.md) @@ -474,118 +473,230 @@ - [Built-in Enums](reference/arkui-ts/ts-appendix-enums.md) - APIs - Ability Framework - - [FeatureAbility Module](reference/apis/js-apis-featureAbility.md) - - [ParticleAbility Module](reference/apis/js-apis-particleAbility.md) - - [DataAbilityHelper Module](reference/apis/js-apis-dataAbilityHelper.md) - - [DataUriUtils Module](reference/apis/js-apis-DataUriUtils.md) - - [Bundle Module](reference/apis/js-apis-Bundle.md) - - [Context Module](reference/apis/js-apis-Context.md) - - Event Notification - - [CommonEvent Module](reference/apis/js-apis-commonEvent.md) - - [Notification Module](reference/apis/js-apis-notification.md) - - [Reminder Agent](reference/apis/js-apis-reminderAgent.md) - - Resource Management - - [Resource Manager](reference/apis/js-apis-resource-manager.md) - - [Internationalization (intl)](reference/apis/js-apis-intl.md) - - [Internationalization (i18n)](reference/apis/js-apis-i18n.md) + + - [@ohos.ability.dataUriUtils](reference/apis/js-apis-DataUriUtils.md) + - [@ohos.ability.errorCode ](reference/apis/js-apis-ability-errorcode.md) + - [@ohos.ability.wantConstant](reference/apis/js-apis-ability-wantConstant.md) + - [@ohos.application.Ability](reference/apis/js-apis-application-ability.md) + - [@ohos.application.AbilityConstant](reference/apis/js-apis-application-abilityConstant.md) + - [@ohos.application.abilityDelegatorRegistry](reference/apis/js-apis-abilityDelegatorRegistry.md) + - [@ohos.application.AbilityStage ](reference/apis/js-apis-application-abilitystage.md) + - [@ohos.application.appManager](reference/apis/js-apis-appmanager.md) + - [@ohos.application.Configuration](reference/apis/js-apis-configuration.md) + - [@ohos.application.ConfigurationConstant](reference/apis/js-apis-configurationconstant.md) + - [@ohos.application.DataShareExtensionAbility](reference/apis/js-apis-application-DataShareExtensionAbility.md) + - [@ohos.ability.featureAbility](reference/apis/js-apis-featureAbility.md) + - [@ohos.application.formBindingData](reference/apis/js-apis-formbindingdata.md) + - [@ohos.application.FormExtension](reference/apis/js-apis-formextension.md) + - [@ohos.application.formError](reference/apis/js-apis-formerror.md) + - [@ohos.application.formHost](reference/apis/js-apis-formhost.md) + - [@ohos.application.formInfo](reference/apis/js-apis-formInfo.md) + - [@ohos.application.missionManager](reference/apis/js-apis-missionManager.md) + - [@ohos.application.formProvider](reference/apis/js-apis-formprovider.md) + - [@ohos.ability.particleAbility](reference/apis/js-apis-particleAbility.md) + - [@ohos.application.ServiceExtensionAbility](reference/apis/js-apis-service-extension-ability.md) + - [@ohos.application.StartOptions](reference/apis/js-apis-application-StartOptions.md) + - [@ohos.application.StaticSubscriberExtensionAbility](reference/apis/js-apis-application-staticSubscriberExtensionAbility.md) + - [@ohos.application.uriPermissionManager](reference/apis/js-apis-uripermissionmanager.md) + - [@ohos.application.Want](reference/apis/js-apis-application-Want.md) + - [@ohos.wantAgent](reference/apis/js-apis-wantAgent.md) + - [dataAbilityHelper](reference/apis/js-apis-dataAbilityHelper.md) + - [context](reference/apis/js-apis-Context.md) + - [AbilityContext](reference/apis/js-apis-ability-context.md) + - [abilityDelegator](reference/apis/js-apis-application-abilityDelegator.md) + - [abilityDelegatorArgs](reference/apis/js-apis-application-abilityDelegatorArgs.md) + - [abilityMonitor](reference/apis/js-apis-application-abilityMonitor.md) + - [AbilityRunningInfo](reference/apis/js-apis-abilityrunninginfo.md) + - [AbilityStageContext](reference/apis/js-apis-abilitystagecontext.md) + - [Context](reference/apis/js-apis-application-context.md) + - [ExtensionContext](reference/apis/js-apis-extension-context.md) + - [ExtensionRunningInfo](reference/apis/js-apis-extensionrunninginfo.md) + - [FormExtensionContext](reference/apis/js-apis-formextensioncontext.md) + - [MissionSnapshot](reference/apis/js-apis-application-MissionSnapshot.md) + - [PermissionRequestResult](reference/apis/js-apis-permissionrequestresult.md) + - [ProcessRunningInfo](reference/apis/js-apis-processrunninginfo.md) + - [ServiceExtensionContext](reference/apis/js-apis-service-extension-context.md) + - [shellCmdResult](reference/apis/js-apis-application-shellCmdResult.md) + + - Common Event and Notification + + - [@ohos.commonEvent](reference/apis/js-apis-commonEvent.md) + - [@ohos.events.emitter](reference/apis/js-apis-emitter.md) + - [@ohos.notification](reference/apis/js-apis-notification.md) + - [@ohos.reminderAgent](reference/apis/js-apis-reminderAgent.md) + - [EventHub](reference/apis/js-apis-eventhub.md) + + - Bundle Management + + - [@ohos.bundle](reference/apis/js-apis-Bundle.md) + - [@ohos.bundleState ](reference/apis/js-apis-deviceUsageStatistics.md) + - [@ohos.zlib](reference/apis/js-apis-zlib.md) + + - UI Page + + - [@ohos.animator](reference/apis/js-apis-animator.md) + + - Graphics + + - [@ohos.display ](reference/apis/js-apis-display.md) + - [@ohos.screenshot](reference/apis/js-apis-screenshot.md) + - [@ohos.window](reference/apis/js-apis-window.md) + - [webgl](reference/apis/js-apis-webgl.md) + - [webgl2](reference/apis/js-apis-webgl2.md) + - Media - - [Audio Management](reference/apis/js-apis-audio.md) - - [Media](reference/apis/js-apis-media.md) - - [Image Processing](reference/apis/js-apis-image.md) - - [Camera](reference/apis/js-apis-camera.md) + + - [@ohos.multimedia.audio](reference/apis/js-apis-audio.md) + - [@ohos.multimedia.camera](reference/apis/js-apis-camera.md) + - [@ohos.multimedia.image](reference/apis/js-apis-image.md) + - [@ohos.multimedia.media](reference/apis/js-apis-media.md) + - [@ohos.multimedia.medialibrary](reference/apis/js-apis-medialibrary.md) + + - Resource Management + - [@ohos.i18n](reference/apis/js-apis-i18n.md) + - [@ohos.intl](reference/apis/js-apis-intl.md) + - [@ohos.resourceManager](reference/apis/js-apis-resource-manager.md) + + - Resource Scheduling + + - [@ohos.backgroundTaskManager](reference/apis/js-apis-backgroundTaskManager.md) + - [@ohos.workScheduler ](reference/apis/js-apis-workScheduler.md) + - [@ohos.WorkSchedulerExtensionAbility](reference/apis/js-apis-WorkSchedulerExtensionAbility.md) + + - Custom Management + + - [@ohos.configPolicy](reference/apis/js-apis-config-policy.md) + - [@ohos.enterpriseDeviceManager](reference/apis/js-apis-enterprise-device-manager.md) + - Security - - [User Authentication](reference/apis/js-apis-useriam-userauth.md) - - [Access Control](reference/apis/js-apis-abilityAccessCtrl.md) + + - [@ohos.abilityAccessCtrl](reference/apis/js-apis-abilityAccessCtrl.md) + - [@ohos.security.huks ](reference/apis/js-apis-huks.md) + - [@ohos.userIAM.userAuth ](reference/apis/js-apis-useriam-userauth.md) + - Data Management - - [Lightweight Storage](reference/apis/js-apis-data-preferences.md) - - [Distributed Data Management](reference/apis/js-apis-distributed-data.md) - - [Relational Database](reference/apis/js-apis-data-rdb.md) - - [Result Set](reference/apis/js-apis-data-resultset.md) - - [DataAbilityPredicates](reference/apis/js-apis-data-ability.md) - - [Settings](reference/apis/js-apis-settings.md) + + - [@ohos.data.dataAbility ](reference/apis/js-apis-data-ability.md) + - [@ohos.data.distributedData](reference/apis/js-apis-distributed-data.md) + - [@ohos.data.distributedDataObject](reference/apis/js-apis-data-distributedobject.md) + - [@ohos.data.preferences](reference/apis/js-apis-data-preferences.md) + - [@ohos.data.rdb](reference/apis/js-apis-data-rdb.md) + - [@ohos.settings](reference/apis/js-apis-settings.md) + - [resultSet](reference/apis/js-apis-data-resultset.md) + - File Management - - [File Management](reference/apis/js-apis-fileio.md) - - [Statfs](reference/apis/js-apis-statfs.md) - - [Environment](reference/apis/js-apis-environment.md) - - [Public File Access and Management](reference/apis/js-apis-filemanager.md) - - [App Storage Statistics](reference/apis/js-apis-storage-statistics.md) - - [Volume Management](reference/apis/js-apis-volumemanager.md) - - Account Management - - [OS Account Management](reference/apis/js-apis-osAccount.md) - - [Distributed Account Management](reference/apis/js-apis-distributed-account.md) - - [App Account Management](reference/apis/js-apis-appAccount.md) + + - [@ohos.environment](reference/apis/js-apis-environment.md) + - [@ohos.fileio](reference/apis/js-apis-fileio.md) + - [@ohos.fileManager](reference/apis/js-apis-filemanager.md) + - [@ohos.statfs](reference/apis/js-apis-statfs.md) + - [@ohos.storageStatistics](reference/apis/js-apis-storage-statistics.md) + - [@ohos.volumeManager](reference/apis/js-apis-volumemanager.md) + - Telephony Service - - [Call](reference/apis/js-apis-call.md) - - [SMS](reference/apis/js-apis-sms.md) - - [SIM Management](reference/apis/js-apis-sim.md) - - [Radio](reference/apis/js-apis-radio.md) - - [Observer](reference/apis/js-apis-observer.md) - - [Cellular Data](reference/apis/js-apis-telephony-data.md) + + - [@ohos.contact](reference/apis/js-apis-contact.md) + - [@ohos.telephony.call](reference/apis/js-apis-call.md) + - [@ohos.telephony.observer](reference/apis/js-apis-observer.md) + - [@ohos.telephony.radio](reference/apis/js-apis-radio.md) + - [@ohos.telephony.sim](reference/apis/js-apis-sim.md) + - [@ohos.telephony.sms](reference/apis/js-apis-sms.md) + - [@ohos.telephony.data](reference/apis/js-apis-telephony-data.md) + - Network Management - - [Network Connection Management](js-apis-net-connection.md) - - [Socket Connection](js-apis-socket.md) - - [WebSocket Connection](js-apis-webSocket.md) - - [Data Request](js-apis-http.md) - - Network and Connectivity - - [WLAN](reference/apis/js-apis-wifi.md) - - [Bluetooth](reference/apis/js-apis-bluetooth.md) - - [RPC](reference/apis/js-apis-rpc.md) - - Device Management - - [Sensor](reference/apis/js-apis-sensor.md) - - [Vibrator](reference/apis/js-apis-vibrator.md) - - [Brightness](reference/apis/js-apis-brightness.md) - - [Battery Info](reference/apis/js-apis-battery-info.md) - - [Power Management](reference/apis/js-apis-power.md) - - [Thermal Management](reference/apis/js-apis-thermal.md) - - [Running Lock](reference/apis/js-apis-runninglock.md) - - [Device Info](reference/apis/js-apis-device-info.md) - - [systemParameter](reference/apis/js-apis-system-parameter.md) - - [Device Management](reference/apis/js-apis-device-manager.md) - - [Window](reference/apis/js-apis-window.md) - - [Display](reference/apis/js-apis-display.md) - - [Update](reference/apis/js-apis-update.md) - - [USB](reference/apis/js-apis-usb.md) - - [Location](reference/apis/js-apis-geolocation.md) + - [@ohos.net.connection](reference/apis/js-apis-net-connection.md) + - [@ohos.net.http](reference/apis/js-apis-http.md) + - [@ohos.request](reference/apis/js-apis-request.md) + - [@ohos.net.socket](reference/apis/js-apis-socket.md) + - [@ohos.net.webSocket](reference/apis/js-apis-webSocket.md) + + - Connectivity + + - [@ohos.bluetooth](reference/apis/js-apis-bluetooth.md) + - [@ohos.rpc](reference/apis/js-apis-rpc.md) + - [@ohos.wifi](reference/apis/js-apis-wifi.md) + - [@ohos.wifiext](reference/apis/js-apis-wifiext.md) + - Basic Features - - [Application Context](reference/apis/js-apis-system-app.md) - - [Console Logs](reference/apis/js-apis-logs.md) - - [Page Routing](reference/apis/js-apis-system-router.md) + + - [@ohos.accessibility](reference/apis/js-apis-accessibility.md) + - [@ohos.faultLogger](reference/apis/js-apis-faultLogger.md) + - [@ohos.hiAppEvent](reference/apis/js-apis-hiappevent.md) + - [@ohos.hichecker](reference/apis/js-apis-hichecker.md) + - [@ohos.hidebug](reference/apis/js-apis-hidebug.md) + - [@ohos.hilog](reference/apis/js-apis-hilog.md) + - [@ohos.hiTraceChain](reference/apis/js-apis-hitracechain.md) + - [@ohos.hiTraceMeter](reference/apis/js-apis-hitracemeter.md) + - [@ohos.inputMethod](reference/apis/js-apis-inputmethod.md) + - [@ohos.inputMethodEngine](reference/apis/js-apis-inputmethodengine.md) + - [@ohos.pasteboard](reference/apis/js-apis-pasteboard.md) + - [@ohos.screenLock](reference/apis/js-apis-screen-lock.md) + - [@ohos.systemTime](reference/apis/js-apis-system-time.md) + - [@ohos.wallpaper](reference/apis/js-apis-wallpaper.md) - [Timer](reference/apis/js-apis-timer.md) - - [Setting the System Time](reference/apis/js-apis-system-time.md) - - [Animation](reference/apis/js-apis-animator.md) - - [WebGL](reference/apis/js-apis-webgl.md) - - [WebGL2](reference/apis/js-apis-webgl2.md) - - [Screenshot](reference/apis/js-apis-screenshot.md) - - [Accessibility](reference/apis/js-apis-accessibility.md) - - DFX - - [HiAppEvent](reference/apis/js-apis-hiappevent.md) - - [Performance Tracing](reference/apis/js-apis-hitracemeter.md) - - [Fault Logger](reference/apis/js-apis-faultLogger.md) - - [Distributed Call Chain Tracing](reference/apis/js-apis-hitracechain.md) - - [HiLog](reference/apis/js-apis-hilog.md) - - [HiChecker](reference/apis/js-apis-hichecker.md) - - [HiDebug](reference/apis/js-apis-hidebug.md) + + - Device Management + + - [@ohos.batteryInfo ](reference/apis/js-apis-battery-info.md) + - [@ohos.brightness](reference/apis/js-apis-brightness.md) + - [@ohos.deviceInfo](reference/apis/js-apis-device-info.md) + - [@ohos.distributedHardware.deviceManager](reference/apis/js-apis-device-manager.md) + - [@ohos.geolocation](reference/apis/js-apis-geolocation.md) + - [@ohos.multimodalInput.inputConsumer](reference/apis/js-apis-inputconsumer.md) + - [@ohos.multimodalInput.inputDevice](reference/apis/js-apis-inputdevice.md) + - [@ohos.multimodalInput.inputEventClient](reference/apis/js-apis-inputeventclient.md) + - [@ohos.multimodalInput.inputMonitor](reference/apis/js-apis-inputmonitor.md) + - [@ohos.power](reference/apis/js-apis-power.md) + - [@ohos.runningLock](reference/apis/js-apis-runninglock.md) + - [@ohos.sensor](reference/apis/js-apis-sensor.md) + - [@ohos.systemParameter](reference/apis/js-apis-system-parameter.md) + - [@ohos.thermal](reference/apis/js-apis-thermal.md) + - [@ohos.update](reference/apis/js-apis-update.md) + - [@ohos.usb](reference/apis/js-apis-usb.md) + - [@ohos.vibrator](reference/apis/js-apis-vibrator.md) + + - Account Management + + - [@ohos.account.appAccount](reference/apis/js-apis-appAccount.md) + - [@ohos.account.distributedAccount](reference/apis/js-apis-distributed-account.md) + - [@ohos.account.osAccount](reference/apis/js-apis-osAccount.md) + - Language Base Class Library - - [Obtaining Process Information](reference/apis/js-apis-process.md) - - [URL String Parsing](reference/apis/js-apis-url.md) - - [URI String Parsing](reference/apis/js-apis-uri.md) - - [Util](reference/apis/js-apis-util.md) - - [XML Parsing and Generation](reference/apis/js-apis-xml.md) - - [XML-to-JavaScript Conversion](reference/apis/js-apis-convertxml.md) - - [Worker Startup](reference/apis/js-apis-worker.md) - - [Linear Container ArrayList](reference/apis/js-apis-arraylist.md) - - [Linear Container Deque](reference/apis/js-apis-deque.md) - - [Linear Container List](reference/apis/js-apis-list.md) - - [Linear Container LinkedList](reference/apis/js-apis-linkedlist.md) - - [Linear Container Queue](reference/apis/js-apis-queue.md) - - [Linear Container Stack](reference/apis/js-apis-stack.md) - - [Linear Container Vector](reference/apis/js-apis-vector.md) - - [Nonlinear Container HashSet](reference/apis/js-apis-hashset.md) - - [Nonlinear Container HashMap](reference/apis/js-apis-hashmap.md) - - [Nonlinear Container PlainArray](reference/apis/js-apis-plainarray.md) - - [Nonlinear Container TreeMap](reference/apis/js-apis-treemap.md) - - [Nonlinear Container TreeSet](reference/apis/js-apis-treeset.md) - - [Nonlinear Container LightWeightMap](reference/apis/js-apis-lightweightmap.md) - - [Nonlinear Container LightWeightSet](reference/apis/js-apis-lightweightset.md) - - Custom Management - - [Configuration Policy](reference/apis/js-apis-config-policy.md) + + - [@ohos.convertxml](reference/apis/js-apis-convertxml.md) + - [@ohos.process](reference/apis/js-apis-process.md) + - [@ohos.uri](reference/apis/js-apis-uri.md) + - [@ohos.url](reference/apis/js-apis-url.md) + - [@ohos.util](reference/apis/js-apis-util.md) + - [@ohos.util.ArrayList](reference/apis/js-apis-arraylist.md) + - [@ohos.util.Deque](reference/apis/js-apis-deque.md) + - [@ohos.util.HashMap](reference/apis/js-apis-hashmap.md) + - [@ohos.util.HashSet](reference/apis/js-apis-hashset.md) + - [@ohos.util.LightWeightMap](reference/apis/js-apis-lightweightmap.md) + - [@ohos.util.LightWeightSet](reference/apis/js-apis-lightweightset.md) + - [@ohos.util.LinkedList](reference/apis/js-apis-linkedlist.md) + - [@ohos.util.List](reference/apis/js-apis-list.md) + - [@ohos.util.PlainArray](reference/apis/js-apis-plainarray.md) + - [@ohos.util.Queue](reference/apis/js-apis-queue.md) + - [@ohos.util.Stack](reference/apis/js-apis-stack.md) + - [@ohos.util.TreeMap](reference/apis/js-apis-treemap.md) + - [@ohos.util.TreeSet](reference/apis/js-apis-treeset.md) + - [@ohos.util.Vector](reference/apis/js-apis-vector.md) + - [@ohos.worker](reference/apis/js-apis-worker.md) + - [@ohos.xml](reference/apis/js-apis-xml.md) + + - Test + - [@ohos.application.testRunner](reference/apis/js-apis-testRunner.md) + - [@ohos.uitest](reference/apis/js-apis-uitest.md) + + - APIs No Longer Maintained + + - [@ohos.bytrace](reference/apis/js-apis-bytrace.md) + - [@ohos.data.storage](reference/apis/js-apis-data-storage.md) + - [@system.app](reference/apis/js-apis-system-app.md) + - [@system.bluetooth](reference/apis/js-apis-system-bluetooth.md) + - [@system.mediaquery](reference/apis/js-apis-system-mediaquery.md) + - [@system.router](reference/apis/js-apis-system-router.md) + - [@system.sensor](reference/apis/js-apis-system-sensor.md) + - [@system.vibrator](reference/apis/js-apis-system-vibrate.md) + - [console](reference/apis/js-apis-logs.md) \ No newline at end of file diff --git a/en/application-dev/device/sensor-overview.md b/en/application-dev/device/sensor-overview.md index ea75d0b5dfc4a0611d118d5ddb9fbbaac1345bc5..c45dd69eea4372c41a1d5f1dbf93de14e4b40ea5 100644 --- a/en/application-dev/device/sensor-overview.md +++ b/en/application-dev/device/sensor-overview.md @@ -1,88 +1,43 @@ # Sensor Overview -Sensors in OpenHarmony are an abstraction of underlying hardware-based sensors. Your application can access the underlying sensors via OpenHarmony sensors. Using the APIs provided by OpenHarmony sensors, you can query sensors on your device, subscribe to sensor data, customize algorithms based on sensor data, and develop various sensor-based applications, such as compass, fitness and health, and games applications. +Sensors in OpenHarmony are an abstraction of underlying hardware-based sensors. Your application can access the underlying sensors via the sensors. Using the APIs provided by sensors, you can query sensors on your device, subscribe to sensor data, customize algorithms based on sensor data, and develop various sensor-based applications, such as compass, fitness and health, and games applications. -The sensors are classified into the following categories based on their functions: motion, environment, orientation, light, body, and other categories (such as Hall effect sensors). Each category includes different sensor types. A sensor type may be a single physical sensor or a composite of multiple physical sensors. +A sensor is a device to detect events or changes in an environment and send messages about the events or changes to another device (for example, a CPU). Generally, a sensor is composed of sensitive components and conversion components. Sensors are the cornerstone of the IoT. A unified sensor management framework is required to achieve data sensing at a low latency and low power consumption, thereby keeping up with requirements of "1+8+N" products or business in the Seamless AI Life Strategy. The sensor list is as follows: +| Sensor Type | Sensor Name | Description | Usage | +| --------------------------------------- | ------------------ | ------------------------------------------------------------ | ---------------------------------------- | +| SENSOR_TYPE_ACCELEROMETER | Acceleration sensor | Measures the acceleration (including the gravity acceleration) applied to a device on three physical axes (X, Y, and Z), in the unit of m/s2.| Detecting the motion status | +| SENSOR_TYPE_ACCELEROMETER_UNCALIBRATED | Uncalibrated acceleration sensor| Measures the uncalibrated acceleration (including the gravity acceleration) applied to a device on three physical axes (X, Y, and Z), in the unit of m/s2.| Measuring the acceleration bias estimation | +| SENSOR_TYPE_LINEAR_ACCELERATION | Linear acceleration sensor | Measures the linear acceleration (excluding the gravity acceleration) applied to a device on three physical axes (X, Y, and Z), in the unit of m/s2.| Detecting the linear acceleration in each axis | +| SENSOR_TYPE_GRAVITY | Gravity sensor | Measures the gravity acceleration applied to a device on three physical axes (X, Y, and Z), in the unit of m/s2.| Measuring the gravity | +| SENSOR_TYPE_GYROSCOPE | Gyroscope sensor | Measures the rotation angular velocity of a device on three physical axes (X, Y, and Z), in the unit of rad/s.| Measuring the rotation angular velocity | +| SENSOR_TYPE_GYROSCOPE_UNCALIBRATED | Uncalibrated gyroscope sensor| Measures the uncalibrated rotation angular velocity of a device on three physical axes (X, Y, and Z), in the unit of rad/s.| Measuring the bias estimation of the rotation angular velocity | +| SENSOR_TYPE_SIGNIFICANT_MOTION | Significant motion sensor | Checks whether a device has a significant motion on three physical axes (X, Y, and Z). The value **0** means that the device does not have a significant motion, and **1** means the opposite.| Detecting significant motions of a device | +| SENSOR_TYPE_PEDOMETER_DETECTION | Pedometer detection sensor | Detects whether a user takes a step. The value can be **0** (the user does not take a step) or **1** (the user takes a step).| Detecting whether a user takes a step | +| SENSOR_TYPE_PEDOMETER | Pedometer sensor | Records the number of steps a user has walked. | Providing the number of steps a user has walked | +| SENSOR_TYPE_AMBIENT_TEMPERATURE | Ambient temperature sensor | Measures the ambient temperature, in the unit of degree Celsius (°C). | Measuring the ambient temperature | +| SENSOR_TYPE_MAGNETIC_FIELD | Magnetic field sensor | Measures the magnetic field on three physical axes (X, Y, and Z), in the unit of μT.| Creating a compass | +| SENSOR_TYPE_MAGNETIC_FIELD_UNCALIBRATED | Uncalibrated magnetic field sensor | Measures the uncalibrated magnetic field on three physical axes (X, Y, and Z), in the unit of μT.| Measuring the magnetic field bias estimation | +| SENSOR_TYPE_HUMIDITY | Humidity sensor | Measures the ambient relative humidity, in a percentage (%). | Monitoring the dew point, absolute humidity, and relative humidity | +| SENSOR_TYPE_BAROMETER | Barometer sensor | Measures the barometric pressure, in the unit of hPa or mbar. | Measuring the barometric pressure | +| SENSOR_TYPE_ORIENTATION | Orientation sensor | Measures the rotation angles of a device on three physical axes (X, Y, and Z), in the unit of rad.| Providing the three orientation angles of the screen | +| SENSOR_TYPE_ROTATION_VECTOR | Rotation vector sensor | Measures the rotation vector of a device. It is a composite sensor that generates data from the acceleration sensor, magnetic field sensor, and gyroscope sensor.| Detecting the orientation of a device in the East, North, Up (ENU) Cartesian coordinate system | +| SENSOR_TYPE_PROXIMITY | Proximity sensor | Measures the distance between a visible object and the device screen. | Measuring the distance between a person and the device during a call | +| SENSOR_TYPE_AMBIENT_LIGHT | Ambient light sensor | Measures the ambient light intensity of a device, in the unit of lux. | Automatically adjusting the screen brightness and checking whether the screen is covered on the top| +| SENSOR_TYPE_HEART_RATE | Heart rate sensor | Measures the heart rate of a user. | Providing users' heart rate data | +| SENSOR_TYPE_WEAR_DETECTION | Wear detection sensor | Checks whether a user is wearing a wearable device. | Detecting wearables | +| SENSOR_TYPE_HALL | Hall effect sensor | Detects a magnetic field around a device. | Smart cover mode of the device | - **Table1** Motion - ohos.sensor.agent.CategoryMotionAgent -| Sensor Type | Sensor Name | Description | Usage | -| -------- | -------- | -------- | -------- | -| SENSOR_TYPE_ACCELEROMETER | Acceleration sensor | Measures the acceleration (including the gravity acceleration) applied to a device on three physical axes (X, Y, and Z), in the unit of m/s2. | Detecting the motion status | -| SENSOR_TYPE_ACCELEROMETER_UNCALIBRATED | Uncalibrated acceleration sensor | Measures the uncalibrated acceleration (including the gravity acceleration) applied to a device on three physical axes (X, Y, and Z), in the unit of m/s2. | Measuring the acceleration bias estimation | -| SENSOR_TYPE_LINEAR_ACCELERATION | Linear acceleration sensor | Measures the linear acceleration (excluding the gravity acceleration) applied to a device on three physical axes (X, Y, and Z), in the unit of m/s2. | Detecting the linear acceleration in each axis | -| SENSOR_TYPE_GRAVITY | Gravity sensor | Measures the gravity acceleration applied to a device on three physical axes (X, Y, and Z), in the unit of m/s2. | Measuring the gravity | -| SENSOR_TYPE_GYROSCOPE | Gyroscope sensor | Measures the rotation angular velocity of a device on three physical axes (X, Y, and Z), in the unit of rad/s. | Measuring the rotation angular velocity | -| SENSOR_TYPE_GYROSCOPE_UNCALIBRATED | Uncalibrated gyroscope sensor | Measures the uncalibrated rotation angular velocity of a device on three physical axes (X, Y, and Z), in the unit of rad/s. | Measuring the bias estimation of the rotation angular velocity | -| SENSOR_TYPE_SIGNIFICANT_MOTION | Significant motion sensor | Checks whether a device has a significant motion on three physical axes (X, Y, and Z). The value can be **0** (having no significant motion) or **1** (having a significant motion). | Detecting significant motions of a device | -| SENSOR_TYPE_DROP_DETECTION | Drop detection sensor | Detects the device drop status. The value can be **0** (the device is not dropped) or **1** (the device is dropped). | Detecting whether a device is dropped | -| SENSOR_TYPE_PEDOMETER_DETECTION | Pedometer detection sensor | Detects whether a user takes a step. The value can be **0** (the user does not take a step) or **1** (the user takes a step). | Detecting whether a user takes a step | -| SENSOR_TYPE_PEDOMETER | Pedometer sensor | Records the number of steps a user has walked. | Providing the number of steps a user has walked | +## Working Principles +The following modules work cooperatively to implement OpenHarmony sensors: Sensor API, Sensor Framework, Sensor Service, and HDF layer. - **Table2** Environment - ohos.sensor.agent.CategoryOrientationAgent + **Figure 1** How the sensor works -| Sensor Type | Sensor Name | Description | Usage | -| -------- | -------- | -------- | -------- | -| SENSOR_TYPE_AMBIENT_TEMPERATURE | Ambient temperature sensor. | Measures the ambient temperature, in the unit of degree Celsius (°C). | Measuring the ambient temperature | -| SENSOR_TYPE_MAGNETIC_FIELD | Magnetic field sensor | Measures the magnetic field on three physical axes (X, Y, and Z), in the unit of μT. | Creating a compass | -| SENSOR_TYPE_MAGNETIC_FIELD_UNCALIBRATED | Uncalibrated magnetic field sensor | Measures the uncalibrated magnetic field on three physical axes (X, Y, and Z), in the unit of μT. | Measuring the magnetic field bias estimation | -| SENSOR_TYPE_HUMIDITY | Humidity sensor | Measures the ambient relative humidity, in a percentage (%). | Monitoring the dew point, absolute humidity, and relative humidity | -| SENSOR_TYPE_BAROMETER | Barometer sensor | Measures the barometric pressure, in the unit of hPa or mbar. | Measuring the barometric pressure | -| SENSOR_TYPE_SAR | Specific Absorption Rate (SAR) sensor | Measures the SAR, in the unit of W/kg. | Measuring the SAR of electromagnetic waves for a device | - - - **Table3** Orientation - ohos.sensor.agent.CategoryOrientationAgent - -| Sensor Type | Sensor Name | Description | Usage | -| -------- | -------- | -------- | -------- | -| SENSOR_TYPE_6DOF | Degrees of Freedom (DoF) sensor | Measures the forward/backward, up/down, and left/right translational movement of a device on the three axes (X, Y, and Z) in the unit of m or mm as well as the roll, pitch, and yaw rotation angles on the three axes (X, Y, and Z) in the unit of rad. | Positioning an object by detecting its freedom of translational and rotational motions, for example, VR | -| SENSOR_TYPE_SCREEN_ROTATION | Screen rotation sensor | Checks the rotation status of the device screen. | Detecting whether the device screen is rotating | -| SENSOR_TYPE_DEVICE_ORIENTATION | Device orientation sensor | Measures the rotation angles of the device, in the unit of rad. | Measuring the angles that a device has rotated | -| SENSOR_TYPE_ORIENTATION | Orientation sensor | Measures the rotation angles of a device on three physical axes (X, Y, and Z), in the unit of rad. | Providing the three orientation angles of the screen | -| SENSOR_TYPE_ROTATION_VECTOR | Rotation vector sensor | Measures the rotation vector of a device. It is a composite sensor that generates data from the acceleration sensor, magnetic field sensor, and gyroscope sensor. | Detecting the orientation of a device in the East, North, Up (ENU) Cartesian coordinate system | -| SENSOR_TYPE_GAME_ROTATION_VECTOR
SENSOR_TYPE_GEOMAGNETIC_ROTATION_VECTOR | Game rotation vector sensor
Geomagnetic rotation vector sensor | Measures the game rotation vector of a device. It is a composite sensor that generates data from the acceleration sensor and gyroscope sensor.
Measures the geomagnetic rotation vector of a device. It is a composite sensor that generates data from the acceleration sensor and magnetic field sensor. | Applied in games
Measuring the geomagnetic rotation vector | - - - **Table4** Light - ohos.sensor.agent.CategoryLightAgent - -| Sensor Type | Sensor Name | Description | Usage | -| -------- | -------- | -------- | -------- | -| SENSOR_TYPE_PROXIMITY | Proximity sensor | Measures the distance between a visible object and the device screen. | Measuring the distance between a person and the device during a call | -| SENSOR_TYPE_TOF | Time of flight (ToF) sensor | Measures the time required for light to travel a distance in the medium. | Facial recognition | -| SENSOR_TYPE_AMBIENT_LIGHT | Ambient light sensor | Measures the ambient light intensity of a device, in the unit of lux. | Automatically adjusting the screen brightness and checking whether the screen is covered on the top | -| SENSOR_TYPE_COLOR_TEMPERATURE | Color temperature sensor | Measures the ambient color temperature. | Image processing on the device | -| SENSOR_TYPE_COLOR_RGB | RGB color sensor | Measures the ambient RGB color values. | Color detection implemented by the reflectance of RGB colors | -| SENSOR_TYPE_COLOR_XYZ | XYZ color sensor | Measures the ambient XYZ color values. | Identifying true-color spots to reproduce more natural colors | - - - **Table5** Body - ohos.sensor.agent.CategoryBodyAgent - -| Sensor Type | Sensor Name | Description | Usage | -| -------- | -------- | -------- | -------- | -| SENSOR_TYPE_HEART_RATE | Heart rate sensor | Measures the heart rate of a user. | Providing users' heart rate data | -| SENSOR_TYPE_WEAR_DETECTION | Wear detection sensor | Checks whether a user is wearing a wearable device. | Detecting wearables | - - - **Table6** Others - -| Sensor Type | Sensor Name | Description | Usage | -| -------- | -------- | -------- | -------- | -| SENSOR_TYPE_HALL | Hall effect sensor | Detects a magnetic field around a device. | Smart cover mode of the device | -| SENSOR_TYPE_GRIP_DETECTOR | Grip detection sensor | Detects grip force applied on a device. | Detecting whether the device is gripped on its sides | -| SENSOR_TYPE_MAGNET_BRACKET | Magnet bracket sensor | Checks whether a device is magnetized. | Detecting an in-vehicle or indoor device | -| SENSOR_TYPE_PRESSURE_DETECTOR | Pressure detection sensor | Detects pressure force applied on a device. | Detecting pressure on the top of the device | - - -## How a Service Is Shared Using Huawei Share - -The following modules work cooperatively to implement OpenHarmony sensors: Sensor API, Sensor Framework, Sensor Service, and HD_IDL. - - **Figure1** Working principles for OpenHarmony sensors - ![en-us_image_0000001226521897](figures/en-us_image_0000001226521897.png) +![fad1a124-a90e-460f-84fc-e87d6caebb21](figures/fad1a124-a90e-460f-84fc-e87d6caebb21.png) - Sensor API: provides APIs for performing basic operations on sensors, including querying the sensor list, subscribing to or unsubscribing from sensor data, and executing control commands. This module makes application development simpler. @@ -90,22 +45,22 @@ The following modules work cooperatively to implement OpenHarmony sensors: Senso - Sensor Service: interacts with the HD_IDL module to receive, parse, and distribute data, manages foreground and background policies and sensors of a device, and controls sensor permissions. -- HD_IDL: selects proper policies based on the hardware first in first out (FIFO) and frequency, and adapts to different devices. +- HDF layer: selects proper policies based on the hardware first in first out (FIFO) and frequency, and adapts to different devices. -## Limitations and Constraints +## Constraints -To obtain data of the following sensors, you must claim the required permissions. +1. To obtain data of the following sensors, you must claim the required permissions. + Table 7 Sensor data permissions - **Table7** Sensor data permission + | Sensor | Permission | Sensitivity | Permission Description | + | ------------------------- | -------------------------------- | ------------ | ----------------------- | + | Acceleration sensor, uncalibrated acceleration sensor, and linear acceleration sensor| ohos.permission.ACCELEROMETER | system_grant | Allows your application to subscribe to data of these acceleration-related sensors in the motion category.| + | Gyroscope sensor and uncalibrated gyroscope sensor | ohos.permission.GYROSCOPE | system_grant | Allows an application to subscribe to data of the gyroscope-related sensors in the motion category.| + | Pedometer sensor | ohos.permission.ACTIVITY_MOTION | user_grant | Allows an application to subscribe to the motion status. | + | Heart rate sensor | ohos.permission.READ_HEALTH_DATA | user_grant | Allows an application to read health data. | -| Sensor | Permission Name | Sensitivity | Permission Description | -| -------- | -------- | -------- | -------- | -| Acceleration sensor, uncalibrated acceleration sensor, and linear acceleration sensor | ohos.permission.ACCELEROMETER | system_grant | Allows your application to subscribe to data of these acceleration-related sensors in the motion category. | -| Gyroscope sensor and uncalibrated gyroscope sensor | ohos.permission.GYROSCOPE | system_grant | Allows your application to subscribe to data of these gyroscope-related sensors in the motion category. | -| Pedometer sensor | ohos.permission.ACTIVITY_MOTION | user_grant | Allows your application to subscribe to the motion status. | -| Heart rate sensor | ohos.permission.READ_HEALTH_DATA | user_grant | Allows your application to read health data. | -The APIs for subscribing to and unsubscribing from sensor data work in pairs. If you do not need sensor data, call the unsubscription API to stop sensor data reporting. +2. The APIs for subscribing to and unsubscribing from sensor data work in pairs. If you do not need sensor data, call the unsubscription API to stop sensor data reporting. diff --git a/en/application-dev/reference/apis/js-apis-backgroundTaskManager.md b/en/application-dev/reference/apis/js-apis-backgroundTaskManager.md index cec4fab99d6e078c65937a10e8825f0844445c29..7787a551160a0afdb84af786ef1efd133a078bf6 100644 --- a/en/application-dev/reference/apis/js-apis-backgroundTaskManager.md +++ b/en/application-dev/reference/apis/js-apis-backgroundTaskManager.md @@ -22,15 +22,15 @@ The default duration of delayed suspension is 180000 when the battery level is h **System capability**: SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask **Parameters** - | Name| Type| Mandatory| Description| - | -------- | -------- | -------- | -------- | - | reason | string | Yes| Reason for delayed transition to the suspended state.| - | callback | Callback<void> | Yes| Invoked when a delay is about to time out. Generally, this callback is used to notify the application 6 seconds before the delay times out.| +| Name | Type | Mandatory | Description | +| -------- | -------------------- | --------- | ---------------------------------------- | +| reason | string | Yes | Reason for delayed transition to the suspended state. | +| callback | Callback<void> | Yes | Invoked when a delay is about to time out. Generally, this callback is used to notify the application 6 seconds before the delay times out. | **Return value** - | Type| Description| - | -------- | -------- | - | [DelaySuspendInfo](#delaysuspendinfo) | Information about the suspension delay.| +| Type | Description | +| ------------------------------------- | --------------------------------------- | +| [DelaySuspendInfo](#delaysuspendinfo) | Information about the suspension delay. | **Example** ```js @@ -50,12 +50,13 @@ Obtains the remaining duration before the application is suspended. This API use **System capability**: SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask **Parameters** - | Name| Type| Mandatory| Description| - | -------- | -------- | -------- | -------- | - | requestId | number | Yes| ID of the suspension delay request.| - | callback | AsyncCallback<number> | Yes| Callback used to return the remaining duration before the application is suspended, in milliseconds.| +| Name | Type | Mandatory | Description | +| --------- | --------------------------- | --------- | ---------------------------------------- | +| requestId | number | Yes | ID of the suspension delay request. | +| callback | AsyncCallback<number> | Yes | Callback used to return the remaining duration before the application is suspended, in milliseconds. | **Example** + ```js let id = 1; backgroundTaskManager.getRemainingDelayTime(id, (err, res) => { @@ -77,14 +78,14 @@ Obtains the remaining duration before the application is suspended. This API use **System capability**: SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask **Parameters** - | Name| Type| Mandatory| Description| - | -------- | -------- | -------- | -------- | - | requestId | number | Yes| ID of the suspension delay request.| +| Name | Type | Mandatory | Description | +| --------- | ------ | --------- | ----------------------------------- | +| requestId | number | Yes | ID of the suspension delay request. | **Return value** - | Type| Description| - | -------- | -------- | - | Promise<number> | Promise used to return the remaining duration before the application is suspended, in milliseconds.| +| Type | Description | +| --------------------- | ---------------------------------------- | +| Promise<number> | Promise used to return the remaining duration before the application is suspended, in milliseconds. | **Example** ```js @@ -106,9 +107,9 @@ Cancels the suspension delay. **System capability**: SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask **Parameters** - | Name| Type| Mandatory| Description| - | -------- | -------- | -------- | -------- | - | requestId | number | Yes| ID of the suspension delay request.| +| Name | Type | Mandatory | Description | +| --------- | ------ | --------- | ----------------------------------- | +| requestId | number | Yes | ID of the suspension delay request. | **Example** ```js @@ -127,12 +128,12 @@ Requests a continuous task from the system. This API uses an asynchronous callba **System capability**: SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask **Parameters** - | Name| Type| Mandatory| Description| - | -------- | -------- | -------- | -------- | - | context | [Context](js-apis-Context.md) | Yes| Application context.| - | bgMode | [BackgroundMode](#backgroundmode8) | Yes| Background mode requested.| - | wantAgent | [WantAgent](js-apis-notification.md#WantAgent)| Yes| Notification parameter, which is used to specify the target page that is redirected to when a continuous task notification is clicked.| - | callback | AsyncCallback<void> | Yes| Callback used to return the result.| +| Name | Type | Mandatory | Description | +| --------- | ---------------------------------- | --------- | ---------------------------------------- | +| context | [Context](js-apis-Context.md) | Yes | Application context. | +| bgMode | [BackgroundMode](#backgroundmode8) | Yes | Background mode requested. | +| wantAgent | [WantAgent](js-apis-wantAgent.md) | Yes | Notification parameter, which is used to specify the target page that is redirected to when a continuous task notification is clicked. | +| callback | AsyncCallback<void> | Yes | Callback used to return the result. | **Example** ```js @@ -178,17 +179,17 @@ Requests a continuous task from the system. This API uses a promise to return th **System capability**: SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask **Parameters** - - | Name| Type| Mandatory| Description| - | -------- | -------- | -------- | -------- | - | context | [Context](js-apis-Context.md) | Yes| Application context.| - | bgMode | [BackgroundMode](#backgroundmode8) | Yes| Background mode requested.| - | wantAgent | [WantAgent](js-apis-notification.md#WantAgent)| Yes| Notification parameter, which is used to specify the target page when a continuous task notification is clicked.| - + +| Name | Type | Mandatory | Description | +| --------- | ---------------------------------- | --------- | ---------------------------------------- | +| context | [Context](js-apis-Context.md) | Yes | Application context. | +| bgMode | [BackgroundMode](#backgroundmode8) | Yes | Background mode requested. | +| wantAgent | [WantAgent](js-apis-wantAgent.md) | Yes | Notification parameter, which is used to specify the target page when a continuous task notification is clicked. | + **Return value** - | Type | Description | - | -------------- | ------------------------- | - | Promise\ | Promise used to return the result.| +| Type | Description | +| -------------- | ---------------------------------- | +| Promise\ | Promise used to return the result. | **Example** ```js @@ -225,15 +226,13 @@ stopBackgroundRunning(context: Context, callback: AsyncCallback<void>): vo Requests to cancel a continuous task. This API uses an asynchronous callback to return the result. -**Required permissions**: ohos.permission.KEEP_BACKGROUND_RUNNING - **System capability**: SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask **Parameters** - | Name| Type| Mandatory| Description| - | -------- | -------- | -------- | -------- | - | context | [Context](js-apis-Context.md) | Yes| Application context.| - | callback | AsyncCallback<void> | Yes| Callback used to return the result.| +| Name | Type | Mandatory | Description | +| -------- | ----------------------------- | --------- | ----------------------------------- | +| context | [Context](js-apis-Context.md) | Yes | Application context. | +| callback | AsyncCallback<void> | Yes | Callback used to return the result. | **Example** ```js @@ -258,19 +257,17 @@ stopBackgroundRunning(context: Context): Promise<void> Requests to cancel a continuous task. This API uses a promise to return the result. -**Required permissions**: ohos.permission.KEEP_BACKGROUND_RUNNING - **System capability**: SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask **Parameters** - | Name| Type| Mandatory| Description| - | -------- | -------- | -------- | -------- | - | context | [Context](js-apis-Context.md) | Yes| Application context.| +| Name | Type | Mandatory | Description | +| ------- | ----------------------------- | --------- | -------------------- | +| context | [Context](js-apis-Context.md) | Yes | Application context. | **Return value** - | Type | Description | - | -------------- | ------------------------- | - | Promise\ | Promise used to return the result.| +| Type | Description | +| -------------- | ---------------------------------- | +| Promise\ | Promise used to return the result. | **Example** ```js @@ -291,24 +288,24 @@ Provides the information about the suspension delay. **System capability**: SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| requestId | number | Yes| ID of the suspension delay request.| -| actualDelayTime | number | Yes| Actual suspension delay duration of the application, in milliseconds.
The default duration is 180000 when the battery level is higher than or equal to the broadcast low battery level and 60000 when the battery level is lower than the broadcast low battery level.| +| Name | Type | Mandatory | Description | +| --------------- | ------ | --------- | ---------------------------------------- | +| requestId | number | Yes | ID of the suspension delay request. | +| actualDelayTime | number | Yes | Actual suspension delay duration of the application, in milliseconds.
The default duration is 180000 when the battery level is higher than or equal to the broadcast low battery level and 60000 when the battery level is lower than the broadcast low battery level. | ## BackgroundMode8+ **System capability**: SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask -| Name | Value| Description| -| ----------------------- | -------- | -------- | -| DATA_TRANSFER | 1 | Data transfer.| -| AUDIO_PLAYBACK | 2 | Audio playback.| -| AUDIO_RECORDING | 3 | Audio recording.| -| LOCATION | 4 | Positioning and navigation.| -| BLUETOOTH_INTERACTION | 5 | Bluetooth-related task.| -| MULTI_DEVICE_CONNECTION | 6 | Multi-device connection.| -| WIFI_INTERACTION | 7 | WLAN-related (reserved).| -| VOIP | 8 | Voice and video call (reserved).| -| TASK_KEEPING | 9 | Computing task (for PC only).| +| Name | Value | Description | +| ----------------------- | ----- | -------------------------------- | +| DATA_TRANSFER | 1 | Data transfer. | +| AUDIO_PLAYBACK | 2 | Audio playback. | +| AUDIO_RECORDING | 3 | Audio recording. | +| LOCATION | 4 | Positioning and navigation. | +| BLUETOOTH_INTERACTION | 5 | Bluetooth-related task. | +| MULTI_DEVICE_CONNECTION | 6 | Multi-device connection. | +| WIFI_INTERACTION | 7 | WLAN-related (reserved). | +| VOIP | 8 | Voice and video call (reserved). | +| TASK_KEEPING | 9 | Computing task. | diff --git a/en/application-dev/reference/apis/js-apis-system-sensor.md b/en/application-dev/reference/apis/js-apis-system-sensor.md index 9ed5217402da967c4557d220c14e3c2bfc0c7076..e8c267f0b0b0d584013882632f71f7faa88ed4b7 100644 --- a/en/application-dev/reference/apis/js-apis-system-sensor.md +++ b/en/application-dev/reference/apis/js-apis-system-sensor.md @@ -17,9 +17,9 @@ import sensor from '@system.sensor'; ## Error Codes - | Error Code| Description| -| -------- | -------- | -| 900 | The current device does not support the corresponding sensor.| +| Error Code | Description | +| ---------- | ---------------------------------------- | +| 900 | The current device does not support the corresponding sensor. | ## sensor.subscribeAccelerometer @@ -33,19 +33,19 @@ Subscribes to data changes of the acceleration sensor. If this API is called mul **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| interval | string | Yes| Execution frequency of the callback for returning the acceleration sensor data.
The default value is **normal**. The options are as follows:
- **game**: called at an interval of 20 ms, which is applicable to gaming scenarios.
- **ui**: called at an interval of 60 ms, which is applicable to UI updating scenarios.
- **normal**: called at an interval of 200 ms, which is applicable to power-saving scenarios.| -| success | Function | Yes| Called when the acceleration sensor data changes.| -| fail | Function | No| Callback upon failure.| +| Name | Type | Mandatory | Description | +| -------- | -------- | --------- | ---------------------------------------- | +| interval | string | Yes | Execution frequency of the callback for returning the acceleration sensor data.
The default value is **normal**. The options are as follows:
- **game**: called at an interval of 20 ms, which is applicable to gaming scenarios.
- **ui**: called at an interval of 60 ms, which is applicable to UI updating scenarios.
- **normal**: called at an interval of 200 ms, which is applicable to power-saving scenarios. | +| success | Function | Yes | Called when the acceleration sensor data changes. | +| fail | Function | No | Callback upon failure. | Return values of the success callback - | Name| Type| Description| -| -------- | -------- | -------- | -| x | number | Acceleration on the x-axis.| -| y | number | Acceleration on the y-axis.| -| z | number | Acceleration on the z-axis.| +| Name | Type | Description | +| ---- | ------ | --------------------------- | +| x | number | Acceleration on the x-axis. | +| y | number | Acceleration on the y-axis. | +| z | number | Acceleration on the z-axis. | **Example** @@ -92,16 +92,16 @@ Subscribes to data changes of the compass sensor. If this API is called multiple **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| success | Function | Yes| Called when the compass sensor data changes.| -| fail | Function | No| Callback upon failure.| +| Name | Type | Mandatory | Description | +| ------- | -------- | --------- | ---------------------------------------- | +| success | Function | Yes | Called when the compass sensor data changes. | +| fail | Function | No | Callback upon failure. | Return values of the success callback - | Name| Type| Description| -| -------- | -------- | -------- | -| direction | number | Direction of the device, in degrees.| +| Name | Type | Description | +| --------- | ------ | ------------------------------------ | +| direction | number | Direction of the device, in degrees. | **Example** @@ -143,16 +143,16 @@ Subscribes to data changes of the proximity sensor. If this API is called multip **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| success | Function | Yes| Called when the proximity sensor data changes.| -| fail | Function | No| Callback upon failure.| +| Name | Type | Mandatory | Description | +| ------- | -------- | --------- | ---------------------------------------- | +| success | Function | Yes | Called when the proximity sensor data changes. | +| fail | Function | No | Callback upon failure. | Return values of the success callback - | Name| Type| Description| -| -------- | -------- | -------- | -| distance | number | Distance between a visible object and the device screen.| +| Name | Type | Description | +| -------- | ------ | ---------------------------------------- | +| distance | number | Distance between a visible object and the device screen. | **Example** @@ -194,16 +194,16 @@ Subscribes to data changes of the ambient light sensor. If this API is called mu **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| success | Function | Yes| Called when the ambient light sensor data changes| -| fail | Function | No| Callback upon failure.| +| Name | Type | Mandatory | Description | +| ------- | -------- | --------- | ---------------------------------------- | +| success | Function | Yes | Called when the ambient light sensor data changes | +| fail | Function | No | Callback upon failure. | Return values of the success callback - | Name| Type| Description| -| -------- | -------- | -------- | -| intensity | number | Light intensity, in lux.| +| Name | Type | Description | +| --------- | ------ | ------------------------ | +| intensity | number | Light intensity, in lux. | **Example** @@ -247,16 +247,16 @@ Subscribes to data changes of the step counter sensor. If this API is called mul **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| success | Function | Yes| Called when the step counter sensor data changes.| -| fail | Function | No| Callback upon failure.| +| Name | Type | Mandatory | Description | +| ------- | -------- | --------- | ---------------------------------------- | +| success | Function | Yes | Called when the step counter sensor data changes. | +| fail | Function | No | Callback upon failure. | Return values of the success callback - | Name| Type| Description| -| -------- | -------- | -------- | -| steps | number | Number of counted steps after the sensor is restarted.
| +| Name | Type | Description | +| ----- | ------ | ---------------------------------------- | +| steps | number | Number of counted steps after the sensor is restarted.
| **Example** @@ -301,16 +301,16 @@ Subscribes to data changes of the barometer sensor. If this API is called multip **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| success | Function | Yes| Called when the barometer sensor data changes.| -| fail | Function | No| Callback upon failure.| +| Name | Type | Mandatory | Description | +| ------- | -------- | --------- | ---------------------------------------- | +| success | Function | Yes | Called when the barometer sensor data changes. | +| fail | Function | No | Callback upon failure. | Return values of the success callback - | Name| Type| Description| -| -------- | -------- | -------- | -| pressure | number | Pressure, in pascal.| +| Name | Type | Description | +| -------- | ------ | -------------------- | +| pressure | number | Pressure, in pascal. | **Example** @@ -356,16 +356,16 @@ Subscribes to data changes of the heart rate sensor. If this API is called multi **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| success | Function | Yes| Called when the heart rate sensor data changes. This callback is invoked every five seconds.| -| fail | Function | No| Callback upon failure.| +| Name | Type | Mandatory | Description | +| ------- | -------- | --------- | ---------------------------------------- | +| success | Function | Yes | Called when the heart rate sensor data changes. This callback is invoked every five seconds. | +| fail | Function | No | Callback upon failure. | Return values of the success callback - | Name| Type| Description| -| -------- | -------- | -------- | -| heartRate | number | Heart rate.| +| Name | Type | Description | +| --------- | ------ | ----------- | +| heartRate | number | Heart rate. | **Example** @@ -410,16 +410,16 @@ Subscribes to changes of the wearing state of a wearable device. If this API is **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| success | Function | Yes| Called when the wearing state changes.| -| fail | Function | No| Callback upon failure.| +| Name | Type | Mandatory | Description | +| ------- | -------- | --------- | -------------------------------------- | +| success | Function | Yes | Called when the wearing state changes. | +| fail | Function | No | Callback upon failure. | Return values of the success callback - | Name| Type| Description| -| -------- | -------- | -------- | -| value | boolean | Whether the wearable device is worn.| +| Name | Type | Description | +| ----- | ------- | ------------------------------------ | +| value | boolean | Whether the wearable device is worn. | **Example** @@ -461,17 +461,17 @@ Obtains the wearing state of a wearable device. **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| success | Function | No| Callback upon success.| -| fail | Function | No| Callback upon failure.| -| complete | Function | No| Called when the execution is complete.| +| Name | Type | Mandatory | Description | +| -------- | -------- | --------- | -------------------------------------- | +| success | Function | No | Callback upon success. | +| fail | Function | No | Callback upon failure. | +| complete | Function | No | Called when the execution is complete. | Return values of the success callback - | Name| Type| Description| -| -------- | -------- | -------- | -| value | boolean | Whether the wearable device is worn.| +| Name | Type | Description | +| ----- | ------- | ------------------------------------ | +| value | boolean | Whether the wearable device is worn. | **Example** @@ -498,18 +498,18 @@ If this API is called multiple times for the same application, the last call tak **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| interval | string | Yes| Interval at which the callback is invoked to return the device orientation sensor data.
The default value is **normal**. The options are as follows:
- **game**: called at an interval of 20 ms, which is applicable to gaming scenarios.
- **ui**: called at an interval of 60 ms, which is applicable to UI updating scenarios.
- **normal**: called at an interval of 200 ms, which is applicable to power-saving scenarios.| -| success | Function | Yes| Called when the device orientation sensor data changes.| -| fail | Function | No| Callback upon failure.| +| Name | Type | Mandatory | Description | +| -------- | -------- | --------- | ---------------------------------------- | +| interval | string | Yes | Interval at which the callback is invoked to return the device orientation sensor data.
The default value is **normal**. The options are as follows:
- **game**: called at an interval of 20 ms, which is applicable to gaming scenarios.
- **ui**: called at an interval of 60 ms, which is applicable to UI updating scenarios.
- **normal**: called at an interval of 200 ms, which is applicable to power-saving scenarios. | +| success | Function | Yes | Called when the device orientation sensor data changes. | +| fail | Function | No | Callback upon failure. | Return values of the success callback - | Name| Type| Description| -| -------- | -------- | -------- | -| alpha | number | Rotation angle around the Z axis when the X/Y axis of the mobile phone coincides with the X/Y axis of the earth.| -| beta | number | Rotation angle around the X axis when the Y/Z axis of the mobile phone coincides with the Y/Z axis of the earth.| -| gamma | number | Rotation angle around the Y axis when the X/Z axis of the mobile phone coincides with the X/Z axis of the earth.| +| Name | Type | Description | +| ----- | ------ | ---------------------------------------- | +| alpha | number | Rotation angle around the Z axis when the X/Y axis of the mobile device coincides with the X/Y axis of the earth. | +| beta | number | Rotation angle around the X axis when the Y/Z axis of the mobile device coincides with the Y/Z axis of the earth. | +| gamma | number | Rotation angle around the Y axis when the X/Z axis of the mobile device coincides with the X/Z axis of the earth. | **Example** @@ -558,19 +558,19 @@ If this API is called multiple times for the same application, the last call tak **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| interval | string | Yes| Interval at which the callback is invoked to return the gyroscope sensor data.
The default value is **normal**. The options are as follows:
- **game**: called at an interval of 20 ms, which is applicable to gaming scenarios.
- **ui**: called at an interval of 60 ms, which is applicable to UI updating scenarios.
- **normal**: called at an interval of 200 ms, which is applicable to power-saving scenarios.| -| success | Function | Yes| Called when the gyroscope sensor data changes.| -| fail | Function | No| Callback upon failure.| +| Name | Type | Mandatory | Description | +| -------- | -------- | --------- | ---------------------------------------- | +| interval | string | Yes | Interval at which the callback is invoked to return the gyroscope sensor data.
The default value is **normal**. The options are as follows:
- **game**: called at an interval of 20 ms, which is applicable to gaming scenarios.
- **ui**: called at an interval of 60 ms, which is applicable to UI updating scenarios.
- **normal**: called at an interval of 200 ms, which is applicable to power-saving scenarios. | +| success | Function | Yes | Called when the gyroscope sensor data changes. | +| fail | Function | No | Callback upon failure. | Return values of the success callback - | Name| Type| Description| -| -------- | -------- | -------- | -| x | number | Rotation angular velocity of the X axis.| -| y | number | Rotation angular velocity of the Y axis.| -| z | number | Rotation angular velocity of the Z axis.| +| Name | Type | Description | +| ---- | ------ | ---------------------------------------- | +| x | number | Rotation angular velocity of the X axis. | +| y | number | Rotation angular velocity of the Y axis. | +| z | number | Rotation angular velocity of the Z axis. | **Example** diff --git a/en/application-dev/reference/apis/js-apis-update.md b/en/application-dev/reference/apis/js-apis-update.md index a9a417c88513e0d39dd5f6fa68892574b7a62d0b..d84b4bdcd5acbe6169c8172961f935f254f5a7d2 100644 --- a/en/application-dev/reference/apis/js-apis-update.md +++ b/en/application-dev/reference/apis/js-apis-update.md @@ -1,6 +1,6 @@ # Update -> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**
+> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE** > The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version. The Update module applies to updates throughout the entire system, including built-in resources and preset applications, but not third-party applications. @@ -8,7 +8,7 @@ The Update module applies to updates throughout the entire system, including bui There are two types of updates: SD card update and over the air (OTA) update. - The SD card update depends on the update packages and SD cards. -- The OTA update depends on the server deployed by the phone manufacturer for managing update packages. The OTA server IP address is passed by the caller. The request interface is fixed and developed by the phone manufacturer. +- The OTA update depends on the server deployed by the device manufacturer for managing update packages. The OTA server IP address is passed by the caller. The request interface is fixed and developed by the device manufacturer. ## Modules to Import @@ -30,16 +30,16 @@ Obtains the **Updater** object for local update. **Parameters** -| Name | Type | Mandatory| Description | -| ----------- | --------------------------- | ---- | -------- | -| upgradeFile | string | Yes | Update file.| -| updateType | [UpdateTypes](#updatetypes) | Yes | Update type.| +| Name | Type | Mandatory | Description | +| ----------- | --------------------------- | --------- | ------------ | +| upgradeFile | string | Yes | Update file. | +| updateType | [UpdateTypes](#updatetypes) | Yes | Update type. | -**Return Value** +**Return value** -| Type | Description | -| ------------------- | -------- | -| [Updater](#updater) | **Updater** object.| +| Type | Description | +| ------------------- | ------------------- | +| [Updater](#updater) | **Updater** object. | **Example** @@ -61,17 +61,17 @@ Obtains the **Updater** object for the device to be updated. **Parameters** -| Name | Type | Mandatory| Description | -| ----------- | --------------------------- | ---- | ---------- | -| upgradeFile | string | Yes | Update file. | -| device | string | Yes | Device to be updated.| -| updateType | [UpdateTypes](#updatetypes) | Yes | Update type. | +| Name | Type | Mandatory | Description | +| ----------- | --------------------------- | --------- | --------------------- | +| upgradeFile | string | Yes | Update file. | +| device | string | Yes | Device to be updated. | +| updateType | [UpdateTypes](#updatetypes) | Yes | Update type. | -**Return Value** +**Return value** -| Type | Description | -| ------------------- | -------- | -| [Updater](#updater) | **Updater** object.| +| Type | Description | +| ------------------- | ------------------- | +| [Updater](#updater) | **Updater** object. | **Example** @@ -93,17 +93,17 @@ Obtains the **Updater** object from another device for the device to be updated. **Parameters** -| Name | Type | Mandatory| Description | -| ----------- | --------------------------- | ---- | ---------- | -| upgradeFile | string | Yes | Update file. | -| device | string | Yes | Device to be updated.| -| updateType | [UpdateTypes](#updatetypes) | Yes | Update type. | +| Name | Type | Mandatory | Description | +| ----------- | --------------------------- | --------- | --------------------- | +| upgradeFile | string | Yes | Update file. | +| device | string | Yes | Device to be updated. | +| updateType | [UpdateTypes](#updatetypes) | Yes | Update type. | -**Return Value** +**Return value** -| Type | Description | -| ------------------- | -------- | -| [Updater](#updater) | **Updater** object.| +| Type | Description | +| ------------------- | ------------------- | +| [Updater](#updater) | **Updater** object. | **Example** @@ -121,15 +121,15 @@ try { getNewVersionInfo(callback: AsyncCallback\): void -Obtains the new version information. This API uses an asynchronous callback to return the result. +Obtains the new version information. This function uses an asynchronous callback to return the result. **System capability**: SystemCapability.Update.UpdateService **Parameters** -| Name | Type | Mandatory| Description | -| -------- | ------------------------------------------------ | ---- | ------------------ | -| callback | AsyncCallback<[NewVersionInfo](#newversioninfo)> | No | Callback used to return the result.| +| Name | Type | Mandatory | Description | +| -------- | ---------------------------------------- | --------- | ---------------------------------------- | +| callback | AsyncCallback<[NewVersionInfo](#newversioninfo)> | No | Callback used to return the new version information. | **Example** @@ -146,15 +146,15 @@ update.getNewVersionInfo(info => { getNewVersionInfo(): Promise\ -Obtains the new version information. This API uses a promise to return the result. +Obtains the new version information. This function uses a promise to return the result. **System capability**: SystemCapability.Update.UpdateService -**Return Value** +**Return value** -| Type | Description | -| ------------------------------------------- | ------------------------- | -| Promise\<[NewVersionInfo](#newversioninfo)> | Promise used to return the result.| +| Type | Description | +| ---------------------------------------- | ---------------------------------------- | +| Promise\<[NewVersionInfo](#newversioninfo)> | Promise used to return the new version information. | **Example** @@ -172,15 +172,15 @@ updater.getNewVersionInfo().then(value => { checkNewVersion(callback: AsyncCallback\): void -Checks whether the current version is the latest. This API uses an asynchronous callback to return the result. +Checks whether the current version is the latest. This function uses an asynchronous callback to return the result. **System capability**: SystemCapability.Update.UpdateService **Parameters** -| Name | Type | Mandatory| Description | -| -------- | ------------------------------------------------- | ---- | ------------------ | -| callback | AsyncCallback\<[NewVersionInfo](#newversioninfo)> | No | Callback used to return the result.| +| Name | Type | Mandatory | Description | +| -------- | ---------------------------------------- | --------- | ---------------------------------------- | +| callback | AsyncCallback\<[NewVersionInfo](#newversioninfo)> | No | Callback used to return the new version information. | **Example** @@ -197,15 +197,15 @@ update.checkNewVersion(info => { checkNewVersion(): Promise\ -Checks whether the current version is the latest. This API uses a promise to return the result. +Checks whether the current version is the latest. This function uses a promise to return the result. **System capability**: SystemCapability.Update.UpdateService -**Return Value** +**Return value** -| Type | Description | -| ------------------------------------------- | ------------------------- | -| Promise\<[NewVersionInfo](#newversioninfo)> | Promise used to return the result.| +| Type | Description | +| ---------------------------------------- | ---------------------------------------- | +| Promise\<[NewVersionInfo](#newversioninfo)> | Promise used to return the new version information. | **Example** @@ -229,10 +229,10 @@ Verifies whether the update package is valid. **Parameters** -| Name | Type | Mandatory| Description | -| ----------- | ------ | ---- | ------------------ | -| upgradeFile | string | Yes | Path of the update package to be verified.| -| certsFile | string | Yes | Certificate path. | +| Name | Type | Mandatory | Description | +| ----------- | ------ | --------- | ---------------------------------------- | +| upgradeFile | string | Yes | Path of the update package to be verified. | +| certsFile | string | Yes | Certificate path. | **Example** @@ -247,15 +247,15 @@ update.verifyUpdatePackage("XXX", "XXX"); rebootAndCleanUserData(): Promise\ -Reboots the device and clears the user partition data. This API uses a promise to return the result. +Reboots the device and clears the user partition data. This function uses a promise to return the result. **System capability**: SystemCapability.Update.UpdateService -**Return Value** +**Return value** -| Type | Description | -| ---------------- | ------------------------------- | -| Promise\ | Promise used to return the result.| +| Type | Description | +| ---------------- | ---------------------------------------- | +| Promise\ | Promise used to return the execution result. | **Example** @@ -271,15 +271,15 @@ update.rebootAndCleanUserData().then(result => { rebootAndCleanUserData(callback: AsyncCallback\): void -Reboots the device and clears the user partition data. This API uses an asynchronous callback to return the result. +Reboots the device and clears the user partition data. This function uses a promise to return the result. **System capability**: SystemCapability.Update.UpdateService **Parameters** -| Name | Type | Mandatory| Description | -| -------- | -------- | ---- | ---------------------- | -| callback | AsyncCallback\| Yes | Callback used to return the result.| +| Name | Type | Mandatory | Description | +| -------- | ---------------------- | --------- | ---------------------------------------- | +| callback | AsyncCallback\ | Yes | Callback used to return the execution result. | **Example** @@ -293,15 +293,15 @@ update.rebootAndCleanUserData(result => { applyNewVersion(): Promise\ -Installs the update package. This API uses a promise to return the result. +Installs the update package. This function uses a promise to return the result. **System capability**: SystemCapability.Update.UpdateService -**Return Value** +**Return value** -| Type | Description | -| ---------------- | ------------------------------- | -| Promise\ | Promise used to return the result.| +| Type | Description | +| ---------------- | ---------------------------------------- | +| Promise\ | Promise used to return the execution result. | **Example** @@ -317,15 +317,15 @@ update.applyNewVersion().then(result => { applyNewVersion(callback: AsyncCallback\): void -Installs the update package. This API uses an asynchronous callback to return the result. +Installs the update package. This function uses a promise to return the result. **System capability**: SystemCapability.Update.UpdateService **Parameters** -| Name | Type | Mandatory| Description | -| -------- | -------- | ---- | ---------------------- | -| callback | AsyncCallback\| Yes | Callback used to return the result.| +| Name | Type | Mandatory | Description | +| -------- | ---------------------- | --------- | ---------------------------------------- | +| callback | AsyncCallback\ | Yes | Callback used to return the execution result. | **Example** @@ -356,7 +356,7 @@ updater.download(); ### upgrade -updater.upgrade():void +upgrade():void Starts an update. @@ -377,16 +377,16 @@ updater.upgrade(); setUpdatePolicy(policy: UpdatePolicy, callback: AsyncCallback\): void -Sets the update policy. This API uses an asynchronous callback to return the result. +Sets the update policy. This function uses an asynchronous callback to return the result. **System capability**: SystemCapability.Update.UpdateService **Parameters** -| Name | Type | Mandatory| Description | -| -------- | ----------------------------- | ---- | ------------ | -| policy | [UpdatePolicy](#updatepolicy) | Yes | Update policy to set.| -| callback | AsyncCallback\ | Yes | Callback used to return the result.| +| Name | Type | Mandatory | Description | +| -------- | ---------------------------------------- | --------- | ---------------------------------------- | +| policy | [UpdatePolicy](#updatepolicy) | Yes | Update policy to set. | +| callback | Callback used to return the execution result. | Yes | Callback used to return the execution result. | **Example** @@ -408,21 +408,21 @@ update.setUpdatePolicy(policy, result => { setUpdatePolicy(policy: UpdatePolicy): Promise\ -Sets the update policy. This API uses a promise to return the result. +Sets the update policy. This function uses a promise to return the result. **System capability**: SystemCapability.Update.UpdateService **Parameters** -| Name| Type | Mandatory| Description | -| ------ | ----------------------------- | ---- | ------------ | -| policy | [UpdatePolicy](#updatepolicy) | Yes | Update policy to set.| +| Name | Type | Mandatory | Description | +| ------ | ----------------------------- | --------- | --------------------- | +| policy | [UpdatePolicy](#updatepolicy) | Yes | Update policy to set. | -**Return Value** +**Return value** -| Type | Description | -| ---------------- | ----------------------- | -| Promise\ | Promise used to return the result.| +| Type | Description | +| ---------------- | ---------------------------------------- | +| Promise\ | Promise used to return the execution result. | **Example** @@ -445,15 +445,15 @@ update.setUpdatePolicy(policy).then(result => getUpdatePolicy(callback: AsyncCallback\): void -Obtains the update policy. This API uses an asynchronous callback to return the result. +Obtains the update policy. This function uses an asynchronous callback to return the result. **System capability**: SystemCapability.Update.UpdateService **Parameters** -| Name | Type | Mandatory| Description | -| -------- | --------------------------------------------- | ---- | -------------------- | -| callback | AsyncCallback\<[UpdatePolicy](#updatepolicy)> | No | Callback used to return the result.| +| Name | Type | Mandatory | Description | +| -------- | ---------------------------------------- | --------- | ---------------------------------------- | +| callback | AsyncCallback\<[UpdatePolicy](#updatepolicy)> | No | Callback used to return the update policy. | **Example** @@ -470,15 +470,15 @@ update.getUpdatePolicy(policy => { getUpdatePolicy(): Promise\ -Obtains the update policy. This API uses a promise to return the result. +Obtains the update policy. This function uses a promise to return the result. **System capability**: SystemCapability.Update.UpdateService -**Return Value** +**Return value** -| Type | Description | -| --------------------------------------- | --------------------------- | -| Promise\<[UpdatePolicy](#updatepolicy)> | Promise used to return the result.| +| Type | Description | +| --------------------------------------- | ---------------------------------------- | +| Promise\<[UpdatePolicy](#updatepolicy)> | Promise used to return the update policy. | **Example** @@ -498,10 +498,10 @@ Enumerates update types. **System capability**: SystemCapability.Update.UpdateService -| Name| Description | -| ------ | -------- | -| OTA | OTA update. | -| patch | Patch update.| +| Name | Description | +| ----- | ------------- | +| OTA | OTA update. | +| patch | Patch update. | ## PackageTypes @@ -509,15 +509,15 @@ Enumerates update package types. **System capability**: SystemCapability.Update.UpdateService -| Name | Default Value| Description | -| -------------------- | ------ | -------------- | -| PACKAGE_TYPE_NORMAL | 1 | Common update package. | -| PACKAGE_TYPE_BASE | 2 | Basic update package. | -| PACKAGE_TYPE_CUST | 3 | Custom update package. | -| PACKAGE_TYPE_PRELOAD | 4 | Preinstalled update package. | -| PACKAGE_TYPE_COTA | 5 | Parameter configuration update package.| -| PACKAGE_TYPE_VERSION | 6 | Version update package. | -| PACKAGE_TYPE_PATCH | 7 | Patch packages | +| Name | Default Value | Description | +| -------------------- | ------------- | --------------------------------------- | +| PACKAGE_TYPE_NORMAL | 1 | Common update package. | +| PACKAGE_TYPE_BASE | 2 | Basic update package. | +| PACKAGE_TYPE_CUST | 3 | Custom update package. | +| PACKAGE_TYPE_PRELOAD | 4 | Preinstalled update package. | +| PACKAGE_TYPE_COTA | 5 | Parameter configuration update package. | +| PACKAGE_TYPE_VERSION | 6 | Version update package. | +| PACKAGE_TYPE_PATCH | 7 | Patch package. | ## InstallMode @@ -525,11 +525,11 @@ Enumerates update modes. **System capability**: SystemCapability.Update.UpdateService -| Name | Default Value| Description | -| ------------------- | ------ | -------- | -| INSTALL_MODE_NORMAL | 0 | Normal update.| -| INSTALL_MODE_NIGHT | 1 | Update at night.| -| INSTALL_MODE_AUTO | 2 | Automatic update.| +| Name | Default Value | Description | +| ------------------- | ------------- | ----------------- | +| INSTALL_MODE_NORMAL | 0 | Normal update. | +| INSTALL_MODE_NIGHT | 1 | Update at night. | +| INSTALL_MODE_AUTO | 2 | Automatic update. | ## NewVersionStatus @@ -537,12 +537,12 @@ Enumerates new version check results. **System capability**: SystemCapability.Update.UpdateService -| Name | Default Value| Description | -| ------------------- | ------ | ---------------- | -| VERSION_STATUS_ERR | -1 | System error while checking for the new version. | -| VERSION_STATUS_NEW | 0 | New version detected. | -| VERSION_STATUS_NONE | 1 | No new version detected.| -| VERSION_STATUS_BUSY | 2 | System busy while checking for the new version. | +| Name | Default Value | Description | +| ------------------- | ------------- | ---------------------------------------- | +| VERSION_STATUS_ERR | -1 | System error while checking for the new version. | +| VERSION_STATUS_NEW | 0 | New version detected. | +| VERSION_STATUS_NONE | 1 | No new version detected. | +| VERSION_STATUS_BUSY | 2 | System busy while checking for the new version. | ## UpdatePolicy @@ -550,11 +550,11 @@ Defines the update policy. **System capability**: SystemCapability.Update.UpdateService -| Name | Type | Mandatory| Description | -| ------------------- | --------------------------- | ---- | -------------- | -| autoDownload | bool | Yes | Automatic update switch. | -| installMode | [InstallMode](#installmode) | Yes | Installation mode. | -| autoUpgradeInterval | Array\ | Yes | Period of time for automatic update.| +| Name | Type | Mandatory | Description | +| ------------------- | --------------------------- | --------- | ------------------------------------ | +| autoDownload | bool | Yes | Automatic update switch. | +| installMode | [InstallMode](#installmode) | Yes | Update mode. | +| autoUpgradeInterval | Array\ | Yes | Period of time for automatic update. | ## NewVersionInfo @@ -562,12 +562,12 @@ Defines the new version information. **System capability**: SystemCapability.Update.UpdateService -| Name | Type | Mandatory| Description | -| --------------- | ------------------------------------------- | ---- | -------- | -| status | [NewVersionStatus](#newversionstatus) | Yes | Update status.| -| errMsg | string | Yes | Error message.| -| checkResults | Array<[CheckResult](#checkresult)> | Yes | Version check result.| -| descriptionInfo | Array\<[DescriptionInfo](#descriptioninfo)> | Yes | Version description information.| +| Name | Type | Mandatory | Description | +| --------------- | ---------------------------------------- | --------- | -------------------------------- | +| status | [NewVersionStatus](#newversionstatus) | Yes | Update status. | +| errMsg | string | Yes | Error message. | +| checkResults | Array<[CheckResult](#checkresult)> | Yes | Version check result. | +| descriptionInfo | Array\<[DescriptionInfo](#descriptioninfo)> | Yes | Version description information. | ## CheckResult @@ -575,14 +575,14 @@ Defines the version check result. **System capability**: SystemCapability.Update.UpdateService -| Name | Type | Mandatory| Description | -| ------------- | ----------------------------- | ---- | ------------ | -| versionName | string | Yes | Version name. | -| versionCode | number | Yes | Version code. | -| size | number | Yes | Version size. | -| verifyInfo | string | Yes | Version verification information.| -| packageType | [PackageTypes](#packagetypes) | Yes | Version type. | -| descriptionId | string | Yes | Version description information.| +| Name | Type | Mandatory | Description | +| ------------- | ----------------------------- | --------- | --------------------------------- | +| versionName | string | Yes | Version name. | +| versionCode | number | Yes | Version code. | +| size | number | Yes | Version size. | +| verifyInfo | string | Yes | Version verification information. | +| packageType | [PackageTypes](#packagetypes) | Yes | Version type. | +| descriptionId | string | Yes | Version description information. | ## DescriptionInfo @@ -590,7 +590,7 @@ Defines the version description information. **System capability**: SystemCapability.Update.UpdateService -| Name | Type| Mandatory| Description | -| ------------- | -------- | ---- | ----------------- | -| descriptionId | string | Yes | Version ID information.| -| content | string | Yes | Version changelog information.| +| Name | Type | Mandatory | Description | +| ------------- | ------ | --------- | ------------------------------ | +| descriptionId | string | Yes | Version ID information. | +| content | string | Yes | Version changelog information. | diff --git a/en/application-dev/reference/arkui-js/js-components-basic-button.md b/en/application-dev/reference/arkui-js/js-components-basic-button.md index 0e3cd7fe5e0f3ff9f43ebb0c45dad2676de730d4..771a5a55404f5bccfab8350837e74dc049bdc298 100644 --- a/en/application-dev/reference/arkui-js/js-components-basic-button.md +++ b/en/application-dev/reference/arkui-js/js-components-basic-button.md @@ -32,7 +32,7 @@ In addition to the attributes in [Universal Attributes](js-components-common-at

No

Dynamic modification is not supported. If this attribute is not set, capsule-like buttons are displayed. Different from the capsule button, the four rounded corners of a capsule-like button can be configured using border-radius. Available button types are as follows:

-
  • capsule: a capsule button with fillets, background color, and text
  • circle: a circle button which can be used to place icons
  • text: a text button which displays the text only
  • arc: an arc button. This value is applicable to wearables only.
  • download: a download button. The download progress bar is added. This value is applicable to smart TVs and smartphones.
+
  • capsule: a capsule button with fillets, background color, and text
  • circle: a circle button which can be used to place icons
  • text: a text button which displays the text only
  • arc: an arc button. This value is applicable to wearables only.
  • download: a download button. The download progress bar is added.

value

diff --git a/en/application-dev/reference/arkui-js/js-components-basic-chart.md b/en/application-dev/reference/arkui-js/js-components-basic-chart.md index cfb8ae34e6ea898ca580e58a0ac7ebcd7a16569c..c635eb624433b2333a8a912a531cf457912c8f9e 100644 --- a/en/application-dev/reference/arkui-js/js-components-basic-chart.md +++ b/en/application-dev/reference/arkui-js/js-components-basic-chart.md @@ -72,7 +72,7 @@ In addition to the attributes in [Universal Attributes](js-components-common-at

Data structures used by progress, loading, and rainbow charts.

DataSegment is available for progress and loading charts.

Array<DataSegment> is available for rainbow charts. A maximum of nine DataSegment are supported in the array.

-
NOTE:

This attribute is only supported on phones and tablets.

+

@@ -85,7 +85,7 @@ In addition to the attributes in [Universal Attributes](js-components-common-at

No

Whether to enable the effects for progress and rainbow charts.

-
NOTE:

This attribute is only supported on phones and tablets.

+

@@ -98,7 +98,7 @@ In addition to the attributes in [Universal Attributes](js-components-common-at

No

Animation duration for expanding a rainbow chart, in milliseconds.

-
NOTE:

This attribute is only supported on phones and tablets.

+

diff --git a/en/application-dev/reference/arkui-js/js-components-basic-picker-view.md b/en/application-dev/reference/arkui-js/js-components-basic-picker-view.md index 358309449063dab4098feb7ee2b00d2522d62a8b..bf54c96ec25a1b3d4895a6f5fe9bd7c09eff183f 100644 --- a/en/application-dev/reference/arkui-js/js-components-basic-picker-view.md +++ b/en/application-dev/reference/arkui-js/js-components-basic-picker-view.md @@ -225,8 +225,8 @@ Date selector \(**type** is **date**\)

No

-

Whether to display the lunar calendar switch in the date selector. When this switch is displayed, you can switch between the lunar calendar and Gregorian calendar. Turn on the switch to display the lunar calendar, and turn off the switch to hide the lunar calendar. This attribute is available for smartphones.

-
NOTE:

This attribute is only supported on phones and tablets.

+

Whether to display the lunar calendar switch in the date selector. When this switch is displayed, you can switch between the lunar calendar and Gregorian calendar. Turn on the switch to display the lunar calendar, and turn off the switch to hide the lunar calendar.

+

@@ -293,8 +293,8 @@ Date and time selector \(**type** is **datetime**\)

No

-

Whether to display the lunar calendar switch in the date and time selector. When this switch is displayed, you can switch between the lunar calendar and Gregorian calendar. Turn on the switch to display the lunar calendar, and turn off the switch to hide the lunar calendar. This attribute is available for smartphones.

-
NOTE:

This attribute is only supported on phones and tablets.

+

Whether to display the lunar calendar switch in the date and time selector. When this switch is displayed, you can switch between the lunar calendar and Gregorian calendar. Turn on the switch to display the lunar calendar, and turn off the switch to hide the lunar calendar.

+

@@ -424,7 +424,7 @@ In addition to the styles in [Universal Styles](js-components-common-styles.md)

No

Font color of the items that gradually disappear. Disappearing items are the top option and bottom option of a column containing five options in total.

-
NOTE:

This attribute is only supported on phones and tablets.

+
NOTE:

@@ -437,7 +437,7 @@ In addition to the styles in [Universal Styles](js-components-common-styles.md)

No

Font size of the items that gradually disappear. Disappearing items are the top option and bottom option of a column containing five options in total.

-
NOTE:

This attribute is only supported on phones and tablets.

+
NOTE:

diff --git a/en/application-dev/reference/arkui-js/js-components-basic-picker.md b/en/application-dev/reference/arkui-js/js-components-basic-picker.md index 1b161a67e12f80fd51410ad89adebb737ca4db91..87e858c2fceb9d83feaffb3b03f95a031e5d2a73 100644 --- a/en/application-dev/reference/arkui-js/js-components-basic-picker.md +++ b/en/application-dev/reference/arkui-js/js-components-basic-picker.md @@ -178,7 +178,7 @@ When **type** is set to **date**, a date selector is used.

No

Whether the date selector displays the lunar calendar switch, which is used to switch between the Gregorian calendar and lunar calendar. The value true means to display the lunar calendar switch for users to switch between the Gregorian calendar and lunar calendar. The value false means not to display the lunar calendar switch.

-
NOTE:

This attribute is only supported on phones and tablets. When both lunarswitch and lunar are set to true, the switch is selected.

+
NOTE:

When both lunarswitch and lunar are set to true, the switch is selected.

@@ -329,7 +329,7 @@ When **type** is set to **datetime**, a date and time selector is used.

No

Whether the date selector displays the lunar calendar switch, which is used to switch between the Gregorian calendar and lunar calendar. The value true means to display the lunar calendar switch for users to switch between the Gregorian calendar and lunar calendar. The value false means not to display the lunar calendar switch.

-
NOTE:

This attribute is only supported on phones and tablets. When both lunarswitch and lunar are set to true, the switch is selected.

+
NOTE:

When both lunarswitch and lunar are set to true, the switch is selected.

@@ -529,7 +529,7 @@ In addition to the styles in [Universal Styles](js-components-common-styles.md)

No

Height of the selector option list.

-
NOTE:

This attribute is only supported on phones and tablets.

+

diff --git a/en/application-dev/reference/arkui-js/js-components-basic-rating.md b/en/application-dev/reference/arkui-js/js-components-basic-rating.md index 35811a0973e287b7a3487b209e0c09a5a0f1c769..aa86324255adcc621eb4b11527f96d3df3ac7f59 100644 --- a/en/application-dev/reference/arkui-js/js-components-basic-rating.md +++ b/en/application-dev/reference/arkui-js/js-components-basic-rating.md @@ -58,7 +58,7 @@ In addition to the attributes in [Universal Attributes](js-components-common-at

No

Step to increment the rating value.

-
NOTE:

This attribute is only supported on phones and tablets.

+

diff --git a/en/application-dev/reference/arkui-js/js-components-basic-slider.md b/en/application-dev/reference/arkui-js/js-components-basic-slider.md index 314f192543e46dc0977954acd373b29958721c58..27d23ac9fb965300fb32f92dcdde9548d038450a 100644 --- a/en/application-dev/reference/arkui-js/js-components-basic-slider.md +++ b/en/application-dev/reference/arkui-js/js-components-basic-slider.md @@ -76,7 +76,7 @@ In addition to the attributes in [Universal Attributes](js-components-common-at

No

Slider style. Available values are as follows:

-
  • outset: The slider is on the sliding bar.
  • inset: The slider is inside the sliding bar.
    NOTE:

    This attribute is only supported on phones and tablets.

    +
    • outset: The slider is on the sliding bar.
    • inset: The slider is inside the sliding bar.

    @@ -90,7 +90,7 @@ In addition to the attributes in [Universal Attributes](js-components-common-at

    No

    Whether to display slider scales.

    -
    NOTE:

    This attribute is only supported on phones and tablets.

    +

    @@ -103,7 +103,7 @@ In addition to the attributes in [Universal Attributes](js-components-common-at

    No

    Whether a pop-up is displayed to show the percentage value on the slider.

    -
    NOTE:

    This attribute is only supported on phones and tablets.

    +

    @@ -158,7 +158,7 @@ In addition to the styles in [Universal Styles](js-components-common-styles.md)

    No

    Slider color.

    -
    NOTE:

    This attribute is only supported on phones, tablets, and wearables.

    +

    diff --git a/en/application-dev/reference/arkui-js/js-components-container-refresh.md b/en/application-dev/reference/arkui-js/js-components-container-refresh.md index d428fe32b243f25b76cd92bd7c9e88a221d166bd..9320f930ba8affc1b9be7b0508c8ac2dffc2dced 100644 --- a/en/application-dev/reference/arkui-js/js-components-container-refresh.md +++ b/en/application-dev/reference/arkui-js/js-components-container-refresh.md @@ -92,7 +92,7 @@ In addition to the attributes in [Universal Attributes](js-components-common-at

    No

    Pull-down friction coefficient. The value ranges from 0 to 100. A larger value indicates a more responsive component. For example, if a user pulls the component down 100 px, it will actually move 100 * friction% px.

    -
    NOTE:

    This attribute is only supported on phones, tablets, and wearables.

    +

    diff --git a/en/application-dev/reference/arkui-ts/ts-basic-components-web.md b/en/application-dev/reference/arkui-ts/ts-basic-components-web.md index 948ad5920d906f7437d20e9a0ffd6511e13bd7ac..97cb13479644e2b679e452c9e4ed0967efb9ba63 100644 --- a/en/application-dev/reference/arkui-ts/ts-basic-components-web.md +++ b/en/application-dev/reference/arkui-ts/ts-basic-components-web.md @@ -5,6 +5,9 @@ The **** component can be used to display web pages. +## Required Permissions +ohos.permission.INTERNET, required only for accessing online web pages. + ## Child Components None @@ -15,10 +18,10 @@ None Table 1 Parameters of options - | Name | Type | Mandatory| Default Value| Description | - | ---------- | ------------------------------- | ---- | ------ | -------------- | - | src | string | Yes | - | Address of a web page resource.| - | controller | [WebController](#WebController) | No | - | Controller. | + | Name | Type | Mandatory | Default Value | Description | + | ---------- | ------------------------------- | --------- | ------------- | ------------------------------- | + | src | string | Yes | - | Address of a web page resource. | + | controller | [WebController](#webcontroller) | No | - | Controller. | > ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE** @@ -28,43 +31,43 @@ None > - Only local audio and video are supported for playback. ## Attributes -| Name | Type | Default Value | Description | -| ----------------- | ------------------------------------------------------------ | -------------- | ------------------------------------------------------------ | -| domStorageAccess | boolean | false | Whether to enable the DOM Storage API permission. By default, the permission is disabled.| -| fileAccess | boolean | true | Whether to enable in-application rawfile access through [$rawfile(filepath/filename)](ts-application-resource-access.md#referencing-resources). By default, this feature is enabled. | -| imageAccess | boolean | true | Whether to enable automatic image loading. By default, this feature is enabled. | -| javaScriptProxy | {
    object: object,
    name: string,
    methodList: Array\,
    controller: WebController
    } | - | JavaScript object to be injected into the window. Methods of this object can be invoked in the window. The parameters in this attribute cannot be updated.
    **object** indicates the object to be registered. Methods can be declared, but not attributes. The parameters and return value can only be of the string, number, or Boolean type.
    **name** indicates the name of the object to be registered, which is the same as that invoked in the window. After registration, the window can use this name to access the JavaScript object at the application side.
    **methodList** indicates the methods of the JavaScript object to be registered at the application side.
    **controller** indicates the controller. | -| javaScriptAccess | boolean | true | Whether JavaScript scripts can be executed. By default, JavaScript scripts can be executed. | -| mixedMode | [MixedMode](#MixedMode) | MixedMode.None | Whether to enable loading of HTTP and HTTPS hybrid content can be loaded. By default, this feature is disabled.| -| onlineImageAccess | boolean | true | Whether to enable access to online images through HTTP and HTTPS. By default, this feature is enabled.| -| zoomAccess | boolean | true | Whether to enable zoom gestures. By default, zoom gestures are enabled. | +| Name | Type | Default Value | Description | +| ----------------- | ---------------------------------------- | -------------- | ---------------------------------------- | +| domStorageAccess | boolean | false | Whether to enable the DOM Storage API permission. By default, the permission is disabled. | +| fileAccess | boolean | true | Whether to enable in-application rawfile access through [$rawfile(filepath/filename)](../../ui/ts-application-resource-access.md). By default, this feature is enabled. | +| imageAccess | boolean | true | Whether to enable automatic image loading. By default, this feature is enabled. | +| javaScriptProxy | {
    object: object,
    name: string,
    methodList: Array\,
    controller: WebController
    } | - | JavaScript object to be injected into the window. Methods of this object can be invoked in the window. The parameters in this attribute cannot be updated.
    **object** indicates the object to be registered. Methods can be declared, but not attributes. The parameters and return value can only be of the string, number, or Boolean type.
    **name** indicates the name of the object to be registered, which is the same as that invoked in the window. After registration, the window can use this name to access the JavaScript object at the application side.
    **methodList** indicates the methods of the JavaScript object to be registered at the application side.
    **controller** indicates the controller. | +| javaScriptAccess | boolean | true | Whether JavaScript scripts can be executed. By default, JavaScript scripts can be executed. | +| mixedMode | MixedMode | MixedMode.None | Whether to enable loading of HTTP and HTTPS hybrid content can be loaded. By default, this feature is disabled. | +| onlineImageAccess | boolean | true | Whether to enable access to online images through HTTP and HTTPS. By default, this feature is enabled. | +| zoomAccess | boolean | true | Whether to enable zoom gestures. By default, zoom gestures are enabled. | > ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE** > > Only the following universal attributes are supported: [width](ts-universal-attributes-size.md#Attributes), [height](ts-universal-attributes-size.md#Attributes), [padding](ts-universal-attributes-size.md#Attributes), [margin](ts-universal-attributes-size.md#Attributes), and [border](ts-universal-attributes-border.md#Attributes). - MixedMode - | Name | Description | - | ---------- | ----------------------------------------------------------- | - | All | HTTP and HTTPS hybrid content can be loaded. This means that all insecure content can be loaded.| - | Compatible | HTTP and HTTPS hybrid content can be loaded in compatibility mode. This means that some insecure content may be loaded. | - | None | HTTP and HTTPS hybrid content cannot be loaded. | + | Name | Description | + | ---------- | ---------------------------------------- | + | All | HTTP and HTTPS hybrid content can be loaded. This means that all insecure content can be loaded. | + | Compatible | HTTP and HTTPS hybrid content can be loaded in compatibility mode. This means that some insecure content may be loaded. | + | None | HTTP and HTTPS hybrid content cannot be loaded. | ## Events Universal events are not supported. -| Name | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | -| onAlert(callback: (event?: { url: string; message: string; result: [JsResult](#JsResult) }) => boolean) |

    Triggered when **alert()** is invoked to display an alert dialog box on the web page.
    If the callback returns **false**, the default dialog box is displayed. If the callback returns **true**, a system application can invoke the system dialog box capability (allows only the confirm operation) and invoke the **JsResult** API to notify the **\** component of the user's operation.
    **url**: URL of the web page where the dialog box is displayed.
    **message**: information displayed in the dialog box.
    **JsResult**: notifies the **\** component of the user's operation.

    | -| onBeforeUnload(callback: (event?: { url: string; message: string; result: [JsResult](#JsResult) }) => boolean) |

    Triggered when the current page is about to exit after the user refreshes or closes the page.
    If the callback returns **false**, the default dialog box is displayed. If the callback returns **true**, a system application can invoke the system dialog box capability (allows the confirm and cancel operations) and invoke the **JsResult** API to notify the **\** component of the user's operation.
    **url**: URL of the web page where the dialog box is displayed.
    **message**: information displayed in the dialog box.
    **JsResult**: notifies the **\** component of the user's operation.

    | -| onConfirm(callback: (event?: { url: string; message: string; result: [JsResult](#JsResult) }) => boolean) |

    Triggered when **confirm()** is invoked to display a confirmation dialog box on the web page.
    If the callback returns **false**, the default dialog box is displayed. If the callback returns **true**, a system application can invoke the system dialog box capability (allows the confirm and cancel operations) and invoke the **JsResult** API to notify the **\** component of the user's operation.
    **url**: URL of the web page where the dialog box is displayed.
    **message**: information displayed in the dialog box.
    **JsResult**: notifies the **\** component of the user's operation.

    | -| onConsole(callback: (event?: { message: [ConsoleMessage](#ConsoleMessage) }) => boolean) |

    Triggered when the host application is notified of a JavaScript console message.
    **message**: console message.

    | +| Name | Description | +| ---------------------------------------- | ---------------------------------------- | +| onAlert(callback: (event?: { url: string; message: string; result: [JsResult](#jsresult) }) => boolean) |

    Triggered when **alert()** is invoked to display an alert dialog box on the web page.
    If the callback returns **false**, the default dialog box is displayed. If the callback returns **true**, a system application can invoke the system dialog box capability (allows only the confirm operation) and invoke the **JsResult** API to notify the **\** component of the user's operation.
    **url**: URL of the web page where the dialog box is displayed.
    **message**: information displayed in the dialog box.
    **JsResult**: notifies the **\** component of the user's operation.

    | +| onBeforeUnload(callback: (event?: { url: string; message: string; result: [JsResult](#jsresult) }) => boolean) |

    Triggered when the current page is about to exit after the user refreshes or closes the page.
    If the callback returns **false**, the default dialog box is displayed. If the callback returns **true**, a system application can invoke the system dialog box capability (allows the confirm and cancel operations) and invoke the **JsResult** API to notify the **\** component of the user's operation.
    **url**: URL of the web page where the dialog box is displayed.
    **message**: information displayed in the dialog box.
    **JsResult**: notifies the **\** component of the user's operation.

    | +| onConfirm(callback: (event?: { url: string; message: string; result: [JsResult](#jsresult) }) => boolean) |

    Triggered when **confirm()** is invoked to display a confirmation dialog box on the web page.
    If the callback returns **false**, the default dialog box is displayed. If the callback returns **true**, a system application can invoke the system dialog box capability (allows the confirm and cancel operations) and invoke the **JsResult** API to notify the **\** component of the user's operation.
    **url**: URL of the web page where the dialog box is displayed.
    **message**: information displayed in the dialog box.
    **JsResult**: notifies the **\** component of the user's operation.

    | +| onConsole(callback: (event?: { message: [ConsoleMessage](#consolemessage) }) => boolean) |

    Triggered when the host application is notified of a JavaScript console message.
    **message**: console message.

    | | onDownloadStart(callback: (event?: { url: string, userAgent: string, contentDisposition: string, mimetype: string, contentLength: number }) => void) |

    Triggered when a download task starts on the web page.
    **url**: URL for the download task.
    **userAgent**: name of the user agent (UA) for the download task.
    **contentDisposition**: Content-Disposition response header returned by the server, which may be empty.
    **mimetype**: content media type (MIME) returned by the server.
    **contentLength**: length of the file returned by the server.

    | -| onErrorReceive(callback: (event?: { request: [WebResourceRequest](#WebResourceError), error: [WebResourceError](#WebResourceError) }) => void) |

    Triggered when an error occurs during web page loading.
    For best results, simplify the implementation logic in the callback.
    **request**: encapsulation of a web page request.
    **error**: encapsulation of a web page resource loading error.

    | -| onHttpErrorReceive(callback: (event?: { request: [WebResourceRequest](#WebResourceError), response: [WebResourceResponse](#WebResourceResponse) }) => void) |

    Triggered when an HTTP error (the response code is greater than or equal to 400) occurs during web page resource loading.
    **request**: encapsulation of a web page request.
    **response**: encapsulation of a web page response.

    | -| onPageBegin(callback: (event?: { url: string }) => void) |

    Triggered when the web page starts to be loaded. This API is triggered only for the main frame content, and not for the iframe or frameset content.
    **url**: URL of the page.

    | -| onPageEnd(callback: (event?: { url: string }) => void) |

    Triggered when the web page loading is complete. This API is triggered only for the main frame content.
    **url**: URL of the page.

    | +| onErrorReceive(callback: (event?: { request: [WebResourceRequest](#webresourceerror), error: [WebResourceError](#webresourceerror) }) => void) |

    Triggered when an error occurs during web page loading.
    For better results, simplify the implementation logic in the callback.
    **request**: encapsulation of a web page request.
    **error**: encapsulation of a web page resource loading error.

    | +| onHttpErrorReceive(callback: (event?: { request: [WebResourceRequest](#webresourceerror), response: [WebResourceResponse](#webresourceresponse) }) => void) |

    Triggered when an HTTP error (the response code is greater than or equal to 400) occurs during web page resource loading.
    **request**: encapsulation of a web page request.
    **response**: encapsulation of a web page response.

    | +| onPageBegin(callback: (event?: { url: string }) => void) |

    Triggered when the web page starts to be loaded. This API is triggered only for the main frame content, and not for the iframe or frameset content.
    **url**: URL of the page.

    | +| onPageEnd(callback: (event?: { url: string }) => void) |

    Triggered when the web page loading is complete. This API is triggered only for the main frame content.
    **url**: URL of the page.

    | | onProgressChange(callback: (event?: { newProgress: number }) => void) |

    Triggered when the web page loading progress changes.
    **newProgress**: new loading progress. The value is an integer ranging from 0 to 100.

    | | onTitleReceive(callback: (event?: { title: string }) => void) |

    Triggered when the document title of the web page is changed.
    **title**: document title.

    | @@ -72,22 +75,22 @@ Universal events are not supported. - APIs - | Name | Description | - | ------------------------------- | ------------------------------ | - | getLineNumber(): number | Obtains the number of rows in the **ConsoleMessage**. | - | getMessage(): string | Obtains the log information of the **ConsoleMessage**.| - | getMessageLevel(): MessageLevel | Obtains the log information level of the **ConsoleMessage**.| - | getSourceId(): string | Obtains the path and name of the web page source file. | + | Name | Description | + | ------------------------------- | ---------------------------------------- | + | getLineNumber(): number | Obtains the number of rows in the **ConsoleMessage**. | + | getMessage(): string | Obtains the log information of the **ConsoleMessage**. | + | getMessageLevel(): MessageLevel | Obtains the log information level of the **ConsoleMessage**. | + | getSourceId(): string | Obtains the path and name of the web page source file. | - MessageLevel enums - | Name | Description | - | ----- | :---- | - | Debug | Debug level.| - | Error | Error level.| - | Info | Information level.| - | Log | Log level.| - | Warn | Warning level. | + | Name | Description | + | ----- | :----------------- | + | Debug | Debug level. | + | Error | Error level. | + | Info | Information level. | + | Log | Log level. | + | Warn | Warning level. | ### JsResult @@ -95,8 +98,8 @@ Represents the result returned to the **\** component to indicate the opera - APIs - | Name | Description | - | --------------------- | ------------------------------------ | + | Name | Description | + | --------------------- | ---------------------------------------- | | handleCancel(): void |

    Notifies the **\** component that the user touches the Cancel button in the dialog box.

    | | handleConfirm(): void |

    Notifies the **\** component that the user touches the Confirm button in the dialog box.

    | @@ -104,22 +107,22 @@ Represents the result returned to the **\** component to indicate the opera - APIs - | Name | Description | - | ---------------------- | ------------ | + | Name | Description | + | ---------------------- | ---------------------------------------- | | getErrorCode(): number | Obtains the error code for resource loading. | - | getErrorInfo(): string | Obtains error information about resource loading.| + | getErrorInfo(): string | Obtains error information about resource loading. | ### WebResourceRequest - APIs - | Name | Description | - | ------------------------------------------------------ | ---------------------------------------- | - | getRequestHeader(): Array\<[Header](#Header)\> | Obtains the information about the resource request header. | - | getRequestUrl(): string | Obtains the URL of the resource request. | - | isMainFrame(): boolean | Checks whether the resource request is in the main frame. | - | isRedirect(): boolean | Checks whether the resource request is redirected by the server. | - | isRequestGesture(): boolean | Checks whether the resource request is associated with a gesture (for example, a tap).| + | Name | Description | + | ---------------------------------------- | ---------------------------------------- | + | getRequestHeader(): Array\<[Header](#header)\> | Obtains the information about the resource request header. | + | getRequestUrl(): string | Obtains the URL of the resource request. | + | isMainFrame(): boolean | Checks whether the resource request is in the main frame. | + | isRedirect(): boolean | Checks whether the resource request is redirected by the server. | + | isRequestGesture(): boolean | Checks whether the resource request is associated with a gesture (for example, a tap). | ### Header @@ -127,28 +130,28 @@ Describes the request/response header object returned by the **\** componen - Parameters - | Name | Description | - | ----------- | ---------------------- | - | headerKey: string |

    Key of the request/response header.

    | - | headerValue: string |

    Value of the request/response header.

    | + | Name | Type | Description | + | ----------- | ------ | ------------------------------------- | + | headerKey | string | Key of the request/response header. | + | headerValue | string | Value of the request/response header. | ### WebResourceResponse - APIs - | Name | Description | - | ------------------------------------ | -------------------------------- | - | getReasonMessage(): string | Obtains the status code description of the resource response. | - | getResponseCode(): number | Obtains the status code of the resource response. | - | getResponseData(): string | Obtains the data in the resource response. | - | getResponseEncoding(): string | Obtains the encoding of the resource response. | - | getResponseHeader(): Array\<[Header](#Header)\> | Obtains the resource response header. | - | getResponseMimeType(): string | Obtains the media (MIME) type of the resource response.| + | Name | Description | + | ---------------------------------------- | ---------------------------------------- | + | getReasonMessage(): string | Obtains the status code description of the resource response. | + | getResponseCode(): number | Obtains the status code of the resource response. | + | getResponseData(): string | Obtains the data in the resource response. | + | getResponseEncoding(): string | Obtains the encoding of the resource response. | + | getResponseHeader(): Array\<[Header](#header)\> | Obtains the resource response header. | + | getResponseMimeType(): string | Obtains the media (MIME) type of the resource response. | ## WebController -Defines a **webController** to control the behavior or obtain the configuration information of the **\** component. +Defines a **WebController** to control the behavior of the **\** component. A **WebController** can control only one **\** component, and the APIs in the **WebController** can be invoked only after it has been bound to the target **\** component. ### Creating an Object @@ -176,9 +179,15 @@ Indicates whether a specific number of steps forward or backward can be performe - Parameters - | Name | Type | Mandatory | Default Value | Description | - | ---- | ------ | ---- | ---- | --------------------- | - | step | number | Yes | - | Number of the steps to take. A positive number means to going forward, and a negative number means to going backward. | + | Name | Type | Mandatory | Default Value | Description | + | ---- | ------ | --------- | ------------- | ---------------------------------------- | + | step | number | Yes | - | Number of the steps to take. A positive number means to going forward, and a negative number means to going backward. | + +- Return value + + | Type | Description | + | ------- | ---------------------------------------- | + | boolean | Whether to go forward or backward from the current page. | ### backward @@ -194,9 +203,9 @@ Deletes a specific application JavaScript object that is registered with the win - Parameters - | Name| Type| Mandatory| Default Value| Description | - | ------ | -------- | ---- | ------ | ------------------------------------------------------------ | - | name | string | Yes | - | Name of the registered JavaScript object, which can be used to invoke the corresponding object on the application side from the web side.| + | Name | Type | Mandatory | Default Value | Description | + | ---- | ------ | --------- | ------------- | ---------------------------------------- | + | name | string | Yes | - | Name of the registered JavaScript object, which can be used to invoke the corresponding object on the application side from the web side. | ### forward @@ -212,16 +221,16 @@ Obtains the element type of the area being clicked. - HitTestType enums - | Name | Description | - | ------------- | ----------------------------------------- | + | Name | Description | + | ------------- | ---------------------------------------- | | EditText | Editable area. | | Email | Email address. | - | HttpAnchor | Hyperlink where **src** is **http**. | - | HttpAnchorImg | Image with a hyperlink, where **src** is **http**.| - | Img | HTML::img tag. | - | Map | Geographical address. | - | Phone | Phone number. | - | Unknown | Unknown content. | + | HttpAnchor | Hyperlink where **src** is **http**. | + | HttpAnchorImg | Image with a hyperlink, where **src** is **http**. | + | Img | HTML::img tag. | + | Map | Geographical address. | + | PhoneNumber | Phone number. | + | Unknown | Unknown content. | ### loadData @@ -229,19 +238,19 @@ loadData(options: { data: string, mimeType: string, encoding: string, baseUrl?: Loads data. If **baseUrl** is empty, the specified character string will be loaded using the data protocol. -If **baseUrl** is set to a data URL, the encoded character string will be loaded by the **\** component using the data protocol. +If **baseUrl** is set to a data URL, the encoded string will be loaded by the **\** component using the data protocol. -If **baseUrl** is set to an HTTP or HTTPS URL, the encoded character string will be loaded by the **\** component as non-encoded string in a manner similar to **loadUrl**. +If **baseUrl** is set to an HTTP or HTTPS URL, the encoded string will be processed by the **\** component as a non-encoded string in a manner similar to **loadUrl**. - options - | Name | Type| Mandatory| Default Value| Description | - | ---------- | -------- | ---- | ------ | ------------------------------------------------------------ | - | data | string | Yes | - | Character string obtained after being Base64 or URL encoded. | - | mimeType | string | Yes | - | Media type (MIME). | - | encoding | string | Yes | - | Encoding type, which can be Base64 or URL. | - | baseUrl | string | No | - | URL (HTTP/HTTPS/data compliant), which is assigned by the **\** component to **window.origin**.| - | historyUrl | string | No | - | Historical record URL. If this parameter is not empty, it can be managed in historical records to implement page going backward and forward. This parameter is invalid when **baseUrl** is left empty.| + | Name | Type | Mandatory | Default Value | Description | + | ---------- | ------ | --------- | ------------- | ---------------------------------------- | + | data | string | Yes | - | Character string obtained after being Base64 or URL encoded. | + | mimeType | string | Yes | - | Media type (MIME). | + | encoding | string | Yes | - | Encoding type, which can be Base64 or URL. | + | baseUrl | string | No | - | URL (HTTP/HTTPS/data compliant), which is assigned by the **\** component to **window.origin**. | + | historyUrl | string | No | - | Historical record URL. If this parameter is not empty, it can be managed in historical records to implement page going backward and forward. This parameter is invalid when **baseUrl** is left empty. | ### loadUrl @@ -255,10 +264,10 @@ Objects injected through **registerJavaScriptProxy** are still valid on a new pa - options - | Name | Type | Mandatory| Default Value| Description | - | ------- | ------------------------------------- | ---- | ------ | --------------------- | - | url | string | Yes | - | URL to load. | - | headers | Array\<[Header](#Header)\> | No | [] | Additional HTTP request header of the URL.| + | Name | Type | Mandatory | Default Value | Description | + | ------- | -------------------------- | --------- | ------------- | ---------------------------------------- | + | url | string | Yes | - | URL to load. | + | headers | Array\<[Header](#header)\> | No | [] | Additional HTTP request header of the URL. | ### onActive @@ -286,11 +295,11 @@ Injects a JavaScript object into the window and invokes the methods of the objec - options - | Name | Type | Mandatory| Default Value| Description | - | ---------- | --------------- | ---- | ------ | ------------------------------------------------------------ | - | object | object | Yes | - | Application-side JavaScript object to be registered. Methods can be declared, but not attributes. The parameters and return value can only be of the string, number, or Boolean type.| - | name | string | Yes | - | Name of the object to be registered, which is the same as that invoked in the window. After registration, the window can use this name to access the JavaScript object at the application side.| - | methodList | Array\ | Yes | - | Methods of the JavaScript object to be registered at the application side. | + | Name | Type | Mandatory | Default Value | Description | + | ---------- | --------------- | --------- | ------------- | ---------------------------------------- | + | object | object | Yes | - | Application-side JavaScript object to be registered. Methods can be declared, but not attributes. The parameters and return value can only be of the string, number, or Boolean type. | + | name | string | Yes | - | Name of the object to be registered, which is the same as that invoked in the window. After registration, the window can use this name to access the JavaScript object at the application side. | + | methodList | Array\ | Yes | - | Methods of the JavaScript object to be registered at the application side. | ### runJavaScript @@ -300,10 +309,10 @@ Asynchronously executes a JavaScript script. This API uses a callback to return - options - | Name | Type | Mandatory| Default Value| Description | - | -------- | ------------------------ | ---- | ------ | ------------------------------------------------------------ | - | script | string | Yes | - | JavaScript script. | - | callback | (result: string) => void | No | - | Callback used to return the result. Returns **null** if the JavaScript script fails to be executed or no value is returned.| + | Name | Type | Mandatory | Default Value | Description | + | -------- | ------------------------ | --------- | ------------- | ---------------------------------------- | + | script | string | Yes | - | JavaScript script. | + | callback | (result: string) => void | No | - | Callback used to return the result. Returns **null** if the JavaScript script fails to be executed or no value is returned. | ### stop diff --git a/en/application-dev/ui/figures/en-us_image_0000001222807784.png b/en/application-dev/ui/figures/en-us_image_0000001222807784.png deleted file mode 100644 index 19ee7009247945887ceb0f8f6f471e45f3116b70..0000000000000000000000000000000000000000 Binary files a/en/application-dev/ui/figures/en-us_image_0000001222807784.png and /dev/null differ diff --git a/en/application-dev/ui/figures/en-us_image_0000001222967800.png b/en/application-dev/ui/figures/en-us_image_0000001222967800.png deleted file mode 100644 index 00964c1cfa5f006f2e8ac064133e23a2d8fc92aa..0000000000000000000000000000000000000000 Binary files a/en/application-dev/ui/figures/en-us_image_0000001222967800.png and /dev/null differ diff --git a/en/application-dev/ui/figures/en-us_image_0000001267887853.png b/en/application-dev/ui/figures/en-us_image_0000001267887853.png deleted file mode 100644 index 5e855312aef77f5badc0c0b0b4d5cbeac23b802f..0000000000000000000000000000000000000000 Binary files a/en/application-dev/ui/figures/en-us_image_0000001267887853.png and /dev/null differ diff --git a/en/application-dev/ui/js-framework-syntax-hml.md b/en/application-dev/ui/js-framework-syntax-hml.md index b4f022f5f6b0ef6a1bf4da21c4490e05ffc8e821..ab908cf72a254f2a98b209d13e78182a57d8067f 100644 --- a/en/application-dev/ui/js-framework-syntax-hml.md +++ b/en/application-dev/ui/js-framework-syntax-hml.md @@ -43,7 +43,7 @@ export default { > ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**: > - To make the array data modification take effect, use the splice method to change array items. -> +> > - ECMAScript 6 (ES6) syntax is not supported in HML. @@ -58,7 +58,7 @@ Events can be written in the following formats: - funcName(a,b): function parameters, such as a and b, which can be constants, or variables defined in data in the .js file. Do not add the prefix this. to variables. - Example - + ```
    @@ -74,7 +74,7 @@ Events can be written in the following formats:
    ``` - + ``` // xxx.js export default { @@ -93,7 +93,7 @@ Events can be written in the following formats: }; ``` - + ``` /* xxx.css */ .container { @@ -139,7 +139,7 @@ Bubbling event binding covers the following: > For details about bubbling events, see [Universal Events](../reference/arkui-js/js-components-common-events.md) - Example - + ```
    @@ -157,8 +157,8 @@ Bubbling event binding covers the following:
    ``` - - + + ``` // xxx.js export default { @@ -185,7 +185,7 @@ Event capturing binding includes: - Bind an event callback, but stop the event from being captured during downward transfer: grab:{event}.capture. - Example - + ```
    @@ -195,7 +195,7 @@ Event capturing binding includes:
    ``` - + ``` // xxx.js export default { @@ -262,9 +262,9 @@ The for loop supports the following statements: > ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**: > - Each element in the array must have the data attribute specified by tid. Otherwise, an exception may occur. -> +> > - The attribute specified by tid in the array must be unique. Otherwise, performance loss occurs. In the above example, only id and name can be used as tid because they are unique fields. -> +> > - The tid field does not support expressions. @@ -278,8 +278,8 @@ There are two ways to implement conditional rendering: if-elif-else or show. In
    - Hello-TV - Hello-Wearable + Hello-World1 + Hello-World2 Hello-World
    ``` diff --git a/en/application-dev/ui/ts-component-based-preview.md b/en/application-dev/ui/ts-component-based-preview.md index 59f5483433cb5c14e94cd414e8c1636789fd11e2..703e4d41a434d66d32a25ab941c1a98da977a7e0 100644 --- a/en/application-dev/ui/ts-component-based-preview.md +++ b/en/application-dev/ui/ts-component-based-preview.md @@ -11,7 +11,7 @@ Custom components decorated by @Preview can be previewed in the Previewer of Dev Example of using @Preview: ``` -// Display only Hello Component1 on the PC preview. The content under MyComponent is displayed on the real device. +// Display only Hello Component1 on the preview. The content under MyComponent is displayed on the real device. @Entry @Component struct MyComponent { diff --git a/en/application-dev/ui/ui-js-components-list.md b/en/application-dev/ui/ui-js-components-list.md index a62d6b67594e3dd2819a513042ba3800dd1dcc75..c2a3150d366260d91dac7997690474f37cf3955e 100644 --- a/en/application-dev/ui/ui-js-components-list.md +++ b/en/application-dev/ui/ui-js-components-list.md @@ -39,7 +39,7 @@ Create a <list> component in the .hml file under pages/index. > ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**: > - <list-item-group> is a child component of the <list> component and is used to group items in a list. It can have a <list-item> nested inside, but not <list>. -> +> > - <list-item> is a child component of the <list> component and is used to display items in a list. @@ -116,7 +116,7 @@ Set a custom indexer component to add an index bar at the right boundary of a li > ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**: > - This indexer attribute is valid only when flex-direction is set to column and columns is set to 1. -> +> > - You must include "\#" when using a customized indexer. @@ -219,7 +219,7 @@ Search for contacts by using an alphabetical indexer.
    {{$item.name}} - 18888888888 + 18888888888
    @@ -251,7 +251,7 @@ Search for contacts by using an alphabetical indexer. color: #000000; font-size: 39px; } -.phone { +.number { color: black; font-size: 25px; } diff --git a/en/application-dev/ui/ui-js-components-picker.md b/en/application-dev/ui/ui-js-components-picker.md index 6771d67b18ff6bc44b6ba9ccc3783058d2d74fcc..a2e5ff4c52c17ce2d17b4638eebcebd68f9418bf 100644 --- a/en/application-dev/ui/ui-js-components-picker.md +++ b/en/application-dev/ui/ui-js-components-picker.md @@ -72,9 +72,8 @@ export default { ![en-us_image_0000001267647893](figures/en-us_image_0000001267647893.gif) > ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**: -> - When setting the value range of a common selector, you must use the data binding mode. -> -> - The lunarswitch attribute of the date selector is only supported on phones and tablets. +> +> When setting the value range of a common selector, you must use the data binding mode. ## Setting the Time Format @@ -110,7 +109,7 @@ Set the hours attribute to specify the time format used by the time selector. Av > ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**: > - When hours is set to 12, the time is displayed in 12-hour format and distinguished by a.m. and p.m. -> +> > - When hours is set to 24, the time is displayed in 24-hour format. diff --git a/en/application-dev/ui/ui-ts-building-data-model.md b/en/application-dev/ui/ui-ts-building-data-model.md index eece0586e93fd0a9e19d554af5d6beab5ab23354..66b713bf5e693cfc6f58b7172ecd370450c8dd99 100644 --- a/en/application-dev/ui/ui-ts-building-data-model.md +++ b/en/application-dev/ui/ui-ts-building-data-model.md @@ -13,7 +13,7 @@ On the created page, we use various items to describe food, such as food names, 2. Define a food data storage model, FoodData, and an enum variable, Category. The FoodData class contains the food ID, name, category, image, calories, protein, fat, carbohydrates, and vitamin C attributes. The eTS programming language is an extension of the TS language and also supports the TS syntax. - + ``` enum Category { Fruit, @@ -22,7 +22,7 @@ On the created page, we use various items to describe food, such as food names, Seafood, Dessert } - + let NextId = 0; class FoodData { id: string; @@ -34,7 +34,7 @@ On the created page, we use various items to describe food, such as food names, fat: number; carbohydrates: number; vitaminC: number; - + constructor(name: string, image: Resource, category: Category, calories: number, protein: number, fat: number, carbohydrates: number, vitaminC: number) { this.id = `${ NextId++ }`; this.name = name; @@ -49,13 +49,13 @@ On the created page, we use various items to describe food, such as food names, } ``` -3. Store food image resources in the resources > phone > media directory. Use food names as the image names. - +3. Store food image resources in the resources > base > media directory. Use food names as the image names. + 4. Create food resource data. Create FoodDataModels.ets in the model folder and declare a food composition array, FoodComposition on the page. In this example, you can customize more data resources when needed. Use LazyForEach to load data if a large amount of food data is involved. 5. Create the initializeOnStartUp method to initialize the FoodData array. Export the FoodData class from FoodData.ets, and import FoodData and Category in FoodDataModels.ets. - + ``` // FoodData.ets export enum Category { @@ -66,7 +66,7 @@ On the created page, we use various items to describe food, such as food names, } // FoodDataModels.ets import { Category, FoodData } from './FoodData' - + export function initializeOnStartup(): Array { let FoodDataArray: Array = [] FoodComposition.forEach(item => { diff --git a/en/application-dev/ui/ui-ts-creating-project.md b/en/application-dev/ui/ui-ts-creating-project.md index 23bd070dff61aa90e7c29e51ef44fe7b5c85f389..97453c3fd1cbd7decac01ea704bb360c91d225bf 100644 --- a/en/application-dev/ui/ui-ts-creating-project.md +++ b/en/application-dev/ui/ui-ts-creating-project.md @@ -7,8 +7,8 @@ Before creating a project, you need to install DevEco Studio. 1. Open DevEco Studio and click Create Project. If there is already a project, choose File > New > New project. ![en-us_image_0000001267607861](figures/en-us_image_0000001267607861.png) -2. - +2. ​ + On the page for selecting an ability template, select [Standard]Empty Ability. @@ -20,13 +20,13 @@ Before creating a project, you need to install DevEco Studio. ![en-us_image_0000001223127700](figures/en-us_image_0000001223127700.png) 4. On the project configuration page, set Project Name to HealthyDiet, Project Type to Application, Device Type to Phone, Language to eTS, and Compatible API Version to SDK: API Version 7. By default, DevEco Studio saves the project to drive C. You can change the save path by setting Save Location. When you are done, click Finish. - + ![en-us_image_0000001267647849](figures/en-us_image_0000001267647849.png) 5. After the project is created, open the app.ets file. The app.ets file provides the onCreate and onDestroy methods for the application lifecycle. onCreate is called when an application is created, and onDestroy is called when an application is destroyed. Global variables can be declared in the app.ets file, wherein the declared data and methods are shared by the entire application. - + ``` export default { onCreate() { @@ -39,7 +39,7 @@ Before creating a project, you need to install DevEco Studio. ``` 6. In the project navigation tree, open index.ets. This page displays the current UI description. The declarative UI framework automatically generates a component-based struct, which complies with the Builder API declaration. The current layout and components are declared in the build method. - + ``` @Entry @Component @@ -56,14 +56,14 @@ Before creating a project, you need to install DevEco Studio. } ``` -7. Click Previewer on the right to open the Previewer window. In the Previewer window of the phone type, Hello World is displayed in the middle and in bold. +7. Click Previewer on the right to open the Previewer window. Hello World is displayed in the middle and in bold. If the Previewer button is unavailable, choose Settings > SDK Manager >OpenHarmony SDK > Tools to check whether the Previewer is installed. ![en-us_image_0000001222807756](figures/en-us_image_0000001222807756.png) -8. Install the application on the phone and run the application. Connect the phone to the computer. After the IDE identifies the phone, click Run'entry'. +8. Install the application and run the application. Connect the device to the computer. After the IDE identifies the device, click Run'entry'. ![en-us_image_0000001267607865](figures/en-us_image_0000001267607865.png) - Before the installation, you must configure an application signature. For details, see [Configuring the OpenHarmony App Signature](../quick-start/configuring-the-openharmony-app-signature.md). After the installation is complete, click the Run icon on the screen to open the application. Hello World is displayed in the center of the screen. + Before the installation, you must configure an application signature. For details, see Configuring the OpenHarmony App Signature. After the installation is complete, click the Run icon on the screen to open the application. Hello World is displayed in the center of the screen. ![en-us_image_0000001267647841](figures/en-us_image_0000001267647841.png) diff --git a/en/application-dev/ui/ui-ts-creating-simple-page.md b/en/application-dev/ui/ui-ts-creating-simple-page.md index 0b23ccaafc7bc382aafc7a52162c90d4c9e66fe8..d9f6b4d27bb6644a6b49bf3168aca6d3b71d32b3 100644 --- a/en/application-dev/ui/ui-ts-creating-simple-page.md +++ b/en/application-dev/ui/ui-ts-creating-simple-page.md @@ -46,13 +46,7 @@ In this section, we will develop an infographic food details page, by building c ![en-us_image_0000001267887861](figures/en-us_image_0000001267887861.png) 3. Access images through resources. - In addition to specifying the image path, you can also use the media resource symbol $r to reference resources based on the resource qualifier rules in the resources folder. Right-click the resources folder, choose New > Resource Directory, set Resource Type to Media (image resource), and set the resource qualifier to Device-Phone (currently, phones are used). - - ![en-us_image_0000001267887853](figures/en-us_image_0000001267887853.png) - - Click OK. The phone.media folder is generated in the resources folder. Place Tomato.png in the folder. - - ![en-us_image_0000001222807784](figures/en-us_image_0000001222807784.png) + In addition to specifying the image path, you can also use the media resource symbol $r to reference resources based on the resource qualifier rules in the resources folder. Right-click the resources folder, choose New > Resource Directory, set Resource Type to Media (image resource).Place Tomato.png in the media folder. You can then can reference the application resource in the ` "$r('app.type.name')"` format, that is, `$r('app.media.Tomato')`. diff --git a/en/application-dev/ui/ui-ts-page-redirection-data-transmission.md b/en/application-dev/ui/ui-ts-page-redirection-data-transmission.md index 575b56f4091b96d56c17146ad32d8aa75a94a3de..5e53938c4309821a6bd547f4b967bfe2b16dad2a 100644 --- a/en/application-dev/ui/ui-ts-page-redirection-data-transmission.md +++ b/en/application-dev/ui/ui-ts-page-redirection-data-transmission.md @@ -20,7 +20,7 @@ The declarative UI paradigm provides two mechanisms for page redirection: The procedure below uses these two mechanisms for redirection between the page list page and food details page. 1. Click FoodListItem. The FoodDetail page is displayed. Create a Navigator component in FoodListItem to enable its child components to have the routing function. The target page is 'pages/FoodDetail'. - + ``` @Component struct FoodListItem { @@ -50,10 +50,10 @@ The procedure below uses these two mechanisms for redirection between the page l ![en-us_image_0000001223127744](figures/en-us_image_0000001223127744.gif) 2. Click FoodGridItem. The FoodDetail page is displayed. Import the router module, and then call the push API of this module to push the FoodDetail page to the route stack to implement page redirection. - + ``` import router from '@system.router' - + @Component struct FoodGridItem { private foodItem: FoodData @@ -72,12 +72,12 @@ The procedure below uses these two mechanisms for redirection between the page l ![en-us_image_0000001267607909](figures/en-us_image_0000001267607909.gif) -3. Add the icon for returning from the FoodDetail page to the food list page. Save the Back.png file to the resources > phone > media directory. Create a custom component PageTitle, which contains the back icon and Food Detail text. Call the router.back() API of the router to display the top page of the route stack, that is, the upper-level page. - +3. Add the icon for returning from the FoodDetail page to the food list page. Save the Back.png file to the resources > base > media directory. Create a custom component PageTitle, which contains the back icon and Food Detail text. Call the router.back() API of the router to display the top page of the route stack, that is, the upper-level page. + ``` // FoodDetail.ets import router from '@system.router' - + @Component struct PageTitle { build() { @@ -100,7 +100,7 @@ The procedure below uses these two mechanisms for redirection between the page l ``` 4. Create the Stack component in the FoodDetail component, including the FoodImageDisplay and PageTitle child components. Set the alignment mode to TopStart. - + ``` @Entry @Component @@ -126,7 +126,7 @@ The procedure below uses these two mechanisms for redirection between the page l We have implemented the redirection and going back of the FoodCategoryList and FoodDetail pages. At this point, the tomato details page is displayed no matter which FoodListItem/FoodGridItem is clicked. This is because the data transmission between pages is not yet configured. To configure data transmission between pages, set the routing with parameters as follows: 1. Set the params attribute in the Navigator of the FoodListItem component. The params attribute accepts the key-value object. - + ``` // FoodList.ets @Component @@ -143,7 +143,7 @@ We have implemented the redirection and going back of the FoodCategoryList and F The router API called by FoodGridItem also has the capability of redirection with parameters. The method of using the router API is similar to that of using the Navigator. - + ``` router.push({ uri: 'pages/FoodDetail', @@ -152,11 +152,11 @@ We have implemented the redirection and going back of the FoodCategoryList and F ``` 2. Import the FoodData class to the FoodDetail page and add the foodItem member variable to the FoodDetail component. - + ``` // FoodDetail.ets import { FoodData } from '../model/FoodData' - + @Entry @Component struct FoodDetail { @@ -168,13 +168,13 @@ We have implemented the redirection and going back of the FoodCategoryList and F ``` 3. Obtain the value of foodData. Call router.getParams().foodData to obtain the data corresponding to foodData carried when the FoodCategoryList page is displayed. - + ``` @Entry @Component struct FoodDetail { private foodItem: FoodData = router.getParams().foodData - + build() { ...... } @@ -182,7 +182,7 @@ We have implemented the redirection and going back of the FoodCategoryList and F ``` 4. Re-build the components on the FoodDetail page. During building, the food information on the FoodDetail page is all directly declared constants. You need to use the passed FoodData data to assign a new value to the constants. The code is as follows: - + ``` @Component struct PageTitle { @@ -203,7 +203,7 @@ We have implemented the redirection and going back of the FoodCategoryList and F }) } } - + @Component struct FoodImageDisplay { private foodItem: FoodData @@ -220,11 +220,11 @@ We have implemented the redirection and going back of the FoodCategoryList and F .backgroundColor('#FFedf2f5') } } - + @Component struct ContentTable { private foodItem: FoodData - + @Builder IngredientItem(title:string, name: string, value: string) { Flex() { Text(title) @@ -241,7 +241,7 @@ We have implemented the redirection and going back of the FoodCategoryList and F .layoutWeight(2) } } - + build() { Flex({ direction: FlexDirection.Column, justifyContent: FlexAlign.SpaceBetween, alignItems: ItemAlign.Start }) { this.IngredientItem('Calories', 'Calories', this.foodItem.calories + 'kcal') @@ -254,12 +254,12 @@ We have implemented the redirection and going back of the FoodCategoryList and F .padding({ top: 30, right: 30, left: 30 }) } } - + @Entry @Component struct FoodDetail { private foodItem: FoodData = router.getParams().foodData - + build() { Column() { Stack( { alignContent: Alignment.TopStart }) { diff --git a/en/application-dev/website.md b/en/application-dev/website.md index 78fc3954bca73f30adf266a97e308e5afdb3a955..1a130cd20873512be88e9bba003cc3794e77be0c 100644 --- a/en/application-dev/website.md +++ b/en/application-dev/website.md @@ -1,28 +1,21 @@ -# OpenHarmony Application Development Documentation -- [Application Development Overview](application-dev-guide.md) +# Application Development +- [Application Development Overview](application-dev-guide.md) - Quick Start - - Getting Started - - [Preparations](quick-start/start-overview.md) - - [Getting Started with eTS](quick-start/start-with-ets.md) - - [Getting Started with JavaScript in the Traditional Coding Approach](quick-start/start-with-js.md) - - [Getting Started with JavaScript in the Low-Code Approach](quick-start/start-with-js-low-code.md) - - Development Fundamentals - - [Directory Structure](quick-start/package-structure.md) - - [Resource File Categories](quick-start/basic-resource-file-categories.md) - + - [Directory Structure](quick-start/package-structure.md) + - [Resource File Categories](quick-start/basic-resource-file-categories.md) - Development - [Ability Development](ability/Readme-EN.md) - - - [FA Model Overview](ability/fa-brief.md) - - [Page Ability Development](ability/fa-pageability.md) - - [Service Ability Development](ability/fa-serviceability.md) - - [Data Ability Development](ability/fa-dataability.md) - - [FA Widget Development](ability/fa-formability.md) - + - [Ability Framework Overview](ability/ability-brief.md) + - FA Model + - [FA Model Overview](ability/fa-brief.md) + - [Page Ability Development](ability/fa-pageability.md) + - [Service Ability Development](ability/fa-serviceability.md) + - [Data Ability Development](ability/fa-dataability.md) + - [FA Widget Development](ability/fa-formability.md) + - Other - [Ability Assistant Usage](ability/ability-assistant-guidelines.md) - - [UI](ui/Readme-EN.md) - [ArkUI Overview](arkui-overview.md) - JavaScript-based Web-Like Development Paradigm @@ -138,7 +131,6 @@ - [Building a Food Category List Layout](ui/ui-ts-building-category-list-layout.md) - [Building a Food Category Grid Layout](ui/ui-ts-building-category-grid-layout.md) - [Implementing Page Redirection and Data Transmission](ui/ui-ts-page-redirection-data-transmission.md) - - Basic Functions - Window Manager - Window @@ -157,9 +149,9 @@ - Audio - [Audio Overview](media/audio-overview.md) - [Audio Playback Development](media/audio-playback.md) - - [Audio Playback Development Using AudioRenderer](media/audio-renderer.md) + - [Audio Rendering Development](media/audio-renderer.md) - [Audio Recording Development](media/audio-recorder.md) - - [Audio Recorder Development Using AudioCapturer](media/audio-capturer) + - [Audio Capture Development](media/audio-capturer) - Video - [Video Playback Development](media/video-playback.md) - [Video Recording Development](media/video-recorder.md) @@ -203,6 +195,9 @@ - Sensor - [Sensor Overview](device/sensor-overview.md) - [Sensor Development](device/sensor-guidelines.md) + - Sensor + - [Sensor Overview](device/sensor-overview.md) + - [Sensor Development](device/sensor-guidelines.md) - Vibrator - [vibrator-Overview.md](device/vibrator-overview.md) - [Vibrator Development](device/vibrator-guidelines.md) @@ -219,13 +214,14 @@ - Distributed Call Chain Tracing - [Overview of Distributed Call Chain Tracing](dfx/hitracechain-overview.md) - [Development of Distributed Call Chain Tracing](dfx/hitracechain-guidelines.md) - + - Internationalization + - [Overview](internationalization/international-overview.md) + - [Internationalization Development (intl)](internationalization/intl-guidelines.md) + - [Internationalization Development (i18n)](internationalization/i18n-guidelines.md) - Tools - [DevEco Studio (OpenHarmony) User Guide](quick-start/deveco-studio-user-guide-for-openharmony.md) - - Hands-On Tutorials - [Samples](https://gitee.com/openharmony/app_samples/blob/master/README.md) - - API References - Compent Reference (JavaScript-based Web-like Development Paradigm) - Components @@ -425,7 +421,7 @@ - [GridItem](reference/arkui-ts/ts-container-griditem.md) - [List](reference/arkui-ts/ts-container-list.md) - [ListItem](reference/arkui-ts/ts-container-listitem.md) - - [Navigator](reference/arkui-ts/ts-container-navigator.md) + - [Navigator](reference/arkui-ts/ts-container-navigator.md) - [Panel](reference/arkui-ts/ts-container-panel.md) - [Refresh](reference/arkui-ts/ts-container-refresh.md) - [Row](reference/arkui-ts/ts-container-row.md) @@ -477,118 +473,230 @@ - [Built-in Enums](reference/arkui-ts/ts-appendix-enums.md) - APIs - Ability Framework - - [FeatureAbility Module](reference/apis/js-apis-featureAbility.md) - - [ParticleAbility Module](reference/apis/js-apis-particleAbility.md) - - [DataAbilityHelper Module](reference/apis/js-apis-dataAbilityHelper.md) - - [DataUriUtils Module](reference/apis/js-apis-DataUriUtils.md) - - [Bundle Module](reference/apis/js-apis-Bundle.md) - - [Context Module](reference/apis/js-apis-Context.md) - - Event Notification - - [CommonEvent Module](reference/apis/js-apis-commonEvent.md) - - [Notification Module](reference/apis/js-apis-notification.md) - - [Reminder Agent](reference/apis/js-apis-reminderAgent.md) - - Resource Management - - [Resource Manager](reference/apis/js-apis-resource-manager.md) - - [Internationalization (intl)](reference/apis/js-apis-intl.md) - - [Internationalization (i18n)](reference/apis/js-apis-i18n.md) + + - [@ohos.ability.dataUriUtils](reference/apis/js-apis-DataUriUtils.md) + - [@ohos.ability.errorCode ](reference/apis/js-apis-ability-errorcode.md) + - [@ohos.ability.wantConstant](reference/apis/js-apis-ability-wantConstant.md) + - [@ohos.application.Ability](reference/apis/js-apis-application-ability.md) + - [@ohos.application.AbilityConstant](reference/apis/js-apis-application-abilityConstant.md) + - [@ohos.application.abilityDelegatorRegistry](reference/apis/js-apis-abilityDelegatorRegistry.md) + - [@ohos.application.AbilityStage ](reference/apis/js-apis-application-abilitystage.md) + - [@ohos.application.appManager](reference/apis/js-apis-appmanager.md) + - [@ohos.application.Configuration](reference/apis/js-apis-configuration.md) + - [@ohos.application.ConfigurationConstant](reference/apis/js-apis-configurationconstant.md) + - [@ohos.application.DataShareExtensionAbility](reference/apis/js-apis-application-DataShareExtensionAbility.md) + - [@ohos.ability.featureAbility](reference/apis/js-apis-featureAbility.md) + - [@ohos.application.formBindingData](reference/apis/js-apis-formbindingdata.md) + - [@ohos.application.FormExtension](reference/apis/js-apis-formextension.md) + - [@ohos.application.formError](reference/apis/js-apis-formerror.md) + - [@ohos.application.formHost](reference/apis/js-apis-formhost.md) + - [@ohos.application.formInfo](reference/apis/js-apis-formInfo.md) + - [@ohos.application.missionManager](reference/apis/js-apis-missionManager.md) + - [@ohos.application.formProvider](reference/apis/js-apis-formprovider.md) + - [@ohos.ability.particleAbility](reference/apis/js-apis-particleAbility.md) + - [@ohos.application.ServiceExtensionAbility](reference/apis/js-apis-service-extension-ability.md) + - [@ohos.application.StartOptions](reference/apis/js-apis-application-StartOptions.md) + - [@ohos.application.StaticSubscriberExtensionAbility](reference/apis/js-apis-application-staticSubscriberExtensionAbility.md) + - [@ohos.application.uriPermissionManager](reference/apis/js-apis-uripermissionmanager.md) + - [@ohos.application.Want](reference/apis/js-apis-application-Want.md) + - [@ohos.wantAgent](reference/apis/js-apis-wantAgent.md) + - [dataAbilityHelper](reference/apis/js-apis-dataAbilityHelper.md) + - [context](reference/apis/js-apis-Context.md) + - [AbilityContext](reference/apis/js-apis-ability-context.md) + - [abilityDelegator](reference/apis/js-apis-application-abilityDelegator.md) + - [abilityDelegatorArgs](reference/apis/js-apis-application-abilityDelegatorArgs.md) + - [abilityMonitor](reference/apis/js-apis-application-abilityMonitor.md) + - [AbilityRunningInfo](reference/apis/js-apis-abilityrunninginfo.md) + - [AbilityStageContext](reference/apis/js-apis-abilitystagecontext.md) + - [Context](reference/apis/js-apis-application-context.md) + - [ExtensionContext](reference/apis/js-apis-extension-context.md) + - [ExtensionRunningInfo](reference/apis/js-apis-extensionrunninginfo.md) + - [FormExtensionContext](reference/apis/js-apis-formextensioncontext.md) + - [MissionSnapshot](reference/apis/js-apis-application-MissionSnapshot.md) + - [PermissionRequestResult](reference/apis/js-apis-permissionrequestresult.md) + - [ProcessRunningInfo](reference/apis/js-apis-processrunninginfo.md) + - [ServiceExtensionContext](reference/apis/js-apis-service-extension-context.md) + - [shellCmdResult](reference/apis/js-apis-application-shellCmdResult.md) + + - Common Event and Notification + + - [@ohos.commonEvent](reference/apis/js-apis-commonEvent.md) + - [@ohos.events.emitter](reference/apis/js-apis-emitter.md) + - [@ohos.notification](reference/apis/js-apis-notification.md) + - [@ohos.reminderAgent](reference/apis/js-apis-reminderAgent.md) + - [EventHub](reference/apis/js-apis-eventhub.md) + + - Bundle Management + + - [@ohos.bundle](reference/apis/js-apis-Bundle.md) + - [@ohos.bundleState ](reference/apis/js-apis-deviceUsageStatistics.md) + - [@ohos.zlib](reference/apis/js-apis-zlib.md) + + - UI Page + + - [@ohos.animator](reference/apis/js-apis-animator.md) + + - Graphics + + - [@ohos.display ](reference/apis/js-apis-display.md) + - [@ohos.screenshot](reference/apis/js-apis-screenshot.md) + - [@ohos.window](reference/apis/js-apis-window.md) + - [webgl](reference/apis/js-apis-webgl.md) + - [webgl2](reference/apis/js-apis-webgl2.md) + - Media - - [Audio Management](reference/apis/js-apis-audio.md) - - [Media](reference/apis/js-apis-media.md) - - [Image Processing](reference/apis/js-apis-image.md) - - [Camera](reference/apis/js-apis-camera.md) + + - [@ohos.multimedia.audio](reference/apis/js-apis-audio.md) + - [@ohos.multimedia.camera](reference/apis/js-apis-camera.md) + - [@ohos.multimedia.image](reference/apis/js-apis-image.md) + - [@ohos.multimedia.media](reference/apis/js-apis-media.md) + - [@ohos.multimedia.medialibrary](reference/apis/js-apis-medialibrary.md) + + - Resource Management + - [@ohos.i18n](reference/apis/js-apis-i18n.md) + - [@ohos.intl](reference/apis/js-apis-intl.md) + - [@ohos.resourceManager](reference/apis/js-apis-resource-manager.md) + + - Resource Scheduling + + - [@ohos.backgroundTaskManager](reference/apis/js-apis-backgroundTaskManager.md) + - [@ohos.workScheduler ](reference/apis/js-apis-workScheduler.md) + - [@ohos.WorkSchedulerExtensionAbility](reference/apis/js-apis-WorkSchedulerExtensionAbility.md) + + - Custom Management + + - [@ohos.configPolicy](reference/apis/js-apis-config-policy.md) + - [@ohos.enterpriseDeviceManager](reference/apis/js-apis-enterprise-device-manager.md) + - Security - - [User Authentication](reference/apis/js-apis-useriam-userauth.md) - - [Access Control](reference/apis/js-apis-abilityAccessCtrl.md) + + - [@ohos.abilityAccessCtrl](reference/apis/js-apis-abilityAccessCtrl.md) + - [@ohos.security.huks ](reference/apis/js-apis-huks.md) + - [@ohos.userIAM.userAuth ](reference/apis/js-apis-useriam-userauth.md) + - Data Management - - [Lightweight Storage](reference/apis/js-apis-data-preferences.md) - - [Distributed Data Management](reference/apis/js-apis-distributed-data.md) - - [Relational Database](reference/apis/js-apis-data-rdb.md) - - [Result Set](reference/apis/js-apis-data-resultset.md) - - [DataAbilityPredicates](reference/apis/js-apis-data-ability.md) - - [Settings](reference/apis/js-apis-settings.md) + + - [@ohos.data.dataAbility ](reference/apis/js-apis-data-ability.md) + - [@ohos.data.distributedData](reference/apis/js-apis-distributed-data.md) + - [@ohos.data.distributedDataObject](reference/apis/js-apis-data-distributedobject.md) + - [@ohos.data.preferences](reference/apis/js-apis-data-preferences.md) + - [@ohos.data.rdb](reference/apis/js-apis-data-rdb.md) + - [@ohos.settings](reference/apis/js-apis-settings.md) + - [resultSet](reference/apis/js-apis-data-resultset.md) + - File Management - - [File Management](reference/apis/js-apis-fileio.md) - - [Statfs](reference/apis/js-apis-statfs.md) - - [Environment](reference/apis/js-apis-environment.md) - - [Public File Access and Management](reference/apis/js-apis-filemanager.md) - - [App Storage Statistics](reference/apis/js-apis-storage-statistics.md) - - [Volume Management](reference/apis/js-apis-volumemanager.md) - - Account Management - - [OS Account Management](reference/apis/js-apis-osAccount.md) - - [Distributed Account Management](reference/apis/js-apis-distributed-account.md) - - [App Account Management](reference/apis/js-apis-appAccount.md) + + - [@ohos.environment](reference/apis/js-apis-environment.md) + - [@ohos.fileio](reference/apis/js-apis-fileio.md) + - [@ohos.fileManager](reference/apis/js-apis-filemanager.md) + - [@ohos.statfs](reference/apis/js-apis-statfs.md) + - [@ohos.storageStatistics](reference/apis/js-apis-storage-statistics.md) + - [@ohos.volumeManager](reference/apis/js-apis-volumemanager.md) + - Telephony Service - - [Call](reference/apis/js-apis-call.md) - - [SMS](reference/apis/js-apis-sms.md) - - [SIM Management](reference/apis/js-apis-sim.md) - - [Radio](reference/apis/js-apis-radio.md) - - [Observer](reference/apis/js-apis-observer.md) - - [Cellular Data](reference/apis/js-apis-telephony-data.md) + + - [@ohos.contact](reference/apis/js-apis-contact.md) + - [@ohos.telephony.call](reference/apis/js-apis-call.md) + - [@ohos.telephony.observer](reference/apis/js-apis-observer.md) + - [@ohos.telephony.radio](reference/apis/js-apis-radio.md) + - [@ohos.telephony.sim](reference/apis/js-apis-sim.md) + - [@ohos.telephony.sms](reference/apis/js-apis-sms.md) + - [@ohos.telephony.data](reference/apis/js-apis-telephony-data.md) + - Network Management - - [Network Connection Management](js-apis-net-connection.md) - - [Socket Connection](js-apis-socket.md) - - [WebSocket Connection](js-apis-webSocket.md) - - [Data Request](js-apis-http.md) - - Network and Connectivity - - [WLAN](reference/apis/js-apis-wifi.md) - - [Bluetooth](reference/apis/js-apis-bluetooth.md) - - [RPC](reference/apis/js-apis-rpc.md) - - Device Management - - [Sensor](reference/apis/js-apis-sensor.md) - - [Vibrator](reference/apis/js-apis-vibrator.md) - - [Brightness](reference/apis/js-apis-brightness.md) - - [Battery Info](reference/apis/js-apis-battery-info.md) - - [Power Management](reference/apis/js-apis-power.md) - - [Thermal Management](reference/apis/js-apis-thermal.md) - - [Running Lock](reference/apis/js-apis-runninglock.md) - - [Device Info](reference/apis/js-apis-device-info.md) - - [systemParameter](reference/apis/js-apis-system-parameter.md) - - [Device Management](reference/apis/js-apis-device-manager.md) - - [Window](reference/apis/js-apis-window.md) - - [Display](reference/apis/js-apis-display.md) - - [Update](reference/apis/js-apis-update.md) - - [USB](reference/apis/js-apis-usb.md) - - [Location](reference/apis/js-apis-geolocation.md) + - [@ohos.net.connection](reference/apis/js-apis-net-connection.md) + - [@ohos.net.http](reference/apis/js-apis-http.md) + - [@ohos.request](reference/apis/js-apis-request.md) + - [@ohos.net.socket](reference/apis/js-apis-socket.md) + - [@ohos.net.webSocket](reference/apis/js-apis-webSocket.md) + + - Connectivity + + - [@ohos.bluetooth](reference/apis/js-apis-bluetooth.md) + - [@ohos.rpc](reference/apis/js-apis-rpc.md) + - [@ohos.wifi](reference/apis/js-apis-wifi.md) + - [@ohos.wifiext](reference/apis/js-apis-wifiext.md) + - Basic Features - - [Application Context](reference/apis/js-apis-system-app.md) - - [Console Logs](reference/apis/js-apis-logs.md) - - [Page Routing](reference/apis/js-apis-system-router.md) + + - [@ohos.accessibility](reference/apis/js-apis-accessibility.md) + - [@ohos.faultLogger](reference/apis/js-apis-faultLogger.md) + - [@ohos.hiAppEvent](reference/apis/js-apis-hiappevent.md) + - [@ohos.hichecker](reference/apis/js-apis-hichecker.md) + - [@ohos.hidebug](reference/apis/js-apis-hidebug.md) + - [@ohos.hilog](reference/apis/js-apis-hilog.md) + - [@ohos.hiTraceChain](reference/apis/js-apis-hitracechain.md) + - [@ohos.hiTraceMeter](reference/apis/js-apis-hitracemeter.md) + - [@ohos.inputMethod](reference/apis/js-apis-inputmethod.md) + - [@ohos.inputMethodEngine](reference/apis/js-apis-inputmethodengine.md) + - [@ohos.pasteboard](reference/apis/js-apis-pasteboard.md) + - [@ohos.screenLock](reference/apis/js-apis-screen-lock.md) + - [@ohos.systemTime](reference/apis/js-apis-system-time.md) + - [@ohos.wallpaper](reference/apis/js-apis-wallpaper.md) - [Timer](reference/apis/js-apis-timer.md) - - [Setting the System Time](reference/apis/js-apis-system-time.md) - - [Animation](reference/apis/js-apis-animator.md) - - [WebGL](reference/apis/js-apis-webgl.md) - - [WebGL2](reference/apis/js-apis-webgl2.md) - - [Screenshot](reference/apis/js-apis-screenshot.md) - - [Accessibility](reference/apis/js-apis-accessibility.md) - - DFX - - [HiAppEvent](reference/apis/js-apis-hiappevent.md) - - [Performance Tracing](reference/apis/js-apis-hitracemeter.md) - - [Fault Logger](reference/apis/js-apis-faultLogger.md) - - [Distributed Call Chain Tracing](reference/apis/js-apis-hitracechain.md) - - [HiLog](reference/apis/js-apis-hilog.md) - - [HiChecker](reference/apis/js-apis-hichecker.md) - - [HiDebug](reference/apis/js-apis-hidebug.md) + + - Device Management + + - [@ohos.batteryInfo ](reference/apis/js-apis-battery-info.md) + - [@ohos.brightness](reference/apis/js-apis-brightness.md) + - [@ohos.deviceInfo](reference/apis/js-apis-device-info.md) + - [@ohos.distributedHardware.deviceManager](reference/apis/js-apis-device-manager.md) + - [@ohos.geolocation](reference/apis/js-apis-geolocation.md) + - [@ohos.multimodalInput.inputConsumer](reference/apis/js-apis-inputconsumer.md) + - [@ohos.multimodalInput.inputDevice](reference/apis/js-apis-inputdevice.md) + - [@ohos.multimodalInput.inputEventClient](reference/apis/js-apis-inputeventclient.md) + - [@ohos.multimodalInput.inputMonitor](reference/apis/js-apis-inputmonitor.md) + - [@ohos.power](reference/apis/js-apis-power.md) + - [@ohos.runningLock](reference/apis/js-apis-runninglock.md) + - [@ohos.sensor](reference/apis/js-apis-sensor.md) + - [@ohos.systemParameter](reference/apis/js-apis-system-parameter.md) + - [@ohos.thermal](reference/apis/js-apis-thermal.md) + - [@ohos.update](reference/apis/js-apis-update.md) + - [@ohos.usb](reference/apis/js-apis-usb.md) + - [@ohos.vibrator](reference/apis/js-apis-vibrator.md) + + - Account Management + + - [@ohos.account.appAccount](reference/apis/js-apis-appAccount.md) + - [@ohos.account.distributedAccount](reference/apis/js-apis-distributed-account.md) + - [@ohos.account.osAccount](reference/apis/js-apis-osAccount.md) + - Language Base Class Library - - [Obtaining Process Information](reference/apis/js-apis-process.md) - - [URL String Parsing](reference/apis/js-apis-url.md) - - [URI String Parsing](reference/apis/js-apis-uri.md) - - [Util](reference/apis/js-apis-util.md) - - [XML Parsing and Generation](reference/apis/js-apis-xml.md) - - [XML-to-JavaScript Conversion](reference/apis/js-apis-convertxml.md) - - [Worker Startup](reference/apis/js-apis-worker.md) - - [Linear Container ArrayList](reference/apis/js-apis-arraylist.md) - - [Linear Container Deque](reference/apis/js-apis-deque.md) - - [Linear Container List](reference/apis/js-apis-list.md) - - [Linear Container LinkedList](reference/apis/js-apis-linkedlist.md) - - [Linear Container Queue](reference/apis/js-apis-queue.md) - - [Linear Container Stack](reference/apis/js-apis-stack.md) - - [Linear Container Vector](reference/apis/js-apis-vector.md) - - [Nonlinear Container HashSet](reference/apis/js-apis-hashset.md) - - [Nonlinear Container HashMap](reference/apis/js-apis-hashmap.md) - - [Nonlinear Container PlainArray](reference/apis/js-apis-plainarray.md) - - [Nonlinear Container TreeMap](reference/apis/js-apis-treemap.md) - - [Nonlinear Container TreeSet](reference/apis/js-apis-treeset.md) - - [Nonlinear Container LightWeightMap](reference/apis/js-apis-lightweightmap.md) - - [Nonlinear Container LightWeightSet](reference/apis/js-apis-lightweightset.md) - - Custom Management - - [Configuration Policy](reference/apis/js-apis-config-policy.md) + + - [@ohos.convertxml](reference/apis/js-apis-convertxml.md) + - [@ohos.process](reference/apis/js-apis-process.md) + - [@ohos.uri](reference/apis/js-apis-uri.md) + - [@ohos.url](reference/apis/js-apis-url.md) + - [@ohos.util](reference/apis/js-apis-util.md) + - [@ohos.util.ArrayList](reference/apis/js-apis-arraylist.md) + - [@ohos.util.Deque](reference/apis/js-apis-deque.md) + - [@ohos.util.HashMap](reference/apis/js-apis-hashmap.md) + - [@ohos.util.HashSet](reference/apis/js-apis-hashset.md) + - [@ohos.util.LightWeightMap](reference/apis/js-apis-lightweightmap.md) + - [@ohos.util.LightWeightSet](reference/apis/js-apis-lightweightset.md) + - [@ohos.util.LinkedList](reference/apis/js-apis-linkedlist.md) + - [@ohos.util.List](reference/apis/js-apis-list.md) + - [@ohos.util.PlainArray](reference/apis/js-apis-plainarray.md) + - [@ohos.util.Queue](reference/apis/js-apis-queue.md) + - [@ohos.util.Stack](reference/apis/js-apis-stack.md) + - [@ohos.util.TreeMap](reference/apis/js-apis-treemap.md) + - [@ohos.util.TreeSet](reference/apis/js-apis-treeset.md) + - [@ohos.util.Vector](reference/apis/js-apis-vector.md) + - [@ohos.worker](reference/apis/js-apis-worker.md) + - [@ohos.xml](reference/apis/js-apis-xml.md) + + - Test + - [@ohos.application.testRunner](reference/apis/js-apis-testRunner.md) + - [@ohos.uitest](reference/apis/js-apis-uitest.md) + + - APIs No Longer Maintained + + - [@ohos.bytrace](reference/apis/js-apis-bytrace.md) + - [@ohos.data.storage](reference/apis/js-apis-data-storage.md) + - [@system.app](reference/apis/js-apis-system-app.md) + - [@system.bluetooth](reference/apis/js-apis-system-bluetooth.md) + - [@system.mediaquery](reference/apis/js-apis-system-mediaquery.md) + - [@system.router](reference/apis/js-apis-system-router.md) + - [@system.sensor](reference/apis/js-apis-system-sensor.md) + - [@system.vibrator](reference/apis/js-apis-system-vibrate.md) + - [console](reference/apis/js-apis-logs.md) \ No newline at end of file diff --git a/zh-cn/application-dev/device/sensor-overview.md b/zh-cn/application-dev/device/sensor-overview.md index 6c4b8cb09b6e721ba45b57bf47ee506830869f02..69b6c06539343276191a53ccd9227a7f2b7e7faa 100644 --- a/zh-cn/application-dev/device/sensor-overview.md +++ b/zh-cn/application-dev/device/sensor-overview.md @@ -6,29 +6,29 @@ OpenHarmony系统传感器是应用访问底层硬件传感器的一种设备抽 传感器是指用于侦测环境中所发生事件或变化，并将此消息发送至其他电子设备（如中央处理器）的设备，通常由敏感组件和转换组件组成。传感器是实现物联网智能化的重要基石，为实现全场景智慧化战略，支撑“1+8+N”产品需求，需要构筑统一的传感器管理框架，达到为各产品/业务提供低时延、低功耗的感知数据的目的。下面为传感器列表： -| 传感器类型 | 描述 | 说明 | 主要用途 | -| --------------------------------------- | ------------------ | ------------------------------------------------------------ | ---------------------------------------- | -| SENSOR_TYPE_ACCELEROMETER | 加速度传感器 | 测量三个物理轴（x、y 和 z）上，施加在设备上的加速度（包括重力加速度），单位 : m/s2 | 检测运动状态 | -| SENSOR_TYPE_ACCELEROMETER_UNCALIBRATED | 未校准加速度传感器 | 测量三个物理轴（x、y 和 z）上，施加在设备上的未校准的加速度（包括重力加速度），单位 : m/s2 | 检测加速度偏差估值 | -| SENSOR_TYPE_LINEAR_ACCELERATION | 线性加速度传感器 | 测量三个物理轴（x、y 和 z）上，施加在设备上的线性加速度（不包括重力加速度），单位 : m/s2 | 检测每个单轴方向上的线性加速度 | -| SENSOR_TYPE_GRAVITY | 重力传感器 | 测量三个物理轴（x、y 和 z）上，施加在设备上的重力加速度，单位 : m/s2 | 测量重力大小 | -| SENSOR_TYPE_GYROSCOPE | 陀螺仪传感器 | 测量三个物理轴（x、y 和 z）上，设备的旋转角速度，单位 : rad/s | 测量旋转的角速度 | -| SENSOR_TYPE_GYROSCOPE_UNCALIBRATED | 未校准陀螺仪传感器 | 测量三个物理轴（x、y 和 z）上，设备的未校准旋转角速度，单位 : rad/s | 测量旋转的角速度及偏差估值 | -| SENSOR_TYPE_SIGNIFICANT_MOTION | 大幅度动作传感器 | 测量三个物理轴（x、y 和 z）上，设备是否存在大幅度运动；如果取值为1则代表存在大幅度运动，取值为0则代表没有大幅度运动 | 用于检测设备是否存在大幅度运动 | -| SENSOR_TYPE_PEDOMETER_DETECTION | 计步器检测传感器 | 检测用户的计步动作；如果取值为1则代表用户产生了计步行走的动作；取值为0则代表用户没有发生运动 | 用于检测用户是否有计步的动作 | -| SENSOR_TYPE_PEDOMETER | 计步器传感器 | 统计用户的行走步数 | 用于提供用户行走的步数数据 | -| SENSOR_TYPE_AMBIENT_TEMPERATURE | 环境温度传感器 | 测量环境温度，单位 : 摄氏度 (°C) | 测量环境温度 | -| SENSOR_TYPE_MAGNETIC_FIELD | 磁场传感器 | 测量三个物理轴向（x、y、z）上，环境地磁场，单位 : μT | 创建指南针 | -| SENSOR_TYPE_MAGNETIC_FIELD_UNCALIBRATED | 未校准磁场传感器 | 测量三个物理轴向（x、y、z）上，未校准环境地磁场，单位 : μT | 测量地磁偏差估值 | -| SENSOR_TYPE_HUMIDITY | 湿度传感器 | 测量环境的相对湿度，以百分比 (%) 表示 | 监测露点、绝对湿度和相对湿度 | -| SENSOR_TYPE_BAROMETER | 气压计传感器 | 测量环境气压，单位 : hPa 或 mbar | 测量环境气压 | -| SENSOR_TYPE_ORIENTATION | 方向传感器 | 测量设备围绕所有三个物理轴（x、y、z）旋转的角度值，单位：rad | 用于提供屏幕旋转的3个角度值 | -| SENSOR_TYPE_ROTATION_VECTOR | 旋转矢量传感器 | 测量设备旋转矢量，复合传感器：由加速度传感器、磁场传感器、陀螺仪传感器合成 | 检测设备相对于东北天坐标系的方向 | -| SENSOR_TYPE_PROXIMITY | 接近光传感器 | 测量可见物体相对于设备显示屏的接近或远离状态 | 通话中设备相对人的位置 | -| SENSOR_TYPE_AMBIENT_LIGHT | 环境光传感器 | 测量设备周围光线强度，单位：lux | 自动调节屏幕亮度，检测屏幕上方是否有遮挡 | -| SENSOR_TYPE_HEART_RATE | 心率传感器 | 测量用户的心率数值 | 用于提供用户的心率健康数据 | -| SENSOR_TYPE_WEAR_DETECTION | 佩戴检测传感器 | 检测用户是否佩戴 | 用于检测用户是否佩戴智能穿戴 | -| SENSOR_TYPE_HALL | 霍尔传感器 | 测量设备周围是否存在磁力吸引 | 设备的皮套模式 | +| 传感器类型 | 描述 | 说明 | 主要用途 | +| --------------------------------------- | --------- | ---------------------------------------- | -------------------- | +| SENSOR_TYPE_ACCELEROMETER | 加速度传感器 | 测量三个物理轴（x、y 和 z）上，施加在设备上的加速度（包括重力加速度），单位 : m/s2 | 检测运动状态 | +| SENSOR_TYPE_ACCELEROMETER_UNCALIBRATED | 未校准加速度传感器 | 测量三个物理轴（x、y 和 z）上，施加在设备上的未校准的加速度（包括重力加速度），单位 : m/s2 | 检测加速度偏差估值 | +| SENSOR_TYPE_LINEAR_ACCELERATION | 线性加速度传感器 | 测量三个物理轴（x、y 和 z）上，施加在设备上的线性加速度（不包括重力加速度），单位 : m/s2 | 检测每个单轴方向上的线性加速度 | +| SENSOR_TYPE_GRAVITY | 重力传感器 | 测量三个物理轴（x、y 和 z）上，施加在设备上的重力加速度，单位 : m/s2 | 测量重力大小 | +| SENSOR_TYPE_GYROSCOPE | 陀螺仪传感器 | 测量三个物理轴（x、y 和 z）上，设备的旋转角速度，单位 : rad/s | 测量旋转的角速度 | +| SENSOR_TYPE_GYROSCOPE_UNCALIBRATED | 未校准陀螺仪传感器 | 测量三个物理轴（x、y 和 z）上，设备的未校准旋转角速度，单位 : rad/s | 测量旋转的角速度及偏差估值 | +| SENSOR_TYPE_SIGNIFICANT_MOTION | 大幅度动作传感器 | 测量三个物理轴（x、y 和 z）上，设备是否存在大幅度运动；如果取值为1则代表存在大幅度运动，取值为0则代表没有大幅度运动 | 用于检测设备是否存在大幅度运动 | +| SENSOR_TYPE_PEDOMETER_DETECTION | 计步器检测传感器 | 检测用户的计步动作；如果取值为1则代表用户产生了计步行走的动作；取值为0则代表用户没有发生运动 | 用于检测用户是否有计步的动作 | +| SENSOR_TYPE_PEDOMETER | 计步器传感器 | 统计用户的行走步数 | 用于提供用户行走的步数数据 | +| SENSOR_TYPE_AMBIENT_TEMPERATURE | 环境温度传感器 | 测量环境温度，单位 : 摄氏度 (°C) | 测量环境温度 | +| SENSOR_TYPE_MAGNETIC_FIELD | 磁场传感器 | 测量三个物理轴向（x、y、z）上，环境地磁场，单位 : μT | 创建指南针 | +| SENSOR_TYPE_MAGNETIC_FIELD_UNCALIBRATED | 未校准磁场传感器 | 测量三个物理轴向（x、y、z）上，未校准环境地磁场，单位 : μT | 测量地磁偏差估值 | +| SENSOR_TYPE_HUMIDITY | 湿度传感器 | 测量环境的相对湿度，以百分比 (%) 表示 | 监测露点、绝对湿度和相对湿度 | +| SENSOR_TYPE_BAROMETER | 气压计传感器 | 测量环境气压，单位 : hPa 或 mbar | 测量环境气压 | +| SENSOR_TYPE_ORIENTATION | 方向传感器 | 测量设备围绕所有三个物理轴（x、y、z）旋转的角度值，单位：rad | 用于提供屏幕旋转的3个角度值 | +| SENSOR_TYPE_ROTATION_VECTOR | 旋转矢量传感器 | 测量设备旋转矢量，复合传感器：由加速度传感器、磁场传感器、陀螺仪传感器合成 | 检测设备相对于东北天坐标系的方向 | +| SENSOR_TYPE_PROXIMITY | 接近光传感器 | 测量可见物体相对于设备显示屏的接近或远离状态 | 通话中设备相对人的位置 | +| SENSOR_TYPE_AMBIENT_LIGHT | 环境光传感器 | 测量设备周围光线强度，单位：lux | 自动调节屏幕亮度，检测屏幕上方是否有遮挡 | +| SENSOR_TYPE_HEART_RATE | 心率传感器 | 测量用户的心率数值 | 用于提供用户的心率健康数据 | +| SENSOR_TYPE_WEAR_DETECTION | 佩戴检测传感器 | 检测用户是否佩戴 | 用于检测用户是否佩戴智能穿戴 | +| SENSOR_TYPE_HALL | 霍尔传感器 | 测量设备周围是否存在磁力吸引 | 设备的皮套模式 | ## 运作机制 @@ -54,12 +54,12 @@ OpenHarmony传感器包含如下四个模块：Sensor API、Sensor Framework、S 表7 传感器数据权限 - | 传感器 | 权限名 | 敏感级别 | 权限描述 | - | ------------------------- | -------------------------------- | ------------ | ----------------------- | - | 加速度传感器，加速度未校准传感器，线性加速度传感器 | ohos.permission.ACCELEROMETER | system_grant | 允许订阅Motion组对应的加速度传感器的数据 | - | 陀螺仪传感器，陀螺仪未校准传感器 | ohos.permission.GYROSCOPE | system_grant | 允许订阅Motion组对应的陀螺仪传感器的数据 | - | 计步器 | ohos.permission.ACTIVITY_MOTION | user_grant | 允许订阅运动状态 | - | 心率计 | ohos.permission.READ_HEALTH_DATA | user_grant | 允许读取健康数据 | +| 传感器 | 权限名 | 敏感级别 | 权限描述 | +| ------------------------- | -------------------------------- | ------------ | ----------------------- | +| 加速度传感器，加速度未校准传感器，线性加速度传感器 | ohos.permission.ACCELEROMETER | system_grant | 允许订阅Motion组对应的加速度传感器的数据 | +| 陀螺仪传感器，陀螺仪未校准传感器 | ohos.permission.GYROSCOPE | system_grant | 允许订阅Motion组对应的陀螺仪传感器的数据 | +| 计步器 | ohos.permission.ACTIVITY_MOTION | user_grant | 允许订阅运动状态 | +| 心率计 | ohos.permission.READ_HEALTH_DATA | user_grant | 允许读取健康数据 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-backgroundTaskManager.md b/zh-cn/application-dev/reference/apis/js-apis-backgroundTaskManager.md index 1a3c7a2dc2ebc6b8f571e28484d01b885dfc3a71..806aa7447d361c98c624457fd9336f90f2a66de9 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-backgroundTaskManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-backgroundTaskManager.md @@ -22,15 +22,15 @@ requestSuspendDelay(reason: string, callback: Callback<void>): DelaySuspen **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | reason | string | 是 | 延迟挂起申请的原因。 | - | callback | Callback<void> | 是 | 延迟即将超时的回调函数，一般在超时前6秒通过此回调通知应用。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------- | ---- | ------------------------------ | +| reason | string | 是 | 延迟挂起申请的原因。 | +| callback | Callback<void> | 是 | 延迟即将超时的回调函数，一般在超时前6秒通过此回调通知应用。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | [DelaySuspendInfo](#delaysuspendinfo) | 返回延迟挂起信息。 | +| 类型 | 说明 | +| ------------------------------------- | --------- | +| [DelaySuspendInfo](#delaysuspendinfo) | 返回延迟挂起信息。 | **示例**： ```js @@ -50,10 +50,10 @@ getRemainingDelayTime(requestId: number, callback: AsyncCallback<number>): **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | requestId | number | 是 | 延迟挂起的请求ID。 | - | callback | AsyncCallback<number> | 是 | 指定的callback回调方法。用于返回应用程序进入挂起状态之前的剩余时间，以毫秒为单位。 | +| 参数名 | 类型 | 必填 | 说明 | +| --------- | --------------------------- | ---- | ---------------------------------------- | +| requestId | number | 是 | 延迟挂起的请求ID。 | +| callback | AsyncCallback<number> | 是 | 指定的callback回调方法。用于返回应用程序进入挂起状态之前的剩余时间，以毫秒为单位。 | **示例**： @@ -78,14 +78,14 @@ getRemainingDelayTime(requestId: number): Promise<number> **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | requestId | number | 是 | 延迟挂起的请求ID。 | +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ------ | ---- | ---------- | +| requestId | number | 是 | 延迟挂起的请求ID。 | **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | Promise<number> | 指定的Promise回调方法。返回应用程序进入挂起状态之前的剩余时间，以毫秒为单位。 | +| 类型 | 说明 | +| --------------------- | ---------------------------------------- | +| Promise<number> | 指定的Promise回调方法。返回应用程序进入挂起状态之前的剩余时间，以毫秒为单位。 | **示例**： ```js @@ -107,9 +107,9 @@ cancelSuspendDelay(requestId: number): void **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | requestId | number | 是 | 延迟挂起的请求ID。 | +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ------ | ---- | ---------- | +| requestId | number | 是 | 延迟挂起的请求ID。 | **示例**： ```js @@ -128,12 +128,12 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask **参数**： -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| context | [Context](js-apis-Context.md) | 是 | 应用运行的上下文。 | -| bgMode | [BackgroundMode](#backgroundmode8) | 是 | 向系统申请的后台模式。| -| wantAgent | [WantAgent](js-apis-wantAgent.md) | 是 | 通知参数，用于指定长时任务通知点击后跳转的界面。 | -| callback | AsyncCallback<void> | 是 | callback形式返回启动长时任务的结果。 | +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ---------------------------------- | ---- | ------------------------ | +| context | [Context](js-apis-Context.md) | 是 | 应用运行的上下文。 | +| bgMode | [BackgroundMode](#backgroundmode8) | 是 | 向系统申请的后台模式。 | +| wantAgent | [WantAgent](js-apis-wantAgent.md) | 是 | 通知参数，用于指定长时任务通知点击后跳转的界面。 | +| callback | AsyncCallback<void> | 是 | callback形式返回启动长时任务的结果。 | **示例**： ```js @@ -180,16 +180,16 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want **参数**： -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| context | [Context](js-apis-Context.md) | 是 | 应用运行的上下文。 | -| bgMode | [BackgroundMode](#backgroundmode8) | 是 | 向系统申请的后台模式。 | -| wantAgent | [WantAgent](js-apis-wantAgent.md) | 是 | 通知参数，用于指定长时任务通知点击跳转的界面。 | +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ---------------------------------- | ---- | ----------------------- | +| context | [Context](js-apis-Context.md) | 是 | 应用运行的上下文。 | +| bgMode | [BackgroundMode](#backgroundmode8) | 是 | 向系统申请的后台模式。 | +| wantAgent | [WantAgent](js-apis-wantAgent.md) | 是 | 通知参数，用于指定长时任务通知点击跳转的界面。 | **返回值** - | 类型 | 说明 | - | -------------- | ------------------------- | - | Promise\ | 使用Promise形式返回结果。 | +| 类型 | 说明 | +| -------------- | ---------------- | +| Promise\ | 使用Promise形式返回结果。 | **示例**： ```js @@ -229,10 +229,10 @@ stopBackgroundRunning(context: Context, callback: AsyncCallback<void>): vo **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | context | [Context](js-apis-Context.md) | 是 | 应用运行的上下文。 | - | callback | AsyncCallback<void> | 是 | callback形式返回启动长时任务的结果。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------- | ---- | ---------------------- | +| context | [Context](js-apis-Context.md) | 是 | 应用运行的上下文。 | +| callback | AsyncCallback<void> | 是 | callback形式返回启动长时任务的结果。 | **示例**： ```js @@ -260,14 +260,14 @@ stopBackgroundRunning(context: Context): Promise<void> **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | context | [Context](js-apis-Context.md) | 是 | 应用运行的上下文。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ----------------------------- | ---- | --------- | +| context | [Context](js-apis-Context.md) | 是 | 应用运行的上下文。 | **返回值** - | 类型 | 说明 | - | -------------- | ------------------------- | - | Promise\ | 使用Promise形式返回结果。 | +| 类型 | 说明 | +| -------------- | ---------------- | +| Promise\ | 使用Promise形式返回结果。 | **示例**： ```js @@ -288,24 +288,24 @@ backgroundTaskManager.stopBackgroundRunning(featureAbility.getContext()).then(() **系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| requestId | number | 是 | 延迟挂起的请求ID。 | -| actualDelayTime | number | 是 | 应用的实际挂起延迟时间，以毫秒为单位。
    一般情况下默认值为180000，低电量（依据系统低电量广播）时默认值为60000。 | +| 参数名 | 类型 | 必填 | 说明 | +| --------------- | ------ | ---- | ---------------------------------------- | +| requestId | number | 是 | 延迟挂起的请求ID。 | +| actualDelayTime | number | 是 | 应用的实际挂起延迟时间，以毫秒为单位。
    一般情况下默认值为180000，低电量（依据系统低电量广播）时默认值为60000。 | ## BackgroundMode8+ **系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask -| 参数名 | 参数值 | 描述 | -| ----------------------- | -------- | -------- | -| DATA_TRANSFER | 1 | 数据传输 | -| AUDIO_PLAYBACK | 2 | 音频播放 | -| AUDIO_RECORDING | 3 | 录音 | -| LOCATION | 4 | 定位导航 | -| BLUETOOTH_INTERACTION | 5 | 蓝牙相关 | -| MULTI_DEVICE_CONNECTION | 6 | 多设备互联 | -| WIFI_INTERACTION | 7 | WLAN相关（系统保留） | -| VOIP | 8 | 音视频通话（系统保留） | -| TASK_KEEPING | 9 | 计算任务（仅供PC使用） | \ No newline at end of file +| 参数名 | 参数值 | 描述 | +| ----------------------- | ---- | ------------ | +| DATA_TRANSFER | 1 | 数据传输 | +| AUDIO_PLAYBACK | 2 | 音频播放 | +| AUDIO_RECORDING | 3 | 录音 | +| LOCATION | 4 | 定位导航 | +| BLUETOOTH_INTERACTION | 5 | 蓝牙相关 | +| MULTI_DEVICE_CONNECTION | 6 | 多设备互联 | +| WIFI_INTERACTION | 7 | WLAN相关（系统保留） | +| VOIP | 8 | 音视频通话（系统保留） | +| TASK_KEEPING | 9 | 计算任务 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-prompt.md b/zh-cn/application-dev/reference/apis/js-apis-prompt.md index 6e68ded1857dbf1ca84c240ea5e7e14833c1d7f5..1523a09d8b4ad3ec3f9c76387a818d9df12ec130 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-prompt.md +++ b/zh-cn/application-dev/reference/apis/js-apis-prompt.md @@ -21,9 +21,9 @@ showToast(options: ShowToastOptions): void **系统能力：** SystemCapability.ArkUI.ArkUI.Full **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | options | [ShowToastOptions](#showtoastoptions) | 是 | 文本弹窗选项。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------------------------------------- | ---- | ------- | +| options | [ShowToastOptions](#showtoastoptions) | 是 | 文本弹窗选项。 | **示例：** ``` @@ -42,11 +42,11 @@ showToast(options: ShowToastOptions): void **系统能力：** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full。 -| 名称 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| message | string | 是 | 显示的文本信息。 | -| duration | number | 否 | 默认值1500ms，建议区间：1500ms-10000ms，若小于1500ms则取默认值。 | -| bottom | <length> | 否 | 设置弹窗边框距离屏幕底部的位置，仅手机和平板设备支持。 | +| 名称 | 类型 | 必填 | 说明 | +| -------- | -------------- | ---- | ---------------------------------------- | +| message | string | 是 | 显示的文本信息。 | +| duration | number | 否 | 默认值1500ms，建议区间：1500ms-10000ms，若小于1500ms则取默认值。 | +| bottom | <length> | 否 | 设置弹窗边框距离屏幕底部的位置。 | ## prompt.showDialog @@ -57,15 +57,15 @@ showDialog(options: ShowDialogOptions): Promise<ShowDialogSuccessResponse> **系统能力：** SystemCapability.ArkUI.ArkUI.Full **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | options | [ShowDialogOptions](#showdialogoptions) | 是 | 对话框选项。| +| 参数名 | 类型 | 必填 | 说明 | +| ------- | --------------------------------------- | ---- | ------ | +| options | [ShowDialogOptions](#showdialogoptions) | 是 | 对话框选项。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<[ShowDialogSuccessResponse](#showdialogsuccessresponse)> | 对话框响应结果。| +| 类型 | 说明 | +| ---------------------------------------- | -------- | +| Promise<[ShowDialogSuccessResponse](#showdialogsuccessresponse)> | 对话框响应结果。 | **示例：** @@ -106,10 +106,10 @@ showDialog(options: ShowDialogOptions, callback: AsyncCallback<ShowDialogSucc **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | options | [ShowDialogOptions](#showdialogoptions) | 是 | 页面显示对话框信息描述。| - | callback | AsyncCallback<[ShowDialogSuccessResponse](#showdialogsuccessresponse)> | 是 | 对话框响应结果回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ------------ | +| options | [ShowDialogOptions](#showdialogoptions) | 是 | 页面显示对话框信息描述。 | +| callback | AsyncCallback<[ShowDialogSuccessResponse](#showdialogsuccessresponse)> | 是 | 对话框响应结果回调。 | **示例：** ``` @@ -146,11 +146,11 @@ showDialog(options: ShowDialogOptions, callback: AsyncCallback<ShowDialogSucc **系统能力：** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full。 -| 名称 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| title | string | 否 | 标题文本。 | -| message | string | 否 | 内容文本。 | -| buttons | Array | 否 | 对话框中按钮的数组，结构为：{text:'button', color: '\#666666'}，支持1-3个按钮。其中第一个为positiveButton；第二个为negativeButton；第三个为neutralButton。 | +| 名称 | 类型 | 必填 | 说明 | +| ------- | ------ | ---- | ---------------------------------------- | +| title | string | 否 | 标题文本。 | +| message | string | 否 | 内容文本。 | +| buttons | Array | 否 | 对话框中按钮的数组，结构为：{text:'button', color: '\#666666'}，支持1-3个按钮。其中第一个为positiveButton；第二个为negativeButton；第三个为neutralButton。 | ## ShowDialogSuccessResponse @@ -158,8 +158,8 @@ showDialog(options: ShowDialogOptions, callback: AsyncCallback<ShowDialogSucc **系统能力：** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full。 -| 名称 | 类型 | 说明 | -| -------- | -------- | -------- | +| 名称 | 类型 | 说明 | +| ----- | ------ | ------------------- | | index | number | 选中按钮在buttons数组中的索引。 | @@ -172,10 +172,10 @@ showActionMenu(options: ActionMenuOptions, callback: AsyncCallback<ActionMenu **系统能力：** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full。 **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | options | [ActionMenuOptions](#actionmenuoptions) | 是 | 操作菜单选项。 | - | callback | AsyncCallback<[ActionMenuSuccessResponse](#actionmenusuccessresponse)> | 是 | 菜单响应结果回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | --------- | +| options | [ActionMenuOptions](#actionmenuoptions) | 是 | 操作菜单选项。 | +| callback | AsyncCallback<[ActionMenuSuccessResponse](#actionmenusuccessresponse)> | 是 | 菜单响应结果回调。 | **示例：** @@ -215,14 +215,14 @@ showActionMenu(options: ActionMenuOptions): Promise **系统能力：** SystemCapability.ArkUI.ArkUI.Full **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | options | [ActionMenuOptions](#actionmenuoptions) | 是 | 操作菜单选项。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | --------------------------------------- | ---- | ------- | +| options | [ActionMenuOptions](#actionmenuoptions) | 是 | 操作菜单选项。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<[ActionMenuSuccessResponse](#actionmenusuccessresponse)> | 菜单响应结果。| +| 类型 | 说明 | +| ---------------------------------------- | ------- | +| Promise<[ActionMenuSuccessResponse](#actionmenusuccessresponse)> | 菜单响应结果。 | **示例：** ``` @@ -256,10 +256,10 @@ showActionMenu(options: ActionMenuOptions): Promise **系统能力：** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full。 -| 名称 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| title | string | 否 | 标题文本。 | -| buttons | Array | 是 | 菜单中菜单项按钮的数组，结构为：{text:'button', color: '\#666666'}，支持1-6个按钮。大于6个按钮时弹窗不显示。 | +| 名称 | 类型 | 必填 | 说明 | +| ------- | ------ | ---- | ---------------------------------------- | +| title | string | 否 | 标题文本。 | +| buttons | Array | 是 | 菜单中菜单项按钮的数组，结构为：{text:'button', color: '\#666666'}，支持1-6个按钮。大于6个按钮时弹窗不显示。 | ## ActionMenuSuccessResponse @@ -267,7 +267,7 @@ showActionMenu(options: ActionMenuOptions): Promise **系统能力：** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full。 -| 名称 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| index | number | 否 | 选中按钮在buttons数组中的索引，从0开始。 | +| 名称 | 类型 | 必填 | 说明 | +| ----- | ------ | ---- | ------------------------ | +| index | number | 否 | 选中按钮在buttons数组中的索引，从0开始。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-prompt.md b/zh-cn/application-dev/reference/apis/js-apis-system-prompt.md index 5c285ac121dd97661bba10eccb37086368a6062a..c400fc338712c9c6062342f984fe8cee24115ac5 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-prompt.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-prompt.md @@ -135,7 +135,7 @@ export default { | ------------------- | -------------- | ---- | ---------------------------------------- | | message | string | 是 | 显示的文本信息。 | | duration | number | 否 | 默认值1500ms，建议区间：1500ms-10000ms。若小于1500ms则取默认值，最大取值为10000ms。 | -| bottom5+ | string\|number | 否 | 设置弹窗边框距离屏幕底部的位置，仅手机和平板设备支持。 | +| bottom5+ | string\|number | 否 | 设置弹窗边框距离屏幕底部的位置。 | ## Button diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-sensor.md b/zh-cn/application-dev/reference/apis/js-apis-system-sensor.md index aa780143e6bda9dbcae31ead2fb0f31f2c3b4f12..69fd17f9c8f6db70281893c895b2241d27d239c3 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-sensor.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-sensor.md @@ -2,8 +2,9 @@ > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** -> - 本模块首批接口从API version 4开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> > - 从API Version 8开始，该接口不再维护，推荐使用新接口[`@ohos.sensor`](js-apis-sensor.md)。 +> - 本模块首批接口从API version 4开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > - 该功能使用需要对应硬件支持，仅支持真机调试。 @@ -17,9 +18,9 @@ import sensor from '@system.sensor'; ## 传感器错误码列表 - | 错误码 | 说明 | -| -------- | -------- | -| 900 | 当前设备不支持相应的传感器。 | +| 错误码 | 说明 | +| ---- | -------------- | +| 900 | 当前设备不支持相应的传感器。 | ## sensor.subscribeAccelerometer @@ -33,19 +34,19 @@ subscribeAccelerometer(Object): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| interval | string | 是 | 频率参数，加速度的回调函数执行频率。
    默认为normal，可选值有：
    - game：极高的回调频率，20ms/次，适用于游戏。
    - ui：较高的回调频率，60ms/次，适用于UI更新。
    - normal：普通的回调频率，200ms/次，低功耗。 | -| success | Function | 是 | 感应到加速度数据变化后的回调函数。 | -| fail | Function | 否 | 接口调用失败的回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | ---- | ---------------------------------------- | +| interval | string | 是 | 频率参数，加速度的回调函数执行频率。
    默认为normal，可选值有：
    - game：极高的回调频率，20ms/次，适用于游戏。
    - ui：较高的回调频率，60ms/次，适用于UI更新。
    - normal：普通的回调频率，200ms/次，低功耗。 | +| success | Function | 是 | 感应到加速度数据变化后的回调函数。 | +| fail | Function | 否 | 接口调用失败的回调函数。 | success返回值： - | 参数名 | 类型 | 说明 | -| -------- | -------- | -------- | -| x | number | x轴的加速度。 | -| y | number | y轴的加速度。 | -| z | number | z轴的加速度。 | +| 参数名 | 类型 | 说明 | +| ---- | ------ | ------- | +| x | number | x轴的加速度。 | +| y | number | y轴的加速度。 | +| z | number | z轴的加速度。 | **示例：** @@ -92,16 +93,16 @@ subscribeCompass(Object): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| success | Function | 是 | 罗盘数据改变后触发的回调函数。 | -| fail | Function | 否 | 接口调用失败的回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | -------- | ---- | --------------- | +| success | Function | 是 | 罗盘数据改变后触发的回调函数。 | +| fail | Function | 否 | 接口调用失败的回调函数。 | success返回值： - | 参数名 | 类型 | 说明 | -| -------- | -------- | -------- | -| direction | number | 设备面对的方向度数。 | +| 参数名 | 类型 | 说明 | +| --------- | ------ | ---------- | +| direction | number | 设备面对的方向度数。 | **示例：** @@ -143,16 +144,16 @@ subscribeProximity(Object): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| success | Function | 是 | 距离感应数据改变后调用的回调函数。 | -| fail | Function | 否 | 接口调用失败的回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | -------- | ---- | ----------------- | +| success | Function | 是 | 距离感应数据改变后调用的回调函数。 | +| fail | Function | 否 | 接口调用失败的回调函数。 | success返回值： - | 参数名 | 类型 | 说明 | -| -------- | -------- | -------- | -| distance | number | 可见物体相对于设备显示屏的接近或远离状态。 | +| 参数名 | 类型 | 说明 | +| -------- | ------ | --------------------- | +| distance | number | 可见物体相对于设备显示屏的接近或远离状态。 | **示例：** @@ -194,16 +195,16 @@ sensor.subscribeLight(Object): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| success | Function | 是 | 光线感应数据改变后的回调函数。 | -| fail | Function | 否 | 接口调用失败的回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | -------- | ---- | --------------- | +| success | Function | 是 | 光线感应数据改变后的回调函数。 | +| fail | Function | 否 | 接口调用失败的回调函数。 | success返回值： - | 参数名 | 类型 | 说明 | -| -------- | -------- | -------- | -| intensity | number | 光线强度，单位为lux。 | +| 参数名 | 类型 | 说明 | +| --------- | ------ | ------------ | +| intensity | number | 光线强度，单位为lux。 | **示例：** @@ -247,16 +248,16 @@ subscribeStepCounter(Object): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| success | Function | 是 | 计步传感器数据改变后的回调函数。 | -| fail | Function | 否 | 接口调用失败的回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | -------- | ---- | ---------------- | +| success | Function | 是 | 计步传感器数据改变后的回调函数。 | +| fail | Function | 否 | 接口调用失败的回调函数。 | success返回值： - | 参数名 | 类型 | 说明 | -| -------- | -------- | -------- | -| steps | number | 计步传感器重启后累计记录的步数。
    | +| 参数名 | 类型 | 说明 | +| ----- | ------ | --------------------- | +| steps | number | 计步传感器重启后累计记录的步数。
    | **示例：** @@ -301,16 +302,16 @@ subcribeBarometer(Object): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| success | Function | 是 | 气压传感器数据改变后的回调函数。 | -| fail | Function | 否 | 接口调用失败的回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | -------- | ---- | ---------------- | +| success | Function | 是 | 气压传感器数据改变后的回调函数。 | +| fail | Function | 否 | 接口调用失败的回调函数。 | success返回值： - | 参数名 | 类型 | 说明 | -| -------- | -------- | -------- | -| pressure | number | 气压值，单位：帕斯卡。 | +| 参数名 | 类型 | 说明 | +| -------- | ------ | ----------- | +| pressure | number | 气压值，单位：帕斯卡。 | **示例：** @@ -356,16 +357,16 @@ subscribeHeartRate(Object): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| success | Function | 是 | 心率传感器数据改变后的回调函数，默认频率5s/次。 | -| fail | Function | 否 | 接口调用失败的回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | -------- | ---- | ------------------------- | +| success | Function | 是 | 心率传感器数据改变后的回调函数，默认频率5s/次。 | +| fail | Function | 否 | 接口调用失败的回调函数。 | success返回值： - | 参数名 | 类型 | 说明 | -| -------- | -------- | -------- | -| heartRate | number | 心率值。 | +| 参数名 | 类型 | 说明 | +| --------- | ------ | ---- | +| heartRate | number | 心率值。 | **示例：** @@ -410,16 +411,16 @@ subscribeOnBodyState(Object): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| success | Function | 是 | 穿戴状态改变后的回调函数。 | -| fail | Function | 否 | 接口调用失败的回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | -------- | ---- | ------------- | +| success | Function | 是 | 穿戴状态改变后的回调函数。 | +| fail | Function | 否 | 接口调用失败的回调函数。 | success返回值： - | 参数名 | 类型 | 说明 | -| -------- | -------- | -------- | -| value | boolean | 是否已佩戴。 | +| 参数名 | 类型 | 说明 | +| ----- | ------- | ------ | +| value | boolean | 是否已佩戴。 | **示例：** @@ -461,17 +462,17 @@ getOnBodyState(Object): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| success | Function | 否 | 接口调用成功的回调函数。 | -| fail | Function | 否 | 接口调用失败的回调函数。 | -| complete | Function | 否 | 接口调用结束的回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | ---- | ------------ | +| success | Function | 否 | 接口调用成功的回调函数。 | +| fail | Function | 否 | 接口调用失败的回调函数。 | +| complete | Function | 否 | 接口调用结束的回调函数。 | success返回值： - | 参数名 | 类型 | 说明 | -| -------- | -------- | -------- | -| value | boolean | 是否已佩戴。 | +| 参数名 | 类型 | 说明 | +| ----- | ------- | ------ | +| value | boolean | 是否已佩戴。 | **示例：** @@ -498,18 +499,18 @@ subscribeDeviceOrientation(interval: string, success: (data: DeviceOrientationRe **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| interval | string | 是 | 频率参数，设备方向传感器的回调函数执行频率。
    默认为normal，可选值有：
    - game：极高的回调频率，20ms/次，适用于游戏。
    - ui：较高的回调频率，60ms/次，适用于UI更新。
    - normal：普通的回调频率，200ms/次，低功耗。 | -| success | Function | 是 | 感应到设备方向传感器数据变化后的回调函数。 | -| fail | Function | 否 | 接口调用失败的回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | ---- | ---------------------------------------- | +| interval | string | 是 | 频率参数，设备方向传感器的回调函数执行频率。
    默认为normal，可选值有：
    - game：极高的回调频率，20ms/次，适用于游戏。
    - ui：较高的回调频率，60ms/次，适用于UI更新。
    - normal：普通的回调频率，200ms/次，低功耗。 | +| success | Function | 是 | 感应到设备方向传感器数据变化后的回调函数。 | +| fail | Function | 否 | 接口调用失败的回调函数。 | success返回值： - | 参数名 | 类型 | 说明 | -| -------- | -------- | -------- | -| alpha | number | 当手机坐标 X/Y 和地球 X/Y 重合时，绕着 Z 轴转动的夹角为 alpha。 | -| beta | number | 当手机坐标 Y/Z 和地球 Y/Z 重合时，绕着 X 轴转动的夹角为 beta。 | -| gamma | number | 当手机 X/Z 和地球 X/Z 重合时，绕着 Y 轴转动的夹角为 gamma。 | +| 参数名 | 类型 | 说明 | +| ----- | ------ | ---------------------------------------- | +| alpha | number | 当设备坐标 X/Y 和地球 X/Y 重合时，绕着 Z 轴转动的夹角为 alpha。 | +| beta | number | 当设备坐标 Y/Z 和地球 Y/Z 重合时，绕着 X 轴转动的夹角为 beta。 | +| gamma | number | 当设备 X/Z 和地球 X/Z 重合时，绕着 Y 轴转动的夹角为 gamma。 | **示例：** @@ -558,19 +559,19 @@ subscribeGyroscope(interval: string, success: (data: GyroscopeResponse), fail?: **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| interval | string | 是 | 频率参数，陀螺仪的回调函数执行频率。
    默认为normal，可选值有：
    - game：极高的回调频率，20ms/次，适用于游戏。
    - ui：较高的回调频率，60ms/次，适用于UI更新。
    - normal：普通的回调频率，200ms/次，低功耗。 | -| success | Function | 是 | 感应到陀螺仪数据变化后的回调函数。 | -| fail | Function | 否 | 接口调用失败的回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | ---- | ---------------------------------------- | +| interval | string | 是 | 频率参数，陀螺仪的回调函数执行频率。
    默认为normal，可选值有：
    - game：极高的回调频率，20ms/次，适用于游戏。
    - ui：较高的回调频率，60ms/次，适用于UI更新。
    - normal：普通的回调频率，200ms/次，低功耗。 | +| success | Function | 是 | 感应到陀螺仪数据变化后的回调函数。 | +| fail | Function | 否 | 接口调用失败的回调函数。 | success返回值： - | 参数名 | 类型 | 说明 | -| -------- | -------- | -------- | -| x | number | x轴的旋转角速度。 | -| y | number | y轴的旋转角速度。 | -| z | number | z轴的旋转角速度。 | +| 参数名 | 类型 | 说明 | +| ---- | ------ | --------- | +| x | number | x轴的旋转角速度。 | +| y | number | y轴的旋转角速度。 | +| z | number | z轴的旋转角速度。 | **示例：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-update.md b/zh-cn/application-dev/reference/apis/js-apis-update.md index d5cb631df90fda9bfd7300f7460fa8441ecf0e73..3ec708af81564e20e8ac812d8ce4c9efebaf77c2 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-update.md +++ b/zh-cn/application-dev/reference/apis/js-apis-update.md @@ -1,4 +1,4 @@ -# 升级 +升级 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 @@ -8,7 +8,7 @@ 升级依赖：升级分为SD卡升级和在线升级两种。 - SD卡升级依赖升级包和SD卡安装。 -- 在线升级依赖手机厂商部署的用于管理升级包的服务器。服务器由手机厂商部署，IP由调用者传入，请求的request接口是固定的，由手机厂商开发。 +- 在线升级依赖设备厂商部署的用于管理升级包的服务器。服务器由设备厂商部署，IP由调用者传入，请求的request接口是固定的，由设备厂商开发。 ## 导入模块 diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-basic-picker-view.md b/zh-cn/application-dev/reference/arkui-js/js-components-basic-picker-view.md index 0d9575bb3f714aed9f084bc3ae2f8a6e74bb7d16..15a1e89ddca0b91a2fe9716e2037010f63738fa6 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-basic-picker-view.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-basic-picker-view.md @@ -15,68 +15,68 @@ 除支持[通用属性](../arkui-js/js-components-common-attributes.md)外，还支持如下属性： -| 名称 | 类型 | 默认值 | 必填 | 描述 | -| -------- | -------- | -------- | -------- | -------- | -| type | string | text | 否 | 设置滑动选择器的类型，该属性不支持动态修改，可选项有：
    - text：文本选择器。
    - time：时间选择器。
    - date：日期选择器。
    - datetime：日期时间选择器。
    - multi-text：多列文本选择器。 | +| 名称 | 类型 | 默认值 | 必填 | 描述 | +| ---- | ------ | ---- | ---- | ---------------------------------------- | +| type | string | text | 否 | 设置滑动选择器的类型，该属性不支持动态修改，可选项有：
    - text：文本选择器。
    - time：时间选择器。
    - date：日期选择器。
    - datetime：日期时间选择器。
    - multi-text：多列文本选择器。 | 文本选择器：type=text -| 名称 | 类型 | 默认值 | 必填 | 描述 | -| -------- | -------- | -------- | -------- | -------- | -| range | Array | - | 否 | 设置文本选择器的取值范围。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > 使用时需要使用数据绑定的方式，如range = {{data}}，js中声明相应变量：data：["15", "20", "25"]。 | -| selected | string | 0 | 否 | 设置文本选择器的默认选择值，该值需要为range的索引。 | -| indicatorprefix | string | - | 否 | 文本选择器选定值增加的前缀字段。 | -| indicatorsuffix | string | - | 否 | 文本选择器选定值增加的后缀字段。 | +| 名称 | 类型 | 默认值 | 必填 | 描述 | +| --------------- | ------ | ---- | ---- | ---------------------------------------- | +| range | Array | - | 否 | 设置文本选择器的取值范围。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > 使用时需要使用数据绑定的方式，如range = {{data}}，js中声明相应变量：data：["15", "20", "25"]。 | +| selected | string | 0 | 否 | 设置文本选择器的默认选择值，该值需要为range的索引。 | +| indicatorprefix | string | - | 否 | 文本选择器选定值增加的前缀字段。 | +| indicatorsuffix | string | - | 否 | 文本选择器选定值增加的后缀字段。 | 时间选择器：type=time -| 名称 | 类型 | 默认值 | 必填 | 描述 | -| -------- | -------- | -------- | -------- | -------- | -| containsecond | boolean | false | 否 | 时间选择器是否包含秒。 | -| selected | string | 当前时间 | 否 | 设置时间选择器的默认取值，格式为 HH:mm；
    当包含秒时，格式为HH:mm:ss。 | -| hours | number | 241-4
    -5+ | 否 | 设置时间选择器采用的时间格式，可选值：
    - 12：按照12小时制显示，用上午和下午进行区分；
    - 24：按照24小时制显示。
      > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
      > 默认值会依据系统当前所选地区和语言选择当地习惯的小时制(12小时制或24小时制)。5+ | +| 名称 | 类型 | 默认值 | 必填 | 描述 | +| ------------- | ------- | ----------------------------------- | ---- | ---------------------------------------- | +| containsecond | boolean | false | 否 | 时间选择器是否包含秒。 | +| selected | string | 当前时间 | 否 | 设置时间选择器的默认取值，格式为 HH:mm；
    当包含秒时，格式为HH:mm:ss。 | +| hours | number | 241-4
    -5+ | 否 | 设置时间选择器采用的时间格式，可选值：
    - 12：按照12小时制显示，用上午和下午进行区分；
    - 24：按照24小时制显示。
      > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
      > 默认值会依据系统当前所选地区和语言选择当地习惯的小时制(12小时制或24小时制)。5+ | 日期选择器：type=date -| 名称 | 类型 | 默认值 | 必填 | 描述 | -| -------- | -------- | -------- | -------- | -------- | -| start | <time> | 1970-1-1 | 否 | 设置日期选择器的起始时间，格式为 YYYY-MM-DD。 | -| end | <time> | 2100-12-31 | 否 | 设置日期选择器的结束时间，格式为 YYYY-MM-DD。 | -| selected | string | 当前日期 | 否 | 设置日期选择器的默认选择值，格式为 YYYY-MM-DD。 | -| lunar5+ | boolean | false | 否 | 设置日期选择器弹窗界面是否为农历展示。 | -| lunarswitch | boolean | false | 否 | 设置日期选择器是否显示农历开关，显示农历开关时，可以在弹窗界面展现农历的开关由于公历和农历切换。在设置显示农历时，开关状态为开，当设置不显示农历时，开关状态为关。手机生效。 | +| 名称 | 类型 | 默认值 | 必填 | 描述 | +| ------------------ | ------------ | ---------- | ---- | ---------------------------------------- | +| start | <time> | 1970-1-1 | 否 | 设置日期选择器的起始时间，格式为 YYYY-MM-DD。 | +| end | <time> | 2100-12-31 | 否 | 设置日期选择器的结束时间，格式为 YYYY-MM-DD。 | +| selected | string | 当前日期 | 否 | 设置日期选择器的默认选择值，格式为 YYYY-MM-DD。 | +| lunar5+ | boolean | false | 否 | 设置日期选择器弹窗界面是否为农历展示。 | +| lunarswitch | boolean | false | 否 | 设置日期选择器是否显示农历开关，显示农历开关时，可以在弹窗界面展现农历的开关由于公历和农历切换。在设置显示农历时，开关状态为开，当设置不显示农历时，开关状态为关。 | 日期时间选择器：type=datetime，日期的选择范围为本年的日月。 -| 名称 | 类型 | 默认值 | 必填 | 描述 | -| -------- | -------- | -------- | -------- | -------- | -| selected | string | 当前日期时间 | 否 | 设置日期时间选择器的默认取值，格式有两种，为月日时分MM-DD-HH-mm或者年月日时分YYYY-MM-DD-HH-mm，不设置年时，默认使用当前年，该取值表示选择器弹窗时弹窗界面的默认选择值。 | -| hours | number | 241-4
    -5+ | 否 | 设置日期时间选择器采用的时间格式，可选值：
    - 12：按照12小时制显示，用上午和下午进行区分；
    - 24：按照24小时制显示。
      > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
      > 默认值会依据系统当前所选地区和语言选择当地习惯的小时制(12小时制或24小时制)。5+ | -| lunar5+ | boolean | false | 否 | 设置日期时间选择器弹窗界面是否为农历展示。 | -| lunarswitch | boolean | false | 否 | 设置日期时间选择器是否显示农历开关，显示农历开关时，可以在弹窗界面展现农历的开关由于公历和农历切换。在设置显示农历时，开关状态为开，当设置不显示农历时，开关状态为关。手机生效。 | +| 名称 | 类型 | 默认值 | 必填 | 描述 | +| ------------------ | ------- | ----------------------------------- | ---- | ---------------------------------------- | +| selected | string | 当前日期时间 | 否 | 设置日期时间选择器的默认取值，格式有两种，为月日时分MM-DD-HH-mm或者年月日时分YYYY-MM-DD-HH-mm，不设置年时，默认使用当前年，该取值表示选择器弹窗时弹窗界面的默认选择值。 | +| hours | number | 241-4
    -5+ | 否 | 设置日期时间选择器采用的时间格式，可选值：
    - 12：按照12小时制显示，用上午和下午进行区分；
    - 24：按照24小时制显示。
      > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
      > 默认值会依据系统当前所选地区和语言选择当地习惯的小时制(12小时制或24小时制)。5+ | +| lunar5+ | boolean | false | 否 | 设置日期时间选择器弹窗界面是否为农历展示。 | +| lunarswitch | boolean | false | 否 | 设置日期时间选择器是否显示农历开关，显示农历开关时，可以在弹窗界面展现农历的开关由于公历和农历切换。在设置显示农历时，开关状态为开，当设置不显示农历时，开关状态为关。 | 多列文本选择器：type=multi-text -| 名称 | 类型 | 默认值 | 必填 | 描述 | -| -------- | -------- | -------- | -------- | -------- | -| columns | number | - | 是 | 设置多列文本选择器的列数。 | -| range | 二维Array | - | 否 | 设置多列文本选择器的选择值，该值为二维数组。长度表示多少列，数组的每项表示每列的数据，如  [["a","b"], ["c","d"]]。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > 使用时需要使用数据绑定的方式，如range = {{data}}，js中声明相应变量：data：[["a","b"], ["c","d"]]。 | -| selected | Array | [0,0,0,…] | 否 | 设置多列文本选择器的默认值，每一列被选中项对应的索引构成的数组，该取值表示选择器弹窗时弹窗界面的默认选择值。 | +| 名称 | 类型 | 默认值 | 必填 | 描述 | +| -------- | ------- | --------- | ---- | ---------------------------------------- | +| columns | number | - | 是 | 设置多列文本选择器的列数。 | +| range | 二维Array | - | 否 | 设置多列文本选择器的选择值，该值为二维数组。长度表示多少列，数组的每项表示每列的数据，如  [["a","b"], ["c","d"]]。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > 使用时需要使用数据绑定的方式，如range = {{data}}，js中声明相应变量：data：[["a","b"], ["c","d"]]。 | +| selected | Array | [0,0,0,…] | 否 | 设置多列文本选择器的默认值，每一列被选中项对应的索引构成的数组，该取值表示选择器弹窗时弹窗界面的默认选择值。 | ## 样式 除支持[通用样式](../arkui-js/js-components-common-styles.md)外，还支持如下样式： -| 名称 | 类型 | 默认值 | 必填 | 描述 | -| -------- | -------- | -------- | -------- | -------- | -| color | <color> | \#ffffff | 否 | 候选项字体颜色。 | -| font-size | <length> | 16px | 否 | 候选项字体尺寸，类型length，单位px。 | -| selected-color | <color> | #ff0a69f7 | 否 | 选中项字体颜色。 | -| selected-font-size | <length> | 20px | 否 | 选中项字体尺寸，类型length，单位px。 | -| disappear-color5+ | <color> | \#ffffff | 否 | 渐变消失项的字体颜色。消失项是在一列中有五个选项场景下最上和最下的两个选项。 | -| disappear-font-size5+ | <length> | 14px | 否 | 渐变消失项的字体尺寸。消失项是在一列中有五个选项场景下最上和最下的两个选项。 | -| font-family | string | sans-serif | 否 | 选项字体类型。字体列表，用逗号分隔，每个字体用字体名或者字体族名设置。列表中第一个系统中存在的或者通过[自定义字体](../arkui-js/js-components-common-customizing-font.md)指定的字体，会被选中作为文本的字体。 | +| 名称 | 类型 | 默认值 | 必填 | 描述 | +| -------------------------------- | -------------- | ---------- | ---- | ---------------------------------------- | +| color | <color> | \#ffffff | 否 | 候选项字体颜色。 | +| font-size | <length> | 16px | 否 | 候选项字体尺寸，类型length，单位px。 | +| selected-color | <color> | #ff0a69f7 | 否 | 选中项字体颜色。 | +| selected-font-size | <length> | 20px | 否 | 选中项字体尺寸，类型length，单位px。 | +| disappear-color5+ | <color> | \#ffffff | 否 | 渐变消失项的字体颜色。消失项是在一列中有五个选项场景下最上和最下的两个选项。 | +| disappear-font-size5+ | <length> | 14px | 否 | 渐变消失项的字体尺寸。消失项是在一列中有五个选项场景下最上和最下的两个选项。 | +| font-family | string | sans-serif | 否 | 选项字体类型。字体列表，用逗号分隔，每个字体用字体名或者字体族名设置。列表中第一个系统中存在的或者通过[自定义字体](../arkui-js/js-components-common-customizing-font.md)指定的字体，会被选中作为文本的字体。 | ## 事件 @@ -85,32 +85,32 @@ type=text： -| 名称 | 参数 | 描述 | -| -------- | -------- | -------- | +| 名称 | 参数 | 描述 | +| ------ | ---------------------------------------- | --------------- | | change | { newValue: newValue, newSelected: newSelected } | 文本选择器选定值后触发该事件。 | type=time： -| 名称 | 参数 | 描述 | -| -------- | -------- | -------- | +| 名称 | 参数 | 描述 | +| ------ | ---------------------------------------- | ------------------------------- | | change | { hour: hour, minute: minute, [second:second]} | 时间选择器选定值后触发该事件。
    包含秒时，返回时分秒。 | type=date： -| 名称 | 参数 | 描述 | -| -------- | -------- | -------- | +| 名称 | 参数 | 描述 | +| ------ | ---------------------------------------- | --------------- | | change | { year:year, month:month, day:day } | 日期选择器选择值后触发该事件。 | type=datetime： -| 名称 | 参数 | 描述 | -| -------- | -------- | -------- | +| 名称 | 参数 | 描述 | +| ------ | ---------------------------------------- | ----------------- | | change | { year:year, month:month, day:day,  hour:hour, minute:minute } | 日期时间选择器选择值后触发该事件。 | type=multi-text： -| 名称 | 参数 | 描述 | -| -------- | -------- | -------- | +| 名称 | 参数 | 描述 | +| ------------ | ---------------------------------------- | ---------------------------------------- | | columnchange | { column:column, newValue:newValue, newSelected:newSelected } | 多列文本选择器某一列的值改变时触发该事件，column：第几列修改，newValue：选中的值，newSelected：选中值对应的索引。 | diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-basic-picker.md b/zh-cn/application-dev/reference/arkui-js/js-components-basic-picker.md index aae0f7e0c51f613d8f0bc597b4c68e1eb525e717..45652c36949000bb41f628ec4d1cdc36c6e8f689 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-basic-picker.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-basic-picker.md @@ -20,89 +20,89 @@ 除支持[通用属性](../arkui-js/js-components-common-attributes.md)外，还支持如下属性：↵ -| 名称 | 类型 | 默认值 | 必填 | 描述 | -| -------- | -------- | -------- | -------- | -------- | -| type | string | - | 否 | 该属性值不支持动态修改。可选择项有：
    - text：文本选择器。
    - date：日期选择器。
    - time：时间选择器。
    - datetime：日期时间选择器。
    - multi-text：多列文本选择器。 | +| 名称 | 类型 | 默认值 | 必填 | 描述 | +| ---- | ------ | ---- | ---- | ---------------------------------------- | +| type | string | - | 否 | 该属性值不支持动态修改。可选择项有：
    - text：文本选择器。
    - date：日期选择器。
    - time：时间选择器。
    - datetime：日期时间选择器。
    - multi-text：多列文本选择器。 | ### 普通选择器 滑动选择器类型设置为text时表示普通选择器。 -| 名称 | 类型 | 默认值 | 必填 | 描述 | -| -------- | -------- | -------- | -------- | -------- | -| range | Array | - | 否 | 设置普通选择器的取值范围，如["15", "20", "25"]。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > 使用时需要使用数据绑定的方式，如range = {{data}}，js中声明相应变量：data：["15", "20", "25"]。 | -| selected | string | 0 | 否 | 设置普通选择器弹窗的默认取值，取值需要是 range 的索引值，该取值表示选择器弹窗界面的默认选择值。 | -| value | string | - | 否 | 设置普通选择器的值。 | +| 名称 | 类型 | 默认值 | 必填 | 描述 | +| -------- | ------ | ---- | ---- | ---------------------------------------- | +| range | Array | - | 否 | 设置普通选择器的取值范围，如["15", "20", "25"]。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > 使用时需要使用数据绑定的方式，如range = {{data}}，js中声明相应变量：data：["15", "20", "25"]。 | +| selected | string | 0 | 否 | 设置普通选择器弹窗的默认取值，取值需要是 range 的索引值，该取值表示选择器弹窗界面的默认选择值。 | +| value | string | - | 否 | 设置普通选择器的值。 | ### 日期选择器 滑动选择器类型设置为date时表示日期选择器。 -| 名称 | 类型 | 默认值 | 必填 | 描述 | -| -------- | -------- | -------- | -------- | -------- | -| start | <time> | 1970-1-1 | 否 | 设置日期选择器的起始时间，格式为 YYYY-MM-DD。 | -| end | <time> | 2100-12-31 | 否 | 设置日期选择器的结束时间，格式为 YYYY-MM-DD。 | -| selected | string | 当前日期 | 否 | 设置日期选择器弹窗的默认取值，格式为 YYYY-MM-DD，该取值表示选择器弹窗界面的默认选择值。 | -| value | string | - | 是 | 设置日期选择器的值。 | -| lunar5+ | boolean | false | 否 | 设置日期选择器弹窗界面是否为农历展示。 | -| lunarswitch | boolean | false | 否 | 设置日期选择器是否显示农历开关。当值为true时，显示农历开关，点击农历开关可切换公历和农历。当值为false时，不显示农历开关。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > 仅手机和平板设备支持。 当lunarswitch=true且lunar=true时，开关按钮处于被选中状态。 | +| 名称 | 类型 | 默认值 | 必填 | 描述 | +| ------------------ | ------------ | ---------- | ---- | ---------------------------------------- | +| start | <time> | 1970-1-1 | 否 | 设置日期选择器的起始时间，格式为 YYYY-MM-DD。 | +| end | <time> | 2100-12-31 | 否 | 设置日期选择器的结束时间，格式为 YYYY-MM-DD。 | +| selected | string | 当前日期 | 否 | 设置日期选择器弹窗的默认取值，格式为 YYYY-MM-DD，该取值表示选择器弹窗界面的默认选择值。 | +| value | string | - | 是 | 设置日期选择器的值。 | +| lunar5+ | boolean | false | 否 | 设置日期选择器弹窗界面是否为农历展示。 | +| lunarswitch | boolean | false | 否 | 设置日期选择器是否显示农历开关。当值为true时，显示农历开关，点击农历开关可切换公历和农历。当值为false时，不显示农历开关。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > 当lunarswitch=true且lunar=true时，开关按钮处于被选中状态。 | ### 时间选择器 滑动选择器类型设置为time时表示时间选择器。 -| 名称 | 类型 | 默认值 | 必填 | 描述 | -| -------- | -------- | -------- | -------- | -------- | -| containsecond | boolean | false | 否 | 设置时间选择器是否包含秒。 | -| selected | string | 当前时间 | 否 | 设置时间选择器弹窗的默认取值，格式为 HH:mm；当包含秒时，格式为HH:mm:ss，
    该取值表示选择器弹窗界面的默认选择值。 | -| value | string | - | 否 | 设置时间选择器的值。 | -| hours | number | 241-4
    -5+ | 否 | 设置时间选择器采用的时间格式，可选值：
    - 12：按照12小时制显示，用上午和下午进行区分；
    - 24：按照24小时制显示。
      > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
      > 默认值会依据系统当前所选地区和语言选择当地习惯的小时制(12小时制或24小时制)。5+ | +| 名称 | 类型 | 默认值 | 必填 | 描述 | +| ------------- | ------- | ----------------------------------- | ---- | ---------------------------------------- | +| containsecond | boolean | false | 否 | 设置时间选择器是否包含秒。 | +| selected | string | 当前时间 | 否 | 设置时间选择器弹窗的默认取值，格式为 HH:mm；当包含秒时，格式为HH:mm:ss，
    该取值表示选择器弹窗界面的默认选择值。 | +| value | string | - | 否 | 设置时间选择器的值。 | +| hours | number | 241-4
    -5+ | 否 | 设置时间选择器采用的时间格式，可选值：
    - 12：按照12小时制显示，用上午和下午进行区分；
    - 24：按照24小时制显示。
      > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
      > 默认值会依据系统当前所选地区和语言选择当地习惯的小时制(12小时制或24小时制)。5+ | ### 日期时间选择器 滑动选择器类型设置为datetime时表示日期时间选择器，日期的选择范围为本年的日月。 -| 名称 | 类型 | 默认值 | 必填 | 描述 | -| -------- | -------- | -------- | -------- | -------- | -| selected | string | 当前日期时间 | 否 | 设置日期时间选择器弹窗的默认取值，有两种可选格式。
    - 月日时分：MM-DD-HH-mm
    - 年月日时分：YYYY-MM-DD-HH-mm
    不设置年时，默认使用当前年，该取值表示选择器弹窗界面的默认选择值。 | -| value | string | - | 是 | 设置日期时间选择器的值。 | -| hours | number | 241-4
    -5+ | 否 | 设置日期时间选择器采用的时间格式，可选值：
    - 12：按照12小时制显示，用上午和下午进行区分；
    - 24：按照24小时制显示。
      > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
      > 默认值会依据系统当前所选地区和语言选择当地习惯的小时制(12小时制或24小时制)。5+ | -| lunar5+ | boolean | false | 否 | 设置日期时间选择器弹窗界面是否为农历展示。 | -| lunarswitch | boolean | false | 否 | 设置日期选择器是否显示农历开关。当值为true时，显示农历开关，点击农历开关可切换公历和农历。当值为false时，不显示农历开关。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > 仅手机和平板设备支持。 当lunarswitch=true且lunar=true时，开关按钮处于被选中状态。 | +| 名称 | 类型 | 默认值 | 必填 | 描述 | +| ------------------ | ------- | ----------------------------------- | ---- | ---------------------------------------- | +| selected | string | 当前日期时间 | 否 | 设置日期时间选择器弹窗的默认取值，有两种可选格式。
    - 月日时分：MM-DD-HH-mm
    - 年月日时分：YYYY-MM-DD-HH-mm
    不设置年时，默认使用当前年，该取值表示选择器弹窗界面的默认选择值。 | +| value | string | - | 是 | 设置日期时间选择器的值。 | +| hours | number | 241-4
    -5+ | 否 | 设置日期时间选择器采用的时间格式，可选值：
    - 12：按照12小时制显示，用上午和下午进行区分；
    - 24：按照24小时制显示。
      > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
      > 默认值会依据系统当前所选地区和语言选择当地习惯的小时制(12小时制或24小时制)。5+ | +| lunar5+ | boolean | false | 否 | 设置日期时间选择器弹窗界面是否为农历展示。 | +| lunarswitch | boolean | false | 否 | 设置日期选择器是否显示农历开关。当值为true时，显示农历开关，点击农历开关可切换公历和农历。当值为false时，不显示农历开关。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > 当lunarswitch=true且lunar=true时，开关按钮处于被选中状态。 | ### 多列文本选择器 滑动选择器类型设置为multi-text时表示多列文本选择器。 -| 名称 | 类型 | 默认值 | 必填 | 描述 | -| -------- | -------- | -------- | -------- | -------- | -| columns | number | - | 是 | 设置多列文本选择器的列数。 | -| range | 二维Array | - | 否 | 设置多列文本选择器的选择项，其中range 为二维数组。长度表示多少列，数组的每项表示每列的数据，如  [["a","b"], ["c","d"]]。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > 使用时需要使用数据绑定的方式，如range = {{data}}，js中声明相应变量：data：[["a","b"], ["c","d"]]。 | -| selected | Array | [0,0,0,…] | 否 | 设置多列文本选择器弹窗的默认值，每一列被选中项对应的索引构成的数组，该取值表示选择器弹窗界面的默认选择值。 | -| value | Array | - | 否 | 设置多列文本选择器的值，每一列被选中项对应的值构成的数组。 | +| 名称 | 类型 | 默认值 | 必填 | 描述 | +| -------- | ------- | --------- | ---- | ---------------------------------------- | +| columns | number | - | 是 | 设置多列文本选择器的列数。 | +| range | 二维Array | - | 否 | 设置多列文本选择器的选择项，其中range 为二维数组。长度表示多少列，数组的每项表示每列的数据，如  [["a","b"], ["c","d"]]。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > 使用时需要使用数据绑定的方式，如range = {{data}}，js中声明相应变量：data：[["a","b"], ["c","d"]]。 | +| selected | Array | [0,0,0,…] | 否 | 设置多列文本选择器弹窗的默认值，每一列被选中项对应的索引构成的数组，该取值表示选择器弹窗界面的默认选择值。 | +| value | Array | - | 否 | 设置多列文本选择器的值，每一列被选中项对应的值构成的数组。 | ## 样式 除支持[通用样式](../arkui-js/js-components-common-styles.md)外，还支持如下样式： -| 名称 | 类型 | 默认值 | 必填 | 描述 | -| -------- | -------- | -------- | -------- | -------- | -| text-color | <color> | - | 否 | 选择器的文本颜色。 | -| font-size | <length> | - | 否 | 选择器的文本尺寸。 | -| allow-scale | boolean | true | 否 | 选择器的文本尺寸是否跟随系统设置字体缩放尺寸进行放大缩小。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > 如果在config描述文件中针对ability配置了fontSize的config-changes标签，则应用不会重启而直接生效。 | -| letter-spacing | <length> | 0 | 否 | 选择器的字符间距。见[text组件的letter-spacing样式属性](../arkui-js/js-components-basic-text.md#样式)。 | -| text-decoration | string | - | 否 | 选择器的文本修饰。见[text组件的text-decoration样式属性](../arkui-js/js-components-basic-text.md#样式)。 | -| font-style | string | normal | 否 | 选择器的字体样式。见[text组件的font-style样式属性](../arkui-js/js-components-basic-text.md#样式)。 | -| font-weight | number \| string | normal | 否 | 选择器的字体粗细。见[text组件的font-weight样式属性](../arkui-js/js-components-basic-text.md#样式)。 | -| font-family | string | sans-serif | 否 | 选择器的字体列表，用逗号分隔，每个字体用字体名或者字体族名设置。列表中第一个系统中存在的或者通过[自定义字体](../arkui-js/js-components-common-customizing-font.md)指定的字体，会被选中作为文本的字体。 | -| line-height | <length> | 0px | 否 | 选择器的文本行高。 | -| column-height5+ | <length> | - | 否 | 选择器的选择项列表高度。 | +| 名称 | 类型 | 默认值 | 必填 | 描述 | +| -------------------------- | -------------------------- | ---------- | ---- | ---------------------------------------- | +| text-color | <color> | - | 否 | 选择器的文本颜色。 | +| font-size | <length> | - | 否 | 选择器的文本尺寸。 | +| allow-scale | boolean | true | 否 | 选择器的文本尺寸是否跟随系统设置字体缩放尺寸进行放大缩小。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > 如果在config描述文件中针对ability配置了fontSize的config-changes标签，则应用不会重启而直接生效。 | +| letter-spacing | <length> | 0 | 否 | 选择器的字符间距。见[text组件的letter-spacing样式属性](../arkui-js/js-components-basic-text.md#样式)。 | +| text-decoration | string | - | 否 | 选择器的文本修饰。见[text组件的text-decoration样式属性](../arkui-js/js-components-basic-text.md#样式)。 | +| font-style | string | normal | 否 | 选择器的字体样式。见[text组件的font-style样式属性](../arkui-js/js-components-basic-text.md#样式)。 | +| font-weight | number \| string | normal | 否 | 选择器的字体粗细。见[text组件的font-weight样式属性](../arkui-js/js-components-basic-text.md#样式)。 | +| font-family | string | sans-serif | 否 | 选择器的字体列表，用逗号分隔，每个字体用字体名或者字体族名设置。列表中第一个系统中存在的或者通过[自定义字体](../arkui-js/js-components-common-customizing-font.md)指定的字体，会被选中作为文本的字体。 | +| line-height | <length> | 0px | 否 | 选择器的文本行高。 | +| column-height5+ | <length> | - | 否 | 选择器的选择项列表高度。 | ## 事件 @@ -112,52 +112,52 @@ ### 普通选择器 -| 名称 | 参数 | 描述 | -| -------- | -------- | -------- | +| 名称 | 参数 | 描述 | +| ------ | ---------------------------------------- | ---------------------------------------- | | change | { newValue: newValue, newSelected: newSelected } | 普通选择器选择值后点击弹窗中的确定按钮时触发该事件（newSelected为索引）。 | -| cancel | - | 用户点击弹窗中的取消按钮时触发该事件。 | +| cancel | - | 用户点击弹窗中的取消按钮时触发该事件。 | ### 日期选择器 -| 名称 | 参数 | 描述 | -| -------- | -------- | -------- | +| 名称 | 参数 | 描述 | +| ------ | ---------------------------------------- | ---------------------------------------- | | change | { year: year, month: month, day: day } | 日期选择器选择值后点击弹窗中的确认按钮时触发该事件。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > month值范围为： 0（1月）~11（12月）。5+ | -| cancel | - | 用户点击弹窗中的取消按钮时触发该事件。 | +| cancel | - | 用户点击弹窗中的取消按钮时触发该事件。 | ### 日期时间选择器 -| 名称 | 参数 | 描述 | -| -------- | -------- | -------- | +| 名称 | 参数 | 描述 | +| ------ | ---------------------------------------- | ---------------------------- | | change | { year: year, month: month, day: day,  hour: hour, minute: minute} | 日期时间选择器选择值后点击弹窗中的确认按钮时触发该事件。 | -| cancel | - | 用户点击弹窗中的取消按钮时触发该事件。 | +| cancel | - | 用户点击弹窗中的取消按钮时触发该事件。 | ### 时间选择器 -| 名称 | 参数 | 描述 | -| -------- | -------- | -------- | +| 名称 | 参数 | 描述 | +| ------ | ---------------------------------------- | ---------------------------------------- | | change | { hour: hour, minute: minute, [second: second] } | 时间选择器选择值后点击弹窗中的确认按钮时触发该事件，当使用时分秒时，还包含秒数据。 | -| cancel | - | 用户点击弹窗中的取消按钮时触发该事件。 | +| cancel | - | 用户点击弹窗中的取消按钮时触发该事件。 | ### 多列文本选择器 -| 名称 | 参数 | 描述 | -| -------- | -------- | -------- | -| change | { newValue: [newValue1, newValue2, newValue3, …], newSelected:[newSelected1, newSelected2, newSelected3, …] } | 多列文本选择器选择值后点击弹窗中的确认按钮时触发该事件，其中：
    - newValue：被选中项对应的值构成的数组。
    - newSelected：被选中项对应的索引构成的数组，两者的长度和range的长度一致。 | +| 名称 | 参数 | 描述 | +| ------------ | ---------------------------------------- | ---------------------------------------- | +| change | { newValue: [newValue1, newValue2, newValue3, …], newSelected:[newSelected1, newSelected2, newSelected3, …] } | 多列文本选择器选择值后点击弹窗中的确认按钮时触发该事件，其中：
    - newValue：被选中项对应的值构成的数组。
    - newSelected：被选中项对应的索引构成的数组，两者的长度和range的长度一致。 | | columnchange | { column: column, newValue: newValue, newSelected: newSelected } | 多列文本选择器中某一列的值改变时触发该事件，其中：
    - column：第几列修改。
    - newValue：选中的值。
    - newSelected：选中值对应的索引。 | -| cancel | - | 用户点击弹窗中的取消按钮时触发该事件。 | +| cancel | - | 用户点击弹窗中的取消按钮时触发该事件。 | ## 方法 除支持[通用方法](../arkui-js/js-components-common-methods.md)外，支持如下方法： -| 名称 | 参数 | 描述 | -| -------- | -------- | -------- | -| show | - | 显示 picker。 | +| 名称 | 参数 | 描述 | +| ---- | ---- | --------------- | +| show | - | 显示 picker。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-common-styles.md b/zh-cn/application-dev/reference/arkui-js/js-components-common-styles.md index 395c073392a4752667b6f61f42752d6173a17f9b..0c59395b6ff772d622eb280c1699979c916cf4c4 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-common-styles.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-common-styles.md @@ -6,63 +6,63 @@ 组件普遍支持的可以在style或css中设置组件外观样式。 -| 名称 | 类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| width | <length> \| <percentage> | - | 设置组件自身的宽度。
    缺省时使用元素自身内容需要的宽度。
    | -| height | <length> \| <percentage> | - | 设置组件自身的高度。
    缺省时使用元素自身内容需要的高度。
    | -| min-width5+ | <length> \| <percentage>6+ | 0 | 设置元素的最小宽度。 | -| min-height5+ | <length> \| <percentage>6+ | 0 | 设置元素的最小高度。 | -| max-width5+ | <length> \| <percentage>6+ | - | 设置元素的最大宽度。默认无限制。 | -| max-height5+ | <length> \| <percentage>6+ | - | 设置元素的最大高度。默认无限制。 | -| padding | <length> \| <percentage>5+ | 0 | 使用简写属性设置所有的内边距属性。
    该属性可以有1到4个值：
    - 指定一个值时，该值指定四个边的内边距。
    - 指定两个值时，第一个值指定上下两边的内边距，第二个指定左右两边的内边距。
    - 指定三个值时，第一个指定上边的内边距，第二个指定左右两边的内边距，第三个指定下边的内边距。
    - 指定四个值时分别为上、右、下、左边的内边距（顺时针顺序）。 | -| padding-[left\|top\|right\|bottom] | <length> \| <percentage>5+ | 0 | 设置左、上、右、下内边距属性。 | -| padding-[start\|end] | <length> \| <percentage>5+ | 0 | 设置起始和末端内边距属性。 | -| margin | <length> \| <percentage>5+ | 0 | 使用简写属性设置所有的外边距属性，该属性可以有1到4个值。
    - 只有一个值时，这个值会被指定给全部的四个边。
    - 两个值时，第一个值被匹配给上和下，第二个值被匹配给左和右。
    - 三个值时，第一个值被匹配给上, 第二个值被匹配给左和右，第三个值被匹配给下。
    - 四个值时，会依次按上、右、下、左的顺序匹配 (即顺时针顺序)。 | -| margin-[left\|top\|right\|bottom] | <length> \| <percentage>5+ | 0 | 设置左、上、右、下外边距属性。 | -| margin-[start\|end] | <length> \| <percentage>5+ | 0 | 设置起始和末端外边距属性。 | -| border | - | 0 | 使用简写属性设置所有的边框属性，包含边框的宽度，样式，颜色属性，顺序设置为border-width、border-style、border-color，不设置时，各属性值为默认值。 | -| border-style | string | solid | 使用简写属性设置所有边框的样式，可选值为：
    - dotted：显示为一系列圆点，圆点半径为border-width的一半。
    - dashed：显示为一系列短的方形虚线。
    - solid：显示为一条实线。 | -| border-[left\|top\|right\|bottom]-style | string | solid | 分别设置左、上、右、下四个边框的样式，可选值为dotted、dashed、solid。 | -| border-[left\|top\|right\|bottom] | - | - | 使用简写属性设置对应位置的边框属性，包含边框的宽度，样式，颜色属性，顺序设置为border-width、border-style、border-color，不设置的值为默认值。 | -| border-width | <length> | 0 | 使用简写属性设置元素的所有边框宽度，或者单独为各边边框设置宽度。 | -| border-[left\|top\|right\|bottom]-width | <length> | 0 | 分别设置左、上、右、下四个边框的宽度。 | -| border-color | <color> | black | 使用简写属性设置元素的所有边框颜色，或者单独为各边边框设置颜色。 | -| border-[left\|top\|right\|bottom]-color | <color> | black | 分别设置左、上、右、下四个边框的颜色。 | -| border-radius | <length> | - | border-radius属性设置元素的外边框圆角半径。设置border-radius时不能单独设置某一个方向的border-[left\|top\|right\|bottom]-width，border-[left\|top\|right\|bottom]-color ，border-[left\|top\|right\|bottom]-style，如果要设置color、width和style，需要将四个方向一起设置（border-width、border-color、border-style）。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > 顺序为左下、右下、左上和右上。 | -| border-[top\|bottom]-[left\|right]-radius | <length> | - | 分别设置左上，右上，右下和左下四个角的圆角半径。 | -| background | <linear-gradient> | - | 仅支持设置[渐变样式](../arkui-js/js-components-common-gradient.md)，与background-color、background-image不兼容。 | -| background-color | <color> | - | 设置背景颜色。 | -| background-image | string | - | 设置背景图片。与background-color、background不兼容，支持网络图片资源和本地图片资源地址。
    示例：
    - background-image: url("/common/background.png")
      > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
      > 不支持svg格式图片。 | -| background-size | - string
    - <length> <length>
    - <percentage> <percentage> | auto | 设置背景图片的大小。
    - string可选值：
      - contain：把图片扩展至最大尺寸，以使其高度和宽度完全适用内容区域。
      - cover：把背景图片扩展至足够大，以使背景图片完全覆盖背景区域；背景图片的某些部分也许无法显示在背景定位区域中。
      - auto：保持原图的比例不变。
    - length值参数方式：
      设置背景图片的高度和宽度。第一个值设置宽度，第二个值设置高度。如果只设置一个值，则第二个值会被设置为 "auto"。
    - 百分比参数方式：
      以父元素的百分比来设置背景图片的宽度和高度。第一个值设置宽度，第二个值设置高度。如果只设置一个值，则第二个值会被设置为 "auto"。 | -| background-repeat | string | repeat | 针对重复背景图片样式进行设置，背景图片默认在水平和垂直方向上重复。
    - repeat：在水平轴和竖直轴上同时重复绘制图片。
    - repeat-x：只在水平轴上重复绘制图片。
    - repeat-y：只在竖直轴上重复绘制图片。
    - no-repeat：不会重复绘制图片。 | -| background-position | - string string
    - <length> <length>
    - <percentage> <percentage> | 0px 0px | - 关键词方式：如果仅规定了一个关键词，那么第二个值为"center"。两个值分别定义水平方向位置和竖直方向位置。
      - left：水平方向上最左侧。
      - right：水平方向上最右侧。
      - top：竖直方向上最顶部。
      - bottom：竖直方向上最底部。
      - center：水平方向或竖直方向上中间位置。
    - length值参数方式：第一个值是水平位置，第二个值是垂直位置。 左上角是 0 0。单位是像素 (0px 0px)  。如果仅规定了一个值，另外一个值将是50%。
    - 百分比参数方式：第一个值是水平位置，第二个值是垂直位置。左上角是 0% 0%。右下角是 100% 100%。如果仅规定了一个值，另外一个值为50%。
    - 可以混合使用<percentage>和<length>。 | -| box-shadow5+ | string | 0 | 语法：box-shadow: h-shadow v-shadow blur spread color
    通过这个样式可以设置当前组件的阴影样式，包括水平位置(必填)、垂直位置(必填)、模糊半径(可选，默认值为0)、阴影延展距离(可选，默认值为0)、阴影颜色(可选，默认值为黑色)。
    示例：
    - box-shadow :10px 20px 5px 10px \#888888
    - box-shadow :100px 100px 30px red
    - box-shadow :-100px -100px 0px 40px | -| filter5+ | string | - | 语法：filter: blur(px)
    通过这个样式可以设置当前组件布局范围的内容模糊，参数用于指定模糊半径，如果没有设置值，则默认是0(不模糊)，不支持百分比。
    示例：
    - filter: blur(10px) | -| backdrop-filter5+ | string | - | 语法：backdrop-filter: blur(px)
    通过这个样式可以设置当前组件布局范围的背景模糊，参数用于指定模糊半径，如果没有设置值，则默认是0(不模糊)，不支持百分比。
    示例：
    - backdrop-filter: blur(10px) | -| window-filter5+ | string | - | 语法：window-filter: blur(percent), style5+
    通过这个样式可以设置当前组件布局范围的窗口模糊程度和模糊样式，如果没有设置值，则默认是0%(不模糊)，多块模糊区域时不支持设置不同的模糊值和模糊样式。style可选值：small_light(默认值), medium_light, large_light, xlarge_light, small_dark, medium_dark, large_dark, xlarge_dark。
    示例：
    - window-filter: blur(50%)
    - window-filter: blur(10%), large_light
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > 仅手机和平板设备支持。 | -| opacity | number | 1 | 元素的透明度，取值范围为0到1，1表示为不透明，0表示为完全透明。 | -| display | string | flex | 确定一个元素所产生的框的类型，可选值为：
    - flex：弹性布局。
    - none：不渲染此元素。 | -| visibility | string | visible | 是否显示元素所产生的框。不可见的框会占用布局（将'display'属性设置为'none'来完全去除框），可选值为：
    - visible：元素正常显示。
    - hidden：隐藏元素，但是其他元素的布局不改变，相当于此元素变成透明。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > visibility和display样式都设置时，仅display生效。 | -| flex | number \| string | - | 规定当前组件如何适应父组件中的可用空间。
    flex可以指定1个、2个5+或3个5+值。
    单值语法：
    - 一个无单位数：用来设置组件的flex-grow。
    - 一个有效的宽度值5+：用来设置组件的flex-basis。
    双值语法5+：
    第一个值必须是无单位数，用来设置组件的flex-grow。第二个值是以下之一：
    - 一个无单位数：用来设置组件的flex-shrink。
    - 一个有效的宽度值：用来设置组件的flex-basis。
    三值语法5+：
    第一个值必须是无单位数，用来设置组件的flex-grow；第二个值必须是无单位数，用来设置组件的flex-shrink；第三个值必须是一个有效的宽度值，用来设置组件的flex-basis。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > 仅父容器为<div>、<list-item>、<tabs>、<refresh>、<stepper-item>5+时生效。 | -| flex-grow | number | 0 | 设置组件的拉伸样式，指定父组件容器主轴方向上剩余空间（容器本身大小减去所有flex子元素占用的大小）的分配权重。0为不伸展。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > 仅父容器为<div>、<list-item>、<tabs>、<refresh>、<stepper-item>5+时生效。 | -| flex-shrink | number | 1 | 设置组件的收缩样式，元素仅在默认宽度之和大于容器的时候才会发生收缩，0为不收缩。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > 仅父容器为<div>、<list-item>、<tabs>、<refresh>、<stepper-item>5+时生效。 | -| flex-basis | <length> | - | 设置组件在主轴方向上的初始大小。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > 仅父容器为<div>、<list-item>、<tabs>、<refresh>、<stepper-item>5+时生效。 | -| align-self6+ | string | - | 设置自身在父元素交叉轴上的对齐方式，该样式会覆盖父元素的align-items样式，仅在父容器为div、list。可选值为：
    - stretch 弹性元素被在交叉轴方向被拉伸到与容器相同的高度或宽度。
    - flex-start 元素向交叉轴起点对齐。
    - flex-end 元素向交叉轴终点对齐。
    - center 元素在交叉轴居中。
    - baseline 元素在交叉轴基线对齐。 | -| position | string | relative | 设置元素的定位类型，不支持动态变更。
    - fixed：相对与整个界面进行定位。
    - absolute：相对于父元素进行定位。
    - relative：相对于其正常位置进行定位。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > absolute属性仅在父容器为<div>、<stack>时生效。 | -| [left\|top\|right\|bottom] | <length> \| <percentage>6+ | - | left\|top\|right\|bottom需要配合position样式使用，来确定元素的偏移位置。
    - left属性规定元素的左边缘。该属性定义了定位元素左外边距边界与其包含块左边界之间的偏移。
    - top属性规定元素的顶部边缘。该属性定义了一个定位元素的上外边距边界与其包含块上边界之间的偏移。
    - right属性规定元素的右边缘。该属性定义了定位元素右外边距边界与其包含块右边界之间的偏移。
    - bottom属性规定元素的底部边缘。该属性定义了一个定位元素的下外边距边界与其包含块下边界之间的偏移。 | -| [start \| end]6+ | <length> \| <percentage> | - | start \| end需要配合position样式使用，来确定元素的偏移位置。
    - start属性规定元素的起始边缘。该属性定义了定位元素起始外边距边界与其包含块起始边界之间的偏移。
    - end属性规定元素的结尾边缘。该属性定义了一个定位元素的结尾边距边界与其包含块结尾边界之间的偏移。 | -| z-index6+ | number | - | 表示对于同一父节点其子节点的渲染顺序。数值越大，渲染数据越靠后。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > z-index不支持auto，并且opacity等其他样式不会影响z-index的渲染顺序。 | -| image-fill6+ | <color> | - | 为svg图片填充颜色，支持组件范围（与设置图片资源的属性）：button（icon属性）、piece（icon属性）、search（icon属性）、input（headericon属性）、textarea（headericon属性）、image（src属性）、toolbar-item(icon属性)。
    svg图片文件内的fill属性颜色值在渲染时将被替换为image-fill所配的颜色值，且仅对svg图片内显示声明的fill属性生效。 | -| clip-path6+ | [ <geometry-box> \|\| <basic-shape> ] \| none | - | 设置组件的裁剪区域。区域内的部分显示，区域外的不显示。
    <geometry-box>：表示裁剪区域的作用范围，默认为border-box。可选值为：
    - margin-box：margin计算入长宽尺寸内。
    - border-box：border计算入长宽尺寸内。
    - padding-box：padding计算入长宽尺寸内。
    - content-box：margin/border/padding不计算入长宽尺寸内。
    <basic-shape>：表示裁剪的形状。包含以下类型：
    - inset，格式为：inset( <percentage>{1,4} [ round <'border-radius'> ]? )。
    - circle，格式为：circle( [ <percentage> ]? [ at <percentage> <percentage> ]? )。
    - ellipse，格式为：ellipse( [ <percentage>{2} ]? [ at <percentage> <percentage> ]? )。
    - polygon，格式为：polygon( [ <percentage> <percentage> ]\# )
    - path，格式为：path( <string> )。 | -| mask-image6+ | - <linear-gradient>
    - string | - | 设置渐变色遮罩或本地图片设置。
    设置渐变色遮罩，示例：
    linear-gradient(to left, black, white)
    设置纯色遮罩，示例：
    linear-gradient(to right, grey , grey)
    设置本地svg图片为遮罩，示例：url(common/mask.svg) | -| mask-size6+ | - string
    - <length><length>
    - <percentage> <percentage> | auto | 设置遮罩图片显示大小，仅当mask-image为图片资源时有效。
    string可选值：
    - contain：把图像扩展至最大尺寸，以使其高度和宽度完全适用内容区域。
    - cover：把图像扩展至足够大，以使背景图像完全覆盖背景区域；背景图像的某些部分也许无法显示在背景定位区域中。
    - auto：保持原图的比例不变。
    length值参数方式：设置图像的高度和宽度。第一个值设置宽度，第二个值设置高度。如果只设置一个值，则第二个值会被设置为 "auto"。
    百分比参数方式：以原图宽高的百分比来设置图像的宽度和高度。第一个值设置宽度，第二个值设置高度。如果只设置一个值，则第二个值会被设置为 "auto"。 | -| mask-position6+ | - string string
    - <length> <length>
    - <percentage> <percentage> | 0px 0px | 设置遮罩图片显示位置，仅当mask-image为图片资源时有效。关键词方式：如果仅规定了一个关键词，那么第二个值为"center"。两个值分别定义水平方向位置和竖直方向位置。
    string可选值：
    - left：水平方向上最左侧。
    - right：水平方向上最右侧。
    - top：竖直方向上最顶部。
    - bottom：竖直方向上最底部。
    - center：水平方向或竖直方向上中间位置。
    length值参数方式：第一个值是水平位置，第二个值是垂直位置。 左上角是 0 0。单位是像素 (0px 0px)  。如果仅规定了一个值，另外一个值将是50%。
    百分比参数方式：第一个值是水平位置，第二个值是垂直位置。左上角是 0% 0%。右下角是 100% 100%。如果仅规定了一个值，另外一个值为50%。
    可以混合使用<percentage>和<length>。 | -| border-image-source7+ | string | - | 指定元素的边框图片。
    示例：
    border-image-source: url("/common/images/border.png") | -| border-image-slice7+ | <length> \| <percentage> | 0 | 指定图片的边界内向偏移。
    该属性可以有1到4个值：
    指定一个值时，该值指定四个边的内偏移。
    指定两个值时，第一个值指定上下两边的内偏移，第二个指定左右两边的内偏移。
    指定三个值时，第一个指定上边的内偏移，第二个指定左右两边的内偏移，第三个指定下边的内偏移。
    指定四个值时分别为上、右、下、左边的内偏移（顺时针顺序）。 | -| border-image-width7+ | <length> \| <percentage> | 0 | 指定图片边界的宽度。
    指定一个值时，该值指定四个边的宽度。
    指定两个值时，第一个值指定上下两边的宽度 ，第二个指定左右两边的宽度。
    指定三个值时，第一个指定上边的宽度 ，第二个指定左右两边的宽度 ，第三个指定下边的宽度。
    指定四个值时分别为上、右、下、左边的宽度 （顺时针顺序）。 | -| border-image-outset7+ | <length> \| <percentage> | 0 | 指定边框图像可超出边框的大小。
    指定一个值时，边框图像在四个方向超出边框的距离。
    指定两个值时，第一个值指定上下两边的边框图像超出边框的距离，第二个指定左右两边的 。
    指定三个值时，第一个指定上边的边框图像超出边框的距离 ，第二个指定左右两边的边框图像超出边框的距离 ，第三个指定下边的边框图像超出边框的距离 。
    指定四个值时分别为上、右、下、左边的边框图像超出边框的距离 （顺时针顺序）。 | -| border-image-repeat7+ | string | stretch | 定义图片如何填充边框。
    stretch: 拉伸图片以填充边框。
    repeat：平铺图片以填充边框。
    round：平铺图像。当不能整数次平铺时，根据情况放大或缩小图像。
    | -| border-image7+ | string | - | 简写属性，可以选择以下两种设置方式：
    - 设置图片边框的每个属性。包含图像的边界向内偏移，图像边界的宽度，边框图像可超出边框盒的大小，图片如何填充边框，顺序设置为 border-image-source ,border-image-slice,border-image-width,border-image-outset,border-image-repeat，不设置的值为默认值。
    - 渐变色边框
      示例:
      border-image: linear-gradient(red, yellow) 10px | +| 名称 | 类型 | 默认值 | 描述 | +| ---------------------------------------- | ---------------------------------------- | ------------ | ---------------------------------------- | +| width | <length> \| <percentage> | - | 设置组件自身的宽度。
    缺省时使用元素自身内容需要的宽度。
    | +| height | <length> \| <percentage> | - | 设置组件自身的高度。
    缺省时使用元素自身内容需要的高度。
    | +| min-width5+ | <length> \| <percentage>6+ | 0 | 设置元素的最小宽度。 | +| min-height5+ | <length> \| <percentage>6+ | 0 | 设置元素的最小高度。 | +| max-width5+ | <length> \| <percentage>6+ | - | 设置元素的最大宽度。默认无限制。 | +| max-height5+ | <length> \| <percentage>6+ | - | 设置元素的最大高度。默认无限制。 | +| padding | <length> \| <percentage>5+ | 0 | 使用简写属性设置所有的内边距属性。
    该属性可以有1到4个值：
    - 指定一个值时，该值指定四个边的内边距。
    - 指定两个值时，第一个值指定上下两边的内边距，第二个指定左右两边的内边距。
    - 指定三个值时，第一个指定上边的内边距，第二个指定左右两边的内边距，第三个指定下边的内边距。
    - 指定四个值时分别为上、右、下、左边的内边距（顺时针顺序）。 | +| padding-[left\|top\|right\|bottom] | <length> \| <percentage>5+ | 0 | 设置左、上、右、下内边距属性。 | +| padding-[start\|end] | <length> \| <percentage>5+ | 0 | 设置起始和末端内边距属性。 | +| margin | <length> \| <percentage>5+ | 0 | 使用简写属性设置所有的外边距属性，该属性可以有1到4个值。
    - 只有一个值时，这个值会被指定给全部的四个边。
    - 两个值时，第一个值被匹配给上和下，第二个值被匹配给左和右。
    - 三个值时，第一个值被匹配给上, 第二个值被匹配给左和右，第三个值被匹配给下。
    - 四个值时，会依次按上、右、下、左的顺序匹配 (即顺时针顺序)。 | +| margin-[left\|top\|right\|bottom] | <length> \| <percentage>5+ | 0 | 设置左、上、右、下外边距属性。 | +| margin-[start\|end] | <length> \| <percentage>5+ | 0 | 设置起始和末端外边距属性。 | +| border | - | 0 | 使用简写属性设置所有的边框属性，包含边框的宽度，样式，颜色属性，顺序设置为border-width、border-style、border-color，不设置时，各属性值为默认值。 | +| border-style | string | solid | 使用简写属性设置所有边框的样式，可选值为：
    - dotted：显示为一系列圆点，圆点半径为border-width的一半。
    - dashed：显示为一系列短的方形虚线。
    - solid：显示为一条实线。 | +| border-[left\|top\|right\|bottom]-style | string | solid | 分别设置左、上、右、下四个边框的样式，可选值为dotted、dashed、solid。 | +| border-[left\|top\|right\|bottom] | - | - | 使用简写属性设置对应位置的边框属性，包含边框的宽度，样式，颜色属性，顺序设置为border-width、border-style、border-color，不设置的值为默认值。 | +| border-width | <length> | 0 | 使用简写属性设置元素的所有边框宽度，或者单独为各边边框设置宽度。 | +| border-[left\|top\|right\|bottom]-width | <length> | 0 | 分别设置左、上、右、下四个边框的宽度。 | +| border-color | <color> | black | 使用简写属性设置元素的所有边框颜色，或者单独为各边边框设置颜色。 | +| border-[left\|top\|right\|bottom]-color | <color> | black | 分别设置左、上、右、下四个边框的颜色。 | +| border-radius | <length> | - | border-radius属性设置元素的外边框圆角半径。设置border-radius时不能单独设置某一个方向的border-[left\|top\|right\|bottom]-width，border-[left\|top\|right\|bottom]-color ，border-[left\|top\|right\|bottom]-style，如果要设置color、width和style，需要将四个方向一起设置（border-width、border-color、border-style）。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > 顺序为左下、右下、左上和右上。 | +| border-[top\|bottom]-[left\|right]-radius | <length> | - | 分别设置左上，右上，右下和左下四个角的圆角半径。 | +| background | <linear-gradient> | - | 仅支持设置[渐变样式](../arkui-js/js-components-common-gradient.md)，与background-color、background-image不兼容。 | +| background-color | <color> | - | 设置背景颜色。 | +| background-image | string | - | 设置背景图片。与background-color、background不兼容，支持网络图片资源和本地图片资源地址。
    示例：
    - background-image: url("/common/background.png")
      > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
      > 不支持svg格式图片。 | +| background-size | - string
    - <length> <length>
    - <percentage> <percentage> | auto | 设置背景图片的大小。
    - string可选值：
      - contain：把图片扩展至最大尺寸，以使其高度和宽度完全适用内容区域。
      - cover：把背景图片扩展至足够大，以使背景图片完全覆盖背景区域；背景图片的某些部分也许无法显示在背景定位区域中。
      - auto：保持原图的比例不变。
    - length值参数方式：
      设置背景图片的高度和宽度。第一个值设置宽度，第二个值设置高度。如果只设置一个值，则第二个值会被设置为 "auto"。
    - 百分比参数方式：
      以父元素的百分比来设置背景图片的宽度和高度。第一个值设置宽度，第二个值设置高度。如果只设置一个值，则第二个值会被设置为 "auto"。 | +| background-repeat | string | repeat | 针对重复背景图片样式进行设置，背景图片默认在水平和垂直方向上重复。
    - repeat：在水平轴和竖直轴上同时重复绘制图片。
    - repeat-x：只在水平轴上重复绘制图片。
    - repeat-y：只在竖直轴上重复绘制图片。
    - no-repeat：不会重复绘制图片。 | +| background-position | - string string
    - <length> <length>
    - <percentage> <percentage> | 0px 0px | - 关键词方式：如果仅规定了一个关键词，那么第二个值为"center"。两个值分别定义水平方向位置和竖直方向位置。
      - left：水平方向上最左侧。
      - right：水平方向上最右侧。
      - top：竖直方向上最顶部。
      - bottom：竖直方向上最底部。
      - center：水平方向或竖直方向上中间位置。
    - length值参数方式：第一个值是水平位置，第二个值是垂直位置。 左上角是 0 0。单位是像素 (0px 0px)  。如果仅规定了一个值，另外一个值将是50%。
    - 百分比参数方式：第一个值是水平位置，第二个值是垂直位置。左上角是 0% 0%。右下角是 100% 100%。如果仅规定了一个值，另外一个值为50%。
    - 可以混合使用<percentage>和<length>。 | +| box-shadow5+ | string | 0 | 语法：box-shadow: h-shadow v-shadow blur spread color
    通过这个样式可以设置当前组件的阴影样式，包括水平位置(必填)、垂直位置(必填)、模糊半径(可选，默认值为0)、阴影延展距离(可选，默认值为0)、阴影颜色(可选，默认值为黑色)。
    示例：
    - box-shadow :10px 20px 5px 10px \#888888
    - box-shadow :100px 100px 30px red
    - box-shadow :-100px -100px 0px 40px | +| filter5+ | string | - | 语法：filter: blur(px)
    通过这个样式可以设置当前组件布局范围的内容模糊，参数用于指定模糊半径，如果没有设置值，则默认是0(不模糊)，不支持百分比。
    示例：
    - filter: blur(10px) | +| backdrop-filter5+ | string | - | 语法：backdrop-filter: blur(px)
    通过这个样式可以设置当前组件布局范围的背景模糊，参数用于指定模糊半径，如果没有设置值，则默认是0(不模糊)，不支持百分比。
    示例：
    - backdrop-filter: blur(10px) | +| window-filter5+ | string | - | 语法：window-filter: blur(percent), style5+
    通过这个样式可以设置当前组件布局范围的窗口模糊程度和模糊样式，如果没有设置值，则默认是0%(不模糊)，多块模糊区域时不支持设置不同的模糊值和模糊样式。style可选值：small_light(默认值), medium_light, large_light, xlarge_light, small_dark, medium_dark, large_dark, xlarge_dark。
    示例：
    - window-filter: blur(50%)
    - window-filter: blur(10%), large_light | +| opacity | number | 1 | 元素的透明度，取值范围为0到1，1表示为不透明，0表示为完全透明。 | +| display | string | flex | 确定一个元素所产生的框的类型，可选值为：
    - flex：弹性布局。
    - none：不渲染此元素。 | +| visibility | string | visible | 是否显示元素所产生的框。不可见的框会占用布局（将'display'属性设置为'none'来完全去除框），可选值为：
    - visible：元素正常显示。
    - hidden：隐藏元素，但是其他元素的布局不改变，相当于此元素变成透明。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > visibility和display样式都设置时，仅display生效。 | +| flex | number \| string | - | 规定当前组件如何适应父组件中的可用空间。
    flex可以指定1个、2个5+或3个5+值。
    单值语法：
    - 一个无单位数：用来设置组件的flex-grow。
    - 一个有效的宽度值5+：用来设置组件的flex-basis。
    双值语法5+：
    第一个值必须是无单位数，用来设置组件的flex-grow。第二个值是以下之一：
    - 一个无单位数：用来设置组件的flex-shrink。
    - 一个有效的宽度值：用来设置组件的flex-basis。
    三值语法5+：
    第一个值必须是无单位数，用来设置组件的flex-grow；第二个值必须是无单位数，用来设置组件的flex-shrink；第三个值必须是一个有效的宽度值，用来设置组件的flex-basis。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > 仅父容器为<div>、<list-item>、<tabs>、<refresh>、<stepper-item>5+时生效。 | +| flex-grow | number | 0 | 设置组件的拉伸样式，指定父组件容器主轴方向上剩余空间（容器本身大小减去所有flex子元素占用的大小）的分配权重。0为不伸展。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > 仅父容器为<div>、<list-item>、<tabs>、<refresh>、<stepper-item>5+时生效。 | +| flex-shrink | number | 1 | 设置组件的收缩样式，元素仅在默认宽度之和大于容器的时候才会发生收缩，0为不收缩。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > 仅父容器为<div>、<list-item>、<tabs>、<refresh>、<stepper-item>5+时生效。 | +| flex-basis | <length> | - | 设置组件在主轴方向上的初始大小。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > 仅父容器为<div>、<list-item>、<tabs>、<refresh>、<stepper-item>5+时生效。 | +| align-self6+ | string | - | 设置自身在父元素交叉轴上的对齐方式，该样式会覆盖父元素的align-items样式，仅在父容器为div、list。可选值为：
    - stretch 弹性元素被在交叉轴方向被拉伸到与容器相同的高度或宽度。
    - flex-start 元素向交叉轴起点对齐。
    - flex-end 元素向交叉轴终点对齐。
    - center 元素在交叉轴居中。
    - baseline 元素在交叉轴基线对齐。 | +| position | string | relative | 设置元素的定位类型，不支持动态变更。
    - fixed：相对与整个界面进行定位。
    - absolute：相对于父元素进行定位。
    - relative：相对于其正常位置进行定位。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > absolute属性仅在父容器为<div>、<stack>时生效。 | +| [left\|top\|right\|bottom] | <length> \| <percentage>6+ | - | left\|top\|right\|bottom需要配合position样式使用，来确定元素的偏移位置。
    - left属性规定元素的左边缘。该属性定义了定位元素左外边距边界与其包含块左边界之间的偏移。
    - top属性规定元素的顶部边缘。该属性定义了一个定位元素的上外边距边界与其包含块上边界之间的偏移。
    - right属性规定元素的右边缘。该属性定义了定位元素右外边距边界与其包含块右边界之间的偏移。
    - bottom属性规定元素的底部边缘。该属性定义了一个定位元素的下外边距边界与其包含块下边界之间的偏移。 | +| [start \| end]6+ | <length> \| <percentage> | - | start \| end需要配合position样式使用，来确定元素的偏移位置。
    - start属性规定元素的起始边缘。该属性定义了定位元素起始外边距边界与其包含块起始边界之间的偏移。
    - end属性规定元素的结尾边缘。该属性定义了一个定位元素的结尾边距边界与其包含块结尾边界之间的偏移。 | +| z-index6+ | number | - | 表示对于同一父节点其子节点的渲染顺序。数值越大，渲染数据越靠后。
    > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
    > z-index不支持auto，并且opacity等其他样式不会影响z-index的渲染顺序。 | +| image-fill6+ | <color> | - | 为svg图片填充颜色，支持组件范围（与设置图片资源的属性）：button（icon属性）、piece（icon属性）、search（icon属性）、input（headericon属性）、textarea（headericon属性）、image（src属性）、toolbar-item(icon属性)。
    svg图片文件内的fill属性颜色值在渲染时将被替换为image-fill所配的颜色值，且仅对svg图片内显示声明的fill属性生效。 | +| clip-path6+ | [ <geometry-box> \|\| <basic-shape> ] \| none | - | 设置组件的裁剪区域。区域内的部分显示，区域外的不显示。
    <geometry-box>：表示裁剪区域的作用范围，默认为border-box。可选值为：
    - margin-box：margin计算入长宽尺寸内。
    - border-box：border计算入长宽尺寸内。
    - padding-box：padding计算入长宽尺寸内。
    - content-box：margin/border/padding不计算入长宽尺寸内。
    <basic-shape>：表示裁剪的形状。包含以下类型：
    - inset，格式为：inset( <percentage>{1,4} [ round <'border-radius'> ]? )。
    - circle，格式为：circle( [ <percentage> ]? [ at <percentage> <percentage> ]? )。
    - ellipse，格式为：ellipse( [ <percentage>{2} ]? [ at <percentage> <percentage> ]? )。
    - polygon，格式为：polygon( [ <percentage> <percentage> ]\# )
    - path，格式为：path( <string> )。 | +| mask-image6+ | - <linear-gradient>
    - string | - | 设置渐变色遮罩或本地图片设置。
    设置渐变色遮罩，示例：
    linear-gradient(to left, black, white)
    设置纯色遮罩，示例：
    linear-gradient(to right, grey , grey)
    设置本地svg图片为遮罩，示例：url(common/mask.svg) | +| mask-size6+ | - string
    - <length><length>
    - <percentage> <percentage> | auto | 设置遮罩图片显示大小，仅当mask-image为图片资源时有效。
    string可选值：
    - contain：把图像扩展至最大尺寸，以使其高度和宽度完全适用内容区域。
    - cover：把图像扩展至足够大，以使背景图像完全覆盖背景区域；背景图像的某些部分也许无法显示在背景定位区域中。
    - auto：保持原图的比例不变。
    length值参数方式：设置图像的高度和宽度。第一个值设置宽度，第二个值设置高度。如果只设置一个值，则第二个值会被设置为 "auto"。
    百分比参数方式：以原图宽高的百分比来设置图像的宽度和高度。第一个值设置宽度，第二个值设置高度。如果只设置一个值，则第二个值会被设置为 "auto"。 | +| mask-position6+ | - string string
    - <length> <length>
    - <percentage> <percentage> | 0px 0px | 设置遮罩图片显示位置，仅当mask-image为图片资源时有效。关键词方式：如果仅规定了一个关键词，那么第二个值为"center"。两个值分别定义水平方向位置和竖直方向位置。
    string可选值：
    - left：水平方向上最左侧。
    - right：水平方向上最右侧。
    - top：竖直方向上最顶部。
    - bottom：竖直方向上最底部。
    - center：水平方向或竖直方向上中间位置。
    length值参数方式：第一个值是水平位置，第二个值是垂直位置。 左上角是 0 0。单位是像素 (0px 0px)  。如果仅规定了一个值，另外一个值将是50%。
    百分比参数方式：第一个值是水平位置，第二个值是垂直位置。左上角是 0% 0%。右下角是 100% 100%。如果仅规定了一个值，另外一个值为50%。
    可以混合使用<percentage>和<length>。 | +| border-image-source7+ | string | - | 指定元素的边框图片。
    示例：
    border-image-source: url("/common/images/border.png") | +| border-image-slice7+ | <length> \| <percentage> | 0 | 指定图片的边界内向偏移。
    该属性可以有1到4个值：
    指定一个值时，该值指定四个边的内偏移。
    指定两个值时，第一个值指定上下两边的内偏移，第二个指定左右两边的内偏移。
    指定三个值时，第一个指定上边的内偏移，第二个指定左右两边的内偏移，第三个指定下边的内偏移。
    指定四个值时分别为上、右、下、左边的内偏移（顺时针顺序）。 | +| border-image-width7+ | <length> \| <percentage> | 0 | 指定图片边界的宽度。
    指定一个值时，该值指定四个边的宽度。
    指定两个值时，第一个值指定上下两边的宽度 ，第二个指定左右两边的宽度。
    指定三个值时，第一个指定上边的宽度 ，第二个指定左右两边的宽度 ，第三个指定下边的宽度。
    指定四个值时分别为上、右、下、左边的宽度 （顺时针顺序）。 | +| border-image-outset7+ | <length> \| <percentage> | 0 | 指定边框图像可超出边框的大小。
    指定一个值时，边框图像在四个方向超出边框的距离。
    指定两个值时，第一个值指定上下两边的边框图像超出边框的距离，第二个指定左右两边的 。
    指定三个值时，第一个指定上边的边框图像超出边框的距离 ，第二个指定左右两边的边框图像超出边框的距离 ，第三个指定下边的边框图像超出边框的距离 。
    指定四个值时分别为上、右、下、左边的边框图像超出边框的距离 （顺时针顺序）。 | +| border-image-repeat7+ | string | stretch | 定义图片如何填充边框。
    stretch: 拉伸图片以填充边框。
    repeat：平铺图片以填充边框。
    round：平铺图像。当不能整数次平铺时，根据情况放大或缩小图像。
    | +| border-image7+ | string | - | 简写属性，可以选择以下两种设置方式：
    - 设置图片边框的每个属性。包含图像的边界向内偏移，图像边界的宽度，边框图像可超出边框盒的大小，图片如何填充边框，顺序设置为 border-image-source ,border-image-slice,border-image-width,border-image-outset,border-image-repeat，不设置的值为默认值。
    - 渐变色边框
      示例:
      border-image: linear-gradient(red, yellow) 10px | > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-container-list-item-group.md b/zh-cn/application-dev/reference/arkui-js/js-components-container-list-item-group.md index 89b93114ef1b03e466d2b2bb42cbd6f8e90d159a..d11f2880032400ea6ee0152a2902820d519ab181 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-container-list-item-group.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-container-list-item-group.md @@ -24,9 +24,9 @@ 除支持[通用属性](../arkui-js/js-components-common-attributes.md)外，还支持如下属性： -| 名称 | 类型 | 默认值 | 必填 | 描述 | -| -------- | -------- | -------- | -------- | -------- | -| type | string | default | 否 | list-item-group类型，同一list支持多种type的list-item-group，相同type的list-item-group需要确保渲染后的视图布局也完全相同，当type固定时，使用show属性代替if属性，确保视图布局不变。 | +| 名称 | 类型 | 默认值 | 必填 | 描述 | +| ---- | ------ | ------- | ---- | ---------------------------------------- | +| type | string | default | 否 | list-item-group类型，同一list支持多种type的list-item-group，相同type的list-item-group需要确保渲染后的视图布局也完全相同，当type固定时，使用show属性代替if属性，确保视图布局不变。 | > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > @@ -37,21 +37,21 @@ 除支持[通用样式](../arkui-js/js-components-common-styles.md)外，还支持如下样式： -| 名称 | 类型 | 默认值 | 必填 | 描述 | -| -------- | -------- | -------- | -------- | -------- | -| flex-direction | string | row | 否 | flex容器主轴方向。可选项有：
    - column：垂直方向从上到下
    - row：水平方向从左到右 | -| justify-content | string | flex-start | 否 | flex容器当前行的主轴对齐格式。可选项有：
    - flex-start：项目位于容器的开头。
    - flex-end：项目位于容器的结尾。
    - center：项目位于容器的中心。
    - space-between：项目位于各行之间留有空白的容器内。
    - space-around：项目位于各行之前、之间、之后都留有空白的容器内。
    - space-evenly5+:  均匀排列每个元素，每个元素之间的间隔相等。 | +| 名称 | 类型 | 默认值 | 必填 | 描述 | +| --------------- | ------ | ---------- | ---- | ---------------------------------------- | +| flex-direction | string | row | 否 | flex容器主轴方向。可选项有：
    - column：垂直方向从上到下
    - row：水平方向从左到右 | +| justify-content | string | flex-start | 否 | flex容器当前行的主轴对齐格式。可选项有：
    - flex-start：项目位于容器的开头。
    - flex-end：项目位于容器的结尾。
    - center：项目位于容器的中心。
    - space-between：项目位于各行之间留有空白的容器内。
    - space-around：项目位于各行之前、之间、之后都留有空白的容器内。
    - space-evenly5+:  均匀排列每个元素，每个元素之间的间隔相等。 | ## 事件 除支持[通用事件](../arkui-js/js-components-common-events.md)外，还支持如下事件： -| 名称 | 参数 | 描述 | -| -------- | -------- | -------- | -| groupclick | { groupid: string } | group点击事件。
    groupid：被点击的group的id。 | +| 名称 | 参数 | 描述 | +| ------------- | ---------------------------------- | ---------------------------------------- | +| groupclick | { groupid: string } | group点击事件。
    groupid：被点击的group的id。 | | groupcollapse | { groupid: string } | group收拢事件。
    groupid：收拢的group的id。
    当不输入参数或者groupid为空时收拢所有分组。 | -| groupexpand | { groupid: string } | group展开事件。
    groupid：展开的group的id。
    当不输入参数或者groupid为空时展开所有分组。 | +| groupexpand | { groupid: string } | group展开事件。
    groupid：展开的group的id。
    当不输入参数或者groupid为空时展开所有分组。 | ## 方法 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-web.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-web.md index c3fd580ab57fb2533f456cdf8699007eefbfc0a1..6bead6a2b88830a32d1d38d0c46b40efecd50f57 100755 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-web.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-web.md @@ -18,10 +18,10 @@ 表1 options参数说明 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | ---------- | ------------------------------- | ---- | ------ | -------------- | - | src | string | 是 | - | 网页资源地址。 | - | controller | [WebController](#webcontroller) | 否 | - | 控制器。 | + | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | + | ---------- | ------------------------------- | ---- | ---- | ------- | + | src | string | 是 | - | 网页资源地址。 | + | controller | [WebController](#webcontroller) | 否 | - | 控制器。 | > ![icon-note.gif](public_sys-resources/icon-note.gif)**说明：** @@ -31,34 +31,34 @@ > - 仅支持本地音视频播放。 ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| ----------------- | ------------------------------------------------------------ | -------------- | ------------------------------------------------------------ | -| domStorageAccess | boolean | false | 设置是否开启文档对象模型存储接口（DOM Storage API）权限，默认未开启。 | -| fileAccess | boolean | true | 设置是否开启通过[$rawfile(filepath/filename)](../../ui/ts-application-resource-access.md#资源引用)访问应用中rawfile路径的文件， 默认启用。 | -| imageAccess | boolean | true | 设置是否允许自动加载图片资源，默认允许。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ----------------- | ---------------------------------------- | -------------- | ---------------------------------------- | +| domStorageAccess | boolean | false | 设置是否开启文档对象模型存储接口（DOM Storage API）权限，默认未开启。 | +| fileAccess | boolean | true | 设置是否开启通过[$rawfile(filepath/filename)](../../ui/ts-application-resource-access.md#资源引用)访问应用中rawfile路径的文件， 默认启用。 | +| imageAccess | boolean | true | 设置是否允许自动加载图片资源，默认允许。 | | javaScriptProxy | {
    object: object,
    name: string,
    methodList: Array\,
    controller: WebController
    } | - | 注入JavaScript对象到window对象中，并在window对象中调用该对象的方法。所有参数不支持更新。
    object: 参与注册的对象。只能声明方法，不能声明属性 。其中方法的参数和返回类型只能为string，number，boolean。
    name: 注册对象的名称，与window中调用的对象名一致。注册后window对象可以通过此名字访问应用侧JavaScript对象。
    methodList: 参与注册的应用侧JavaScript对象的方法。
    controller: 控制器。 | -| javaScriptAccess | boolean | true | 设置是否允许执行JavaScript脚本，默认允许执行。 | -| mixedMode | MixedMode | MixedMode.None | 设置是否允许加载超文本传输协议（HTTP）和超文本传输安全协议（HTTPS）混合内容，默认不允许加载HTTP和HTTPS混合内容。 | -| onlineImageAccess | boolean | true | 设置是否允许从网络加载图片资源（通过HTTP和HTTPS访问的资源），默认允许访问。 | -| zoomAccess | boolean | true | 设置是否支持手势进行缩放，默认允许执行缩放。 | +| javaScriptAccess | boolean | true | 设置是否允许执行JavaScript脚本，默认允许执行。 | +| mixedMode | MixedMode | MixedMode.None | 设置是否允许加载超文本传输协议（HTTP）和超文本传输安全协议（HTTPS）混合内容，默认不允许加载HTTP和HTTPS混合内容。 | +| onlineImageAccess | boolean | true | 设置是否允许从网络加载图片资源（通过HTTP和HTTPS访问的资源），默认允许访问。 | +| zoomAccess | boolean | true | 设置是否支持手势进行缩放，默认允许执行缩放。 | > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > > 通用属性仅支持[width](ts-universal-attributes-size.md#属性)、[height](ts-universal-attributes-size.md#属性)、[padding](ts-universal-attributes-size.md#属性)、[margin](ts-universal-attributes-size.md#属性)、[border](ts-universal-attributes-border.md#属性)。 - MixedMode枚举说明 - | 名称 | 描述 | - | ---------- | ----------------------------------------------------------- | + | 名称 | 描述 | + | ---------- | ---------------------------------- | | All | 允许加载HTTP和HTTPS混合内容。所有不安全的内容都可以被加载。 | - | Compatible | 混合内容兼容性模式，部分不安全的内容可能被加载。 | - | None | 不允许加载HTTP和HTTPS混合内容。 | + | Compatible | 混合内容兼容性模式，部分不安全的内容可能被加载。 | + | None | 不允许加载HTTP和HTTPS混合内容。 | ## 事件 不支持通用事件。 -| 名称 | 功能描述 | -| ------------------------------------------------------------ | ------------------------------------------------------------ | +| 名称 | 功能描述 | +| ---------------------------------------- | ---------------------------------------- | | onAlert(callback: (event?: { url: string; message: string; result: [JsResult](#jsresult对象说明) }) => boolean) |

    网页触发alert()告警弹窗时触发回调。
    当回调返回false时，触发默认弹窗。当回调返回true时，系统应用可以调用系统弹窗能力（只有确认场景），并且根据用户的确认操作调用JsResult通知Web组件。
    url：当前显示弹窗所在网页的URL。
    message：弹窗中显示的信息。
    JsResult：通知Web组件用户操作行为。

    | | onBeforeUnload(callback: (event?: { url: string; message: string; result: [JsResult](#jsresult对象说明) }) => boolean) |

    刷新或关闭场景下，在即将离开当前页面时触发此回调。
    当回调返回false时，触发默认弹窗。当回调返回true时，系统应用可以调用系统弹窗能力（包括确认和取消），并且需要根据用户的确认或取消操作调用JsResult通知Web组件最终是否离开当前页面。
    url：当前显示弹窗所在网页的URL。
    message：弹窗中显示的信息。
    JsResult：通知Web组件用户操作行为。

    | | onConfirm(callback: (event?: { url: string; message: string; result: [JsResult](#jsresult对象说明) }) => boolean) |

    网页调用confirm()告警时触发此回调。
    当回调返回false时，触发默认弹窗。当回调返回true时，系统应用可以调用系统弹窗能力（包括确认和取消），并且需要根据用户的确认或取消操作调用JsResult通知Web组件。
    url：当前显示弹窗所在网页的URL。
    message：弹窗中显示的信息。
    JsResult：通知Web组件用户操作行为。

    | @@ -66,8 +66,8 @@ | onDownloadStart(callback: (event?: { url: string, userAgent: string, contentDisposition: string, mimetype: string, contentLength: number }) => void) |

    网页的下载任务开始时触发该回调。
    url：文件下载的URL。
    userAgent：下载的用户代理（UA）名称。
    contentDisposition：服务器返回的 Content-Disposition响应头，可能为空。
    mimetype：服务器返回内容媒体类型（MIME）信息。
    contentLength：服务器返回文件的长度。

    | | onErrorReceive(callback: (event?: { request: [WebResourceRequest](#webresourceerror对象说明), error: [WebResourceError](#webresourceerror对象说明) }) => void) |

    网页加载遇到错误时触发该回调。
    出于性能考虑，建议此回调中尽量执行简单逻辑。
    request：网页请求的封装信息。
    error：网页加载资源错误的封装信息 。

    | | onHttpErrorReceive(callback: (event?: { request: [WebResourceRequest](#webresourceerror对象说明), response: [WebResourceResponse](#webresourceresponse对象说明) }) => void) |

    网页加载资源遇到的HTTP错误（响应码>=400)时触发该回调。
    request：网页请求的封装信息。
    response：网页响应的封装信息

    | -| onPageBegin(callback: (event?: { url: string }) => void) |

    网页开始加载时触发该回调，且只在主frame触发，iframe或者frameset的内容加载时不会触发此回调。
    url：页面的URL地址。

    | -| onPageEnd(callback: (event?: { url: string }) => void) |

    网页加载完成时触发该回调，且只在主frame触发。
    url：页面的URL地址。

    | +| onPageBegin(callback: (event?: { url: string }) => void) |

    网页开始加载时触发该回调，且只在主frame触发，iframe或者frameset的内容加载时不会触发此回调。
    url：页面的URL地址。

    | +| onPageEnd(callback: (event?: { url: string }) => void) |

    网页加载完成时触发该回调，且只在主frame触发。
    url：页面的URL地址。

    | | onProgressChange(callback: (event?: { newProgress: number }) => void) |

    网页加载进度变化时触发该回调。
    newProgress：新的加载进度，取值范围为0到100的整数。

    | | onTitleReceive(callback: (event?: { title: string }) => void) |

    网页document标题更改时触发该回调。
    title：document标题内容。

    | @@ -75,12 +75,12 @@ - 接口 - | 接口名称 | 功能描述 | - | ------------------------------- | ------------------------------ | - | getLineNumber(): number | 获取ConsoleMessage的行数。 | + | 接口名称 | 功能描述 | + | ------------------------------- | ---------------------- | + | getLineNumber(): number | 获取ConsoleMessage的行数。 | | getMessage(): string | 获取ConsoleMessage的日志信息。 | | getMessageLevel(): MessageLevel | 获取ConsoleMessage的信息级别。 | - | getSourceId(): string | 获取网页源文件路径和名字。 | + | getSourceId(): string | 获取网页源文件路径和名字。 | - MessageLevel枚举说明 @@ -98,8 +98,8 @@ Web组件返回的弹窗确认或弹窗取消功能对象。 - 接口 - | 接口名称 | 功能描述 | - | --------------------- | ------------------------------------ | + | 接口名称 | 功能描述 | + | --------------------- | ----------------------- | | handleCancel(): void |

    通知Web组件用户取消弹窗操作。

    | | handleConfirm(): void |

    通知Web组件用户确认弹窗操作。

    | @@ -116,13 +116,13 @@ Web组件返回的弹窗确认或弹窗取消功能对象。 - 接口 - | 接口名称 | 功能描述 | - | ------------------------------------------------------ | ---------------------------------------- | - | getRequestHeader(): Array\<[Header](#header对象说明)\> | 获取资源请求头信息。 | - | getRequestUrl(): string | 获取资源请求的URL信息。 | - | isMainFrame(): boolean | 判断资源请求是否为主frame。 | - | isRedirect(): boolean | 判断资源请求是否被服务端重定向。 | - | isRequestGesture(): boolean | 获取资源请求是否与手势（如点击）相关联。 | + | 接口名称 | 功能描述 | + | ---------------------------------------- | -------------------- | + | getRequestHeader(): Array\<[Header](#header对象说明)\> | 获取资源请求头信息。 | + | getRequestUrl(): string | 获取资源请求的URL信息。 | + | isMainFrame(): boolean | 判断资源请求是否为主frame。 | + | isRedirect(): boolean | 判断资源请求是否被服务端重定向。 | + | isRequestGesture(): boolean | 获取资源请求是否与手势（如点击）相关联。 | ### Header对象说明 @@ -130,24 +130,24 @@ Web组件返回的请求/响应头对象。 - 参数 - | 参数名称 | 参数类型 |参数描述 | - | ----------- | ----------- |---------------------- | - | headerKey | string |请求/响应头的key。 | - | headerValue | string |请求/响应头的value。| + | 参数名称 | 参数类型 | 参数描述 | + | ----------- | ------ | ------------- | + | headerKey | string | 请求/响应头的key。 | + | headerValue | string | 请求/响应头的value。 | ### WebResourceResponse对象说明 - 接口 - | 接口名称 | 功能描述 | - | ------------------------------------ | -------------------------------- | - | getReasonMessage(): string | 获取资源响应的状态码描述。 | - | getResponseCode(): number | 获取资源响应的状态码。 | - | getResponseData(): string | 获取资源响应数据。 | - | getResponseEncoding(): string | 获取资源响应的编码。 | - | getResponseHeader(): Array\<[Header](#header对象说明)\> | 获取资源响应头。 | - | getResponseMimeType(): string | 获取资源响应的媒体（MIME）类型。 | + | 接口名称 | 功能描述 | + | ---------------------------------------- | ------------------ | + | getReasonMessage(): string | 获取资源响应的状态码描述。 | + | getResponseCode(): number | 获取资源响应的状态码。 | + | getResponseData(): string | 获取资源响应数据。 | + | getResponseEncoding(): string | 获取资源响应的编码。 | + | getResponseHeader(): Array\<[Header](#header对象说明)\> | 获取资源响应头。 | + | getResponseMimeType(): string | 获取资源响应的媒体（MIME）类型。 | ## WebController @@ -185,8 +185,8 @@ accessStep(step: number): boolean - 返回值 - | 参数类型 | 说明 | - | ---- | ------ | + | 参数类型 | 说明 | + | ------- | --------- | | boolean | 页面是否前进或后退 | ### backward @@ -203,9 +203,9 @@ deleteJavaScriptRegister(name: string): void - 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | ------ | -------- | ---- | ------ | ------------------------------------------------------------ | - | name | string | 是 | - | 注册对象的名称，可在网页侧JavaScript中通过此名称调用应用侧JavaScript对象。 | + | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | + | ---- | ------ | ---- | ---- | ---------------------------------------- | + | name | string | 是 | - | 注册对象的名称，可在网页侧JavaScript中通过此名称调用应用侧JavaScript对象。 | ### forward @@ -221,16 +221,16 @@ getHitTest(): HitTestType - HitTestType枚举说明 - | 名称 | 描述 | - | ------------- | ----------------------------------------- | - | EditText | 可编辑的区域。 | - | Email | 电子邮件地址。 | - | HttpAnchor | 超链接。其src为http。 | + | 名称 | 描述 | + | ------------- | ------------------------ | + | EditText | 可编辑的区域。 | + | Email | 电子邮件地址。 | + | HttpAnchor | 超链接。其src为http。 | | HttpAnchorImg | 带有超链接的图片，其中超链接的src为http。 | - | Img | HTML::img标签。 | - | Map | 地理地址。 | - | Phone | 电话号码。 | - | Unknown | 未知内容。 | + | Img | HTML::img标签。 | + | Map | 地理地址。 | + | PhoneNumber | 电话号码。 | + | Unknown | 未知内容。 | ### loadData @@ -244,13 +244,13 @@ baseUrl为空时，通过”data“协议加载指定的一段字符串。 - options参数说明 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | ---------- | -------- | ---- | ------ | ------------------------------------------------------------ | - | data | string | 是 | - | 按照”Base64“或者”URL"编码后的一段字符串。 | - | mimeType | string | 是 | - | 媒体类型（MIME）。 | - | encoding | string | 是 | - | 编码类型，具体为“Base64"或者”URL编码。 | - | baseUrl | string | 否 | - | 指定的一个URL路径（“http”/“https”/"data"协议），并由Web组件赋值给window.origin。 | - | historyUrl | string | 否 | - | 历史记录URL。非空时，可被历史记录管理，实现前后后退功能。当baseUrl为空时，此属性无效。 | + | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | + | ---------- | ------ | ---- | ---- | ---------------------------------------- | + | data | string | 是 | - | 按照”Base64“或者”URL"编码后的一段字符串。 | + | mimeType | string | 是 | - | 媒体类型（MIME）。 | + | encoding | string | 是 | - | 编码类型，具体为“Base64"或者”URL编码。 | + | baseUrl | string | 否 | - | 指定的一个URL路径（“http”/“https”/"data"协议），并由Web组件赋值给window.origin。 | + | historyUrl | string | 否 | - | 历史记录URL。非空时，可被历史记录管理，实现前后后退功能。当baseUrl为空时，此属性无效。 | ### loadUrl @@ -264,10 +264,10 @@ loadUrl(options:{ url: string, headers?: Array\ }): void - options参数说明 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | ------- | ------------------------------------- | ---- | ------ | --------------------- | - | url | string | 是 | - | 需要加载的 URL。 | - | headers | Array\<[Header](#header对象说明)\> | 否 | [] | URL的附加HTTP请求头。 | + | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | + | ------- | ------------------------------ | ---- | ---- | -------------- | + | url | string | 是 | - | 需要加载的 URL。 | + | headers | Array\<[Header](#header对象说明)\> | 否 | [] | URL的附加HTTP请求头。 | ### onActive @@ -295,11 +295,11 @@ registerJavaScriptProxy(options: { object: object, name: string, methodList: Arr - options 参数说明 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | ---------- | --------------- | ---- | ------ | ------------------------------------------------------------ | - | object | object | 是 | - | 参与注册的应用侧JavaScript对象。只能声明方法，不能声明属性 。其中方法的参数和返回类型只能为string，number，boolean | - | name | string | 是 | - | 注册对象的名称，与window中调用的对象名一致。注册后window对象可以通过此名字访问应用侧JavaScript对象。 | - | methodList | Array\ | 是 | - | 参与注册的应用侧JavaScript对象的方法。 | + | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | + | ---------- | --------------- | ---- | ---- | ---------------------------------------- | + | object | object | 是 | - | 参与注册的应用侧JavaScript对象。只能声明方法，不能声明属性 。其中方法的参数和返回类型只能为string，number，boolean | + | name | string | 是 | - | 注册对象的名称，与window中调用的对象名一致。注册后window对象可以通过此名字访问应用侧JavaScript对象。 | + | methodList | Array\ | 是 | - | 参与注册的应用侧JavaScript对象的方法。 | ### runJavaScript @@ -309,10 +309,10 @@ runJavaScript(options: { script: string, callback?: (result: string) => void }): - options参数说明 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | ------------------------ | ---- | ------ | ------------------------------------------------------------ | - | script | string | 是 | - | JavaScript脚本。 | - | callback | (result: string) => void | 否 | - | 回调执行JavaScript脚本结果。JavaScript脚本若执行失败或无返回值时，返回null。 | + | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | + | -------- | ------------------------ | ---- | ---- | ---------------------------------------- | + | script | string | 是 | - | JavaScript脚本。 | + | callback | (result: string) => void | 否 | - | 回调执行JavaScript脚本结果。JavaScript脚本若执行失败或无返回值时，返回null。 | ### stop diff --git a/zh-cn/application-dev/ui/figures/zh-cn_image_0000001168570318.png b/zh-cn/application-dev/ui/figures/zh-cn_image_0000001168570318.png deleted file mode 100644 index d8f65fa710293636817f62b13aca13791e8c579d..0000000000000000000000000000000000000000 Binary files a/zh-cn/application-dev/ui/figures/zh-cn_image_0000001168570318.png and /dev/null differ diff --git a/zh-cn/application-dev/ui/figures/zh-cn_image_0000001195117633.png b/zh-cn/application-dev/ui/figures/zh-cn_image_0000001195117633.png deleted file mode 100644 index 00964c1cfa5f006f2e8ac064133e23a2d8fc92aa..0000000000000000000000000000000000000000 Binary files a/zh-cn/application-dev/ui/figures/zh-cn_image_0000001195117633.png and /dev/null differ diff --git a/zh-cn/application-dev/ui/figures/zh-cn_image_0000001214330169.png b/zh-cn/application-dev/ui/figures/zh-cn_image_0000001214330169.png deleted file mode 100644 index f0c016e9fa69e07581cda8d89f13d5b56f91cc7f..0000000000000000000000000000000000000000 Binary files a/zh-cn/application-dev/ui/figures/zh-cn_image_0000001214330169.png and /dev/null differ diff --git a/zh-cn/application-dev/ui/js-framework-syntax-hml.md b/zh-cn/application-dev/ui/js-framework-syntax-hml.md index b4fc9e6a3ce4bc85dd6246ad823cf436f7115aa9..2684911c682c245a0c43b739904dd91bf28f1876 100644 --- a/zh-cn/application-dev/ui/js-framework-syntax-hml.md +++ b/zh-cn/application-dev/ui/js-framework-syntax-hml.md @@ -39,7 +39,7 @@ export default { > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > - 针对数组内的数据修改，请使用splice方法生效数据绑定变更。 -> +> > - hml文件中的js表达式不支持ES6语法。 @@ -185,7 +185,7 @@ Touch触摸类事件支持捕获，捕获阶段位于冒泡阶段之前，捕获
    ``` - + ``` // xxx.js export default { @@ -247,9 +247,9 @@ tid属性主要用来加速for循环的重渲染，旨在列表中的数据有 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > - 数组中的每个元素必须存在tid指定的数据属性，否则运行时可能会导致异常。 -> +> > - 数组中被tid指定的属性要保证唯一性，如果不是则会造成性能损耗。比如，示例中只有id和name可以作为tid字段，因为它们属于唯一字段。 -> +> > - tid不支持表达式。 @@ -262,8 +262,8 @@ tid属性主要用来加速for循环的重渲染，旨在列表中的数据有
    - Hello-TV - Hello-Wearable + Hello-world1 + Hello-world2 Hello-World
    ``` diff --git a/zh-cn/application-dev/ui/ts-component-based-preview.md b/zh-cn/application-dev/ui/ts-component-based-preview.md index 828093c7822267769a1cf43a054855fe9f71b2d8..73fc57fa9c4d20a3053351cbd48a01ed618fab17 100644 --- a/zh-cn/application-dev/ui/ts-component-based-preview.md +++ b/zh-cn/application-dev/ui/ts-component-based-preview.md @@ -11,7 +11,7 @@ ``` -// Display only Hello Component1 on the PC preview. The content under MyComponent is displayed on the real device. +// Display only Hello Component1 on the preview. The content under MyComponent is displayed on the real device. @Entry @Component struct MyComponent { diff --git a/zh-cn/application-dev/ui/ui-js-components-input.md b/zh-cn/application-dev/ui/ui-js-components-input.md index b8afcf6a8a0939b862935e7aa17c8c71ed5e519d..d697e7964b575409db4f1509208013248da7ebda 100644 --- a/zh-cn/application-dev/ui/ui-js-components-input.md +++ b/zh-cn/application-dev/ui/ui-js-components-input.md @@ -101,9 +101,8 @@ export default { > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** -> - 智能穿戴仅支Input类型设置为button、radio、checkbox。 -> -> - 仅当Input类型为checkbox和radio时，当前组件是否选中的属性checked才生效，默认值为false。 +> +> 仅当Input类型为checkbox和radio时，当前组件是否选中的属性checked才生效，默认值为false。 ## 事件绑定 diff --git a/zh-cn/application-dev/ui/ui-js-components-list.md b/zh-cn/application-dev/ui/ui-js-components-list.md index 45287a52316872090ed15ddb4a53a14729a138af..849878d6d0a249282c9804ce5fe8e3231fc2840a 100644 --- a/zh-cn/application-dev/ui/ui-js-components-list.md +++ b/zh-cn/application-dev/ui/ui-js-components-list.md @@ -39,7 +39,7 @@ List是用来显示列表的组件，包含一系列相同宽度的列表项， > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > - <list-item-group>是<list>的子组件，实现列表分组功能，不能再嵌套<list>，可以嵌套<list-item>。 -> +> > - <list-item>是<list>的子组件，展示列表的具体项。 @@ -112,7 +112,7 @@ List是用来显示列表的组件，包含一系列相同宽度的列表项， > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > - indexer属性生效需要flex-direction属性配合设置为column，且columns属性设置为1。 -> +> > - indexer可以自定义索引表，自定义时"\#"必须要存在。 @@ -214,7 +214,7 @@ export default {
    {{$item.name}} - 18888888888 + 18888888888
    @@ -247,7 +247,7 @@ export default { color: #000000; font-size: 39px; } -.phone { +.number { color: black; font-size: 25px; } diff --git a/zh-cn/application-dev/ui/ui-js-components-picker.md b/zh-cn/application-dev/ui/ui-js-components-picker.md index 7d0e4b91b6cf6011f776b1f75d75eb0890099c23..f719c39b8f6bb18942f7273634da68df34c7948b 100644 --- a/zh-cn/application-dev/ui/ui-js-components-picker.md +++ b/zh-cn/application-dev/ui/ui-js-components-picker.md @@ -70,9 +70,8 @@ export default { ![zh-cn_image_0000001189098638](figures/zh-cn_image_0000001189098638.gif) > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** -> - 普通选择器设置取值范围时，需要使用数据绑定的方式。 -> -> - 日期选择器的lunarswitch属性只支持手机和平板设备。 +> +> 普通选择器设置取值范围时，需要使用数据绑定的方式。 ## 设置时间展现格式 @@ -108,7 +107,7 @@ Picker的hours属性定义时间的展现格式，可选类型有12小时制和2 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > - hours属性为12：按照12小时制显示，用上午和下午进行区分； -> +> > - hours属性为24：按照24小时制显示。 diff --git a/zh-cn/application-dev/ui/ui-js-components-slider.md b/zh-cn/application-dev/ui/ui-js-components-slider.md index 7b724f90b67e27752e4d5174221bd5eccfb0ddad..20d4e775e81d5bc5034bb90069729e103e27f927 100644 --- a/zh-cn/application-dev/ui/ui-js-components-slider.md +++ b/zh-cn/application-dev/ui/ui-js-components-slider.md @@ -91,10 +91,10 @@ Slider组件通过color、selected-color、block-color样式分别为滑动条 ![zh-cn_image_0000001179438692](figures/zh-cn_image_0000001179438692.gif) > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** -> mode属性为滑动条样式，仅在手机和平板上生效，可选值为： -> +> mode属性为滑动条样式，可选值为： +> > - outset：滑块在滑杆上； -> +> > - inset：滑块在滑杆内。 diff --git a/zh-cn/application-dev/ui/ui-js-components-text.md b/zh-cn/application-dev/ui/ui-js-components-text.md index f28505317a830b5ca7f1b5752ed416140c351ce4..35c7525615dc6619c266dc88eecc99f4c28779be 100644 --- a/zh-cn/application-dev/ui/ui-js-components-text.md +++ b/zh-cn/application-dev/ui/ui-js-components-text.md @@ -10,7 +10,7 @@ Text是文本组件，用于呈现一段文本信息。具体用法请参考[Tex ```
    - Hello World + Hello World
    ``` @@ -35,178 +35,175 @@ Text是文本组件，用于呈现一段文本信息。具体用法请参考[Tex 设置color、font-size、allow-scale、word-spacing、text-valign属性分别为文本添加颜色、大小、缩放、文本之间的间距和文本在垂直方向的对齐方式。 + ``` + +
    + + This is a passage + + + This is a passage + +
    + ``` + + ``` + /* xxx.css */ + .container { + width: 100%; + height: 100%; + flex-direction: column; + align-items: center; + justify-content: center; + background-color: #F1F3F5; + } + ``` + ![zh-cn_image_0000001220778205](figures/zh-cn_image_0000001220778205.png) -``` - -
    - - This is a passage - - - This is a passage - -
    -``` - -``` -/* xxx.css */ -.container { - width: 100%; - height: 100%; - flex-direction: column; - align-items: center; - justify-content: center; - background-color: #F1F3F5; -} -``` - - - ![zh-cn_image_0000001220778205](figures/zh-cn_image_0000001220778205.png) - 添加划线 -​ 设置text-decoration和text-decoration-colo属性为文本添加划线和划线颜色，text-decoration枚举值请参考 Text自有样式。 + 设置text-decoration和text-decoration-colo属性为文本添加划线和划线颜色，text-decoration枚举值请参考 Text自有样式。 - - -
    - - This is a passage - - - This is a passage - -
    -``` -/* xxx.css */ -.container { - width: 100%; - height: 100%; - flex-direction: column; - align-items: center; - justify-content: center; -} -text{ - font-size: 50px; -} -``` + ``` + +
    + + This is a passage + + + This is a passage + +
    + ``` + + ``` + /* xxx.css */ + .container { + width: 100%; + height: 100%; + flex-direction: column; + align-items: center; + justify-content: center; + } + text{ + font-size: 50px; + } + ``` ![zh-cn_image_0000001220856725](figures/zh-cn_image_0000001220856725.png) -- 隐藏文本内容 - 当文本内容过多而显示不全时，添加text-overflow属性将隐藏内容以省略号的形式展现 - -``` - -
    - - This is a passage - -
    -``` - - /* xxx.css */ - .container { - width: 100%; - height: 100%; - flex-direction: column; - align-items: center; - background-color: #F1F3F5; - justify-content: center; - } - .text{ - width: 200px; - max-lines: 1; - text-overflow:ellipsis; - } +- 隐藏文本内容 - **说明：** + 当文本内容过多而显示不全时，添加text-overflow属性将隐藏内容以省略号的形式展现。 -- text-overflow样式需要与max-lines样式配套使用，设置了最大行数的情况下生效。 -- max-lines属性设置文本最多可以展示的行数。 + ``` + +
    + + This is a passage + +
    + ``` + + ``` + /* xxx.css */ + .container { + width: 100%; + height: 100%; + flex-direction: column; + align-items: center; + background-color: #F1F3F5; + justify-content: center; + } + .text{ + width: 200px; + max-lines: 1; + text-overflow:ellipsis; + } + ``` + > **说明：** + > - text-overflow样式需要与max-lines样式配套使用，设置了最大行数的情况下生效。 + > - max-lines属性设置文本最多可以展示的行数。 -​ ![zh-cn_image_0000001163656706](figures/zh-cn_image_0000001163656706.png) + ​ ![zh-cn_image_0000001163656706](figures/zh-cn_image_0000001163656706.png) - 设置文本折行 -​ 设置word-break属性对文本内容做断行处理，word-break枚举值请参考Text自有样式。 + 设置word-break属性对文本内容做断行处理，word-break枚举值请参考Text自有样式。 -``` - -
    -
    - - Welcome to the world - - + ``` + +
    +
    + Welcome to the world + + Welcome to the world + +
    -
    +
    + + This is a passage + + + This 1 + + is a 1 + passage + +
    + ``` - ``` - -
    - - This is a passage - - - This 1 - - is a 1 - passage - -
    - ``` - - - ![zh-cn_image_0000001163372568](figures/zh-cn_image_0000001163372568.png) - - + ![zh-cn_image_0000001163372568](figures/zh-cn_image_0000001163372568.png) > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > - 当使用Span子组件组成文本段落时，如果Span属性样式异常（例如：font-weight设置为1000），将导致文本段落显示异常。 > diff --git a/zh-cn/application-dev/ui/ui-ts-building-data-model.md b/zh-cn/application-dev/ui/ui-ts-building-data-model.md index 2936ed0c1d866f8b8ef13a350fb6c1a2af725c5d..5cf7431456f7c42d92a05d2c3417bed5072d71b9 100644 --- a/zh-cn/application-dev/ui/ui-ts-building-data-model.md +++ b/zh-cn/application-dev/ui/ui-ts-building-data-model.md @@ -20,7 +20,7 @@ Seafood, Dessert } - + let NextId = 0; class FoodData { id: string; @@ -32,7 +32,7 @@ fat: number; carbohydrates: number; vitaminC: number; - + constructor(name: string, image: Resource, category: Category, calories: number, protein: number, fat: number, carbohydrates: number, vitaminC: number) { this.id = `${ NextId++ }`; this.name = name; @@ -47,8 +47,8 @@ } ``` -3. 存入食物图片资源。在resources > phone > media目录下存入食物图片资源，图片名称为食物名称。 - +3. 存入食物图片资源。在resources >base> media目录下存入食物图片资源，图片名称为食物名称。 + 4. 创建食物资源数据。在model文件夹下创建FoodDataModels.ets，在该页面中声明食物成分数组FoodComposition。 实际开发中，开发者可以自定义更多的数据资源，当食物资源很多时，建议使用数据懒加载LazyForEach。 @@ -63,7 +63,7 @@ } // FoodDataModels.ets import { Category, FoodData } from './FoodData' - + export function initializeOnStartup(): Array { let FoodDataArray: Array = [] FoodComposition.forEach(item => { diff --git a/zh-cn/application-dev/ui/ui-ts-creating-project.md b/zh-cn/application-dev/ui/ui-ts-creating-project.md index ce681733ccdc518f519fb5fddddc815baf6a83f7..e35ca9fa9b76d6dd69cbdc26864d649971265693 100644 --- a/zh-cn/application-dev/ui/ui-ts-creating-project.md +++ b/zh-cn/application-dev/ui/ui-ts-creating-project.md @@ -14,14 +14,14 @@ ![zh-cn_image_0000001168059158](figures/zh-cn_image_0000001168059158.png) -4. 进入配置工程界面，将工程名字改为HealthyDiet，Project Type选择Application，Compile API选择8，UI Syntax选择eTS。DevEco Studio会默认将工程保存在C盘，如果要更改工程保存位置，点击Save Location的文件夹图标，自行指定工程创建位置。配置完成后点击Finish。 - +3. 进入配置工程界面，将工程名字改为HealthyDiet，Project Type选择Application，Compile API选择8，UI Syntax选择eTS。DevEco Studio会默认将工程保存在C盘，如果要更改工程保存位置，点击Save Location的文件夹图标，自行指定工程创建位置。配置完成后点击Finish。 + ![zh-cn_image_0000001167746622](figures/zh-cn_image_0000001167746622.png) -5. 工程创建完成后，打开app.ets。 +4. 工程创建完成后，打开app.ets。 app.ets提供了应用生命周期的接口：onCreate和onDestroy，分别在应用创建之初和应用被销毁时调用。在app.ets里可以声明全局变量，并且声明的数据和方法是整个应用共享的。 - + ``` export default { onCreate() { @@ -32,8 +32,8 @@ }, } ``` - -6. 在工程导航栏里，打开index.ets。该页面展示了当前的UI描述，声明式UI框架会自动生成一个组件化的struct，这个struct遵循Builder接口声明，在build方法里面声明当前的布局和组件。 + +5. 在工程导航栏里，打开index.ets。该页面展示了当前的UI描述，声明式UI框架会自动生成一个组件化的struct，这个struct遵循Builder接口声明，在build方法里面声明当前的布局和组件。 ``` @Entry @Component @@ -50,14 +50,16 @@ } ``` -7. 点击右侧的Previewer按钮，打开预览窗口。可以看到在手机设备类型的预览窗口中“Hello World”居中加粗显示。 +6. 点击右侧的Previewer按钮，打开预览窗口。可以看到预览窗口中“Hello World”居中加粗显示。 如果没有Previewer按钮，点击settings > SDK Manager > OpenHarmony SDK> Tools 查看是否安装了Previewer。 ![zh-cn_image_0000001214595111](figures/zh-cn_image_0000001214595111.png) -8. 应用安装到手机上运行应用。将手机连接电脑，等IDE识别到物理设备后，点击Run 'entry'按钮。 +7. 应用安装到设备上运行应用。 + + 将设备连接电脑，等IDE识别到物理设备后，点击Run 'entry'按钮。 ![zh-cn_image_0000001148858818](figures/zh-cn_image_0000001148858818.png) - 在安装之前，需要[配置应用签名](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/ohos-debugging-and-running-0000001263040487#section17660437768)。安装成功后，点击屏幕上的Run图标打开应用，可以看到居中加粗显示的“Hello World”。 + 在安装之前，需要配置应用签名。安装成功后，点击屏幕上的Run图标打开应用，可以看到居中加粗显示的“Hello World”。 ![zh-cn_image_0000001158896538](figures/zh-cn_image_0000001158896538.png) diff --git a/zh-cn/application-dev/ui/ui-ts-creating-simple-page.md b/zh-cn/application-dev/ui/ui-ts-creating-simple-page.md index 93506e15a1954e4af82f40fb9cbb937ae1bfb8de..1b7edd1205710adc65fd787f04aceacdf96ec4ad 100644 --- a/zh-cn/application-dev/ui/ui-ts-creating-simple-page.md +++ b/zh-cn/application-dev/ui/ui-ts-creating-simple-page.md @@ -43,15 +43,9 @@ ![zh-cn_image_0000001168410342](figures/zh-cn_image_0000001168410342.png) 3. 通过资源访问图片。 - 除指定图片路径外，也可以使用引用媒体资源符$r引用资源，需要遵循resources文件夹的资源限定词的规则。右键resources文件夹，点击New>Resource Directory，选择Resource Type为Media（图片资源），选择资源限定词为Device-Phone（目前开发设备为手机）。 + 除指定图片路径外，也可以使用引用媒体资源符$r引用资源，需要遵循resources文件夹的资源限定词的规则。右键resources文件夹，点击New>Resource Directory，选择Resource Type为Media（图片资源）。 - ![zh-cn_image_0000001168570318](figures/zh-cn_image_0000001168570318.png) - - 点击OK后，resources文件夹下生成phone文件夹，phone文件夹下生成media文件夹，将Tomato.png放入media文件夹内。 - - ![zh-cn_image_0000001214330169](figures/zh-cn_image_0000001214330169.png) - - 就可以通过`$r('app.type.name')`的形式引用应用资源，即`$r('app.media.Tomato')`。 + 将Tomato.png放入media文件夹内。就可以通过`$r('app.type.name')`的形式引用应用资源，即`$r('app.media.Tomato')`。 ``` @Entry diff --git a/zh-cn/application-dev/ui/ui-ts-page-redirection-data-transmission.md b/zh-cn/application-dev/ui/ui-ts-page-redirection-data-transmission.md index 0c0bc3943a0c604ddefe14bfa20f772551dcf553..826fdd6f5c0db8f423d9ec0b2f85d6a53ff5c43e 100644 --- a/zh-cn/application-dev/ui/ui-ts-page-redirection-data-transmission.md +++ b/zh-cn/application-dev/ui/ui-ts-page-redirection-data-transmission.md @@ -50,7 +50,7 @@ 2. 点击FoodGridItem后跳转到FoodDetail页面。调用页面路由router模块的push接口，将FoodDetail页面推到路由栈中，实现页面跳转。使用router路由API接口，需要先引入router。 ``` import router from '@system.router' - + @Component struct FoodGridItem { private foodItem: FoodData @@ -69,11 +69,11 @@ ![zh-cn_image_0000001169918548](figures/zh-cn_image_0000001169918548.gif) -3. 在FoodDetail页面增加回到食物列表页面的图标。在resources > phone > media文件夹下存入回退图标Back.png。新建自定义组件PageTitle，包含后退的图标和Food Detail的文本，调用路由的router.back()接口，弹出路由栈最上面的页面，即返回上一级页面。 +3. 在FoodDetail页面增加回到食物列表页面的图标。在resources > base > media文件夹下存入回退图标Back.png。新建自定义组件PageTitle，包含后退的图标和Food Detail的文本，调用路由的router.back()接口，弹出路由栈最上面的页面，即返回上一级页面。 ``` // FoodDetail.ets import router from '@system.router' - + @Component struct PageTitle { build() { @@ -148,7 +148,7 @@ ``` // FoodDetail.ets import { FoodData } from '../model/FoodData' - + @Entry @Component struct FoodDetail { @@ -165,7 +165,7 @@ @Component struct FoodDetail { private foodItem: FoodData = router.getParams().foodData - + build() { ...... } @@ -193,7 +193,7 @@ }) } } - + @Component struct FoodImageDisplay { private foodItem: FoodData @@ -210,11 +210,11 @@ .backgroundColor('#FFedf2f5') } } - + @Component struct ContentTable { private foodItem: FoodData - + @Builder IngredientItem(title:string, name: string, value: string) { Flex() { Text(title) @@ -231,7 +231,7 @@ .layoutWeight(2) } } - + build() { Flex({ direction: FlexDirection.Column, justifyContent: FlexAlign.SpaceBetween, alignItems: ItemAlign.Start }) { this.IngredientItem('Calories', 'Calories', this.foodItem.calories + 'kcal') @@ -244,12 +244,12 @@ .padding({ top: 30, right: 30, left: 30 }) } } - + @Entry @Component struct FoodDetail { private foodItem: FoodData = router.getParams().foodData - + build() { Column() { Stack( { alignContent: Alignment.TopStart }) {