diff --git a/en/application-dev/Readme-EN.md b/en/application-dev/Readme-EN.md index 8e42633391269303e5e8d888561281f57d1718ae..5854144672c9a672c58e889857e1697fe4fa1ab2 100644 --- a/en/application-dev/Readme-EN.md +++ b/en/application-dev/Readme-EN.md @@ -8,14 +8,14 @@ - Quick Start - Getting Started - [Preparations](quick-start/start-overview.md) - - [Getting Started with eTS in the Traditional Coding Approach](quick-start/start-with-ets.md) - - [Getting Started with eTS in the Low-Code Approach](quick-start/start-with-ets-low-code.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) + - [Getting Started with eTS in Stage Model](quick-start/start-with-ets-stage.md) + - [Getting Started with eTS in FA Model](quick-start/start-with-ets-fa.md) + - [Getting Started with JavaScript in FA Model](quick-start/start-with-js-fa.md) - Development Fundamentals - [Application Package Structure Configuration File (FA Model)](quick-start/package-structure.md) - [Application Package Structure Configuration File (Stage Model)](quick-start/stage-structure.md) - [SysCap](quick-start/syscap.md) + - [HarmonyAppProvision Configuration File](quick-start/app-provision-structure.md) - Development - [Ability Development](ability/Readme-EN.md) - [UI Development](ui/Readme-EN.md) @@ -44,5 +44,8 @@ - [Component Reference (TypeScript-based Declarative Development Paradigm)](reference/arkui-ts/Readme-EN.md) - APIs - [JS and TS APIs](reference/apis/Readme-EN.md) + - Native APIs + - [Standard Libraries](reference/native-lib/third_party_libc/musl.md) + - [Node_API](reference/native-lib/third_party_napi/napi.md) - Contribution - [How to Contribute](../contribute/documentation-contribution.md) diff --git a/en/application-dev/napi/Readme-EN.md b/en/application-dev/napi/Readme-EN.md index d5297e9374fdf42b1b50fa2ac6e545fe9766971b..280efd8afa5fa845dab0d607ed94b33e2a75e6d3 100644 --- a/en/application-dev/napi/Readme-EN.md +++ b/en/application-dev/napi/Readme-EN.md @@ -2,6 +2,7 @@ - [Using Native APIs in Application Projects](napi-guidelines.md) - [Drawing Development](drawing-guidelines.md) -- [Native Window Development](native-window-guidelines.md) - [Raw File Development](rawfile-guidelines.md) +- [Native Window Development](native-window-guidelines.md) + diff --git a/en/application-dev/website.md b/en/application-dev/website.md index d4635b57a336ef5f019f5eba6855d841b4ae5560..c27aa07aa2baa2b839198d5d8b01802475fa8d4b 100644 --- a/en/application-dev/website.md +++ b/en/application-dev/website.md @@ -190,17 +190,10 @@ - [Agent-Powered Scheduled Reminder Development](notification/background-agent-scheduled-reminder-guide.md) - [Debugging Assistant Usage](notification/assistant-guidelines.md) - Window Manager - - Window - - [Window Overview](windowmanager/window-overview.md) - - [Application Window Development (Stage Mode)](windowmanager/application-window-stage.md) - - [Application Window Development (FA Model)](windowmanager/application-window-fa.md) - - [System Window Development (Stage Model Only)](windowmanager/system-window-stage.md) - - Display - - [Display Overview](windowmanager/display-overview.md) - - [Display Development](windowmanager/display-guidelines.md) - - Screenshot - - [Screenshot Overview](windowmanager/screenshot-overview.md) - - [Screenshot Development](windowmanager/screenshot-guidelines.md) + - [Window Overview](windowmanager/window-overview.md) + - [Application Window Development (Stage Mode)](windowmanager/application-window-stage.md) + - [Application Window Development (FA Model)](windowmanager/application-window-fa.md) + - [System Window Development (Stage Model Only)](windowmanager/system-window-stage.md) - WebGL - [WebGL Overview](webgl/webgl-overview.md) - [WebGL Development](webgl/webgl-guidelines.md) diff --git a/en/application-dev/windowmanager/Readme-EN.md b/en/application-dev/windowmanager/Readme-EN.md index 7007e701afe32675c029f5a4734e50b88f82849f..851e4d4c6b0f3837872a60acf8540714ba5edd2d 100644 --- a/en/application-dev/windowmanager/Readme-EN.md +++ b/en/application-dev/windowmanager/Readme-EN.md @@ -1,14 +1,7 @@ # Window Manager -* Window - * [Window Overview](window-overview.md) - * [System Window Development (Stage Model Only)](application-window-stage.md) - * [Application Window Development (FA Model)](application-window-fa.md) - * [Application Window Development (Stage Mode)](system-window-stage.md) -* Display - * [Display Overview](display-overview.md) - * [Display Development](display-guidelines.md) -* Screenshot - * [Screenshot Overview](screenshot-overview.md) - * [Screenshot Development](screenshot-guidelines.md) +- [Window Overview](window-overview.md) +- [System Window Development (Stage Model Only)](application-window-stage.md) +- [Application Window Development (FA Model)](application-window-fa.md) +- [Application Window Development (Stage Mode)](system-window-stage.md) diff --git a/en/application-dev/windowmanager/display-guidelines.md b/en/application-dev/windowmanager/display-guidelines.md deleted file mode 100644 index cdfaa91c9e30760be35923d2c41345feba682080..0000000000000000000000000000000000000000 --- a/en/application-dev/windowmanager/display-guidelines.md +++ /dev/null @@ -1,23 +0,0 @@ -# Display Development - -## When to Use - -An application can obtain the default display object or all display objects by calling the **Display** APIs. - -## Available APIs - -For details about the APIs, see [Display](../reference/apis/js-apis-display.md). - -## How to Develop - -Call `getDefaultDisplay(): Promise` to obtain the default display object. An example code snippet is as follows: - -```js -import display from '@ohos.display' // Import the module. - -display.getDefaultDisplay().then((disp) => { - console.log('display.getDefaultDisplay success, display :' + JSON.stringify(disp)); -}, (err) => { - console.log('display.getDefaultDisplay failed, error : ' + JSON.stringify(err)); -}) -``` diff --git a/en/application-dev/windowmanager/display-overview.md b/en/application-dev/windowmanager/display-overview.md deleted file mode 100644 index 702ff0961e6111f0d73f16f81e52cf7fcaca444f..0000000000000000000000000000000000000000 --- a/en/application-dev/windowmanager/display-overview.md +++ /dev/null @@ -1,7 +0,0 @@ -# Display Overview - -The **Display** APIs present the window layout of an application. The display attributes include the display ID, name, active status, state, refresh rate, rotation angle, width, height, pixel density, font scaling factor, and exact physical dots per inch. - -## Basic Concepts - -**Display**: a screen visible to an application. It can be used as a window container. It is an abstract concept that is different from a physical screen. diff --git a/en/application-dev/windowmanager/screenshot-guidelines.md b/en/application-dev/windowmanager/screenshot-guidelines.md deleted file mode 100644 index a5023d76ec0645511de1c9a0a5f39779363a5729..0000000000000000000000000000000000000000 --- a/en/application-dev/windowmanager/screenshot-guidelines.md +++ /dev/null @@ -1,37 +0,0 @@ -# Screenshot Development - -## When to Use - -You can specify a display device to take screenshots, with screenshot parameters specified. - -## Available APIs - -For details about the APIs, see [Screenshot](../reference/apis/js-apis-screenshot.md). - -## How to Develop - -Call **save(options?: ScreenshotOptions): Promise** to take a screenshot. In this API, **options** is a predefined screenshot parameter. If **options** is unspecified, the entire screen is captured by default. An example code snippet is as follows: - -```js -import screenshot from '@ohos.screenshot' // Import the module. - -// Set screenshot parameters. -var ScreenshotOptions = { - "screenRect": { - "left": 200, - "top": 100, - "width": 200, - "height": 200}, - "imageSize": { - "width": 300, - "height": 300}, - "rotation": 0 -}; - -let image; // image is used to save the screenshot. -screenshot.save(ScreenshotOptions).then((image) => { - console.log('screenshot.save success, screenshot image :' + JSON.stringify(image)); -}, (err) => { - console.log('screenshot.save failed, error : ' + JSON.stringify(err)); -}) -``` diff --git a/en/application-dev/windowmanager/screenshot-overview.md b/en/application-dev/windowmanager/screenshot-overview.md deleted file mode 100644 index 8f1a485a711e031dfc9762fb803d41c55c4380fd..0000000000000000000000000000000000000000 --- a/en/application-dev/windowmanager/screenshot-overview.md +++ /dev/null @@ -1,7 +0,0 @@ -# Screenshot Overview - -The screenshot APIs, with parameters, enable you to take screenshots on display devices. - -## Basic Concepts - -Screenshot: provides the screenshot capability. diff --git a/en/device-dev/Readme-EN.md b/en/device-dev/Readme-EN.md index da79e395fe463e47d3606de98f799e3e306d3b0e..99194b48e979df7822002596d27c74f6c76b29da 100644 --- a/en/device-dev/Readme-EN.md +++ b/en/device-dev/Readme-EN.md @@ -6,53 +6,57 @@ - [Glossary](../glossary.md) - [Release Notes](../release-notes/Readme.md) - Quick Start - - [Mini and Small Systems](quick-start/quickstart-lite.md) - - [Standard System](quick-start/quickstart-standard.md) + - [Mini and Small Systems](quick-start/quickstart-ide-lite-overview.md) + - [Standard System](quick-start/quickstart-ide-standard-overview.md) - Compatibility and Security - [Privacy and Security](security/Readme-EN.md) - Porting - - [Third-Party Library Porting Guide for Mini and Small Systems](porting/porting-thirdparty.md) - - [Mini System SoC Porting Guide](porting/porting-minichip.md) - - [Mini System SoC Porting Cases](porting/porting-minichip-cases.md) - - [Small System SoC Porting Guide](porting/porting-smallchip.md) - - [Standard System SoC Porting Guide](porting/standard-system-porting-guide.md) + - Porting Guide + - [Third-Party Library Porting Guide for Mini and Small Systems](porting/porting-thirdparty-overview.md) + - [Mini System SoC Porting Guide](porting/porting-minichip.md) + - [Small System SoC Porting Guide](porting/porting-smallchip-prepare-needs.md) + - [Standard System SoC Porting Guide](porting/standard-system-porting-guide.md) + - Porting Cases + - Mini System SoC Porting Cases + - [Mini-System Devices with Screens — Bestechnic SoC Porting Case](porting/porting-bes2600w-on-minisystem-display-demo.md) + - [Combo Solution — ASR Chip Porting Case](porting/porting-asr582x-combo-demo.md) + - Subsystem Development - Kernel - - [Kernel for the Mini System](kernel/kernel-mini.md) - - [Kernel for the Small System](kernel/kernel-small.md) - - [Kernel for the Standard System](kernel/kernel-standard.md) + - [Kernel for the Mini System](kernel/kernel-mini-overview.md) + - [Kernel for the Small System](kernel/kernel-small-overview.md) + - [Kernel for the Standard System](kernel/kernel-standard-overview.md) - [Driver](driver/Readme-EN.md) - - [Compilation and Building](subsystems/subsys-build.md) + - [Compilation and Building](subsystems/subsys-build-all.md) - [Distributed Remote Startup](subsystems/subsys-remote-start.md) - - [Graphics](subsystems/subsys-graphics.md) - - [Multimedia](subsystems/subsys-multimedia.md) - - [Utils](subsystems/subsys-utils.md) - - [AI Framework](subsystems/subsys-aiframework.md) - - [Data Management](subsystems/subsys-data.md) - - [Sensor](subsystems/subsys-sensor.md) - - [USB](subsystems/subsys-usbservice.md) - - [Application Framework](subsystems/subsys-application-framework.md) + - [Graphics](subsystems/subsys-graphics-overview.md) + - [Multimedia](subsystems/subsys-multimedia-camera-overview.md) + - [Utils](subsystems/subsys-utils-overview.md) + - [AI Framework](subsystems/subsys-aiframework-guide.md) + - [Data Management](subsystems/subsys-data-relational-database-overview.md) + - [Sensor](subsystems/subsys-sensor-overview.md) + - [USB](subsystems/subsys-usbservice-overview.md) + - [Application Framework](subsystems/subsys-application-framework-overview.md) - [OTA Update](subsystems/subsys-ota-guide.md) - - [Telephony](subsystems/subsys-tel.md) - - [Security](subsystems/subsys-security.md) - - [Startup](subsystems/subsys-boot.md) - - [DFX](subsystems/subsys-dfx.md) + - [Telephony](subsystems/subsys-tel-overview.md) + - [Security](subsystems/subsys-security-overview.md) + - [Startup](subsystems/subsys-boot-overview.md) + - [DFX](subsystems/subsys-dfx-overview.md) - Featured Topics - [HPM Part](hpm-part/Readme-EN.md) - Device Development Examples - - [Mini- and Small-System Devices](guide/device-lite.md) - - [Standard-System Devices](guide/device-standard.md) + - [Mini- and Small-System Devices](guide/device-wlan-led-control.md) + - [Standard-System Devices](guide/device-clock-guide.md) - Debugging - [Test Case Development](subsystems/subsys-testguide-test.md) - - [R&D Tools](subsystems/subsys-toolchain.md) + - [R&D Tools](subsystems/subsys-toolchain-hdc-guide.md) - XTS Certification - [XTS Test Case Development](subsystems/subsys-xts-guide.md) - Tools - [Docker Environment](get-code/gettools-acquire.md) - [IDE](get-code/gettools-ide.md) - Hands-On Tutorials - - [Samples](https://gitee.com/openharmony/app_samples/blob/master/README.md) - - [Codelabs](https://gitee.com/openharmony/codelabs) + - [Codelabs](https://gitee.com/openharmony/codelabs) - References - [FAQs](faqs/Readme-EN.md) - Contribution diff --git a/en/device-dev/get-code/gettools.md b/en/device-dev/get-code/gettools.md deleted file mode 100644 index 95366cdb4c3f08c8783e132e5489b026622d262a..0000000000000000000000000000000000000000 --- a/en/device-dev/get-code/gettools.md +++ /dev/null @@ -1,7 +0,0 @@ -# Tool Acquisition - -- **[Docker Environment](gettools-acquire.md)** - -- **[IDE](gettools-ide.md)** - - diff --git a/en/device-dev/get-code/sourcecode.md b/en/device-dev/get-code/sourcecode.md deleted file mode 100644 index 5e118ce26fcaab05055610b3ca990fd6c3f676b0..0000000000000000000000000000000000000000 --- a/en/device-dev/get-code/sourcecode.md +++ /dev/null @@ -1,5 +0,0 @@ -# Source Code Acquisition - -- **[Source Code Acquisition](sourcecode-acquire.md)** - - diff --git a/en/device-dev/guide/Readme-EN.md b/en/device-dev/guide/Readme-EN.md index 281430305ce6af02b4cb1481e6100acc35c233af..4da6d3441ea153312b7a0f283be891052c430515 100644 --- a/en/device-dev/guide/Readme-EN.md +++ b/en/device-dev/guide/Readme-EN.md @@ -1,25 +1,25 @@ # Development Examples -- [Mini- and Small-System Devices](device-lite.md) - - [WLAN-connected Products](device-wlan.md) +- Mini- and Small-System Devices + - WLAN-connected Products - [LED Peripheral Control](device-wlan-led-control.md) - [Third-Party SDK Integration](device-wlan-sdk.md) - - [Cameras Without a Screen](device-iotcamera.md) - - [Camera Control](device-iotcamera-control.md) + - Cameras Without a Screen + - Camera Control - [Overview](device-iotcamera-control-overview.md) - - [Development Guidelines](device-iotcamera-control-demo.md) + - Development Guidelines - [Photographing](device-iotcamera-control-demo-photodevguide.md) - [Video Recording](device-iotcamera-control-demo-videodevguide.md) - [Use Case](device-iotcamera-control-example.md) - - [Cameras with a Screen](device-camera.md) - - [Screen and Camera Control](device-camera-control.md) + - Cameras with a Screen + - Screen and Camera Control - [Overview](device-camera-control-overview.md) - - [Development Guidelines](device-camera-control-demo.md) + - Development Guidelines - [Photographing](device-camera-control-demo-photoguide.md) - [Video Recording](device-camera-control-demo-videoguide.md) - [Previewing](device-camera-control-demo-previewguide.md) - [Use Case](device-camera-control-example.md) - - [Visual Application Development](device-camera-visual.md) + - Visual Application Development - [Overview](device-camera-visual-overview.md) - [Preparations](device-camera-visual-prepare.md) - [Adding Pages](device-camera-visual-addpage.md) @@ -28,7 +28,7 @@ - [Debugging and Packaging](device-camera-visual-debug.md) - [Running on the Device](device-camera-visual-run.md) - [FAQs](device-camera-visual-faqs.md) -- [Standard-System Devices](device-standard.md) +- Standard-System Devices - [Development Guidelines on Clock Apps](device-clock-guide.md) - [Development Example for Platform Drivers](device-driver-demo.md) - [Development Example for Peripheral Drivers](device-outerdriver-demo.md) \ No newline at end of file diff --git a/en/device-dev/guide/device-camera-control-demo.md b/en/device-dev/guide/device-camera-control-demo.md deleted file mode 100644 index 0656cdd72908cb5fd9c21e373f478b09c3693406..0000000000000000000000000000000000000000 --- a/en/device-dev/guide/device-camera-control-demo.md +++ /dev/null @@ -1,9 +0,0 @@ -# Screen and Camera Control Development - -- **[Photographing](device-camera-control-demo-photoguide.md)** - -- **[Video Recording](device-camera-control-demo-videoguide.md)** - -- **[Previewing](device-camera-control-demo-previewguide.md)** - - diff --git a/en/device-dev/guide/device-camera-control.md b/en/device-dev/guide/device-camera-control.md deleted file mode 100644 index e57f328b6d90589b33abc16752c301b2ef78a158..0000000000000000000000000000000000000000 --- a/en/device-dev/guide/device-camera-control.md +++ /dev/null @@ -1,9 +0,0 @@ -# Screen and Camera Control - -- **[Screen and Camera Control Overview](device-camera-control-overview.md)** - -- **[Screen and Camera Control Development](device-camera-control-demo.md)** - -- **[Use Case](device-camera-control-example.md)** - - diff --git a/en/device-dev/guide/device-camera-visual.md b/en/device-dev/guide/device-camera-visual.md deleted file mode 100644 index 223659e705eb9f4ba215c92237e631dcf31c3b7d..0000000000000000000000000000000000000000 --- a/en/device-dev/guide/device-camera-visual.md +++ /dev/null @@ -1,19 +0,0 @@ -# Visual Application Development - -- **[Overview](device-camera-visual-overview.md)** - -- **[Preparations](device-camera-visual-prepare.md)** - -- **[Adding Pages](device-camera-visual-addpage.md)** - -- **[Building the Home Page](device-camera-visual-firstpage.md)** - -- **[Building the Details Page](device-camera-visual-details.md)** - -- **[Debugging and Packaging](device-camera-visual-debug.md)** - -- **[Running on the Device](device-camera-visual-run.md)** - -- **[FAQs](device-camera-visual-faqs.md)** - - diff --git a/en/device-dev/guide/device-camera.md b/en/device-dev/guide/device-camera.md deleted file mode 100644 index 3fab60c51ec77fb4f023d1337edc3327aa29dbc0..0000000000000000000000000000000000000000 --- a/en/device-dev/guide/device-camera.md +++ /dev/null @@ -1,7 +0,0 @@ -# Cameras with a Screen - -- **[Screen and Camera Control](device-camera-control.md)** - -- **[Visual Application Development](device-camera-visual.md)** - - diff --git a/en/device-dev/guide/device-iotcamera-control-demo.md b/en/device-dev/guide/device-iotcamera-control-demo.md deleted file mode 100644 index 2d711a2c708133b926a17f2f21ee576171b4541d..0000000000000000000000000000000000000000 --- a/en/device-dev/guide/device-iotcamera-control-demo.md +++ /dev/null @@ -1,7 +0,0 @@ -# Camera Control Development - -- **[Photographing](device-iotcamera-control-demo-photodevguide.md)** - -- **[Video Recording](device-iotcamera-control-demo-videodevguide.md)** - - diff --git a/en/device-dev/guide/device-iotcamera-control.md b/en/device-dev/guide/device-iotcamera-control.md deleted file mode 100644 index 35d1af547b6a0b579c201e01079c1429f5249492..0000000000000000000000000000000000000000 --- a/en/device-dev/guide/device-iotcamera-control.md +++ /dev/null @@ -1,9 +0,0 @@ -# Camera Control - -- **[Camera Control Overview](device-iotcamera-control-overview.md)** - -- **[Camera Control Development](device-iotcamera-control-demo.md)** - -- **[Use Case](device-iotcamera-control-example.md)** - - diff --git a/en/device-dev/guide/device-iotcamera.md b/en/device-dev/guide/device-iotcamera.md deleted file mode 100644 index 7cbb7f06d6d084d8c3876d78b30514b95cc7b948..0000000000000000000000000000000000000000 --- a/en/device-dev/guide/device-iotcamera.md +++ /dev/null @@ -1,5 +0,0 @@ -# Cameras Without a Screen - -- **[Camera Control](device-iotcamera-control.md)** - - diff --git a/en/device-dev/guide/device-lite.md b/en/device-dev/guide/device-lite.md deleted file mode 100644 index 506b0beefeaad68acee95d488329dbf0d292ae7d..0000000000000000000000000000000000000000 --- a/en/device-dev/guide/device-lite.md +++ /dev/null @@ -1,9 +0,0 @@ -# Mini- and Small-System Devices - -- **[WLAN-connected Products](device-wlan.md)** - -- **[Cameras Without a Screen](device-iotcamera.md)** - -- **[Cameras with a Screen](device-camera.md)** - - diff --git a/en/device-dev/guide/device-standard.md b/en/device-dev/guide/device-standard.md deleted file mode 100644 index 7ee3a52b865cae093c77aa56f784bbd56bcc91f3..0000000000000000000000000000000000000000 --- a/en/device-dev/guide/device-standard.md +++ /dev/null @@ -1,9 +0,0 @@ -# Standard-System Devices - -- **[Development Guidelines on Clock Apps](device-clock-guide.md)** - -- **[Development Example for Platform Drivers](device-driver-demo.md)** - -- **[Development Example for Peripheral Drivers](device-outerdriver-demo.md)** - - diff --git a/en/device-dev/guide/device-wlan-led.md b/en/device-dev/guide/device-wlan-led.md deleted file mode 100644 index 55faec5993ec121fc8af870ab4250ca7f63ea120..0000000000000000000000000000000000000000 --- a/en/device-dev/guide/device-wlan-led.md +++ /dev/null @@ -1,5 +0,0 @@ -# LED Peripheral Control - -- **[LED Peripheral Control](device-wlan-led-control.md)** - - diff --git a/en/device-dev/guide/device-wlan.md b/en/device-dev/guide/device-wlan.md deleted file mode 100644 index dd1fb71a73aa1bef16a5d4a906a00fe1b709df4b..0000000000000000000000000000000000000000 --- a/en/device-dev/guide/device-wlan.md +++ /dev/null @@ -1,8 +0,0 @@ -# WLAN-connected Products - - -- **[LED Peripheral Control](device-wlan-led.md)** - -- **[Third-Party SDK Integration](device-wlan-sdk.md)** - - diff --git a/en/device-dev/guide/device.md b/en/device-dev/guide/device.md deleted file mode 100644 index 651da70de63631e3aeec538fea3974a9fe75b122..0000000000000000000000000000000000000000 --- a/en/device-dev/guide/device.md +++ /dev/null @@ -1,7 +0,0 @@ -# Devices - -- **[Mini- and Small-System Devices](device-lite.md)** - -- **[Standard-System Devices](device-standard.md)** - - diff --git a/en/device-dev/quick-start/quickstart-lite.md b/en/device-dev/quick-start/quickstart-lite.md deleted file mode 100644 index 95674ead0e58a3a495d5968aa2994655bf33a639..0000000000000000000000000000000000000000 --- a/en/device-dev/quick-start/quickstart-lite.md +++ /dev/null @@ -1,6 +0,0 @@ -# Getting Started with Mini and Small Systems - - - -- **[Getting Started with Mini and Small Systems (IDE Mode)](quickstart-lite-ide-directory.md)** -- **[Getting Started with Mini and Small Systems (Installation Package Mode)](quickstart-lite-package-directory.md)** diff --git a/en/device-dev/quick-start/quickstart-standard.md b/en/device-dev/quick-start/quickstart-standard.md deleted file mode 100644 index b66899afd7e5b3c0e5acd1600115bc9c12ce2e14..0000000000000000000000000000000000000000 --- a/en/device-dev/quick-start/quickstart-standard.md +++ /dev/null @@ -1,6 +0,0 @@ -# Getting Started with Standard System - - - -- **[Getting Started with Standard System (IDE Mode)](quickstart-standard-ide-directory.md)** -- **[Getting Started with Standard System (Installation Package Mode)](quickstart-standard-package-directory.md)** diff --git a/en/device-dev/subsystems/subsys-application-framework.md b/en/device-dev/subsystems/subsys-application-framework.md deleted file mode 100644 index d182dd67a37a05d615a169b96a08ea0091b578fd..0000000000000000000000000000000000000000 --- a/en/device-dev/subsystems/subsys-application-framework.md +++ /dev/null @@ -1,11 +0,0 @@ -# Application Framework - -- **[Application Framework Overview](subsys-application-framework-overview.md)** - -- **[Setting Up a Development Environment](subsys-application-framework-envbuild.md)** - -- **[Development Guidelines](subsys-application-framework-guide.md)** - -- **[Development Example](subsys-application-framework-demo.md)** - - diff --git a/en/device-dev/subsystems/subsys-boot-init.md b/en/device-dev/subsystems/subsys-boot-init.md deleted file mode 100644 index 74be1119d5486153c9d3353db431e56e67546528..0000000000000000000000000000000000000000 --- a/en/device-dev/subsystems/subsys-boot-init.md +++ /dev/null @@ -1,13 +0,0 @@ -# init Module - -- **[init Configuration File](subsys-boot-init-cfg.md)** - -- **[Job Management](subsys-boot-init-jobs.md)** - -- **[Service Management](subsys-boot-init-service.md)** - -- **[Parameter Management](subsys-boot-init-sysparam.md)** - -- **[Sandbox Management](subsys-boot-init-sandbox.md)** - -- **[Plug-in Management](subsys-boot-init-plugin.md)** diff --git a/en/device-dev/subsystems/subsys-boot.md b/en/device-dev/subsystems/subsys-boot.md deleted file mode 100644 index 7888048a08574ef3a06b3cdca551a4d598dc201d..0000000000000000000000000000000000000000 --- a/en/device-dev/subsystems/subsys-boot.md +++ /dev/null @@ -1,10 +0,0 @@ -# Startup - -- **[Startup](subsys-boot-overview.md)** -- **[init Module](subsys-boot-init.md)** -- **[appspawn Module](subsys-boot-appspawn.md)** -- **[bootstrap Module](subsys-boot-bootstrap.md)** -- **[FAQs](subsys-boot-faqs.md)** -- **[Reference](subsys-boot-ref.md)** - - diff --git a/en/device-dev/subsystems/subsys-build.md b/en/device-dev/subsystems/subsys-build.md deleted file mode 100644 index 814bb5e74c1f84240a0e1b2f259bc29391381ec1..0000000000000000000000000000000000000000 --- a/en/device-dev/subsystems/subsys-build.md +++ /dev/null @@ -1,7 +0,0 @@ -# Compilation and Building - -- **[Compilation and Building Guide](subsys-build-all.md)** - -- **[Build System Coding Specifications and Best Practices](subsys-build-gn-coding-style-and-best-practice.md)** - -- **[Building the Kconfig Visual Configuration](subsys-build-gn-kconfig-visual-config-guide.md)** diff --git a/en/device-dev/subsystems/subsys-data-relational-database.md b/en/device-dev/subsystems/subsys-data-relational-database.md deleted file mode 100644 index b1b3c1b15503b45874a2c6886458e7d904af9388..0000000000000000000000000000000000000000 --- a/en/device-dev/subsystems/subsys-data-relational-database.md +++ /dev/null @@ -1,5 +0,0 @@ -# RDB - -- **[RDB Overview](subsys-data-relational-database-overview.md)** - -- **[RDB Development](subsys-data-relational-database-guide.md)** diff --git a/en/device-dev/subsystems/subsys-data-storage.md b/en/device-dev/subsystems/subsys-data-storage.md deleted file mode 100644 index 504f220b7b85bc4d942ae0b35c0ad60c295729cd..0000000000000000000000000000000000000000 --- a/en/device-dev/subsystems/subsys-data-storage.md +++ /dev/null @@ -1,5 +0,0 @@ -# Lightweight Data Store - -- **[Lightweight Data Store Overview](subsys-data-storage-overview.md)** - -- **[Lightweight Data Store Development](subsys-data-storage-guide.md)** diff --git a/en/device-dev/subsystems/subsys-data.md b/en/device-dev/subsystems/subsys-data.md deleted file mode 100644 index f74c8f5cf30d86ba342205b1ced63d5fa6b47804..0000000000000000000000000000000000000000 --- a/en/device-dev/subsystems/subsys-data.md +++ /dev/null @@ -1,4 +0,0 @@ -# Data Management - -- **[RDB](subsys-data-relational-database.md)** -- **[Lightweight Data Store](subsys-data-storage.md)** diff --git a/en/device-dev/subsystems/subsys-dfx-hisysevent.md b/en/device-dev/subsystems/subsys-dfx-hisysevent.md deleted file mode 100644 index 86ceb227152ca26ec2c50a9be11d7c15b9be6adf..0000000000000000000000000000000000000000 --- a/en/device-dev/subsystems/subsys-dfx-hisysevent.md +++ /dev/null @@ -1,15 +0,0 @@ -# HiSysEvent Development - -- **[HiSysEvent Overview](subsys-dfx-hisysevent-overview.md)** - -- **[HiSysEvent Logging Configuration](subsys-dfx-hisysevent-logging-config.md)** - -- **[HiSysEvent Logging](subsys-dfx-hisysevent-logging.md)** - -- **[HiSysEvent Listening](subsys-dfx-hisysevent-listening.md)** - -- **[HiSysEvent Query](subsys-dfx-hisysevent-query.md)** - -- **[HiSysEvent Tool Usage](subsys-dfx-hisysevent-tool.md)** - - diff --git a/en/device-dev/subsystems/subsys-dfx.md b/en/device-dev/subsystems/subsys-dfx.md deleted file mode 100644 index f01cb1eb3be14fb4a3519012fdbaf94599b82a0a..0000000000000000000000000000000000000000 --- a/en/device-dev/subsystems/subsys-dfx.md +++ /dev/null @@ -1,11 +0,0 @@ -# DFX Development Guide - -- **[DFX Overview](subsys-dfx-overview.md)** -- **[HiLog Development](subsys-dfx-hilog-rich.md)** -- **[HiLog_Lite Development](subsys-dfx-hilog-lite.md)** -- **[HiTrace Development](subsys-dfx-hitrace.md)** -- **[HiCollie Development](subsys-dfx-hicollie.md)** -- **[HiSysEvent Development](subsys-dfx-hisysevent.md)** -- **[HiDumper Development](subsys-dfx-hidumper.md)** -- **[HiChecker Development](subsys-dfx-hichecker.md)** -- **[Hiview Development](subsys-dfx-hiview.md)** diff --git a/en/device-dev/subsystems/subsys-graphics.md b/en/device-dev/subsystems/subsys-graphics.md deleted file mode 100644 index b687f2f46074750639367f99f76de6abb8c11063..0000000000000000000000000000000000000000 --- a/en/device-dev/subsystems/subsys-graphics.md +++ /dev/null @@ -1,13 +0,0 @@ -# Graphics - -- **[Graphics Overview](subsys-graphics-overview.md)** - -- **[Container Component Development](subsys-graphics-container-guide.md)** - -- **[Development of Layout Container Components](subsys-graphics-layout-guide.md)** - -- **[Common Component Development](subsys-graphics-common-guide.md)** - -- **[Animator Development](subsys-graphics-animation-guide.md)** - - diff --git a/en/device-dev/subsystems/subsys-multimedia-camera.md b/en/device-dev/subsystems/subsys-multimedia-camera.md deleted file mode 100644 index d98f596ccb6373eef7b306d15ad1d2bdebd75b00..0000000000000000000000000000000000000000 --- a/en/device-dev/subsystems/subsys-multimedia-camera.md +++ /dev/null @@ -1,11 +0,0 @@ -# Camera - -- **[Camera Overview](subsys-multimedia-camera-overview.md)** - -- **[Photographing Development](subsys-multimedia-camera-photo-guide.md)** - -- **[Video Recording Development](subsys-multimedia-camera-record-guide.md)** - -- **[Previewing Development](subsys-multimedia-camera-preview-guide.md)** - - diff --git a/en/device-dev/subsystems/subsys-multimedia-video.md b/en/device-dev/subsystems/subsys-multimedia-video.md deleted file mode 100644 index c1ef1b3965da35d397c3ff3a3dc7bbb324e660dd..0000000000000000000000000000000000000000 --- a/en/device-dev/subsystems/subsys-multimedia-video.md +++ /dev/null @@ -1,9 +0,0 @@ -# Audio/Video - -- **[Audio/Video Overview](subsys-multimedia-video-overview.md)** - -- **[Audio/Video Playback Development](subsys-multimedia-video-play-guide.md)** - -- **[Audio/Video Recording Development](subsys-multimedia-video-record-guide.md)** - - diff --git a/en/device-dev/subsystems/subsys-multimedia.md b/en/device-dev/subsystems/subsys-multimedia.md deleted file mode 100644 index c4b8f72b08f658c27e999c81452c400e0403018b..0000000000000000000000000000000000000000 --- a/en/device-dev/subsystems/subsys-multimedia.md +++ /dev/null @@ -1,7 +0,0 @@ -# Multimedia - -- **[Camera](subsys-multimedia-camera.md)** - -- **[Audio/Video](subsys-multimedia-video.md)** - - diff --git a/en/device-dev/subsystems/subsys-ota.md b/en/device-dev/subsystems/subsys-ota.md deleted file mode 100644 index cf835e028e0a171cc4a002ace3878cc130bb965b..0000000000000000000000000000000000000000 --- a/en/device-dev/subsystems/subsys-ota.md +++ /dev/null @@ -1,5 +0,0 @@ -# Update - - - -- **[OTA Update](subsys-ota-guide.md)** \ No newline at end of file diff --git a/en/device-dev/subsystems/subsys-security.md b/en/device-dev/subsystems/subsys-security.md deleted file mode 100644 index 7658eee732e6120279604ff10f5132c8d12fca95..0000000000000000000000000000000000000000 --- a/en/device-dev/subsystems/subsys-security.md +++ /dev/null @@ -1,12 +0,0 @@ -# Security - -- **[Security Overview](subsys-security-overview.md)** - -- **[Development on Application Signature Verification](subsys-security-sigverify.md)** - -- **[Development on Application Permission Management](subsys-security-rightmanagement.md)** - -- **[Development on IPC Authentication](subsys-security-communicationverify.md)** - -- **[Development on Device Security Level Management](subsys-security-devicesecuritylevel.md)** - diff --git a/en/device-dev/subsystems/subsys-sensor.md b/en/device-dev/subsystems/subsys-sensor.md deleted file mode 100644 index 86091571411176655cfb29452781d01ee5e70c32..0000000000000000000000000000000000000000 --- a/en/device-dev/subsystems/subsys-sensor.md +++ /dev/null @@ -1,9 +0,0 @@ -# Sensor - -- **[Sensor Overview](subsys-sensor-overview.md)** - -- **[Sensor Usage Guidelines](subsys-sensor-guide.md)** - -- **[Sensor Usage Example](subsys-sensor-demo.md)** - - diff --git a/en/device-dev/subsystems/subsys-testguide-envbuild.md b/en/device-dev/subsystems/subsys-testguide-envbuild.md deleted file mode 100644 index 515d55a4f3d2c1e01f3bc0e660b07fa2b7b1fe55..0000000000000000000000000000000000000000 --- a/en/device-dev/subsystems/subsys-testguide-envbuild.md +++ /dev/null @@ -1,81 +0,0 @@ -# Setting Up the Environment - -## Basic Test Framework Environment - -| Environment | Operating System | Linux Extended Component | Python | Python Plug-ins | NFS Server | HDC | -| ------------ | ------------ | ------------ | ------------ | ------------ | ------------ | ------------ | -| Version | Ubuntu 18.04 or later | libreadline-dev | 3.7.5 or later | - pySerial 3.3 or later
- Paramiko 2.7.1 or later
- Setuptools 40.8.0 or later
- rsa4.0 or later | haneWIN NFS Server 1.2.50 or later, or NFS v4 or later | 1.1.0 or later | -| Description | Provides code build environment. | Plug-in used to read commands. | Language used by the test framework. | - pySerial: supports Python serial port communication.
- Paramiko: allows Python to use SSH.
- Setuptools: allows Python packages to be created and distributed easily.
- rsa: implements RSA encryption in Python. | Enables devices to be connected through the serial port. | A tool that enables devices to be connected through the HarmonyOS Device Connector (HDC). | - -## Installation Process -1. Run the following command to install the Linux extended component libreadline: - ``` - sudo apt-get install libreadline-dev - ``` - The installation is successful if the following information is displayed: - ``` - Reading package lists... Done - Building dependency tree - Reading state information... Done - libreadline-dev is already the newest version (7.0-3). - 0 upgraded, 0 newly installed, 0 to remove and 11 not upgraded. - ``` -2. Run the following command to install the Setuptools plug-in: - ``` - pip3 install setuptools - ``` - The installation is successful if the following information is displayed: - ``` - Requirement already satisfied: setuptools in d:\programs\python37\lib\site-packages (41.2.0) - ``` -3. Run the following command to install the Paramiko plug-in: - ``` - pip3 install paramiko - ``` - The installation is successful if the following information is displayed: - ``` - Installing collected packages: pycparser, cffi, pynacl, bcrypt, cryptography, paramiko - Successfully installed bcrypt-3.2.0 cffi-1.14.4 cryptography-3.3.1 paramiko-2.7.2 pycparser-2.20 pynacl-1.4.0 - ``` -4. Run the following command to install the ras plug-in: - ``` - pip3 install rsa - ``` - The installation is successful if the following information is displayed: - ``` - Installing collected packages: pyasn1, rsa - Successfully installed pyasn1-0.4.8 rsa-4.7 - ``` -5. Run the following command to install the pySerial plug-in: - ``` - pip3 install pyserial - ``` - The installation is successful if the following information is displayed: - ``` - Requirement already satisfied: pyserial in d:\programs\python37\lib\site-packages\pyserial-3.4-py3.7.egg (3.4) - ``` -6. Install the NFS server if the device outputs results only through the serial port. - - In Windows, install, for example, haneWIN NFS Server 1.2.50. - - In Linux, run the following command to install the NFS server: - ``` - sudo apt install nfs-kernel-server - ``` - The installation is successful if the following information is displayed: - ``` - Reading package lists... Done - Building dependency tree - Reading state information... Done - nfs-kernel-server is already the newest version (1:1.3.4-2.1ubuntu5.3). - 0 upgraded, 0 newly installed, 0 to remove and 11 not upgraded. - ``` -7. Install the HDC tool if the device supports HDC connections. For details about the installation process, see [Readme](https://gitee.com/openharmony/developtools_hdc_standard/blob/master/README.md). - - -## Checking the Environment - - | Check Item | Operation | Expected Result | - | --- | --- | --- | - | Whether Python is successfully installed | Run the **python --version** command. | The Python version is 3.7.5 or later. | - | Whether Python plug-ins are successfully installed | Go to the **test/developertest** directory and run **start.bat** or **start.sh**. | The **>>>** prompt is displayed. | - | NFS server status (for the devices that support only serial port output) | Log in to the development board through the serial port and run the **mount** command to mount the NFS. | The file directory can be mounted. | - | Whether HDC tool is successfully installed | Run the **hdc_std -v** command. | The HDC version is 1.1.0 or later. | diff --git a/en/device-dev/subsystems/subsys-toolchain.md b/en/device-dev/subsystems/subsys-toolchain.md deleted file mode 100644 index ebb14d2e60dc493893241f8d308df7c8a8d93deb..0000000000000000000000000000000000000000 --- a/en/device-dev/subsystems/subsys-toolchain.md +++ /dev/null @@ -1,9 +0,0 @@ -# R&D Tools - -- **[bytrace](subsys-toolchain-bytrace-guide.md)** - -- **[hdc\_std](subsys-toolchain-hdc-guide.md)** - -- **[hiperf](subsys-toolchain-hiperf.md)** - - diff --git a/en/device-dev/subsystems/subsys-usbservice.md b/en/device-dev/subsystems/subsys-usbservice.md deleted file mode 100644 index 9369d067cb3d73b3a9b074e4fc7c383b0bea429e..0000000000000000000000000000000000000000 --- a/en/device-dev/subsystems/subsys-usbservice.md +++ /dev/null @@ -1,8 +0,0 @@ -# USB - -- **[USB Overview](subsys-usbservice-overview.md)** - -- **[USB Usage Guidelines](subsys-usbservice-guide.md)** - -- **[USB Usage Example](subsys-usbservice-demo.md)** - diff --git a/en/device-dev/subsystems/subsys-utils.md b/en/device-dev/subsystems/subsys-utils.md deleted file mode 100644 index 96b98bfb785eb0dbfca81f57ad9242fa7dd3f41e..0000000000000000000000000000000000000000 --- a/en/device-dev/subsystems/subsys-utils.md +++ /dev/null @@ -1,9 +0,0 @@ -# Utils - -- **[Utils Overview](subsys-utils-overview.md)** - -- **[Utils Development](subsys-utils-guide.md)** - -- **[Utils FAQ](subsys-utils-faqs.md)** - - diff --git a/en/device-dev/subsystems/subsys.md b/en/device-dev/subsystems/subsys.md deleted file mode 100644 index 7eb175c7a40640aae1e0bc1de699179be0e91b23..0000000000000000000000000000000000000000 --- a/en/device-dev/subsystems/subsys.md +++ /dev/null @@ -1,22 +0,0 @@ -# Subsystem Development Guidelines - -- **[Compilation and Building](subsys-build.md)** -- **[Distributed Remote Startup](subsys-remote-start.md)** -- **[Graphics](subsys-graphics.md)** -- **[Multimedia](subsys-multimedia.md)** -- **[Utils](subsys-utils.md)** -- **[AI Framework](subsys-aiframework.md)** -- **[Data Management](subsys-data.md)** -- **[Sensor](subsys-sensor.md)** -- **[USB](subsys-usbservice.md)** -- **[Application Framework](subsys-application-framework.md)** -- **[OTA Updade](subsys-ota-guide.md)** -- **[Telephony](subsys-tel.md)** -- **[Security](subsys-security.md)** -- **[Startup](subsys-boot.md)** -- **[Test Case Development](subsys-testguide-test.md)** -- **[DFX](subsys-dfx.md)** -- **[R&D Tools](subsys-toolchain.md)** -- **[XTS Test Case Development](subsys-xts-guide.md)** - - diff --git a/zh-cn/application-dev/device/vibrator-overview.md b/zh-cn/application-dev/device/vibrator-overview.md index 037b8bb8326494541b632d14293fcb515ab0f899..11cec9fdec7c7cd0745edddb3e4a9f390fe78daf 100644 --- a/zh-cn/application-dev/device/vibrator-overview.md +++ b/zh-cn/application-dev/device/vibrator-overview.md @@ -1,7 +1,7 @@ # Vibrator开发概述 -马达振动服务最大化开放硬工最新马达器件能力，通过拓展原生马达服务实现振动与交互融合设计，打造细腻精致的一体化振动体验和差异化体验，提升用户交互效率和易用性、提升用户体验、增强品牌竞争力。 +振动器模块服务最大化开放硬工最新马达器件能力，通过拓展原生马达服务实现振动与交互融合设计，打造细腻精致的一体化振动体验和差异化体验，提升用户交互效率和易用性、提升用户体验、增强品牌竞争力。 ## 运作机制 @@ -23,7 +23,7 @@ Vibrator属于控制类小器件，主要包含以下四个模块：Vibrator API ## 约束与限制 -在使用振动器时，开发者需要配置请求振动器的权限ohos.permission.VIBRATE，才能控制振动器振动，敏感级别是system_grant。 +在使用振动器时，开发者需要配置请求振动器的权限ohos.permission.VIBRATE，才能控制振动器振动，权限类型是system_grant。 diff --git a/zh-cn/application-dev/faqs/faqs-hdc-std.md b/zh-cn/application-dev/faqs/faqs-hdc-std.md index 90f627289b2fcefa4d9e62d23249f22ed7e597c2..5caf5db008a993bca4cbeb8e49f0e0495d716f05 100644 --- a/zh-cn/application-dev/faqs/faqs-hdc-std.md +++ b/zh-cn/application-dev/faqs/faqs-hdc-std.md @@ -36,7 +36,7 @@ 适用于：OpenHarmony SDK 3.2.2.5版本 -日志打印的长度限制为1024，该长度不能配置。 +日志打印的长度限制为1024个字符，该长度不能配置。 ## 为什么有时候直接用IDE安装HAP包到开发板上无法打开？ diff --git a/zh-cn/application-dev/reference/Readme-CN.md b/zh-cn/application-dev/reference/Readme-CN.md index 62258182f16f280828c947c9ed7173d1a4acdd5d..27ce7a0cce45404b3d438ced0b06efab69d88310 100644 --- a/zh-cn/application-dev/reference/Readme-CN.md +++ b/zh-cn/application-dev/reference/Readme-CN.md @@ -1,7 +1,7 @@ # 开发参考 -- [组件参考（基于TS扩展的声明式开发范式）](arkui-ts/Readme-CN.md) -- [组件参考（基于JS扩展的类Web开发范式）](arkui-js/Readme-CN.md) +- [组件参考（基于eTS的声明式开发范式）](arkui-ts/Readme-CN.md) +- [组件参考（兼容JS的类Web开发范式）](arkui-js/Readme-CN.md) - [JS服务卡片UI组件参考](js-service-widget-ui/Readme-CN.md) - [接口参考（JS及TS API）](apis/Readme-CN.md) - 接口参考（Native API） diff --git a/zh-cn/application-dev/reference/apis/js-apis-Context.md b/zh-cn/application-dev/reference/apis/js-apis-Context.md index 2de7d3aa4e6ce916921035329f2d623df5ff4308..9e171c87d7a9bf5342a08558ec1a46d724034888 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-Context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-Context.md @@ -381,6 +381,53 @@ context.getDisplayOrientation().then((data) => { }); ``` +## Context.getExternalCacheDir + +getExternalCacheDir(callback: AsyncCallback\): void + +获取应用程序的外部缓存目录（callback形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**参数：** + +| 名称 | 类型 | 必填 | 描述 | +| -------- | ---------------------- | ---- | ------------------ | +| callback | AsyncCallback\ | 是 | 返回应用程序的缓存目录的绝对路径。 | + +**示例：** + +```js +import featureAbility from '@ohos.ability.featureAbility' +var context = featureAbility.getContext(); +context.getExternalCacheDir() +``` + +## Context.getExternalCacheDir + +getExternalCacheDir(): Promise\; + +获取应用程序的外部缓存目录（Promise形式）。 + +**系统能力**：SystemCapability.Ability.AbilityRuntime.Core + +**返回值：** + +| 类型 | 说明 | +| ---------------- | ---------------- | +| Promise\ | 返回应用程序的缓存目录的绝对路径。 | + +**示例：** + +```js +import featureAbility from '@ohos.ability.featureAbility' +var context = featureAbility.getContext(); +context.getExternalCacheDir().then((data) => { + console.info("=======================>getExternalCacheDirCallback====================>"); + console.info("====>data====>" + JSON.stringify(data)); +}); +``` + ## Context.setDisplayOrientation7+ setDisplayOrientation(orientation: bundle.DisplayOrientation, callback: AsyncCallback\): void diff --git a/zh-cn/application-dev/reference/apis/js-apis-ability-context.md b/zh-cn/application-dev/reference/apis/js-apis-ability-context.md index 5bb428a86275353ab74e07a3da62b3ba44042ea4..8674ffeb9f72848b6c613ee44cc6abd0b694761b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-ability-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-ability-context.md @@ -892,8 +892,6 @@ startAbilityByCall(want: Want): Promise<Caller>; **系统能力**：SystemCapability.Ability.AbilityRuntime.Core -**系统API**: 此接口为系统接口，三方应用不支持调用。 - **参数：** | 参数名 | 类型 | 必填 | 说明 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-abilityAccessCtrl.md b/zh-cn/application-dev/reference/apis/js-apis-abilityAccessCtrl.md index 6cb15cdf4dda6a8b80da4f7427cba9f478a8a994..d5549075d11ae8e723c1c462a2f55c8aa564c9f2 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-abilityAccessCtrl.md +++ b/zh-cn/application-dev/reference/apis/js-apis-abilityAccessCtrl.md @@ -94,7 +94,7 @@ verifyAccessTokenSync(tokenID: number, permissionName: string): GrantStatus ```js var AtManager = abilityAccessCtrl.createAtManager(); let tokenID = 0; -let data = verifyAccessTokenSync(tokenID, "ohos.permission.GRANT_SENSITIVE_PERMISSIONS"); +let data = AtManager.verifyAccessTokenSync(tokenID, "ohos.permission.GRANT_SENSITIVE_PERMISSIONS"); console.log(`data->${JSON.stringify(data)}`); ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-Want.md b/zh-cn/application-dev/reference/apis/js-apis-application-Want.md index 883e6fdf83a770448c4a2e893c14f1eb098d9f17..be3a1a0272edf7872b269db394cf6e77c87614f0 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-Want.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-Want.md @@ -49,6 +49,7 @@ import Want from '@ohos.application.Want'; - 传递FD数据，FD表示文件描述符(FileDescriptor) ``` js + import fileio from '@ohos.fileio'; var fd; try { fd = fileio.openSync("/data/storage/el2/base/haps/pic.png"); @@ -59,9 +60,9 @@ import Want from '@ohos.application.Want'; "deviceId": "", // deviceId为空表示本设备 "bundleName": "com.extreme.test", "abilityName": "MainAbility", - "moduleName": "entry" // moduleName非必选 + "moduleName": "entry", // moduleName非必选 "parameters": { - "keyFd":{"type":"FD", "value":fd} + "keyFd":{"type":"FD", "value":fd} } }; this.context.startAbility(want, (error) => { diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-ability.md b/zh-cn/application-dev/reference/apis/js-apis-application-ability.md index 9ea16b8df6ed56218a5cb5e4301a172172b6ddaf..1c67e86ee5d26139313b32180d9beb9a54accbf1 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-ability.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-ability.md @@ -643,9 +643,8 @@ off(method: string): void; | 名称 | 参数类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | | (msg: string) | function | 是 | 否 | 调用者注册的侦听器函数接口的原型。 | - - ## CalleeCallBack +## CalleeCallBack (indata: rpc.MessageParcel): rpc.Sequenceable; diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilitystage.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilitystage.md index 54c2890308c248c6506851a1e0afcd17cfee4fd1..6e9cbe21f860a5189c93308e6818c9b43127450c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilitystage.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilitystage.md @@ -96,7 +96,7 @@ onMemoryLevel(level: AbilityConstant.MemoryLevel): void; 当系统已决定调整内存时调用。例如，当该功能在后台运行时，没有足够的内存来运行尽可能多的后台进程时可以使用。 -**系统能力**：SystemCapability.Ability.AbilityRuntime.Core +**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore **参数：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-appmanager.md b/zh-cn/application-dev/reference/apis/js-apis-appmanager.md index 818145a800a81e9c69e271a97c4a32f1eb832056..0bb9cf1c93ee5f3058366761ae0e2dd576b656f6 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-appmanager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-appmanager.md @@ -185,14 +185,12 @@ getProcessRunningInfos(): Promise\>; ## appManager.getProcessRunningInfos(deprecated) -> **说明：** -> -> 从 API Version 9 开始废弃，建议使用[appManager.getProcessRunningInformation9+](#appmanagergetprocessrunninginformation9-1)替代。 - getProcessRunningInfos(callback: AsyncCallback\>): void; 获取有关运行进程的信息。 +> 从 API Version 9 开始废弃，建议使用[appManager.getProcessRunningInformation9+](#appmanagergetprocessrunninginformation9-1)替代。 + **需要权限**：ohos.permission.GET_RUNNING_INFO **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -706,9 +704,14 @@ onForegroundApplicationChanged(appStateData: AppStateData): void; **示例：** ```js -import ApplicationStateObserver from '@ohos.application.ApplicationStateObserver' -const foregroundApplicationInfo = ApplicationStateObserver.onForegroundApplicationChanged(); -console.log('-------- foregroundApplicationInfo: ---------', foregroundApplicationInfo); + var applicationStateObserver = { + onForegroundApplicationChanged(appStateData) { + console.log('------------ onForegroundApplicationChanged -----------', appStateData); + } + } + const observerCode = app.registerApplicationStateObserver(applicationStateObserver); + console.log('-------- observerCode: ---------', observerCode); + ``` ## ApplicationStateObserver.onAbilityStateChanged8+ @@ -730,9 +733,13 @@ onAbilityStateChanged(abilityStateData: AbilityStateData): void; **示例：** ```js -import ApplicationStateObserver from '@ohos.application.ApplicationStateObserver' -const abilityStateChangedInfo = ApplicationStateObserver.onAbilityStateChanged(); -console.log('-------- abilityStateChangedInfo: ---------', abilityStateChangedInfo); + var applicationStateObserver = { + onAbilityStateChanged(abilityStateData) { + console.log('------------ onAbilityStateChanged -----------', abilityStateData); + } + } + const observerCode = app.registerApplicationStateObserver(applicationStateObserver); + console.log('-------- observerCode: ---------', observerCode); ``` ## ApplicationStateObserver.onProcessCreated8+ @@ -754,9 +761,13 @@ onProcessCreated(processData: ProcessData): void; **示例：** ```js -import ApplicationStateObserver from '@ohos.application.ApplicationStateObserver' -const processCreatedInfo = ApplicationStateObserver.onProcessCreated(); -console.log('-------- processCreatedInfo: ---------', processCreatedInfo); + var applicationStateObserver = { + onProcessCreated(processData) { + console.log('------------ onProcessCreated -----------', processData); + } + } + const observerCode = app.registerApplicationStateObserver(applicationStateObserver); + console.log('-------- observerCode: ---------', observerCode); ``` ## ApplicationStateObserver.onProcessDied8+ @@ -778,9 +789,13 @@ onProcessDied(processData: ProcessData): void; **示例：** ```js -import ApplicationStateObserver from '@ohos.application.ApplicationStateObserver' -const processDiedInfo = ApplicationStateObserver.onProcessDied(); -console.log('-------- processDiedInfo: ---------', processDiedInfo); + var applicationStateObserver = { + onProcessDied(processData) { + console.log('------------ onProcessDied -----------', processData); + } + } + const observerCode = app.registerApplicationStateObserver(applicationStateObserver); + console.log('-------- observerCode: ---------', observerCode); ``` ## AppStateData diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-rdb.md b/zh-cn/application-dev/reference/apis/js-apis-data-rdb.md index 94e9b093900c49079f2abec3e041217170f46f70..39465f70542b10799dcac16ccfe566fe8d989cc1 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-data-rdb.md +++ b/zh-cn/application-dev/reference/apis/js-apis-data-rdb.md @@ -2375,7 +2375,7 @@ try { | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | name | string | 是 | 数据库文件名。 | -| encrypt | boolean | 否 | 指定数据库是否加密。
true:加密。
false:非加密。 | +| encrypt9+ | boolean | 否 | 指定数据库是否加密。
true:加密。
false:非加密。 | ## ValueType diff --git a/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md b/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md index f9e481726f7441b1a2cbd9e407ab3e785d4e441e..d0c2b246541d3416a2aab075ee9bdf92e84592fb 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md +++ b/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md @@ -560,7 +560,7 @@ try { on(event: 'distributedDataServiceDie', deathCallback: Callback<void>): void -订阅服务状态变更通知。 +订阅服务状态变更通知，此方法为同步方法。 **系统能力：** SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。 @@ -592,7 +592,7 @@ try { off(event: 'distributedDataServiceDie', deathCallback?: Callback<void>): void -取消订阅服务状态变更通知。 +取消订阅服务状态变更通知，此方法为同步方法。 **系统能力：** SystemCapability.DistributedDataManager.KVStore.DistributedKVStore。 @@ -2584,7 +2584,7 @@ try { on(event: 'dataChange', type: SubscribeType, listener: Callback<ChangeNotification>): void -订阅指定类型的数据变更通知。 +订阅指定类型的数据变更通知，此方法为同步方法。 **系统能力：** SystemCapability.DistributedDataManager.KVStore.Core @@ -2610,7 +2610,7 @@ kvStore.on('dataChange', distributedData.SubscribeType.SUBSCRIBE_TYPE_LOCAL, fun on(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>>): void -订阅同步完成事件回调通知。 +订阅同步完成事件回调通知，此方法为同步方法。 **系统能力：** SystemCapability.DistributedDataManager.KVStore.Core @@ -2634,7 +2634,7 @@ kvStore.on('syncComplete', function (data) { off(event:'dataChange', listener?: Callback<ChangeNotification>): void -取消订阅数据变更通知。 +取消订阅数据变更通知，此方法为同步方法。 **系统能力：** SystemCapability.DistributedDataManager.KVStore.Core @@ -2670,7 +2670,7 @@ class KvstoreModel { off(event: 'syncComplete', syncCallback?: Callback<Array<[string, number]>>): void -取消订阅数据变更通知，此方法为同步方法。 +取消订阅同步完成事件回调通知，此方法为同步方法。 **系统能力：** SystemCapability.DistributedDataManager.KVStore.Core @@ -4271,7 +4271,7 @@ try { on(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>>): void -订阅同步完成事件回调通知。 +订阅同步完成事件回调通知，此方法为同步方法。 **系统能力：** SystemCapability.DistributedDataManager.KVStore.Core @@ -4307,7 +4307,7 @@ try { off(event: 'syncComplete', syncCallback?: Callback<Array<[string, number]>>): void -取消订阅同步完成事件回调通知。 +取消订阅同步完成事件回调通知，此方法为同步方法。 **系统能力：** SystemCapability.DistributedDataManager.KVStore.Core @@ -5781,7 +5781,7 @@ try { on(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>>): void -订阅同步完成事件回调通知。 +订阅同步完成事件回调通知，此方法为同步方法。 **系统能力：** SystemCapability.DistributedDataManager.KVStore.Core @@ -5817,7 +5817,7 @@ try { off(event: 'syncComplete', syncCallback?: Callback<Array<[string, number]>>): void -取消订阅同步完成事件回调通知，该方法为同步方法。 +取消订阅同步完成事件回调通知，此方法为同步方法。 **系统能力：** SystemCapability.DistributedDataManager.KVStore.Core diff --git a/zh-cn/application-dev/reference/apis/js-apis-errorManager.md b/zh-cn/application-dev/reference/apis/js-apis-errorManager.md index ac6596cf75d20f9e9aa49c334d63fb27c86505bf..73d79b3ba240ba718959e8bc8175a3142c884a53 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-errorManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-errorManager.md @@ -33,8 +33,7 @@ var observer = { console.log('onUnhandledException, errorMsg: ', errorMsg) } } -const registerErrorObserverNumber=errorManager.registerErrorObserver(observer) -console.info(registerErrorObserverNumber) +errorManager.registerErrorObserver(observer) ``` ## ErrorManager.unregisterErrorObserver @@ -123,11 +122,4 @@ var observer = { } } errorManager.registerErrorObserver(observer) - .then((data) => { - console.log('----------- registerErrorObserver success ----------', data); - }) - .catch((err) => { - console.log('----------- registerErrorObserver fail ----------', err); - }) - ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-formInfo.md b/zh-cn/application-dev/reference/apis/js-apis-formInfo.md index 249a408bac7708185457b6c4e6d12699998c48a5..6fc8f00410f67684418c1faf0aee73293fa38ad5 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-formInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-formInfo.md @@ -105,7 +105,7 @@ import formInfo from '@ohos.application.formInfo'; | TEMPORARY_KEY | "ohos.extra.param.key.form_temporary" | 临时卡片。 | | ABILITY_NAME_KEY9+ | "ohos.extra.param.key.ability_name" | ability名称 | | DEVICE_ID_KEY9+ | "ohos.extra.param.key.device_id" | 设备标识。
此接口为系统接口。 | -| BUNDLE_NAME_KEY9+ | "ohos.extra.param.key.bundle_name" | 指示指定要获取的捆绑包名称的键。
此接口为系统接口。 | +| BUNDLE_NAME_KEY9+ | "ohos.extra.param.key.bundle_name" | 指示指定要获取的捆绑包名称的键。| ## FormDimension diff --git a/zh-cn/application-dev/reference/apis/js-apis-privacyManager.md b/zh-cn/application-dev/reference/apis/js-apis-privacyManager.md index 1ce771ed898e26668d9ccf7ef5dc7e9a3659f29e..edb3da9da7f38b0bfac435671a7623c8c9edc688 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-privacyManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-privacyManager.md @@ -42,6 +42,12 @@ addPermissionUsedRecord(tokenID: number, permissionName: string, successCount: n **示例：** ```js +import bundle from '@ohos.bundle'; +import privacyManager from '@ohos.privacyManager'; + +let bundleName = "com.ohos.permissionmanager"; // change to your bundle name +let appInfo = await bundle.getApplicationInfo(bundleName, 16); // need async type function + var tokenID = appInfo.accessTokenId; // 可以通过getApplicationInfo获取accessTokenId privacyManager.addPermissionUsedRecord(tokenID, "ohos.permission.PERMISSION_USED_STATS", 1, 0).then(data => { console.log(`promise: data->${JSON.stringify(data)}`); @@ -72,8 +78,14 @@ addPermissionUsedRecord(tokenID: number, permissionName: string, successCount: n **示例：** ```js +import bundle from '@ohos.bundle'; +import privacyManager from '@ohos.privacyManager'; + +let bundleName = "com.ohos.permissionmanager"; // change to your bundle name +let appInfo = await bundle.getApplicationInfo(bundleName, 16); // need async type function + var tokenID = appInfo.accessTokenId; // 可以通过getApplicationInfo获取accessTokenId -privacyManager.privacyManager.addPermissionUsedRecord(tokenID, "ohos.permission.PERMISSION_USED_STATS", 1, 0, (err, data) => { +privacyManager.addPermissionUsedRecord(tokenID, "ohos.permission.PERMISSION_USED_STATS", 1, 0, (err, data) => { console.log(`callback: data->${JSON.stringify(data)}`); }); ``` @@ -105,10 +117,10 @@ getPermissionUsedRecords(request: PermissionUsedRequest): Promise<PermissionU ```js let request = { "tokenId": 1, - "isRemote": 1, + "isRemote": false, "deviceId": "device", "bundleName": "bundle", - "permissionNames": 1, + "permissionNames": [], "beginTime": 0, "endTime": 1, "flag":privacyManager.PermissionUsageFlag.FLAG_PERMISSION_USAGE_DETAIL, @@ -140,10 +152,10 @@ getPermissionUsedRecords(request: PermissionUsedRequest, callback: AsyncCallback ```js let request = { "tokenId": 1, - "isRemote": 1, + "isRemote": false, "deviceId": "device", "bundleName": "bundle", - "permissionNames": 1, + "permissionNames": [], "beginTime": 0, "endTime": 1, "flag":privacyManager.PermissionUsageFlag.FLAG_PERMISSION_USAGE_DETAIL, 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 a0fbe254c019fadee070f0eec5657ef79bd595b3..aeb56ea6f380e2daf696e872cb01514d167ead8c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-prompt.md +++ b/zh-cn/application-dev/reference/apis/js-apis-prompt.md @@ -21,28 +21,31 @@ showToast(options: ShowToastOptions): void **系统能力：** SystemCapability.ArkUI.ArkUI.Full **参数：** + | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------------------------- | ---- | ------- | | options | [ShowToastOptions](#showtoastoptions) | 是 | 文本弹窗选项。 | **示例：** - ```js + +```js prompt.showToast({ message: 'Message Info', duration: 2000, }); - ``` +``` + ## ShowToastOptions 文本提示框的选项。 -**系统能力：** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full。 +**系统能力：** SystemCapability.ArkUI.ArkUI.Full。 -| 名称 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------------- | ------ | ---------------------------------------- | -| message | string\| [Resource](../../ui/ts-types.md#resource类型)9+ | 是 | 显示的文本信息。 | -| duration | number | 否 | 默认值1500ms，取值区间：1500ms-10000ms。若小于1500ms则取默认值，若大于10000ms则取上限值10000ms。 | -| bottom | string\| number | 否 | 设置弹窗边框距离屏幕底部的位置。 | +| 名称 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ---------------------------------------- | +| message | string\| [Resource](../../ui/ts-types.md#resource类型)9+ | 是 | 显示的文本信息。 | +| duration | number | 否 | 默认值1500ms，取值区间：1500ms-10000ms。若小于1500ms则取默认值，若大于10000ms则取上限值10000ms。 | +| bottom | string\| number | 否 | 设置弹窗边框距离屏幕底部的位置。 | ## prompt.showDialog @@ -50,9 +53,10 @@ showDialog(options: ShowDialogOptions): Promise<ShowDialogSuccessResponse> 创建并显示对话框，对话框响应后同步返回结果。 -**系统能力：** SystemCapability.ArkUI.ArkUI.Full +**系统能力：** SystemCapability.ArkUI.ArkUI.Full **参数：** + | 参数名 | 类型 | 必填 | 说明 | | ------- | --------------------------------------- | ---- | ------ | | options | [ShowDialogOptions](#showdialogoptions) | 是 | 对话框选项。 | @@ -65,7 +69,7 @@ showDialog(options: ShowDialogOptions): Promise<ShowDialogSuccessResponse> **示例：** - ```js +```js prompt.showDialog({ title: 'Title Info', message: 'Message Info', @@ -86,7 +90,7 @@ prompt.showDialog({ .catch(err => { console.info('showDialog error: ' + err); }) - ``` +``` ## prompt.showDialog @@ -94,17 +98,18 @@ showDialog(options: ShowDialogOptions, callback: AsyncCallback<ShowDialogSucc 创建并显示对话框，对话框响应结果异步返回。 -**系统能力：** SystemCapability.ArkUI.ArkUI.Full - +**系统能力：** SystemCapability.ArkUI.ArkUI.Full **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ------------ | | options | [ShowDialogOptions](#showdialogoptions) | 是 | 页面显示对话框信息描述。 | | callback | AsyncCallback<[ShowDialogSuccessResponse](#showdialogsuccessresponse)> | 是 | 对话框响应结果回调。 | **示例：** - ```js + +```js prompt.showDialog({ title: 'showDialog Title Info', message: 'Message Info', @@ -125,13 +130,13 @@ prompt.showDialog({ } console.info('showDialog success callback, click button: ' + data.index); }); - ``` +``` ## ShowDialogOptions 对话框的选项。 -**系统能力：** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full。 +**系统能力：** SystemCapability.ArkUI.ArkUI.Full | 名称 | 类型 | 必填 | 说明 | | ------- | ---------------------------------------- | ---- | ---------------------------------------- | @@ -143,7 +148,7 @@ prompt.showDialog({ 对话框的响应结果。 -**系统能力：** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full。 +**系统能力：** SystemCapability.ArkUI.ArkUI.Full | 名称 | 类型 | 说明 | | ----- | ------ | ------------------- | @@ -159,6 +164,7 @@ showActionMenu(options: ActionMenuOptions, callback: AsyncCallback<ActionMenu **系统能力：** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full。 **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | --------- | | options | [ActionMenuOptions](#actionmenuoptions) | 是 | 操作菜单选项。 | @@ -166,7 +172,8 @@ showActionMenu(options: ActionMenuOptions, callback: AsyncCallback<ActionMenu **示例：** - ```js + +```js prompt.showActionMenu({ title: 'Title Info', buttons: [ @@ -186,7 +193,7 @@ prompt.showActionMenu({ } console.info('showActionMenu success callback, click button: ' + data.index); }) - ``` +``` ## prompt.showActionMenu @@ -197,17 +204,20 @@ showActionMenu(options: ActionMenuOptions): Promise<ActionMenuSuccessResponse **系统能力：** SystemCapability.ArkUI.ArkUI.Full **参数：** + | 参数名 | 类型 | 必填 | 说明 | | ------- | --------------------------------------- | ---- | ------- | | options | [ActionMenuOptions](#actionmenuoptions) | 是 | 操作菜单选项。 | **返回值：** + | 类型 | 说明 | | ---------------------------------------- | ------- | | Promise<[ActionMenuSuccessResponse](#actionmenusuccessresponse)> | 菜单响应结果。 | **示例：** - ```js + +```js prompt.showActionMenu({ title: 'showActionMenu Title Info', buttons: [ @@ -227,7 +237,7 @@ prompt.showActionMenu({ .catch(err => { console.info('showActionMenu error: ' + err); }) - ``` +``` ## ActionMenuOptions 操作菜单的选项。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-rpc.md b/zh-cn/application-dev/reference/apis/js-apis-rpc.md index 1eb6a3e5159ca9a3d190282fbe1524d06ab9c254..8788332775063deefb363aea6a45b6e25c064840 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-rpc.md +++ b/zh-cn/application-dev/reference/apis/js-apis-rpc.md @@ -66,7 +66,8 @@ writeRemoteObject(object: [IRemoteObject](#iremoteobject)): boolean **系统能力**：SystemCapability.Communication.IPC.Core **参数：** - | 参数名 | 类型 | 必填 | 说明 | + + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | object | [IRemoteObject](#iremoteobject) | 是 | 要序列化并写入MessageParcel的远程对象。 | @@ -156,7 +157,8 @@ writeInterfaceToken(token: string): boolean **系统能力**：SystemCapability.Communication.IPC.Core **参数：** - | 参数名 | 类型 | 必填 | 说明 | + + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | token | string | 是 | 字符串类型描述符。 | diff --git a/zh-cn/application-dev/reference/arkui-js/Readme-CN.md b/zh-cn/application-dev/reference/arkui-js/Readme-CN.md index 2a1209a974d273ca6187367ca3fa58cc981c5a10..c67743da8b03297fba24172d508281d34d56e64a 100644 --- a/zh-cn/application-dev/reference/arkui-js/Readme-CN.md +++ b/zh-cn/application-dev/reference/arkui-js/Readme-CN.md @@ -1,4 +1,4 @@ -# 基于JS扩展的类Web开发范式 +# 兼容JS的类Web开发范式 - 组件通用信息 - [通用属性](js-components-common-attributes.md) diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-basic-input.md b/zh-cn/application-dev/reference/arkui-js/js-components-basic-input.md index 4efc9f3778a084b4f6850f1a76d66d7f4737bbbb..3d08d858cdc7f5c54673e3d1755a9fdd42eced56 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-basic-input.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-basic-input.md @@ -64,7 +64,8 @@ 除支持[通用事件](../arkui-js/js-components-common-events.md)外，还支持如下事件： - 当input类型为text、email、date、time、number、password时，支持如下事件： - | 名称 | 参数 | 描述 | + + | 名称 | 参数 | 描述 | | ------------------------- | ---------------------------------------- | ---------------------------------------- | | change | {
 value: inputValue
 } | 输入框输入内容发生变化时触发该事件，返回用户当前输入值。
改变value属性值不会触发该回调。 | | enterkeyclick | {
 value: enterKey
 } | 软键盘enter键点击后触发该事件，返回enter按钮的类型，enterKey类型为number，可选值为：
- 2：设置enterkeytype属性为go时生效。
- 3：设置enterkeytype属性为search时生效。
- 4：设置enterkeytype属性为send时生效。
- 5：设置enterkeytype属性为next时生效。
- 6：不设置enterkeytype或者设置enterkeytype属性为default、done时生效。 | @@ -75,6 +76,7 @@ | selectchange6+ | {
start: number,
end: number
 } | 文本选择变化时触发事件。 | - 当input类型为checkbox、radio时，支持如下事件： + | 名称 | 参数 | 描述 | | ------ | ---------------------------------------- | ---------------------------------------- | | change | {
 checked:true \| false 
} | checkbox多选框或radio单选框的checked状态发生变化时触发该事件。 | 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 7e4751d2b207bc43d252d3a36e6dfdf6eea1d9d4..3c38f3db2dc824e700b7488b53373b5a83bc7ae1 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 @@ -171,7 +171,7 @@ + oncancel="textoncancel" class="pickertext"> diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-basic-web.md b/zh-cn/application-dev/reference/arkui-js/js-components-basic-web.md index 5940bde4373b66ee39032c4d3d3d0d3bdd642e47..e17335649e15e1536cde78ae8e78b62e83a3e850 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-basic-web.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-basic-web.md @@ -25,6 +25,7 @@ web组件不跟随转场动画。一个页面仅支持一个web组件。 ## 事件 仅支持如下事件： + | 名称 | 参数 | 描述 | | -------- | -------- | -------- | | pagestart | {url: string} | 加载网页时触发。 | @@ -33,6 +34,7 @@ web组件不跟随转场动画。一个页面仅支持一个web组件。 ## 方法 仅支持如下方法： + | 名称 | 参数 | 描述 | | -------- | -------- | -------- | | reload | - | 重新加载页面。 | diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-canvas-canvas.md b/zh-cn/application-dev/reference/arkui-js/js-components-canvas-canvas.md index b203a6f0b3bae39f606d9f806e4b5ae118a3632e..6715bc42fc91491db5d363173a0962962603faec 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-canvas-canvas.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-canvas-canvas.md @@ -42,6 +42,7 @@ getContext(type: '2d', options?: ContextAttrOptions): CanvasRendering2dContext 获取canvas绘图上下文。不支持在onInit和onReady中进行调用。 **参数：** + | 参数名 | 参数类型 | 必填 | 描述 | | -------------------- | ------------------ | ---- | ---------------------------------------- | | type | string | 是 | 设置为'2d'，返回值为2D绘制对象，该对象可用于在画布组件上绘制矩形、文本、图片等。 | @@ -54,6 +55,7 @@ getContext(type: '2d', options?: ContextAttrOptions): CanvasRendering2dContext | antialias | boolean | 是否开启抗锯齿功能，默认为false。 | **返回值：** + | 类型 | 说明 | | ---------------------------------------- | -------------------- | | [CanvasRenderingContext2D](../arkui-js/js-components-canvas-canvasrenderingcontext2d.md) | 用于在画布组件上绘制矩形、文本、图片等。 | @@ -65,12 +67,14 @@ toDataURL(type?: string, quality?: number): string 生成一个包含图片展示的URL。 **参数：** + | 参数名 | 参数类型 | 必填 | 描述 | | ------- | ------ | ---- | ---------------------------------------- | | type | string | 否 | 可选参数，用于指定图像格式，默认格式为image/png。 | | quality | number | 否 | 在指定图片格式为image/jpeg或image/webp的情况下，可以从0到1的区间内选择图片的质量。如果超出取值范围，将会使用默认值0.92。 | **返回值：** + | 类型 | 说明 | | ------ | --------- | | string | 图像的URL地址。 | diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-canvas-canvasgradient.md b/zh-cn/application-dev/reference/arkui-js/js-components-canvas-canvasgradient.md index a8b786f7d2b8bb5449a63effabe5d92533ff81e3..6f6a7992c56adb2b92150507c88dceefc647f313 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-canvas-canvasgradient.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-canvas-canvasgradient.md @@ -13,12 +13,14 @@ addColorStop(offset: number, color: string): void 设置渐变断点值，包括偏移和颜色。 **参数：** + | 参数 | 类型 | 描述 | | ------ | ------ | ---------------------------- | | offset | number | 设置渐变点距离起点的位置占总体长度的比例，范围为0到1。 | | color | string | 设置渐变的颜色。 | **示例：** + ```html
diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-canvas-canvasrenderingcontext2d.md b/zh-cn/application-dev/reference/arkui-js/js-components-canvas-canvasrenderingcontext2d.md index 51aa4618b3bd86def22292491ef4c056c513fb0f..f94a20bf5991f7dc4c8066278d687ee022540103 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-canvas-canvasrenderingcontext2d.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-canvas-canvasrenderingcontext2d.md @@ -380,6 +380,7 @@ export default { ### globalCompositeOperation 类型字段说明 + | 值 | 描述 | | ---------------- | ------------------------ | | source-over | 在现有绘制内容上显示新绘制内容，属于默认值。 | @@ -570,6 +571,7 @@ fillRect(x: number, y: number, width:number, height: number): void 填充一个矩形。 **参数：** + | 参数 | 类型 | 描述 | | ------ | ------ | ------------- | | x | number | 指定矩形左上角点的x坐标。 | @@ -606,6 +608,7 @@ clearRect(x: number, y: number, width:number, height: number): void 删除指定区域内的绘制内容。 **参数：** + | 参数 | 类型 | 描述 | | ------ | ------ | ------------- | | x | number | 指定矩形上的左上角x坐标。 | @@ -644,6 +647,7 @@ strokeRect(x: number, y: number, width:number, height: number): void 绘制具有边框的矩形，矩形内部不填充。 **参数：** + | 参数 | 类型 | 描述 | | ------ | ------ | ------------ | | x | number | 指定矩形的左上角x坐标。 | @@ -680,6 +684,7 @@ fillText(text: string, x: number, y: number): void 绘制填充类文本。 **参数：** + | 参数 | 类型 | 描述 | | ---- | ------ | --------------- | | text | string | 需要绘制的文本内容。 | @@ -715,6 +720,7 @@ strokeText(text: string, x: number, y: number): void 绘制描边类文本。 **参数：** + | 参数 | 类型 | 描述 | | ---- | ------ | --------------- | | text | string | 需要绘制的文本内容。 | @@ -750,11 +756,13 @@ measureText(text: string): TextMetrics 该方法返回一个文本测算的对象，通过该对象可以获取指定文本的宽度值。 **参数：** + | 参数 | 类型 | 描述 | | ---- | ------ | ---------- | | text | string | 需要进行测量的文本。 | **返回值：** + | 类型 | 说明 | | ----------- | -------------------------------------- | | TextMetrics | 包含指定字体的宽度，该宽度可以通过TextMetrics.width来获取。 | @@ -853,6 +861,7 @@ moveTo(x: number, y: number): void 路径从当前点移动到指定点。 **参数：** + | 参数 | 类型 | 描述 | | ---- | ------ | --------- | | x | number | 指定位置的x坐标。 | @@ -889,6 +898,7 @@ lineTo(x: number, y: number): void 从当前点到指定点进行路径连接。 **参数：** + | 参数 | 类型 | 描述 | | ---- | ------ | --------- | | x | number | 指定位置的x坐标。 | @@ -957,12 +967,14 @@ createPattern(image: Image, repetition: string): Object 通过指定图像和重复方式创建图片填充的模板。 **参数：** + | 参数 | 类型 | 描述 | | ---------- | ------ | ---------------------------------------- | | image | Image | 图源对象，具体参考[Image对象](../arkui-js/js-components-canvas-image.md)。 | | repetition | string | 设置图像重复的方式，取值为：'repeat'、'repeat-x'、 'repeat-y'、'no-repeat'。 | **返回值：** + | 类型 | 说明 | | ------ | ----------------- | | Object | 指定图像填充的Pattern对象。 | @@ -999,6 +1011,7 @@ bezierCurveTo(cp1x: number, cp1y: number, cp2x: number, cp2y: number, x: number, 创建三次贝赛尔曲线的路径。 **参数：** + | 参数 | 类型 | 描述 | | ---- | ------ | -------------- | | cp1x | number | 第一个贝塞尔参数的x坐标值。 | @@ -1039,6 +1052,7 @@ quadraticCurveTo(cpx: number, cpy: number, x: number, y: number): void 创建二次贝赛尔曲线的路径。 **参数：** + | 参数 | 类型 | 描述 | | ---- | ------ | ----------- | | cpx | number | 贝塞尔参数的x坐标值。 | @@ -1077,6 +1091,7 @@ arc(x: number, y: number, radius: number, startAngle: number, endAngle: number, 绘制弧线路径。 **参数：** + | 参数 | 类型 | 描述 | | ------------- | ------- | ---------- | | x | number | 弧线圆心的x坐标值。 | @@ -1116,6 +1131,7 @@ arcTo(x1: number, y1: number, x2: number, y2: number, radius: number): void 依据圆弧经过的点和圆弧半径创建圆弧路径。 **参数：** + | 参数 | 类型 | 描述 | | ------ | ------ | --------------- | | x1 | number | 圆弧经过的第一个点的x坐标值。 | @@ -1154,6 +1170,7 @@ ellipse(x: number, y: number, radiusX: number, radiusY: number, rotation: number 在规定的矩形区域绘制一个椭圆。 **参数：** + | 参数 | 类型 | 描述 | | ------------- | ------ | ------------------------------------ | | x | number | 椭圆圆心的x轴坐标。 | @@ -1195,6 +1212,7 @@ rect(x: number, y: number, width: number, height: number): void 创建矩形路径。 **参数：** + | 参数 | 类型 | 描述 | | ------ | ------ | ------------- | | x | number | 指定矩形的左上角x坐标值。 | @@ -1291,6 +1309,7 @@ rotate(rotate: number): void 针对当前坐标轴进行顺时针旋转。 **参数：** + | 参数 | 类型 | 描述 | | ------ | ------ | ---------------------------------------- | | rotate | number | 设置顺时针旋转的弧度值，可以通过Math.PI / 180将角度转换为弧度值。 | @@ -1324,6 +1343,7 @@ scale(x: number, y: number): void 设置canvas画布的缩放变换属性，后续的绘制操作将按照缩放比例进行缩放。 **参数：** + | 参数 | 类型 | 描述 | | ---- | ------ | ----------- | | x | number | 设置水平方向的缩放值。 | @@ -1366,6 +1386,7 @@ transform方法对应一个变换矩阵，想对一个图形进行变化的时 > - y' = skewX \* x + scaleY \* y + translateY **参数：** + | 参数 | 类型 | 描述 | | ---------- | ------ | -------- | | scaleX | number | 指定水平缩放值。 | @@ -1410,6 +1431,7 @@ setTransform(scaleX: number, skewX: number, skewY: number, scale: number, transl setTransfrom方法使用的参数和transform()方法相同，但setTransform()方法会重置现有的变换矩阵并创建新的变换矩阵。 **参数：** + | 参数 | 类型 | 描述 | | ---------- | ------ | -------- | | scaleX | number | 指定水平缩放值。 | @@ -1451,6 +1473,7 @@ translate(x: number, y: number): void 移动当前坐标系的原点。 **参数：** + | 参数 | 类型 | 描述 | | ---- | ------ | -------- | | x | number | 设置水平平移量。 | @@ -1486,12 +1509,14 @@ createPath2D(path: Path2D, cmds: string): Path2D 创建一个Path2D对象。 **参数：** + | 参数 | 类型 | 描述 | | ---- | ------ | -------------- | | path | Path2D | Path2D对象。 | | cmds | string | SVG的Path描述字符串。 | -**返回值：** +**返回值：** + [Path2D对象](../arkui-js/js-components-canvas-path2d.md) **示例：** @@ -1531,6 +1556,7 @@ drawImage(image: Image | PixelMap, sx: number, sy: number, sWidth: number, sHeig 进行图像绘制。 **参数：** + | 参数 | 类型 | 描述 | | ------- | ------------------------------ | ---------------------------------------- | | image | Image \| PixelMap9+ | 图片资源，请参考[Image对象](../arkui-js/js-components-canvas-image.md) 或[PixelMap对象](../apis/js-apis-image.md#pixelmap7)。 | @@ -1623,6 +1649,7 @@ createLinearGradient(x0: number, y0: number, x1: number, y1: number): Object 创建一个线性渐变色，返回CanvasGradient对象，请参考[CanvasGradient对象](../arkui-js/js-components-canvas-canvasgradient.md)。 **参数：** + | 参数 | 类型 | 描述 | | ---- | ------ | -------- | | x0 | number | 起点的x轴坐标。 | @@ -1631,6 +1658,7 @@ createLinearGradient(x0: number, y0: number, x1: number, y1: number): Object | y1 | number | 终点的y轴坐标。 | **返回值：** + | 类型 | 说明 | | ------ | ---------------------- | | Object | 返回创建的CanvasGradient对象。 | @@ -1672,6 +1700,7 @@ createRadialGradient(x0: number, y0: number, r0: number, x1: number, y1: number, 创建一个径向渐变色，返回CanvasGradient对象，请参考CanvasGradient **参数：** + | 参数 | 类型 | 描述 | | ---- | ------ | ----------------- | | x0 | number | 起始圆的x轴坐标。 | @@ -1682,6 +1711,7 @@ createRadialGradient(x0: number, y0: number, r0: number, x1: number, y1: number, | r1 | number | 终点圆的半径。必须为非负且有限的。 | **返回值：** + | 类型 | 说明 | | ------ | ---------------------- | | Object | 返回创建的CanvasGradient对象。 | @@ -1723,6 +1753,7 @@ createImageData(width: number, height: number, imageData: Object): Object 创建新的ImageData 对象，请参考[ImageData对象](../arkui-js/js-components-canvas-imagedata.md)。 **参数：** + | 参数 | 类型 | 描述 | | --------- | ------ | ----------------- | | width | number | ImageData的宽度。 | @@ -1730,6 +1761,7 @@ createImageData(width: number, height: number, imageData: Object): Object | imagedata | Object | 复制现有的ImageData对象。 | **返回值：** + | 类型 | 说明 | | ------ | ----------------- | | Object | 返回创建的ImageData对象。 | @@ -1761,6 +1793,7 @@ getImageData(sx: number, sy: number, sw: number, sh: number): Object 以当前canvas指定区域内的像素创建ImageData对象。 **参数：** + | 参数 | 类型 | 描述 | | ---- | ------ | --------------- | | sx | number | 需要输出的区域的左上角x坐标。 | @@ -1769,6 +1802,7 @@ getImageData(sx: number, sy: number, sw: number, sh: number): Object | sh | number | 需要输出的区域的高度。 | **返回值：** + | 类型 | 说明 | | ------ | ----------------------- | | Object | 返回包含指定区域像素的ImageData对象。 | @@ -1799,6 +1833,7 @@ putImageData(imageData: Object, dx: number, dy: number, dirtyX: number, dirtyY: 使用ImageData数据填充新的矩形区域。 **参数：** + | 参数 | 类型 | 描述 | | ----------- | ------ | ----------------------------- | | imagedata | Object | 包含像素值的ImageData对象。 | @@ -1885,6 +1920,7 @@ setLineDash(segments: Array): void 设置画布的虚线样式。 **参数：** + | 参数 | 类型 | 描述 | | -------- | ----- | -------------------- | | segments | Array | 作为数组用来描述线段如何交替和间距长度。 | @@ -1919,6 +1955,7 @@ getLineDash(): Array 获得当前画布的虚线样式。 **返回值：** + | 类型 | 说明 | | ----- | ------------------------ | | Array | 返回数组，该数组用来描述线段如何交替和间距长度。 | @@ -1949,6 +1986,7 @@ transferFromImageBitmap(bitmap: ImageBitmap): void 显示给定的ImageBitmap对象。 **参数：** + | 参数 | 类型 | 描述 | | ------ | ----------- | ------------------ | | bitmap | ImageBitmap | 待显示的ImageBitmap对象。 | diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-canvas-offscreencanvas.md b/zh-cn/application-dev/reference/arkui-js/js-components-canvas-offscreencanvas.md index 70d64e7aba055c3fdf53c49a0d5ca86bea288087..169915527dbcabd5a273cb9f3a9f8010a568cf17 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-canvas-offscreencanvas.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-canvas-offscreencanvas.md @@ -25,12 +25,14 @@ getContext(type: string, options?: CanvasRenderingContext2DSettings): OffscreenC 获取offscreen canvas绘图上下文，返回值为2D绘制对象。 **参数：** + | 参数名 | 参数类型 | 必填 | 描述 | | --------- | ---------------------------------------- | ---- | ---------------------- | | contextId | string | 是 | 仅支持 '2d'。 | | options | [CanvasRenderingContext2DSettings](../arkui-js/js-offscreencanvasrenderingcontext2d.md) | 否 | 用于在离屏画布上进行绘制矩形、文本、图片等。 | **返回值：** + | 类型 | 说明 | | ---------------------------------------- | --------------------------- | | [OffscreenCanvasRenderingContext2D](../arkui-js/js-offscreencanvasrenderingcontext2d.md) | 2D绘制对象，用于在画布组件上绘制矩形、文本、图片等。 | @@ -42,13 +44,15 @@ toDataURL(type?: string, quality?:number): 生成一个包含图片展示的URL。 -**参数：** +**参数：** + | 参数名 | 参数类型 | 必填 | 描述 | | ------- | ------ | ---- | ---------------------------------------- | | type | string | 否 | 可选参数，用于指定图像格式，默认格式为image/png。 | | quality | number | 否 | 在指定图片格式为image/jpeg或image/webp的情况下，可以从0到1的区间内选择图片的质量。如果超出取值范围，将会使用默认值0.92。 | **返回值：** + | 类型 | 说明 | | ------ | --------- | | string | 图像的URL地址。 | @@ -61,6 +65,7 @@ transferToImageBitmap(): ImageBitmap 在离屏画布最近渲染的图像上创建一个ImageBitmap对象。 **返回值：** + | 类型 | 说明 | | ---------------------------------------- | --------------- | | [ImageBitmap](../arkui-js/js-components-canvas-imagebitmap.md) | 存储离屏画布上渲染的像素数据。 | diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-canvas-path2d.md b/zh-cn/application-dev/reference/arkui-js/js-components-canvas-path2d.md index 803ca487efb7fb7c181a7d975828f5c0319c7765..e09ea90de9b7d96609d7ea9430c64dfbbcecb2f1 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-canvas-path2d.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-canvas-path2d.md @@ -12,12 +12,14 @@ addPath(path: Object): void 将另一个路径添加到当前的路径对象中。 -**参数：** +**参数：** + | 参数 | 类型 | 描述 | | ---- | ------ | -------------- | | path | Object | 需要添加到当前路径的路径对象 | -**示例：** +**示例：** + ```html
@@ -47,7 +49,8 @@ setTransform(scaleX: number, skewX: number, skewY: number, scaleY: number, trans 设置路径变换矩阵。 -**参数：** +**参数：** + | 参数 | 类型 | 描述 | | ---------- | ------ | ------- | | scaleX | number | x轴的缩放比例 | @@ -58,6 +61,7 @@ setTransform(scaleX: number, skewX: number, skewY: number, scaleY: number, trans | translateY | number | y轴的平移距离 | **示例：** + ```html
@@ -88,6 +92,7 @@ closePath(): void 将路径的当前点移回到路径的起点，当前点到起点间画一条直线。如果形状已经闭合或只有一个点，则此功能不执行任何操作。 **示例：** + ```html
@@ -120,13 +125,15 @@ moveTo(x: number, y: number): void 将路径的当前坐标点移动到目标点，移动过程中不绘制线条。 -**参数：** +**参数：** + | 参数 | 类型 | 描述 | | ---- | ------ | ------- | | x | number | 目标点X轴坐标 | | y | number | 目标点Y轴坐标 | **示例：** + ```html
@@ -159,13 +166,15 @@ lineTo(x: number, y: number): void 从当前点绘制一条直线到目标点。 -**参数：** +**参数：** + | 参数 | 类型 | 描述 | | ---- | ------ | ------- | | x | number | 目标点X轴坐标 | | y | number | 目标点Y轴坐标 | -**示例：** +**示例：** + ```html
@@ -199,7 +208,8 @@ bezierCurveTo(cp1x: number, cp1y: number, cp2x: number, cp2y: number, x: number, 创建三次贝赛尔曲线的路径。 -**参数：** +**参数：** + | 参数 | 类型 | 描述 | | ---- | ------ | -------------- | | cp1x | number | 第一个贝塞尔参数的x坐标值。 | @@ -210,6 +220,7 @@ bezierCurveTo(cp1x: number, cp1y: number, cp2x: number, cp2y: number, x: number, | y | number | 路径结束时的y坐标值。 | **示例：** + ```html
@@ -241,6 +252,7 @@ quadraticCurveTo(cpx: number, cpy: number, x: number, y: number): void 创建二次贝赛尔曲线的路径。 **参数：** + | 参数 | 类型 | 描述 | | ---- | ------ | ----------- | | cpx | number | 贝塞尔参数的x坐标值。 | @@ -248,7 +260,8 @@ quadraticCurveTo(cpx: number, cpy: number, x: number, y: number): void | x | number | 路径结束时的x坐标值。 | | y | number | 路径结束时的y坐标值。 | -**示例：** +**示例：** + ```html
@@ -280,6 +293,7 @@ arc(x: number, y: number, radius: number, startAngle: number, endAngle: number, 绘制弧线路径。 **参数：** + | 参数 | 类型 | 描述 | | ------------- | ------- | ---------- | | x | number | 弧线圆心的x坐标值。 | @@ -290,6 +304,7 @@ arc(x: number, y: number, radius: number, startAngle: number, endAngle: number, | anticlockwise | boolean | 是否逆时针绘制圆弧。 | **示例：** + ```html
@@ -319,7 +334,8 @@ arcTo(x1: number, y1: number, x2: number, y2: number, radius: number): void 依据圆弧经过的点和圆弧半径创建圆弧路径。 -**参数：** +**参数：** + | 参数 | 类型 | 描述 | | ------ | ------ | --------------- | | x1 | number | 圆弧经过的第一个点的x坐标值。 | @@ -329,6 +345,7 @@ arcTo(x1: number, y1: number, x2: number, y2: number, radius: number): void | radius | number | 圆弧的圆半径值。 | **示例：** + ```html
@@ -358,7 +375,8 @@ ellipse(x: number, y: number, radiusX: number, radiusY: number, rotation: number 在规定的矩形区域绘制一个椭圆。 -**参数：** +**参数：** + | 参数 | 类型 | 描述 | | ------------- | ------ | ------------------------------------ | | x | number | 椭圆圆心的x轴坐标。 | @@ -371,6 +389,7 @@ ellipse(x: number, y: number, radiusX: number, radiusY: number, rotation: number | anticlockwise | number | 是否以逆时针方向绘制椭圆，0为顺时针，1为逆时针。(可选参数，默认为0) | **示例：** + ```html
@@ -400,7 +419,8 @@ rect(x: number, y: number, width: number, height: number): void 创建矩形路径。 -**参数：** +**参数：** + | 参数 | 类型 | 描述 | | ------ | ------ | ------------- | | x | number | 指定矩形的左上角x坐标值。 | @@ -409,6 +429,7 @@ rect(x: number, y: number, width: number, height: number): void | height | number | 指定矩形的高度。 | **示例：** + ```html
diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-common-events.md b/zh-cn/application-dev/reference/arkui-js/js-components-common-events.md index 9a5db24f0ab945ebbf01b0eb185c1a8c0e7124ae..ceaae4522e80f28606596e2edb933a1c5314f237 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-common-events.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-common-events.md @@ -141,6 +141,7 @@ setData(key: string, value: object): boolean | value | object | 是 | 要存储的数据。 | **返回值：** + | 类型 | 说明 | | ------- | ------------------------ | | boolean | 执行结果，true表示成功，false表示失败。 | @@ -173,6 +174,7 @@ getData(key: string): object | key | string | 是 | 数据键值。 | **返回值：** + | 类型 | 说明 | | ------ | ------ | | object | 获取的数据。 | @@ -204,6 +206,7 @@ clearData(key?: string): boolean | key | string | 否 | 数据键值。 | **返回值：** + | 类型 | 说明 | | ------- | ------------------------ | | boolean | 执行结果，true表示成功，false表示失败。 | @@ -230,6 +233,7 @@ setDragImage(pixelmap: PixelMap, offsetX: number,offsetY: number): boolean | offsetY | number | 是 | 相对于图片的纵向偏移量。 | **返回值：** + | 类型 | 说明 | | ---- | ------------------------ | | boolean | 执行结果，true表示成功，false表示失败。 | diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-common-gradient.md b/zh-cn/application-dev/reference/arkui-js/js-components-common-gradient.md index eeb2755eb7586634733d7af932ab7bc39b8c7538..275e01728e948008e6d5a0685dd95b61169a2d98 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-common-gradient.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-common-gradient.md @@ -32,6 +32,7 @@ background: repeating-linear-gradient(direction/angle, color, color, ...); 支持以下四种方式：\#ff0000、\#ffff0000、rgb(255, 0, 0)、rgba(255, 0, 0, 1)，需要指定至少两种颜色。 **参数：** + | 名称 | 类型 | 默认值 | 必填 | 描述 | | --------- | ---------------------------------------- | ---------------------------- | ---- | ---------------------------------------- | | direction | to <side-or-corner>  <side-or-corner> = [left \| right] \| [top \| bottom] | to bottom (由上到下渐变) | 否 | 指定过渡方向，如：to left (从右向左渐变)  ；或者
to bottom right (从左上角到右下角)。 | diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-common-methods.md b/zh-cn/application-dev/reference/arkui-js/js-components-common-methods.md index 17b767b0a0ac29cc5acfa7c5055304901bd60d12..72a3f7ffd4771995ecbe8fd232d60457c2085e1b 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-common-methods.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-common-methods.md @@ -11,6 +11,7 @@ animate( keyframes: Keyframes, options: Options)：void **参数：** + | 参数名 | 参数类型 | 必填 | 描述 | | --------- | --------- | ---- | ------------------------------------ | | keyframes | keyframes | 是 | 设置动画样式 | @@ -218,6 +219,7 @@ createIntersectionObserver(param?: ObserverParam): Observer 监听元素在当前页面的可见范围。 **参数：** + | 参数名 | 参数类型 | 必填 | 描述 | | ----- | ------------- | ---- | -------------- | | param | ObserverParam | - | 获取observer的回调。 | diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-container-div.md b/zh-cn/application-dev/reference/arkui-js/js-components-container-div.md index ee69668eed61448f250ed3aade2578fb5fd13d72..0d51d6238b8e1434efadbde33b288a87ee950d88 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-container-div.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-container-div.md @@ -24,24 +24,24 @@ 除支持组件[通用样式](../arkui-js/js-components-common-styles.md)外，还支持如下样式： -| 名称 | 类型 | 默认值 | 必填 | 描述 | -| ------------------------------ | -------------- | ------------ | ---- | ---------------------------------------- | -| flex-direction | string | row | 否 | flex容器主轴方向。可选项有：
- column：垂直方向从上到下。
- row：水平方向从左到右。 | -| flex-wrap | string | nowrap | 否 | flex容器是单行还是多行显示，该值暂不支持动态修改。可选项有：
- nowrap：不换行，单行显示。
- wrap：换行，多行显示。 | -| justify-content | string | flex-start | 否 | flex容器当前行的主轴对齐格式。可选项有：
- flex-start：项目位于容器的开头。
- flex-end：项目位于容器的结尾。
- center：项目位于容器的中心。
- space-between：项目位于各行之间留有空白的容器内。
- space-around：项目位于各行之前、之间、之后都留有空白的容器内。
- space-evenly5+:  均匀排列每个元素，每个元素之间的间隔相等。 | -| align-items | string | stretch
| 否 | flex容器当前行的交叉轴对齐格式，可选值为：
- stretch：弹性元素在交叉轴方向被拉伸到与容器相同的高度或宽度。
- flex-start：元素向交叉轴起点对齐。
- flex-end：元素向交叉轴终点对齐。
- center：元素在交叉轴居中。 | -| align-content | string | flex-start | 否 | 交叉轴中有额外的空间时，多行内容对齐格式，可选值为：
- flex-start：所有行从交叉轴起点开始填充。第一行的交叉轴起点边和容器的交叉轴起点边对齐。接下来的每一行紧跟前一行。
- flex-end：所有行从交叉轴末尾开始填充。最后一行的交叉轴终点和容器的交叉轴终点对齐。同时所有后续行与前一个对齐。
- center：所有行朝向容器的中心填充。每行互相紧挨，相对于容器居中对齐。容器的交叉轴起点边和第一行的距离相等于容器的交叉轴终点边和最后一行的距离。
- space-between：所有行在容器中平均分布。相邻两行间距相等。容器的交叉轴起点边和终点边分别与第一行和最后一行的边对齐。
- space-around：所有行在容器中平均分布，相邻两行间距相等。容器的交叉轴起点边和终点边分别与第一行和最后一行的距离是相邻两行间距的一半。 | -| display | string | flex | 否 | 确定该元素视图框的类型，该值暂不支持动态修改。可选值为：
- flex：弹性布局
- grid：网格布局
- none：不渲染此元素
-inline-flex9+：当设置为inline-flex 时，同时具备flex样式和inline-block的效果 | -| grid-template-[columns\|rows] | string | 1行1列 | 否 | 用于设置当前网格布局行和列的数量，不设置时默认1行1列，仅当display为grid时生效。
示例：如设置grid-template-columns为：
- 50px 100px 60px：分三列，第一列50px，第二列100px，第三列60px；
- 1fr 1fr 2fr：分三列，将父组件允许的宽分为4等份，第一列占1份，第二列占一份，第三列占2份；
- 30% 20% 50%：分三列，将父组件允许的宽为基准，第一列占30%，第二列占20%，第三列占50%；
- repeat(2,100px)：分两列，第一列100px，第二列100px；
- repeat(auto-fill,100px)5+：按照每列100px的大小和交叉轴大小计算最大正整数重复次数，按照该重复次数布满交叉轴；
- auto 1fr 1fr：分三列，第一列自适应内部子组件所需宽度，剩余空间分为两等份，第二列占一份，第三列占一份。 | -| grid-[columns\|rows]-gap | <length> | 0 | 否 | 用于设置行与行的间距或者列与列的间距，也可以支持通过grid-gap设置相同的行列间距，仅当display为grid时生效。 | -| grid-row-[start\|end] | number | - | 否 | 用于设置当前元素在网格布局中的起止行号，仅当父组件display样式为grid时生效（仅div支持display样式设置为grid）。 | -| grid-column-[start\|end] | number | - | 否 | 用于设置当前元素在网格布局中的起止列号，仅当父组件display样式为grid时生效（仅div支持display样式设置为grid）。 | -| grid-auto-flow5+ | string | - | 否 | 使用框架自动布局算法进行网格的布局，可选值为：
- row：逐行填充元素，如果行空间不够，则新增行；
- column：逐列填充元素，如果列空间不够，则新增列。 | -| overflow6+ | string | visible | 否 | 设置元素内容区超过元素本身大小时的表现形式。
- visible：多个子元素内容超过元素大小时，显示在元素外面；
- hidden：元素内容超过元素大小时，进行裁切显示；
- scroll：元素内容超过元素大小时，进行滚动显示并展示滚动条（当前只支持纵向）。
overflow: scroll样式需要元素设置固定的大小，默认滚动方向与容器方向一致。 | -| align-items6+ | string | - | 否 | 设置容器中元素交叉轴上的对齐方式：
- stretch：Flex容器内容在交叉轴方向被拉伸到与容器相同的高度或宽度；
- flex-start：Flex布局容器内元素向交叉轴起点对齐；
- flex-end：Flex布局容器内元素向交叉轴终点对齐；
- center：Flex布局容器内元素在交叉轴居中对齐；
- baseline：如Flex布局纵向排列，则该值与'flex-start'等效。横向布局时，内容元素存在文本时按照文本基线对齐，否则底部对齐。 | -| scrollbar-color6+ | <color> | - | 否 | 设置滚动条的颜色。 | -| scrollbar-width6+ | <length> | - | 否 | 设置滚动条的宽度。 | -| overscroll-effect6+ | string | - | 否 | 设置滚动边缘效果，可选值为：
- spring：弹性物理动效，滑动到边缘后可以根据初始速度或通过触摸事件继续滑动一段距离，松手后回弹；
- fade：渐隐物理动效，滑动到边缘后展示一个波浪形的渐隐，根据速度和滑动距离的变化渐隐也会发送一定的变化；
- none：滑动到边缘后无效果 | +| 名称 | 类型 | 默认值 | 必填 | 描述 | +| ------------------------------ | -------------- | ------------ | ---- | ------------------------------------------------------------ | +| flex-direction | string | row | 否 | flex容器主轴方向。可选项有：
- column：垂直方向从上到下。
- row：水平方向从左到右。 | +| flex-wrap | string | nowrap | 否 | flex容器是单行还是多行显示，该值暂不支持动态修改。可选项有：
- nowrap：不换行，单行显示。
- wrap：换行，多行显示。 | +| justify-content | string | flex-start | 否 | flex容器当前行的主轴对齐格式。可选项有：
- flex-start：项目位于容器的开头。
- flex-end：项目位于容器的结尾。
- center：项目位于容器的中心。
- space-between：项目位于各行之间留有空白的容器内。
- space-around：项目位于各行之前、之间、之后都留有空白的容器内。
- space-evenly5+:  均匀排列每个元素，每个元素之间的间隔相等。 | +| align-items | string | stretch
| 否 | flex容器当前行的交叉轴对齐格式，可选值为：
- stretch：弹性元素在交叉轴方向被拉伸到与容器相同的高度或宽度。
- flex-start：元素向交叉轴起点对齐。
- flex-end：元素向交叉轴终点对齐。
- center：元素在交叉轴居中。
- baseline：如Flex布局纵向排列，则该值与’flex-start‘等效。横向布局时，内容元素存在文本时按照文本基线对齐，否则底部对齐。 | +| align-content | string | flex-start | 否 | 交叉轴中有额外的空间时，多行内容对齐格式，可选值为：
- flex-start：所有行从交叉轴起点开始填充。第一行的交叉轴起点边和容器的交叉轴起点边对齐。接下来的每一行紧跟前一行。
- flex-end：所有行从交叉轴末尾开始填充。最后一行的交叉轴终点和容器的交叉轴终点对齐。同时所有后续行与前一个对齐。
- center：所有行朝向容器的中心填充。每行互相紧挨，相对于容器居中对齐。容器的交叉轴起点边和第一行的距离相等于容器的交叉轴终点边和最后一行的距离。
- space-between：所有行在容器中平均分布。相邻两行间距相等。容器的交叉轴起点边和终点边分别与第一行和最后一行的边对齐。
- space-around：所有行在容器中平均分布，相邻两行间距相等。容器的交叉轴起点边和终点边分别与第一行和最后一行的距离是相邻两行间距的一半。 | +| display | string | flex | 否 | 确定该元素视图框的类型，该值暂不支持动态修改。可选值为：
- flex：弹性布局
- grid：网格布局
- none：不渲染此元素
-inline-flex9+：当设置为inline-flex 时，同时具备flex样式和inline-block的效果 | +| grid-template-[columns\|rows] | string | 1行1列 | 否 | 用于设置当前网格布局行和列的数量，不设置时默认1行1列，仅当display为grid时生效。
示例：如设置grid-template-columns为：
- 50px 100px 60px：分三列，第一列50px，第二列100px，第三列60px；
- 1fr 1fr 2fr：分三列，将父组件允许的宽分为4等份，第一列占1份，第二列占一份，第三列占2份；
- 30% 20% 50%：分三列，将父组件允许的宽为基准，第一列占30%，第二列占20%，第三列占50%；
- repeat(2,100px)：分两列，第一列100px，第二列100px；
- repeat(auto-fill,100px)5+：按照每列100px的大小和交叉轴大小计算最大正整数重复次数，按照该重复次数布满交叉轴；
- auto 1fr 1fr：分三列，第一列自适应内部子组件所需宽度，剩余空间分为两等份，第二列占一份，第三列占一份。 | +| grid-[columns\|rows]-gap | <length> | 0 | 否 | 用于设置行与行的间距或者列与列的间距，也可以支持通过grid-gap设置相同的行列间距，仅当display为grid时生效。 | +| grid-row-[start\|end] | number | - | 否 | 用于设置当前元素在网格布局中的起止行号，仅当父组件display样式为grid时生效（仅div支持display样式设置为grid）。 | +| grid-column-[start\|end] | number | - | 否 | 用于设置当前元素在网格布局中的起止列号，仅当父组件display样式为grid时生效（仅div支持display样式设置为grid）。 | +| grid-auto-flow5+ | string | - | 否 | 使用框架自动布局算法进行网格的布局，可选值为：
- row：逐行填充元素，如果行空间不够，则新增行；
- column：逐列填充元素，如果列空间不够，则新增列。 | +| overflow6+ | string | visible | 否 | 设置元素内容区超过元素本身大小时的表现形式。
- visible：多个子元素内容超过元素大小时，显示在元素外面；
- hidden：元素内容超过元素大小时，进行裁切显示；
- scroll：元素内容超过元素大小时，进行滚动显示并展示滚动条（当前只支持纵向）。
overflow: scroll样式需要元素设置固定的大小，默认滚动方向与容器方向一致。 | +| align-items6+ | string | - | 否 | 设置容器中元素交叉轴上的对齐方式：
- stretch：Flex容器内容在交叉轴方向被拉伸到与容器相同的高度或宽度；
- flex-start：Flex布局容器内元素向交叉轴起点对齐；
- flex-end：Flex布局容器内元素向交叉轴终点对齐；
- center：Flex布局容器内元素在交叉轴居中对齐；
- baseline：如Flex布局纵向排列，则该值与'flex-start'等效。横向布局时，内容元素存在文本时按照文本基线对齐，否则底部对齐。 | +| scrollbar-color6+ | <color> | - | 否 | 设置滚动条的颜色。 | +| scrollbar-width6+ | <length> | - | 否 | 设置滚动条的宽度。 | +| overscroll-effect6+ | string | - | 否 | 设置滚动边缘效果，可选值为：
- spring：弹性物理动效，滑动到边缘后可以根据初始速度或通过触摸事件继续滑动一段距离，松手后回弹；
- fade：渐隐物理动效，滑动到边缘后展示一个波浪形的渐隐，根据速度和滑动距离的变化渐隐也会发送一定的变化；
- none：滑动到边缘后无效果 | ## 事件 diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-custom-event-parameter.md b/zh-cn/application-dev/reference/arkui-js/js-components-custom-event-parameter.md index d889622c56e4b92ca8546fd2f355b2f8437a1983..ba98fb2c28321fadf3f00ded3a47fa0248c8a14b 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-custom-event-parameter.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-custom-event-parameter.md @@ -7,7 +7,7 @@
点击这里查看隐藏文本 - hello world + hello world
``` diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-svg-circle.md b/zh-cn/application-dev/reference/arkui-js/js-components-svg-circle.md index 311021cb4063978c467949dc2469f4dd21c31ce7..79c6068e49ba8880e88cc0ba0677732290bc8347 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-svg-circle.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-svg-circle.md @@ -13,12 +13,12 @@ ## 子组件 -支持animate、animateMotion、animateTransform。 +支持[animate](js-components-svg-animate.md)、[animateMotion](js-components-svg-animatemotion.md)、[animateTransform](js-components-svg-animatetransform.md)。 ## 属性 -支持Svg组件[通用属性](../arkui-js/js-components-svg-common-attributes.md)和以下属性。 +支持Svg组件[通用属性](js-components-svg-common-attributes.md)和以下属性。 | 名称 | 类型 | 默认值 | 必填 | 描述 | | -------- | -------- | -------- | -------- | -------- | diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-svg-common-attributes.md b/zh-cn/application-dev/reference/arkui-js/js-components-svg-common-attributes.md index fdf28e37326f2c138835d6b3c96dbd503a6b87cb..70f7ab9bd10572e14617697c9129be88e9c4b62a 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-svg-common-attributes.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-svg-common-attributes.md @@ -14,7 +14,7 @@ | stroke-dasharray | <string> | - | 否 | 指定短划线和缺口的长度。格式为[length length length length]，短划线和缺口的长度中间空格隔开成对出现。 | | stroke-dashoffset | <length> | 0 | 否 | 设置关联虚线数组渲染时的偏移量。支持属性动画 | | stroke-linejoin | [bevel \| miter \| round] | miter | 否 | 进行描边时在路径的拐角处使用的形状。
bevel：使用斜角连接路径段；
miter：使用尖角连接路径段；
round：使用圆角连接路径段。 | -| stroke-linecap | [butt \| round \| square] | butt | 否 | 路径描边时在它们的结尾处使用的形状。
butt：不在路径两端扩展；
round：在路径的末端延伸半个圆，直径等于线度。
square：在路径的末端延伸半个圆，宽度等于线宽的一半，高度等于线宽。 | +| stroke-linecap | [butt \| round \| square] | butt | 否 | 路径描边时在它们的结尾处使用的形状。
butt：不在路径两端扩展；
round：在路径的末端延伸半个圆，直径等于线宽；
square：在路径的末端延伸一个矩形，宽度等于线宽的一半，高度等于线宽。 | | stroke-miterlimit | number | 4 | 否 | 设置将锐角绘制成斜角的极限值。支持属性动画 | | stroke-opacity | number | 1 | 否 | 轮廓线条的透明度，取值范围为0到1，1表示为不透明，0表示为完全透明。支持属性动画 | | stroke-width | <length> | 1px | 否 | 设置轮廓线条的宽度。支持属性动画 | diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-svg-ellipse.md b/zh-cn/application-dev/reference/arkui-js/js-components-svg-ellipse.md index 6dd5c2a61e153cc6769001a4295ec11999bff2ce..5cdcf8e52a74d1557b88e2d4ea8f10f71348233c 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-svg-ellipse.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-svg-ellipse.md @@ -13,12 +13,12 @@ ## 子组件 -支持animate、animateMotion、animateTransform。 +支持[animate](js-components-svg-animate.md)、[animateMotion](js-components-svg-animatemotion.md)、[animateTransform](js-components-svg-animatetransform.md)。 ## 属性 -支持Svg组件[通用属性](../arkui-js/js-components-svg-common-attributes.md)和以下属性。 +支持Svg组件[通用属性](js-components-svg-common-attributes.md)和以下属性。 | 名称 | 类型 | 默认值 | 必填 | 描述 | | -------- | -------- | -------- | -------- | -------- | diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-svg-line.md b/zh-cn/application-dev/reference/arkui-js/js-components-svg-line.md index ac33a8138e8aedeb24535a6ba9f09f41decbd607..754b50e7c59254615367556910d04b6a89c55eb3 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-svg-line.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-svg-line.md @@ -13,12 +13,12 @@ ## 子组件 -支持animate、animateMotion、animateTransform。 +支持[animate](js-components-svg-animate.md)、[animateMotion](js-components-svg-animatemotion.md)、[animateTransform](js-components-svg-animatetransform.md)。 ## 属性 -支持所列的Svg组件通用属性和以下表格的属性。 +支持Svg组件[通用属性](js-components-svg-common-attributes.md)和以下属性。 | 名称 | 类型 | 默认值 | 必填 | 描述 | | -------- | -------- | -------- | -------- | -------- | @@ -38,8 +38,11 @@ + // round：在路径的末端延伸半个圆，直径等于线宽 + // butt：不在路径两端扩展 + // square：在路径的末端延伸一个矩形，宽度等于线宽的一半，高度等于线宽
diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-svg-path.md b/zh-cn/application-dev/reference/arkui-js/js-components-svg-path.md index 6e7f042a6a8ca46714ea781c5a62473167467cbe..5d5c0efe75f5fc341451079b28f5671c72078838 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-svg-path.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-svg-path.md @@ -13,12 +13,12 @@ ## 子组件 -支持animate、animateMotion、animateTransform。 +支持[animate](js-components-svg-animate.md)、[animateMotion](js-components-svg-animatemotion.md)、[animateTransform](js-components-svg-animatetransform.md)。 ## 属性 -支持Svg组件[通用属性](../arkui-js/js-components-svg-common-attributes.md)和以下属性，设置的通用属性会传递给子组件。 +支持Svg组件[通用属性](js-components-svg-common-attributes.md)和以下属性，设置的通用属性会传递给子组件。 | 名称 | 类型 | 默认值 | 必填 | 描述 | | -------- | -------- | -------- | -------- | -------- | diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-svg-polygon.md b/zh-cn/application-dev/reference/arkui-js/js-components-svg-polygon.md index 7355b5d28dde8df9f34d1f4a2240895f36ba161e..fbcfea9ab868d48a21cd2571c508cb6dbae6f1c7 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-svg-polygon.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-svg-polygon.md @@ -13,12 +13,12 @@ ## 子组件 -支持animate、animateMotion、animateTransform。 +支持[animate](js-components-svg-animate.md)、[animateMotion](js-components-svg-animatemotion.md)、[animateTransform](js-components-svg-animatetransform.md)。 ## 属性 -支持Svg组件[通用属性](../arkui-js/js-components-svg-common-attributes.md)和以下属性。 +支持Svg组件[通用属性](js-components-svg-common-attributes.md)和以下属性。 | 名称 | 类型 | 默认值 | 必填 | 描述 | | -------- | -------- | -------- | -------- | -------- | diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-svg-polyline.md b/zh-cn/application-dev/reference/arkui-js/js-components-svg-polyline.md index d1326bce931b4662a72cd50edffa0aaba6e68f82..92b11c267dab527521d0b24a8627795b7402ac3d 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-svg-polyline.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-svg-polyline.md @@ -13,12 +13,12 @@ ## 子组件 -支持animate、animateMotion、animateTransform。 +支持[animate](js-components-svg-animate.md)、[animateMotion](js-components-svg-animatemotion.md)、[animateTransform](js-components-svg-animatetransform.md)。 ## 属性 -支持所列的Svg组件通用属性和以下表格的属性。 +支持Svg组件[通用属性](js-components-svg-common-attributes.md)和以下属性。 | 名称 | 类型 | 默认值 | 必填 | 描述 | | -------- | -------- | -------- | -------- | -------- | diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-svg-rect.md b/zh-cn/application-dev/reference/arkui-js/js-components-svg-rect.md index 1e7ff584868742fa16c1ebcd683adfb4ff66524b..a7aed7172a3e925ecccd285b745bce4cb8cb80d4 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-svg-rect.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-svg-rect.md @@ -13,12 +13,12 @@ ## 子组件 -支持animate、animateMotion、animateTransform。 +支持[animate](js-components-svg-animate.md)、[animateMotion](js-components-svg-animatemotion.md)、[animateTransform](js-components-svg-animatetransform.md)。 ## 属性 -支持Svg组件[通用属性](../arkui-js/js-components-svg-common-attributes.md)和以下属性。 +支持Svg组件[通用属性](js-components-svg-common-attributes.md)和以下属性。 | 名称 | 类型 | 默认值 | 必填 | 描述 | | -------- | -------- | -------- | -------- | -------- | diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-svg-text.md b/zh-cn/application-dev/reference/arkui-js/js-components-svg-text.md index 4df75ebf6511acbe66d25da3d0f012541c8bdee9..664953f5fcbcfada13d8424701773fe14b40627a 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-svg-text.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-svg-text.md @@ -19,7 +19,7 @@ ## 子组件 -支持tspan、textpath、animate、animateTransform。 +支持[tspan](js-components-svg-tspan.md)、[textpath](js-components-svg-textpath.md)、[animate](js-components-svg-animate.md)、[animateTransform](js-components-svg-animatetransform.md)。 ## 属性 diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-svg-textpath.md b/zh-cn/application-dev/reference/arkui-js/js-components-svg-textpath.md index 669f8106d9da813e5754660c639bd2351b49816f..cf6779fb5069197f1913c192007e776a2070334d 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-svg-textpath.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-svg-textpath.md @@ -17,7 +17,7 @@ ## 子组件 -tspan。 +[tspan](js-components-svg-tspan.md)。 ## 属性 diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-svg-tspan.md b/zh-cn/application-dev/reference/arkui-js/js-components-svg-tspan.md index e6020808cf4f95798827d5b33ca3f6ca58c6ecc8..cb38ce4b167157441a7d4c572c94ab87a1ed0298 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-svg-tspan.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-svg-tspan.md @@ -17,7 +17,7 @@ ## 子组件 -支持tspan。 +支持[tspan](js-components-svg-tspan.md)。 支持以下表格中的属性。 diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-svg.md b/zh-cn/application-dev/reference/arkui-js/js-components-svg.md index ac978acbdc69f500b9a62cc2b0fc914b1f6035e4..a44fed0e5caee70217c41e0f045ff4a1d0074a78 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-svg.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-svg.md @@ -15,7 +15,7 @@ ## 子组件 -支持svg、rect、circle、ellipse、path、line、polygon、polyline、text、animate、animateTransform。 +支持[svg](js-components-svg.md)、[rect](js-components-svg-rect.md)、[circle](js-components-svg-circle.md)、[ellipse](../arkui-js/js-components-svg-ellipse.md)、[path](js-components-svg-path.md)、[line](../arkui-js/js-components-svg-line.md)、[polygon](../arkui-js/js-components-svg-polygon.md)、[polyline](js-components-svg-polyline.md)、[text](js-components-svg-text.md)、[animate](js-components-svg-animate.md)、[animateTransform](js-components-svg-animateTransform.md)。 ## 属性 diff --git a/zh-cn/application-dev/reference/arkui-ts/Readme-CN.md b/zh-cn/application-dev/reference/arkui-ts/Readme-CN.md index 257819fc7793b44e615ac6dc1fe4495f20d49dce..5eb5a49955b47df7d72293fc49453e17775ab632 100644 --- a/zh-cn/application-dev/reference/arkui-ts/Readme-CN.md +++ b/zh-cn/application-dev/reference/arkui-ts/Readme-CN.md @@ -1,4 +1,4 @@ -# 基于TS扩展的声明式开发范式 +# 基于eTS的声明式开发范式 - 组件通用信息 - 通用事件 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-blank.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-blank.md index 00e0be6eb07b133fb74bba702d4e1a3443c7b221..c518eeb883e658045e54b7a9dd4b01afcb3f9194 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-blank.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-blank.md @@ -19,12 +19,12 @@ ## 接口 -Blank(min?: Length) +Blank(min?: number \| string) - 参数 | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | - | min | [Length](../../ui/ts-types.md) | 否 | 0 | 空白填充组件在容器主轴上的最小大小。 | + | min | number \| string | 否 | 0 | 空白填充组件在容器主轴上的最小大小。 | ## 属性 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-image.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-image.md index aa9037ff771aff36d33a0f710f287b314346924d..0e90c223c08c18084c29c3530d9ef66d99bd6bac 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-image.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-image.md @@ -6,19 +6,9 @@ > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限说明 +## 需要权限 -使用网络图片时，需要在config.json（FA模型）或者module.json5（Stage模型）对应的"abilities"中添加网络使用权限ohos.permission.INTERNET。 - -``` -"abilities": [ - { - ... - "permissions": ["ohos.permission.INTERNET"], - ... - } -] -``` +使用网络图片时，需要申请权限ohos.permission.INTERNET。具体申请方式请参考[权限申请声明](../../security/accesstoken-guidelines.md)。 ## 子组件 @@ -42,21 +32,21 @@ Image(src: string | PixelMap | Resource) 除支持[通用属性](ts-universal-attributes-size.md)外，还支持以下属性： -| 名称 | 参数类型 | 默认值 | 描述 | -| --------------------- | ------------------------------------------------------- | ------------------------ | ------------------------------------------------------------ | -| alt | string \| [Resource](../../ui/ts-types.md#resource类型) | - | 加载时显示的占位图，支持本地图片和网络图片。 | -| objectFit | [ImageFit](ts-appendix-enums.md#imagefit) | ImageFit.Cover | 设置图片的缩放类型。 | -| objectRepeat | [ImageRepeat](ts-appendix-enums.md#imagerepeat) | NoRepeat | 设置图片的重复样式。
> **说明：**
> - svg类型图源不支持该属性。 | -| interpolation | [ImageInterpolation](#imageinterpolation) | ImageInterpolation.None | 设置图片的插值效果，即减轻低清晰度图片在放大显示的时候出现的锯齿问题，仅针对图片放大插值。
> **说明：**
> - svg类型图源不支持该属性。
> - PixelMap资源不支持该属性。 | -| renderMode | [ImageRenderMode](#imagerendermode) | ImageRenderMode.Original | 设置图片渲染的模式。
> **说明：**
> - svg类型图源不支持该属性。 | -| sourceSize | {
width: number,
height: number
} | - | 设置图片裁剪尺寸，将原始图片解码成pixelMap，指定尺寸的图片，单位为px。
> **说明：**
> PixelMap资源不支持该属性。 | -| matchTextDirection | boolean | false | 设置图片是否跟随系统语言方向，在RTL语言环境下显示镜像翻转显示效果。 | -| fitOriginalSize | boolean | true | 图片组件尺寸未设置时，其显示尺寸是否跟随图源尺寸。 | -| fillColor | [ResourceColor](../../ui/ts-types.md#resourcecolor8) | - | 仅对svg图源生效，设置后会替换svg图片的fill颜色。 | -| autoResize | boolean | true | 是否需要在图片解码过程中对图源做resize操作，该操作会根据显示区域的尺寸决定用于绘制的图源尺寸，有利于减少内存占用。 | -| syncLoad8+ | boolean | false | 设置是否同步加载图片，默认是异步加载。同步加载时阻塞UI线程，不会显示占位图。 | -| copyOption9+ | [CopyOptions](ts-appendix-enums.md#copyoptions9) | CopyOptions.None | 设置图片是否可复制（SVG图片不支持复制）。
当设置copyOption为非CopyOptions.None时，支持快捷组合键'CTRL+C'进行复制。 | -| colorFilter9+ | [ColorFilter](../../ui/ts-types.md#colorfilter9) | - | 给图像设置颜色滤镜效果。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ------------------------ | ---------------------------------------- | ------------------------ | ---------------------------------------- | +| alt | string \| [Resource](../../ui/ts-types.md#resource类型) | - | 加载时显示的占位图，支持本地图片和网络图片。 | +| objectFit | [ImageFit](ts-appendix-enums.md#imagefit) | ImageFit.Cover | 设置图片的缩放类型。 | +| objectRepeat | [ImageRepeat](ts-appendix-enums.md#imagerepeat) | NoRepeat | 设置图片的重复样式。
> **说明：**
> - svg类型图源不支持该属性。 | +| interpolation | [ImageInterpolation](#imageinterpolation) | ImageInterpolation.None | 设置图片的插值效果，即减轻低清晰度图片在放大显示的时候出现的锯齿问题，仅针对图片放大插值。
> **说明：**
> - svg类型图源不支持该属性。
> - PixelMap资源不支持该属性。 | +| renderMode | [ImageRenderMode](#imagerendermode) | ImageRenderMode.Original | 设置图片渲染的模式。
> **说明：**
> - svg类型图源不支持该属性。 | +| sourceSize | {
width: number,
height: number
} | - | 设置图片裁剪尺寸，将原始图片解码成pixelMap，指定尺寸的图片，单位为px。
> **说明：**
> PixelMap资源不支持该属性。 | +| matchTextDirection | boolean | false | 设置图片是否跟随系统语言方向，在RTL语言环境下显示镜像翻转显示效果。 | +| fitOriginalSize | boolean | true | 图片组件尺寸未设置时，其显示尺寸是否跟随图源尺寸。 | +| fillColor | [ResourceColor](../../ui/ts-types.md#resourcecolor8) | - | 仅对svg图源生效，设置后会替换svg图片的fill颜色。 | +| autoResize | boolean | true | 是否需要在图片解码过程中对图源做resize操作，该操作会根据显示区域的尺寸决定用于绘制的图源尺寸，有利于减少内存占用。 | +| syncLoad8+ | boolean | false | 设置是否同步加载图片，默认是异步加载。同步加载时阻塞UI线程，不会显示占位图。 | +| copyOption9+ | [CopyOptions](ts-appendix-enums.md#copyoptions9) | CopyOptions.None | 设置图片是否可复制（SVG图片不支持复制）。
当设置copyOption为非CopyOptions.None时，支持快捷组合键'CTRL+C'进行复制。 | +| colorFilter9+ | [ColorFilter](../../ui/ts-types.md#colorfilter9) | - | 给图像设置颜色滤镜效果。 | > **说明：** > 使用快捷组合键对Image组件复制的前提是，该组件必须处于获焦状态。将Image组件的属性focusable设置为true，即可使用TAB键将焦点切换到Image组件上，再将Image组件的focusOnTouch属性设置为true，即可实现点击获焦。 @@ -84,7 +74,7 @@ Image(src: string | PixelMap | Resource) | 名称 | 功能描述 | | ---------------------------------------- | ---------------------------------------- | | onComplete(callback: (event?: { width: number, height: number, componentWidth: number,
 componentHeight: number, loadingStatus: number }) => void) | 图片成功加载时触发该回调，返回成功加载的图片尺寸。
- width：图片的宽，单位为像素。
- height：图片的高，单位为像素。
- componentWidth：组件的宽，单位为像素。
- componentHeight：组件的高，单位为像素。
- loadingStatus：图片加载成功的状态。
| -| onError(callback: (event?: { componentWidth: number, componentHeight: number }) => void) | 图片加载出现异常时触发该回调。
- componentWidth：组件的宽，单位为像素。
- componentHeight：组件的高，单位为像素。
| +| onError(callback: (event?: { componentWidth: number, componentHeight: number , message9+: string }) => void) | 图片加载出现异常时触发该回调。
- componentWidth：组件的宽，单位为像素。
- componentHeight：组件的高，单位为像素。
| | onFinish(event: () => void) | 当加载的源文件为带动效的svg图片时，当svg动效播放完成时会触发这个回调，如果动效为无限循环动效，则不会触发这个回调。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-timepicker.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-timepicker.md index b5edeedb5dc259f890202404e5b6c83abb27e133..41877c746edcc01b89ee5eceece30c1bc4e7d2b3 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-timepicker.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-timepicker.md @@ -3,7 +3,7 @@ 滚动选择时间的组件。 > **说明：** -> 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 +> 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 ## 权限列表 @@ -20,31 +20,31 @@ TimePicker(options?: TimePickerOptions) -默认以00：00至23：59的时间区间创建滑动选择器。 +默认以00:00至23:59的时间区间创建滑动选择器。 - options参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | selected | Date | 否 | 当前系统时间 | 设置选中项的时间。 | + | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | + | -------- | ---- | ---- | ------ | --------- | + | selected | Date | 否 | 当前系统时间 | 设置选中项的时间。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | +| 名称 | 参数类型 | 默认值 | 描述 | +| --------------- | ------- | ----- | --------------------- | | useMilitaryTime | boolean | false | 展示时间是否为24小时制，不支持动态修改。 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | +| 名称 | 功能描述 | +| ---------------------------------------- | ----------- | | onChange(callback: (value: TimePickerResult ) => void) | 选择时间时触发该事件。 | ### TimePickerResult对象说明 -| 名称 | 参数类型 | 描述 | -| -------- | -------- | -------- | -| hour | number | 选中时间的时。 | +| 名称 | 参数类型 | 描述 | +| ------ | ------ | ------- | +| hour | number | 选中时间的时。 | | minute | number | 选中时间的分。 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-canvasrenderingcontext2d.md b/zh-cn/application-dev/reference/arkui-ts/ts-canvasrenderingcontext2d.md index 152ff182e77fc382f99a785de5ad2aa95194deb9..2d2626943d22da8ee8ff4b3a31b78ae60dcbc38d 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-canvasrenderingcontext2d.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-canvasrenderingcontext2d.md @@ -1,6 +1,7 @@ # CanvasRenderingContext2D对象 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> **说明：** +> > 从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 @@ -13,9 +14,9 @@ CanvasRenderingContext2D(setting: RenderingContextSetting) **参数：** - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | ------- | ---------------------------------------- | ---- | ---- | ---------------------------------------- | - | setting | [RenderingContextSettings](#renderingcontextsettings) | 是 | - | 见[RenderingContextSettings](#renderingcontextsettings)。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ------- | ---------------------------------------- | ---- | ---------------------------------------- | +| setting | [RenderingContextSettings](#renderingcontextsettings) | 是 | 见[RenderingContextSettings](#renderingcontextsettings)。 | ### RenderingContextSettings @@ -26,9 +27,9 @@ RenderingContextSettings(antialias?: boolean) **参数：** - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | --------- | ------- | ---- | ----- | ---------------- | - | antialias | boolean | 否 | false | 表明canvas是否开启抗锯齿。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| --------- | ------- | ---- | ----------------------------- | +| antialias | boolean | 否 | 表明canvas是否开启抗锯齿。
默认值：false | ## 属性 @@ -38,23 +39,24 @@ RenderingContextSettings(antialias?: boolean) | [fillStyle](#fillstyle) | string \| [CanvasGradient](ts-components-canvas-canvasgradient.md) \| [CanvasPattern](#canvaspattern) | 指定绘制的填充色。
- 类型为string时，表示设置填充区域的颜色。
- 类型为CanvasGradient时，表示渐变对象，使用[createLinearGradient](#createlineargradient)方法创建。
- 类型为CanvasPattern时，使用[createPattern](#createpattern)方法创建。 | | [lineWidth](#linewidth) | number | 设置绘制线条的宽度。 | | [strokeStyle](#strokestyle) | string \| [CanvasGradient](ts-components-canvas-canvasgradient.md) \| [CanvasPattern](#canvaspattern) | 设置描边的颜色。
- 类型为string时，表示设置描边使用的颜色。
- 类型为CanvasGradient时，表示渐变对象，使用[createLinearGradient](#createlineargradient)方法创建。
- 类型为CanvasPattern时，使用[createPattern](#createpattern)方法创建。 | -| [lineCap](#linecap) | CanvasLineCap | 指定线端点的样式，可选值为：
- 'butt'：线端点以方形结束。
- 'round'：线端点以圆形结束。
- 'square'：线端点以方形结束，该样式下会增加一个长度和线段厚度相同，宽度是线段厚度一半的矩形。
默认值：'butt'。 | -| [lineJoin](#linejoin) | CanvasLineJoin | 指定线段间相交的交点样式，可选值为：
- 'round'：在线段相连处绘制一个扇形，扇形的圆角半径是线段的宽度。
- 'bevel'：在线段相连处使用三角形为底填充， 每个部分矩形拐角独立。
- 'miter'：在相连部分的外边缘处进行延伸，使其相交于一点，形成一个菱形区域，该属性可以通过设置miterLimit属性展现效果。
默认值：'miter'。 | -| [miterLimit](#miterlimit) | number | 设置斜接面限制值，该值指定了线条相交处内角和外角的距离。
默认值：10。 | -| [font](#font) | string | 设置文本绘制中的字体样式。
语法：ctx.font='font-size font-family'
- font-size(可选)，指定字号和行高，单位只支持px。
- font-family(可选)，指定字体系列。
语法：ctx.font='font-style font-weight font-size font-family'
- font-style(可选)，用于指定字体样式，支持如下几种样式：'normal','italic'。
- font-weight(可选)，用于指定字体的粗细，支持如下几种类型：'normal', 'bold', 'bolder', 'lighter', 100, 200, 300, 400, 500, 600, 700, 800, 900。
- font-size(可选)，指定字号和行高，单位只支持px。
- font-family(可选)，指定字体系列，支持如下几种类型：'sans-serif', 'serif', 'monospace'。
默认值：'normal normal 14px sans-serif'。 | -| [textAlign](#textalign) | CanvasTextAlign | 设置文本绘制中的文本对齐方式，可选值为：
- 'left'：文本左对齐。
- 'right'：文本右对齐。
- 'center'：文本居中对齐。
- 'start'：文本对齐界线开始的地方。
- 'end'：文本对齐界线结束的地方。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> ltr布局模式下'start'和'left'一致，rtl布局模式下'start'和'right'一致·。
默认值：'left'。 | -| [textBaseline](#textbaseline) | CanvasTextBaseline | 设置文本绘制中的水平对齐方式，可选值为：
- 'alphabetic'：文本基线是标准的字母基线。
- 'top'：文本基线在文本块的顶部。
- 'hanging'：文本基线是悬挂基线。
- 'middle'：文本基线在文本块的中间。
- 'ideographic'：文字基线是表意字基线；如果字符本身超出了alphabetic基线，那么ideograhpic基线位置在字符本身的底部。
- 'bottom'：文本基线在文本块的底部。 与ideographic基线的区别在于ideographic基线不需要考虑下行字母。
默认值：'alphabetic'。 | +| [lineCap](#linecap) | CanvasLineCap | 指定线端点的样式，可选值为：
- 'butt'：线端点以方形结束。
- 'round'：线端点以圆形结束。
- 'square'：线端点以方形结束，该样式下会增加一个长度和线段厚度相同，宽度是线段厚度一半的矩形。
默认值：'butt'。 | +| [lineJoin](#linejoin) | CanvasLineJoin | 指定线段间相交的交点样式，可选值为：
- 'round'：在线段相连处绘制一个扇形，扇形的圆角半径是线段的宽度。
- 'bevel'：在线段相连处使用三角形为底填充， 每个部分矩形拐角独立。
- 'miter'：在相连部分的外边缘处进行延伸，使其相交于一点，形成一个菱形区域，该属性可以通过设置miterLimit属性展现效果。
默认值：'miter'。 | +| [miterLimit](#miterlimit) | number | 设置斜接面限制值，该值指定了线条相交处内角和外角的距离。
默认值：10。 | +| [font](#font) | string | 设置文本绘制中的字体样式。
语法：ctx.font='font-size font-family'
- font-size(可选)，指定字号和行高，单位只支持px。
- font-family(可选)，指定字体系列。
语法：ctx.font='font-style font-weight font-size font-family'
- font-style(可选)，用于指定字体样式，支持如下几种样式：'normal','italic'。
- font-weight(可选)，用于指定字体的粗细，支持如下几种类型：'normal', 'bold', 'bolder', 'lighter', 100, 200, 300, 400, 500, 600, 700, 800, 900。
- font-size(可选)，指定字号和行高，单位只支持px。
- font-family(可选)，指定字体系列，支持如下几种类型：'sans-serif', 'serif', 'monospace'。
默认值：'normal normal 14px sans-serif'。 | +| [textAlign](#textalign) | CanvasTextAlign | 设置文本绘制中的文本对齐方式，可选值为：
- 'left'：文本左对齐。
- 'right'：文本右对齐。
- 'center'：文本居中对齐。
- 'start'：文本对齐界线开始的地方。
- 'end'：文本对齐界线结束的地方。
ltr布局模式下'start'和'left'一致，rtl布局模式下'start'和'right'一致·。
默认值：'left'。 | +| [textBaseline](#textbaseline) | CanvasTextBaseline | 设置文本绘制中的水平对齐方式，可选值为：
- 'alphabetic'：文本基线是标准的字母基线。
- 'top'：文本基线在文本块的顶部。
- 'hanging'：文本基线是悬挂基线。
- 'middle'：文本基线在文本块的中间。
- 'ideographic'：文字基线是表意字基线；如果字符本身超出了alphabetic基线，那么ideograhpic基线位置在字符本身的底部。
- 'bottom'：文本基线在文本块的底部。 与ideographic基线的区别在于ideographic基线不需要考虑下行字母。
默认值：'alphabetic'。 | | [globalAlpha](#globalalpha) | number | 设置透明度，0.0为完全透明，1.0为完全不透明。 | -| [lineDashOffset](#linedashoffset) | number | 设置画布的虚线偏移量，精度为float。
默认值：0.0。 | +| [lineDashOffset](#linedashoffset) | number | 设置画布的虚线偏移量，精度为float。
默认值：0.0。 | | [globalCompositeOperation](#globalcompositeoperation) | string | 设置合成操作的方式。类型字段可选值有'source-over'，'source-atop'，'source-in'，'source-out'，'destination-over'，'destination-atop'，'destination-in'，'destination-out'，'lighter'，'copy'，'xor'。
默认值：'source-over'。 | -| [shadowBlur](#shadowblur) | number | 设置绘制阴影时的模糊级别，值越大越模糊，精度为float。
默认值：0.0。 | -| [shadowColor](#shadowcolor) | string | 设置绘制阴影时的阴影颜色。 | +| [shadowBlur](#shadowblur) | number | 设置绘制阴影时的模糊级别，值越大越模糊，精度为float。
默认值：0.0。 | +| [shadowColor](#shadowcolor) | string | 设置绘制阴影时的阴影颜色。 | | [shadowOffsetX](#shadowoffsetx) | number | 设置绘制阴影时和原有对象的水平偏移值。 | | [shadowOffsetY](#shadowoffsety) | number | 设置绘制阴影时和原有对象的垂直偏移值。 | -| [imageSmoothingEnabled](#imagesmoothingenabled) | boolean | 用于设置绘制图片时是否进行图像平滑度调整，true为启用，false为不启用。
默认值：true。 | +| [imageSmoothingEnabled](#imagesmoothingenabled) | boolean | 用于设置绘制图片时是否进行图像平滑度调整，true为启用，false为不启用。
默认值：true。 | -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** ->fillStyle、shadowColor与 strokeStyle 中string类型格式为 'rgb(255, 255, 255)'，'rgba(255, 255, 255, 1.0)'，'\#FFFFFF'。 +> **说明：** +> +> fillStyle、shadowColor与 strokeStyle 中string类型格式为 'rgb(255, 255, 255)'，'rgba(255, 255, 255, 1.0)'，'\#FFFFFF'。 ### fillStyle @@ -662,12 +664,12 @@ fillRect(x: number, y: number, w: number, h: number): void **参数：** - | 参数 | 类型 | 必填 | 默认值 | 说明 | - | ------ | ------ | ---- | ---- | ------------- | - | x | number | 是 | 0 | 指定矩形左上角点的x坐标。 | - | y | number | 是 | 0 | 指定矩形左上角点的y坐标。 | - | width | number | 是 | 0 | 指定矩形的宽度。 | - | height | number | 是 | 0 | 指定矩形的高度。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| ------ | ------ | ---- | ---- | ------------- | +| x | number | 是 | 0 | 指定矩形左上角点的x坐标。 | +| y | number | 是 | 0 | 指定矩形左上角点的y坐标。 | +| width | number | 是 | 0 | 指定矩形的宽度。 | +| height | number | 是 | 0 | 指定矩形的高度。 | **示例：** @@ -706,12 +708,12 @@ strokeRect(x: number, y: number, w: number, h: number): void **参数：** - | 参数 | 类型 | 必填 | 默认值 | 说明 | - | ------ | ------ | ---- | ---- | ------------ | - | x | number | 是 | 0 | 指定矩形的左上角x坐标。 | - | y | number | 是 | 0 | 指定矩形的左上角y坐标。 | - | w | number | 是 | 0 | 指定矩形的宽度。 | - | h | number | 是 | 0 | 指定矩形的高度。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| ---- | ------ | ---- | ---- | ------------ | +| x | number | 是 | 0 | 指定矩形的左上角x坐标。 | +| y | number | 是 | 0 | 指定矩形的左上角y坐标。 | +| w | number | 是 | 0 | 指定矩形的宽度。 | +| h | number | 是 | 0 | 指定矩形的高度。 | **示例：** @@ -750,12 +752,12 @@ clearRect(x: number, y: number, w: number, h: number): void **参数：** - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ------ | ------ | ---- | ---- | ------------- | - | x | number | 是 | 0 | 指定矩形上的左上角x坐标。 | - | y | number | 是 | 0 | 指定矩形上的左上角y坐标。 | - | w | number | 是 | 0 | 指定矩形的宽度。 | - | h | number | 是 | 0 | 指定矩形的高度。 | +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---- | ------ | ---- | ---- | ------------- | +| x | number | 是 | 0 | 指定矩形上的左上角x坐标。 | +| y | number | 是 | 0 | 指定矩形上的左上角y坐标。 | +| w | number | 是 | 0 | 指定矩形的宽度。 | +| h | number | 是 | 0 | 指定矩形的高度。 | **示例：** @@ -796,12 +798,12 @@ fillText(text: string, x: number, y: number, maxWidth?: number): void **参数：** - | 参数 | 类型 | 必填 | 默认值 | 说明 | - | ---- | ------ | ---- | ---- | --------------- | - | text | string | 是 | “” | 需要绘制的文本内容。 | - | x | number | 是 | 0 | 需要绘制的文本的左下角x坐标。 | - | y | number | 是 | 0 | 需要绘制的文本的左下角y坐标。 | - | maxWidth | number | 否 | - | 指定文本允许的最大宽度。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| -------- | ------ | ---- | ---- | --------------- | +| text | string | 是 | "" | 需要绘制的文本内容。 | +| x | number | 是 | 0 | 需要绘制的文本的左下角x坐标。 | +| y | number | 是 | 0 | 需要绘制的文本的左下角y坐标。 | +| maxWidth | number | 否 | - | 指定文本允许的最大宽度。 | **示例：** @@ -841,12 +843,12 @@ strokeText(text: string, x: number, y: number, maxWidth?:number): void **参数：** - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ---- | ------ | ---- | ---- | --------------- | - | text | string | 是 | “” | 需要绘制的文本内容。 | - | x | number | 是 | 0 | 需要绘制的文本的左下角x坐标。 | - | y | number | 是 | 0 | 需要绘制的文本的左下角y坐标。 | - | maxWidth | number | 否 | - | 需要绘制的文本的最大宽度 。| +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| -------- | ------ | ---- | ---- | --------------- | +| text | string | 是 | “” | 需要绘制的文本内容。 | +| x | number | 是 | 0 | 需要绘制的文本的左下角x坐标。 | +| y | number | 是 | 0 | 需要绘制的文本的左下角y坐标。 | +| maxWidth | number | 否 | - | 需要绘制的文本的最大宽度 。 | **示例：** @@ -886,33 +888,33 @@ measureText(text: string): TextMetrics **参数：** - | 参数 | 类型 | 必填 | 默认值 | 说明 | - | ---- | ------ | ---- | ---- | ---------- | - | text | string | 是 | "" | 需要进行测量的文本。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| ---- | ------ | ---- | ---- | ---------- | +| text | string | 是 | "" | 需要进行测量的文本。 | **返回值：** - | 类型 | 说明 | - | ----------- | ------- | - | TextMetrics | 文本的尺寸信息 | +| 类型 | 说明 | +| ----------- | ------- | +| TextMetrics | 文本的尺寸信息 | **TextMetrics类型描述:** - | 属性 | 类型 | 描述 | - | ----- | ------ | ------- | - | width | number | 字符串的宽度。 | - | height | number | 字符串的高度。 | - | actualBoundingBoxAscent | number | 从CanvasRenderingContext2D.textBaseline 属性标明的水平线到渲染文本的矩形边界顶部的距离，当前值为0。 | - | actualBoundingBoxDescent | number | 从CanvasRenderingContext2D.textBaseline 属性标明的水平线到渲染文本的矩形边界底部的距离，当前值为0。 | - | actualBoundingBoxLeft | number | 平行于基线，从CanvasRenderingContext2D.textAlign 属性确定的对齐点到文本矩形边界左侧的距离，当前值为0。 | - | actualBoundingBoxRight | number | 平行于基线，从CanvasRenderingContext2D.textAlign 属性确定的对齐点到文本矩形边界右侧的距离，当前值为0。| - | alphabeticBaseline | number | 从CanvasRenderingContext2D.textBaseline 属性标明的水平线到线框的 alphabetic 基线的距离，当前值为0。| - | emHeightAscent | number | 从CanvasRenderingContext2D.textBaseline 属性标明的水平线到线框中 em 方块顶部的距离，当前值为0。| - | emHeightDescent | number | 从CanvasRenderingContext2D.textBaseline 属性标明的水平线到线框中 em 方块底部的距离，当前值为0。| - | fontBoundingBoxAscent | number | 从CanvasRenderingContext2D.textBaseline 属性标明的水平线到渲染文本的所有字体的矩形最高边界顶部的距离，当前值为0。| - | fontBoundingBoxDescent | number | 从CanvasRenderingContext2D.textBaseline 属性标明的水平线到渲染文本的所有字体的矩形边界最底部的距离，当前值为0。| - | hangingBaseline | number | 从CanvasRenderingContext2D.textBaseline 属性标明的水平线到线框的 hanging 基线的距离，当前值为0。| - | ideographicBaseline | number | 从CanvasRenderingContext2D.textBaseline 属性标明的水平线到线框的 ideographic 基线的距离，当前值为0。| +| 属性 | 类型 | 描述 | +| ------------------------ | ------ | ---------------------------------------- | +| width | number | 字符串的宽度。 | +| height | number | 字符串的高度。 | +| actualBoundingBoxAscent | number | 从CanvasRenderingContext2D.textBaseline 属性标明的水平线到渲染文本的矩形边界顶部的距离，当前值为0。 | +| actualBoundingBoxDescent | number | 从CanvasRenderingContext2D.textBaseline 属性标明的水平线到渲染文本的矩形边界底部的距离，当前值为0。 | +| actualBoundingBoxLeft | number | 平行于基线，从CanvasRenderingContext2D.textAlign 属性确定的对齐点到文本矩形边界左侧的距离，当前值为0。 | +| actualBoundingBoxRight | number | 平行于基线，从CanvasRenderingContext2D.textAlign 属性确定的对齐点到文本矩形边界右侧的距离，当前值为0。 | +| alphabeticBaseline | number | 从CanvasRenderingContext2D.textBaseline 属性标明的水平线到线框的 alphabetic 基线的距离，当前值为0。 | +| emHeightAscent | number | 从CanvasRenderingContext2D.textBaseline 属性标明的水平线到线框中 em 方块顶部的距离，当前值为0。 | +| emHeightDescent | number | 从CanvasRenderingContext2D.textBaseline 属性标明的水平线到线框中 em 方块底部的距离，当前值为0。 | +| fontBoundingBoxAscent | number | 从CanvasRenderingContext2D.textBaseline 属性标明的水平线到渲染文本的所有字体的矩形最高边界顶部的距离，当前值为0。 | +| fontBoundingBoxDescent | number | 从CanvasRenderingContext2D.textBaseline 属性标明的水平线到渲染文本的所有字体的矩形边界最底部的距离，当前值为0。 | +| hangingBaseline | number | 从CanvasRenderingContext2D.textBaseline 属性标明的水平线到线框的 hanging 基线的距离，当前值为0。 | +| ideographicBaseline | number | 从CanvasRenderingContext2D.textBaseline 属性标明的水平线到线框的 ideographic 基线的距离，当前值为0。 | @@ -956,9 +958,9 @@ stroke(path?: Path2D): void **参数：** - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ---- | ---------------------------------------- | ---- | ---- | ------------ | - | path | [Path2D](ts-components-canvas-path2d.md) | 否 | null | 需要绘制的Path2D。 | +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---- | ---------------------------------------- | ---- | ---- | ------------ | +| path | [Path2D](ts-components-canvas-path2d.md) | 否 | null | 需要绘制的Path2D。 | **示例：** @@ -1040,10 +1042,10 @@ moveTo(x: number, y: number): void **参数：** - | 参数 | 类型 | 必填 | 默认值 | 说明 | - | ---- | ------ | ---- | ---- | --------- | - | x | number | 是 | 0 | 指定位置的x坐标。 | - | y | number | 是 | 0 | 指定位置的y坐标。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| ---- | ------ | ---- | ---- | --------- | +| x | number | 是 | 0 | 指定位置的x坐标。 | +| y | number | 是 | 0 | 指定位置的y坐标。 | **示例：** @@ -1085,10 +1087,10 @@ lineTo(x: number, y: number): void **参数：** - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ---- | ------ | ---- | ---- | --------- | - | x | number | 是 | 0 | 指定位置的x坐标。 | - | y | number | 是 | 0 | 指定位置的y坐标。 | +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---- | ------ | ---- | ---- | --------- | +| x | number | 是 | 0 | 指定位置的x坐标。 | +| y | number | 是 | 0 | 指定位置的y坐标。 | **示例：** @@ -1170,16 +1172,16 @@ createPattern(image: ImageBitmap, repetition: string | null): CanvasPattern | nu **参数：** - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ---------- | ---------------------------------------- | ---- | ---- | ---------------------------------------- | - | image | [ImageBitmap](ts-components-canvas-imagebitmap.md) | 是 | null | 图源对象，具体参考ImageBitmap对象。 | - | repetition | string | 是 | “” | 设置图像重复的方式，取值为：'repeat'、'repeat-x'、 'repeat-y'、'no-repeat'。 | +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---------- | ---------------------------------------- | ---- | ---- | ---------------------------------------- | +| image | [ImageBitmap](ts-components-canvas-imagebitmap.md) | 是 | null | 图源对象，具体参考ImageBitmap对象。 | +| repetition | string | 是 | “” | 设置图像重复的方式，取值为：'repeat'、'repeat-x'、 'repeat-y'、'no-repeat'。 | **返回值：**： - | 类型 | 说明 | - | ---------- | ---------------------------------------- | - | [CanvasPattern](#canvaspattern) | 通过指定图像和重复方式创建图片填充的模板对象。 | +| 类型 | 说明 | +| ------------------------------- | ----------------------- | +| [CanvasPattern](#canvaspattern) | 通过指定图像和重复方式创建图片填充的模板对象。 | **示例：** @@ -1221,14 +1223,14 @@ bezierCurveTo(cp1x: number, cp1y: number, cp2x: number, cp2y: number, x: number, **参数：** - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ---- | ------ | ---- | ---- | -------------- | - | cp1x | number | 是 | 0 | 第一个贝塞尔参数的x坐标值。 | - | cp1y | number | 是 | 0 | 第一个贝塞尔参数的y坐标值。 | - | cp2x | number | 是 | 0 | 第二个贝塞尔参数的x坐标值。 | - | cp2y | number | 是 | 0 | 第二个贝塞尔参数的y坐标值。 | - | x | number | 是 | 0 | 路径结束时的x坐标值。 | - | y | number | 是 | 0 | 路径结束时的y坐标值。 | +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---- | ------ | ---- | ---- | -------------- | +| cp1x | number | 是 | 0 | 第一个贝塞尔参数的x坐标值。 | +| cp1y | number | 是 | 0 | 第一个贝塞尔参数的y坐标值。 | +| cp2x | number | 是 | 0 | 第二个贝塞尔参数的x坐标值。 | +| cp2y | number | 是 | 0 | 第二个贝塞尔参数的y坐标值。 | +| x | number | 是 | 0 | 路径结束时的x坐标值。 | +| y | number | 是 | 0 | 路径结束时的y坐标值。 | **示例：** @@ -1270,12 +1272,12 @@ quadraticCurveTo(cpx: number, cpy: number, x: number, y: number): void **参数：** - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ---- | ------ | ---- | ---- | ----------- | - | cpx | number | 是 | 0 | 贝塞尔参数的x坐标值。 | - | cpy | number | 是 | 0 | 贝塞尔参数的y坐标值。 | - | x | number | 是 | 0 | 路径结束时的x坐标值。 | - | y | number | 是 | 0 | 路径结束时的y坐标值。 | +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---- | ------ | ---- | ---- | ----------- | +| cpx | number | 是 | 0 | 贝塞尔参数的x坐标值。 | +| cpy | number | 是 | 0 | 贝塞尔参数的y坐标值。 | +| x | number | 是 | 0 | 路径结束时的x坐标值。 | +| y | number | 是 | 0 | 路径结束时的y坐标值。 | **示例：** @@ -1317,14 +1319,14 @@ arc(x: number, y: number, radius: number, startAngle: number, endAngle: number, **参数：** - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ------------- | ------- | ---- | ----- | ---------- | - | x | number | 是 | 0 | 弧线圆心的x坐标值。 | - | y | number | 是 | 0 | 弧线圆心的y坐标值。 | - | radius | number | 是 | 0 | 弧线的圆半径。 | - | startAngle | number | 是 | 0 | 弧线的起始弧度。 | - | endAngle | number | 是 | 0 | 弧线的终止弧度。 | - | counterclockwise | boolean | 否 | false | 是否逆时针绘制圆弧。 | +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---------------- | ------- | ---- | ----- | ---------- | +| x | number | 是 | 0 | 弧线圆心的x坐标值。 | +| y | number | 是 | 0 | 弧线圆心的y坐标值。 | +| radius | number | 是 | 0 | 弧线的圆半径。 | +| startAngle | number | 是 | 0 | 弧线的起始弧度。 | +| endAngle | number | 是 | 0 | 弧线的终止弧度。 | +| counterclockwise | boolean | 否 | false | 是否逆时针绘制圆弧。 | **示例：** @@ -1365,13 +1367,13 @@ arcTo(x1: number, y1: number, x2: number, y2: number, radius: number): void **参数：** - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ------ | ------ | ---- | ---- | --------------- | - | x1 | number | 是 | 0 | 圆弧经过的第一个点的x坐标值。 | - | y1 | number | 是 | 0 | 圆弧经过的第一个点的y坐标值。 | - | x2 | number | 是 | 0 | 圆弧经过的第二个点的x坐标值。 | - | y2 | number | 是 | 0 | 圆弧经过的第二个点的y坐标值。 | - | radius | number | 是 | 0 | 圆弧的圆半径值。 | +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ------ | ------ | ---- | ---- | --------------- | +| x1 | number | 是 | 0 | 圆弧经过的第一个点的x坐标值。 | +| y1 | number | 是 | 0 | 圆弧经过的第一个点的y坐标值。 | +| x2 | number | 是 | 0 | 圆弧经过的第二个点的x坐标值。 | +| y2 | number | 是 | 0 | 圆弧经过的第二个点的y坐标值。 | +| radius | number | 是 | 0 | 圆弧的圆半径值。 | **示例：** @@ -1412,16 +1414,16 @@ ellipse(x: number, y: number, radiusX: number, radiusY: number, rotation: number **参数：** - | 参数 | 类型 | 必填 | 默认值 | 说明 | - | ------------- | ------- | ---- | ----- | ----------------- | - | x | number | 是 | 0 | 椭圆圆心的x轴坐标。 | - | y | number | 是 | 0 | 椭圆圆心的y轴坐标。 | - | radiusX | number | 是 | 0 | 椭圆x轴的半径长度。 | - | radiusY | number | 是 | 0 | 椭圆y轴的半径长度。 | - | rotation | number | 是 | 0 | 椭圆的旋转角度，单位为弧度。 | - | startAngle | number | 是 | 0 | 椭圆绘制的起始点角度，以弧度表示。 | - | endAngle | number | 是 | 0 | 椭圆绘制的结束点角度，以弧度表示。 | - | counterclockwise | boolean | 否 | false | 是否以逆时针方向绘制椭圆。 | +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| ---------------- | ------- | ---- | ----- | ----------------- | +| x | number | 是 | 0 | 椭圆圆心的x轴坐标。 | +| y | number | 是 | 0 | 椭圆圆心的y轴坐标。 | +| radiusX | number | 是 | 0 | 椭圆x轴的半径长度。 | +| radiusY | number | 是 | 0 | 椭圆y轴的半径长度。 | +| rotation | number | 是 | 0 | 椭圆的旋转角度，单位为弧度。 | +| startAngle | number | 是 | 0 | 椭圆绘制的起始点角度，以弧度表示。 | +| endAngle | number | 是 | 0 | 椭圆绘制的结束点角度，以弧度表示。 | +| counterclockwise | boolean | 否 | false | 是否以逆时针方向绘制椭圆。 | **示例：** @@ -1462,12 +1464,12 @@ rect(x: number, y: number, w: number, h: number): void **参数：** - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ------ | ------ | ---- | ---- | ------------- | - | x | number | 是 | 0 | 指定矩形的左上角x坐标值。 | - | y | number | 是 | 0 | 指定矩形的左上角y坐标值。 | - | w | number | 是 | 0 | 指定矩形的宽度。 | - | h | number | 是 | 0 | 指定矩形的高度。 | +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---- | ------ | ---- | ---- | ------------- | +| x | number | 是 | 0 | 指定矩形的左上角x坐标值。 | +| y | number | 是 | 0 | 指定矩形的左上角y坐标值。 | +| w | number | 是 | 0 | 指定矩形的宽度。 | +| h | number | 是 | 0 | 指定矩形的高度。 | **示例：** @@ -1507,9 +1509,9 @@ fill(fillRule?: CanvasFillRule): void **参数:** - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ------ | ------ | ---- | ---- | ------------- | - | fillRule | CanvasFillRule | 否 | "nonzero" | 指定要填充对象的规则。
可选参数为："nonzero", "evenodd"。| +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| -------- | -------------- | ---- | --------- | ---------------------------------------- | +| fillRule | CanvasFillRule | 否 | "nonzero" | 指定要填充对象的规则。
可选参数为："nonzero", "evenodd"。 | **示例:** @@ -1548,10 +1550,10 @@ fill(path: Path2D, fillRule?: CanvasFillRule): void **参数:** - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ------ | ------ | ---- | ---- | ------------- | - | path | Path2D | 是 | | Path2D填充路径。 | - | fillRule | CanvasFillRule | 否 | "nonzero" | 指定要填充对象的规则。
可选参数为："nonzero", "evenodd"。| +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| -------- | -------------- | ---- | --------- | ---------------------------------------- | +| path | Path2D | 是 | | Path2D填充路径。 | +| fillRule | CanvasFillRule | 否 | "nonzero" | 指定要填充对象的规则。
可选参数为："nonzero", "evenodd"。 | **示例:** @@ -1588,7 +1590,7 @@ struct Fill { .height('100%') } } - ``` +``` ![zh-cn_image_000000127777774](figures/zh-cn_image_000000127777774.png) @@ -1601,9 +1603,9 @@ clip(fillRule?: CanvasFillRule): void **参数:** - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ------ | ------ | ---- | ---- | ------------- | - | fillRule | CanvasFillRule | 否 | "nonzero" | 指定要剪切对象的规则。
可选参数为："nonzero", "evenodd"。| +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| -------- | -------------- | ---- | --------- | ---------------------------------------- | +| fillRule | CanvasFillRule | 否 | "nonzero" | 指定要剪切对象的规则。
可选参数为："nonzero", "evenodd"。 | **示例:** @@ -1644,11 +1646,11 @@ clip(path: Path2D, fillRule?: CanvasFillRule): void **参数:** - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ------ | ------ | ---- | ---- | ------------- | - | path | Path2D | 是 | - | Path2D剪切路径。 | - | fillRule | CanvasFillRule | 否 | "nonzero" | 指定要剪切对象的规则。
可选参数为："nonzero", "evenodd"。| - +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| -------- | -------------- | ---- | --------- | ---------------------------------------- | +| path | Path2D | 是 | - | Path2D剪切路径。 | +| fillRule | CanvasFillRule | 否 | "nonzero" | 指定要剪切对象的规则。
可选参数为："nonzero", "evenodd"。 | + ### filter @@ -1659,9 +1661,9 @@ filter(filter: string): void **参数:** - | 参数 | 类型 | 必填 | 默认值 | 说明 | - | ------ | ------ | ---- | ---- | ------------- | - | filter | string | 是 | - | 接受各类滤镜效果的函数。| +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| ------ | ------ | ---- | ---- | ------------ | +| filter | string | 是 | - | 接受各类滤镜效果的函数。 | ### getTransform @@ -1693,9 +1695,9 @@ rotate(angle: number): void **参数：** - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ------ | ------ | ---- | ---- | ---------------------------------------- | - | angle | number | 是 | 0 | 设置顺时针旋转的弧度值，可以通过Math.PI / 180将角度转换为弧度值。 | +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ----- | ------ | ---- | ---- | ---------------------------------------- | +| angle | number | 是 | 0 | 设置顺时针旋转的弧度值，可以通过Math.PI / 180将角度转换为弧度值。 | **示例：** @@ -1735,10 +1737,10 @@ scale(x: number, y: number): void **参数：** - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ---- | ------ | ---- | ---- | ----------- | - | x | number | 是 | 0 | 设置水平方向的缩放值。 | - | y | number | 是 | 0 | 设置垂直方向的缩放值。 | +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---- | ------ | ---- | ---- | ----------- | +| x | number | 是 | 0 | 设置水平方向的缩放值。 | +| y | number | 是 | 0 | 设置垂直方向的缩放值。 | **示例：** @@ -1786,14 +1788,14 @@ transform方法对应一个变换矩阵，想对一个图形进行变化的时 **参数：** - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ---------- | ------ | ---- | ---- | -------- | - | a | number | 是 | 0 |scaleX: 指定水平缩放值。 | - | b | number | 是 | 0 |skewX: 指定水平倾斜值。 | - | c | number | 是 | 0 |skewY: 指定垂直倾斜值。 | - | d | number | 是 | 0 |scaleY: 指定垂直缩放值。 | - | e | number | 是 | 0 |translateX: 指定水平移动值。 | - | f | number | 是 | 0 |translateY: 指定垂直移动值。 | +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---- | ------ | ---- | ---- | -------------------- | +| a | number | 是 | 0 | scaleX: 指定水平缩放值。 | +| b | number | 是 | 0 | skewX: 指定水平倾斜值。 | +| c | number | 是 | 0 | skewY: 指定垂直倾斜值。 | +| d | number | 是 | 0 | scaleY: 指定垂直缩放值。 | +| e | number | 是 | 0 | translateX: 指定水平移动值。 | +| f | number | 是 | 0 | translateY: 指定垂直移动值。 | **示例：** @@ -1839,14 +1841,14 @@ setTransfrom方法使用的参数和transform()方法相同，但setTransform() **参数：** - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ---------- | ------ | ---- | ---- | -------- | - | a | number | 是 | 0 |scaleX: 指定水平缩放值。 | - | b | number | 是 | 0 |skewX: 指定水平倾斜值。 | - | c | number | 是 | 0 |skewY: 指定垂直倾斜值。 | - | d | number | 是 | 0 |scaleY: 指定垂直缩放值。 | - | e | number | 是 | 0 |translateX: 指定水平移动值。 | - | f | number | 是 | 0 |translateY: 指定垂直移动值。 | +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---- | ------ | ---- | ---- | -------------------- | +| a | number | 是 | 0 | scaleX: 指定水平缩放值。 | +| b | number | 是 | 0 | skewX: 指定水平倾斜值。 | +| c | number | 是 | 0 | skewY: 指定垂直倾斜值。 | +| d | number | 是 | 0 | scaleY: 指定垂直缩放值。 | +| e | number | 是 | 0 | translateX: 指定水平移动值。 | +| f | number | 是 | 0 | translateY: 指定垂直移动值。 | **示例：** @@ -1894,10 +1896,10 @@ translate(x: number, y: number): void **参数：** - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ---- | ------ | ---- | ---- | -------- | - | x | number | 是 | 0 | 设置水平平移量。 | - | y | number | 是 | 0 | 设置竖直平移量。 | +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---- | ------ | ---- | ---- | -------- | +| x | number | 是 | 0 | 设置水平平移量。 | +| y | number | 是 | 0 | 设置竖直平移量。 | **示例：** @@ -1942,17 +1944,17 @@ drawImage(image: ImageBitmap | PixelMap, sx: number, sy: number, sw: number, sh: **参数：** - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ------- | ---------------------------------------- | ---- | ---- | ---------------------------------------- | - | image | [ImageBitmap](ts-components-canvas-imagebitmap.md)或[PixelMap](../apis/js-apis-image.md#pixelmap7) | 是 | null | 图片资源，请参考ImageBitmap或PixelMap。 | - | sx | number | 否 | 0 | 裁切源图像时距离源图像左上角的x坐标值。 | - | sy | number | 否 | 0 | 裁切源图像时距离源图像左上角的y坐标值。 | - | sw | number | 否 | 0 | 裁切源图像时需要裁切的宽度。 | - | sh | number | 否 | 0 | 裁切源图像时需要裁切的高度。 | - | dx | number | 是 | 0 | 绘制区域左上角在x轴的位置。 | - | dy | number | 是 | 0 | 绘制区域左上角在y 轴的位置。 | - | dw | number | 否 | 0 | 绘制区域的宽度。当绘制区域的宽度和裁剪图像的宽度不一致时，将图像宽度拉伸或压缩为绘制区域的宽度。 | - | dh | number | 否 | 0 | 绘制区域的高度。当绘制区域的高度和裁剪图像的高度不一致时，将图像高度拉伸或压缩为绘制区域的高度。 | +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ----- | ---------------------------------------- | ---- | ---- | ---------------------------------------- | +| image | [ImageBitmap](ts-components-canvas-imagebitmap.md)或[PixelMap](../apis/js-apis-image.md#pixelmap7) | 是 | null | 图片资源，请参考ImageBitmap或PixelMap。 | +| sx | number | 否 | 0 | 裁切源图像时距离源图像左上角的x坐标值。 | +| sy | number | 否 | 0 | 裁切源图像时距离源图像左上角的y坐标值。 | +| sw | number | 否 | 0 | 裁切源图像时需要裁切的宽度。 | +| sh | number | 否 | 0 | 裁切源图像时需要裁切的高度。 | +| dx | number | 是 | 0 | 绘制区域左上角在x轴的位置。 | +| dy | number | 是 | 0 | 绘制区域左上角在y 轴的位置。 | +| dw | number | 否 | 0 | 绘制区域的宽度。当绘制区域的宽度和裁剪图像的宽度不一致时，将图像宽度拉伸或压缩为绘制区域的宽度。 | +| dh | number | 否 | 0 | 绘制区域的高度。当绘制区域的高度和裁剪图像的高度不一致时，将图像高度拉伸或压缩为绘制区域的高度。 | **示例：** @@ -1993,10 +1995,10 @@ createImageData(sw: number, sh: number): ImageData **参数：** - | 参数 | 类型 | 必填 | 默认 | 描述 | - | ------ | ------ | ---- | ---- | ------------- | - | sw | number | 是 | 0 | ImageData的宽度。 | - | sh | number | 是 | 0 | ImageData的高度。 | +| 参数 | 类型 | 必填 | 默认 | 描述 | +| ---- | ------ | ---- | ---- | ------------- | +| sw | number | 是 | 0 | ImageData的宽度。 | +| sh | number | 是 | 0 | ImageData的高度。 | ### createImageData @@ -2007,15 +2009,15 @@ createImageData(imageData: ImageData): ImageData **参数：** - | 参数 | 类型 | 必填 | 默认 | 描述 | - | --------- | ------ | ---- | ---- | ----------------- | - | imagedata | [ImageData](ts-components-canvas-imagebitmap.md)| 是 | null | 复制现有的ImageData对象。 | +| 参数 | 类型 | 必填 | 默认 | 描述 | +| --------- | ---------------------------------------- | ---- | ---- | ----------------- | +| imagedata | [ImageData](ts-components-canvas-imagebitmap.md) | 是 | null | 复制现有的ImageData对象。 | **返回值：** - | 类型 | 说明 | - | ---------- | ---------------------------------------- | - | [ImageData](ts-components-canvas-imagebitmap.md) | 新的ImageData对象。| +| 类型 | 说明 | +| ---------------------------------------- | -------------- | +| [ImageData](ts-components-canvas-imagebitmap.md) | 新的ImageData对象。 | ### getPixelMap @@ -2026,18 +2028,18 @@ getPixelMap(sx: number, sy: number, sw: number, sh: number): PixelMap **参数：** - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ---- | ------ | ---- | ---- | --------------- | - | sx | number | 是 | 0 | 需要输出的区域的左上角x坐标。 | - | sy | number | 是 | 0 | 需要输出的区域的左上角y坐标。 | - | sw | number | 是 | 0 | 需要输出的区域的宽度。 | - | sh | number | 是 | 0 | 需要输出的区域的高度。 | +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---- | ------ | ---- | ---- | --------------- | +| sx | number | 是 | 0 | 需要输出的区域的左上角x坐标。 | +| sy | number | 是 | 0 | 需要输出的区域的左上角y坐标。 | +| sw | number | 是 | 0 | 需要输出的区域的宽度。 | +| sh | number | 是 | 0 | 需要输出的区域的高度。 | **返回值：** - | 类型 | 说明 | - | ---------- | ---------------------------------------- | - | [PixelMap](../apis/js-apis-image.md#pixelmap7) | 新的PixelMap对象。 | +| 类型 | 说明 | +| ---------------------------------------- | ------------- | +| [PixelMap](../apis/js-apis-image.md#pixelmap7) | 新的PixelMap对象。 | ### getImageData @@ -2047,18 +2049,18 @@ getImageData(sx: number, sy: number, sw: number, sh: number): ImageData **参数：** - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ---- | ------ | ---- | ---- | --------------- | - | sx | number | 是 | 0 | 需要输出的区域的左上角x坐标。 | - | sy | number | 是 | 0 | 需要输出的区域的左上角y坐标。 | - | sw | number | 是 | 0 | 需要输出的区域的宽度。 | - | sh | number | 是 | 0 | 需要输出的区域的高度。 | +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---- | ------ | ---- | ---- | --------------- | +| sx | number | 是 | 0 | 需要输出的区域的左上角x坐标。 | +| sy | number | 是 | 0 | 需要输出的区域的左上角y坐标。 | +| sw | number | 是 | 0 | 需要输出的区域的宽度。 | +| sh | number | 是 | 0 | 需要输出的区域的高度。 | **返回值：** - | 类型 | 说明 | - | ---------- | ---------------------------------------- | - | [ImageData](ts-components-canvas-imagebitmap.md) | 新的ImageData对象。 | +| 类型 | 说明 | +| ---------------------------------------- | -------------- | +| [ImageData](ts-components-canvas-imagebitmap.md) | 新的ImageData对象。 | ### putImageData @@ -2071,15 +2073,15 @@ putImageData(imageData: ImageData, dx: number, dy: number, dirtyX: number, dirty **参数：** - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ----------- | ------ | ---- | ------------ | ----------------------------- | - | imagedata | [ImageData](ts-components-canvas-imagebitmap.md) | 是 | null | 包含像素值的ImageData对象。 | - | dx | number | 是 | 0 | 填充区域在x轴方向的偏移量。 | - | dy | number | 是 | 0 | 填充区域在y轴方向的偏移量。 | - | dirtyX | number | 否 | 0 | 源图像数据矩形裁切范围左上角距离源图像左上角的x轴偏移量。 | - | dirtyY | number | 否 | 0 | 源图像数据矩形裁切范围左上角距离源图像左上角的y轴偏移量。 | - | dirtyWidth | number | 否 | imagedata的宽度 | 源图像数据矩形裁切范围的宽度。 | - | dirtyHeight | number | 否 | imagedata的高度 | 源图像数据矩形裁切范围的高度。 | +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ----------- | ---------------------------------------- | ---- | ------------ | ----------------------------- | +| imagedata | [ImageData](ts-components-canvas-imagebitmap.md) | 是 | null | 包含像素值的ImageData对象。 | +| dx | number | 是 | 0 | 填充区域在x轴方向的偏移量。 | +| dy | number | 是 | 0 | 填充区域在y轴方向的偏移量。 | +| dirtyX | number | 否 | 0 | 源图像数据矩形裁切范围左上角距离源图像左上角的x轴偏移量。 | +| dirtyY | number | 否 | 0 | 源图像数据矩形裁切范围左上角距离源图像左上角的y轴偏移量。 | +| dirtyWidth | number | 否 | imagedata的宽度 | 源图像数据矩形裁切范围的宽度。 | +| dirtyHeight | number | 否 | imagedata的高度 | 源图像数据矩形裁切范围的高度。 | **示例：** @@ -2125,8 +2127,8 @@ setLineDash(segments: number[]): void **参数：** -| 参数 | 类型 | 描述 | -| -------- | ----- | -------------------- | +| 参数 | 类型 | 描述 | +| -------- | -------- | ------------------- | | segments | number[] | 描述线段如何交替和线段间距长度的数组。 | **示例：** @@ -2167,8 +2169,8 @@ getLineDash(): number[] **返回值：** -| 类型 | 说明 | -| ----- | ------------------------ | +| 类型 | 说明 | +| -------- | ------------------------ | | number[] | 返回数组，该数组用来描述线段如何交替和间距长度。 | **示例：** @@ -2210,9 +2212,9 @@ imageSmoothingQuality(quality: imageSmoothingQuality) **参数：** -| 参数 | 类型 | 描述 | -| ------ | ----------- | ------------------ | -| quality |imageSmoothingQuality | 支持如下三种类型：'low', 'medium', 'high'。 | +| 参数 | 类型 | 描述 | +| ------- | --------------------- | ---------------------------------------- | +| quality | imageSmoothingQuality | 支持如下三种类型：'low', 'medium', 'high'。 | @@ -2224,9 +2226,9 @@ transferFromImageBitmap(bitmap: ImageBitmap): void **参数：** -| 参数 | 类型 | 描述 | -| ------ | ----------- | ------------------ | -| bitmap |[ImageData](ts-components-canvas-imagebitmap.md) | 待显示的ImageBitmap对象。 | +| 参数 | 类型 | 描述 | +| ------ | ---------------------------------------- | ------------------ | +| bitmap | [ImageData](ts-components-canvas-imagebitmap.md) | 待显示的ImageBitmap对象。 | **示例：** @@ -2386,12 +2388,12 @@ createLinearGradient(x0: number, y0: number, x1: number, y1: number): void **参数：** - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ---- | ------ | ---- | ---- | -------- | - | x0 | number | 是 | 0 | 起点的x轴坐标。 | - | y0 | number | 是 | 0 | 起点的y轴坐标。 | - | x1 | number | 是 | 0 | 终点的x轴坐标。 | - | y1 | number | 是 | 0 | 终点的y轴坐标。 | +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---- | ------ | ---- | ---- | -------- | +| x0 | number | 是 | 0 | 起点的x轴坐标。 | +| y0 | number | 是 | 0 | 起点的y轴坐标。 | +| x1 | number | 是 | 0 | 终点的x轴坐标。 | +| y1 | number | 是 | 0 | 终点的y轴坐标。 | **示例：** @@ -2435,14 +2437,14 @@ createRadialGradient(x0: number, y0: number, r0: number, x1: number, y1: number, **参数：** - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ---- | ------ | ---- | ---- | ----------------- | - | x0 | number | 是 | 0 | 起始圆的x轴坐标。 | - | y0 | number | 是 | 0 | 起始圆的y轴坐标。 | - | r0 | number | 是 | 0 | 起始圆的半径。必须是非负且有限的。 | - | x1 | number | 是 | 0 | 终点圆的x轴坐标。 | - | y1 | number | 是 | 0 | 终点圆的y轴坐标。 | - | r1 | number | 是 | 0 | 终点圆的半径。必须为非负且有限的。 | +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---- | ------ | ---- | ---- | ----------------- | +| x0 | number | 是 | 0 | 起始圆的x轴坐标。 | +| y0 | number | 是 | 0 | 起始圆的y轴坐标。 | +| r0 | number | 是 | 0 | 起始圆的半径。必须是非负且有限的。 | +| x1 | number | 是 | 0 | 终点圆的x轴坐标。 | +| y1 | number | 是 | 0 | 终点圆的y轴坐标。 | +| r1 | number | 是 | 0 | 终点圆的半径。必须为非负且有限的。 | **示例：** diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-alphabet-indexer.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-alphabet-indexer.md index ab02aba8fb49b683f89f8794b2223b0c7e6dff9c..62f3d0c96531cf3486e49d04ab2f0e1ad08f16cc 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-alphabet-indexer.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-alphabet-indexer.md @@ -30,17 +30,19 @@ AlphabetIndexer(value: {arrayValue: Array<string>, selected: number}) | 名称 | 参数类型 | 描述 | | ----------------------- | --------------- | ----------------------------------------------------------- | -| color | [ResourceColor](../../ui/ts-types.md) | 设置文字颜色。 | -| selectedColor | [ResourceColor](../../ui/ts-types.md) | 设置选中项文字颜色。 | -| popupColor | [ResourceColor](../../ui/ts-types.md) | 设置提示弹窗文字颜色。 | -| selectedBackgroundColor | [ResourceColor](../../ui/ts-types.md) | 设置选中项背景颜色。 | -| popupBackground | [ResourceColor](../../ui/ts-types.md) | 设置提示弹窗背景色。 | +| color | [ResourceColor](../../ui/ts-types.md#resourcecolor8) | 设置文字颜色。 | +| selectedColor | [ResourceColor](../../ui/ts-types.md#resourcecolor8) | 设置选中项文字颜色。 | +| popupColor | [ResourceColor](../../ui/ts-types.md#resourcecolor8) | 设置提示弹窗文字颜色。 | +| selectedBackgroundColor | [ResourceColor](../../ui/ts-types.md#resourcecolor8) | 设置选中项背景颜色。 | +| popupBackground | [ResourceColor](../../ui/ts-types.md#resourcecolor8) | 设置提示弹窗背景色。 | | usingPopup | boolean | 设置是否使用提示弹窗。 | -| selectedFont | [Font](../../ui/ts-types.md) | 设置选中项文字样式。 | -| popupFont | [Font](../../ui/ts-types.md) | 设置提示弹窗字体样式。 | -| font | [Font](../../ui/ts-types.md) | 设置字母索引条默认字体样式。 | -| itemSize | Length | 设置字母索引条字母区域大小，字母区域为正方形，即正方形边长。 | +| selectedFont | [Font](../../ui/ts-types.md#font) | 设置选中项文字样式。 | +| popupFont | [Font](../../ui/ts-types.md#font) | 设置提示弹窗字体样式。 | +| font | [Font](../../ui/ts-types.md#font) | 设置字母索引条默认字体样式。 | +| itemSize | string \| number | 设置字母索引条字母区域大小，字母区域为正方形，即正方形边长。 | | alignStyle | IndexerAlign | 设置字母索引条弹框的对齐样式，支持弹窗显示在索引条右侧和左侧。
默认值：IndexerAlign.Right | +| selected | number | 设置选中项索引值。 | +| popupPosition | [Position](../../ui/ts-types.md#position8) | 设置弹出窗口相对于索引器条上边框中点的位置。 | - IndexerAlign枚举说明 | 名称 | 描述 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-gridcol.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-gridcol.md index 7ae03e5762361b2f41e01dd52d300a719c73c7e3..83fa0086f0e4e5881b36b2796d09a5e6f0704973 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-gridcol.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-gridcol.md @@ -17,7 +17,7 @@ 可以包含单个子组件。 ## 接口 -GridCol(span?: number | GridColColumnOption, offset?: number | GridColColumnOption, order?: number | GridColColumnOption) +GridCol(option?: {span?: number | GridColColumnOption, offset?: number | GridColColumnOption, order?: number | GridColColumnOption}) **参数**： | 参数名 |类型|必填|说明 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-gridcontainer.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-gridcontainer.md index 4f779e905760c0ff8a93d15f0a8c703e5e3ede9f..024f1fc399352abe46f79818afed12279c1e2ced 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-gridcontainer.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-gridcontainer.md @@ -19,7 +19,7 @@ ## 接口 -GridContainer(options?: { columns?: number | 'auto', sizeType?: SizeType, gutter?: Length, margin?: Length}) +GridContainer(value?: { columns?: number | 'auto', sizeType?: SizeType, gutter?: Length, margin?: Length}) - 参数 | 参数名 | 类型 | 必填 | 默认值 | 说明 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-griditem.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-griditem.md index 8377d8dccf74ba49bd94c9dba68f5bd4ad0bb2cf..5b78f6f6d4c4d4574c43973996279f159312a785 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-griditem.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-griditem.md @@ -38,7 +38,7 @@ GridItem() | 名称 | 功能描述 | | -------- | -------- | -| onSelect(callback: (isSelected: boolean) => void)8+ | GridItem元素被鼠标框选的状态改变时触发回调。
isSelected：进入鼠标框选范围即被选中返回true， 移出鼠标框选范围即未被选中返回false。 | +| onSelect(event: (isSelected: boolean) => void)8+ | GridItem元素被鼠标框选的状态改变时触发回调。
isSelected：进入鼠标框选范围即被选中返回true， 移出鼠标框选范围即未被选中返回false。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-gridrow.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-gridrow.md index 9cb2070a0015d6e1e044cd84e9c5b56cd0e3b68f..d1ee3980df402eaa81bf0a2ae84cd0a1f2be1d5f 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-gridrow.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-gridrow.md @@ -20,25 +20,27 @@ ## 接口 -GridRow(options?: {columns?: number | GridRowColumnOption, gutter?: Length | GetterOption, breakpoints?: BreakPoints, direction?: GridRowDirection}) +GridRow(option?: {columns?: number | GridRowColumnOption, gutter?: Length | GutterOption, breakpoints?: BreakPoints, direction?: GridRowDirection}) **参数：** | 参数名 |类型|必填|说明| |-----|-----|----|----| -|gutter|Length \| GetterOption| 否 |栅格布局间距，x代表水平方向。| +|gutter|Length \| GutterOption| 否 |栅格布局间距，x代表水平方向。| |columns| number \| GridRowColumnOption | 否 |设置布局列数。| |breakpoints|BreakPoints| 否 |用于设置断点值的断点数列以及基于窗口或容器尺寸的相应参照。| |direction|GridRowDirection| 否 |栅格布局排列方向。| -## GetterOption +## GutterOption | 参数名 | 参数类型 | 必填 | 参数描述 | | ----- | ------ | ---- | ---------------------------------------- | -| x | Length \| GridRowSizeOption | 否 | 水平getter option。 | -| y | Length \| GridRowSizeOption | 否 | 竖直getter option。 | +| x | Length \| GridRowSizeOption | 否 | 水平gutter option。 | +| y | Length \| GridRowSizeOption | 否 | 竖直gutter option。 | ## GridRowColumnOption +栅格在不同宽度设备类型下，栅格列数。 + | 参数名 | 参数类型 | 必填 | 参数描述 | | ----- | ------ | ---- | ---------------------------------------- | | xs | number | 否 | 最小宽度类型设备。 | @@ -48,12 +50,25 @@ GridRow(options?: {columns?: number | GridRowColumnOption, gutter?: Length | Get | xl | number | 否 | 特大宽度类型设备。 | | xxl | number | 否 | 超大宽度类型设备。 | +## GridRowSizeOption + +栅格在不同宽度设备类型下，gutter的大小。 + +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ----- | ------ | ---- | ---------------------------------------- | +| xs | Length | 否 | 最小宽度类型设备。 | +| sm | Length | 否 | 小宽度类型设备。 | +| md | Length | 否 | 中等宽度类型设备。 | +| lg | Length | 否 | 大宽度类型设备。 | +| xl | Length | 否 | 特大宽度类型设备。 | +| xxl | Length | 否 | 超大宽度类型设备。 | + ## BreakPoints | 参数名 | 参数类型 | 必填 | 参数描述 | | ----- | ------ | ---- | ---------------------------------------- | | value | Array | 否 | 用于设置断点位置的单调递增数组。
默认值：["320vp", "520vp", "840vp"] | -| reference | BreakpointsReference | 否 | - | 竖直getter option。 | +| reference | BreakpointsReference | 否 | - | 竖直gutter option。 | ```ts // 启用xs、sm、md共3个断点 breakpoints: {value: ["100vp", "200vp"]} @@ -108,7 +123,7 @@ GridRow(options?: {columns?: number | GridRowColumnOption, gutter?: Length | Get ### onBreakpointChange -onBreakpointChange(callback: (breakpoints: string) => void +onBreakpointChange(callback: (breakpoints: string) => void) **参数：** diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-circle.md b/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-circle.md index acc942af60e41bd26a7c86253e937b17814a6bb2..c641e7932e0d6362d5dabae55aff65c61698ba3f 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-circle.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-circle.md @@ -22,11 +22,6 @@ Circle(options?: {width?: string | number, height?: string | number}) | width | string \| number | 否 | 0 | 宽度。 | | height | string \| number | 否 | 0 | 高度。 | -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| -------- | -------- | -------- | -------- | -------- | -| width | string \| number | 是 | - | 宽度。 | -| height | string \| number | 是 | - | 高度。 | - ## 属性 除支持[通用属性](ts-universal-attributes-size.md)外，还支持以下属性： diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-explicit-animation.md b/zh-cn/application-dev/reference/arkui-ts/ts-explicit-animation.md index 0ca66e5dab70bb423141c5ea320a516856b4537a..c3cedbcfe3b530df362567af6fcc6f1e153b349a 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-explicit-animation.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-explicit-animation.md @@ -14,9 +14,7 @@ ## AnimationOptions对象说明 -### 属性 - -| 属性名称 | 属性类型 | 描述 | +| 名称 | 类型 | 描述 | | -------- | -------- | -------- | | duration | number | 动画持续时间，单位为毫秒。
默认值：1000 | | tempo | number | 动画的播放速度，值越大动画播放越快，值越小播放越慢，为0时无动画效果。
默认值：1.0 | @@ -24,12 +22,8 @@ | delay | number | 单位为ms(毫秒)，默认不延时播放。
默认值：0 | | iterations | number | 默认播放一次，设置为-1时表示无限次播放。
默认值：1 | | playMode | [PlayMode](ts-appendix-enums.md#playmode) | 设置动画播放模式，默认播放完成后重头开始播放。
默认值：PlayMode.Normal | +| onFinish | () => void | 动效播放完成回调。 | -### 接口 - -| 名称 | 功能描述 | -| -------- | -------- | -| onFinish() => void | 动效播放完成回调。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-media-components-video.md b/zh-cn/application-dev/reference/arkui-ts/ts-media-components-video.md index c16671bfe38e198b0d055f189e5f08f4293dc0b1..05591aaf496e148eb2f9d950d42eb69842fe2368 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-media-components-video.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-media-components-video.md @@ -8,17 +8,7 @@ ## 权限列表 -使用网络视频时，需要在config或者module.json对应的"abilities"中添加网络使用权限ohos.permission.INTERNET。 - -```js -"abilities":[ - { - ... - "permissions": ["ohos.permission.INTERNET"], - ... - } -] -``` +使用网络视频时，需要申请权限ohos.permission.INTERNET。具体申请方式请参考[权限申请声明](../../security/accesstoken-guidelines.md)。 ## 子组件 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-methods-action-sheet.md b/zh-cn/application-dev/reference/arkui-ts/ts-methods-action-sheet.md index 558cd8b546884cdabc80525e904ccf8fe3767c62..c4f236ec93bb4b595cd0b9ab33e6abc2c94205d7 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-methods-action-sheet.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-methods-action-sheet.md @@ -13,29 +13,30 @@ ## ActionSheet.show -show(options: { paramObject1}) +show(value: { title: string | Resource, message: string | Resource, confirm?: {value: string | Resource, action:() => void}, cancel?:()=>void, sheets: Array<SheetInfo>, autoCancel?:boolean, alignment?: DialogAlignment, offset?: { dx: number | string | Resource; dy: number | string | Resource } }) 定义列表弹窗并弹出。 -- paramObject1参数 +**参数：** + | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | - | title | string \| [Resource](../../ui/ts-types.md#resource类型) | 否 | 无标题 | 弹窗标题。 | - | message | string \| [Resource](../../ui/ts-types.md#resource类型) | 是 | - | 弹窗内容。 | + | title | string \| [Resource](../../ui/ts-types.md#resource) | 是 | - | 弹窗标题。 | + | message | string \| [Resource](../../ui/ts-types.md#resource) | 是 | - | 弹窗内容。 | | autoCancel | boolean | 否 | true | 点击遮障层时，是否关闭弹窗。 | - | confirm | {
value: string \| [Resource](../../ui/ts-types.md#resource类型),
action: () => void
} | 否 | - | 确认按钮的文本内容和点击回调。
value：按钮文本内容。
action: 按钮选中时的回调。 | + | confirm | {
value: string \| [Resource](../../ui/ts-types.md#resource),
action: () => void
} | 否 | - | 确认按钮的文本内容和点击回调。
value：按钮文本内容。
action: 按钮选中时的回调。 | | cancel | () => void | 否 | - | 点击遮障层关闭dialog时的回调。 | | alignment | [DialogAlignment](ts-methods-custom-dialog-box.md) | 否 | DialogAlignment.Default | 弹窗在竖直方向上的对齐方式。 | | offset | {
dx: Length,
dy: Length
} | 否 | {
dx: 0,
dy: 0
} | 弹窗相对alignment所在位置的偏移量。 | - | sheets | Arraydx: Length \| [Resource](../../ui/ts-types.md#resource类型),
dy: Length  \| [Resource](../../ui/ts-types.md#resource类型)
} | 否 | - | 弹窗相对alignment所在位置的偏移量。 | | gridCount | number | 否 | - | 弹窗容器宽度所占用栅格数。 | -- paramObject2参数 +## AlertDialogParamWithButtons对象说明 | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | | title | string \| [Resource](../../ui/ts-types.md#resource类型) | 否 | - | 弹窗标题。 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-click.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-click.md index 01ee8c54de5a4f3b202035e05312def5a8ddba9f..bf3e92c02ec64393cf633b8861f68f15771e8447 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-click.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-click.md @@ -1,6 +1,6 @@ # 点击控制 -设置组件是否可触摸。 +设置组件是否可以响应点击事件、触摸事件等手指交互事件。 > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 @@ -16,7 +16,7 @@ | **名称** | **参数类型** | **默认值** | **描述** | | --------- | -------- | ------- | -------------- | -| touchable | boolean | true | 设置当前组件是否可以被触摸。 | +| touchable | boolean | true | 设置当前组件是否可以响应点击事件、触摸事件等手指交互事件。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-enable.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-enable.md index f8d01f547aaea524e0141e5f529cff133d783a42..794627c66f84c4aa409cc521c13fc25326bb6803 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-enable.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-enable.md @@ -1,22 +1,18 @@ # 禁用控制 -可交互状态下组件响应点击事件。 +组件是否可交互，可交互状态下响应[点击事件](ts-universal-events-click.md)、[触摸事件](ts-universal-events-touch.md)、[拖拽事件](ts-universal-events-drag-drop.md)、[按键事件](ts-universal-events-key.md)、[焦点事件](ts-universal-focus-event.md)和[鼠标事件](ts-universal-mouse-key.md)。 > **说明：** -> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 - - -## 权限列表 - -无 +> +> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| enabled | boolean | true | 值为true表示组件可用，可响应点击等操作；值为false时，不响应点击等操作。 | +| 名称 | 参数类型 | 描述 | +| ------- | ------- | ---------------------------------------- | +| enabled | boolean | 值为true表示组件可交互，响应点击等操作。
值为false表示组件不可交互，不响应点击等操作。
默认值：true | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-gradient-color.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-gradient-color.md index 7bb5c61e3019194b71102aca1d997bd03b079763..564c3a50b6047ab2443719de2045030ed1513e45 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-gradient-color.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-gradient-color.md @@ -17,9 +17,9 @@ | 名称 | 参数类型 | 默认值 | 描述 | | -------- | -------- | -------- | -------- | -| linearGradient | {
angle?: [Angle](../../ui/ts-types.md),
direction?: [GradientDirection](ts-appendix-enums.md#gradientdirection),
colors: Array<[ColorStop](../../ui/ts-types.md)>
repeating?: boolean
} | - | 线性渐变。
angle: 线性渐变的角度。
direction: 线性渐变的方向，设置angle后不生效。
colors: 为渐变的颜色描述。
repeating: 为渐变的颜色重复着色。 | -| sweepGradient | {
center: Point,
start?: angle,
end?: angle,
colors: Array<[ColorStop](../../ui/ts-types.md)>
repeating?: boolean
} | - | 角度渐变。
center：为角度渐变的中心点。
start：角度渐变的起点。
end：角度渐变的终点。
colors: 为渐变的颜色描述。
repeating: 为渐变的颜色重复着色。 | -| radialGradient | {
center: Point,
radius: Length,
colors: Array<[ColorStop](../../ui/ts-types.md)>
repeating: boolean
} | - | 径向渐变。
center：径向渐变的中心点。
radius：径向渐变的半径。
colors: 为渐变的颜色描述。
repeating: 为渐变的颜色重复着色。 | +| linearGradient | {
angle?: number \| string,
direction?: [GradientDirection](ts-appendix-enums.md#gradientdirection),
colors: Array<[ColorStop](../../ui/ts-types.md)>
, repeating?: boolean
} | - | 线性渐变。
angle: 线性渐变的角度。
direction: 线性渐变的方向，设置angle后不生效。
colors: 为渐变的颜色描述。
repeating: 为渐变的颜色重复着色。 | +| sweepGradient | {
center: Point,
start?: number \| string,
end?: number \| string,
colors: Array<[ColorStop](../../ui/ts-types.md)>
, repeating?: boolean
} | - | 角度渐变。
center：为角度渐变的中心点。
start：角度渐变的起点。
end：角度渐变的终点。
colors: 为渐变的颜色描述。
repeating: 为渐变的颜色重复着色。 | +| radialGradient | {
center: Point,
radius: number \| string,
colors: Array<[ColorStop](../../ui/ts-types.md)>
, repeating: boolean
} | - | 径向渐变。
center：径向渐变的中心点。
radius：径向渐变的半径。
colors: 为渐变的颜色描述。
repeating: 为渐变的颜色重复着色。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-image-effect.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-image-effect.md index 2d5b2007efe5fbf9ad087c6c48068794083fd19a..d677e345712d41e2fd13f6d5b3517f5be8058a3a 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-image-effect.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-image-effect.md @@ -18,13 +18,13 @@ | ----------------------------- | ------------------------------------------------------------ | ------ | ------------------------------------------------------------ | | blur | number | - | 为当前组件添加内容模糊效果，入参为模糊半径，模糊半径越大越模糊，为0时不模糊。 | | backdropBlur | number | - | 为当前组件添加背景模糊效果，入参为模糊半径，模糊半径越大越模糊，为0时不模糊。 | -| shadow | {
radius: number,
color?: Color \| string \| [Resource](../../ui/ts-types.md#resource类型),
offsetX?: number,
offsetY?: number
} | - | 为当前组件添加阴影效果，入参为模糊半径(必填)、阴影的颜色(可选，默认为灰色)、X轴的偏移量(可选，默认为0)，Y轴的偏移量(可选，默认为0)，偏移量单位为px。 | +| shadow | {
radius: number \| [Resource](../../ui/ts-types.md#resource),
color?: Color \| string \| Resource,
offsetX?: number \| Resource,
offsetY?: number \| Resource
} | - | 为当前组件添加阴影效果，入参为模糊半径(必填)、阴影的颜色(可选，默认为灰色)、X轴的偏移量(可选，默认为0)，Y轴的偏移量(可选，默认为0)，偏移量单位为px。 | | grayscale | number | 0.0 | 为当前组件添加灰度效果。值定义为灰度转换的比例，入参1.0则完全转为灰度图像，入参则0.0图像无变化，入参在0.0和1.0之间时，效果呈线性变化。（百分比) | | brightness | number | 1.0 | 为当前组件添加高光效果，入参为高光比例，值为1时没有效果，小于1时亮度变暗，0为全黑；大于1时亮度增加，数值越大亮度越大。 | | saturate | number | 1.0 | 为当前组件添加饱和度效果，饱和度为颜色中的含色成分和消色成分(灰)的比例，入参为1时，显示原图像，大于1时含色成分越大，饱和度越大；小于1时消色成分越大，饱和度越小。（百分比） | | contrast | number | 1.0 | 为当前组件添加对比度效果，入参为对比度的值，值为1时，显示原图；大于1时，值越大对比度越高，图像越清晰醒目；小于1时，值越小对比度越低；当对比度为0时，图像变为全灰。（百分比） | | invert | number | 0 | 反转输入的图像。入参为图像反转的比例。值为1时完全反转。值为0则图像无变化。（百分比） | -| colorBlend 8+ | Color \| string \| [Resource](../../ui/ts-types.md#resource类型) | - | 为当前组件添加颜色叠加效果，入参为叠加的颜色。 | +| colorBlend 8+ | Color \| string \| [Resource](../../ui/ts-types.md#resource) | - | 为当前组件添加颜色叠加效果，入参为叠加的颜色。 | | sepia | number | 0 | 将图像转换为深褐色。入参为图像反转的比例。值为1则完全是深褐色的，值为0图像无变化。 （百分比） | | hueRotate | number\|string | '0deg' | 色相旋转效果，输入参数为旋转角度。 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-overlay.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-overlay.md index c7f3b9a1e64db48ca56dbf6e21358da6d96b36bf..46c242c454ce64ba344588d96356971e649c5728 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-overlay.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-overlay.md @@ -16,7 +16,7 @@ | 名称 | 参数类型 | 默认值 | 描述 | | -------- | -------- | -------- | -------- | -| overlay | title: string,
options: {
align?: [Alignment](ts-appendix-enums.md#alignment枚举说明),
offset?: {x: number, y: number}
} | {
align: Alignment.Center,
offset: {0, 0}
} | 在当前组件上，增加遮罩文本，布局与当前组件相同。 | +| overlay | value: string,
options?: {
align?: [Alignment](ts-appendix-enums.md#alignment), 
offset?: {x?: number, y?: number}
} | {
align: Alignment.Center,
offset: {0, 0}
} | 在当前组件上，增加遮罩文本，布局与当前组件相同。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-sharp-clipping.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-sharp-clipping.md index 3dfc55ee77613cf4231d0dff984deef68c78c1dd..a6dc29932101859c1f172d4c62bc7e08e011767b 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-sharp-clipping.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-sharp-clipping.md @@ -17,8 +17,8 @@ | 名称 | 参数类型 | 默认值 | 描述 | | -------- | -------- | -------- | -------- | -| clip | Shape \| boolean | false | 参数为Shape类型时，按指定的形状对当前组件进行裁剪；参数为boolean类型时，设置是否按照边缘轮廓进行裁剪。 | -| mask | Shape | - | 在当前组件上加上指定形状的遮罩。 | +| clip | [Circle](ts-drawing-components-circle.md) \| [Ellipse](ts-drawing-components-ellipse.md) \| [Path](ts-drawing-components-path.md) \| [Rect](ts-drawing-components-rect.md) \| boolean | false | 参数为相应类型的组件，按指定的形状对当前组件进行裁剪；参数为boolean类型时，设置是否按照边缘轮廓进行裁剪。 | +| mask | [Circle](ts-drawing-components-circle.md) \| [Ellipse](ts-drawing-components-ellipse.md) \| [Path](ts-drawing-components-path.md) \| [Rect](ts-drawing-components-rect.md) | - | 在当前组件上加上指定形状的遮罩。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-size.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-size.md index 6a9466e98ba923b9b3505499742c944c74047d7d..6c807d77f2bd40fc776f5a13fe4e770af314c6b3 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-size.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-size.md @@ -21,7 +21,7 @@ | size | {
width?: Length,
height?: Length
} | - | 设置高宽尺寸。 | | padding | {
top?: Length,
right?: Length,
bottom?: Length,
left?: Length
} \| Length | 0 | 设置内边距属性。
参数为Length类型时，四个方向内边距同时生效。 | | margin | {
top?: Length,
right?: Length,
bottom?: Length,
left?: Length
}
\| Length | 0 | 设置外边距属性。
参数为Length类型时，四个方向外边距同时生效。 | -| constraintSize | {
minWidth?: Length,
maxWidth?: Length,
minHeight?: Length,
maxHeight?: Length
} | {
minWidth: 0,
maxWidth: Infinity,
minHeight: 0,
maxHeight: Infinity
} | 设置约束尺寸，组件布局时，进行尺寸范围限制。 | +| constraintSize | {
minWidth?: Length,
maxWidth?: Length,
minHeight?: Length,
maxHeight?: Length
} | {
minWidth: 0,
maxWidth: Infinity,
minHeight: 0,
maxHeight: Infinity
} | 设置约束尺寸，组件布局时，进行尺寸范围限制。constraintSize的优先级高于Width和Height。 | | layoutWeight | number \| string | 0 | 容器尺寸确定时，元素与兄弟节点主轴布局尺寸按照权重进行分配，忽略本身尺寸设置，表示自适应占满剩余空间。
>  **说明：**
> 仅在Row/Column/Flex布局中生效。 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-component-area-change-event.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-component-area-change-event.md index 4f9dfcd7904d09e167a33d281cf32fa1fec72f07..361699d2968608ae2aef7dc3eb9a9831145d3a8c 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-component-area-change-event.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-component-area-change-event.md @@ -3,7 +3,7 @@ 组件区域变化事件指组件显示的尺寸、位置等发生变化时触发的事件。 > **说明：** -> 从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 +> 从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 ## 权限列表 @@ -13,9 +13,9 @@ ## 事件 -| 名称 | 支持冒泡 | 功能描述 | -| -------- | -------- | -------- | -| onAreaChange(event: (oldValue: Area, newValue: Area) => void) | 否 | 组件区域变化时触发该回调，Area类型说明见[Area对象](ts-universal-events-click.md)介绍。 | +| 名称 | 支持冒泡 | 功能描述 | +| ---------------------------------------- | ---- | ---------------------------------------- | +| onAreaChange(event: (oldValue: Area, newValue: Area) => void) | 否 | 组件区域变化时触发该回调，Area类型描述见[Area](../../ui/ts-types.md#area8)。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-drag-drop.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-drag-drop.md index ee97ae6e83eb790be4d57336c2ea22448d07a2d1..4d6b2525e46f9cf5f1b716cfbb645a2cab61867d 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-drag-drop.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-drag-drop.md @@ -9,13 +9,21 @@ | 名称 | 支持冒泡 | 功能描述 | | ---------------------------------------- | ---- | ---------------------------------------- | -| onDragStart(event: (event?: DragEvent, extraParams?: string) =>  [CustomBuilder](../../ui/ts-types.md)) | 否 | 第一次拖拽此事件绑定的组件时，触发回调。
- event：拖拽事件信息，包括拖拽点坐标。
- extraParams：拖拽事件额外信息，详见extraParam类型描述。
返回值：当前跟手效果所拖拽的对象，用于显示拖拽时的提示组件。
长按150毫秒(ms)可触发拖拽事件。优先级：长按手势配置时间小于等于150毫秒(ms)时，长按手势优先触发，否则拖拽事件优先触发。 | +| onDragStart(event: (event?: DragEvent, extraParams?: string) =>  [CustomBuilder](../../ui/ts-types.md#custombuilder8)) \| DragItemInfo | 否 | 第一次拖拽此事件绑定的组件时，触发回调。
- event：拖拽事件信息，包括拖拽点坐标。
- extraParams：拖拽事件额外信息，详见extraParam类型描述。
返回值：当前跟手效果所拖拽的对象，用于显示拖拽时的提示组件。
长按150毫秒(ms)可触发拖拽事件。优先级：长按手势配置时间小于等于150毫秒(ms)时，长按手势优先触发，否则拖拽事件优先触发。 | | onDragEnter(event: (event?: DragEvent, extraParams?: string) => void) | 否 | 拖拽进入组件范围内时，触发回调。
- event：拖拽事件信息，包括拖拽点坐标。
- extraParams：拖拽事件额外信息，详见extraParam类型描述。
当监听了onDrop事件时，此事件才有效。 | | onDragMove(event: (event?: DragEvent, extraParams?: string) => void) | 否 | 拖拽在组件范围内移动时，触发回调。
- event：拖拽事件信息，包括拖拽点坐标。
- extraParams：拖拽事件额外信息，详见extraParam类型描述。
当监听了onDrop事件时，此事件才有效。 | | onDragLeave(event: (event?: DragEvent, extraParams?: string) => void) | 否 | 拖拽离开组件范围内时，触发回调。
- event：拖拽事件信息，包括拖拽点坐标。
- extraParams：拖拽事件额外信息，详见extraParam类型描述。
当监听了onDrop事件时，此事件才有效。 | | onDrop(event: (event?: DragEvent, extraParams?: string) => void) | 否 | 绑定此事件的组件可作为拖拽释放目标，当在本组件范围内停止拖拽行为时，触发回调。
- event：拖拽事件信息，包括拖拽点坐标。
- extraParams：拖拽事件额外信息，详见extraParam类型描述。 | -- extraParam说明
+## DragItemInfo说明 + | 属性名称 | 属性类型 | 必填 | 描述 | + | ------------- | ------ | ------- |--------------------------------- | + | pixelMap | [PixelMap](../apis/js-apis-image.md#pixelmap7) | 否 | 设置拖拽过程中显示的图片。 | + | builder | [CustomBuilder](../../ui/ts-types.md#custombuilder8) | 否 | 使用自定义生成器进行绘图，如果设置了pixelMap，则忽略此值。 | + | extraInfo | string | 否 | 拖拽项的描述。 | + + +## extraParam说明 用于返回组件在拖拽中需要用到的额外信息。 extraParam是Json对象转换的string字符串，可以通过Json.parse转换的Json对象获取如下属性。 | 属性名称 | 属性类型 | 描述 | diff --git a/zh-cn/application-dev/reference/js-service-widget-ui/Readme-CN.md b/zh-cn/application-dev/reference/js-service-widget-ui/Readme-CN.md index e300f5795c7e5f4428972bb288f187ee2f0c3d7f..57c3e074bd6b50541a4c676d273bff1cb15aa4ff 100644 --- a/zh-cn/application-dev/reference/js-service-widget-ui/Readme-CN.md +++ b/zh-cn/application-dev/reference/js-service-widget-ui/Readme-CN.md @@ -2,7 +2,6 @@ - JS服务卡片UI框架说明 - [文件组织](js-service-widget-file.md) - - [配置文件](js-service-widget-config-file.md) - 语法 - [HML语法参考](js-service-widget-syntax-hml.md) - [CSS语法参考](js-service-widget-syntax-css.md) diff --git a/zh-cn/application-dev/reference/js-service-widget-ui/js-service-widget-config-file.md b/zh-cn/application-dev/reference/js-service-widget-ui/js-service-widget-config-file.md deleted file mode 100644 index 82867f64408b16b9a82a1d43a786ace97e4f12fa..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/js-service-widget-ui/js-service-widget-config-file.md +++ /dev/null @@ -1,91 +0,0 @@ -# 配置文件 - - -js标签中包含了实例名称、窗口样式和卡片页面信息。 - - -| 标签 | 类型 | 默认值 | 必填 | 描述 | -| ------ | ------ | ------- | ---- | --------------------------- | -| name | String | default | 是 | 标识JS实例的名字。 | -| pages | Array | - | 是 | 路由信息，详见“[pages](#pages)”。 | -| window | Object | - | 否 | 窗口信息，详见“[window](#window)”。 | - -> **说明：** -> name、pages、window等标签配置需在[配置文件]()中的“js”标签中完成设置。 - - -## pages - -定义卡片页面信息，由卡片页面路径和卡片页面名组成，卡片仅包含一个页面。比如： - - -``` -{ - ... - "src": "./js/widget/pages/index/index" //卡片仅包含一个页面 - ... -} -``` - - -> **说明：** -> - pages列表中仅包含一个页面。 -> -> - 页面文件名不能使用组件名称，比如：text.hml、button.hml等。 - - -## window - -window用于定义与显示窗口相关的配置。对于卡片尺寸适配问题，有2种配置方法，建议使用autoDesignWidth： - -- 指定卡片designWidth 150px（2×2），所有与大小相关的样式（例如width、font-size）均以designWidth和实际卡片宽度的比例进行缩放，例如在designWidth为150时，如果设置width为100px时，在卡片实际宽度为300物理像素时，width实际渲染像素为200物理像素。 - -- 设置autoDesignWidth为true，此时designWidth字段将会被忽略，渲染组件和布局时按屏幕密度进行缩放。屏幕逻辑宽度由设备宽度和屏幕密度自动计算得出，在不同设备上可能不同，请使用相对布局来适配多种设备。例如：在466\*466分辨率，320dpi的设备上，屏幕密度为2（以160dpi为基准），1px等于渲染出的2物理像素。 - > **说明：** - > - 组件样式中<length>类型的默认值，按屏幕密度进行计算和绘制，如：在屏幕密度为2（以160dpi为基准）的设备上，默认<length>为1px时，设备上实际渲染出2物理像素。 - > - > - autoDesignWidth、designWidth的设置不影响默认值计算方式和绘制结果。 - -| 属性 | 类型 | 必填 | 默认值 | 描述 | -| --------------- | ------- | ---- | ----- | ---------------------------------------- | -| designWidth | number | 否 | 150px | 页面显示设计时的参考值，实际显示效果基于设备宽度与参考值之间的比例进行缩放。 | -| autoDesignWidth | boolean | 否 | false | 页面设计基准宽度是否自动计算，当设为true时，designWidth将会被忽略，设计基准宽度由设备宽度与屏幕密度计算得出。 | - - 示例如下： - { - ... - "window": { - "autoDesignWidth": true - } - ... - } - - -## 示例 - - -```json -{ - "forms": [ - { - "name": "widget", - "description": "This is a service widget.", - "src": "./js/widget/pages/index/index", - "window": { - "designWidth": 720, - "autoDesignWidth": true - }, - "colorMode": "auto", - "isDefault": true, - "updateEnabled": true, - "scheduledUpdateTime": "10:30", - "updateDuration": 1, - "defaultDimension": "2*2", - "supportDimensions": [ - "1*2","2*2","2*4","4*4" - ], - "formConfigAbility": "ability://xxxxx" - } - ] -} -``` diff --git a/zh-cn/application-dev/reference/js-service-widget-ui/js-service-widget-file.md b/zh-cn/application-dev/reference/js-service-widget-ui/js-service-widget-file.md index 6e7b373bfe3a5d1450c0b86dbc278ad60840336e..9025d3ad8df2f64ca271fd3dd690c14ca575860d 100644 --- a/zh-cn/application-dev/reference/js-service-widget-ui/js-service-widget-file.md +++ b/zh-cn/application-dev/reference/js-service-widget-ui/js-service-widget-file.md @@ -49,9 +49,15 @@ JS服务卡片(entry/src/main/js/Widget)的典型开发目录结构如下： > **说明：** > 当代码文件A需要引用代码文件B时： -> +> > - 如果代码文件A和文件B位于同一目录，则代码文件B引用资源文件时可使用相对路径，也可使用绝对路径。 -> +> > - 如果代码文件A和文件B位于不同目录，则代码文件B引用资源文件时必须使用绝对路径。因为Webpack打包时，代码文件B的目录会发生变化。 -> +> > - 在json文件中定义的数据为资源文件路径时，需使用绝对路径。 + +## 配置文件 + +FA卡片需要在应用配置文件config.json中进行配置。详细的配置内容请参考[FA卡片配置文件说明](../../ability/fa-formability.md#配置卡片配置文件)。 + +Stage卡片需要在应用配置文件module.json5中的extensionAbilities标签下，配置ExtensionAbility相关信息。详细的配置内容请参考[Stage卡片配置文件说明](../../ability/stage-formextension.md#配置卡片配置文件)。 \ No newline at end of file diff --git a/zh-cn/application-dev/ui/Readme-CN.md b/zh-cn/application-dev/ui/Readme-CN.md index 1fa9e2bd8a616441ff07722933a287499204b263..f4876392b3cbd07103959dd697762a9bcf32df44 100755 --- a/zh-cn/application-dev/ui/Readme-CN.md +++ b/zh-cn/application-dev/ui/Readme-CN.md @@ -1,7 +1,7 @@ # UI开发 - [方舟开发框架（ArkUI）概述](arkui-overview.md) -- 基于TS扩展的声明式开发范式 +- UI开发（基于eTS的声明式开发范式） - [概述](ui-ts-overview.md) - 框架说明 - 文件组织 @@ -74,7 +74,7 @@ - [页面跳转与数据传递](ui-ts-page-redirection-data-transmission.md) - [性能提升的推荐方法](ts-performance-improvement-recommendation.md) -- 基于JS扩展的类Web开发范式 +- UI开发（兼容JS的类Web开发范式） - [概述](ui-js-overview.md) - 框架说明 - [文件组织](js-framework-file.md) diff --git a/zh-cn/application-dev/ui/arkui-overview.md b/zh-cn/application-dev/ui/arkui-overview.md index e1dc6e11c2013cacebac3cae38b516e08751ff57..52410dd81e71b4ff9ee6a24aab982feec0f43500 100644 --- a/zh-cn/application-dev/ui/arkui-overview.md +++ b/zh-cn/application-dev/ui/arkui-overview.md @@ -26,7 +26,7 @@ - 平台API通道：方舟开发框架提供了API扩展机制，平台能力通过此种机制进行封装，提供风格统一的JS接口。 -- 两种开发范式：方舟开发框架针对不同目的和技术背景的开发者提供了两种开发范式，分别是基于TS扩展的声明式开发范式（简称“声明式开发范式”）和基于JS扩展的类Web开发范式（简称“类Web开发范式”）。 +- 两种开发范式：方舟开发框架针对不同目的和技术背景的开发者提供了两种开发范式，分别是基于eTS的声明式开发范式（简称“声明式开发范式”）和兼容JS的类Web开发范式（简称“类Web开发范式”）。 | 开发范式名称 | 简介 | 适用场景 | 适用人群 | | -------- | ---------------------------------------- | ---------------- | ------------------- | diff --git a/zh-cn/application-dev/ui/ts-framework-file-access-rules.md b/zh-cn/application-dev/ui/ts-framework-file-access-rules.md index 3d8a3b5709b49781d3aa3d51dafdf38c7ec2a3b3..f792bb37ff8e84fc1f2723139b65ffac1dec17c9 100644 --- a/zh-cn/application-dev/ui/ts-framework-file-access-rules.md +++ b/zh-cn/application-dev/ui/ts-framework-file-access-rules.md @@ -3,9 +3,9 @@ 应用代码文件可通过如下方式访问： -- 使用相对路径引用代码文件，比如：上一级目录：../common/utils/utils.ets，当前目录：./common/utils/utils.ets。 +- 使用相对路径引用代码文件，比如：上一级目录：../common/utils/utils，当前目录：./common/utils/utils。 -- 使用当前模块根路径引用代码文件，比如：common/utils/utils.ets。 +- 使用当前模块根路径引用代码文件，比如：common/utils/utils。 - 公共代码文件推荐放在**common**目录下。 @@ -14,7 +14,7 @@ ```ts // xxx.ets -import { FoodData, FoodList } from "../common/utils/utils.ets"; +import { FoodData, FoodList } from "../common/utils/utils"; @Entry @Component diff --git a/zh-cn/application-dev/ui/ts-types.md b/zh-cn/application-dev/ui/ts-types.md index 7dd533eac74d315fe2e5174dbc49bde5719b602a..39b84c43e101fed069a02a52519bb72813043a71 100644 --- a/zh-cn/application-dev/ui/ts-types.md +++ b/zh-cn/application-dev/ui/ts-types.md @@ -18,14 +18,6 @@ filename：工程中resources/rawfile目录下的文件名称。 - | 名称 | 类型 | 可读 | 可写 | 说明 | - | ----------------------- | ------ | ---- | ---- | ---------- | - | id | number | 是 | 否 | 资源id值。 | - | type | number | 是 | 否 | 资源类型。 | - | params | any[] | 是 | 否 | 资源可选参数 | - | bundleName9+ | string | 是 | 否 | 资源包名称。 | - | moduleName9+ | string | 是 | 否 | 资源模块名称。| - ## Length 长度类型，用于描述尺寸单位。 @@ -84,10 +76,10 @@ | 名称 | 类型 | 必填 | 说明 | | ----------- | ------ | ---- |--------------------- | - | topLeft | Length | 否 | 组件上边框宽度。 | - | topRight | Length | 否 | 组件右边框宽度。 | - | bottomLeft | Length | 否 | 组件下边框宽度。 | - | bottomRight | Length | 否 | 组件左边框宽度。 | + | topLeft | Length | 否 | 组件左上角圆角半径。 | + | topRight | Length | 否 | 组件右上角圆角半径。 | + | bottomLeft | Length | 否 | 组件左下角圆角半径。 | + | bottomRight | Length | 否 | 组件右下角圆角半径。 | ## EdgeColors9+ @@ -148,10 +140,10 @@ | 名称 | 类型 | 必填 | 说明 | | ------ | ------------------------------ | ---- | ------------------------------------------------------------ | -| size | number | 否 | 设置文本尺寸，Length为number类型时，使用fp单位。 | -| weight | number | 否 | 设置文本的字体粗细，number类型取值[100, 900]，取值间隔为100，默认为400，取值越大，字体越粗。 | -| family | [FontWeight](../reference/arkui-ts/ts-appendix-enums.md#fontweight) \| number \| string | 否 | 设置文本的字体列表。使用多个字体，使用','进行分割，优先级按顺序生效。例如：'Arial, sans-serif'。 | -| style | string \| Resource | 否 | 设置文本的字体样式。 | +| size | [Length](#length) | 否 | 设置文本尺寸，Length为number类型时，使用fp单位。 | +| weight | [FontWeight](../reference/arkui-ts/ts-appendix-enums.md#fontweight) \| number \| string | 否 | 设置文本的字体粗细，number类型取值[100, 900]，取值间隔为100，默认为400，取值越大，字体越粗。 | +| family | string \| [Resource](#resource) | 否 | 设置文本的字体列表。使用多个字体，使用','进行分割，优先级按顺序生效。例如：'Arial, sans-serif'。 | +| style | [FontStyle](../reference/arkui-ts/ts-appendix-enums.md#fontstyle) | 否 | 设置文本的字体样式。 | ## Area8+ @@ -159,10 +151,10 @@ | 名称 | 类型 | 说明 | | -------------- | -------- | ------------------------------------------------- | -| width | Length | 目标元素的宽度，作为返回值时，类型为number，单位vp。 | -| height | Length | 目标元素的高度，作为返回值时，类型为number，单位vp。 | -| position | Position | 目标元素左上角相对父元素左上角的位置。 | -| globalPosition | Position | 目标元素左上角相对页面左上角的位置。 | +| width | [Length](#length) | 目标元素的宽度，作为返回值时，类型为number，单位vp。 | +| height | [Length](#length) | 目标元素的高度，作为返回值时，类型为number，单位vp。 | +| position | [Position](#position8) | 目标元素左上角相对父元素左上角的位置。 | +| globalPosition | [Position](#position8) | 目标元素左上角相对页面左上角的位置。 | ## Position8+ @@ -203,7 +195,7 @@ | ------ | ----------------------- | ---- | ----------- | | width | Length \| EdgeWidths9+ | 否 | 边框宽度。 | | color | ResourceColor \| EdgeColors9+ | 否 | 边框颜色。 | -| radius | Length \| BorderRadiuses9+ | 否 | 边框角度。 | +| radius | Length \| BorderRadiuses9+ | 否 | 边框圆角半径。 | | style | [BorderStyle](../reference/arkui-ts/ts-appendix-enums.md#borderstyle) \| EdgeStyles9+ | 否 | 边框样式。 | ## ColorFilter9+ diff --git a/zh-cn/application-dev/ui/ui-js-component-tabs.md b/zh-cn/application-dev/ui/ui-js-component-tabs.md index bcefedaf9826d965910f070ab753a07707de2b8c..69b08d7edb002f75dadb8631e1d1a447444ca882 100644 --- a/zh-cn/application-dev/ui/ui-js-component-tabs.md +++ b/zh-cn/application-dev/ui/ui-js-component-tabs.md @@ -9,20 +9,21 @@ tabs是一种常见的界面导航结构。通过页签容器，用户可以快 ```html -
- - item1 - item2 - - -
- content1 -
-
- content2 -
- - +
+ + + item1 + item2 + + +
+ content1 +
+
+ content2 +
+ +
``` diff --git a/zh-cn/application-dev/ui/ui-js-overview.md b/zh-cn/application-dev/ui/ui-js-overview.md index d34a9f2cb8c946c3b0527965794e035c72f0429e..4fd6c93e289abe56d05d89f2f025bb832dd03a28 100755 --- a/zh-cn/application-dev/ui/ui-js-overview.md +++ b/zh-cn/application-dev/ui/ui-js-overview.md @@ -1,13 +1,13 @@ # 概述 -基于JS扩展的类Web开发范式的方舟开发框架，采用经典的HML、CSS、JavaScript三段式开发方式。使用HML标签文件进行布局搭建，使用CSS文件进行样式描述，使用JavaScript文件进行逻辑处理。UI组件与数据之间通过单向数据绑定的方式建立关联，当数据发生变化时，UI界面自动触发更新。此种开发方式，更接近Web前端开发者的使用习惯，快速将已有的Web应用改造成方舟开发框架应用。主要适用于界面较为简单的中小型应用开发。 +兼容JS的类Web开发范式的方舟开发框架，采用经典的HML、CSS、JavaScript三段式开发方式。使用HML标签文件进行布局搭建，使用CSS文件进行样式描述，使用JavaScript文件进行逻辑处理。UI组件与数据之间通过单向数据绑定的方式建立关联，当数据发生变化时，UI界面自动触发更新。此种开发方式，更接近Web前端开发者的使用习惯，快速将已有的Web应用改造成方舟开发框架应用。主要适用于界面较为简单的中小型应用开发。 -请参考[基于JS扩展的类Web开发范式API](../reference/arkui-js/js-components-common-attributes.md)文档，全面地了解组件，更好地开发应用。 +请参考[兼容JS的类Web开发范式API](../reference/arkui-js/js-components-common-attributes.md)文档，全面地了解组件，更好地开发应用。 ## 整体架构 -使用基于JS扩展的类Web开发范式的方舟开发框架，包括应用层（Application）、前端框架层（Framework）、引擎层（Engine）和平台适配层（Porting Layer）。 +使用兼容JS的类Web开发范式的方舟开发框架，包括应用层（Application）、前端框架层（Framework）、引擎层（Engine）和平台适配层（Porting Layer）。 @@ -32,7 +32,7 @@ ## 相关实例 -基于JS扩展的类Web开发范式的方舟开发框架，有以下相关实例可供参考： +兼容JS的类Web开发范式的方舟开发框架，有以下相关实例可供参考： - [`AtomicLayout`：原子布局（JS）（API8）](https://gitee.com/openharmony/applications_app_samples/tree/master/UI/AtomicLayout) 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 42eec7a17592f85aa1e10a746c80997f845b96fb..fe8843dd0050a63c369cfb2b4bb92c518b28e9a7 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 @@ -50,7 +50,15 @@ 3. 存入食物图片资源。在resources >base> media目录下存入食物图片资源，图片名称为食物名称。 -4. 创建食物资源数据。在model文件夹下创建FoodDataModels.ets，在该页面中声明食物成分数组FoodComposition。 +4. 创建食物资源数据。在model文件夹下创建FoodDataModels.ets，在该页面中声明食物成分数组FoodComposition。以下示例创建了两个食物数据。 + + ``` + const FoodComposition: any[] = [ + { 'name': 'Tomato', 'image': $r('app.media.Tomato'), 'category': Category.Vegetable, 'calories': 17, 'protein': 0.9, 'fat': 0.2, 'carbohydrates': 3.9, 'vitaminC': 17.8 }, + { 'name': 'Walnut', 'image': $r('app.media.Walnut'), 'category': Category.Nut, 'calories': 654 , 'protein': 15, 'fat': 65, 'carbohydrates': 14, 'vitaminC': 1.3 } + ] + ``` + 实际开发中，开发者可以自定义更多的数据资源，当食物资源很多时，建议使用数据懒加载LazyForEach。 5. 创建initializeOnStartUp方法来初始化FoodData的数组。在FoodDataModels.ets中使用了定义在FoodData.ets的FoodData和Category，所以要将FoodData.ets的FoodData类export，在FoodDataModels.ets内import FoodData和Category。 diff --git a/zh-cn/application-dev/website.md b/zh-cn/application-dev/website.md index 923a7e45bb65064b60a5792dd73b1f9f523d9860..08c82d3c8d3f22143657f4d193f9dec9b826c045 100644 --- a/zh-cn/application-dev/website.md +++ b/zh-cn/application-dev/website.md @@ -190,17 +190,10 @@ - [后台提醒开发指导](notification/background-agent-scheduled-reminder-guide.md) - [调试助手使用指导](notification/assistant-guidelines.md) - 窗口管理 - - 窗口 - - [窗口开发概述](windowmanager/window-overview.md) - - [管理应用窗口（Stage模型）](windowmanager/application-window-stage.md) - - [管理应用窗口（FA模型）](windowmanager/application-window-fa.md) - - [管理系统窗口（仅Stage模型支持）](windowmanager/system-window-stage.md) - - 屏幕属性 - - [屏幕属性开发概述](windowmanager/display-overview.md) - - [屏幕属性开发指导](windowmanager/display-guidelines.md) - - 屏幕截图 - - [屏幕截图开发概述](windowmanager/screenshot-overview.md) - - [屏幕截图开发指导](windowmanager/screenshot-guidelines.md) + - [窗口开发概述](windowmanager/window-overview.md) + - [管理应用窗口（Stage模型）](windowmanager/application-window-stage.md) + - [管理应用窗口（FA模型）](windowmanager/application-window-fa.md) + - [管理系统窗口（仅Stage模型支持）](windowmanager/system-window-stage.md) - WebGL - [WebGL开发概述](webgl/webgl-overview.md) - [WebGL开发指导](webgl/webgl-guidelines.md) @@ -639,7 +632,6 @@ - JS服务卡片UI组件参考 - JS服务卡片UI框架说明 - [文件组织](reference/js-service-widget-ui/js-service-widget-file.md) - - [配置文件](reference/js-service-widget-ui/js-service-widget-config-file.md) - 语法 - [HML语法参考](reference/js-service-widget-ui/js-service-widget-syntax-hml.md) - [CSS语法参考](reference/js-service-widget-ui/js-service-widget-syntax-css.md) diff --git a/zh-cn/application-dev/windowmanager/Readme-CN.md b/zh-cn/application-dev/windowmanager/Readme-CN.md index fff76b863d6b9198dec861f7cffaf7e9025009d2..0ebc186a333645c3e683360f1a2c8eaf1967ad68 100644 --- a/zh-cn/application-dev/windowmanager/Readme-CN.md +++ b/zh-cn/application-dev/windowmanager/Readme-CN.md @@ -1,16 +1,6 @@ # 窗口管理 -- 窗口 - - - [窗口开发概述](window-overview.md) - - [管理应用窗口（Stage模型）](application-window-stage.md) - - [管理应用窗口（FA模型）](application-window-fa.md) - - [管理系统窗口（仅Stage模型支持）](system-window-stage.md) - -- 屏幕属性 - - [屏幕属性开发概述](display-overview.md) - - [屏幕属性开发指导](display-guidelines.md) - -- 屏幕截图 - - [屏幕截图开发概述](screenshot-overview.md) - - [屏幕截图开发指导](screenshot-guidelines.md) \ No newline at end of file +- [窗口开发概述](window-overview.md) +- [管理应用窗口（Stage模型）](application-window-stage.md) +- [管理应用窗口（FA模型）](application-window-fa.md) +- [管理系统窗口（仅Stage模型支持）](system-window-stage.md) \ No newline at end of file diff --git a/zh-cn/application-dev/windowmanager/display-guidelines.md b/zh-cn/application-dev/windowmanager/display-guidelines.md deleted file mode 100644 index 98ff63601358f7894896925295df2a90600c6663..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/windowmanager/display-guidelines.md +++ /dev/null @@ -1,27 +0,0 @@ -# 屏幕属性开发指导 - -## 场景介绍 - -应用通过调用屏幕接口获取默认Display或者所有Display的属性。 - -## 接口说明 - -完整版的接口定义请参考API接口说明文件：[屏幕属性](../reference/apis/js-apis-display.md)。 - -## 开发步骤 - -通过`getDefaultDisplay(): Promise`来获取当前默认的`Display`对象，具体代码示例可参考： - -```js -import display from '@ohos.display' // 导入模块 - -display.getDefaultDisplay().then((disp) => { - console.log('display.getDefaultDisplay success, display :' + JSON.stringify(disp)); -}, (err) => { - console.log('display.getDefaultDisplay failed, error : ' + JSON.stringify(err)); -}) -``` -## 相关实例 -针对屏幕属性开发，有以下相关实例可供参考： -- [`Screen`：屏幕属性（eTS）（API8）（Full SDK）](https://gitee.com/openharmony/applications_app_samples/tree/master/device/Screen) - diff --git a/zh-cn/application-dev/windowmanager/display-overview.md b/zh-cn/application-dev/windowmanager/display-overview.md deleted file mode 100644 index 8c80828fc20c4e694ca92a6922e2afa906f7ec36..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/windowmanager/display-overview.md +++ /dev/null @@ -1,7 +0,0 @@ -# 屏幕属性开发概述 - -屏幕具有显示应用窗口布局的能力，屏幕属性包括：屏幕id号、屏幕名称、屏幕启用标识、屏幕状态、屏幕刷新率、屏幕旋转角度、屏幕宽度、屏幕高度、屏幕像素密度、屏幕字体缩放因子和每英寸屏幕的确切物理像素值。 - -## 基本概念 - -`Display`：Display指的是对应用可见的屏幕，这是一种抽象的屏幕概念，与真实的物理屏幕不同，可作为窗口容器。 diff --git a/zh-cn/application-dev/windowmanager/screenshot-guidelines.md b/zh-cn/application-dev/windowmanager/screenshot-guidelines.md deleted file mode 100644 index 9a60b348166899094fb1e2e685ab02f4e42d8535..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/windowmanager/screenshot-guidelines.md +++ /dev/null @@ -1,40 +0,0 @@ -# 屏幕截图开发指导 - -## 场景介绍 - -指定显示设备进行特定参数的屏幕截图。 - -## 接口说明 - -完整版的接口定义请参考API接口说明文件：[屏幕截图](../reference/apis/js-apis-screenshot.md)。 - -## 开发步骤 - -通过接口`save(options?: ScreenshotOptions): Promise`进行屏幕截图。其中`options`为预定义的截屏参数，如果没有输入`options`，则使用默认截取整屏，具体代码示例可参考： - -```js -import screenshot from '@ohos.screenshot' // 导入模块 - -// 设置屏幕截图参数 -let screenshotOps = { - "screenRect": { - "left": 200, - "top": 100, - "width": 200, - "height": 200}, - "imageSize": { - "width": 300, - "height": 300}, - "rotation": 0 -}; - -screenshot.save(screenshotOps).then((image) => { - console.log('screenshot.save success, screenshot image :' + JSON.stringify(image)); -}, (err) => { - console.log('screenshot.save failed, error : ' + JSON.stringify(err)); -}) -``` -## 相关实例 -针对屏幕截图开发，有以下相关实例可供参考： -- [`Screenshot`：屏幕截图（eTS）（API9）（Full SDK）](https://gitee.com/openharmony/applications_app_samples/tree/master/Basic/Screenshot) - diff --git a/zh-cn/application-dev/windowmanager/screenshot-overview.md b/zh-cn/application-dev/windowmanager/screenshot-overview.md deleted file mode 100644 index ba051123b1b6d135feec750fe8b16e33f7cb691d..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/windowmanager/screenshot-overview.md +++ /dev/null @@ -1,7 +0,0 @@ -# 屏幕截图开发概述 - -提供指定显示设备下特定参数的屏幕截图能力。 - -## 基本概念 - -`screenshot`：提供屏幕截图能力。 diff --git a/zh-cn/device-dev/porting/porting-w800-combo-demo.md b/zh-cn/device-dev/porting/porting-w800-combo-demo.md index e9a7b107a690a6e962f9c844b9dc7cbe441fa181..1e98d732edc5bb2bcb87500361e439f90705570f 100755 --- a/zh-cn/device-dev/porting/porting-w800-combo-demo.md +++ b/zh-cn/device-dev/porting/porting-w800-combo-demo.md @@ -49,7 +49,7 @@ "kernel_version": "3.0.0", --- 内核版本：3.0.0 "subsystems": [] --- 子系统 } -``` + ``` 填入的信息与规划的目录相对应，其中`device_company`和`board`用于关联出`device/board//`目录。 ### 单板配置 @@ -403,7 +403,8 @@ OHOS Which product do you need? neptune_iotlink_demo { "subsystem": "kernel", "components": [ - { "component": "liteos_m", "features":[] + { + "component": "liteos_m", "features":[] } ] }, @@ -419,11 +420,11 @@ OHOS Which product do you need? neptune_iotlink_demo osStatus_t ret = osKernelInitialize(); --- 内核初始化 if(ret == osOK) { - threadId = osThreadNew((osThreadFunc_t)sys_init,NULL,&g_main_task); --- 创建init线程 - if(threadId!=NULL) - { - osKernelStart(); --- 线程调度 - } + threadId = osThreadNew((osThreadFunc_t)sys_init,NULL,&g_main_task); --- 创建init线程 + if(threadId!=NULL) + { + osKernelStart(); --- 线程调度 + } } ``` diff --git a/zh-cn/device-dev/subsystems/Readme-CN.md b/zh-cn/device-dev/subsystems/Readme-CN.md index b393e1d17d7adfc4d9251ccf1e3d5dbf8efbd89a..3fcac88fe7a7fc5e4781fadf0004d85c992eacaf 100755 --- a/zh-cn/device-dev/subsystems/Readme-CN.md +++ b/zh-cn/device-dev/subsystems/Readme-CN.md @@ -106,6 +106,7 @@ - [HiTrace开发指导](subsys-dfx-hitrace.md) - [HiCollie开发指导](subsys-dfx-hicollie.md) - HiSysEvent开发指导 + - [HiSysEvent概述](subsys-dfx-hisysevent-overview.md) - [HiSysEvent打点配置指导](subsys-dfx-hisysevent-logging-config.md) - [HiSysEvent打点指导](subsys-dfx-hisysevent-logging.md) - [HiSysEvent订阅指导](subsys-dfx-hisysevent-listening.md) diff --git a/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-overview.md b/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-overview.md index 2203d06a22e87162f34e7e17d5042b1741cd883e..65f825ea1bacf5f9c8bdf59897e74a2023ba4852 100644 --- a/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-overview.md +++ b/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-overview.md @@ -5,17 +5,17 @@ HiSysEvent是面向OpenHarmony系统开发者提供的系统打点功能，通过在关键路径埋点来记录系统在运行过程中的重要信息，辅助开发者定位问题，此外还支持开发者将打点数据上传到云进行大数据质量度量。 -HiSysEvent提供给开发者的打点相关能力主要包括事件配置、事件埋点、事件订阅、事件查询以及事件调试工具，各模块能力介绍如下： +HiSysEvent包括HiSysEvent打点配置、HiSysEvent打点、HiSysEvent订阅、HiSysEvent查询以及HiSysEvent工具模块，各模块能力介绍如下： -- 事件配置：提供了事件的yaml配置能力，支持在yaml文件中对HiSysEvent事件进行定义。 +- [HiSysEvent打点配置](subsys-dfx-hisysevent-logging-config.md)：提供了事件打点配置的相关能力，支持在yaml文件中对打点事件进行定义。 -- 事件埋点：提供了事件埋点的相关接口能力，支持对打点的HiSysEvent事件进行落盘。 +- [HiSysEvent打点](subsys-dfx-hisysevent-logging.md)：提供了事件打点的相关接口能力，支持对打点事件进行落盘。 -- 事件订阅：提供了事件订阅的相关接口能力，支持根据事件领域和事件名称来对HiSysEvent事件进行订阅。 +- [HiSysEvent订阅](subsys-dfx-hisysevent-listening.md)：提供了事件订阅的相关接口能力，支持根据事件领域和事件名称来对打点事件进行订阅。 -- 事件查询：提供了事件查询的相关接口能力，支持根据事件领域和事件名称来对HiSysEvent事件进行查询。 +- [HiSysEvent查询](subsys-dfx-hisysevent-query.md)：提供了事件查询的相关接口能力，支持根据事件领域和事件名称来对打点事件进行查询。 -- 事件调试工具：提供了hisysevent工具，支持通过该工具来实时订阅HiSysEvent事件及查询历史HiSysEvent事件。 +- [HiSysEvent工具](subsys-dfx-hisysevent-tool.md)：提供了HiSysEvent工具，支持通过该工具来实时订阅打点事件及查询历史打点事件。 ## 参考 diff --git a/zh-cn/release-notes/OpenHarmony-v3.2-beta2.md b/zh-cn/release-notes/OpenHarmony-v3.2-beta2.md index dce2199ce9ac8cbdad0516d50afffd003f915648..94baa5eb183fca24e52f4cc75addce8e4d5c27c3 100644 --- a/zh-cn/release-notes/OpenHarmony-v3.2-beta2.md +++ b/zh-cn/release-notes/OpenHarmony-v3.2-beta2.md @@ -119,8 +119,8 @@ | 标准系统Full SDK包（Windows\Linux） | 3.2.5.5 | [站点](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta2/ohos-sdk-windows_linux-full.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta2/ohos-sdk-windows_linux-full.tar.gz.sha256) | | 标准系统Public SDK包（Mac） | 3.2.5.5 | [站点](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta2/ohos-sdk-mac-public.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta2/ohos-sdk-mac-public.tar.gz.sha256) | | 标准系统Public SDK包（Windows\Linux） | 3.2.5.5 | [站点](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta2/ohos-sdk-windows_linux-public.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/harmonyos/os/3.2-Beta2/ohos-sdk-windows_linux-public.tar.gz.sha256) | -| 标准系统Full SDK包（Mac） | 3.2.5.6 | [站点](https://repo.huaweicloud.com/openharmony/os/3.2-Beta2/sdk-patch/ohos-sdk-mac-full.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/openharmony/os/3.2-Beta2/sdk-patch/ohos-sdk-mac-full.tar.gz.sha256) | -| 标准系统Full SDK包（Windows\Linux） | 3.2.5.6 | [站点](https://repo.huaweicloud.com/openharmony/os/3.2-Beta2/sdk-patch/ohos-sdk-windows_linux-full.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/openharmony/os/3.2-Beta2/sdk-patch/ohos-sdk-windows_linux-full.tar.gz.sha256) | +| 标准系统Full SDK包（Mac） | 3.2.5.6 | [站点](https://repo.huaweicloud.com/openharmony/os/3.2-Beta2/sdk-patch/ohos-sdk-mac-full_20220913.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/openharmony/os/3.2-Beta2/sdk-patch/ohos-sdk-mac-full_20220913.tar.gz.sha256) | +| 标准系统Full SDK包（Windows\Linux） | 3.2.5.6 | [站点](https://repo.huaweicloud.com/openharmony/os/3.2-Beta2/sdk-patch/ohos-sdk-windows_linux-full_20220913.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/openharmony/os/3.2-Beta2/sdk-patch/ohos-sdk-windows_linux-full_20220913.tar.gz.sha256) | | 标准系统Public SDK包（Mac） | 3.2.5.6 | [站点](https://repo.huaweicloud.com/openharmony/os/3.2-Beta2/sdk-patch/ohos-sdk-mac-public.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/openharmony/os/3.2-Beta2/sdk-patch/ohos-sdk-mac-public.tar.gz.sha256) | | 标准系统Public SDK包（Windows\Linux） | 3.2.5.6 | [站点](https://repo.huaweicloud.com/openharmony/os/3.2-Beta2/sdk-patch/ohos-sdk-windows_linux-public.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/openharmony/os/3.2-Beta2/sdk-patch/ohos-sdk-windows_linux-public.tar.gz.sha256) |