diff --git a/en/application-dev/device/sensor-guidelines.md b/en/application-dev/device/sensor-guidelines.md index ca434c9639e064dda463873dee8fdf701271181b..b2d3d9ce0f27cb9ec91849b8a178c57b608eec4a 100644 --- a/en/application-dev/device/sensor-guidelines.md +++ b/en/application-dev/device/sensor-guidelines.md @@ -34,40 +34,52 @@ 1. To obtain data from a type of sensor, configure the requested permissions in the **config.json** file. ``` - "reqPermissions":[ - { - "name":"ohos.permission.ACCELEROMETER", - "reason"":"", - "usedScene":{ - "ability": ["sensor.index.MainAbility",".MainAbility"], - "when":"inuse" - } - }, - { - "name":"ohos.permission.GYROSCOPE", - "reason"":"", - "usedScene":{ - "ability": ["sensor.index.MainAbility",".MainAbility"], - "when":"inuse" - } - }, - { - "name":"ohos.permission.ACTIVITY_MOTION", - "reason"":"ACTIVITY_MOTION_TEST", - "usedScene":{ - "ability": ["sensor.index.MainAbility",".MainAbility"], - "when":"inuse" - } - }, - { - "name":"ohos.permission.READ_HEALTH_DATA", - "reason"":"HEALTH_DATA_TEST", - "usedScene":{ - "ability": ["sensor.index.MainAbility",".MainAbility"], - "when":"inuse" - } - }, - ] + "reqPermissions": [ + { + "name": "ohos.permission.ACCELEROMETER", + "reason": "", + "usedScene": { + "ability": [ + "sensor.index.MainAbility", + ".MainAbility" + ], + "when": "inuse" + } + }, + { + "name": "ohos.permission.GYROSCOPE", + "reason": "", + "usedScene": { + "ability": [ + "sensor.index.MainAbility", + ".MainAbility" + ], + "when": "inuse" + } + }, + { + "name": "ohos.permission.ACTIVITY_MOTION", + "reason": "ACTIVITY_MOTION_TEST", + "usedScene": { + "ability": [ + "sensor.index.MainAbility", + ".MainAbility" + ], + "when": "inuse" + } + }, + { + "name": "ohos.permission.READ_HEALTH_DATA", + "reason": "HEALTH_DATA_TEST", + "usedScene": { + "ability": [ + "sensor.index.MainAbility", + ".MainAbility" + ], + "when": "inuse" + } + } + ] ``` 2. Subscribe to data changes of a type of sensor. @@ -75,7 +87,7 @@ ``` import sensor from "@ohos.sensor" sensor.on(sensor.sensorType.SENSOR_TYPE_ACCELEROMETER,function(data){ - console.info("Subscription succeeded. data = "+ data); // The call is successful, and the obtained sensor data is printed. + console.info("Subscription succeeded. data = " + data); // The call is successful, and the obtained sensor data is printed. } ); ``` @@ -127,4 +139,4 @@ The following sample is provided to help you better understand how to develop sensors: -- [`Sensor`: sensor (eTS, API 8)](https://gitee.com/openharmony/app_samples/tree/master/device/Sensor) +- [`Sensor`: sensor (eTS, API version 8)](https://gitee.com/openharmony/app_samples/tree/master/device/Sensor) diff --git a/en/application-dev/reference/apis/Readme-EN.md b/en/application-dev/reference/apis/Readme-EN.md index 5e261f99ad0e2cae3473c8819f10a830fc944954..4646544abd6e22a632a35faeba6184819d601097 100644 --- a/en/application-dev/reference/apis/Readme-EN.md +++ b/en/application-dev/reference/apis/Readme-EN.md @@ -59,6 +59,7 @@ - Bundle Management - [@ohos.bundle](js-apis-Bundle.md) + - [@ohos.bundle.defaultAppManager](js-apis-bundle-defaultAppManager.md) - [@ohos.bundleState](js-apis-deviceUsageStatistics.md) - [@ohos.zlib](js-apis-zlib.md) - bundle/[AbilityInfo](js-apis-bundle-AbilityInfo.md) @@ -108,6 +109,7 @@ - [@ohos.configPolicy](js-apis-config-policy.md) - [@ohos.enterpriseDeviceManager](js-apis-enterprise-device-manager.md) + - [@ohos.EnterpriseAdminExtensionAbility](js-apis-EnterpriseAdminExtensionAbility.md) - Security @@ -173,6 +175,7 @@ - [@ohos.hichecker](js-apis-hichecker.md) - [@ohos.hidebug](js-apis-hidebug.md) - [@ohos.hilog](js-apis-hilog.md) + - [@ohos.hiSysEvent](js-apis-hisysevent.md) - [@ohos.hiTraceChain](js-apis-hitracechain.md) - [@ohos.hiTraceMeter](js-apis-hitracemeter.md) - [@ohos.inputMethod](js-apis-inputmethod.md) @@ -192,13 +195,13 @@ - [@ohos.geolocation](js-apis-geolocation.md) - [@ohos.multimodalInput.inputConsumer](js-apis-inputconsumer.md) - [@ohos.multimodalInput.inputDevice](js-apis-inputdevice.md) + - [@ohos.multimodalInput.inputEvent](js-apis-inputevent.md) - [@ohos.multimodalInput.inputEventClient](js-apis-inputeventclient.md) - [@ohos.multimodalInput.inputMonitor](js-apis-inputmonitor.md) - - [@ohos.multimodalInput.inputEvent](js-apis-inputevent.md) - [@ohos.multimodalInput.keyCode](js-apis-keycode.md) - [@ohos.multimodalInput.keyEvent](js-apis-keyevent.md) - [@ohos.multimodalInput.mouseEvent](js-apis-mouseevent.md) - - [@ohos.multimodalInput.ToucEvent](js-apis-touchevent.md) + - [@ohos.multimodalInput.touchEvent](js-apis-touchevent.md) - [@ohos.power](js-apis-power.md) - [@ohos.runningLock](js-apis-runninglock.md) - [@ohos.sensor](js-apis-sensor.md) diff --git a/en/application-dev/reference/apis/js-apis-EnterpriseAdminExtensionAbility.md b/en/application-dev/reference/apis/js-apis-EnterpriseAdminExtensionAbility.md new file mode 100644 index 0000000000000000000000000000000000000000..5b7866478f7f527ceb806b2aec083bd21835800a --- /dev/null +++ b/en/application-dev/reference/apis/js-apis-EnterpriseAdminExtensionAbility.md @@ -0,0 +1,48 @@ +# EnterpriseAdminExtentionAbility + +The **EnterpriseAdminExtentionAbility** module provides APIs for Extension abilities of enterprise administrators. + +> **NOTE** +> +> The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version. +> The APIs of this module can be used only in the stage model. +## Modules to Import + +```ts +import EnterpriseAdminExtentionAbility from '@ohos.EnterpriseAdminExtentionAbility' +``` + +## EnterpriseAdminExtentionAbility.onAdminEnabled + +onAdminEnabled(): void + +Called when an enterprise administrator is enabled. + +**System capability**: SystemCapability.Customization.EnterpriseDeviceManager + +**Example** + + ```ts +export default class EnterpriseAdminAbility extends EnterpriseAdminExtensionAbility { + onAdminEnabled() { + } +}; + ``` + +## EnterpriseAdminExtentionAbility.onAdminDisabled + +onAdminDisabled(): void + +Called when an enterprise administrator is disabled. + +**System capability**: SystemCapability.Customization.EnterpriseDeviceManager + +**Example** + + + ```ts +export default class EnterpriseAdminAbility extends EnterpriseAdminExtensionAbility { + onAdminDisabled() { + } +}; + ``` diff --git a/en/application-dev/reference/apis/js-apis-abilityManager.md b/en/application-dev/reference/apis/js-apis-abilityManager.md new file mode 100644 index 0000000000000000000000000000000000000000..28c5cd31b0350ca0e8b24c8bfbda21fb039adcd7 --- /dev/null +++ b/en/application-dev/reference/apis/js-apis-abilityManager.md @@ -0,0 +1,268 @@ +# AbilityManager + +The **AbilityManager** module provides APIs for obtaining, adding, and modifying ability running information and state information. + +> **NOTE** +> +> The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version. +> The APIs of this module are system APIs and cannot be called by third-party applications. + +# Modules to Import + +```js +import AbilityManager from '@ohos.application.abilityManager' +``` + +## AbilityState + +Enumerates the ability states. + +**System capability**: SystemCapability.Ability.AbilityRuntime.Core + +**System API**: This is a system API and cannot be called by third-party applications. + +| Name| Value| Description| +| -------- | -------- | -------- | +| INITIAL | 0 | The ability is in the initial state.| +| FOREGROUND | 9 | The ability is in the foreground state. | +| BACKGROUND | 10 | The ability is in the background state. | +| FOREGROUNDING | 11 | The ability is in the foregrounding state. | +| BACKGROUNDING | 12 | The ability is in the backgrounding state. | + +## updateConfiguration + +updateConfiguration(config: Configuration, callback: AsyncCallback\): void + +Obtains the ability running information. This API uses an asynchronous callback to return the result. + +**Permission required**: ohos.permission.UPDATE_CONFIGURATION + +**System capability**: SystemCapability.Ability.AbilityRuntime.Core + +**Parameters** + +| Name | Type | Mandatory | Description | +| --------- | ---------------------------------------- | ---- | -------------- | +| config | Configuration | Yes | New configuration.| +| callback | AsyncCallback\ | Yes | Callback used to return the result. | + +**Example** + +```js +import abilitymanager from '@ohos.application.abilityManager'; + +var config = { + language: 'chinese' +} + +abilitymanager.updateConfiguration(config, () => { + console.log('------------ updateConfiguration -----------'); +}) +``` + +## updateConfiguration + +updateConfiguration(config: Configuration): Promise\ + +Updates the configuration. This API uses a promise to return the result. + +**Permission required**: ohos.permission.UPDATE_CONFIGURATION + +**System capability**: SystemCapability.Ability.AbilityRuntime.Core + +**Parameters** + +| Name | Type | Mandatory | Description | +| --------- | ---------------------------------------- | ---- | -------------- | +| config | Configuration | Yes | New configuration.| + +**Return value** + +| Type | Description | +| ---------------------------------------- | ------- | +| Promise\ | Promise used to return the result. | + +**Example** + +```js +import abilitymanager from '@ohos.application.abilityManager'; + +var config = { + language: 'chinese' +} + +abilitymanager.updateConfiguration(config).then(() => { + console.log('updateConfiguration success'); +}).catch((err) => { + console.log('updateConfiguration fail'); +}) +``` + +## getAbilityRunningInfos + +getAbilityRunningInfos(callback: AsyncCallback\>): void + +Obtains the ability running information. This API uses an asynchronous callback to return the result. + +**Required permissions**: ohos.permission.GET_RUNNING_INFO + +**System capability**: SystemCapability.Ability.AbilityRuntime.Core + +**Parameters** + +| Name | Type | Mandatory | Description | +| --------- | ---------------------------------------- | ---- | -------------- | +| callback | AsyncCallback\> | Yes | Callback used to return the result. | + +**Example** + +```js +import abilitymanager from '@ohos.application.abilityManager'; + +abilitymanager.getAbilityRunningInfos((err,data) => { + console.log("getAbilityRunningInfos err: " + err + " data: " + JSON.stringify(data)); +}); +``` + +## getAbilityRunningInfos + +getAbilityRunningInfos(): Promise\> + +Obtains the ability running information. This API uses a promise to return the result. + +**Required permissions**: ohos.permission.GET_RUNNING_INFO + +**System capability**: SystemCapability.Ability.AbilityRuntime.Core + +**Return value** + +| Type | Description | +| ---------------------------------------- | ------- | +| Promise\> | Promise used to return the result. | + +**Example** + +```js +import abilitymanager from '@ohos.application.abilityManager'; + +abilitymanager.getAbilityRunningInfos().then((data) => { + console.log("getAbilityRunningInfos data: " + JSON.stringify(data)) +}).catch((err) => { + console.log("getAbilityRunningInfos err: " + err) +}); +``` + +## getExtensionRunningInfos9+ + +getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\>): void + +Obtains the extension running information. This API uses an asynchronous callback to return the result. + +**Required permissions**: ohos.permission.GET_RUNNING_INFO + +**System capability**: SystemCapability.Ability.AbilityRuntime.Core + +**Parameters** + +| Name | Type | Mandatory | Description | +| --------- | ---------------------------------------- | ---- | -------------- | +| upperLimit | number | Yes| Maximum number of messages that can be obtained.| +| callback | AsyncCallback\> | Yes | Callback used to return the result. | + +**Example** + +```js +import abilitymanager from '@ohos.application.abilityManager'; + +var upperLimit = 0; + +abilitymanager.getExtensionRunningInfos(upperLimit, (err,data) => { + console.log("getExtensionRunningInfos err: " + err + " data: " + JSON.stringify(data)); +}); +``` + +## getExtensionRunningInfos9+ + +getExtensionRunningInfos(upperLimit: number): Promise\> + +Obtains the extension running information. This API uses a promise to return the result. + +**Required permissions**: ohos.permission.GET_RUNNING_INFO + +**System capability**: SystemCapability.Ability.AbilityRuntime.Core + +**Parameters** + +| Name | Type | Mandatory | Description | +| --------- | ---------------------------------------- | ---- | -------------- | +| upperLimit | number | Yes| Maximum number of messages that can be obtained.| + +**Return value** + +| Type | Description | +| ---------------------------------------- | ------- | +| Promise\> | Promise used to return the result. | + +**Example** + +```js +import abilitymanager from '@ohos.application.abilityManager'; + +var upperLimit = 0; + +abilitymanager.getExtensionRunningInfos(upperLimit).then((data) => { + console.log("getAbilityRunningInfos data: " + JSON.stringify(data)); +}).catch((err) => { + console.log("getAbilityRunningInfos err: " + err); +}) +``` + +## getTopAbility9+ + +getTopAbility(callback: AsyncCallback\): void; + +Obtains the top ability, which is the ability that has the window focus. This API uses an asynchronous callback to return the result. + +**System capability**: SystemCapability.Ability.AbilityRuntime.Core + +**Parameters** + +| Name | Type | Mandatory | Description | +| --------- | ---------------------------------------- | ---- | -------------- | +| callback | AsyncCallback\ | Yes | Callback used to return the result. | + +**Example** + +```js +import abilitymanager from '@ohos.application.abilityManager'; + +abilitymanager.getTopAbility((err,data) => { + console.log("getTopAbility err: " + err + " data: " + JSON.stringify(data)); +}); +``` + +## getTopAbility9+ + +getTopAbility(): Promise\; + +Obtains the top ability, which is the ability that has the window focus. This API uses a promise to return the result. + +**System capability**: SystemCapability.Ability.AbilityRuntime.Core + +**Return value** + +| Type | Description | +| ---------------------------------------- | ------- | +| Promise\| Promise used to return the result. | + +**Example** + +```js +import abilitymanager from '@ohos.application.abilityManager'; + +abilitymanager.getTopAbility().then((data) => { + console.log("getTopAbility data: " + JSON.stringify(data)); +}).catch((err) => { + console.log("getTopAbility err: " + err); +}) +``` diff --git a/en/application-dev/reference/apis/js-apis-bundle-AbilityInfo.md b/en/application-dev/reference/apis/js-apis-bundle-AbilityInfo.md index 02536e5aa2b22f7cc20354e2ac8f56d8bb75421a..74ba45c52450241572aff5ab9cba2a55debd9124 100644 --- a/en/application-dev/reference/apis/js-apis-bundle-AbilityInfo.md +++ b/en/application-dev/reference/apis/js-apis-bundle-AbilityInfo.md @@ -42,7 +42,7 @@ Provides the ability information. | labelId | number | Yes | No | Ability label ID. | | subType | AbilitySubType | Yes | No | Subtype of the template that can be used by the ability. | | metaData8+ | Array\<[CustomizeData](js-apis-bundle-CustomizeData.md)> | Yes | No | Custom metadata of the ability. | -| metaData9+ | Array\<[Metadata](js-apis-bundle-Metadata.md)> | Yes | No | Metadata of the ability. | +| metadata9+ | Array\<[Metadata](js-apis-bundle-Metadata.md)> | Yes | No | Metadata of the ability. | | enabled8+ | boolean | Yes | No | Whether the ability is enabled. | | supportWindowMode9+ | Array\<[SupportWindowMode](js-apis-Bundle.md)> | Yes | No | Window modes supported by the ability. | | maxWindowRatio9+ | number | Yes | No | Maximum window ratio supported by the ability. | diff --git a/en/application-dev/reference/apis/js-apis-bundle-ApplicationInfo.md b/en/application-dev/reference/apis/js-apis-bundle-ApplicationInfo.md index 4f658d8880c014bdbc4cf46cd3ab1d2a7bb01ec0..185338803c92789aea72fa0fca2ab7791ab89ea1 100644 --- a/en/application-dev/reference/apis/js-apis-bundle-ApplicationInfo.md +++ b/en/application-dev/reference/apis/js-apis-bundle-ApplicationInfo.md @@ -1,42 +1,41 @@ # ApplicationInfo - - -> **NOTE**
+> **NOTE** +> > The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version. - - Provides the application information. - +## ApplicationInfo **System capability**: SystemCapability.BundleManager.BundleFramework -| Name | Type | Readable| Writable| Description | -| -------------------------- | ------------------------------------------------------------ | ---- | ---- | ------------------------------------------ | -| name | string | Yes | No | Application name. | -| description | string | Yes | No | Application description. | -| descriptionId | number | Yes | No | Application description ID. | -| systemApp | boolean | Yes | No | Whether the application is a system application. The default value is **false**. | -| enabled | boolean | Yes | No | Whether the application is enabled. The default value is **true**. | -| label | string | Yes | No | Application label. | -| labelId | string | Yes | No | Application label ID. | -| icon | string | Yes | No | Application icon. | -| iconId | string | Yes | No | Application icon ID. | -| process | string | Yes | No | Process in which the application runs. If this parameter is not set, the bundle name is used.| -| supportedModes | number | Yes | No | Running modes supported by the application. | -| moduleSourceDirs | Array\ | Yes | No | Relative paths for storing application resources. | -| permissions | Array\ | Yes | No | Permissions required for accessing the application. | -| moduleInfos | Array\<[ModuleInfo](js-apis-bundle-ModuleInfo.md)> | Yes | No | Application module information. | -| entryDir | string | Yes | No | Path for storing application files. | -| codePath8+ | string | Yes | No | Installation directory of the application. | -| metaData8+ | Map\> | Yes | No | Custom metadata of the application. | -| metaData9+ | Map\> | Yes | No | Metadata of the application. | -| removable8+ | boolean | Yes | No | Whether the application is removable. | -| accessTokenId8+ | number | Yes | No | Access token ID of the application. | -| uid8+ | number | Yes | No | UID of the application. | -| entityType8+ | string | Yes | No | Entity type of the application. | -| fingerprint9+ | string | Yes | No | Signing certificate fingerprint of the application, that is, the SHA-256 checksum of the signing certificate that you apply for for the application. | +| Name | Type | Readable| Writable| Description | +| -------------------------- | ------------------------------------------------------------ | ---- | ---- | ------------------------------------------------------------ | +| name | string | Yes | No | Application name. | +| description | string | Yes | No | Application description. | +| descriptionId | number | Yes | No | Application description ID. | +| systemApp | boolean | Yes | No | Whether the application is a system application. The default value is **false**. | +| enabled | boolean | Yes | No | Whether the application is enabled. The default value is **true**. | +| label | string | Yes | No | Application label. | +| labelId | string | Yes | No | Application label ID. | +| icon | string | Yes | No | Application icon. | +| iconId | string | Yes | No | Application icon ID. | +| process | string | Yes | No | Process in which the application runs. If this parameter is not set, the bundle name is used. | +| supportedModes | number | Yes | No | Running modes supported by the application. | +| moduleSourceDirs | Array\ | Yes | No | Relative paths for storing application resources. | +| permissions | Array\ | Yes | No | Permissions required for accessing the application. | +| moduleInfos | Array\<[ModuleInfo](js-apis-bundle-ModuleInfo.md)> | Yes | No | Application module information. | +| entryDir | string | Yes | No | Path for storing application files. | +| codePath8+ | string | Yes | No | Installation directory of the application. | +| metaData8+ | Map\> | Yes | No | Custom metadata of the application. | +| metadata9+ | Map\> | Yes | No | Metadata of the application. | +| removable8+ | boolean | Yes | No | Whether the application is removable. | +| accessTokenId8+ | number | Yes | No | Access token ID of the application. | +| uid8+ | number | Yes | No | UID of the application. | +| entityType8+ | string | Yes | No | Entity type of the application. | +| fingerprint9+ | string | Yes | No | Signing certificate fingerprint of the application, that is, the SHA-256 checksum of the signing certificate that you request for the application.| +| appDistributionType9+ | string | Yes | No | Distribution type of the application signing certificate. The options are **app_gallery**, **enterprise**, **os_integration**, and **crowdtesting**. | +| appProvisionType9+ | string | Yes | No | Type of the application signing certificate file. The options are **debug** and **release**.| diff --git a/en/application-dev/reference/apis/js-apis-bundle-BundleInfo.md b/en/application-dev/reference/apis/js-apis-bundle-BundleInfo.md index 38a93fd67cb7cd086f4e2f317dfd9a966ddc1f6d..f9e8ea3be2d7ccfff71426848d2dbc2f0e349201 100644 --- a/en/application-dev/reference/apis/js-apis-bundle-BundleInfo.md +++ b/en/application-dev/reference/apis/js-apis-bundle-BundleInfo.md @@ -2,14 +2,15 @@ -> **NOTE**
+> **NOTE** +> > The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version. Provides the application bundle information. - +## BundleInfo **System capability**: SystemCapability.BundleManager.BundleFramework diff --git a/en/application-dev/reference/apis/js-apis-bundle-CustomizeData.md b/en/application-dev/reference/apis/js-apis-bundle-CustomizeData.md index d45e4620d5af5f29334b9cb4bc264acea124095a..3fc0106cb1ae1317f4edfbffe87675626dfd016b 100644 --- a/en/application-dev/reference/apis/js-apis-bundle-CustomizeData.md +++ b/en/application-dev/reference/apis/js-apis-bundle-CustomizeData.md @@ -2,14 +2,15 @@ -> **NOTE**
+> **NOTE** +> > The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version. Provides custom metadata. - +## CustomizeData **System capability**: SystemCapability.BundleManager.BundleFramework diff --git a/en/application-dev/reference/apis/js-apis-bundle-ElementName.md b/en/application-dev/reference/apis/js-apis-bundle-ElementName.md new file mode 100644 index 0000000000000000000000000000000000000000..ede83cd6de76637220005f0821471c0141c9721f --- /dev/null +++ b/en/application-dev/reference/apis/js-apis-bundle-ElementName.md @@ -0,0 +1,20 @@ +# ElementName + +> **NOTE** +> +> The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version. + +Provides the element name information. + +## ElementName + + **System capability**: SystemCapability.BundleManager.BundleFramework + +| Name | Type | Readable| Writable| Description | +| ----------------------- | ---------| ---- | ---- | ------------------------- | +| deviceId | string | Yes | Yes | Device ID. | +| bundleName | string | Yes | Yes | Bundle name of the application. | +| abilityName | string | Yes | Yes | Name of the ability. | +| uri | string | Yes | Yes | URI. | +| shortName | string | Yes | Yes | Short name of the ability. | +| moduleName9+ | string | Yes | Yes | Name of the HAP file to which the ability belongs. | diff --git a/en/application-dev/reference/apis/js-apis-bundle-ExtensionAbilityInfo.md b/en/application-dev/reference/apis/js-apis-bundle-ExtensionAbilityInfo.md index ad3f411f69569eea7a25179302af000f2dee3edb..3c98a25b721a8f3cce41f927d7a35456761db366 100644 --- a/en/application-dev/reference/apis/js-apis-bundle-ExtensionAbilityInfo.md +++ b/en/application-dev/reference/apis/js-apis-bundle-ExtensionAbilityInfo.md @@ -2,14 +2,15 @@ -> **NOTE**
+> **NOTE** +> > The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version. Provides the Extension ability information. - +## ExtensionAbilityInfo **System capability**: SystemCapability.BundleManager.BundleFramework @@ -25,7 +26,7 @@ Provides the Extension ability information. | extensionAbilityType | bundle.ExtensionAbilityType | Yes | No | Type of the Extension ability. | | permissions | Array\ | Yes | No | Permissions required for other applications to call the Extension ability.| | applicationInfo | [ApplicationInfo](js-apis-bundle-ApplicationInfo.md) | Yes | No | Application information of the Extension ability. | -| metaData | Array\<[Metadata](js-apis-bundle-Metadata.md)> | Yes | No | Metadata of the Extension ability. | +| metadata | Array\<[Metadata](js-apis-bundle-Metadata.md)> | Yes | No | Metadata of the Extension ability. | | enabled | boolean | Yes | No | Whether the Extension ability is enabled. | | readPermission | string | Yes | No | Permission required for reading the Extension ability data. | | writePermission | string | Yes | No | Permission required for writing data to the Extension ability. | diff --git a/en/application-dev/reference/apis/js-apis-bundle-HapModuleInfo.md b/en/application-dev/reference/apis/js-apis-bundle-HapModuleInfo.md index 89a4a6d8a16ce6e8d1b98a36bfe26df6ca3bf414..2f6dbbef26e41ec1f78fe5768c2389d1a8ee0578 100644 --- a/en/application-dev/reference/apis/js-apis-bundle-HapModuleInfo.md +++ b/en/application-dev/reference/apis/js-apis-bundle-HapModuleInfo.md @@ -2,14 +2,15 @@ -> **NOTE**
+> **NOTE** +> > The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version. Provides the HAP module information. - +## HapModuleInfo **System capability**: SystemCapability.BundleManager.BundleFramework @@ -35,4 +36,4 @@ Provides the HAP module information. | mainElementName9+ | string | Yes | No | Information about the main ability. | | extensionAbilityInfo9+ | Array\<[ExtensionAbilityInfo](js-apis-bundle-ExtensionAbilityInfo.md)> | Yes | No | Information about the Extension ability.| | metadata9+ | Array\<[Metadata](js-apis-bundle-Metadata.md)> | Yes | No | Metadata of the ability. | -| hashValue9+ | string | Yes | No | The hash value of the module. | \ No newline at end of file +| hashValue9+ | string | Yes | No | Hash value of the module. | diff --git a/en/application-dev/reference/apis/js-apis-bundle-Metadata.md b/en/application-dev/reference/apis/js-apis-bundle-Metadata.md index 7c7d43b444284377bb4e80dc201ef45141ece00c..81a2bd77f57ad54be375f6911fe02102b04d20a9 100644 --- a/en/application-dev/reference/apis/js-apis-bundle-Metadata.md +++ b/en/application-dev/reference/apis/js-apis-bundle-Metadata.md @@ -2,14 +2,15 @@ -> **NOTE**
-> The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version. +> **NOTE** +> +> The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version. Provides the metadata information. - +## Metadata **System capability**: SystemCapability.BundleManager.BundleFramework diff --git a/en/application-dev/reference/apis/js-apis-bundle-ModuleInfo.md b/en/application-dev/reference/apis/js-apis-bundle-ModuleInfo.md index 71fc24ff40eca2febce360b6be7b9eeb149d1b52..4dc32a18b0aad9b28e8550d9a66b32bf85220add 100644 --- a/en/application-dev/reference/apis/js-apis-bundle-ModuleInfo.md +++ b/en/application-dev/reference/apis/js-apis-bundle-ModuleInfo.md @@ -2,14 +2,15 @@ -> **NOTE**
+> **NOTE** +> > The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version. Provides the module information of the application. - +## ModuleInfo **System capability**: SystemCapability.BundleManager.BundleFramework diff --git a/en/application-dev/reference/apis/js-apis-camera.md b/en/application-dev/reference/apis/js-apis-camera.md index 34b0ab6878da8b7a36848c5f7d7181022009a34b..43f15f6c7b3666fc53f69deadb0043e6adacca46 100644 --- a/en/application-dev/reference/apis/js-apis-camera.md +++ b/en/application-dev/reference/apis/js-apis-camera.md @@ -1,18 +1,15 @@ # Camera Management -> **NOTE**
+> **NOTE** +> > The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version. ## Modules to Import -``` +```js import camera from '@ohos.multimedia.camera'; ``` -## Required Permissions - -ohos.permission.CAMERA - ## camera.getCameraManager getCameraManager(context: Context, callback: AsyncCallback): void @@ -30,7 +27,7 @@ Obtains a **CameraManager** instance. This API uses an asynchronous callback to **Example** -``` +```js camera.getCameraManager(context, (err, cameraManager) => { if (err) { console.error('Failed to get the CameraManager instance ${err.message}'); @@ -62,7 +59,7 @@ Obtains a **CameraManager** instance. This API uses a promise to return the resu **Example** -``` +```js camera.getCameraManager(context).then((cameraManager) => { console.log('Promise returned with the CameraManager instance.'); }) @@ -74,12 +71,12 @@ Enumerates the camera statuses. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Default Value| Description | -| ------------------------- | ------ | ------------ | -| CAMERA_STATUS_APPEAR | 0 | The camera exists. | -| CAMERA_STATUS_DISAPPEAR | 1 | The camera does not exist.| -| CAMERA_STATUS_AVAILABLE | 2 | The camera is ready. | -| CAMERA_STATUS_UNAVAILABLE | 3 | The camera is not ready.| +| Name | Value | Description | +| ------------------------- | ---- | ------------ | +| CAMERA_STATUS_APPEAR | 0 | The camera exists. | +| CAMERA_STATUS_DISAPPEAR | 1 | The camera does not exist.| +| CAMERA_STATUS_AVAILABLE | 2 | The camera is ready. | +| CAMERA_STATUS_UNAVAILABLE | 3 | The camera is not ready.| ## CameraPosition @@ -88,11 +85,11 @@ Enumerates the camera positions. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Default Value| Description | -| --------------------------- | ------ | ---------------- | -| CAMERA_POSITION_UNSPECIFIED | 0 | Unspecified position.| -| CAMERA_POSITION_BACK | 1 | Rear camera. | -| CAMERA_POSITION_FRONT | 2 | Front camera. | +| Name | Value | Description | +| --------------------------- | ---- | ---------------- | +| CAMERA_POSITION_UNSPECIFIED | 0 | Unspecified position.| +| CAMERA_POSITION_BACK | 1 | Rear camera. | +| CAMERA_POSITION_FRONT | 2 | Front camera. | ## CameraType @@ -100,13 +97,13 @@ Enumerates the camera types. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Default Value| Description | -| ----------------------- | ------ | ---------------- | -| CAMERA_TYPE_UNSPECIFIED | 0 | Unspecified camera type.| -| CAMERA_TYPE_WIDE_ANGLE | 1 | Wide camera. | -| CAMERA_TYPE_ULTRA_WIDE | 2 | Ultra wide camera. | -| CAMERA_TYPE_TELEPHOTO | 3 | Telephoto camera. | -| CAMERA_TYPE_TRUE_DEPTH | 4 | True depth camera. | +| Name | Value | Description | +| ----------------------- | ---- | ---------------- | +| CAMERA_TYPE_UNSPECIFIED | 0 | Unspecified camera type.| +| CAMERA_TYPE_WIDE_ANGLE | 1 | Wide camera. | +| CAMERA_TYPE_ULTRA_WIDE | 2 | Ultra wide camera. | +| CAMERA_TYPE_TELEPHOTO | 3 | Telephoto camera. | +| CAMERA_TYPE_TRUE_DEPTH | 4 | True depth camera. | ## ConnectionType @@ -115,12 +112,22 @@ Enumerates the camera connection types. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Default Value| Description | -| ---------------------------- | ------ | ------------- | -| CAMERA_CONNECTION_BUILT_IN | 0 | Built-in camera. | -| CAMERA_CONNECTION_USB_PLUGIN | 1 | Camera connected using USB.| -| CAMERA_CONNECTION_REMOTE | 2 | Remote camera. | +| Name | Value | Description | +| ---------------------------- | ---- | ------------- | +| CAMERA_CONNECTION_BUILT_IN | 0 | Built-in camera. | +| CAMERA_CONNECTION_USB_PLUGIN | 1 | Camera connected using USB.| +| CAMERA_CONNECTION_REMOTE | 2 | Remote camera. | + +## Size + +Defines the image size that can be used in previewing, photographing, and video recording. + +**System capability**: SystemCapability.Multimedia.Camera.Core +| Name | Type | Readable| Writable| Description | +| ------ | ------ | ---- | ---- | ------------ | +| height | string | Yes | Yes | Image height.| +| width | number | Yes | Yes | Image width.| ## CameraManager @@ -142,7 +149,7 @@ Obtains all cameras supported by the device. This API uses an asynchronous callb **Example** -``` +```js cameraManager.getCameras((err, cameras) => { if (err) { console.error('Failed to get the cameras. ${err.message}'); @@ -169,41 +176,32 @@ Obtains all cameras supported by the device. This API uses a promise to return t **Example** -``` +```js cameraManager.getCameras().then((cameraArray) => { console.log('Promise returned with an array of supported cameras: ' + cameraArray.length); }) ``` -### Size - -Size parameters. This interface used to get supported size for Preview + Photo + Video. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -| Name | Default Value | Mandatory| Description | -| -------- | ------------------------------------------- | ---- | ----------------------------------- | -| height | number | Yes | Desired height of the Preview + Photo + Video. | -| width | number | Yes | Desired width of the Preview + Photo + Video.| - ### createCameraInput createCameraInput(cameraId: string, callback: AsyncCallback): void Creates a **CameraInput** instance with the specified camera ID. This API uses an asynchronous callback to return the instance. +**Required permissions**: ohos.permission.CAMERA + **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Default Value | Mandatory| Description | +| Name | Type | Mandatory| Description | | -------- | ------------------------------------------- | ---- | ----------------------------------- | | cameraId | string | Yes | Camera ID used to create the instance. | | callback | AsyncCallback<[CameraInput](#camerainput)\> | Yes | Callback used to return the **CameraInput** instance.| **Example** -``` +```js cameraManager.createCameraInput(cameraId, (err, cameraInput) => { if (err) { console.error('Failed to create the CameraInput instance. ${err.message}'); @@ -219,11 +217,13 @@ createCameraInput(cameraId: string): Promise Creates a **CameraInput** instance with the specified camera ID. This API uses a promise to return the instance. +**Required permissions**: ohos.permission.CAMERA + **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Default Value| Mandatory| Description | +| Name | Type | Mandatory| Description | | -------- | ------ | ---- | ------------ | | cameraId | string | Yes | Camera ID used to create the instance.| @@ -235,7 +235,7 @@ Creates a **CameraInput** instance with the specified camera ID. This API uses a **Example** -``` +```js cameraManager.createCameraInput(cameraId).then((cameraInput) => { console.log('Promise returned with the CameraInput instance'); }) @@ -247,6 +247,8 @@ createCameraInput(position: CameraPosition, type: CameraType, callback: AsyncCal Creates a **CameraInput** instance with the specified camera position and camera type. This API uses an asynchronous callback to return the instance. +**Required permissions**: ohos.permission.CAMERA + **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** @@ -259,7 +261,7 @@ Creates a **CameraInput** instance with the specified camera position and camera **Example** -``` +```js cameraManager.createCameraInput(camera.CameraPosition.CAMERA_POSITION_BACK, camera.CameraType.CAMERA_TYPE_UNSPECIFIED, (err, cameraInput) => { if (err) { console.error('Failed to create the CameraInput instance. ${err.message}'); @@ -275,6 +277,8 @@ createCameraInput(position: CameraPosition, type: CameraType): Promise { console.log('Promise returned with the CameraInput instance.'); }) @@ -302,7 +306,7 @@ cameraManager.createCameraInput(camera.CameraPosition.CAMERA_POSITION_BACK, came on(type: 'cameraStatus', callback: AsyncCallback): void -Listens for camera status changes. This API uses a callback to return the camera status changes. +Listens for camera status changes. This API uses an asynchronous callback to return the camera status changes. **System capability**: SystemCapability.Multimedia.Camera.Core @@ -315,7 +319,7 @@ Listens for camera status changes. This API uses a callback to return the camera **Example** -``` +```js cameraManager.on('cameraStatus', (err, cameraStatusInfo) => { if (err) { console.error('Failed to get cameraStatus callback. ${err.message}'); @@ -328,7 +332,7 @@ cameraManager.on('cameraStatus', (err, cameraStatusInfo) => { ## Camera -After **[camera.getCameraManager](#cameragetcameramanager)** is called, a camera instance is returned, including camera-related metadata such as **cameraId**, **cameraPosition**, **cameraType**, and **connectionType**. +After **[camera.getCameraManager](#cameragetcameramanager)** is called, a camera instance is returned, with camera-related metadata such as **cameraId**, **cameraPosition**, **cameraType**, and **connectionType**. **System capability**: SystemCapability.Multimedia.Camera.Core @@ -341,7 +345,7 @@ After **[camera.getCameraManager](#cameragetcameramanager)** is called, a camera **Example** -``` +```js async function getCameraInfo("cameraId") { var cameraManager = await camera.getCameraManager(); var cameras = await cameraManager.getCameras(); @@ -351,7 +355,6 @@ async function getCameraInfo("cameraId") { var cameraType = cameraObj.cameraType; var connectionType = cameraObj.connectionType; } - ``` ## CameraStatusInfo @@ -386,7 +389,7 @@ Obtains the camera ID based on which this **CameraInput** instance is created. T **Example** -``` +```js cameraInput.getCameraId((err, cameraId) => { if (err) { console.error('Failed to get the camera ID. ${err.message}'); @@ -412,7 +415,7 @@ Obtains the camera ID based on which this **CameraInput** instance is created. T **Example** -``` +```js cameraInput.getCameraId().then((cameraId) => { console.log('Promise returned with the camera ID:' + cameraId); }) @@ -435,7 +438,7 @@ Checks whether the device has flash light. This API uses an asynchronous callbac **Example** -``` +```js cameraInput.hasFlash((err, status) => { if (err) { console.error('Failed to check whether the device has flash light. ${err.message}'); @@ -461,7 +464,7 @@ Checks whether the device has flash light. This API uses a promise to return the **Example** -``` +```js cameraInput.hasFlash().then((status) => { console.log('Promise returned with the flash light support status:' + status); }) @@ -484,7 +487,7 @@ Checks whether a specified flash mode is supported. This API uses an asynchronou **Example** -``` +```js cameraInput.isFlashModeSupported(camera.FlashMode.FLASH_MODE_AUTO, (err, status) => { if (err) { console.error('Failed to check whether the flash mode is supported. ${err.message}'); @@ -516,7 +519,7 @@ Checks whether a specified flash mode is supported. This API uses a promise to r **Example** -``` +```js cameraInput.isFlashModeSupported(camera.FlashMode.FLASH_MODE_AUTO).then((status) => { console.log('Promise returned with flash mode support status.' + status); }) @@ -544,7 +547,7 @@ Before setting the parameters, do the following checks: **Example** -``` +```js cameraInput.setFlashMode(camera.FlashMode.FLASH_MODE_AUTO, (err) => { if (err) { console.error('Failed to set the flash mode ${err.message}'); @@ -581,7 +584,7 @@ Before setting the parameters, do the following checks: **Example** -``` +```js cameraInput.setFlashMode(camera.FlashMode.FLASH_MODE_AUTO).then(() => { console.log('Promise returned with the successful execution of setFlashMode.'); }) @@ -603,7 +606,7 @@ Obtains the current flash mode. This API uses an asynchronous callback to return **Example** -``` +```js cameraInput.getFlashMode((err, flashMode) => { if (err) { console.error('Failed to get the flash mode ${err.message}'); @@ -629,7 +632,7 @@ Obtains the current flash mode. This API uses a promise to return the result. **Example** -``` +```js cameraInput.getFlashMode().then((flashMode) => { console.log('Promise returned with current flash mode : ' + flashMode); }) @@ -652,7 +655,7 @@ Checks whether a specified focus mode is supported. This API uses an asynchronou **Example** -``` +```js cameraInput.isFocusModeSupported(camera.FocusMode.FOCUS_MODE_AUTO, (err, status) => { if (err) { console.error('Failed to check whether the focus mode is supported. ${err.message}'); @@ -680,11 +683,11 @@ Checks whether a specified focus mode is supported. This API uses a promise to r | Type | Description | | ----------------- | ----------------------------------------------------------- | -| Promise | Promise used to return the flash mode support status. The value **true** means that the specified focus mode is supported.| +| Promise | Promise used to return the focus mode support status. The value **true** means that the specified focus mode is supported.| **Example** -``` +```js cameraInput.isFocusModeSupported(camera.FocusMode.FOCUS_MODE_AUTO).then((status) => { console.log('Promise returned with focus mode support status.' + status); }) @@ -709,7 +712,7 @@ Before setting the focus mode, use **[isFocusModeSupported](#isfocusmodesupporte **Example** -``` +```js cameraInput.setFocusMode(camera.FocusMode.FOCUS_MODE_AUTO, (err) => { if (err) { console.error('Failed to set the focus mode ${err.message}'); @@ -743,7 +746,7 @@ Before setting the focus mode, use **[isFocusModeSupported](#isfocusmodesupporte **Example** -``` +```js cameraInput.setFocusMode(camera.FocusMode.FOCUS_MODE_AUTO).then(() => { console.log('Promise returned with the successful execution of setFocusMode.'); }) @@ -765,7 +768,7 @@ Obtains the current focus mode. This API uses an asynchronous callback to return **Example** -``` +```js cameraInput.getFocusMode((err, afMode) => { if (err) { console.error('Failed to get the focus mode ${err.message}'); @@ -791,7 +794,7 @@ Obtains the current focus mode. This API uses a promise to return the result. **Example** -``` +```js cameraInput.getFocusMode().then((afMode) => { console.log('Promise returned with current focus mode : ' + afMode); }) @@ -813,7 +816,7 @@ Obtains the zoom ratio range. This API uses an asynchronous callback to return t **Example** -``` +```js cameraInput.getZoomRatioRange((err, zoomRatioRange) => { if (err) { console.error('Failed to get the zoom ratio range. ${err.message}'); @@ -839,7 +842,7 @@ Obtains the zoom ratio range. This API uses a promise to return the result. **Example** -``` +```js cameraInput.getZoomRatioRange().then((zoomRatioRange) => { console.log('Promise returned with zoom ratio range: ' + zoomRatioRange.length); }) @@ -862,7 +865,7 @@ Sets a zoom ratio. This API uses an asynchronous callback to return the result. **Example** -``` +```js cameraInput.setZoomRatio(1, (err) => { if (err) { console.error('Failed to set the zoom ratio value ${err.message}'); @@ -894,7 +897,7 @@ Sets a zoom ratio. This API uses a promise to return the result. **Example** -``` +```js cameraInput.setZoomRatio(1).then(() => { console.log('Promise returned with the successful execution of setZoomRatio.'); }) @@ -916,7 +919,7 @@ Obtains the current zoom ratio. This API uses an asynchronous callback to return **Example** -``` +```js cameraInput.getZoomRatio((err, zoomRatio) => { if (err) { console.error('Failed to get the zoom ratio ${err.message}'); @@ -942,7 +945,7 @@ Obtains the current zoom ratio. This API uses a promise to return the result. **Example** -``` +```js cameraInput.getZoomRatio().then((zoomRatio) => { console.log('Promise returned with current zoom ratio : ' + zoomRatio); }) @@ -964,7 +967,7 @@ Releases this **CameraInput** instance. This API uses an asynchronous callback t **Example** -``` +```js cameraInput.release((err) => { if (err) { console.error('Failed to release the CameraInput instance ${err.message}'); @@ -990,7 +993,7 @@ Releases this **CameraInput** instance. This API uses a promise to return the re **Example** -``` +```js cameraInput.release().then(() => { console.log('Promise returned to indicate that the CameraInput instance is released successfully.'); }) @@ -1000,7 +1003,7 @@ cameraInput.release().then(() => { on(type: 'focusStateChange', callback: AsyncCallback): void -Listens for focus state changes. This API uses a callback to return the focus state changes. +Listens for focus state changes. This API uses an asynchronous callback to return the focus state changes. **System capability**: SystemCapability.Multimedia.Camera.Core @@ -1013,7 +1016,7 @@ Listens for focus state changes. This API uses a callback to return the focus st **Example** -``` +```js cameraInput.on('focusStateChange', (focusState) => { console.log('Focus state : ' + focusState); }) @@ -1029,40 +1032,39 @@ Listens for **CameraInput** errors. This API uses a callback to return the error **Parameters** -| Name | Type | Mandatory| Description | -| :------- | :------------------------------- | :--- | :---------------------------------------------- | +| Name | Type | Mandatory| Description | +| :------- | :------------------------------- | :--- | :----------------------------------------------- | | type | string | Yes | Type of event to listen for. The value is fixed at **error**, indicating the camera input error event.| -| callback | ErrorCallback | Yes | Callback used to return the capture input errors. | +| callback | ErrorCallback<[CameraInputError](#camerainputerror)\> | Yes | Callback used to return the error information. | **Example** -``` +```js cameraInput.on('error', (cameraInputError) => { console.log('Camera input error code: ' + cameraInputError.code); }) ``` -## CameraInputErrorCode +## CameraInputErrorCode -Enumerates the CameraInput error code. +Enumerates the **CameraInput** error codes. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Default Value| Description | -| ---------------------- | ------ | ------------ | -| ERROR_UNKNOWN | -1 | Unknown error.| +| Name | Value | Description | +| ------------- | ---- | ---------- | +| ERROR_UNKNOWN | -1 | Unknown error.| -## CameraInputError +## CameraInputError -Camera input error object which extends **Error** interface. +Defines a **CameraInput** error object. **System capability**: SystemCapability.Multimedia.Camera.Core -**Parameters** +| Name| Type | Description | +| ---- | ------------------------------------------- | -------------------------- | +| code | [CameraInputErrorCode](#camerainputerrorcode) | **CameraInput** error code.| -| Name | Default Value| Description | -| ---------------------- | ------ | ------------ | -| code | [CameraInputErrorCode](#camerainputerrorcode) | Used to get error code in CameraInput on('error') callback| ## FlashMode @@ -1070,12 +1072,12 @@ Enumerates the flash modes. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Default Value| Description | -| ---------------------- | ------ | ------------ | -| FLASH_MODE_CLOSE | 0 | The flash is off.| -| FLASH_MODE_OPEN | 1 | The flash is on.| -| FLASH_MODE_AUTO | 2 | The flash mode is auto, indicating that the flash fires automatically depending on the shooting conditions.| -| FLASH_MODE_ALWAYS_OPEN | 3 | The flash is steady on.| +| Name | Value | Description | +| ---------------------- | ---- | ------------ | +| FLASH_MODE_CLOSE | 0 | The flash is off.| +| FLASH_MODE_OPEN | 1 | The flash is on.| +| FLASH_MODE_AUTO | 2 | The flash mode is auto, indicating that the flash fires automatically depending on the shooting conditions.| +| FLASH_MODE_ALWAYS_OPEN | 3 | The flash is steady on.| ## FocusMode @@ -1083,12 +1085,12 @@ Enumerates the focus modes. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Default Value| Description | -| -------------------------- | ------ | ------------------ | -| FOCUS_MODE_MANUAL | 0 | Manual focus. | -| FOCUS_MODE_CONTINUOUS_AUTO | 1 | Continuous auto focus.| -| FOCUS_MODE_AUTO | 2 | Auto focus. | -| FOCUS_MODE_LOCKED | 3 | Locked focus. | +| Name | Value | Description | +| -------------------------- | ---- | ------------------ | +| FOCUS_MODE_MANUAL | 0 | Manual focus. | +| FOCUS_MODE_CONTINUOUS_AUTO | 1 | Continuous auto focus.| +| FOCUS_MODE_AUTO | 2 | Auto focus. | +| FOCUS_MODE_LOCKED | 3 | Locked focus. | ## FocusState @@ -1096,11 +1098,11 @@ Enumerates the focus states. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Default Value| Description | -| --------------------- | ------ | ------------ | -| FOCUS_STATE_SCAN | 0 | Scanning. | -| FOCUS_STATE_FOCUSED | 1 | Focused.| -| FOCUS_STATE_UNFOCUSED | 2 | Unfocused.| +| Name | Value | Description | +| --------------------- | ---- | ------------ | +| FOCUS_STATE_SCAN | 0 | Scanning. | +| FOCUS_STATE_FOCUSED | 1 | Focused.| +| FOCUS_STATE_UNFOCUSED | 2 | Unfocused.| ## camera.createCaptureSession @@ -1119,7 +1121,7 @@ Creates a **CaptureSession** instance. This API uses an asynchronous callback to **Example** -``` +```js camera.createCaptureSession((context), (err, captureSession) => { if (err) { console.error('Failed to create the CaptureSession instance. ${err.message}'); @@ -1151,7 +1153,7 @@ Creates a **CaptureSession** instance. This API uses a promise to return the ins **Example** -``` +```js camera.createCaptureSession(context).then((captureSession) => { console.log('Promise returned with the CaptureSession instance'); }) @@ -1177,7 +1179,7 @@ Starts configuration for this **CaptureSession** instance. This API uses an asyn **Example** -``` +```js captureSession.beginConfig((err) => { if (err) { console.error('Failed to start the configuration. ${err.message}'); @@ -1204,7 +1206,7 @@ Starts configuration for this **CaptureSession** instance. This API uses a promi **Example** -``` +```js captureSession.beginConfig().then(() => { console.log('Promise returned to indicate the begin config success.'); }) @@ -1226,7 +1228,7 @@ Commits the configuration for this **CaptureSession** instance. This API uses an **Example** -``` +```js captureSession.commitConfig((err) => { if (err) { console.error('Failed to commit the configuration. ${err.message}'); @@ -1252,7 +1254,7 @@ Commits the configuration for this **CaptureSession** instance. This API uses a **Example** -``` +```js captureSession.commitConfig().then(() => { console.log('Promise returned to indicate the commit config success.'); }) @@ -1275,7 +1277,7 @@ Adds a **CameraInput** instance to this **CaptureSession** instance. This API us **Example** -``` +```js captureSession.addInput(cameraInput, (err) => { if (err) { console.error('Failed to add the CameraInput instance. ${err.message}'); @@ -1307,7 +1309,7 @@ Adds a **CameraInput** instance to this **CaptureSession** instance. This API us **Example** -``` +```js captureSession.addInput(cameraInput).then(() => { console.log('Promise used to indicate that the CameraInput instance is added.'); }) @@ -1330,7 +1332,7 @@ Adds a **PreviewOutput** instance to this **CaptureSession** instance. This API **Example** -``` +```js captureSession.addOutput(previewOutput, (err) => { if (err) { console.error('Failed to add the PreviewOutput instance ${err.message}'); @@ -1362,7 +1364,7 @@ Adds a **PreviewOutput** instance to this **CaptureSession** instance. This API **Example** -``` +```js captureSession.addOutput(previewOutput).then(() => { console.log('Promise used to indicate that the PreviewOutput instance is added.'); }) @@ -1385,7 +1387,7 @@ Adds a **PhotoOutput** instance to this **CaptureSession** instance. This API us **Example** -``` +```js captureSession.addOutput(photoOutput, (err) => { if (err) { console.error('Failed to add the PhotoOutput instance ${err.message}'); @@ -1417,7 +1419,7 @@ Adds a **PhotoOutput** instance to this **CaptureSession** instance. This API us **Example** -``` +```js captureSession.addOutput(photoOutput).then(() => { console.log('Promise used to indicate that the PhotoOutput instance is added.'); }) @@ -1440,7 +1442,7 @@ Adds a **VideoOutput** instance to this **CaptureSession** instance. This API us **Example** -``` +```js captureSession.addOutput(videoOutput, (err) => { if (err) { console.error('Failed to add the VideoOutput instance ${err.message}'); @@ -1472,7 +1474,7 @@ Adds a **VideoOutput** instance to this **CaptureSession** instance. This API us **Example** -``` +```js captureSession.addOutput(videoOutput).then(() => { console.log('Promise used to indicate that the VideoOutput instance is added.'); }) @@ -1495,7 +1497,7 @@ Removes a **CameraInput** instance from this **CaptureSession** instance. This A **Example** -``` +```js captureSession.removeInput(cameraInput, (err) => { if (err) { console.error('Failed to remove the CameraInput instance. ${err.message}'); @@ -1527,7 +1529,7 @@ Removes a **CameraInput** instance from this **CaptureSession** instance. This A **Example** -``` +```js captureSession.removeInput(cameraInput).then(() => { console.log('Promise returned to indicate that the cameraInput instance is removed.'); }) @@ -1550,7 +1552,7 @@ Removes a **PreviewOutput** instance from this **CaptureSession** instance. This **Example** -``` +```js captureSession.removeOutput(previewOutput, (err) => { if (err) { console.error('Failed to remove the PreviewOutput instance. ${err.message}'); @@ -1584,7 +1586,7 @@ Removes a **PreviewOutput** instance from this **CaptureSession** instance. This **Example** -``` +```js captureSession.removeOutput(previewOutput).then(() => { console.log('Promise returned to indicate that the PreviewOutput instance is removed.'); }) @@ -1607,7 +1609,7 @@ Removes a **PhotoOutput** instance from this **CaptureSession** instance. This A **Example** -``` +```js captureSession.removeOutput(photoOutput, (err) => { if (err) { console.error('Failed to remove the PhotoOutput instance. ${err.message}'); @@ -1641,7 +1643,7 @@ Removes a **PhotoOutput** instance from this **CaptureSession** instance. This A **Example** -``` +```js captureSession.removeOutput(photoOutput).then(() => { console.log('Promise returned to indicate that the PhotoOutput instance is removed.'); }) @@ -1664,7 +1666,7 @@ Removes a **VideoOutput** instance from this **CaptureSession** instance. This A **Example** -``` +```js captureSession.removeOutput(videoOutput, (err) => { if (err) { console.error('Failed to remove the VideoOutput instance. ${err.message}'); @@ -1698,7 +1700,7 @@ Removes a **VideoOutput** instance from this **CaptureSession** instance. This A **Example** -``` +```js captureSession.removeOutput(videoOutput).then(() => { console.log('Promise returned to indicate that the VideoOutput instance is removed.'); }) @@ -1720,7 +1722,7 @@ Starts this **CaptureSession** instance. This API uses an asynchronous callback **Example** -``` +```js captureSession.start((err) => { if (err) { console.error('Failed to start the session ${err.message}'); @@ -1746,7 +1748,7 @@ Starts this **CaptureSession** instance. This API uses a promise to return the r **Example** -``` +```js captureSession.start().then(() => { console.log('Promise returned to indicate the session start success.'); }) @@ -1769,7 +1771,7 @@ Stops this **CaptureSession** instance. This API uses an asynchronous callback t **Example** -``` +```js captureSession.stop((err) => { if (err) { console.error('Failed to stop the session ${err.message}'); @@ -1795,7 +1797,7 @@ Stops this **CaptureSession** instance. This API uses a promise to return the re **Example** -``` +```js captureSession.stop().then(() => { console.log('Promise returned to indicate the session stop success.'); }) @@ -1817,7 +1819,7 @@ Releases this **CaptureSession** instance. This API uses an asynchronous callbac **Example** -``` +```js captureSession.release((err) => { if (err) { console.error('Failed to release the CaptureSession instance ${err.message}'); @@ -1843,7 +1845,7 @@ Releases this **CaptureSession** instance. This API uses a promise to return the **Example** -``` +```js captureSession.release().then(() => { console.log('Promise returned to indicate that the CaptureSession instance is released successfully.'); }) @@ -1859,40 +1861,38 @@ Listens for **CaptureSession** errors. This API uses a callback to return the er **Parameters** -| Name | Type | Mandatory| Description | -| :------- | :---------------------------------- | :--- | :-------------------------------------------- | -| type | string | Yes | Type of event to listen for. The value is fixed at **error**, indicating the capture session error event.| -| callback | ErrorCallback | Yes | Callback used to return the capture session errors. | +| Name | Type | Mandatory| Description | +| :------- | :---------------------------------------------------------- | :--- | :-------------------------------------------- | +| type | string | Yes | Type of event to listen for. The value is fixed at **error**, indicating the capture session error event.| +| callback | ErrorCallback<[CaptureSessionError](#capturesessionerror)\> | Yes | Callback used to return the error information. | **Example** -``` +```js captureSession.on('error', (captureSessionError) => { console.log('Capture session error code: ' + captureSessionError.code); }) ``` -## CaptureSessionErrorCode +## CaptureSessionErrorCode -Enumerates the CaptureSession error code. +Enumerates the **CaptureSession** error codes. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Default Value| Description | -| ---------------------- | ------ | ------------ | -| ERROR_UNKNOWN | -1 | Unknown error.| +| Name | Value | Description | +| ------------- | ---- | ---------- | +| ERROR_UNKNOWN | -1 | Unknown error.| -## CaptureSessionError +## CaptureSessionError -Capture session error object which extends **Error** interface. +Defines a **CaptureSession** error object. **System capability**: SystemCapability.Multimedia.Camera.Core -**Parameters** - -| Name | Default Value| Description | -| ---------------------- | ------ | ------------ | -| code | [CaptureSessionErrorCode](#capturesessionerrorcode) | Used to get error code in CaptureSession on('error') callback.| +| Name| Type | Description | +| ---- | ------------------------------------------- | -------------------------- | +| code | [CaptureSessionError](#capturesessionerror) | **CaptureSession** error code.| ## camera.createPreviewOutput @@ -1911,7 +1911,7 @@ Creates a **PreviewOutput** instance. This API uses an asynchronous callback to **Example** -``` +```js camera.createPreviewOutput(("surfaceId"), (err, previewOutput) => { if (err) { console.error('Failed to create the PreviewOutput instance. ${err.message}'); @@ -1943,7 +1943,7 @@ Creates a **PreviewOutput** instance. This API uses a promise to return the inst **Example** -``` +```js camera.createPreviewOutput("surfaceId").then((previewOutput) => { console.log('Promise returned with the PreviewOutput instance'); }) @@ -1969,7 +1969,7 @@ Releases this **PreviewOutput** instance. This API uses an asynchronous callback **Example** -``` +```js previewOutput.release((err) => { if (err) { console.error('Failed to release the PreviewOutput instance ${err.message}'); @@ -1996,7 +1996,7 @@ Releases this **PreviewOutput** instance. This API uses a promise to return the **Example** -``` +```js previewOutput.release().then(() => { console.log('Promise returned to indicate that the PreviewOutput instance is released successfully.'); }) @@ -2019,7 +2019,7 @@ Listens for preview frame start events. This API uses an asynchronous callback t **Example** -``` +```js previewOutput.on('frameStart', () => { console.log('Preview frame started'); }) @@ -2042,7 +2042,7 @@ Listens for preview frame end events. This API uses an asynchronous callback to **Example** -``` +```js previewOutput.on('frameEnd', () => { console.log('Preview frame ended'); }) @@ -2058,14 +2058,14 @@ Listens for **PreviewOutput** errors. This API uses a callback to return the err **Parameters** -| Name | Type | Mandatory| Description | -| :------- | :--------------------------------- | :--- | :-------------------------------------------- | -| type | string | Yes | Type of event to listen for. The value is fixed at **error**, indicating the preview output error event.| -| callback | ErrorCallback | Yes | Callback used to return the preview output errors. | +| Name | Type | Mandatory| Description | +| :------- | :----------------------------------------------------------- | :--- | :-------------------------------------------- | +| type | string | Yes | Type of event to listen for. The value is fixed at **error**, indicating the preview output error event.| +| callback | ErrorCallback<[PreviewOutputErrorCode](#previewoutputerrorcode)\> | Yes | Callback used to return the error information. | **Example** -``` +```js previewOutput.on('error', (previewOutputError) => { console.log('Preview output error code: ' + previewOutputError.code); }) @@ -2073,25 +2073,23 @@ previewOutput.on('error', (previewOutputError) => { ## PreviewOutputErrorCode -Enumerates the PreviewOutput error code. +Enumerates the **PreviewOutput** error codes. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Default Value| Description | -| ---------------------- | ------ | ------------ | -| ERROR_UNKNOWN | -1 | Unknown error.| +| Name | Value | Description | +| ------------- | ---- | ---------- | +| ERROR_UNKNOWN | -1 | Unknown error.| -## PreviewOutputError +## PreviewOutputError -Preview output error object which extends **Error** interface. +Defines a **PreviewOutput** error object. **System capability**: SystemCapability.Multimedia.Camera.Core -**Parameters** - -| Name | Default Value| Description | -| ---------------------- | ------ | ------------ | -| code | [PreviewOutputErrorCode](#previewoutputerrorcode) | Used to get error code in PreviewOutput on('error') callback.| +| Name| Type | Description | +| ---- | ------------------------------------------------- | ---------------------- | +| code | [PreviewOutputErrorCode](#previewoutputerrorcode) | **PreviewOutput** error code.| ## camera.createPhotoOutput @@ -2110,7 +2108,7 @@ Creates a **PhotoOutput** instance. This API uses an asynchronous callback to re **Example** -``` +```js camera.createPhotoOutput(("surfaceId"), (err, photoOutput) => { if (err) { console.error('Failed to create the PhotoOutput instance. ${err.message}'); @@ -2142,7 +2140,7 @@ Creates a **PhotoOutput** instance. This API uses a promise to return the instan **Example** -``` +```js camera.createPhotoOutput("surfaceId").then((photoOutput) => { console.log('Promise returned with PhotoOutput instance'); }) @@ -2153,14 +2151,12 @@ Enumerates the image rotation angles. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Default Value| Description | -| ------------ | ------ | --------------- | -| ROTATION_0 | 0 | The image rotates 0 degrees. | -| ROTATION_90 | 90 | The image rotates 90 degrees. | -| ROTATION_180 | 180 | The image rotates 180 degrees.| -| ROTATION_270 | 270 | The image rotates 270 degrees.| - - +| Name | Value | Description | +| ------------ | ---- | --------------- | +| ROTATION_0 | 0 | The image rotates 0 degrees. | +| ROTATION_90 | 90 | The image rotates 90 degrees. | +| ROTATION_180 | 180 | The image rotates 180 degrees.| +| ROTATION_270 | 270 | The image rotates 270 degrees.| ## QualityLevel @@ -2168,23 +2164,23 @@ Enumerates the image quality levels. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Default Value| Description | -| -------------------- | ------ | -------------- | -| QUALITY_LEVEL_HIGH | 0 | High image quality. | -| QUALITY_LEVEL_MEDIUM | 1 | Medium image quality.| -| QUALITY_LEVEL_LOW | 2 | Low image quality. | +| Name | Value | Description | +| -------------------- | ---- | -------------- | +| QUALITY_LEVEL_HIGH | 0 | High image quality. | +| QUALITY_LEVEL_MEDIUM | 1 | Medium image quality.| +| QUALITY_LEVEL_LOW | 2 | Low image quality. | ## PhotoCaptureSetting -Defines the settings for image capture. +Defines the settings for photo capture. **System capability**: SystemCapability.Multimedia.Camera.Core | Name | Type | Mandatory| Description | | -------- | ------------------------------- | ---- | -------------- | -| quality | [QualityLevel](#qualitylevel) | No | Photo image quality. | -| rotation | [ImageRotation](#imagerotation) | No | Photo rotation.| +| quality | [QualityLevel](#qualitylevel) | No | Photo quality. | +| rotation | [ImageRotation](#imagerotation) | No | Rotation angle of the photo.| ## PhotoOutput @@ -2207,7 +2203,7 @@ Captures a photo. This API uses an asynchronous callback to return the result. **Example** -``` +```js photoOutput.capture((err) => { if (err) { console.error('Failed to capture the photo ${err.message}'); @@ -2234,7 +2230,7 @@ Captures a photo with the specified capture settings. This API uses an asynchron **Example** -``` +```js photoOutput.capture(settings, (err) => { if (err) { console.error('Failed to capture the photo ${err.message}'); @@ -2267,7 +2263,7 @@ Captures a photo with the specified capture settings. This API uses a promise to **Example** -``` +```js photoOutput.capture().then(() => { console.log('Promise returned to indicate that photo capture request success.'); }) @@ -2289,7 +2285,7 @@ Releases this **PhotoOutput** instance. This API uses an asynchronous callback t **Example** -``` +```js photoOutput.release((err) => { if (err) { console.error('Failed to release the PhotoOutput instance ${err.message}'); @@ -2316,7 +2312,7 @@ Releases this **PhotoOutput** instance. This API uses a promise to return the re **Example** -``` +```js photoOutput.release().then(() => { console.log('Promise returned to indicate that the PhotoOutput instance is released successfully.'); }) @@ -2326,7 +2322,7 @@ photoOutput.release().then(() => { on(type: 'captureStart', callback: AsyncCallback): void -Listens for photo capture start events. This API uses a callback to return the event information. +Listens for photo capture start events. This API uses an asynchronous callback to return the capture ID. **System capability**: SystemCapability.Multimedia.Camera.Core @@ -2339,7 +2335,7 @@ Listens for photo capture start events. This API uses a callback to return the e **Example** -``` +```js photoOutput.on('captureStart', (err, captureId) => { console.log('photo capture stated, captureId : ' + captureId); }) @@ -2349,20 +2345,20 @@ photoOutput.on('captureStart', (err, captureId) => { on(type: 'frameShutter', callback: AsyncCallback): void -Listens for frame shutter events. This API uses a callback to return the event information. +Listens for frame shutter events. This API uses an asynchronous callback to return the event information. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| :------- | :------------------------------- | :--- | :--------------------------------------------- | -| type | string | Yes | Type of event to listen for. The value is fixed at **frameShutter**, indicating the frame shutter event.| -| callback | AsyncCallback | Yes | Callback used to return the frame shutter information. | +| Name | Type | Mandatory| Description | +| :------- | :---------------------------------------------------- | :--- | :--------------------------------------------- | +| type | string | Yes | Type of event to listen for. The value is fixed at **frameShutter**, indicating the frame shutter event.| +| callback | AsyncCallback<[FrameShutterInfo](#frameshutterinfo)\> | Yes | Callback used to return the information. | **Example** -``` +```js photoOutput.on('frameShutter', (frameShutterInfo) => { console.log('photo capture end, captureId : ' + frameShutterInfo.captureId); console.log('Timestamp for frame : ' + frameShutterInfo.timestamp); @@ -2373,20 +2369,20 @@ photoOutput.on('frameShutter', (frameShutterInfo) => { on(type: 'captureEnd', callback: AsyncCallback): void -Listens for photo capture end events. This API uses a callback to return the event information. +Listens for photo capture end events. This API uses an asynchronous callback to return the event information. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| :------- | :----------------------------- | :--- | :--------------------------------------------- | -| type | string | Yes | Type of event to listen for. The value is fixed at **captureEnd**, indicating the photo capture end event.| -| callback | AsyncCallback | Yes | Callback used to return the photo capture end information. | +| Name | Type | Mandatory| Description | +| :------- | :------------------------------------------------ | :--- | :--------------------------------------------- | +| type | string | Yes | Type of event to listen for. The value is fixed at **captureEnd**, indicating the photo capture end event.| +| callback | AsyncCallback<[CaptureEndInfo](#captureendinfo)\> | Yes | Callback used to return the information. | **Example** -``` +```js photoOutput.on('captureEnd', (captureEndInfo) => { console.log('photo capture end, captureId : ' + captureEndInfo.captureId); console.log('frameCount : ' + captureEndInfo.frameCount); @@ -2403,62 +2399,60 @@ Listens for **PhotoOutput** errors. This API uses a callback to return the error **Parameters** -| Name | Type | Mandatory| Description | -| :------- | :------------------------------- | :--- | :---------------------------------------- | -| type | string | Yes | Type of event to listen for. The value is fixed at **error**, indicating the photo output error event.| -| callback | ErrorCallback | Yes | Callback used to return the photo output errors. | +| Name | Type | Mandatory| Description | +| :------- | :---------------------------------------------------- | :--- | :---------------------------------------- | +| type | string | Yes | Type of event to listen for. The value is fixed at **error**, indicating the photo output error event.| +| callback | ErrorCallback<[PhotoOutputError](#photooutputerror)\> | Yes | Callback used to return the error information. | **Example** -``` +```js photoOutput.on('error', (photoOutputError) => { console.log('Photo output error code: ' + photoOutputError.code); }) ``` -### FrameShutterInfo +## FrameShutterInfo -Frame shutter callback info which provides **captureId** & **timestamp** parameteres & indicates the frame shutter event. +Defines the frame shutter information. -**Parameteres** +**System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Type | Mandatory| Description | -| :------- | :------------------------------- | :--- | :---------------------------------------- | -| captureId | number | Yes | Capture id.| -| timestamp | number | Yes | Timestamp for frame. +| Name | Type | Mandatory| Description | +| --------- | ------ | ---- | ----------------------------- | +| captureId | number | Yes | ID of this capture action.| +| timestamp | number | Yes | Timestamp when the frame shutter event is triggered. | -### CaptureEndInfo +## CaptureEndInfo -Capture end info which provides **captureId** & **frameCount** parameteres & indicates the photo capture end event. +Defines the capture end information. -**Parameteres** +**System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Type | Mandatory| Description | -| :------- | :------------------------------- | :--- | :---------------------------------------- | -| captureId | number | Yes | Capture id.| -| frameCount | number | Yes | Frame count. +| Name | Type | Mandatory| Description | +| ---------- | ------ | ---- | ----------------------------- | +| captureId | number | Yes | ID of this capture action.| +| frameCount | number | Yes | Number of frames captured. | ## PhotoOutputErrorCode -Enumerates the PhotoOutput error code. +Enumerates the **PhotoOutput** error codes. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Default Value| Description | -| ---------------------- | ------ | ------------ | -| ERROR_UNKNOWN | -1 | Unknown error.| +| Name | Value | Description | +| ------------- | ---- | ---------- | +| ERROR_UNKNOWN | -1 | Unknown error.| -## PhotoOutputError +## PhotoOutputError -Photo output error object which extends **Error** interface. +Defines a **PhotoOutput** error object. **System capability**: SystemCapability.Multimedia.Camera.Core -**Parameters** - -| Name | Default Value| Description | -| ---------------------- | ------ | ------------ | -| code | [PhotoOutputErrorCode](#photooutputerrorcode) | Used to get error code in PhotoOutput on('error') callback.| +| Name| Type | Description | +| ---- | ------------------------------------- | ----------------------- | +| code | [PhotoOutputError](#photooutputerror) | **PhotoOutput** error code.| ## camera.createVideoOutput @@ -2477,7 +2471,7 @@ Creates a **VideoOutput** instance. This API uses an asynchronous callback to re **Example** -``` +```js camera.createVideoOutput(("surfaceId"), (err, videoOutput) => { if (err) { console.error('Failed to create the VideoOutput instance. ${err.message}'); @@ -2509,7 +2503,7 @@ Creates a **VideoOutput** instance. This API uses a promise to return the instan **Example** -``` +```js camera.createVideoOutput("surfaceId" ).then((videoOutput) => { console.log('Promise returned with the VideoOutput instance'); @@ -2536,7 +2530,7 @@ Starts the video output. This API uses an asynchronous callback to return the re **Example** -``` +```js videoOutput.start((err) => { if (err) { console.error('Failed to start the video output ${err.message}'); @@ -2563,7 +2557,7 @@ Starts the video output. This API uses a promise to return the result. **Example** -``` +```js videoOutput.start().then(() => { console.log('Promise returned to indicate that start method execution success.'); }) @@ -2585,7 +2579,7 @@ Stops the video output. This API uses an asynchronous callback to return the res **Example** -``` +```js videoOutput.stop((err) => { if (err) { console.error('Failed to stop the video output ${err.message}'); @@ -2611,7 +2605,7 @@ Stops the video output. This API uses a promise to return the result. **Example** -``` +```js videoOutput.start().then(() => { console.log('Promise returned to indicate that stop method execution success.'); }) @@ -2633,7 +2627,7 @@ Releases this **VideoOutput** instance. This API uses an asynchronous callback t **Example** -``` +```js videoOutput.release((err) => { if (err) { console.error('Failed to release the VideoOutput instance ${err.message}'); @@ -2660,7 +2654,7 @@ Releases this **VideoOutput** instance. This API uses a promise to return the re **Example** -``` +```js videoOutput.release().then(() => { console.log('Promise returned to indicate that the VideoOutput instance is released successfully.'); }) @@ -2670,7 +2664,7 @@ videoOutput.release().then(() => { on(type: 'frameStart', callback: AsyncCallback): void -Listens for video frame start events. This API uses a callback to return the event information. +Listens for video frame start events. This API uses an asynchronous callback to return the event information. **System capability**: SystemCapability.Multimedia.Camera.Core @@ -2683,7 +2677,7 @@ Listens for video frame start events. This API uses a callback to return the eve **Example** -``` +```js videoOutput.on('frameStart', () => { console.log('Video frame started'); }) @@ -2693,7 +2687,7 @@ videoOutput.on('frameStart', () => { on(type: 'frameEnd', callback: AsyncCallback): void -Listens for video frame end events. This API uses a callback to return the event information. +Listens for video frame end events. This API uses an asynchronous callback to return the event information. **System capability**: SystemCapability.Multimedia.Camera.Core @@ -2706,7 +2700,7 @@ Listens for video frame end events. This API uses a callback to return the event **Example** -``` +```js videoOutput.on('frameEnd', () => { console.log('Video frame ended'); }) @@ -2722,14 +2716,14 @@ Listens for **VideoOutput** errors. This API uses a callback to return the error **Parameters** -| Name | Type | Mandatory| Description | -| :------- | :-------------------------- | :--- | :-------------------------------------------- | -| type | string | Yes | Type of event to listen for. The value is fixed at **error**, indicating the video output error event.| -| callback | Callback | Yes | Callback used to return the video output errors. | +| Name | Type | Mandatory| Description | +| :------- | :----------------------------------------------- | :--- | :-------------------------------------------- | +| type | string | Yes | Type of event to listen for. The value is fixed at **error**, indicating the video output error event.| +| callback | Callback<[VideoOutputError](#videooutputerror)\> | Yes | Callback used to return the error information. | **Example** -``` +```js videoOutput.on('error', (VideoOutputError) => { console.log('Video output error code: ' + VideoOutputError.code); }) @@ -2737,22 +2731,20 @@ videoOutput.on('error', (VideoOutputError) => { ## VideoOutputErrorCode -Enumerates the VideoOutput error code. +Enumerates the **VideoOutput** error codes. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Default Value| Description | -| ---------------------- | ------ | ------------ | -| ERROR_UNKNOWN | -1 | Unknown error.| +| Name | Value | Description | +| ------------- | ---- | ---------- | +| ERROR_UNKNOWN | -1 | Unknown error.| -## VideoOutputError +## VideoOutputError -Photo output error object which extends **Error** interface. +Defines a **VideoOutput** error object. **System capability**: SystemCapability.Multimedia.Camera.Core -**Parameters** - -| Name | Default Value| Description | -| ---------------------- | ------ | ------------ | -| code | [VideoOutputErrorCode](#videooutputerrorcode) | Used to get error code in VideoOutput on('error') callback.| \ No newline at end of file +| Name| Type | Description | +| ---- | ------------------------------------- | ----------------------- | +| code | [PhotoOutputError](#photooutputerror) | **VideoOutput** error code.| diff --git a/en/application-dev/reference/apis/js-apis-image.md b/en/application-dev/reference/apis/js-apis-image.md index ff9c8b14b4aba73b734f9fb61f4e6f2d1d2755aa..85ff0550112bbfc81e22925c3a69ca7ac813cfab 100644 --- a/en/application-dev/reference/apis/js-apis-image.md +++ b/en/application-dev/reference/apis/js-apis-image.md @@ -34,6 +34,7 @@ Creates a **PixelMap** object. This API uses a promise to return the result. ```js const color = new ArrayBuffer(96); +let bufferArr = new Unit8Array(color); let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } } image.createPixelMap(color, opts) .then((pixelmap) => { @@ -60,6 +61,7 @@ Creates a **PixelMap** object. This API uses an asynchronous callback to return ```js const color = new ArrayBuffer(96); +let bufferArr = new Unit8Array(color); let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } } image.createPixelMap(color, opts, (pixelmap) => { }) @@ -100,10 +102,11 @@ Reads image pixel map data and writes the data to an **ArrayBuffer**. This API u **Example** ```js -pixelmap.readPixelsToBuffer(ReadBuffer).then(() => { - console.log('readPixelsToBuffer succeeded.'); // Called if the condition is met. +const readBuffer = new ArrayBuffer(400); +pixelmap.readPixelsToBuffer(readBuffer).then(() => { + console.log('Succeeded in reading image pixel data.'); // Called if the condition is met. }).catch(error => { - console.log('readPixelsToBuffer failed.'); // Called if no condition is met. + ('Failed to read image pixel data.'); // Called if no condition is met. }) ``` @@ -125,11 +128,12 @@ Reads image pixel map data and writes the data to an **ArrayBuffer**. This API u **Example** ```js -pixelmap.readPixelsToBuffer(ReadBuffer, (err, res) => { +const readBuffer = new ArrayBuffer(400); +pixelmap.readPixelsToBuffer(readBuffer, (err, res) => { if(err) { - console.log('readPixelsToBuffer failed.'); // Called if the condition is met. + console.log('Failed to read image pixel data.'); // Called if no condition is met. } else { - console.log('readPixelsToBuffer succeeded.'); // Called if the condition is met. + console.log('Succeeded in reading image pixel data.'); // Called if the condition is met. } }) ``` @@ -157,10 +161,11 @@ Reads image pixel map data in an area. This API uses a promise to return the dat **Example** ```js -pixelmap.readPixels(Area).then((data) => { - console.log('readPixels succeeded.'); // Called if the condition is met. +const area = new ArrayBuffer(400); +pixelmap.readPixels(area).then(() => { + console.log('Succeeded in reading the image data in the area.'); // Called if the condition is met. }).catch(error => { - console.log('readPixels failed.'); // Called if no condition is met. + console.log('Failed to read the image data in the area.'); // Called if no condition is met. }) ``` @@ -182,6 +187,8 @@ Reads image pixel map data in an area. This API uses an asynchronous callback to **Example** ```js +const color = new ArrayBuffer(96); +let bufferArr = new Unit8Array(color); let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } } image.createPixelMap(color, opts, (err, pixelmap) => { if(pixelmap == undefined){ @@ -222,6 +229,7 @@ Writes image pixel map data to an area. This API uses a promise to return the op ```js const color = new ArrayBuffer(96); +let bufferArr = new Unit8Array(color); let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } } image.createPixelMap(color, opts) .then( pixelmap => { @@ -233,7 +241,7 @@ image.createPixelMap(color, opts) stride: 8, region: { size: { height: 1, width: 2 }, x: 0, y: 0 } } - var bufferArr = new Uint8Array(area.pixels); + let bufferArr = new Uint8Array(area.pixels); for (var i = 0; i < bufferArr.length; i++) { bufferArr[i] = i + 1; } @@ -269,13 +277,18 @@ Writes image pixel map data to an area. This API uses an asynchronous callback t **Example** ```js -pixelmap.writePixels(Area, () => { - const readArea = { - pixels: new ArrayBuffer(20), - offset: 0, - stride: 8, - region: { size: { height: 1, width: 2 }, x: 0, y: 0 }, - } +const area = new ArrayBuffer(400); +pixelmap.writePixels(area, (error) => { + if (error!=undefined) { + console.info('Failed to write pixelmap into the specified area.'); + } else { + const readArea = { + pixels: new ArrayBuffer(20), + offset: 0, + stride: 8, + region: { size: { height: 1, width: 2 }, x: 0, y: 0 }, + } + } }) ``` @@ -302,7 +315,10 @@ Reads image data in an **ArrayBuffer** and writes the data to a **PixelMap** obj **Example** ```js -PixelMap.writeBufferToPixels(color).then(() => { +const color = new ArrayBuffer(96); +const pixelMap = new ArrayBuffer(400); +let bufferArr = new Unit8Array(color); +pixelMap.writeBufferToPixels(color).then(() => { console.log("Succeeded in writing data from a buffer to a PixelMap."); }).catch((err) => { console.error("Failed to write data from a buffer to a PixelMap."); @@ -327,7 +343,10 @@ Reads image data in an **ArrayBuffer** and writes the data to a **PixelMap** obj **Example** ```js -PixelMap.writeBufferToPixels(color, function(err) { +const color = new ArrayBuffer(96);\ +const pixelMap = new ArrayBuffer(400); +let bufferArr = new Unit8Array(color); +pixelMap.writeBufferToPixels(color, function(err) { if (err) { console.error("Failed to write data from a buffer to a PixelMap."); return; @@ -354,7 +373,8 @@ Obtains pixel map information of this image. This API uses a promise to return t **Example** ```js -PixelMap.getImageInfo().then(function(info) { +const pixelMap = new ArrayBuffer(400); +pixelMap.getImageInfo().then(function(info) { console.log("Succeeded in obtaining the image pixel map information."); }).catch((err) => { console.error("Failed to obtain the image pixel map information."); @@ -379,9 +399,7 @@ Obtains pixel map information of this image. This API uses an asynchronous callb ```js pixelmap.getImageInfo((imageInfo) => { - console.log("getImageInfo succeeded."); -}).catch((err) => { - console.error("getImageInfo failed."); + console.log("Succeeded in obtaining the image pixel map information.."); }) ``` @@ -402,7 +420,10 @@ Obtains the number of bytes per line of the image pixel map. **Example** ```js -image.createPixelMap(clolr, opts, (err,pixelmap) => { +const color = new ArrayBuffer(96); +let bufferArr = new Unit8Array(color); +let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } } +image.createPixelMap(color, opts, (err,pixelmap) => { let rowCount = pixelmap.getBytesNumberPerRow(); }) ``` @@ -444,11 +465,14 @@ Releases this **PixelMap** object. This API uses a promise to return the result. **Example** ```js +const color = new ArrayBuffer(96); +let bufferArr = new Unit8Array(color); +let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } } image.createPixelMap(color, opts, (pixelmap) => { pixelmap.release().then(() => { - console.log('release succeeded.'); + console.log('Succeeded in releasing pixelmap object.'); }).catch(error => { - console.log('release failed.'); + console.log('Failed to release pixelmap object.'); }) }) ``` @@ -470,11 +494,14 @@ Releases this **PixelMap** object. This API uses an asynchronous callback to ret **Example** ```js +const color = new ArrayBuffer(96); +let bufferArr = new Unit8Array(color); +let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } } image.createPixelMap(color, opts, (pixelmap) => { pixelmap.release().then(() => { - console.log('release succeeded.'); + console.log('Succeeded in releasing pixelmap object.'); }).catch(error => { - console.log('release failed.'); + console.log('Failed to release pixelmap object.'); }) }) ``` @@ -589,9 +616,7 @@ Obtains information about this image. This API uses an asynchronous callback to ```js imageSourceApi.getImageInfo(imageInfo => { - console.log('getImageInfo succeeded.'); -}).catch(error => { - console.log('getImageInfo failed.'); + console.log('Succeeded in obtaining the image information.'); }) ``` @@ -620,9 +645,9 @@ Obtains information about an image with the specified index. This API uses a pro ```js imageSourceApi.getImageInfo(0) .then(imageInfo => { - console.log('getImageInfo succeeded.'); + console.log('Succeeded in obtaining the image information.'); }).catch(error => { - console.log('getImageInfo failed.'); + console.log('Failed to obtain the image information.'); }) ``` @@ -652,9 +677,7 @@ Obtains the value of a property with the specified index in this image. This API ```js imageSourceApi.getImageProperty("BitsPerSample") .then(data => { - console.log('getImageProperty succeeded.'); - }).catch(error => { - console.log('getImageProperty failed.'); + console.log('Succeeded in getting the value of the specified attribute key of the image.'); }) ``` @@ -678,9 +701,9 @@ Obtains the value of a property with the specified index in this image. This API ```js imageSourceApi.getImageProperty("BitsPerSample",(error,data) => { if(error) { - console.log('getImageProperty failed.'); + console.log('Failed to get the value of the specified attribute key of the image.'); } else { - console.log('getImageProperty succeeded.'); + console.log('Succeeded in getting the value of the specified attribute key of the image.'); } }) ``` @@ -704,11 +727,12 @@ Obtains the value of a property in this image. This API uses an asynchronous cal **Example** ```js -imageSourceApi.getImageProperty("BitsPerSample",Property,(error,data) => { +const property = new ArrayBuffer(400); +imageSourceApi.getImageProperty("BitsPerSample",property,(error,data) => { if(error) { - console.log('getImageProperty failed.'); + console.log('Failed to get the value of the specified attribute key of the image.'); } else { - console.log('getImageProperty succeeded.'); + console.log('Succeeded in getting the value of the specified attribute key of the image.'); } }) ``` @@ -737,9 +761,9 @@ Creates a **PixelMap** object based on image decoding parameters. This API uses ```js imageSourceApi.createPixelMap().then(pixelmap => { - console.log('createPixelMap succeeded.'); + console.log('Succeeded in creating pixelmap object through image decoding parameters.'); }).catch(error => { - console.log('createPixelMap failed.'); + console.log('Failed to create pixelmap object through image decoding parameters.'); }) ``` @@ -761,9 +785,9 @@ Creates a **PixelMap** object based on the default parameters. This API uses an ```js imageSourceApi.createPixelMap(pixelmap => { - console.log('createPixelMap succeeded.'); + console.log('Succeeded in creating pixelmap object.'); }).catch(error => { - console.log('createPixelMap failed.'); + console.log('Failed to create pixelmap object.'); }) ``` @@ -785,11 +809,10 @@ Creates a **PixelMap** object based on image decoding parameters. This API uses **Example** ```js +const decodingOptions = new ArrayBuffer(400); imageSourceApi.createPixelMap(decodingOptions, pixelmap => { - console.log('createPixelMap succeeded.'); -}).catch(error => { - console.log('createPixelMap failed.'); -}) + console.log('Succeeded in creating pixelmap object.'); +}) ``` ### release @@ -811,8 +834,6 @@ Releases this **ImageSource** instance. This API uses an asynchronous callback t ```js imageSourceApi.release(() => { console.log('release succeeded.'); -}).catch(error => { - console.log('release failed.'); }) ``` @@ -834,9 +855,9 @@ Releases this **ImageSource** instance. This API uses a promise to return the re ```js imageSourceApi.release().then(()=>{ - console.log('release succeeded.'); + console.log('Succeeded in releasing the image source instance.'); }).catch(error => { - console.log('release failed.'); + console.log('Failed to release the image source instance.'); }) ``` @@ -891,8 +912,9 @@ Packs an image. This API uses an asynchronous callback to return the result. **Example** ```js -let packOpts = { format:["image/jpeg"], quality:98 }; -imagePackerApi.packing(ImageSourceApi, packOpts, data => {}) +let packOpts = { format:"image/jpeg", quality:98 }; +const imageSourceApi = new ArrayBuffer(400); +imagePackerApi.packing(imageSourceApi, packOpts, data => {}) ``` ### packing @@ -919,8 +941,9 @@ Packs an image. This API uses a promise to return the result. **Example** ```js -let packOpts = { format:["image/jpeg"], quality:98 } -imagePackerApi.packing(ImageSourceApi, packOpts) +let packOpts = { format:"image/jpeg", quality:98 } +const imageSourceApi = new ArrayBuffer(400); +imagePackerApi.packing(imageSourceApi, packOpts) .then( data => { console.log('packing succeeded.'); }).catch(error => { @@ -947,11 +970,12 @@ Packs an image. This API uses an asynchronous callback to return the result. **Example** ```js -let packOpts = { format:["image/jpeg"], quality:98 } -imagePackerApi.packing(PixelMapApi, packOpts, data => { - console.log('packing succeeded.'); +let packOpts = { format:"image/jpeg", quality:98 } +const pixelMapApi = new ArrayBuffer(400); +imagePackerApi.packing(pixelMapApi, packOpts, data => { + console.log('Succeeded in packing the image.'); }).catch(error => { - console.log('packing failed.'); + console.log('Failed to pack the image.'); }) ``` @@ -979,12 +1003,13 @@ Packs an image. This API uses a promise to return the result. **Example** ```js -let packOpts = { format:["image/jpeg"], quality:98 } -imagePackerApi.packing(PixelMapApi, packOpts) +let packOpts = { format:"image/jpeg", quality:98 } +const pixelMapApi = new ArrayBuffer(400); +imagePackerApi.packing(pixelMapApi, packOpts) .then( data => { - console.log('packing succeeded.'); + console.log('Succeeded in packing the image.'); }).catch(error => { - console.log('packing failed.'); + console.log('Failed to pack the image..'); }) ``` @@ -1006,9 +1031,7 @@ Releases this **ImagePacker** instance. This API uses an asynchronous callback t ```js imagePackerApi.release(()=>{ - console.log('release succeeded.'); -}).catch(error => { - console.log('release failed.'); + console.log('Succeeded in releasing image packaging.'); }) ``` @@ -1030,9 +1053,9 @@ Releases this **ImagePacker** instance. This API uses a promise to return the re ```js imagePackerApi.release().then(()=>{ - console.log('release succeeded.'); + console.log('Succeeded in releasing image packaging.'); }).catch((error)=>{ - console.log('release failed.'); + console.log('Failed to release image packaging.'); }) ``` @@ -1098,7 +1121,7 @@ Obtains a surface ID for the camera or other components. This API uses an asynch **Example** ```js - receiver.getReceivingSurfaceId((err, id) => { +receiver.getReceivingSurfaceId((err, id) => { if(err) { console.log('getReceivingSurfaceId failed.'); } else { @@ -1513,7 +1536,7 @@ Defines image decoding options. | desiredSize | [Size](#size) | Yes | Yes | Expected output size. | | desiredRegion | [Region](#region7) | Yes | Yes | Region to decode. | | desiredPixelFormat | [PixelMapFormat](#pixelmapformat7) | Yes | Yes | Pixel map format for decoding.| -| index | number | Yes | Yes | Index of the image to decode. | +| index | number | Yes | Yes | Index of the image to decode. | ## Region7+ @@ -1536,7 +1559,7 @@ Defines the option for image packing. | Name | Type | Readable| Writable| Description | | ------- | ------ | ---- | ---- | -------------- | | format | string | Yes | Yes | Format of the packed image. | -| quality | number | Yes | Yes | Quality of the packed image.| +| quality | number | Yes | Yes | Quality of the output image during JPEG encoding. The value ranges from 1 to 100.| ## GetImagePropertyOptions7+ diff --git a/en/application-dev/reference/apis/js-apis-sensor.md b/en/application-dev/reference/apis/js-apis-sensor.md index aab544f7f78bd2b755ab24443aa1d0acd5d683c1..16dbb61057c1ab6f8d6c34462004d8babbacb448 100644 --- a/en/application-dev/reference/apis/js-apis-sensor.md +++ b/en/application-dev/reference/apis/js-apis-sensor.md @@ -886,11 +886,7 @@ Subscribes to only one data change of the proximity sensor. **Example** ```js - sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY, function(error, data) { - if (error) { - console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message); - return; - } + sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY, function(data) { console.info('Distance: ' + data.distance); } ); @@ -1350,8 +1346,6 @@ off(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback?: Callback<HumidityRes Unsubscribes from sensor data changes. -**Required permission**: ohos.permission.READ_HEALTH_DATA (a system permission) - **System capability**: SystemCapability.Sensors.Sensor **Parameters** @@ -1404,8 +1398,6 @@ sensor.off(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, callback); Unsubscribes from sensor data changes. -**Required permissions**: ohos.permission.ACCELEROMETER (a system permission) - **System capability**: SystemCapability.Sensors.Sensor **Parameters** @@ -1487,6 +1479,8 @@ off(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback?: Callback<PedometerR Unsubscribes from sensor data changes. +**Required permissions**: ohos.permission.ACTIVITY_MOTION + **System capability**: SystemCapability.Sensors.Sensor **Parameters** @@ -1739,7 +1733,7 @@ Obtains the geomagnetic field of a geographic location. This API uses a promise **Return value** | Type | Description | | ---------------------------------------- | ------- | -| Promise<[GeomagneticResponse](#geomagneticresponse)> | Promise used to return the geomagnetic field. | +| Promise<[GeomagneticResponse](#geomagneticresponse)> | Promise used to return the geomagnetic field.| **Example** ```js @@ -1899,7 +1893,6 @@ Obtains the angle change between two rotation matrices. This API uses a callback err.message); return; } - console.info("SensorJsAPI--->Successed to get getAngleModifiy interface get data: " + data.x); for (var i=0; i < data.length; i++) { console.info("data[" + i + "]: " + data[i]); } @@ -1967,7 +1960,6 @@ Converts a rotation vector into a rotation matrix. This API uses a callback to r err.message); return; } - console.info("SensorJsAPI--->Successed to get createRotationMatrix interface get data: " + data.x); for (var i=0; i < data.length; i++) { console.info("data[" + i + "]: " + data[i]); } @@ -2034,7 +2026,6 @@ Converts a rotation vector into a quaternion. This API uses a callback to return err.message); return; } - console.info("SensorJsAPI--->Successed to get createQuaternion interface get data: " + data.x); for (var i=0; i < data.length; i++) { console.info("data[" + i + "]: " + data[i]); } @@ -2169,7 +2160,6 @@ Creates a rotation matrix based on the gravity vector and geomagnetic vector. Th err.message); return; } - console.info("SensorJsAPI--->Successed to get createRotationMatrix interface get data: " + data.x); for (var i=0; i < data.length; i++) { console.info("data[" + i + "]: " + data[i]) } diff --git a/en/application-dev/webgl/webgl-guidelines.md b/en/application-dev/webgl/webgl-guidelines.md index 23b4feca5f4bdb77288c3c823fcf24796f70d43a..f541b6328a122a8fd331e790977916ca681b13ab 100644 --- a/en/application-dev/webgl/webgl-guidelines.md +++ b/en/application-dev/webgl/webgl-guidelines.md @@ -12,17 +12,17 @@ WebGL helps you process graphics at the frontend, for example, drawing color gra | API| Description| | -------- | -------- | | canvas.getContext | Obtains the canvas context.| -| webgl.createBuffer(): WebGLBuffer \| null | Creates and initializes a WebGL buffer.| -| webgl.bindBuffer(target: GLenum, buffer: WebGLBuffer \| null): void | Binds the WebGL buffer to the target.| -| webgl.bufferData(target: GLenum, srcData: ArrayBufferView, usage: GLenum, srcOffset: GLuint, length?: GLuint): void | Creates and initializes the WebGL buffer object's data store.| -| webgl.getAttribLocation(program: WebGLProgram, name: string): GLint | Obtains the address of the **attribute** variable in the shader from the given WebGLProgram.| -| webgl.vertexAttribPointer(index: GLuint, size: GLint, type: GLenum, normalized: GLboolean, stride: GLsizei, offset: GLintptr): void | Assigns a **Buffer** object to a variable.| -| webgl.enableVertexAttribArray(index: GLuint): void | Connects a variable to the **Buffer** object allocated to it.| -| webgl.clearColor(red: GLclampf, green: GLclampf, blue: GLclampf, alpha: GLclampf): void | Clears the specified color on the **\** component.| -| webgl.clear(mask: GLbitfield): void | Clears the **\** component.| -| webgl.drawArrays(mode: GLenum, first: GLint, count: GLsizei): void | Draws data.| -| webgl.flush(): void | Flushes data to the GPU and clears the buffer.| -| webgl.createProgram(): WebGLProgram \| null | Creates a **WebGLProgram** object.| +| webgl.createBuffer(): WebGLBuffer \| null | Creates and initializes a WebGL buffer.| +| webgl.bindBuffer(target: GLenum, buffer: WebGLBuffer \| null): void | Binds the WebGL buffer to the target.| +| webgl.bufferData(target: GLenum, srcData: ArrayBufferView, usage: GLenum, srcOffset: GLuint, length?: GLuint): void | Creates and initializes the WebGL buffer object's data store.| +| webgl.getAttribLocation(program: WebGLProgram, name: string): GLint | Obtains the address of the **attribute** variable in the shader from the given WebGLProgram.| +| webgl.vertexAttribPointer(index GLuint, size: GLint, type: GLenum, normalized: GLboolean, stride: GLsizei, offset: GLintptr): void | Assigns a **Buffer** object to a variable.| +| webgl.enableVertexAttribArray(index: GLuint): void | Connects a variable to the **Buffer** object allocated to it.| +| webgl.clearColor(red: GLclampf, green:GLclampf, blue: GLclampf, alpha: GLclampf): void | Clears the specified color on the **\** component.| +| webgl.clear(mask: GLbitfield): void | Clears the **\** component.| +| webgl.drawArrays(mode: GLenum, first:;GLint, count: GLsizei): void | Draws data.| +| webgl.flush(): void | Flushes data to the GPU and clears the buffer.| +| webgl.createProgram(): WebGLProgram \| null | Creates a **WebGLProgram** object.| ## How to Develop @@ -699,3 +699,9 @@ To use WebGL to draw a color triangle (GPU drawing), perform the following steps **Figure 2** Effect of clicking the button to draw a color triangle ![en-us_image_0000001192429306](figures/en-us_image_0000001192429306.gif) + +## Samples + +The following sample is provided to help you better understand how to develop WebGL: + +- [`JsWbgGL`: WebGL (JS, API version 8)](https://gitee.com/openharmony/app_samples/tree/master/Graphics/JsWebGL) diff --git a/en/contribute/OpenHarmony-64bits-coding-guide.md b/en/contribute/OpenHarmony-64bits-coding-guide.md index 32d5a20a9e3fc7cbf11149e7324b32ba3e08ecee..b007ac53bfa3601f8f5f69db190170758b5abf27 100644 --- a/en/contribute/OpenHarmony-64bits-coding-guide.md +++ b/en/contribute/OpenHarmony-64bits-coding-guide.md @@ -52,7 +52,7 @@ The table below lists the length of `sizeof` and `print` in ILP32 and LP64 to sh | unsigned long int | 4 | %lu | **8** | %lu | Differences exist.| | long long | 8 | %lld | 8 | %lld | | | unsigned long long | 8 | %llu | 8 | %llu | | -| type * | 4 | %p | **8** | %p | Differences exist.| +| type \* | 4 | %p | **8** | %p | Differences exist.| | pid_t | 4 | %d | 4 | %d | | | socklen_t | 4 | %u | 4 | %u | | | off_t | 4 | %zd | **8** | %zd | Differences exist.| @@ -121,7 +121,7 @@ Although uint64\_t has a fixed length, **sizeof(Foo)** is different due to align | double | 8 | 8 | %lf | Used for double-precision floating point numbers.| | bool | 1 | 1 | %d | Used for Boolean.| | uintptr_t | **4** | **8** | %zu | Used for pointer storage. Different lengths are defined for 32- and 64-bit OSs.| -| type * | **4** | **8** | %p | Variable-length type. It is equivalent to uintptr_t, which is recommended for type conversion.| +| type \* | **4** | **8** | %p | Variable-length type. It is equivalent to uintptr_t, which is recommended for type conversion.| | nullptr_t | **4** | **8** | %p | Used for pointer initialization.| | pid_t | 4 | 4 | %d | Built-in for the Linux kernel. It has a fixed length.| | socklen_t | 4 | 4 | %u | Built-in for the Linux kernel. It has a fixed length.| @@ -353,13 +353,13 @@ p = (int32_t *)malloc(sizeof(p) * ELEMENTS_NUMBER); [Example] ```c -#pragma pack(push) # Save the current alignment mode. -#pragma pack(1) # Set the alignment mode to 1-byte alignment. +#pragma pack(push) // Save the current alignment mode. +#pragma pack(1) // Set the alignment mode to 1-byte alignment. struct test { ...... }; -#pragma pack(pop) # Restore the previous alignment mode. +#pragma pack(pop) // Restore the previous alignment mode. ``` #### [Rule] Uniform the message structures related to multi-device communication. For compatibility purposes, 1-byte alignment is preferred. Do not use 8-byte alignment or 64-bit data types to avoid errors during communication with a 32-bit OS. @@ -492,9 +492,9 @@ printf("t2 = %lu\n", t2); t1 is a signed negative 32-bit number, which must be extended with signs. The most significant bits of the negative number are all fs, and the value after extension is 0xffffffffffffffff. t2 is an unsigned 64-bit number, the value of which is a large positive number. -#### [Rule] When a pointer is used as the base address and the offset is calculated by byte, the pointer must be forcibly converted to a single-byte pointer such as uintptr_t or uint8_t *. +#### [Rule] When a pointer is used as the base address and the offset is calculated by byte, the pointer must be forcibly converted to a single-byte pointer such as uintptr_t or uint8_t \*. -[Description] If the pointer is converted to an integer of the uint32_t type, the pointer may be truncated. This will not occur if the pointer is converted to uintptr_t. The pointer can also be converted to a single-byte pointer such as uint8_t * and char *. In this case, the offset is considered as bytes. A one-byte offset will be carried out for the void * type. To clarify the type, you are advised to use the type that is more specific. +[Description] If the pointer is converted to an integer of the uint32_t type, the pointer may be truncated. This will not occur if the pointer is converted to uintptr_t. The pointer can also be converted to a single-byte pointer such as uint8_t \* and char \*. In this case, the offset is considered as bytes. A one-byte offset will be carried out for the void \* type. To clarify the type, you are advised to use the type that is more specific. [Example] @@ -503,13 +503,13 @@ t1 is a signed negative 32-bit number, which must be extended with signs. The mo void *pPkt = (void *)((uint32_t)MSG_GET_DATA_ADDR(msgAddr) + OFFSET); // Correct -void *pPkt = (void *)((uintptr_t)MSG_GET_DATA_ADDR(msgAddr) + OFFSET);// C +void *pPkt = (void *)((uintptr_t)MSG_GET_DATA_ADDR(msgAddr) + OFFSET); // C void *pPkt = reinterpret_cast(reinterpret_cast(MSG_GET_DATA_ADDR(msgAddr)) + OFFSET); // C++ ``` #### [Rule] Mutual assignment is forbidden between pointers and uint32_t, including function parameter passing. -[Description] If the variable to be defined is a length-variable pointer, use void *. If the variable to be defined is a pointer or an integer, use uintptr_t. +[Description] If the variable to be defined is a length-variable pointer, use void \*. If the variable to be defined is a pointer or an integer, use uintptr_t. [Example] Conversion between pointers and integers diff --git a/zh-cn/application-dev/connectivity/websocket-connection.md b/zh-cn/application-dev/connectivity/websocket-connection.md index a3a335abccb58ae12b21df75d566c83256928ee7..8cd007bf75842aac584aa76cf97c1f986473962e 100644 --- a/zh-cn/application-dev/connectivity/websocket-connection.md +++ b/zh-cn/application-dev/connectivity/websocket-connection.md @@ -3,7 +3,7 @@ ## 场景介绍 -使用WebSocket建立服务器与客户端的双向连接，需要先通过createWebSocket方法创建WebSocket对象，然后通过connect方法连接到服务器。当连接成功后，客户端会收到open事件的回调，之后客户端就可以通过send方法与服务器进行通信。当服务器发信息给客户端时，客户端会收到message事件的回调。当客户端不要此连接时，可以通过调用close方法主动断开连接，之后客户端会收到close事件的回调。 +使用WebSocket建立服务器与客户端的双向连接，需要先通过createWebSocket()方法创建WebSocket对象，然后通过connect()方法连接到服务器。当连接成功后，客户端会收到open事件的回调，之后客户端就可以通过send()方法与服务器进行通信。当服务器发信息给客户端时，客户端会收到message事件的回调。当客户端不要此连接时，可以通过调用close()方法主动断开连接，之后客户端会收到close事件的回调。 若在上述任一过程中发生错误，客户端会收到error事件的回调。 @@ -18,23 +18,23 @@ WebSocket连接功能主要由webSocket模块提供。使用该功能需要申 | connect() | 根据URL地址，建立一个WebSocket连接。 | | send() | 通过WebSocket连接发送数据。 | | close() | 关闭WebSocket连接。 | -| on(type: 'open') | 订阅WebSocket的打开事件。 | -| off(type: 'open') | 取消订阅WebSocket的打开事件。 | -| on(type: 'message') | 订阅WebSocket的接收到服务器消息事件。 | -| off(type: 'message') | 取消订阅WebSocket的接收到服务器消息事件。 | -| on(type: 'close') | 订阅WebSocket的关闭事件。 | -| off(type: 'close') | 取消订阅WebSocket的关闭事件 | -| on(type: 'error') | 订阅WebSocket的Error事件。 | -| off(type: 'error') | 取消订阅WebSocket的Error事件。 | +| on(type: 'open') | 订阅WebSocket的打开事件。 | +| off(type: 'open') | 取消订阅WebSocket的打开事件。 | +| on(type: 'message') | 订阅WebSocket的接收到服务器消息事件。 | +| off(type: 'message') | 取消订阅WebSocket的接收到服务器消息事件。 | +| on(type: 'close') | 订阅WebSocket的关闭事件。 | +| off(type: 'close') | 取消订阅WebSocket的关闭事件 | +| on(type: 'error') | 订阅WebSocket的Error事件。 | +| off(type: 'error') | 取消订阅WebSocket的Error事件。 | ## 开发步骤 -1. import需要的webSocket模块。 +1. 导入需要的webSocket模块。 2. 创建一个WebSocket连接，返回一个WebSocket对象。 -3. （可选）订阅WebSocket的打开、消息、关闭、Error事件。 +3. （可选）订阅WebSocket的打开、消息接收、关闭、Error事件。 4. 根据URL地址，发起WebSocket连接。 @@ -50,9 +50,9 @@ WebSocket连接功能主要由webSocket模块提供。使用该功能需要申 // 当收到on('open')事件时，可以通过send()方法与服务器进行通信 ws.send("Hello, server!", (err, value) => { if (!err) { - console.log("send success"); + console.log("Message sent successfully"); } else { - console.log("send fail, err:" + JSON.stringify(err)); + console.log("Failed to send the message. Err:" + JSON.stringify(err)); } }); }); @@ -62,9 +62,9 @@ WebSocket连接功能主要由webSocket模块提供。使用该功能需要申 if (value === 'bye') { ws.close((err, value) => { if (!err) { - console.log("close success"); + console.log("Connection closed successfully"); } else { - console.log("close fail, err is " + JSON.stringify(err)); + console.log("Failed to close the connection. Err: " + JSON.stringify(err)); } }); } @@ -77,9 +77,9 @@ WebSocket连接功能主要由webSocket模块提供。使用该功能需要申 }); ws.connect(defaultIpAddress, (err, value) => { if (!err) { - console.log("connect success"); + console.log("Connected successfully"); } else { - console.log("connect fail, err:" + JSON.stringify(err)); + console.log("Connection failed. Err:" + JSON.stringify(err)); } }); ``` diff --git a/zh-cn/application-dev/device/sample-server-guidelines.md b/zh-cn/application-dev/device/sample-server-guidelines.md index d627de4a1607bd3cf2ea2edf10ced138f846086a..b9d1ab5850fa0cbe35f503b517b66fa28f3d3664 100644 --- a/zh-cn/application-dev/device/sample-server-guidelines.md +++ b/zh-cn/application-dev/device/sample-server-guidelines.md @@ -33,12 +33,12 @@ ``` mkdir server_sample // 建立示例服务器server_sample目录 - touch server_sample/BUILD.gn // 创建BUILD.gn编译文件 - mkdir server_sample/include // 建立示例服务器头文件include目录 - touch server_process.h // 创建server_process.h头文件 + touch server_sample/BUILD.gn // 创建BUILD.gn编译文件 + mkdir server_sample/include // 建立示例服务器头文件include目录 + touch server_process.h // 创建server_process.h头文件 mkdir server_sample/src // 建立示例服务器c/c++文件src目录 - touch server_sample/src/server_process.c // 创建server_process.c文件 - touch server_sample/src/main.cpp // 创建main.cpp文件 + touch server_sample/src/server_process.c // 创建server_process.c文件 + touch server_sample/src/main.cpp // 创建main.cpp文件 ``` 4. 编写编译文件BUILD.gn diff --git a/zh-cn/application-dev/reference/apis/js-apis-animator.md b/zh-cn/application-dev/reference/apis/js-apis-animator.md index 6acf87e937cffb211ccfa6b43ca3d70276491fcf..35c8f7ce114b4f83f6b4287244696e3c9f652b4d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-animator.md +++ b/zh-cn/application-dev/reference/apis/js-apis-animator.md @@ -1,5 +1,7 @@ # 动画 +本模块提供组件动画效果，包括定义动画、启动动画和以相反的顺序播放动画等。 + > **说明：** > > 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 @@ -21,14 +23,14 @@ createAnimator(options: AnimatorOptions): AnimatorResult **系统能力：** SystemCapability.ArkUI.ArkUI.Full **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | options | [AnimatorOptions](#animatoroptions) | 是 | 定义动画选项。| +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| options | [AnimatorOptions](#animatoroptions) | 是 | 定义动画选项。| **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | [AnimatorResult](#animatorresult) | Animator结果接口。 | +| 类型 | 说明 | +| -------- | -------- | +| [AnimatorResult](#animatorresult) | Animator结果接口。 | **示例：** @@ -92,9 +94,9 @@ update(options: AnimatorOptions): void **系统能力：** SystemCapability.ArkUI.ArkUI.Full **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | options | [AnimatorOptions](#animatoroptions) | 是 | 定义动画选项。| +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| options | [AnimatorOptions](#animatoroptions) | 是 | 定义动画选项。| **示例：** ``` @@ -175,9 +177,9 @@ onframe: (progress: number) => void **系统能力：** SystemCapability.ArkUI.ArkUI.Full **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | progress | number | 是 | 动画的当前进度。| +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| progress | number | 是 | 动画的当前进度。| **示例：** ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-bytrace.md b/zh-cn/application-dev/reference/apis/js-apis-bytrace.md index 9eb2a4a96fe5909666ef9df138b68e2fb4cb7ccd..add046e1ff964c4f3d54cf4e5657f74a456b0c62 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bytrace.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bytrace.md @@ -1,5 +1,7 @@ # 性能打点 +本模块提供了追踪进程轨迹。 + > **说明：** > - 从API Version 8开始，该接口不再维护，推荐使用新接口[`@ohos.hiTraceMeter`](js-apis-hitracemeter.md)。 > - 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-connectedTag.md b/zh-cn/application-dev/reference/apis/js-apis-connectedTag.md index f0993bdb4d39ee0521368c13a05f5cf0dbf2c2b4..6f62b388faf8642a95796829f7f39147e03db897 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-connectedTag.md +++ b/zh-cn/application-dev/reference/apis/js-apis-connectedTag.md @@ -1,5 +1,7 @@ # 有源标签 +本模块提供有源标签的使用，包括初始化有源标签芯片、读取有源标签内容、写入内容到有源标签等。 + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-contact.md b/zh-cn/application-dev/reference/apis/js-apis-contact.md index d278496c2a547c4150b98ac20adcfead9ddac860..fa9d389a4a908ffc790de9dab1c2fa570b0f9eb1 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-contact.md +++ b/zh-cn/application-dev/reference/apis/js-apis-contact.md @@ -1,5 +1,7 @@ # 联系人 +本模块提供联系人管理能力，包括添加联系人、删除联系人、更新联系人等 + >**说明：** > >本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-continuation-continuationExtraParams.md b/zh-cn/application-dev/reference/apis/js-apis-continuation-continuationExtraParams.md index e72255533792d0b6e44e8c694430b04751087c09..8270193601115937abe402bb26eb67e11f907411 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-continuation-continuationExtraParams.md +++ b/zh-cn/application-dev/reference/apis/js-apis-continuation-continuationExtraParams.md @@ -1,5 +1,7 @@ # ContinuationExtraParams +本模块提供流转管理入口中互联面板所需的过滤参数。 + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 @@ -15,7 +17,7 @@ import continuationManager from "@ohos.continuation.continuationManager" **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.DistributedAbilityManager -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 参数类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | | deviceType | Array\ | 是 | 是 | 表示设备类型。| | targetBundle | string | 是 | 是 | 表示目标包名。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-convertxml.md b/zh-cn/application-dev/reference/apis/js-apis-convertxml.md index 8c5d07f459ab09421173796afd247726009df586..b5bad4a12fb5be6631b00662311387e9f217dd18 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-convertxml.md +++ b/zh-cn/application-dev/reference/apis/js-apis-convertxml.md @@ -1,5 +1,7 @@ # xml转换JavaScript +本模块提供转换xml文本为JavaScript对象的选项。 + > **说明：** > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-environment.md b/zh-cn/application-dev/reference/apis/js-apis-environment.md index 518975f8f7ec926a05b0680098d47738fd28d658..768e6c876aa8382bdbee09ce92dc88fe8ce831ec 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-environment.md +++ b/zh-cn/application-dev/reference/apis/js-apis-environment.md @@ -1,12 +1,12 @@ # 目录环境能力 +该模块提供环境目录能力，获取内存存储根目录、公共文件根目录的JS接口。 + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > > - 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > - 本模块接口为系统接口，三方应用不支持调用。 -该模块提供环境目录能力，获取内存存储根目录、公共文件根目录的JS接口。 - ## 导入模块 ```js diff --git a/zh-cn/application-dev/reference/apis/js-apis-fileio.md b/zh-cn/application-dev/reference/apis/js-apis-fileio.md index 6c7e54494b3a7f18a75e507db0e91c7f7a4ff8b7..35502aad72d8abbfc3a62731b62956420db5880b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-fileio.md +++ b/zh-cn/application-dev/reference/apis/js-apis-fileio.md @@ -1,9 +1,10 @@ -文件管理 +# 文件管理 + +该模块提供文件存储管理能力，包括文件基本管理、文件目录管理、文件信息统计、文件流式读写等常用功能。 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -该模块提供文件存储管理能力，包括文件基本管理、文件目录管理、文件信息统计、文件流式读写等常用功能。 ## 导入模块 @@ -41,9 +42,9 @@ stat(path: string): Promise<Stat> **返回值：** - | 类型 | 说明 | - | ---------------------------- | ---------- | - | Promise<[Stat](#stat)> | Promise对象。返回文件的具体信息。 | +| 类型 | 说明 | +| ---------------------------- | ---------- | +| Promise<[Stat](#stat)> | Promise对象。返回文件的具体信息。 | **示例：** ```js @@ -92,9 +93,9 @@ statSync(path:string): Stat **返回值：** - | 类型 | 说明 | - | ------------- | ---------- | - | [Stat](#stat) | 表示文件的具体信息。 | +| 类型 | 说明 | +| ------------- | ---------- | +| [Stat](#stat) | 表示文件的具体信息。 | **示例：** ```js @@ -117,9 +118,9 @@ opendir(path: string): Promise<Dir> | path | string | 是 | 待打开文件目录的应用沙箱路径。 | **返回值：** - | 类型 | 说明 | - | -------------------------- | -------- | - | Promise<[Dir](#dir)> | Promise对象。返回Dir对象。 | +| 类型 | 说明 | +| -------------------------- | -------- | +| Promise<[Dir](#dir)> | Promise对象。返回Dir对象。 | **示例：** ```js @@ -171,9 +172,9 @@ opendirSync(path: string): Dir | path | string | 是 | 待打开文件目录的应用沙箱路径。 | **返回值：** - | 类型 | 说明 | - | ----------- | -------- | - | [Dir](#dir) | 返回Dir对象。 | +| 类型 | 说明 | +| ----------- | -------- | +| [Dir](#dir) | 返回Dir对象。 | **示例：** ```js @@ -199,9 +200,9 @@ access(path: string, mode?: number): Promise<void> | mode | number | 否 | 访问文件时的选项，可给定如下选项，以按位或的方式使用多个选项，默认给定0。
确认当前进程是否具有对应权限：
- 0：确认文件是否存在。
- 1：确认当前进程是否具有可执行权限。
- 2：确认当前进程是否具有写权限。
- 4：确认当前进程是否具有读权限。 | **返回值：** - | 类型 | 说明 | - | ------------------- | ---------------------------- | - | Promise<void> | Promise对象。无返回值。 | +| 类型 | 说明 | +| ------------------- | ---------------------------- | +| Promise<void> | Promise对象。无返回值。 | **示例：** ```js @@ -269,14 +270,14 @@ close(fd: number):Promise<void> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ------------ | - | fd | number | 是 | 待关闭文件的文件描述符。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ------------ | +| fd | number | 是 | 待关闭文件的文件描述符。 | **返回值：** - | 类型 | 说明 | - | ------------------- | ---------------------------- | - | Promise<void> | Promise对象。无返回值。 | +| 类型 | 说明 | +| ------------------- | ---------------------------- | +| Promise<void> | Promise对象。无返回值。 | **示例：** ```js @@ -298,10 +299,10 @@ close(fd: number, callback:AsyncCallback<void>): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ------------ | - | fd | number | 是 | 待关闭文件的文件描述符。 | - | callback | AsyncCallback<void> | 是 | 异步关闭文件之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ------------ | +| fd | number | 是 | 待关闭文件的文件描述符。 | +| callback | AsyncCallback<void> | 是 | 异步关闭文件之后的回调。 | **示例：** ```js @@ -321,9 +322,9 @@ closeSync(fd: number): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ------------ | - | fd | number | 是 | 待关闭文件的文件描述符。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ------------ | +| fd | number | 是 | 待关闭文件的文件描述符。 | **示例：** ```js @@ -340,9 +341,9 @@ close(): Promise<void> **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** - | 类型 | 说明 | - | ------------------- | ---------------------------- | - | Promise<void> | Promise对象。无返回值。 | +| 类型 | 说明 | +| ------------------- | ---------------------------- | +| Promise<void> | Promise对象。无返回值。 | **示例：** ```js @@ -363,9 +364,9 @@ close(callback: AsyncCallback<void>): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ------------- | - | callback | AsyncCallback<void> | 是 | 异步关闭文件流之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ------------- | +| callback | AsyncCallback<void> | 是 | 异步关闭文件流之后的回调。 | **示例：** ```js @@ -384,16 +385,16 @@ copyFile(src:string | number, dest:string | number, mode?:number):Promise<voi **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | -------------------------- | ---- | ---------------------------------------- | - | src | string \| number | 是 | 待复制文件的路径或待复制文件的描述符。 | - | dest | string \| number | 是 | 目标文件路径或目标文件描述符。 | - | mode | number | 否 | mode提供覆盖文件的选项，当前仅支持0，且默认为0。
0：完全覆盖目标文件，未覆盖部分将被裁切掉。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | -------------------------- | ---- | ---------------------------------------- | +| src | string \| number | 是 | 待复制文件的路径或待复制文件的描述符。 | +| dest | string \| number | 是 | 目标文件路径或目标文件描述符。 | +| mode | number | 否 | mode提供覆盖文件的选项，当前仅支持0，且默认为0。
0：完全覆盖目标文件，未覆盖部分将被裁切掉。 | **返回值：** - | 类型 | 说明 | - | ------------------- | ---------------------------- | - | Promise<void> | Promise对象。无返回值。 | +| 类型 | 说明 | +| ------------------- | ---------------------------- | +| Promise<void> | Promise对象。无返回值。 | **示例：** ```js @@ -414,12 +415,12 @@ copyFile(src: string | number, dest: string | number, mode: number, callback: As **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------------------------- | ---- | ---------------------------------------- | - | src | string \| number | 是 | 待复制文件的路径或待复制文件的描述符。 | - | dest | string \| number | 是 | 目标文件路径或目标文件描述符。 | - | mode | number | 否 | mode提供覆盖文件的选项，当前仅支持0，且默认为0。
0：完全覆盖目标文件，未覆盖部分将被裁切掉。 | - | callback | AsyncCallback<void> | 是 | 异步复制文件之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------- | ---- | ---------------------------------------- | +| src | string \| number | 是 | 待复制文件的路径或待复制文件的描述符。 | +| dest | string \| number | 是 | 目标文件路径或目标文件描述符。 | +| mode | number | 否 | mode提供覆盖文件的选项，当前仅支持0，且默认为0。
0：完全覆盖目标文件，未覆盖部分将被裁切掉。 | +| callback | AsyncCallback<void> | 是 | 异步复制文件之后的回调。 | **示例：** ```js @@ -438,11 +439,11 @@ copyFileSync(src: string | number, dest: string | number, mode?: number): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | -------------------------- | ---- | ---------------------------------------- | - | src | string \| number | 是 | 待复制文件的路径或待复制文件的描述符。 | - | dest | string \| number | 是 | 目标文件路径或目标文件描述符。 | - | mode | number | 否 | mode提供覆盖文件的选项，当前仅支持0，且默认为0。
0：完全覆盖目标文件，未覆盖部分将被裁切掉。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | -------------------------- | ---- | ---------------------------------------- | +| src | string \| number | 是 | 待复制文件的路径或待复制文件的描述符。 | +| dest | string \| number | 是 | 目标文件路径或目标文件描述符。 | +| mode | number | 否 | mode提供覆盖文件的选项，当前仅支持0，且默认为0。
0：完全覆盖目标文件，未覆盖部分将被裁切掉。 | **示例：** ```js @@ -465,9 +466,9 @@ mkdir(path:string, mode?: number): Promise<void> | mode | number | 否 | 创建目录的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o775。
- 0o775：所有者具有读、写及可执行权限，其余用户具有读及可执行权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | **返回值：** - | 类型 | 说明 | - | ------------------- | ---------------------------- | - | Promise<void> | Promise对象。无返回值。 | +| 类型 | 说明 | +| ------------------- | ---------------------------- | +| Promise<void> | Promise对象。无返回值。 | **示例：** ```js @@ -538,9 +539,9 @@ open(path: string, flags?: number, mode?: number): Promise<number> | mode | number | 否 | 若创建文件，则指定文件的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o666。
- 0o666：所有者具有读、写权限，所有用户组具有读、写权限，其余用户具有读、写权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | **返回值：** - | 类型 | 说明 | - | --------------------- | ----------- | - | Promise<number> | Promise对象。返回打开文件的文件描述符。 | +| 类型 | 说明 | +| --------------------- | ----------- | +| Promise<number> | Promise对象。返回打开文件的文件描述符。 | **示例：** ```js @@ -592,9 +593,9 @@ openSync(path:string, flags?:number, mode?:number): number | mode | number | 否 | 若创建文件，则指定文件的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o666。
- 0o666：所有者具有读、写权限，所有用户组具有读、写权限，其余用户具有读、写权限。
- 0o640：所有者具有读、写权限，所有用户组具有读权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。
创建出的文件权限受umask影响，umask随进程启动确定，其修改当前不开放。 | **返回值：** - | 类型 | 说明 | - | ------ | ----------- | - | number | 打开文件的文件描述符。 | +| 类型 | 说明 | +| ------ | ----------- | +| number | 打开文件的文件描述符。 | **示例：** ```js @@ -631,9 +632,9 @@ read(fd: number, buffer: ArrayBuffer, options?: { **返回值：** - | 类型 | 说明 | - | ---------------------------------- | ------ | - | Promise<[ReadOut](#readout)> | Promise对象。返回读取的结果。 | +| 类型 | 说明 | +| ---------------------------------- | ------ | +| Promise<[ReadOut](#readout)> | Promise对象。返回读取的结果。 | **示例：** ```js @@ -661,12 +662,12 @@ read(fd: number, buffer: ArrayBuffer, options: { **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ---------------------------------------- | ---- | ---------------------------------------- | - | fd | number | 是 | 待读取文件的文件描述符。 | - | buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 | - | options | Object | 否 | 支持如下选项：
- offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
- length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
- position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。
约束：offset+length<=buffer.size。 | - | callback | AsyncCallback<[ReadOut](#readout)> | 是 | 异步读取数据之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ---------------------------------------- | +| fd | number | 是 | 待读取文件的文件描述符。 | +| buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 | +| options | Object | 否 | 支持如下选项：
- offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
- length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
- position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。
约束：offset+length<=buffer.size。 | +| callback | AsyncCallback<[ReadOut](#readout)> | 是 | 异步读取数据之后的回调。 | **示例：** ```js @@ -694,16 +695,16 @@ readSync(fd: number, buffer: ArrayBuffer, options?: { **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------- | ----------- | ---- | ---------------------------------------- | - | fd | number | 是 | 待读取文件的文件描述符。 | - | buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 | - | options | Object | 否 | 支持如下选项：
- offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
- length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
- position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。
约束：offset+length<=buffer.size。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ----------- | ---- | ---------------------------------------- | +| fd | number | 是 | 待读取文件的文件描述符。 | +| buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 | +| options | Object | 否 | 支持如下选项：
- offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
- length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
- position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。
约束：offset+length<=buffer.size。 | **返回值：** - | 类型 | 说明 | - | ------ | -------- | - | number | 实际读取的长度。 | +| 类型 | 说明 | +| ------ | -------- | +| number | 实际读取的长度。 | **示例：** ```js @@ -727,9 +728,9 @@ rmdir(path: string): Promise<void> | path | string | 是 | 待删除目录的应用沙箱路径。 | **返回值：** - | 类型 | 说明 | - | ------------------- | ---------------------------- | - | Promise<void> | Promise对象。无返回值。 | +| 类型 | 说明 | +| ------------------- | ---------------------------- | +| Promise<void> | Promise对象。无返回值。 | **示例：** ```js @@ -797,9 +798,9 @@ unlink(path:string): Promise<void> | path | string | 是 | 待删除文件的应用沙箱路径。 | **返回值：** - | 类型 | 说明 | - | ------------------- | ---------------------------- | - | Promise<void> | Promise对象。无返回值。 | +| 类型 | 说明 | +| ------------------- | ---------------------------- | +| Promise<void> | Promise对象。无返回值。 | **示例：** ```js @@ -866,16 +867,16 @@ write(fd: number, buffer: ArrayBuffer | string, options?: { **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------- | ------------------------------- | ---- | ---------------------------------------- | - | fd | number | 是 | 待写入文件的文件描述符。 | - | buffer | ArrayBuffer \| string | 是 | 待写入文件的数据，可来自缓冲区或字符串。 | - | options | Object | 否 | 支持如下选项：
- offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。
- length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。
- position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。
- encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认 'utf-8'。仅支持 'utf-8'。
约束：offset+length<=buffer.size。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------------------------------- | ---- | ---------------------------------------- | +| fd | number | 是 | 待写入文件的文件描述符。 | +| buffer | ArrayBuffer \| string | 是 | 待写入文件的数据，可来自缓冲区或字符串。 | +| options | Object | 否 | 支持如下选项：
- offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。
- length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。
- position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。
- encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认 'utf-8'。仅支持 'utf-8'。
约束：offset+length<=buffer.size。 | **返回值：** - | 类型 | 说明 | - | --------------------- | -------- | - | Promise<number> | Promise对象。返回实际写入的长度。 | +| 类型 | 说明 | +| --------------------- | -------- | +| Promise<number> | Promise对象。返回实际写入的长度。 | **示例：** ```js @@ -902,12 +903,12 @@ write(fd: number, buffer: ArrayBuffer | string, options: { **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------------- | ---- | ---------------------------------------- | - | fd | number | 是 | 待写入文件的文件描述符。 | - | buffer | ArrayBuffer \| string | 是 | 待写入文件的数据，可来自缓冲区或字符串。 | - | options | Object | 否 | 支持如下选项：
- offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。
- length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。
- position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。
- encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认 'utf-8'。仅支持 'utf-8'。
约束：offset+length<=buffer.size。 | - | callback | AsyncCallback<number> | 是 | 异步将数据写入完成后执行的回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------- | ---- | ---------------------------------------- | +| fd | number | 是 | 待写入文件的文件描述符。 | +| buffer | ArrayBuffer \| string | 是 | 待写入文件的数据，可来自缓冲区或字符串。 | +| options | Object | 否 | 支持如下选项：
- offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。
- length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。
- position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。
- encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认 'utf-8'。仅支持 'utf-8'。
约束：offset+length<=buffer.size。 | +| callback | AsyncCallback<number> | 是 | 异步将数据写入完成后执行的回调函数。 | **示例：** ```js @@ -934,16 +935,16 @@ writeSync(fd: number, buffer: ArrayBuffer | string, options?: { **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------- | ------------------------------- | ---- | ---------------------------------------- | - | fd | number | 是 | 待写入文件的文件描述符。 | - | buffer | ArrayBuffer \| string | 是 | 待写入文件的数据，可来自缓冲区或字符串。 | - | options | Object | 否 | 支持如下选项：
- offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。
- length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。
- position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。
- encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认 'utf-8'。仅支持 'utf-8'。
约束：offset+length<=buffer.size。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------------------------------- | ---- | ---------------------------------------- | +| fd | number | 是 | 待写入文件的文件描述符。 | +| buffer | ArrayBuffer \| string | 是 | 待写入文件的数据，可来自缓冲区或字符串。 | +| options | Object | 否 | 支持如下选项：
- offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。
- length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。
- position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。
- encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认 'utf-8'。仅支持 'utf-8'。
约束：offset+length<=buffer.size。 | **返回值：** - | 类型 | 说明 | - | ------ | -------- | - | number | 实际写入的长度。 | +| 类型 | 说明 | +| ------ | -------- | +| number | 实际写入的长度。 | **示例：** ```js @@ -967,9 +968,9 @@ hash(path: string, algorithm: string): Promise<string> | algorithm | string | 是 | 哈希计算采用的算法。可选 "md5"、"sha1" 或 "sha256"。建议采用安全强度更高的 "sha256"。 | **返回值：** - | 类型 | 说明 | - | --------------------- | -------------------------- | - | Promise<string> | Promise对象。返回文件的哈希值。表示为十六进制数字串，所有字母均大写。 | +| 类型 | 说明 | +| --------------------- | -------------------------- | +| Promise<string> | Promise对象。返回文件的哈希值。表示为十六进制数字串，所有字母均大写。 | **示例：** ```js @@ -1021,9 +1022,9 @@ chmod(path: string, mode: number):Promise<void> | mode | number | 是 | 改变文件权限，可给定如下权限，以按位或的方式追加权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | **返回值：** - | 类型 | 说明 | - | ------------------- | ---------------------------- | - | Promise<void> | Promise对象。无返回值。 | +| 类型 | 说明 | +| ------------------- | ---------------------------- | +| Promise<void> | Promise对象。无返回值。 | **示例：** ```js @@ -1087,14 +1088,14 @@ fstat(fd: number): Promise<Stat> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ------------ | - | fd | number | 是 | 待获取文件状态的文件描述符。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ------------ | +| fd | number | 是 | 待获取文件状态的文件描述符。 | **返回值：** - | 类型 | 说明 | - | ---------------------------- | ---------- | - | Promise<[Stat](#stat)> | Promise对象。返回表示文件状态的具体信息。 | +| 类型 | 说明 | +| ---------------------------- | ---------- | +| Promise<[Stat](#stat)> | Promise对象。返回表示文件状态的具体信息。 | **示例：** ```js @@ -1115,10 +1116,10 @@ fstat(fd: number, callback: AsyncCallback<Stat>): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ---------------------------------- | ---- | ---------------- | - | fd | number | 是 | 待获取文件状态的文件描述符。 | - | callback | AsyncCallback<[Stat](#stat)> | 是 | 异步获取文件状态信息之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------- | ---- | ---------------- | +| fd | number | 是 | 待获取文件状态的文件描述符。 | +| callback | AsyncCallback<[Stat](#stat)> | 是 | 异步获取文件状态信息之后的回调。 | **示例：** ```js @@ -1138,14 +1139,14 @@ fstatSync(fd: number): Stat **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ------------ | - | fd | number | 是 | 待获取文件状态的文件描述符。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ------------ | +| fd | number | 是 | 待获取文件状态的文件描述符。 | **返回值：** - | 类型 | 说明 | - | ------------- | ---------- | - | [Stat](#stat) | 表示文件状态的具体信息。 | +| 类型 | 说明 | +| ------------- | ---------- | +| [Stat](#stat) | 表示文件状态的具体信息。 | **示例：** ```js @@ -1163,15 +1164,15 @@ ftruncate(fd: number, len?: number): Promise<void> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ---------------- | - | fd | number | 是 | 待截断文件的文件描述符。 | - | len | number | 否 | 文件截断后的长度，以字节为单位。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ---------------- | +| fd | number | 是 | 待截断文件的文件描述符。 | +| len | number | 否 | 文件截断后的长度，以字节为单位。 | **返回值：** - | 类型 | 说明 | - | ------------------- | ---------------------------- | - | Promise<void> | Promise对象。无返回值。| +| 类型 | 说明 | +| ------------------- | ---------------------------- | +| Promise<void> | Promise对象。无返回值。| **示例：** ```js @@ -1193,11 +1194,11 @@ ftruncate(fd: number, len: number, callback:AsyncCallback<void>): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ---------------- | - | fd | number | 是 | 待截断文件的文件描述符。 | - | len | number | 是 | 文件截断后的长度，以字节为单位。 | - | callback | AsyncCallback<void> | 是 | 回调函数，本调用无返回值。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ---------------- | +| fd | number | 是 | 待截断文件的文件描述符。 | +| len | number | 是 | 文件截断后的长度，以字节为单位。 | +| callback | AsyncCallback<void> | 是 | 回调函数，本调用无返回值。 | **示例：** ```js @@ -1216,10 +1217,10 @@ ftruncateSync(fd: number, len?: number): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ---------------- | - | fd | number | 是 | 待截断文件的文件描述符。 | - | len | number | 否 | 文件截断后的长度，以字节为单位。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ---------------- | +| fd | number | 是 | 待截断文件的文件描述符。 | +| len | number | 否 | 文件截断后的长度，以字节为单位。 | **示例：** ```js @@ -1242,9 +1243,9 @@ truncate(path: string, len?: number): Promise<void> | len | number | 否 | 文件截断后的长度，以字节为单位。 | **返回值：** - | 类型 | 说明 | - | ------------------- | ---------------------------- | - | Promise<void> | Promise对象。无返回值。 | +| 类型 | 说明 | +| ------------------- | ---------------------------- | +| Promise<void> | Promise对象。无返回值。 | **示例：** ```js @@ -1318,9 +1319,9 @@ readText(filePath: string, options?: { | options | Object | 否 | 支持如下选项：
- position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读取。
- length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
- encoding，string类型，当数据是 string 类型时有效，表示数据的编码方式，默认 'utf-8'，仅支持 'utf-8'。 | **返回值：** - | 类型 | 说明 | - | --------------------- | ---------- | - | Promise<string> | Promise对象。返回读取文件的内容。 | +| 类型 | 说明 | +| --------------------- | ---------- | +| Promise<string> | Promise对象。返回读取文件的内容。 | **示例：** ```js @@ -1378,9 +1379,9 @@ readTextSync(filePath: string, options?: { | options | Object | 否 | 支持如下选项：
- position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读取。
- length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
- encoding，string类型，当数据是 string 类型时有效，表示数据的编码方式，默认 'utf-8'，仅支持 'utf-8'。 | **返回值：** - | 类型 | 说明 | - | ------ | -------------------- | - | string | 返回读取文件的内容。 | +| 类型 | 说明 | +| ------ | -------------------- | +| string | 返回读取文件的内容。 | **示例：** ```js @@ -1402,9 +1403,9 @@ lstat(path: string): Promise<Stat> | path | string | 是 | 目标文件的应用沙箱路径。 | **返回值：** - | 类型 | 说明 | - | ---------------------------- | ---------- | - | Promise<[Stat](#stat)> | promise对象，返回文件对象，表示文件的具体信息，详情见stat。 | +| 类型 | 说明 | +| ---------------------------- | ---------- | +| Promise<[Stat](#stat)> | promise对象，返回文件对象，表示文件的具体信息，详情见stat。 | **示例：** ```js @@ -1452,9 +1453,9 @@ lstatSync(path:string): Stat | path | string | 是 | 目标文件的应用沙箱路径。 | **返回值：** - | 类型 | 说明 | - | ------------- | ---------- | - | [Stat](#stat) | 表示文件的具体信息。 | +| 类型 | 说明 | +| ------------- | ---------- | +| [Stat](#stat) | 表示文件的具体信息。 | **示例：** ```js @@ -1475,15 +1476,15 @@ read(buffer: ArrayBuffer, options?: { **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------- | ----------- | ---- | ------------------------------------------------------------ | - | buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 | - | options | Object | 否 | 支持如下选项：
- offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
- length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
约束：offset+length<=buffer.size。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ----------- | ---- | ------------------------------------------------------------ | +| buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 | +| options | Object | 否 | 支持如下选项：
- offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
- length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
约束：offset+length<=buffer.size。 | **返回值：** - | 类型 | 说明 | - | ---------------------------------- | ------ | - | Promise<[ReadOut](#readout)> | Promise对象。返回读取的结果。 | +| 类型 | 说明 | +| ---------------------------------- | ------ | +| Promise<[ReadOut](#readout)> | Promise对象。返回读取的结果。 | **示例：** ```js @@ -1509,11 +1510,11 @@ read(buffer: ArrayBuffer, options: { **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ---------------------------------------- | ---- | ---------------------------------------- | - | buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 | - | options | Object | 否 | 支持如下选项：
- offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
- length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
约束：offset+length<=buffer.size。 | - | callback | AsyncCallback<[ReadOut](#readout)> | 是 | 异步从文件读取数据之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ---------------------------------------- | +| buffer | ArrayBuffer | 是 | 用于保存读取到的文件数据的缓冲区。 | +| options | Object | 否 | 支持如下选项：
- offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
- length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
约束：offset+length<=buffer.size。 | +| callback | AsyncCallback<[ReadOut](#readout)> | 是 | 异步从文件读取数据之后的回调。 | **示例：** ```js @@ -1542,9 +1543,9 @@ rename(oldPath: string, newPath: string): Promise<void> | newPath | String | 是 | 目标文件的新应用沙箱路径。 | **返回值：** - | 类型 | 说明 | - | ------------------- | ---------------------------- | - | Promise<void> | Promise对象。无返回值。 | +| 类型 | 说明 | +| ------------------- | ---------------------------- | +| Promise<void> | Promise对象。无返回值。 | **示例：** ```js @@ -1607,14 +1608,14 @@ fsync(fd: number): Promise<void> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ------------ | - | fd | number | 是 | 待同步文件的文件描述符。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ------------ | +| fd | number | 是 | 待同步文件的文件描述符。 | **返回值：** - | 类型 | 说明 | - | ------------------- | ---------------------------- | - | Promise<void> | Promise对象。无返回值。 | +| 类型 | 说明 | +| ------------------- | ---------------------------- | +| Promise<void> | Promise对象。无返回值。 | **示例：** ```js @@ -1635,10 +1636,10 @@ fsync(fd: number, callback: AsyncCallback<void>): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | --------------- | - | fd | number | 是 | 待同步文件的文件描述符。 | - | Callback | AsyncCallback<void> | 是 | 异步将文件数据同步之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | --------------- | +| fd | number | 是 | 待同步文件的文件描述符。 | +| Callback | AsyncCallback<void> | 是 | 异步将文件数据同步之后的回调。 | **示例：** ```js @@ -1657,9 +1658,9 @@ fsyncSync(fd: number): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ------------ | - | fd | number | 是 | 待同步文件的文件描述符。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ------------ | +| fd | number | 是 | 待同步文件的文件描述符。 | **示例：** ```js @@ -1676,14 +1677,14 @@ fdatasync(fd: number): Promise<void> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ------------ | - | fd | number | 是 | 待同步文件的文件描述符。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ------------ | +| fd | number | 是 | 待同步文件的文件描述符。 | **返回值：** - | 类型 | 说明 | - | ------------------- | ---------------------------- | - | Promise<void> | Promise对象。无返回值。 | +| 类型 | 说明 | +| ------------------- | ---------------------------- | +| Promise<void> | Promise对象。无返回值。 | **示例：** ```js @@ -1704,10 +1705,10 @@ fdatasync(fd: number, callback:AsyncCallback<void>): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------------- | ---- | ----------------- | - | fd | number | 是 | 待同步文件的文件描述符。 | - | callback | AsyncCallback <void> | 是 | 异步将文件内容数据同步之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------- | ---- | ----------------- | +| fd | number | 是 | 待同步文件的文件描述符。 | +| callback | AsyncCallback <void> | 是 | 异步将文件内容数据同步之后的回调。 | **示例：** ```js @@ -1726,9 +1727,9 @@ fdatasyncSync(fd: number): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ------------ | - | fd | number | 是 | 待同步文件的文件描述符。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ------------ | +| fd | number | 是 | 待同步文件的文件描述符。 | **示例：** ```js @@ -1751,9 +1752,9 @@ symlink(target: string, srcPath: string): Promise<void> | srcPath | string | 是 | 符号链接文件的应用沙箱路径。 | **返回值：** - | 类型 | 说明 | - | ------------------- | ---------------------------- | - | Promise<void> | Promise对象。无返回值。 | +| 类型 | 说明 | +| ------------------- | ---------------------------- | +| Promise<void> | Promise对象。无返回值。 | **示例：** ```js @@ -1824,9 +1825,9 @@ chown(path: string, uid: number, gid: number): Promise<void> | gid | number | 是 | 新的GID（GroupID）。 | **返回值：** - | 类型 | 说明 | - | ------------------- | ---------------------------- | - | Promise<void> | Promise对象。无返回值。 | +| 类型 | 说明 | +| ------------------- | ---------------------------- | +| Promise<void> | Promise对象。无返回值。 | **示例：** ```js @@ -1895,14 +1896,14 @@ mkdtemp(prefix: string): Promise<string> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------ | ---- | --------------------------- | - | prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | --------------------------- | +| prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 | **返回值：** - | 类型 | 说明 | - | --------------------- | ---------- | - | Promise<string> | Promise对象。返回生成的唯一目录路径。 | +| 类型 | 说明 | +| --------------------- | ---------- | +| Promise<string> | Promise对象。返回生成的唯一目录路径。 | **示例：** ```js @@ -1923,10 +1924,10 @@ mkdtemp(prefix: string, callback: AsyncCallback<string>): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | --------------------------- | ---- | --------------------------- | - | prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 | - | callback | AsyncCallback<string> | 是 | 异步创建临时目录之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------- | ---- | --------------------------- | +| prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 | +| callback | AsyncCallback<string> | 是 | 异步创建临时目录之后的回调。 | **示例：** ```js @@ -1945,14 +1946,14 @@ mkdtempSync(prefix: string): string **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------ | ---- | --------------------------- | - | prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | --------------------------- | +| prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 | **返回值：** - | 类型 | 说明 | - | ------ | ---------- | - | string | 产生的唯一目录路径。 | +| 类型 | 说明 | +| ------ | ---------- | +| string | 产生的唯一目录路径。 | **示例：** ```js @@ -1969,15 +1970,15 @@ fchmod(fd: number, mode: number): Promise<void> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ---------------------------------------- | - | fd | number | 是 | 待改变文件的文件描述符。 | - | mode | number | 是 | 若创建文件，则指定文件的权限，可给定如下权限，以按位或的方式追加权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ---------------------------------------- | +| fd | number | 是 | 待改变文件的文件描述符。 | +| mode | number | 是 | 若创建文件，则指定文件的权限，可给定如下权限，以按位或的方式追加权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | **返回值：** - | 类型 | 说明 | - | ------------------- | ---------------------------- | - | Promise<void> | Promise对象。无返回值。 | +| 类型 | 说明 | +| ------------------- | ---------------------------- | +| Promise<void> | Promise对象。无返回值。 | **示例：** ```js @@ -1998,11 +1999,11 @@ fchmod(fd: number, mode: number, callback: AsyncCallback<void>): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------------- | ---- | ---------------------------------------- | - | fd | number | 是 | 待改变文件的文件描述符。 | - | mode | number | 是 | 若创建文件，则指定文件的权限，可给定如下权限，以按位或的方式追加权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | - | callback | AsyncCallback <void> | 是 | 异步改变文件权限之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------- | ---- | ---------------------------------------- | +| fd | number | 是 | 待改变文件的文件描述符。 | +| mode | number | 是 | 若创建文件，则指定文件的权限，可给定如下权限，以按位或的方式追加权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | +| callback | AsyncCallback <void> | 是 | 异步改变文件权限之后的回调。 | **示例：** ```js @@ -2021,10 +2022,10 @@ fchmodSync(fd: number, mode: number): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ---------------------------------------- | - | fd | number | 是 | 待改变文件的文件描述符。 | - | mode | number | 是 | 若创建文件，则指定文件的权限，可给定如下权限，以按位或的方式追加权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ---------------------------------------- | +| fd | number | 是 | 待改变文件的文件描述符。 | +| mode | number | 是 | 若创建文件，则指定文件的权限，可给定如下权限，以按位或的方式追加权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | **示例：** ```js @@ -2047,9 +2048,9 @@ createStream(path: string, mode: string): Promise<Stream> | mode | string | 是 | - r：打开只读文件，该文件必须存在。
- r+：打开可读写的文件，该文件必须存在。
- w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
- a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 | **返回值：** - | 类型 | 说明 | - | --------------------------------- | --------- | - | Promise<[Stream](#stream7)> | Promise对象。返回文件流的结果。 | +| 类型 | 说明 | +| --------------------------------- | --------- | +| Promise<[Stream](#stream7)> | Promise对象。返回文件流的结果。 | **示例：** ```js @@ -2099,9 +2100,9 @@ createStreamSync(path: string, mode: string): Stream | mode | string | 是 | - r：打开只读文件，该文件必须存在。
- r+：打开可读写的文件，该文件必须存在。
- w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
- a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 | **返回值：** - | 类型 | 说明 | - | ------------------ | --------- | - | [Stream](#stream7) | 返回文件流的结果。 | +| 类型 | 说明 | +| ------------------ | --------- | +| [Stream](#stream7) | 返回文件流的结果。 | **示例：** ```js @@ -2118,15 +2119,15 @@ fdopenStream(fd: number, mode: string): Promise<Stream> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ---------------------------------------- | - | fd | number | 是 | 待打开文件的文件描述符。 | - | mode | string | 是 | - r：打开只读文件，该文件必须存在。
- r+：打开可读写的文件，该文件必须存在。
- w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
- a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ---------------------------------------- | +| fd | number | 是 | 待打开文件的文件描述符。 | +| mode | string | 是 | - r：打开只读文件，该文件必须存在。
- r+：打开可读写的文件，该文件必须存在。
- w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
- a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 | **返回值：** - | 类型 | 说明 | - | --------------------------------- | --------- | - | Promise<[Stream](#stream7)> | Promise对象。返回文件流的结果。 | +| 类型 | 说明 | +| --------------------------------- | --------- | +| Promise<[Stream](#stream7)> | Promise对象。返回文件流的结果。 | **示例：** ```js @@ -2148,11 +2149,11 @@ fdopenStream(fd: number, mode: string, callback: AsyncCallback<Stream>): v **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ---------------------------------------- | ---- | ---------------------------------------- | - | fd | number | 是 | 待打开文件的文件描述符。 | - | mode | string | 是 | - r：打开只读文件，该文件必须存在。
- r+：打开可读写的文件，该文件必须存在。
- w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
- a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 | - | callback | AsyncCallback <[Stream](#stream7)> | 是 | 异步打开文件流之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ---------------------------------------- | +| fd | number | 是 | 待打开文件的文件描述符。 | +| mode | string | 是 | - r：打开只读文件，该文件必须存在。
- r+：打开可读写的文件，该文件必须存在。
- w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
- a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 | +| callback | AsyncCallback <[Stream](#stream7)> | 是 | 异步打开文件流之后的回调。 | **示例：** ```js @@ -2172,15 +2173,15 @@ fdopenStreamSync(fd: number, mode: string): Stream **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ---------------------------------------- | - | fd | number | 是 | 待打开文件的文件描述符。 | - | mode | string | 是 | - r：打开只读文件，该文件必须存在。
- r+：打开可读写的文件，该文件必须存在。
- w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
- a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ---------------------------------------- | +| fd | number | 是 | 待打开文件的文件描述符。 | +| mode | string | 是 | - r：打开只读文件，该文件必须存在。
- r+：打开可读写的文件，该文件必须存在。
- w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
- a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 | **返回值：** - | 类型 | 说明 | - | ------------------ | --------- | - | [Stream](#stream7) | 返回文件流的结果。 | +| 类型 | 说明 | +| ------------------ | --------- | +| [Stream](#stream7) | 返回文件流的结果。 | **示例：** ```js @@ -2198,16 +2199,16 @@ fchown(fd: number, uid: number, gid: number): Promise<void> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ------------ | - | fd | number | 是 | 待改变文件的文件描述符。 | - | uid | number | 是 | 文件所有者的UID。 | - | gid | number | 是 | 文件所有组的GID。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ------------ | +| fd | number | 是 | 待改变文件的文件描述符。 | +| uid | number | 是 | 文件所有者的UID。 | +| gid | number | 是 | 文件所有组的GID。 | **返回值：** - | 类型 | 说明 | - | ------------------- | ---------------------------- | - | Promise<void> | Promise对象。无返回值。 | +| 类型 | 说明 | +| ------------------- | ---------------------------- | +| Promise<void> | Promise对象。无返回值。 | **示例：** ```js @@ -2229,12 +2230,12 @@ fchown(fd: number, uid: number, gid: number, callback: AsyncCallback<void> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | --------------- | - | fd | number | 是 | 待改变文件的文件描述符。 | - | uid | number | 是 | 文件所有者的UID。 | - | gid | number | 是 | 文件所有组的GID。 | - | callback | AsyncCallback<void> | 是 | 异步改变文件所有者之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | --------------- | +| fd | number | 是 | 待改变文件的文件描述符。 | +| uid | number | 是 | 文件所有者的UID。 | +| gid | number | 是 | 文件所有组的GID。 | +| callback | AsyncCallback<void> | 是 | 异步改变文件所有者之后的回调。 | **示例：** ```js @@ -2254,11 +2255,11 @@ fchownSync(fd: number, uid: number, gid: number): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ------------ | - | fd | number | 是 | 待改变文件的文件描述符。 | - | uid | number | 是 | 文件所有者的UID。 | - | gid | number | 是 | 文件所有组的GID。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ------------ | +| fd | number | 是 | 待改变文件的文件描述符。 | +| uid | number | 是 | 文件所有者的UID。 | +| gid | number | 是 | 文件所有组的GID。 | **示例：** ```js @@ -2283,9 +2284,9 @@ lchown(path: string, uid: number, gid: number): Promise<void> | gid | number | 是 | 新的GID。 | **返回值：** - | 类型 | 说明 | - | ------------------- | ---------------------------- | - | Promise<void> | Promise对象。无返回值。 | +| 类型 | 说明 | +| ------------------- | ---------------------------- | +| Promise<void> | Promise对象。无返回值。 | **示例：** ```js @@ -2361,9 +2362,9 @@ createWatcher(filename: string, events: number, callback: AsyncCallback<numbe | callback | AsyncCallback<number > | 是 | 每发生变化一次，调用一次此函数。 | **返回值：** - | 类型 | 说明 | - | -------------------- | ---------- | - | [Watcher](#watcher7) | Promise对象。返回文件变化监听的实例。 | +| 类型 | 说明 | +| -------------------- | ---------- | +| [Watcher](#watcher7) | Promise对象。返回文件变化监听的实例。 | **示例：** ```js @@ -2421,9 +2422,9 @@ isBlockDevice(): boolean **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** - | 类型 | 说明 | - | ------- | ---------------- | - | boolean | 表示文件是否是块特殊设备。 | +| 类型 | 说明 | +| ------- | ---------------- | +| boolean | 表示文件是否是块特殊设备。 | **示例：** ```js @@ -2440,9 +2441,9 @@ isCharacterDevice(): boolean **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** - | 类型 | 说明 | - | ------- | ----------------- | - | boolean | 表示文件是否是字符特殊设备。 | +| 类型 | 说明 | +| ------- | ----------------- | +| boolean | 表示文件是否是字符特殊设备。 | **示例：** ```js @@ -2459,9 +2460,9 @@ isDirectory(): boolean **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** - | 类型 | 说明 | - | ------- | ------------- | - | boolean | 表示文件是否是目录。 | +| 类型 | 说明 | +| ------- | ------------- | +| boolean | 表示文件是否是目录。 | **示例：** ```js @@ -2478,9 +2479,9 @@ isFIFO(): boolean **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** - | 类型 | 说明 | - | ------- | --------------------- | - | boolean | 表示文件是否是 FIFO。 | +| 类型 | 说明 | +| ------- | --------------------- | +| boolean | 表示文件是否是 FIFO。 | **示例：** ```js @@ -2497,9 +2498,9 @@ isFile(): boolean **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** - | 类型 | 说明 | - | ------- | --------------- | - | boolean | 表示文件是否是普通文件。 | +| 类型 | 说明 | +| ------- | --------------- | +| boolean | 表示文件是否是普通文件。 | **示例：** ```js @@ -2516,9 +2517,9 @@ isSocket(): boolean **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** - | 类型 | 说明 | - | ------- | -------------- | - | boolean | 表示文件是否是套接字。 | +| 类型 | 说明 | +| ------- | -------------- | +| boolean | 表示文件是否是套接字。 | **示例：** ```js @@ -2535,9 +2536,9 @@ isSymbolicLink(): boolean **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** - | 类型 | 说明 | - | ------- | --------------- | - | boolean | 表示文件是否是符号链接。 | +| 类型 | 说明 | +| ------- | --------------- | +| boolean | 表示文件是否是符号链接。 | **示例：** ```js @@ -2579,9 +2580,9 @@ stop(callback: AsyncCallback<void>): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ---------------------- | - | callback | AsyncCallback<void> | 是 | 以异步方法关闭watcher监听之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ---------------------- | +| callback | AsyncCallback<void> | 是 | 以异步方法关闭watcher监听之后的回调。 | **示例：** ```js @@ -2609,9 +2610,9 @@ close(): Promise<void> **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** - | 类型 | 说明 | - | ------------------- | ------------- | - | Promise<void> | Promise对象。返回表示异步关闭文件流的结果。 | +| 类型 | 说明 | +| ------------------- | ------------- | +| Promise<void> | Promise对象。返回表示异步关闭文件流的结果。 | **示例：** ```js @@ -2633,9 +2634,9 @@ close(callback: AsyncCallback<void>): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ------------- | - | callback | AsyncCallback<void> | 是 | 异步关闭文件流之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ------------- | +| callback | AsyncCallback<void> | 是 | 异步关闭文件流之后的回调。 | **示例：** ```js @@ -2670,9 +2671,9 @@ flush(): Promise<void> **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** - | 类型 | 说明 | - | ------------------- | ------------- | - | Promise<void> | Promise对象。返回表示异步刷新文件流的结果。 | +| 类型 | 说明 | +| ------------------- | ------------- | +| Promise<void> | Promise对象。返回表示异步刷新文件流的结果。 | **示例：** ```js @@ -2694,9 +2695,9 @@ flush(callback: AsyncCallback<void>): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | -------------- | - | callback | AsyncCallback<void> | 是 | 异步刷新文件流后的回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | -------------- | +| callback | AsyncCallback<void> | 是 | 异步刷新文件流后的回调函数。 | **示例：** ```js @@ -2736,15 +2737,15 @@ write(buffer: ArrayBuffer | string, options?: { **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------- | ------------------------------- | ---- | ---------------------------------------- | - | buffer | ArrayBuffer \| string | 是 | 待写入文件的数据，可来自缓冲区或字符串。 | - | options | Object | 否 | 支持如下选项：
- offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。
- length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。
- position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。
- encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认 'utf-8'。仅支持 'utf-8'。
约束：offset+length<=buffer.size。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------------------------------- | ---- | ---------------------------------------- | +| buffer | ArrayBuffer \| string | 是 | 待写入文件的数据，可来自缓冲区或字符串。 | +| options | Object | 否 | 支持如下选项：
- offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。
- length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。
- position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。
- encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认 'utf-8'。仅支持 'utf-8'。
约束：offset+length<=buffer.size。 | **返回值：** - | 类型 | 说明 | - | --------------------- | -------- | - | Promise<number> | Promise对象。返回实际写入的长度。 | +| 类型 | 说明 | +| --------------------- | -------- | +| Promise<number> | Promise对象。返回实际写入的长度。 | **示例：** ```js @@ -2771,11 +2772,11 @@ write(buffer: ArrayBuffer | string, options: { **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------------- | ---- | ------------------------------------------------------------ | - | buffer | ArrayBuffer \| string | 是 | 待写入文件的数据，可来自缓冲区或字符串。 | - | options | Object | 否 | 支持如下选项：
- offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。
- length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。
- position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。
- encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认 'utf-8'。仅支持 'utf-8'。
约束：offset+length<=buffer.size。 | - | callback | AsyncCallback<number> | 是 | 异步写入完成后执行的回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------- | ---- | ------------------------------------------------------------ | +| buffer | ArrayBuffer \| string | 是 | 待写入文件的数据，可来自缓冲区或字符串。 | +| options | Object | 否 | 支持如下选项：
- offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。
- length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。
- position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。
- encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认 'utf-8'。仅支持 'utf-8'。
约束：offset+length<=buffer.size。 | +| callback | AsyncCallback<number> | 是 | 异步写入完成后执行的回调函数。 | **示例：** ```js @@ -2803,15 +2804,15 @@ writeSync(buffer: ArrayBuffer | string, options?: { **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------- | ------------------------------- | ---- | ---------------------------------------- | - | buffer | ArrayBuffer \| string | 是 | 待写入文件的数据，可来自缓冲区或字符串。 | - | options | Object | 否 | 支持如下选项：
- offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。
- length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。
- position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。
- encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认 'utf-8'。仅支持 'utf-8'。
约束：offset+length<=buffer.size。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------------------------------- | ---- | ---------------------------------------- | +| buffer | ArrayBuffer \| string | 是 | 待写入文件的数据，可来自缓冲区或字符串。 | +| options | Object | 否 | 支持如下选项：
- offset，number类型，表示期望写入数据的位置相对于数据首地址的偏移。可选，默认为0。
- length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度减去偏移长度。
- position，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。
- encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认 'utf-8'。仅支持 'utf-8'。
约束：offset+length<=buffer.size。 | **返回值：** - | 类型 | 说明 | - | ------ | -------- | - | number | 实际写入的长度。 | +| 类型 | 说明 | +| ------ | -------- | +| number | 实际写入的长度。 | **示例：** ```js @@ -2833,15 +2834,15 @@ read(buffer: ArrayBuffer, options?: { **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------- | ----------- | ---- | ---------------------------------------- | - | buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 | - | options | Object | 否 | 支持如下选项：
- offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
- length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
- position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。
约束：offset+length<=buffer.size。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ----------- | ---- | ---------------------------------------- | +| buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 | +| options | Object | 否 | 支持如下选项：
- offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
- length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
- position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。
约束：offset+length<=buffer.size。 | **返回值：** - | 类型 | 说明 | - | ---------------------------------- | ------ | - | Promise<[ReadOut](#readout)> | Promise对象。返回读取的结果。 | +| 类型 | 说明 | +| ---------------------------------- | ------ | +| Promise<[ReadOut](#readout)> | Promise对象。返回读取的结果。 | **示例：** ```js @@ -2868,11 +2869,11 @@ read(buffer: ArrayBuffer, options: { **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ---------------------------------------- | ---- | ---------------------------------------- | - | buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 | - | options | Object | 否 | 支持如下选项：
- offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
- length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
- position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。
约束：offset+length<=buffer.size。 | - | callback | AsyncCallback<[ReadOut](#readout)> | 是 | 异步从流文件读取数据之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ---------------------------------------- | +| buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 | +| options | Object | 否 | 支持如下选项：
- offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
- length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
- position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。
约束：offset+length<=buffer.size。 | +| callback | AsyncCallback<[ReadOut](#readout)> | 是 | 异步从流文件读取数据之后的回调。 | **示例：** ```js @@ -2900,16 +2901,16 @@ readSync(buffer: ArrayBuffer, options?: { **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------- | ----------- | ---- | ---------------------------------------- | - | buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 | - | options | Object | 否 | 支持如下选项：
- offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
- length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
- position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。
约束：offset+length<=buffer.size。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ----------- | ---- | ---------------------------------------- | +| buffer | ArrayBuffer | 是 | 用于读取文件的缓冲区。 | +| options | Object | 否 | 支持如下选项：
- offset，number类型，表示将数据读取到缓冲区的位置，即相对于缓冲区首地址的偏移。可选，默认为0。
- length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
- position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。
约束：offset+length<=buffer.size。 | **返回值：** - | 类型 | 说明 | - | ------ | -------- | - | number | 实际读取的长度。 | +| 类型 | 说明 | +| ------ | -------- | +| number | 实际读取的长度。 | **示例：** ```js @@ -2932,9 +2933,9 @@ read(): Promise<Dirent> **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** - | 类型 | 说明 | - | -------------------------------- | ------------- | - | Promise<[Dirent](#dirent)> | Promise对象。返回表示异步读取目录项的结果。 | +| 类型 | 说明 | +| -------------------------------- | ------------- | +| Promise<[Dirent](#dirent)> | Promise对象。返回表示异步读取目录项的结果。 | **示例：** ```js @@ -2956,9 +2957,9 @@ read(callback: AsyncCallback<Dirent>): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------------------------------------- | ---- | ---------------- | - | callback | AsyncCallback<[Dirent](#dirent)> | 是 | 异步读取下一个目录项之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------------- | ---- | ---------------- | +| callback | AsyncCallback<[Dirent](#dirent)> | 是 | 异步读取下一个目录项之后的回调。 | **示例：** ```js @@ -2981,9 +2982,9 @@ readSync(): Dirent **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** - | 类型 | 说明 | - | ----------------- | -------- | - | [Dirent](#dirent) | 表示一个目录项。 | +| 类型 | 说明 | +| ----------------- | -------- | +| [Dirent](#dirent) | 表示一个目录项。 | **示例：** ```js @@ -3063,9 +3064,9 @@ isBlockDevice(): boolean **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** - | 类型 | 说明 | - | ------- | ---------------- | - | boolean | 表示当前目录项是否是块特殊设备。 | +| 类型 | 说明 | +| ------- | ---------------- | +| boolean | 表示当前目录项是否是块特殊设备。 | **示例：** ```js @@ -3083,9 +3084,9 @@ isCharacterDevice(): boolean **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** - | 类型 | 说明 | - | ------- | ----------------- | - | boolean | 表示当前目录项是否是字符特殊设备。 | +| 类型 | 说明 | +| ------- | ----------------- | +| boolean | 表示当前目录项是否是字符特殊设备。 | **示例：** ```js @@ -3103,9 +3104,9 @@ isDirectory(): boolean **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** - | 类型 | 说明 | - | ------- | ------------- | - | boolean | 表示当前目录项是否是目录。 | +| 类型 | 说明 | +| ------- | ------------- | +| boolean | 表示当前目录项是否是目录。 | **示例：** ```js @@ -3123,9 +3124,9 @@ isFIFO(): boolean **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** - | 类型 | 说明 | - | ------- | --------------- | - | boolean | 表示当前目录项是否是FIFO。 | +| 类型 | 说明 | +| ------- | --------------- | +| boolean | 表示当前目录项是否是FIFO。 | **示例：** ```js @@ -3143,9 +3144,9 @@ isFile(): boolean **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** - | 类型 | 说明 | - | ------- | --------------- | - | boolean | 表示当前目录项是否是普通文件。 | +| 类型 | 说明 | +| ------- | --------------- | +| boolean | 表示当前目录项是否是普通文件。 | **示例：** ```js @@ -3163,9 +3164,9 @@ isSocket(): boolean **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** - | 类型 | 说明 | - | ------- | -------------- | - | boolean | 表示当前目录项是否是套接字。 | +| 类型 | 说明 | +| ------- | -------------- | +| boolean | 表示当前目录项是否是套接字。 | **示例：** ```js @@ -3183,9 +3184,9 @@ isSymbolicLink(): boolean **系统能力**：SystemCapability.FileManagement.File.FileIO **返回值：** - | 类型 | 说明 | - | ------- | --------------- | - | boolean | 表示当前目录项是否是符号链接。 | +| 类型 | 说明 | +| ------- | --------------- | +| boolean | 表示当前目录项是否是符号链接。 | **示例：** ```js diff --git a/zh-cn/application-dev/reference/apis/js-apis-filemanager.md b/zh-cn/application-dev/reference/apis/js-apis-filemanager.md index 576959692a7c8c86a319104c1e8c35ff2e3637d5..802d3d71d66bb58f8cf9e49f85d4d2f336453140 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-filemanager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-filemanager.md @@ -1,11 +1,12 @@ # 公共文件访问与管理 + +该模块提供公共文件访问和管理的服务接口，向下对接底层文件管理服务，如媒体库、外卡管理；向上对应用程序提供公共文件查询、创建的能力。 + >![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > >- 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 >- 本模块接口为系统接口，三方应用不支持调用，当前只支持filepicker调用。 -该模块提供公共文件访问和管理的服务接口，向下对接底层文件管理服务，如媒体库、外卡管理；向上对应用程序提供公共文件查询、创建的能力。 - ## 导入模块 ```js diff --git a/zh-cn/application-dev/reference/apis/js-apis-i18n.md b/zh-cn/application-dev/reference/apis/js-apis-i18n.md index 36b7223e6f112663d2decfea66f0d6b7a0822bbc..553191a186b1c8db0cf82716e5f5d45b218b2a55 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-i18n.md +++ b/zh-cn/application-dev/reference/apis/js-apis-i18n.md @@ -1,5 +1,8 @@ # 国际化-I18n + 本模块提供系统相关的或者增强的国际化能力，包括区域管理、电话号码处理、日历等，相关接口为ECMA 402标准中未定义的补充接口。 +[Intl模块](js-apis-intl.md)提供了ECMA 402标准定义的基础国际化接口，与本模块共同使用可提供完整地国际化支持能力。 + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > - 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > diff --git a/zh-cn/application-dev/reference/apis/js-apis-image.md b/zh-cn/application-dev/reference/apis/js-apis-image.md index df5b95212ee6a01eeee84c149f10fd26ccd9f4e9..d6a15887574068cc821609588d075f9610573036 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-image.md +++ b/zh-cn/application-dev/reference/apis/js-apis-image.md @@ -1,5 +1,7 @@ # 图片处理 +本模块提供图片处理效果，包括通过属性创建PixelMap、读取图像像素数据、读取区域内的图片数据等。 + > **说明：** > 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md b/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md index 613a9701bad2595f022673cca38e12665e575db1..9752a5537b6061d7b923ec61dd92ac4dea82c873 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md @@ -1,5 +1,7 @@ # 输入法框架 +本模块提供对输入法框架的管理，包括隐藏输入法、查询已安装的输入法列表和显示输入法选择对话框。 + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 @@ -47,7 +49,7 @@ getInputMethodController(): InputMethodController | [InputMethodController](#InputMethodController) | 回调返回当前客户端实例。 | **示例：** - + ```js var InputMethodController = inputMethod.getInputMethodController(); ``` @@ -62,9 +64,9 @@ getInputMethodSetting(): InputMethodSetting **返回值：** - | 类型 | 说明 | - | ----------------------------------------- | ---------------------------- | - | [InputMethodSetting](#InputMethodSetting) | 回调返回当前客户端设置实例。 | +| 类型 | 说明 | +| ----------------------------------------- | ---------------------------- | +| [InputMethodSetting](#InputMethodSetting) | 回调返回当前客户端设置实例。 | **示例：** @@ -87,9 +89,9 @@ stopInput(callback: AsyncCallback<boolean>): void **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<boolean> | 是 | 返回输入法隐藏是否成功。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| callback | AsyncCallback<boolean> | 是 | 返回输入法隐藏是否成功。 | **示例：** @@ -109,9 +111,9 @@ stopInput(): Promise<boolean> **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<boolean> | 返回输入法隐藏是否成功。 | +| 类型 | 说明 | +| -------- | -------- | +| Promise<boolean> | 返回输入法隐藏是否成功。 | **示例：** @@ -134,12 +136,12 @@ listInputMethod(callback: AsyncCallback<Array<InputMethodProperty>>) **系统能力**： SystemCapability.Miscservices.InputMethodFramework **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------------------------------------------------- | ---- | ---------------------- | - | callback | Array<[InputMethodProperty](#InputMethodProperty)> | 是 | 返回已安装输入法列表。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------------------------- | ---- | ---------------------- | +| callback | Array<[InputMethodProperty](#InputMethodProperty)> | 是 | 返回已安装输入法列表。 | **示例：** - + ```js InputMethodSetting.listInputMethod((properties)=>{ for (var i = 0;i < properties.length; i++) { @@ -158,9 +160,9 @@ listInputMethod(): Array<InputMethodProperty> **系统能力**： SystemCapability.Miscservices.InputMethodFramework **返回值：** - | 类型 | 说明 | - | ----------------------------------------------------------- | ---------------------- | - | Promise> | 返回已安装输入法列表。 | +| 类型 | 说明 | +| ----------------------------------------------------------- | ---------------------- | +| Promise> | 返回已安装输入法列表。 | **示例：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-intl.md b/zh-cn/application-dev/reference/apis/js-apis-intl.md index f101d78123fbcf66ff346b217d934779a93c23c6..f3c4df4e1deee00198bb19f0a79f16c0760af3ff 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-intl.md +++ b/zh-cn/application-dev/reference/apis/js-apis-intl.md @@ -1,5 +1,8 @@ # 国际化-Intl + 本模块提供提供基础的应用国际化能力，包括时间日期格式化、数字格式化、排序等，相关接口在ECMA 402标准中定义。 +[I18N模块](js-apis-i18n.md)提供其他非ECMA 402定义的国际化接口，与本模块共同使用可提供完整地国际化支持能力。 + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > - 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > diff --git a/zh-cn/application-dev/reference/apis/js-apis-logs.md b/zh-cn/application-dev/reference/apis/js-apis-logs.md index 45806efdcf4870a25b48dc53d403c3113fb2f2aa..13a43a294e44a7b2c33b0c001f327175d8a1f4e9 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-logs.md +++ b/zh-cn/application-dev/reference/apis/js-apis-logs.md @@ -1,5 +1,7 @@ # 日志打印 +本模块提供日志打印能力，包括打印debug级别的日志信息、打印info级别的日志信息、打印warn级别的日志信息和打印error级别的日志信息。 + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 从API Version 7 开始，该接口不再维护，推荐使用新接口[`@ohos.hilog`](js-apis-hilog.md)。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-mediaquery.md b/zh-cn/application-dev/reference/apis/js-apis-mediaquery.md index 1eabfdf4b161a24fa2031fd187ebca5b729e15a5..0b6e423c1731de71958ee1a18e21db2da46c09f9 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-mediaquery.md +++ b/zh-cn/application-dev/reference/apis/js-apis-mediaquery.md @@ -1,5 +1,7 @@ # 媒体查询 +提供根据不同媒体类型定义不同的样式。 + > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 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 475fd483adb8d59ee6b39ee809491787e1628f34..d987dd9a8eb874f2cc942a1747669263f9a80ee6 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-prompt.md +++ b/zh-cn/application-dev/reference/apis/js-apis-prompt.md @@ -1,5 +1,7 @@ # 弹窗 +创建并显示文本提示框、对话框和操作菜单。 + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明** > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-resource-manager.md b/zh-cn/application-dev/reference/apis/js-apis-resource-manager.md index d46da1226a142fed8522cf4b10e8049107565668..60b2decb872483e945c3cbde36964548a9c6c487 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-resource-manager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-resource-manager.md @@ -2,7 +2,8 @@ 资源管理模块，根据当前configuration（语言，区域，横竖屏，mccmnc）和device capability（设备类型，分辨率）提供获取应用资源信息读取接口。 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> **说明：** +> > 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 @@ -238,7 +239,7 @@ resourceManager.getResourceManager((error, mgr) => { | offset | number | rawfile的起始偏移量 | | length | number | rawfile的文件长度 | -## Resource +## Resource9+ 表示的资源信息。 @@ -255,7 +256,8 @@ resourceManager.getResourceManager((error, mgr) => { 提供访问应用资源的能力。 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> **说明：** +> > - ResourceManager涉及到的方法，仅限基于TS扩展的声明式开发范式使用。 > > - 资源文件在工程的resources目录中定义，id可通过$r(资源地址).id的方式获取，例如$r('app.string.test').id。 @@ -330,7 +332,7 @@ getString(resource: Resource, callback: AsyncCallback<string>): void **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------- | ---- | --------------- | -| resource | [Resource](#resource) | 是 | 资源信息 | +| resource | [Resource](#resource9) | 是 | 资源信息 | | callback | AsyncCallback<string> | 是 | 异步回调，用于返回获取的字符串 | **示例：** @@ -360,7 +362,7 @@ getString(resource: Resource): Promise<string> **参数：** | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | ----- | -| resource | [Resource](#resource) | 是 | 资源信息 | +| resource | [Resource](#resource9) | 是 | 资源信息 | **返回值：** | 类型 | 说明 | @@ -449,7 +451,7 @@ getStringArray(resource: Resource, callback: AsyncCallback<Array<string> **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------- | ---- | --------------- | -| resource | [Resource](#resource) | 是 | 资源信息 | +| resource | [Resource](#resource9) | 是 | 资源信息 | | callback | AsyncCallback<Array<string>> | 是 | 异步回调，用于返回获取的字符串数组 | **示例：** @@ -479,7 +481,7 @@ getStringArray(resource: Resource): Promise<Array<string>> **参数：** | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | ----- | -| resource | [Resource](#resource) | 是 | 资源信息 | +| resource | [Resource](#resource9) | 是 | 资源信息 | **返回值：** | 类型 | 说明 | @@ -568,7 +570,7 @@ getMedia(resource: Resource, callback: AsyncCallback<Uint8Array>): void **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------- | ---- | --------------- | -| resource | [Resource](#resource) | 是 | 资源信息 | +| resource | [Resource](#resource9) | 是 | 资源信息 | | callback | AsyncCallback<Uint8Array> | 是 | 异步回调，用于返回获取的媒体文件内容 | **示例：** @@ -598,7 +600,7 @@ getMedia(resource: Resource): Promise<Uint8Array> **参数：** | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | ----- | -| resource | [Resource](#resource) | 是 | 资源信息 | +| resource | [Resource](#resource9) | 是 | 资源信息 | **返回值：** | 类型 | 说明 | @@ -687,7 +689,7 @@ getMediaBase64(resource: Resource, callback: AsyncCallback<string>): void **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------- | ---- | ------------------------ | -| resource | [Resource](#resource) | 是 | 资源信息 | +| resource | [Resource](#resource9) | 是 | 资源信息 | | callback | AsyncCallback<string> | 是 | 异步回调，用于返回获取的图片资源Base64编码 | **示例：** @@ -717,7 +719,7 @@ getMediaBase64(resource: Resource): Promise<string> **参数：** | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | ----- | -| resource | [Resource](#resource) | 是 | 资源信息 | +| resource | [Resource](#resource9) | 是 | 资源信息 | **返回值：** | 类型 | 说明 | @@ -917,7 +919,7 @@ getPluralString(resource: Resource, num: number, callback: AsyncCallback<stri **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------- | ---- | ------------------------------- | -| resource | [Resource](#resource) | 是 | 资源信息 | +| resource | [Resource](#resource9) | 是 | 资源信息 | | num | number | 是 | 数量值 | | callback | AsyncCallback<string> | 是 | 异步回调，返回根据指定数量获取指定resource对象表示的单复数字符串 | @@ -948,7 +950,7 @@ getPluralString(resource: Resource, num: number): Promise<string> **参数：** | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | ----- | -| resource | [Resource](#resource) | 是 | 资源信息 | +| resource | [Resource](#resource9) | 是 | 资源信息 | | num | number | 是 | 数量值 | **返回值：** @@ -1451,7 +1453,7 @@ getStringSync(resource: Resource): string **参数：** | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | ----- | -| resource | [Resource](#resource) | 是 | 资源信息 | +| resource | [Resource](#resource9) | 是 | 资源信息 | **返回值：** | 类型 | 说明 | @@ -1524,7 +1526,7 @@ getBoolean(resource: Resource): boolean **参数：** | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | ----- | -| resource | [Resource](#resource) | 是 | 资源信息 | +| resource | [Resource](#resource9) | 是 | 资源信息 | **返回值：** | 类型 | 说明 | @@ -1599,7 +1601,7 @@ getNumber(resource: Resource): number **参数：** | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | ----- | -| resource | [Resource](#resource) | 是 | 资源信息 | +| resource | [Resource](#resource9) | 是 | 资源信息 | **返回值：** | 类型 | 说明 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-router.md b/zh-cn/application-dev/reference/apis/js-apis-router.md index 589eeef14ad56a7f33136b1e595bb7f4a027aa9d..d8fc608e699c0ccd46b7e65da250dcf9994da9e5 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-router.md +++ b/zh-cn/application-dev/reference/apis/js-apis-router.md @@ -1,5 +1,7 @@ # 页面路由 +本模块提供通过不同的url访问不同的页面，包括跳转到应用内的指定页面、用应用内的某个页面替换当前页面、返回上一页面或指定的页面等。 + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明** > > - 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-securityLabel.md b/zh-cn/application-dev/reference/apis/js-apis-securityLabel.md index 255ec5792603390e1eb64cd9e8569c0af89f8d51..34a85c6f3ca0098102c08121a098058e1fb15010 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-securityLabel.md +++ b/zh-cn/application-dev/reference/apis/js-apis-securityLabel.md @@ -1,10 +1,10 @@ # 数据标签 +该模块提供文件数据安全等级的相关功能：向应用程序提供查询、设置文件数据安全等级的JS接口。 + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -该模块提供文件数据安全等级的相关功能：向应用程序提供查询、设置文件数据安全等级的JS接口。 - ## 导入模块 ```js diff --git a/zh-cn/application-dev/reference/apis/js-apis-statfs.md b/zh-cn/application-dev/reference/apis/js-apis-statfs.md index d213902e4c4f46d228f1765e417ea2371306fb36..23e357dc9f3f970cf579ffbc1229023867eb2c6a 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-statfs.md +++ b/zh-cn/application-dev/reference/apis/js-apis-statfs.md @@ -1,10 +1,10 @@ # statfs +该模块提供文件系统相关存储信息的功能，向应用程序提供获取文件系统总字节数、空闲字节数的JS接口。 + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -该模块提供文件系统相关存储信息的功能，向应用程序提供获取文件系统总字节数、空闲字节数的JS接口。 - ## 导入模块 ```js diff --git a/zh-cn/application-dev/reference/apis/js-apis-storage-statistics.md b/zh-cn/application-dev/reference/apis/js-apis-storage-statistics.md index 5b838f928823ab8c5f20ee4cbaaa8959b6cf4c4a..be091dacdebc8dd1b1d944c01af095c0b57f5625 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-storage-statistics.md +++ b/zh-cn/application-dev/reference/apis/js-apis-storage-statistics.md @@ -1,12 +1,12 @@ # 应用空间统计 +该模块提供空间查询相关的常用功能：包括对内外卡的空间查询，对应用分类数据统计的查询，对应用数据的查询等。 + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > > - 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > - API 9当前为Canary版本，仅供试用，不保证接口可稳定调用。 -该模块提供空间查询相关的常用功能：包括对内外卡的空间查询，对应用分类数据统计的查询，对应用数据的查询等。 - ## 导入模块 ```js diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-mediaquery.md b/zh-cn/application-dev/reference/apis/js-apis-system-mediaquery.md index 20f90a9b04e1f3fb47c4d1cf70ae2a53433b414d..03a18e692036dcb20736e2e068877fe4da0da26a 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-mediaquery.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-mediaquery.md @@ -1,5 +1,7 @@ # 媒体查询 +提供根据不同媒体类型定义不同的样式。 + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-prompt.md b/zh-cn/application-dev/reference/apis/js-apis-system-prompt.md index 4eb142162676ef2b10788a9f627f01dd4aa0c1b6..676b19d2a5fbe5caee02c0825825fbf857b1ebbe 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-prompt.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-prompt.md @@ -1,5 +1,7 @@ # 弹窗 +创建并显示文本提示框、对话框和操作菜单。 + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > > - 从API Version 8 开始，该接口不再维护，推荐使用新接口[`@ohos.prompt`](js-apis-prompt.md)。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-router.md b/zh-cn/application-dev/reference/apis/js-apis-system-router.md index 78f5384c47e41264752b4b9d974a3519de077a8f..4f2d3e9c136268dfa8147a38f5ea54f7b4ba61bd 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-router.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-router.md @@ -1,5 +1,7 @@ # 页面路由 +通过不同的uri访问不同的页面。 + > **说明：** > > - 从API Version 8 开始，该接口不再维护，推荐使用新接口[`@ohos.router`](js-apis-router.md)。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-volumemanager.md b/zh-cn/application-dev/reference/apis/js-apis-volumemanager.md index 387d3a71ad666c605dd1ba126e6ef5b79f0819f4..7cc98e4b15693698873fed6ca834c4eb9248f51c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-volumemanager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-volumemanager.md @@ -1,13 +1,13 @@ # 卷管理 +该模块提供卷、磁盘查询和管理的相关功能：包括查询卷信息，对卷的挂载卸载、对磁盘分区以及卷的格式化等功能。 + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > > - 本模块首批接口从API version 9开始支持。 > - API 9当前为Canary版本，仅供试用，不保证接口可稳定调用。 > - 本模块接口为系统接口，三方应用不支持调用。 -该模块提供卷、磁盘查询和管理的相关功能：包括查询卷信息，对卷的挂载卸载、对磁盘分区以及卷的格式化等功能。 - ## 导入模块 ```js diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-common-styles.md b/zh-cn/application-dev/reference/arkui-js/js-components-common-styles.md index 1e088157f6f1f349d8aa8b203f27265032260dde..6a17f49df84211a01daebfe044f34a544c0ccdc5 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-common-styles.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-common-styles.md @@ -53,7 +53,7 @@ | [start \| end]6+ | <length> \| <percentage> | - | start \| end需要配合position样式使用，来确定元素的偏移位置。
- start属性规定元素的起始边缘。该属性定义了定位元素起始外边距边界与其包含块起始边界之间的偏移。
- end属性规定元素的结尾边缘。该属性定义了一个定位元素的结尾边距边界与其包含块结尾边界之间的偏移。 | | z-index6+ | number | - | 表示对于同一父节点其子节点的渲染顺序。数值越大，渲染数据越靠后。
z-index不支持auto，并且opacity等其他样式不会影响z-index的渲染顺序。 | | image-fill6+ | <color> | - | 为svg图片填充颜色，支持组件范围（与设置图片资源的属性）：button（icon属性）、piece（icon属性）、search（icon属性）、input（headericon属性）、textarea（headericon属性）、image（src属性）、toolbar-item(icon属性)。
svg图片文件内的fill属性颜色值在渲染时将被替换为image-fill所配的颜色值，且仅对svg图片内显示声明的fill属性生效。 | -| clip-path6+ | [ <geometry-box> \|\| <basic-shape> ] \| none | - | 设置组件的裁剪区域。区域内的部分显示，区域外的不显示。
<geometry-box>：表示裁剪区域的作用范围，默认为border-box。可选值为：
- margin-box：margin计算入长宽尺寸内。
- border-box：border计算入长宽尺寸内。
- padding-box：padding计算入长宽尺寸内。
- content-box：margin/border/padding不计算入长宽尺寸内。
<basic-shape>：表示裁剪的形状。包含以下类型：
- inset，格式为：inset( <percentage>{1,4} [ round <'border-radius'> ]? )。
- circle，格式为：circle( [ <percentage> ]? [ at <percentage> <percentage> ]? )。
- ellipse，格式为：ellipse( [ <percentage>{2} ]? [ at <percentage> <percentage> ]? )。
- polygon，格式为：polygon( [ <percentage> <percentage> ]\# )
- path，格式为：path( <string> )。 | +| clip-path6+ | [ <geometry-box> \| <basic-shape> ] \| none | - | 设置组件的裁剪区域。区域内的部分显示，区域外的不显示。
<geometry-box>：表示裁剪区域的作用范围，默认为border-box。可选值为：
- margin-box：margin计算入长宽尺寸内。
- border-box：border计算入长宽尺寸内。
- padding-box：padding计算入长宽尺寸内。
- content-box：margin/border/padding不计算入长宽尺寸内。
<basic-shape>：表示裁剪的形状。包含以下类型：
- inset，格式为：inset( <percentage>{1,4} [ round <'border-radius'> ]? )。
- circle，格式为：circle( [ <percentage> ]? [ at <percentage> <percentage> ]? )。
- ellipse，格式为：ellipse( [ <percentage>{2} ]? [ at <percentage> <percentage> ]? )。
- polygon，格式为：polygon( [ <percentage> <percentage> ]\# )
- path，格式为：path( <string> )。 | | mask-image6+ | - <linear-gradient>
- string | - | 设置渐变色遮罩或本地图片设置。
设置渐变色遮罩，示例：
linear-gradient(to left, black, white)
设置纯色遮罩，示例：
linear-gradient(to right, grey , grey)
设置本地svg图片为遮罩，示例：url(common/mask.svg) | | mask-size6+ | - string
- <length><length>
- <percentage> <percentage> | auto | 设置遮罩图片显示大小，仅当mask-image为图片资源时有效。
string可选值：
- contain：把图像扩展至最大尺寸，以使其高度和宽度完全适用内容区域。
- cover：把图像扩展至足够大，以使背景图像完全覆盖背景区域；背景图像的某些部分也许无法显示在背景定位区域中。
- auto：保持原图的比例不变。
length值参数方式：设置图像的高度和宽度。第一个值设置宽度，第二个值设置高度。如果只设置一个值，则第二个值会被设置为 "auto"。
百分比参数方式：以原图宽高的百分比来设置图像的宽度和高度。第一个值设置宽度，第二个值设置高度。如果只设置一个值，则第二个值会被设置为 "auto"。 | | mask-position6+ | - string string
- <length> <length>
- <percentage> <percentage> | 0px 0px | 设置遮罩图片显示位置，仅当mask-image为图片资源时有效。关键词方式：如果仅规定了一个关键词，那么第二个值为"center"。两个值分别定义水平方向位置和竖直方向位置。
string可选值：
- left：水平方向上最左侧。
- right：水平方向上最右侧。
- top：竖直方向上最顶部。
- bottom：竖直方向上最底部。
- center：水平方向或竖直方向上中间位置。
length值参数方式：第一个值是水平位置，第二个值是垂直位置。 左上角是 0 0。单位是像素 (0px 0px)  。如果仅规定了一个值，另外一个值将是50%。
百分比参数方式：第一个值是水平位置，第二个值是垂直位置。左上角是 0% 0%。右下角是 100% 100%。如果仅规定了一个值，另外一个值为50%。
可以混合使用<percentage>和<length>。 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-button.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-button.md index 5cea77125767de5344804c9ef655a2bcb569124f..27ac9a92677ae717972bb9a7e759189f78d157f0 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-button.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-button.md @@ -1,12 +1,11 @@ # Button +按钮组件，可快速创建不同样式的按钮。 + > **说明：** > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -提供按钮组件。 - - ## 权限列表 无 @@ -23,10 +22,10 @@ **表1** options参数说明 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | + | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | - | type | ButtonType | 否 | Capsule | 描述按钮风格。 | - | stateEffect | boolean | 否 | true | 按钮按下时是否开启切换效果，当状态置为false时，点击效果关闭。 | + | type | ButtonType | 否 | Capsule | 描述按钮风格。 | + | stateEffect | boolean | 否 | true | 按钮按下时是否开启切换效果，当状态置为false时，点击效果关闭。 | - Button(label?: string, options?: { type?: ButtonType, stateEffect?: boolean }) @@ -49,11 +48,11 @@ | stateEffect | boolean | true | 状态切换时是否开启切换效果，当状态置为false时，点击效果关闭。 | - ButtonType枚举说明 - | 名称 | 描述 | + | 名称 | 描述 | | -------- | -------- | - | Capsule | 胶囊型按钮（圆角默认为高度的一半）。 | - | Circle | 圆形按钮。 | - | Normal | 普通按钮（默认不带圆角）。 | + | Capsule | 胶囊型按钮（圆角默认为高度的一半）。 | + | Circle | 圆形按钮。 | + | Normal | 普通按钮（默认不带圆角）。 | > **说明：** > - 按钮圆角通过[通用属性borderRadius设置](ts-universal-attributes-border.md)（不支持通过border接口设置圆角）。 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-loadingprogress.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-loadingprogress.md index f09c3c732c1da4e25bb5a0e2e4318d465e4de621..daaf87b01f562bd33e6971560474193e5ebc7445 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-loadingprogress.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-loadingprogress.md @@ -1,10 +1,10 @@ # LoadingProgress +用于显示加载动效的组件。 + > **说明：** > 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -用于显示加载进展。 - ## 权限列表 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-qrcode.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-qrcode.md index b6ea534ecd55c48f35c3ee72632f857a68b79931..977c2c04b269082b4d2b38a8fa6dd0920810cf5f 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-qrcode.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-qrcode.md @@ -1,12 +1,11 @@ # QRCode +用于显示单个二维码的组件。 + > **说明：** > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -显示二维码信息。 - - ## 权限列表 无 @@ -22,16 +21,16 @@ QRCode(value: string) - 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | + | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | - | value | string | 是 | - | 二维码内容字符串。 | + | value | string | 是 | - | 二维码内容字符串。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | +| 名称 | 参数类型 | 默认值 | 描述 | | -------- | -------- | -------- | -------- | -| color | Color | Black | 设置二维码颜色。 | +| color | Color | Black | 设置二维码颜色。 | ## 事件 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-rating.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-rating.md index bfeba8f0919996808d383c9f354e3d8c2a0812c5..72934461df0a20aee8797d34d390c8f08b160842 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-rating.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-rating.md @@ -1,12 +1,11 @@ # Rating +提供在给定范围内选择评分的组件。 + > **说明：** > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -评分条组件。 - - ## 权限列表 无 @@ -22,26 +21,26 @@ Rating(options?: { rating: number, indicator?: boolean }) - 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | + | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | - | rating | number | 是 | 0 | 设置并接收评分值。 | - | indicator | boolean | 否 | false | 仅作为指示器使用，不可操作。 | + | rating | number | 是 | 0 | 设置并接收评分值。 | + | indicator | boolean | 否 | false | 仅作为指示器使用，不可操作。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | +| 名称 | 参数类型 | 默认值 | 描述 | | -------- | -------- | -------- | -------- | -| stars | number | 5 | 设置评星总数。 | -| stepSize | number | 0.5 | 操作评级的步长。 | -| starStyle | {
backgroundUri: string,
foregroundUri: string,
secondaryUri?: string
} | - | backgroundSrc：未选中的星级的图片链接，可由用户自定义或使用系统默认图片，仅支持本地。
foregroundSrc：选中的星级的图片路径，可由用户自定义或使用系统默认图片，仅支持本地。
secondarySrc：部分选中的星级的图片路径，可由用户自定义或使用系统默认图片，仅支持本地。 | +| stars | number | 5 | 设置评星总数。 | +| stepSize | number | 0.5 | 操作评级的步长。 | +| starStyle | {
backgroundUri: string,
foregroundUri: string,
secondaryUri?: string
} | - | backgroundSrc：未选中的星级的图片链接，可由用户自定义或使用系统默认图片，仅支持本地。
foregroundSrc：选中的星级的图片路径，可由用户自定义或使用系统默认图片，仅支持本地。
secondarySrc：部分选中的星级的图片路径，可由用户自定义或使用系统默认图片，仅支持本地。 | ## 事件 -| 名称 | 功能描述 | +| 名称 | 功能描述 | | -------- | -------- | -| onChange(callback:(value: number) => void) | 操作评分条的评星发生改变时触发该回调。 | +| onChange(callback:(value: number) => void) | 操作评分条的评星发生改变时触发该回调。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-span.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-span.md index 347eb3d9d3aae0ad73502c3fe03c9edff7241d20..59fdeceedc35e0c5b27f74dfb903805339821bc9 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-span.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-span.md @@ -1,12 +1,11 @@ # Span +作为Text组件的子组件，用于显示行内文本的组件。 + > **说明：** > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -文本段落，只能作为Text子组件，呈现一段文本信息。 - - ## 权限列表 无 @@ -22,9 +21,9 @@ Span(content: string) - 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | + | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | - | content | string | 是 | - | 文本内容。 | + | content | string | 是 | - | 文本内容。 | ## 属性 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-stepper.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-stepper.md index 46ff7442fa5041d7bb10e89aa2fe9d7d9d00ed11..4e57b1813c3091e0fdb802d955c64f12613d0c64 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-stepper.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-stepper.md @@ -1,13 +1,12 @@ # Stepper +应用步骤方式切换页面的组件。 + > **说明：** > 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -步骤导航器。 - - ## 权限列表 无 @@ -24,9 +23,9 @@ Stepper(value?: { index?: number }) - 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | + | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | - | index | number | 否 | 0 | 设置步骤导航器显示第几个StepperItem。 | + | index | number | 否 | 0 | 设置步骤导航器显示第几个StepperItem。 | ## 属性 @@ -36,11 +35,11 @@ Stepper(value?: { index?: number }) ## 事件 - | 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| onFinish(callback: () => void) | 步骤导航器最后一个StepperItem的nextLabel被点击时触发该回调 。 | -| onSkip(callback: () => void) | 当前显示的StepperItem状态为ItemState.Skip时，nextLabel被点击时触发该回调。 | -| onChange(callback: (prevIndex?: number, index?: number) => void) | 点击左边或者右边文本按钮进行步骤切换时触发该事件。
- prevIndex：切换前的步骤页索引值。
- index：切换后的步骤页（前一页或者下一页）索引值。 | +| onFinish(callback: () => void) | 步骤导航器最后一个StepperItem的nextLabel被点击时触发该回调 。 | +| onSkip(callback: () => void) | 当前显示的StepperItem状态为ItemState.Skip时，nextLabel被点击时触发该回调。 | +| onChange(callback: (prevIndex?: number, index?: number) => void) | 点击左边或者右边文本按钮进行步骤切换时触发该事件。
- prevIndex：切换前的步骤页索引值。
- index：切换后的步骤页（前一页或者下一页）索引值。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-stepperitem.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-stepperitem.md index eca7788b8a88018305e7352473217b1d9213ca3c..dfbabd005766ee3afaa7e10dd3d226d3732b9722 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-stepperitem.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-stepperitem.md @@ -1,13 +1,12 @@ # StepperItem +用作[Stepper](ts-basic-components-stepper.md)组件的页面子组件。 + > **说明：** > 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -步骤导航器元素。 - - ## 权限列表 无 @@ -32,12 +31,12 @@ StepperItem() | status | ItemState | ItemState.Normal | 步骤导航器元素的状态。 | - ItemState枚举说明 - | 名称 | 描述 | + | 名称 | 描述 | | -------- | -------- | - | Normal | 正常状态，右侧文本按钮正常显示，可点击进入下一个StepperItem。 | - | Disabled | 不可用状态，右侧文本按钮灰度显示，不可点击进入下一个StepperItem。 | - | Waiting | 等待状态，右侧文本按钮不显示，使用等待进度条，不可点击进入下一个StepperItem。 | - | Skip | 跳过状态，表示跳过当前步骤, 进入下一个StepperItem。 | + | Normal | 正常状态，右侧文本按钮正常显示，可点击进入下一个StepperItem。 | + | Disabled | 不可用状态，右侧文本按钮灰度显示，不可点击进入下一个StepperItem。 | + | Waiting | 等待状态，右侧文本按钮不显示，使用等待进度条，不可点击进入下一个StepperItem。 | + | Skip | 跳过状态，表示跳过当前步骤, 进入下一个StepperItem。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-text.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-text.md index b8ce970cbd33af29ad31f5751f105f0176d81392..b01ca87835f4d78d370d767d30944bd9483b3cb3 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-text.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-text.md @@ -1,12 +1,11 @@ # Text +显示一段文本的组件。 + > **说明：** > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -文本，用于呈现一段信息。 - - ## 权限列表 无 @@ -22,9 +21,9 @@ Text(content?: string) - 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | + | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | - | content | string | 否 | '' | 文本内容，包含子组件Span时不生效，显示Span内容。 | + | content | string | 否 | '' | 文本内容，包含子组件Span时不生效，显示Span内容。 | ## 属性 @@ -41,26 +40,26 @@ Text(content?: string) | copyOption9+ | boolean\|CopyOption | false | 组件支持设置文本是否可复制粘贴。 | - TextAlign枚举说明 - | 名称 | 描述 | + | 名称 | 描述 | | -------- | -------- | - | Center | 文本居中对齐。 | - | Start | 根据文字书写相同的方向对齐。 | - | End | 根据文字书写相反的方向对齐。 | + | Center | 文本居中对齐。 | + | Start | 根据文字书写相同的方向对齐。 | + | End | 根据文字书写相反的方向对齐。 | - TextOverflow枚举说明 - | 名称 | 描述 | + | 名称 | 描述 | | -------- | -------- | - | Clip | 文本超长时进行裁剪显示。 | - | Ellipsis | 文本超长时显示不下的文本用省略号代替。 | - | None | 文本超长时不进行裁剪。 | + | Clip | 文本超长时进行裁剪显示。 | + | Ellipsis | 文本超长时显示不下的文本用省略号代替。 | + | None | 文本超长时不进行裁剪。 | - TextDecorationType枚举说明 - | 名称 | 描述 | + | 名称 | 描述 | | -------- | -------- | - | Underline | 文字下划线修饰。 | - | LineThrough | 穿过文本的修饰线。 | - | Overline | 文字上划线修饰。 | - | None | 不使用文本装饰线。 | + | Underline | 文字下划线修饰。 | + | LineThrough | 穿过文本的修饰线。 | + | Overline | 文字上划线修饰。 | + | None | 不使用文本装饰线。 | - TextCase枚举说明 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textarea.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textarea.md index c1bbd2996f9d040e92a1abad3f3d175571bd9d2c..7aa32c4489a61155281f8af8c1920c55af92ce94 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textarea.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textarea.md @@ -1,12 +1,11 @@ # TextArea +可以输入多行文本并支持响应部分输入事件的组件。 + > **说明：** > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -提供多行文本输入组件。 - - ## 权限列表 无 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md index c55d69b4cf6960ce8c6c0dee7590e55ff10374a0..7817f08f1360dd3226fcfe75dfecfb67cd5a4fd2 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md @@ -1,12 +1,11 @@ # TextInput +可以输入单行文本并支持响应输入事件的组件。 + > **说明：** > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -提供单行文本输入组件。 - - ## 权限列表 无 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textpicker.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textpicker.md index 8d83077ee1e6af77476ca0cb05f2ad24312642cd..d21ddc6b3a577fbef16758970eed5f7a1f74b936 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textpicker.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textpicker.md @@ -1,12 +1,11 @@ # TextPicker +滚动选择文本的组件。 + > **说明：** > 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -文本类滑动选择器组件。 - - ## 权限列表 无 @@ -24,7 +23,7 @@ TextPicker(value: {range: string[] | Resource, value?: string, selected?: number 根据range指定的选择范围创建文本选择器。 - 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | + | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | | range | string[]\| [Resource](../../ui/ts-types.md#resource类型) | 是 | - | 选择器的数据选择范围。 | | value | string | 否 | - | 搜索文本值。 | @@ -33,16 +32,16 @@ TextPicker(value: {range: string[] | Resource, value?: string, selected?: number ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | +| 名称 | 参数类型 | 默认值 | 描述 | | -------- | -------- | -------- | -------- | -| defaultPickerItemHeight | Length | - | 默认Picker内容项元素高度。 | +| defaultPickerItemHeight | Length | - | 默认Picker内容项元素高度。 | ## 事件 -| 名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| onChange(callback: (value: string, index: number) => void) | 滑动选中TextPicker文本内容后，触发该回调。
- value: 当前选中项的文本。
- index: 当前选中项的下标。 | +| onChange(callback: (value: string, index: number) => void) | 滑动选中TextPicker文本内容后，触发该回调。
- value: 当前选中项的文本。
- index: 当前选中项的下标。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-texttimer.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-texttimer.md index e0036a7d4ea8de9b4ed46be43a709c2efb4e69d1..024b03570c8acf59f12f1839bbe1c8d6bd6f8419 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-texttimer.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-texttimer.md @@ -1,12 +1,11 @@ # TextTimer +通过文本显示计时信息并控制其计时器状态的组件。 + > **说明：** > 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -文本计时器组件，支持自定义时间格式。 - - ## 权限列表 无 @@ -22,24 +21,24 @@ TextTimer(options: { isCountDown?: boolean, count?: number, controller?: TextTimerController }) - 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | + | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | - | isCountDown | boolean | 否 | false | 是否倒计时。 | - | count | number | 否 | 60000 | 倒计时时间（isCountDown为true时生效），单位为毫秒。
- count<=0时，使用默认值为倒计时初始值。
- count>0时，count值为倒计时初始值。 | - | controller | [TextTimerController](#texttimercontroller) | 否 | null | TextTimer控制器。 | + | isCountDown | boolean | 否 | false | 是否倒计时。 | + | count | number | 否 | 60000 | 倒计时时间（isCountDown为true时生效），单位为毫秒。
- count<=0时，使用默认值为倒计时初始值。
- count>0时，count值为倒计时初始值。 | + | controller | [TextTimerController](#texttimercontroller) | 否 | null | TextTimer控制器。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | +| 名称 | 参数类型 | 默认值 | 描述 | | -------- | -------- | -------- | -------- | -| format | string | 'hh:mm:ss.ms' | 自定义格式，需至少包含一个hh、mm、ss、ms中的关键字。 | +| format | string | 'hh:mm:ss.ms' | 自定义格式，需至少包含一个hh、mm、ss、ms中的关键字。 | ## 事件 -| 名称 | 功能描述 | +| 名称 | 功能描述 | | -------- | -------- | -| onTimer(callback: (utc: number, elapsedTime: number) => void) | 时间文本发生变化时触发。
utc：当前显示的时间，单位为毫秒。
elapsedTime：计时器经过的时间，单位为毫秒。 | +| onTimer(callback: (utc: number, elapsedTime: number) => void) | 时间文本发生变化时触发。
utc：当前显示的时间，单位为毫秒。
elapsedTime：计时器经过的时间，单位为毫秒。 | ## TextTimerController 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 94a6f551dc93e60890ad53ae01f058b4f536af99..92cd8df915ddee1167ecd688daef50e527743335 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 @@ -1,12 +1,11 @@ # TimePicker +滚动选择时间的组件。 + > **说明：** > 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -选择时间的滑动选择器组件。 - - ## 权限列表 无 @@ -31,22 +30,22 @@ TimePicker(options?: TimePickerOptions) ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | +| 名称 | 参数类型 | 默认值 | 描述 | | -------- | -------- | -------- | -------- | -| useMilitaryTime | boolean | false | 展示时间是否为24小时制，不支持动态修改。 | +| useMilitaryTime | boolean | false | 展示时间是否为24小时制，不支持动态修改。 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | -| onChange(callback: (value: TimePickerResult ) => void) | 选择时间时触发该事件。 | +| 名称 | 功能描述 | +| -------- | -------- | +| onChange(callback: (value: TimePickerResult ) => void) | 选择时间时触发该事件。 | ### TimePickerResult对象说明 - | 名称 | 参数类型 | 描述 | - | -------- | -------- | -------- | - | hour | number | 选中时间的时。 | - | minute | number | 选中时间的分。 | +| 名称 | 参数类型 | 描述 | +| -------- | -------- | -------- | +| hour | number | 选中时间的时。 | +| minute | number | 选中时间的分。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-toggle.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-toggle.md index 3040999573345a1b76178c4da8c7b5959f9d9c3f..d410e2a0aec9d0f2507e5661f40a2d63c49645a0 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-toggle.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-toggle.md @@ -1,5 +1,7 @@ # Toggle +组件提供勾选框样式、状态按钮样式及开关样式。 + > **说明：** > 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 @@ -28,7 +30,7 @@ Toggle(options: { type: ToggleType, isOn?: boolean }) - ToggleType枚举说明 | 名称 | 描述 | | -------- | -------- | - | Checkbox | 提供单选框样式，子组件设置文本不生效，如需文本设置，可将Text和当前组件放入布局组件中。
> **说明：**
> [通用属性padding](ts-universal-attributes-size.md)的默认值为：
{
 top: 14 vp,
 right: 6 vp,
 bottom: 14 vp,
 left: 6 vp
} | + | Checkbox | 提供勾选框样式，子组件设置文本不生效，如需文本设置，可将Text和当前组件放入布局组件中。
> **说明：**
> [通用属性padding](ts-universal-attributes-size.md)的默认值为：
{
 top: 14 vp,
 right: 6 vp,
 bottom: 14 vp,
 left: 6 vp
} | | Button | 提供状态按钮样式，如果有文本设置，则相应的文本内容会显示在按钮内部。 | | Switch | 提供开关样式，子组件设置文本不生效，如需文本设置，可将Text和当前组件放入布局组件中。
> **说明：**
> [通用属性padding](ts-universal-attributes-size.md)默认值为：
{
 top: 12 vp,
 right: 12 vp,
 bottom: 12 vp,
 left: 12 vp
} | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md index 9fc06d2975774e9389051d2d7e0dd4f2a9d7814f..bb41739d61c6f05ab68b8eaf616902bc67d83ab2 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md @@ -1,5 +1,7 @@ # LongPressGesture +用于触发长按手势事件，触发长按手势的最少手指数为1，最短时间为500毫秒。 + > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 @@ -14,25 +16,25 @@ LongPressGesture(options?: { fingers?: number, repeat?: boolean, duration?: number }) - 参数 - | 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | + | 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | - | fingers | number | 否 | 1 | 触发长按的最少手指数，最小为1指， 最大取值为10指。 | - | repeat | boolean | 否 | false | 是否连续触发事件回调。 | - | duration | number | 否 | 500 | 最小触发长按的时间，单位为毫秒（ms）。 | + | fingers | number | 否 | 1 | 触发长按的最少手指数，最小为1指， 最大取值为10指。 | + | repeat | boolean | 否 | false | 是否连续触发事件回调。 | + | duration | number | 否 | 500 | 最小触发长按的时间，单位为毫秒（ms）。 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | -| onAction((event?: GestureEvent) => void) | LongPress手势识别成功回调。 | -| onActionEnd((event?: GestureEvent) => void) | LongPress手势识别成功，手指抬起后触发回调。 | -| onActionCancel(event: () => void) | LongPress手势识别成功，接收到触摸取消事件触发回调。 | +| 名称 | 功能描述 | +| -------- | -------- | +| onAction((event?: GestureEvent) => void) | LongPress手势识别成功回调。 | +| onActionEnd((event?: GestureEvent) => void) | LongPress手势识别成功，手指抬起后触发回调。 | +| onActionCancel(event: () => void) | LongPress手势识别成功，接收到触摸取消事件触发回调。 | - GestureEvent对象中与LongPress手势相关的属性 - | 属性名称 | 属性类型 | 描述 | + | 属性名称 | 属性类型 | 描述 | | -------- | -------- | -------- | - | repeat | boolean | 事件是否为重复触发事件。 | + | repeat | boolean | 事件是否为重复触发事件。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md index 7f9a3ef2cf8f0f16990ac648f667d3bac767bd5d..f2b094307eb23c403c4f648af1a96d61dfb36cb7 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md @@ -1,5 +1,7 @@ # PanGesture +用于触发拖动手势事件，滑动的最小距离为5vp时拖动手势识别成功。 + > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 @@ -21,16 +23,16 @@ PanGesture(options?: { fingers?: number, direction?: PanDirection, distance?: nu | distance | number | 否 | 5.0 | 最小滑动识别距离，单位为vp。 | - PanDirection枚举说明 - | 名称 | 描述 | + | 名称 | 描述 | | -------- | -------- | - | All | 所有方向可滑动。 | - | Horizontal | 水平方向可滑动。 | - | Vertical | 竖直方向可滑动。 | - | Left | 向左滑动。 | - | Right | 向右滑动。 | - | Up | 向上滑动。 | - | Down | 向下滑动。 | - | None | 任何方向都不可滑动。 | + | All | 所有方向可滑动。 | + | Horizontal | 水平方向可滑动。 | + | Vertical | 竖直方向可滑动。 | + | Left | 向左滑动。 | + | Right | 向右滑动。 | + | Up | 向上滑动。 | + | Down | 向下滑动。 | + | None | 任何方向都不可滑动。 | ### PanGestureOptions @@ -43,27 +45,27 @@ PanGestureOptions(options?: { fingers?: number, direction?: PanDirection, distan 同PanGesture参数说明。 - 接口 - | 名称 | 功能描述 | + | 名称 | 功能描述 | | -------- | -------- | - | setDirection(value: PanDirection) | 设置direction属性。 | - | setDistance(value: number) | 设置distance属性。 | - | setFingers(value: number) | 设置fingers属性。 | + | setDirection(value: PanDirection) | 设置direction属性。 | + | setDistance(value: number) | 设置distance属性。 | + | setFingers(value: number) | 设置fingers属性。 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | -| onActionStart(callback: (event?: GestureEvent) => void) | Pan手势识别成功回调。 | -| onActionUpdate(callback: (event?: GestureEvent) => void) | Pan手势移动过程中回调。 | -| onActionEnd(callback: (event?: GestureEvent) => void) | Pan手势识别成功，手指抬起后触发回调。 | -| onActionCancel(callback: () => void) | Pan手势识别成功，接收到触摸取消事件触发回调。 | +| 名称 | 功能描述 | +| -------- | -------- | +| onActionStart(callback: (event?: GestureEvent) => void) | Pan手势识别成功回调。 | +| onActionUpdate(callback: (event?: GestureEvent) => void) | Pan手势移动过程中回调。 | +| onActionEnd(callback: (event?: GestureEvent) => void) | Pan手势识别成功，手指抬起后触发回调。 | +| onActionCancel(callback: () => void) | Pan手势识别成功，接收到触摸取消事件触发回调。 | - GestureEvent对象中与Pan手势相关的属性 - | 属性名称 | 属性类型 | 描述 | + | 属性名称 | 属性类型 | 描述 | | -------- | -------- | -------- | - | offsetX | number | 手势事件偏移量，单位为vp。 | - | offsetY | number | 手势事件偏移量，单位为vp。 | + | offsetX | number | 手势事件偏移量，单位为vp。 | + | offsetY | number | 手势事件偏移量，单位为vp。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md index 0dba2dcc4581ce59c6e1304472281284a69fe051..317f763e1e1af6bba81cf61bfbed7749992b7751 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md @@ -1,5 +1,7 @@ # PinchGesture +用于触发捏合手势，触发捏合手势的最少手指为2指，最大为5指，最小识别距离为3vp。 + > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 @@ -14,27 +16,27 @@ PinchGesture(options?: { fingers?: number, distance?: number }) - 参数 - | 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | + | 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | - | fingers | number | 否 | 2 | 触发捏合的最少手指数, 最小为2指，最大为5指。 | - | distance | number | 否 | 3.0 | 最小识别距离，单位为vp。 | + | fingers | number | 否 | 2 | 触发捏合的最少手指数, 最小为2指，最大为5指。 | + | distance | number | 否 | 3.0 | 最小识别距离，单位为vp。 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | -| onActionStart((event?: GestureEvent) => void) | Pinch手势识别成功回调。 | -| onActionUpdate((event?: GestureEvent) => void) | Pinch手势移动过程中回调。 | -| onActionEnd((event?: GestureEvent) => void) | Pinch手势识别成功，手指抬起后触发回调。 | -| onActionCancel(event: () => void) | Pinch手势识别成功，接收到触摸取消事件触发回调。 | +| 名称 | 功能描述 | +| -------- | -------- | +| onActionStart((event?: GestureEvent) => void) | Pinch手势识别成功回调。 | +| onActionUpdate((event?: GestureEvent) => void) | Pinch手势移动过程中回调。 | +| onActionEnd((event?: GestureEvent) => void) | Pinch手势识别成功，手指抬起后触发回调。 | +| onActionCancel(event: () => void) | Pinch手势识别成功，接收到触摸取消事件触发回调。 | - GestureEvent对象中与Pinch手势相关的属性 - | 属性名称 | 属性类型 | 描述 | + | 属性名称 | 属性类型 | 描述 | | -------- | -------- | -------- | - | scale | number | 缩放比例，用于PinchGesture手势触发场景。 | - | pinchCenterX | number | 捏合手势中心点X轴坐标，单位为px。 | - | pinchCenterY | number | 捏合手势中心点Y轴坐标，单位为px。 | + | scale | number | 缩放比例，用于PinchGesture手势触发场景。 | + | pinchCenterX | number | 捏合手势中心点X轴坐标，单位为px。 | + | pinchCenterY | number | 捏合手势中心点Y轴坐标，单位为px。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md index d221b92eeccbc876d2e0fb5046fbd8331be50cde..46a41b500b670f2b8d6f10aec9ced5cf111ea6ae 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md @@ -1,5 +1,7 @@ # RotationGesture +用于触发旋转手势事件，触发旋转手势的最少手指为2指，最大为5指，最小改变度数为1度。 + > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 @@ -14,25 +16,25 @@ RotationGesture(options?: { fingers?: number, angle?: number }) - 参数 - | 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | + | 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | - | fingers | number | 否 | 2 | 触发旋转的最少手指数, 最小为2指，最大为5指。 | - | angle | number | 否 | 1.0 | 触发旋转手势的最小改变度数，单位为度数。 | + | fingers | number | 否 | 2 | 触发旋转的最少手指数, 最小为2指，最大为5指。 | + | angle | number | 否 | 1.0 | 触发旋转手势的最小改变度数，单位为度数。 | ## 事件 -| 名称 | 功能描述 | +| 名称 | 功能描述 | | -------- | -------- | -| onActionStart((event?: GestureEvent) => void) | Rotation手势识别成功回调。 | -| onActionUpdate((event?: GestureEvent) => void) | Rotation手势移动过程中回调。 | -| onActionEnd((event?: GestureEvent) => void) | Rotation手势识别成功，手指抬起后触发回调。 | -| onActionCancel(event: () => void) | Rotation手势识别成功，接收到触摸取消事件触发回调。 | +| onActionStart((event?: GestureEvent) => void) | Rotation手势识别成功回调。 | +| onActionUpdate((event?: GestureEvent) => void) | Rotation手势移动过程中回调。 | +| onActionEnd((event?: GestureEvent) => void) | Rotation手势识别成功，手指抬起后触发回调。 | +| onActionCancel(event: () => void) | Rotation手势识别成功，接收到触摸取消事件触发回调。 | - GestureEvent对象中与Rotation手势相关的属性 - | 属性名称 | 属性类型 | 描述 | + | 属性名称 | 属性类型 | 描述 | | -------- | -------- | -------- | - | angle | number | 旋转角度。 | + | angle | number | 旋转角度。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md index fbe6fbbbf6d732212a2fa4c2b7dd4534134b69ee..b3cecea1cc3de9b222de74ffac975189bb15010d 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md @@ -1,5 +1,7 @@ # SwipeGesture +用于触发滑动事件，滑动最小速度为100vp/s时识别成功。 + > **说明：** > 从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 @@ -21,25 +23,25 @@ SwipeGesture(value?: { fingers?: number; direction?: SwipeDirection; speed?: num | speed | number | 否 | 100 | 识别滑动的最小速度（100VP/秒）。 | - SwipeDirection枚举说明 - | 名称 | 描述 | + | 名称 | 描述 | | -------- | -------- | - | All | 所有方向。 | - | Horizontal | 水平方向。 | - | Vertical | 竖直方向。 | + | All | 所有方向。 | + | Horizontal | 水平方向。 | + | Vertical | 竖直方向。 | ## 事件 -| 名称 | 功能描述 | +| 名称 | 功能描述 | | -------- | -------- | -| onAction(callback:(event?: GestureEvent) => void) | 滑动手势识别成功回调。 | +| onAction(callback:(event?: GestureEvent) => void) | 滑动手势识别成功回调。 | - GestureEvent对象中与Swipe手势相关的属性 - | 参数名 | 类型 | 说明 | + | 参数名 | 类型 | 说明 | | -------- | -------- | -------- | - | angle | number | 滑动手势的角度，即两根手指间的线段与水平方向的夹角变化的度数。
>  **说明：**
> 角度计算方式：滑动手势被识别到后，连接两根手指之间的线被识别为起始线条，随着手指的滑动，手指之间的线条会发生旋转，根据起始线条两端点和当前线条两端点的坐标，使用反正切函数分别计算其相对于水平方向的夹角，最后arctan2(cy2-cy1,cx2-cx1)-arctan2(y2-y1,x2-x1)为旋转的角度。以起始线条为坐标系，顺时针旋转为0到180度，逆时针旋转为-180到0度。 | - | speed | number | 滑动手势的速度，是所有手指滑动的平均速度，单位为VP/秒。 | + | angle | number | 滑动手势的角度，即两根手指间的线段与水平方向的夹角变化的度数。
>  **说明：**
> 角度计算方式：滑动手势被识别到后，连接两根手指之间的线被识别为起始线条，随着手指的滑动，手指之间的线条会发生旋转，根据起始线条两端点和当前线条两端点的坐标，使用反正切函数分别计算其相对于水平方向的夹角，最后arctan2(cy2-cy1,cx2-cx1)-arctan2(y2-y1,x2-x1)为旋转的角度。以起始线条为坐标系，顺时针旋转为0到180度，逆时针旋转为-180到0度。 | + | speed | number | 滑动手势的速度，是所有手指滑动的平均速度，单位为VP/秒。 | ![zh-cn_image_0000001231374559](figures/zh-cn_image_0000001231374661.png) ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md index ec8884d075c378fd16df58258f3f845fd751327a..8477b4653852a02117c788a43bb8d79ee30e92ea 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md @@ -1,5 +1,7 @@ # TapGesture +支持单次点击、多次点击识别。 + > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 @@ -14,17 +16,17 @@ TapGesture(options?: { count?: number, fingers?: number }) - 参数 - | 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | + | 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | - | count | number | 否 | 1 | 识别的连续点击次数。如果设置小于1，会被转化为默认值。
>  **说明：**
> 如配置多击，上一次抬起和下一次按下的超时时间为300毫秒（ms）。 | - | fingers | number | 否 | 1 | 触发点击的最少手指数，最小为1指， 最大为10指。
>  **说明：**
> 1. 当配置多指时，第一根手指按下后300毫秒（ms）内未有足够的手指数按下，手势识别失败。
> 
> 2. 实际点击手指数超过配置值，手势识别失败。 | + | count | number | 否 | 1 | 识别的连续点击次数。如果设置小于1，会被转化为默认值。
>  **说明：**
> 如配置多击，上一次抬起和下一次按下的超时时间为300毫秒（ms）。 | + | fingers | number | 否 | 1 | 触发点击的最少手指数，最小为1指， 最大为10指。
>  **说明：**
> 1. 当配置多指时，第一根手指按下后300毫秒（ms）内未有足够的手指数按下，手势识别失败。
> 
> 2. 实际点击手指数超过配置值，手势识别失败。 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | -| onAction((event?: [GestureEvent](ts-gesture-settings.md)) => void) | Tap手势识别成功回调。 | +| 名称 | 功能描述 | +| -------- | -------- | +| onAction((event?: [GestureEvent](ts-gesture-settings.md)) => void) | Tap手势识别成功回调。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-combined-gestures.md b/zh-cn/application-dev/reference/arkui-ts/ts-combined-gestures.md index 978aff2c6bacc25fea9eaede797664c998f0e551..d5d3324e8a027846ca166638f9be4c9a93d90602 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-combined-gestures.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-combined-gestures.md @@ -1,5 +1,7 @@ # 组合手势 +手势识别组，多种手势组合为复合手势，支持连续识别、并行识别和互斥识别。 + > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 @@ -20,18 +22,18 @@ GestureGroup(mode: GestureMode, ...gesture: GestureType[]) | gesture | [TapGesture](ts-basic-gestures-tapgesture.md)
\| [LongPressGesture](ts-basic-gestures-longpressgesture.md)
\| [PanGesture](ts-basic-gestures-pangesture.md)
\| [PinchGesture](ts-basic-gestures-pinchgesture.md)
\| [RotationGesture](ts-basic-gestures-rotationgesture.md) | 是 | - | 可变长参数，1个或者多个基础手势类型，这些手势会被组合识别。 | - GestureMode枚举说明 - | 名称 | 描述 | + | 名称 | 描述 | | -------- | -------- | - | Sequence | 顺序识别，按照手势的注册顺序识别手势，直到所有手势识别成功。当有一个手势识别失败时，所有手势识别失败。 | - | Parallel | 并发识别，注册的手势同时识别，直到所有手势识别结束，手势识别互相不影响。 | - | Exclusive | 互斥识别，注册的手势同时识别，若有一个手势识别成功，则结束手势识别。 | + | Sequence | 顺序识别，按照手势的注册顺序识别手势，直到所有手势识别成功。当有一个手势识别失败时，所有手势识别失败。 | + | Parallel | 并发识别，注册的手势同时识别，直到所有手势识别结束，手势识别互相不影响。 | + | Exclusive | 互斥识别，注册的手势同时识别，若有一个手势识别成功，则结束手势识别。 | ## 事件 -| 名称 | 功能描述 | +| 名称 | 功能描述 | | -------- | -------- | -| onCancel(event: () => void) | 顺序组合手势（GestureMode.Sequence）取消后触发回调。 | +| onCancel(event: () => void) | 顺序组合手势（GestureMode.Sequence）取消后触发回调。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-lottie.md b/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-lottie.md index b6cbc21fde54ff812e045aa2879fbb89bc457297..be0cb2c09316aeec04eb8a8a63fdc6b67c340953 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-lottie.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-lottie.md @@ -1,5 +1,7 @@ # Lottie +提供Lottie动画。 + > **说明：** > 从 API Version 8 开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 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 36f1e1421fc4186100e1aeab09b79ae2258ee356..57a07853dc1e3fc0f1a4162386082e5f1c19bdf0 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 @@ -1,13 +1,10 @@ # AlphabetIndexer +可以与容器组件联动用于按逻辑结构快速定位容器显示区域的组件。 + > **说明：** > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 - -字母索引条。 - - - ## 权限列表 无 @@ -23,32 +20,32 @@ AlphabetIndexer(value: {arrayValue : Array<string>, selected : number}) - 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | + | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | - | arrayValue | Array<string> | 是 | - | 字母索引字符串数组。 | - | selected | number | 是 | - | 选中项编号。 | + | arrayValue | Array<string> | 是 | - | 字母索引字符串数组。 | + | selected | number | 是 | - | 选中项编号。 | ## 属性 -| 名称 | 参数类型 | 描述 | +| 名称 | 参数类型 | 描述 | | -------- | -------- | -------- | -| selectedColor | Color | 选中文本文字颜色。 | -| popupColor | Color | 弹出提示文本字体颜色。 | -| selectedBackgroundColor | Color | 选中文本背景颜色。 | -| popupBackground | Color | 弹窗索引背景色。 | -| usingPopup | boolean | 是否使用弹出索引提示。 | -| selectedFont | {
size?: number,
weight?: FontWeight,
family?: string,
style?: FontStyle
} | 选中文本文字样式。 | -| popupFont | {
size?: number,
weight?: FontWeight,
family?: string,
style?: FontStyle
} | 弹出提示文本字体样式。 | -| font | {
size?: number,
weight?: FontWeight,
family?: string,
style?: FontStyle
} | 字母索引条默认文本字体样式。 | -| itemSize | Length | 字母索引条字母区域大小，字母区域为正方形，设置正方形边长。 | -| alignStyle | IndexerAlign | 字母索引条对齐样式，支持左侧对齐样式与右侧对齐样式，影响弹窗弹出位置。 | +| selectedColor | Color | 选中文本文字颜色。 | +| popupColor | Color | 弹出提示文本字体颜色。 | +| selectedBackgroundColor | Color | 选中文本背景颜色。 | +| popupBackground | Color | 弹窗索引背景色。 | +| usingPopup | boolean | 是否使用弹出索引提示。 | +| selectedFont | {
size?: number,
weight?: FontWeight,
family?: string,
style?: FontStyle
} | 选中文本文字样式。 | +| popupFont | {
size?: number,
weight?: FontWeight,
family?: string,
style?: FontStyle
} | 弹出提示文本字体样式。 | +| font | {
size?: number,
weight?: FontWeight,
family?: string,
style?: FontStyle
} | 字母索引条默认文本字体样式。 | +| itemSize | Length | 字母索引条字母区域大小，字母区域为正方形，设置正方形边长。 | +| alignStyle | IndexerAlign | 字母索引条对齐样式，支持左侧对齐样式与右侧对齐样式，影响弹窗弹出位置。 | - IndexerAlign枚举说明 - | 名称 | 描述 | + | 名称 | 描述 | | -------- | -------- | - | Left | 弹框显示在索引条右侧。 | - | Right | 弹框显示在索引条左侧。 | + | Left | 弹框显示在索引条右侧。 | + | Right | 弹框显示在索引条左侧。 | ## 事件 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-badge.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-badge.md index 7d13aad9a9881a67691810b11ee485f285f35385..b8bb74795c696b3dd914d532568593d23b450f1e 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-badge.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-badge.md @@ -1,12 +1,11 @@ # Badge +可以附加在单个组件上用于信息标记的容器组件。 + > **说明：** > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -新事件标记组件，在组件上提供事件信息展示能力。 - - ## 权限列表 无 @@ -49,11 +48,11 @@ Badge(value: {value: string, position?: BadgePosition, style?: BadgeStyle}) | badgeColor | Color | 否 | Color.Red | badge的颜色。 | - BadgePosition枚举说明 - | 名称 | 描述 | + | 名称 | 描述 | | -------- | -------- | - | Right | 圆点显示在右侧纵向居中。 | - | RightTop | 圆点显示在右上角。 | - | Left | 圆点显示在左侧纵向居中。 | + | Right | 圆点显示在右侧纵向居中。 | + | RightTop | 圆点显示在右上角。 | + | Left | 圆点显示在左侧纵向居中。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-flex.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-flex.md index da30cdcf9abb5cd091b8fae77c2ab29c3392ad9d..8cf11c00aebb020da33014a16a1bd50bce0ccabb 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-flex.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-flex.md @@ -1,12 +1,11 @@ # Flex +应用弹性方式布局子组件的容器组件。 + > **说明：** > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -弹性布局组件。 - - ## 权限列表 无 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-refresh.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-refresh.md index a9c22363adf16b105235897581f98a12b0eeeeeb..df2ace39644d48184188f66496ca8e03e40b48ed 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-refresh.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-refresh.md @@ -1,10 +1,10 @@ # Refresh + 可以进行页面下拉操作并显示刷新动效的容器组件。 + > **说明：** > 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -下拉刷新容器。 - ## 权限列表 无 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 9c2b8cb1960bbbee4f081d0e55bde733c761c23b..70d9312592886a74b4600f6c0c1d58a17253365a 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 @@ -1,12 +1,11 @@ # Circle + 用于绘制圆形的组件。 + > **说明：** > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -圆形绘制组件。 - - ## 权限列表 无 @@ -27,18 +26,18 @@ Circle(options?: {width: Length, height: Length}) | options | Object | 否 | - | 见options参数说明。 | - options参数说明 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | + | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | - | width | Length | 是 | - | 宽度。 | - | height | Length | 是 | - | 高度。 | + | width | Length | 是 | - | 宽度。 | + | height | Length | 是 | - | 高度。 | ## 属性 -| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 | +| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | -| width | Length | 0 | 否 | 圆所在矩形的宽度。 | -| height | Length | 0 | 否 | 圆所在矩形的高度。 | +| width | Length | 0 | 否 | 圆所在矩形的宽度。 | +| height | Length | 0 | 否 | 圆所在矩形的高度。 | ## 示例 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 4bb719c6d48dff1cbf1137db9703133dd1c13134..a29438b26c85c635e234f188e04c77de2b13cbfc 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 @@ -1,5 +1,7 @@ # 显式动画 +提供显示动画接口。 + > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 @@ -12,20 +14,20 @@ ## AnimationOptions对象说明 - 属性 - | 属性名称 | 属性类型 | 默认值 | 描述 | + | 属性名称 | 属性类型 | 默认值 | 描述 | | -------- | -------- | -------- | -------- | - | duration | number | 1000 | 动画持续时间，单位为毫秒。 | - | tempo | number | 1.0 | 动画的播放速度，值越大动画播放越快，值越小播放越慢，为0时无动画效果。 | - | curve | Curve \| Curves | Linear | 动画曲线。 | - | delay | number | 0 | 单位为ms(毫秒)，默认不延时播放。 | - | iterations | number | 1 | 默认播放一次，设置为-1时表示无限次播放。 | - | playMode | PlayMode | Normal | 设置动画播放模式，默认播放完成后重头开始播放。 | + | duration | number | 1000 | 动画持续时间，单位为毫秒。 | + | tempo | number | 1.0 | 动画的播放速度，值越大动画播放越快，值越小播放越慢，为0时无动画效果。 | + | curve | Curve \| Curves | Linear | 动画曲线。 | + | delay | number | 0 | 单位为ms(毫秒)，默认不延时播放。 | + | iterations | number | 1 | 默认播放一次，设置为-1时表示无限次播放。 | + | playMode | PlayMode | Normal | 设置动画播放模式，默认播放完成后重头开始播放。 | - 接口 - | 名称 | 功能描述 | + | 名称 | 功能描述 | | -------- | -------- | - | onFinish() => void | 动效播放完成回调。 | + | onFinish() => void | 动效播放完成回调。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-gesture-settings.md b/zh-cn/application-dev/reference/arkui-ts/ts-gesture-settings.md index 50268acf5cdb0f46cfe5cb04d8124660b7880d27..dab1454385102a4f6ebbbb66456890008ee79860 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-gesture-settings.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-gesture-settings.md @@ -1,5 +1,7 @@ # 绑定手势方法 +为组件绑定不同类型的手势事件，并设置事件的响应方法。 + > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-interpolation-calculation.md b/zh-cn/application-dev/reference/arkui-ts/ts-interpolation-calculation.md index c7a34317a8f9bb653c03ce0cf84809c3ed8f09a5..f4c4626cb1f6ab0b4cad1b17065914ff5cf5ce61 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-interpolation-calculation.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-interpolation-calculation.md @@ -1,5 +1,7 @@ # 插值计算 +设置动画插值曲线，用于构造阶梯曲线对象、构造三阶贝塞尔曲线对象和构造弹簧曲线对象。 + > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 @@ -48,10 +50,10 @@ stepsCurve(count: number, end: boolean)：ICurve **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------- | ----| ------------------------------------------------------------ | - | count | number | 是 | 阶梯的数量，需要为正整数。 | - | end | boolean | 是 | 在每个间隔的起点或是终点发生阶跃变化。
-true：在终点发生阶跃变化。
-false:在起点发生阶跃变化。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------- | ----| ------------------------------------------------------------ | +| count | number | 是 | 阶梯的数量，需要为正整数。 | +| end | boolean | 是 | 在每个间隔的起点或是终点发生阶跃变化。
-true：在终点发生阶跃变化。
-false:在起点发生阶跃变化。 | **返回值：** @@ -77,12 +79,12 @@ cubicBezierCurve(x1: number, y1: number, x2: number, y2: number)：ICurve **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | -------------- | - | x1 | number | 是 | 确定贝塞尔曲线第一点横坐标。 | - | y1 | number | 是 | 确定贝塞尔曲线第一点纵坐标。 | - | x2 | number | 是 | 确定贝塞尔曲线第二点横坐标。 | - | y2 | number | 是 | 确定贝塞尔曲线第二点纵坐标。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | -------------- | +| x1 | number | 是 | 确定贝塞尔曲线第一点横坐标。 | +| y1 | number | 是 | 确定贝塞尔曲线第一点纵坐标。 | +| x2 | number | 是 | 确定贝塞尔曲线第二点横坐标。 | +| y2 | number | 是 | 确定贝塞尔曲线第二点纵坐标。 | **返回值：** @@ -185,10 +187,10 @@ steps(count: number, end: boolean): string **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------- | ----| ------------------------------------------------------------ | - | count | number | 是 | 阶梯的数量，需要为正整数。 | - | end | boolean | 是 | 在每个间隔的起点或是终点发生阶跃变化。
-true：在终点发生阶跃变化。
-false:在起点发生阶跃变化。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------- | ----| ------------------------------------------------------------ | +| count | number | 是 | 阶梯的数量，需要为正整数。 | +| end | boolean | 是 | 在每个间隔的起点或是终点发生阶跃变化。
-true：在终点发生阶跃变化。
-false:在起点发生阶跃变化。 | ## Curves.cubicBezier(deprecated) @@ -200,12 +202,12 @@ cubicBezier(x1: number, y1: number, x2: number, y2: number): string **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | -------------- | - | x1 | number | 是 | 确定贝塞尔曲线第一点横坐标。 | - | y1 | number | 是 | 确定贝塞尔曲线第一点纵坐标。 | - | x2 | number | 是 | 确定贝塞尔曲线第二点横坐标。 | - | y2 | number | 是 | 确定贝塞尔曲线第二点纵坐标。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | -------------- | +| x1 | number | 是 | 确定贝塞尔曲线第一点横坐标。 | +| y1 | number | 是 | 确定贝塞尔曲线第一点纵坐标。 | +| x2 | number | 是 | 确定贝塞尔曲线第二点横坐标。 | +| y2 | number | 是 | 确定贝塞尔曲线第二点纵坐标。 | ## Curves.spring(deprecated) @@ -227,21 +229,21 @@ spring(velocity: number, mass: number, stiffness: number, damping: number): stri ## Curve枚举说明 - | 名称 | 描述 | - | ------------------- | ---------------------------------------- | - | Linear | 表示动画从头到尾的速度都是相同的。 | - | Ease | 表示动画以低速开始，然后加快，在结束前变慢，CubicBezier(0.25, 0.1, 0.25, 1.0)。 | - | EaseIn | 表示动画以低速开始，CubicBezier(0.42, 0.0, 1.0, 1.0)。 | - | EaseOut | 表示动画以低速结束，CubicBezier(0.0, 0.0, 0.58, 1.0)。 | - | EaseInOut | 表示动画以低速开始和结束，CubicBezier(0.42, 0.0, 0.58, 1.0)。 | - | FastOutSlowIn | 标准曲线，cubic-bezier(0.4, 0.0, 0.2, 1.0)。 | - | LinearOutSlowIn | 减速曲线，cubic-bezier(0.0, 0.0, 0.2, 1.0)。 | - | FastOutLinearIn | 加速曲线，cubic-bezier(0.4, 0.0, 1.0, 1.0)。 | - | ExtremeDeceleration | 急缓曲线，cubic-bezier(0.0, 0.0, 0.0, 1.0)。 | - | Sharp | 锐利曲线，cubic-bezier(0.33, 0.0, 0.67, 1.0)。 | - | Rhythm | 节奏曲线，cubic-bezier(0.7, 0.0, 0.2, 1.0)。 | - | Smooth | 平滑曲线，cubic-bezier(0.4, 0.0, 0.4, 1.0)。 | - | Friction | 阻尼曲线，CubicBezier(0.2, 0.0, 0.2, 1.0)。 | +| 名称 | 描述 | +| ------------------- | ---------------------------------------- | +| Linear | 表示动画从头到尾的速度都是相同的。 | +| Ease | 表示动画以低速开始，然后加快，在结束前变慢，CubicBezier(0.25, 0.1, 0.25, 1.0)。 | +| EaseIn | 表示动画以低速开始，CubicBezier(0.42, 0.0, 1.0, 1.0)。 | +| EaseOut | 表示动画以低速结束，CubicBezier(0.0, 0.0, 0.58, 1.0)。 | +| EaseInOut | 表示动画以低速开始和结束，CubicBezier(0.42, 0.0, 0.58, 1.0)。 | +| FastOutSlowIn | 标准曲线，cubic-bezier(0.4, 0.0, 0.2, 1.0)。 | +| LinearOutSlowIn | 减速曲线，cubic-bezier(0.0, 0.0, 0.2, 1.0)。 | +| FastOutLinearIn | 加速曲线，cubic-bezier(0.4, 0.0, 1.0, 1.0)。 | +| ExtremeDeceleration | 急缓曲线，cubic-bezier(0.0, 0.0, 0.0, 1.0)。 | +| Sharp | 锐利曲线，cubic-bezier(0.33, 0.0, 0.67, 1.0)。 | +| Rhythm | 节奏曲线，cubic-bezier(0.7, 0.0, 0.2, 1.0)。 | +| Smooth | 平滑曲线，cubic-bezier(0.4, 0.0, 0.4, 1.0)。 | +| Friction | 阻尼曲线，CubicBezier(0.2, 0.0, 0.2, 1.0)。 | ## 整体示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-matrix-transformation.md b/zh-cn/application-dev/reference/arkui-ts/ts-matrix-transformation.md index 8c8503e738bd5099df347f0c076002b78f2c2f47..0095e993f188030e0c556f7625545e51bb41654c 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-matrix-transformation.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-matrix-transformation.md @@ -1,5 +1,7 @@ # 矩阵变换 +可对图形进行平移、旋转和缩放等。 + > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 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 57560522f21108006925d703d87a778935d7fa39..97d6ef696cbb1785b6933fcb4ed0c9bb3952213a 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 @@ -1,10 +1,10 @@ # Video + 用于播放单个视频并控制其播放状态的组件。 + > **说明：** > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -视频播放组件。 - ## 权限列表 使用网络视频时，需要在config或者module.json对应的"abilities"中添加网络使用权限ohos.permission.INTERNET。 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-methods-menu.md b/zh-cn/application-dev/reference/arkui-ts/ts-methods-menu.md index e70e8054984458b912db148c89a09075145dec21..20e5fafc7e541a777b61d16ae3199c2fcae4d1fa 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-methods-menu.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-methods-menu.md @@ -1,5 +1,7 @@ # 菜单 +在页面范围内关闭通过[bindContextMenu](./ts-universal-attributes-menu.md#属性)属性绑定的菜单。 + > **说明：** > 从 API Version 8 开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 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 f4f688c4c3920a669da4b41e4ecbc39bceab8c96..f61b99891a8cc034ecbad6b070e984c44ae0484b 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,5 +1,7 @@ # 点击控制 +设置组件是否可触摸。 + > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-component-id.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-component-id.md index ed1cbf1ee69e60a89396f7fe0c6ca46cf6eb3888..b372ccc183263a9321011a8c6df308cd36fa6a6a 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-component-id.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-component-id.md @@ -13,9 +13,9 @@ id为组件的唯一标识，在整个应用内唯一。本模块提供组件标 ## 属性 -| 名称 | 参数说明 | 默认值 | 描述 | +| 名称 | 参数说明 | 默认值 | 描述 | | -------- | -------- | -------- | -------- | -| id | string | '' | 组件的唯一标识，唯一性由使用者保证。 | +| id | string | '' | 组件的唯一标识，唯一性由使用者保证。 | ## 接口 @@ -28,14 +28,14 @@ getInspectorByKey(id: string): string 获取指定id的组件的所有属性，不包括子组件信息。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | + | 参数 | 类型 | 必填 | 默认值 | 描述 | | -------- | -------- | -------- | -------- | -------- | - | id | string | 是 | - | 要获取属性的组件id。 | + | id | string | 是 | - | 要获取属性的组件id。 | - 返回值 - | 类型 | 描述 | + | 类型 | 描述 | | -------- | -------- | - | string | 组件属性列表的JSON字符串。 | + | string | 组件属性列表的JSON字符串。 | ### getInspectorTree @@ -56,16 +56,16 @@ sendEventByKey(id: string, action: number, params: string): boolean 给指定id的组件发送事件。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | + | 参数 | 类型 | 必填 | 默认值 | 描述 | | -------- | -------- | -------- | -------- | -------- | - | id | string | 是 | - | 要触发事件的组件的id。 | - | action | number | 是 | - | 要触发的事件类型，目前支持取值：
- 点击事件Click: 10
- 长按事件LongClick: 11。 | - | params | string | 是 | - | 事件参数，无参数传空字符串 ""。 | + | id | string | 是 | - | 要触发事件的组件的id。 | + | action | number | 是 | - | 要触发的事件类型，目前支持取值：
- 点击事件Click: 10
- 长按事件LongClick: 11。 | + | params | string | 是 | - | 事件参数，无参数传空字符串 ""。 | - 返回值 - | 类型 | 描述 | + | 类型 | 描述 | | -------- | -------- | - | boolean | 找不到指定id的组件时返回false，其余情况返回true。 | + | boolean | 找不到指定id的组件时返回false，其余情况返回true。 | ### sendTouchEvent 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 3c891de4cdd5a799a6301fb0fb654332c07116dc..1381d68ed4cf5533c760dd1a293cc36076510321 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,5 +1,7 @@ # 禁用控制 +可交互状态下组件响应点击事件。 + > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 @@ -12,9 +14,9 @@ ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | +| 名称 | 参数类型 | 默认值 | 描述 | | -------- | -------- | -------- | -------- | -| enabled | boolean | true | 值为true表示组件可用，可响应点击等操作；值为false时，不响应点击等操作。 | +| enabled | boolean | true | 值为true表示组件可用，可响应点击等操作；值为false时，不响应点击等操作。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-focus.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-focus.md index 80027036fcb21f5c533b65d27b89824c8c055bf9..4709e6c5b4807df9551cd60bab96c20354e68bf8 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-focus.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-focus.md @@ -1,5 +1,7 @@ # 焦点控制 +自定义组件的走焦效果，可设置组件是否走焦和具体的走焦顺序，tab键或者方向键切换焦点。 + > **说明：** > 从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 @@ -11,9 +13,9 @@ ## 属性 -| **名称** | **参数类型** | **默认值** | **描述** | +| **名称** | **参数类型** | **默认值** | **描述** | | -------- | -------- | -------- | -------- | -| focusable | boolean | false | 设置当前组件是否可以获焦。 | +| focusable | boolean | false | 设置当前组件是否可以获焦。 | | tabIndex9+ | number | 0 | 自定义组件tab键走焦能力，走焦顺序为：tabIndex大于0的组件依次递增走焦, tabIndex等于0的组件按组件树先后顺序走焦。
- tabIndex >= 0：表示元素是可聚焦的，并且可以通过tab键走焦来访问到该元素，按照tabIndex的数值递增而先后获焦。如果多个元素拥有相同的tabIndex，按照元素在当前组件树中的先后顺序获焦
- tabIndex < 0（通常是tabIndex = -1）：表示元素是可聚焦的，但是不能通过tab键走焦来访问到该元素 | > **说明：** 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 a5849cf6525ed8f4647184eb3821af45c7090d31..c2ccb7bf9bf00de306bcffeac847361bc76f5885 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 @@ -1,5 +1,7 @@ # 颜色渐变 +设置组件的颜色渐变效果。 + > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 @@ -22,17 +24,17 @@ - GradientDirection枚举说明
GradientDirection用于描述渐变方向。 - | 名称 | 描述 | + | 名称 | 描述 | | -------- | -------- | - | Left | 从右向左。 | - | Top | 从下向上。 | - | Right | 从左向右。 | - | Bottom | 从上向下。 | - | LeftTop | 左上。 | - | LeftBottom | 左下。 | - | RightTop | 右上。 | - | RightBottom | 右下。 | - | None | 无。 | + | Left | 从右向左。 | + | Top | 从下向上。 | + | Right | 从左向右。 | + | Bottom | 从上向下。 | + | LeftTop | 左上。 | + | LeftBottom | 左下。 | + | RightTop | 右上。 | + | RightBottom | 右下。 | + | None | 无。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-hover-effect.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-hover-effect.md index 5ff1536cc78f199d202aa3bcb207df5656930f42..ba2fd891c3258f400766f0d51864d1d213f7a83d 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-hover-effect.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-hover-effect.md @@ -1,5 +1,7 @@ # 悬浮态效果 +设置组件的鼠标悬浮态显示效果。 + > **说明：** > 从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 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 ffd9610886f7557f16920fa56744e828dc3e5535..e7e0a8eaef78ba7020faefba9c16a8947bfd4dd1 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 @@ -1,5 +1,7 @@ # 图像效果 +例如背景模糊、内容模糊和灰度效果等。 + > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-layout-constraints.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-layout-constraints.md index 23a1f4329db73c2f9b262e2f56f49239d331df8c..ac3fb457b4bdf6fa77fd06467393064e71253af4 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-layout-constraints.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-layout-constraints.md @@ -1,5 +1,7 @@ # 布局约束 +通过组件的宽高比和显示优先级约束组件显示效果。 + > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 @@ -12,10 +14,10 @@ ## 属性 -| 名称 | 参数说明 | 默认值 | 描述 | +| 名称 | 参数说明 | 默认值 | 描述 | | -------- | -------- | -------- | -------- | -| aspectRatio | number | - | 指定当前组件的宽高比。 | -| displayPriority | number | - | 设置当前组件在布局容器中显示的优先级，当父容器空间不足时，低优先级的组件会被隐藏。
>  **说明：**
> 仅在Row/Column/Flex(单行)容器组件中生效。 | +| aspectRatio | number | - | 指定当前组件的宽高比。 | +| displayPriority | number | - | 设置当前组件在布局容器中显示的优先级，当父容器空间不足时，低优先级的组件会被隐藏。
>  **说明：**
> 仅在Row/Column/Flex(单行)容器组件中生效。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-location.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-location.md index 8b10308acc70b1fd271d0b1d80c67ec4ee50fd7c..5f7430a51ddcff6391a9ca61173464fd98b0804a 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-location.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-location.md @@ -1,5 +1,7 @@ # 位置设置 +设置组件的对齐方式、布局方向和显示位置。 + > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 @@ -22,11 +24,11 @@ - Direction枚举说明 - | 名称 | 描述 | + | 名称 | 描述 | | -------- | -------- | - | Ltr | 元素从左到右布局。 | - | Rtl | 元素从右到左布局。 | - | Auto | 使用系统默认布局方向。 | + | Ltr | 元素从左到右布局。 | + | Rtl | 元素从右到左布局。 | + | Auto | 使用系统默认布局方向。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-menu.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-menu.md index 6be5562c698e85489097c4da40431179be2f3de3..9bda919e8809d0f8ec0fc400daca3814d252d72f 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-menu.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-menu.md @@ -1,5 +1,7 @@ # Menu控制 +为组件绑定弹出式菜单，弹出式菜单以垂直列表形式显示菜单项，可通过长按、点击或鼠标右键触发。 + > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 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 36d01e74f0e60ee8f2dcaf55e20a6d44df689d81..c7f3b9a1e64db48ca56dbf6e21358da6d96b36bf 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 @@ -1,5 +1,7 @@ # 浮层 +设置组件的遮罩文本。 + > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-popup.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-popup.md index b69cf78e7c8062cedc22de31d2b6653c3e5f1d8a..1e1448d039f1369edd0489abe6161cc163f781b6 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-popup.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-popup.md @@ -1,5 +1,7 @@ # Popup控制 +设置组件点击时弹出的气泡框状态。 + > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 @@ -18,13 +20,13 @@ - PopupOptions类型接口说明 - | 名称 | 类型 | 必填 | 默认值 | 描述 | + | 名称 | 类型 | 必填 | 默认值 | 描述 | | -------- | -------- | -------- | -------- | -------- | - | message | string | 是 | - | 弹窗信息内容。 | - | placementOnTop | boolean | 否 | false | 是否在组件上方显示，默认值为false。 | - | primaryButton | {
value: string,
action: () => void
} | 否 | - | 第一个按钮。
value: 弹窗里主按钮的文本。
action: 点击主按钮的回调函数。 | - | secondaryButton | {
value: string,
action: () => void
} | 否 | - | 第二个按钮。
value: 弹窗里辅助按钮的文本。
action: 点击辅助按钮的回调函数。 | - | onStateChange | (isVisible: boolean) => void | 否 | - | 弹窗状态变化事件回调，参数isVisible为弹窗当前的显示状态。 | + | message | string | 是 | - | 弹窗信息内容。 | + | placementOnTop | boolean | 否 | false | 是否在组件上方显示，默认值为false。 | + | primaryButton | {
value: string,
action: () => void
} | 否 | - | 第一个按钮。
value: 弹窗里主按钮的文本。
action: 点击主按钮的回调函数。 | + | secondaryButton | {
value: string,
action: () => void
} | 否 | - | 第二个按钮。
value: 弹窗里辅助按钮的文本。
action: 点击辅助按钮的回调函数。 | + | onStateChange | (isVisible: boolean) => void | 否 | - | 弹窗状态变化事件回调，参数isVisible为弹窗当前的显示状态。 | - CustomPopupOptions8+类型接口说明 | 名称 | 类型 | 必填 | 默认值 | 描述 | 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 30dda4ed7ef182ed965b8974543361ce14ce6e7a..4f8390195044e7e3f82476589c978108a948018a 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 @@ -1,5 +1,7 @@ # 形状裁剪 +用于对组件进行裁剪、遮罩处理。 + > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 @@ -12,10 +14,10 @@ ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | +| 名称 | 参数类型 | 默认值 | 描述 | | -------- | -------- | -------- | -------- | -| clip | Shape \| boolean | false | 参数为Shape类型时，按指定的形状对当前组件进行裁剪；参数为boolean类型时，设置是否按照边缘轮廓进行裁剪。 | -| mask | Shape | - | 在当前组件上加上指定形状的遮罩。 | +| clip | Shape \| boolean | false | 参数为Shape类型时，按指定的形状对当前组件进行裁剪；参数为boolean类型时，设置是否按照边缘轮廓进行裁剪。 | +| mask | Shape | - | 在当前组件上加上指定形状的遮罩。 | ## 示例 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 99e4e5b2864a0c5b9bab53b42eb0dfca5e50eec6..7e5929486da6248cb9b6c8cfc01c932e58c2aa68 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 @@ -1,5 +1,7 @@ # 尺寸设置 +用于设置组件的宽高、边距等显示尺寸进行设置。 + > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-transformation.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-transformation.md index f1c71c494574e8e2280cc6effb61d273daf8bed8..e935176de2dc21f49a97990cdde9dc03e5549799 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-transformation.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-transformation.md @@ -1,5 +1,7 @@ # 图形变换 +用于对组件进行旋转、平移、缩放、矩阵变换等操作。 + > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-visibility.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-visibility.md index f103cc63eeed6700fa06ae59456326b8d944a79f..c6cdc3e4c94058689933bbeacbedc293ed35af57 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-visibility.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-visibility.md @@ -1,5 +1,7 @@ # 显隐控制 +控制组件是否可见。 + > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 @@ -18,11 +20,11 @@ - Visibility枚举说明 - | 名称 | 描述 | + | 名称 | 描述 | | -------- | -------- | - | Hidden | 隐藏，但参与布局进行占位。 | - | Visible | 显示。 | - | None | 隐藏，但不参与布局，不进行占位。 | + | Hidden | 隐藏，但参与布局进行占位。 | + | Visible | 显示。 | + | None | 隐藏，但不参与布局，不进行占位。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-z-order.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-z-order.md index bdbcbda0d38fa463873520bbc738f8a86150b62d..a9858490e745609b02b4f18e0ef25c53138af706 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-z-order.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-z-order.md @@ -1,5 +1,7 @@ # Z序控制 +组件的Z序，指明了该组件在堆叠组件中的位置。 + > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 @@ -12,9 +14,9 @@ ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | +| 名称 | 参数类型 | 默认值 | 描述 | | -------- | -------- | -------- | -------- | -| zIndex | number | 0 | 同一容器中兄弟组件显示层级关系，z值越大，显示层级越高。 | +| zIndex | number | 0 | 同一容器中兄弟组件显示层级关系，z值越大，显示层级越高。 | ## 示例 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 7e2eed43be86d0c974965be9f38d3de6e0710617..290515df466fb954f78ed884ebb4282d68283a09 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 @@ -1,5 +1,7 @@ # 组件区域变化事件 +组件区域变化事件指组件显示的尺寸、位置等发生变化时触发的事件。 + > **说明：** > 从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 @@ -11,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对象](ts-universal-events-click.md)介绍。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-click.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-click.md index 54b6b01f3ede7ddaf4c2ed815b2e72ecc35026a0..ae2bda63aad1304b7cc1211fc3ff723daf3c2616 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-click.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-click.md @@ -1,8 +1,17 @@ # 点击事件 +点击事件指组件被点击时触发的事件。 + > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 +## 支持设备 + +| 手机 | 平板 | 智慧屏 | 智能穿戴 | +| ---- | ---- | ------ | -------- | +| 支持 | 支持 | 不支持 | 不支持 | + + ## 权限列表 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 a845085f5e097a930fa9b4f41e7972fe5a86ab97..df5c75ae00ce2bc9fee1b463d0d8409e406bc825 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 @@ -1,5 +1,7 @@ # 拖拽事件 +拖拽事件指被长按后拖拽时触发的事件。 + > **说明：** > 从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-key.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-key.md index c395fff5bf5063607a475181f74d380729a951c0..4488aeb52c7ad1235b8df921e4815b16718afdc8 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-key.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-key.md @@ -1,5 +1,7 @@ # 按键事件 +按键事件指组件与键盘、遥控器等按键设备交互时触发的事件。 + > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-show-hide.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-show-hide.md index 76af7f4a6cd5ae15cb585234ccd9421586458d19..b84246cdf3008cac0dbeca2f383919588d76c68c 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-show-hide.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-show-hide.md @@ -1,5 +1,7 @@ # 挂载卸载事件 +挂载卸载事件指组件从组件树上挂载、卸载时触发的事件。 + > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-touch.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-touch.md index 4745e9e02cb7669f1f7a85fec8428efabf449122..d557008e7ecd1fcab915fa62e46d496c9e65cece 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-touch.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-touch.md @@ -1,5 +1,7 @@ # 触摸事件 +当手指放在组件上、滑动或从组件上移开时触发。 + > **说明：** > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-focus-event.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-focus-event.md index 9d03181aad6a16eb5a2f09e62c44e222e1fdf917..c3a261fca5b8f99f791a7d77b9eaa63d333d4774 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-focus-event.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-focus-event.md @@ -1,5 +1,7 @@ # 焦点事件 +焦点事件指页面焦点在组件间移动时触发的事件，组件可使用焦点事件来更改内容。 + > **说明：** > 从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 @@ -11,10 +13,10 @@ ## 事件 -| **名称** | **支持冒泡** | **功能描述** | +| **名称** | **支持冒泡** | **功能描述** | | -------- | -------- | -------- | -| onFocus(callback: () => void) | 否 | 当前组件获取焦点时触发的回调。 | -| onBlur(callback:() => void) | 否 | 当前组件失去焦点时触发的回调。 | +| onFocus(callback: () => void) | 否 | 当前组件获取焦点时触发的回调。 | +| onBlur(callback:() => void) | 否 | 当前组件失去焦点时触发的回调。 | > **说明：** > 支持焦点事件的组件：Button、Text、Image、List、Grid。 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-mouse-key.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-mouse-key.md index febe01ccc186e38bb1bebc8a0f1b9524b54227ef..e4c803903726c7c261edc32b9abbceea1b0d2630 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-mouse-key.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-mouse-key.md @@ -1,5 +1,7 @@ # 鼠标事件 +在单个动作触发多个事件时，事件的顺序是固定的，遵循xxx的顺序调用处理程序。 + > **说明：** > 从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 diff --git a/zh-cn/device-dev/quick-start/figures/zh-cn_image_0000001227757036.png b/zh-cn/device-dev/quick-start/figures/zh-cn_image_0000001227757036.png index eead40cd3f889b23f73a6f02a9b7f44c822c2e37..dea8677bfd7c9ba3f7b82f00c8422d695f85b86b 100644 Binary files a/zh-cn/device-dev/quick-start/figures/zh-cn_image_0000001227757036.png and b/zh-cn/device-dev/quick-start/figures/zh-cn_image_0000001227757036.png differ diff --git a/zh-cn/device-dev/quick-start/figures/zh-cn_image_0000001265676877.png b/zh-cn/device-dev/quick-start/figures/zh-cn_image_0000001265676877.png index 1c6cd44560eb87ed1d97528add4c632e4d4f5f9d..f467c1b45f84730fd3fc45158004d9a03dec2551 100644 Binary files a/zh-cn/device-dev/quick-start/figures/zh-cn_image_0000001265676877.png and b/zh-cn/device-dev/quick-start/figures/zh-cn_image_0000001265676877.png differ