diff --git a/en/application-dev/reference/apis/js-apis-mediaquery.md b/en/application-dev/reference/apis/js-apis-mediaquery.md
index 7cb3263efc4800810a185bf908ae98fef33808ec..1f754aa69bee3f93a3420df473d06e915a673c4f 100644
--- a/en/application-dev/reference/apis/js-apis-mediaquery.md
+++ b/en/application-dev/reference/apis/js-apis-mediaquery.md
@@ -1,12 +1,13 @@
# Media Query
-> ![icon-note.gif](public_sys-resources/icon-note.gif)**NOTE**
+> **NOTE**
+>
> The APIs of this module are supported since API version 7. Updates will be marked with a superscript to indicate their earliest API version.
## Modules to Import
-```
+```js
import mediaquery from '@ohos.mediaquery'
```
@@ -22,19 +23,19 @@ matchMediaSync(condition: string): MediaQueryListener
Sets the media query criteria and returns the corresponding listening handle.
-- Parameters
- | Name| Type| Mandatory| Description|
- | -------- | -------- | -------- | -------- |
- | condition | string | Yes| Matching condition of a media event.|
+**Parameters**
+| Name | Type | Mandatory | Description |
+| --------- | ------ | ---- | ---------- |
+| condition | string | Yes | Matching condition of a media event.|
-- Return value
- | Type| Description|
- | -------- | -------- |
- | MediaQueryListener | Listening handle to a media event, which is used to register or unregister the listening callback.|
+**Return value**
+| Type | Description |
+| ------------------ | ---------------------- |
+| MediaQueryListener | Listening handle to a media event, which is used to register or unregister the listening callback.|
-- Example
- ```
- listener = mediaquery.matchMediaSync('(orientation: landscape)'); // Listen for landscape events.
+**Example**
+ ```js
+listener = mediaquery.matchMediaSync('(orientation: landscape)'); // Listen for landscape events.
```
@@ -45,10 +46,10 @@ Media query handle, including the first query result when the handle is applied
### Attributes
-| Name| Type| Readable| Writable| Description|
-| -------- | -------- | -------- | -------- | -------- |
-| matches | boolean | Yes| No| Whether the match condition is met.|
-| media | string | Yes| No| Matching condition of a media event.|
+| Name | Type | Readable | Writable | Description |
+| ------- | ------- | ---- | ---- | ---------- |
+| matches | boolean | Yes | No | Whether the match condition is met. |
+| media | string | Yes | No | Matching condition of a media event.|
### on
@@ -57,13 +58,13 @@ on(type: 'change', callback: Callback<MediaQueryResult>): void
Registers a callback with the corresponding query condition by using the handle. This callback is triggered when the media attributes change.
-- Parameters
- | Name| Type| Mandatory| Description|
- | -------- | -------- | -------- | -------- |
- | type | string | Yes| Must enter the string **change**.|
- | callback | Callback<MediaQueryResult> | Yes| Callback registered with media query.|
+**Parameters**
+| Name | Type | Mandatory | Description |
+| -------- | -------------------------------- | ---- | ---------------- |
+| type | string | Yes | Must enter the string **change**.|
+| callback | Callback<MediaQueryResult> | Yes | Callback registered with media query. |
-- Example
+**Example**
For details, see [off Example](#off).
@@ -72,14 +73,14 @@ Registers a callback with the corresponding query condition by using the handle.
off(type: 'change', callback?: Callback<MediaQueryResult>): void
Unregisters a callback with the corresponding query condition by using the handle, so that no callback is triggered when the media attributes change.
-- Parameters
- | Name| Type| Mandatory| Description|
- | -------- | -------- | -------- | -------- |
- | type | boolean | Yes| Must enter the string **change**.|
- | callback | Callback<MediaQueryResult> | No| Callback to be unregistered. If the default value is used, all callbacks of the handle are unregistered.|
-
-- Example
- ```
+**Parameters**
+| Name | Type | Mandatory | Description |
+| -------- | -------------------------------- | ---- | ----------------------------- |
+| type | boolean | Yes | Must enter the string **change**. |
+| callback | Callback<MediaQueryResult> | No | Callback to be unregistered. If the default value is used, all callbacks of the handle are unregistered.|
+
+**Example**
+ ```js
import mediaquery from '@ohos.mediaquery'
listener = mediaquery.matchMediaSync('(orientation: landscape)'); // Listen for landscape events.
@@ -90,8 +91,8 @@ Unregisters a callback with the corresponding query condition by using the handl
// do something here
}
}
- this.listener.on('change', this.onPortrait) // Registration callback.
- this.listener.off('change', this.onPortrait) // Deregistration callback.
+ listener.on('change', onPortrait) // Register a callback.
+ listener.off('change', onPortrait) // Unregister a callback.
```
@@ -100,15 +101,15 @@ Unregisters a callback with the corresponding query condition by using the handl
### Attributes
-| Name| Type| Readable| Writable| Description|
-| -------- | -------- | -------- | -------- | -------- |
-| matches | boolean | Yes| No| Whether the match condition is met.|
-| media | string | Yes| No| Matching condition of a media event.|
+| Name | Type | Readable | Writable | Description |
+| ------- | ------- | ---- | ---- | ---------- |
+| matches | boolean | Yes | No | Whether the match condition is met. |
+| media | string | Yes | No | Matching condition of a media event.|
### Example
-```
+```js
import mediaquery from '@ohos.mediaquery'
let portraitFunc = null
diff --git a/en/application-dev/reference/apis/js-apis-sensor.md b/en/application-dev/reference/apis/js-apis-sensor.md
index b038cd0f9b2e376b6e2d76fe096c1d4d9aefec13..aab544f7f78bd2b755ab24443aa1d0acd5d683c1 100644
--- a/en/application-dev/reference/apis/js-apis-sensor.md
+++ b/en/application-dev/reference/apis/js-apis-sensor.md
@@ -11,8 +11,9 @@
import sensor from '@ohos.sensor';
```
+## sensor.on
-## sensor.on(SensorType.SENSOR_TYPE_ID_ACCELEROMETER)
+### ACCELEROMETER
on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback<AccelerometerResponse>,options?: Options): void
@@ -41,8 +42,7 @@ Subscribes to data changes of the acceleration sensor. If this API is called mul
);
```
-
-## sensor.on(SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION)
+### LINEAR_ACCELERATION
on(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback<LinearAccelerometerResponse>, options?: Options): void
@@ -70,8 +70,7 @@ Subscribes to data changes of the linear acceleration sensor. If this API is cal
);
```
-
-## sensor.on(SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED)
+### ACCELEROMETER_UNCALIBRATED
on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callback<AccelerometerUncalibratedResponse>, options?: Options): void
@@ -102,8 +101,7 @@ Subscribes to data changes of the uncalibrated acceleration sensor. If this API
);
```
-
-## sensor.on(SensorType.SENSOR_TYPE_ID_GRAVITY)
+### GRAVITY
on(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: Callback<GravityResponse>,options?: Options): void
@@ -129,8 +127,7 @@ Subscribes to data changes of the gravity sensor. If this API is called multiple
);
```
-
-## sensor.on(SensorType.SENSOR_TYPE_ID_GYROSCOPE)
+### GYROSCOPE
on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback<GyroscopeResponse>, options?: Options): void
@@ -158,8 +155,7 @@ Subscribes to data changes of the gyroscope sensor. If this API is called multip
);
```
-
-## sensor.on(SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED)
+### GYROSCOPE_UNCALIBRATED
on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback:Callback<GyroscopeUncalibratedResponse>, options?: Options): void
@@ -190,8 +186,7 @@ Subscribes to data changes of the uncalibrated gyroscope sensor. If this API is
);
```
-
-## sensor.on(SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION)
+### SIGNIFICANT_MOTION
on(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback: Callback<SignificantMotionResponse>, options?: Options): void
@@ -215,8 +210,7 @@ Subscribes to data changes of the significant motion sensor. If this API is call
);
```
-
-## sensor.on(SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION)
+### PEDOMETER_DETECTION
on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback: Callback<PedometerDetectionResponse>, options?: Options): void
@@ -242,8 +236,7 @@ Subscribes to data changes of the pedometer detection sensor. If this API is cal
);
```
-
-## sensor.on(SensorType.SENSOR_TYPE_ID_PEDOMETER)
+### PEDOMETER
on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: Callback<PedometerResponse>, options?: Options): void
@@ -269,8 +262,7 @@ Subscribes to data changes of the pedometer sensor. If this API is called multip
);
```
-
-## sensor.on(SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE)
+### AMBIENT_TEMPERATURE
on(type:SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback:Callback<AmbientTemperatureResponse>, options?: Options): void
@@ -294,8 +286,7 @@ Subscribes to data changes of the ambient temperature sensor. If this API is cal
);
```
-
-## sensor.on(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD)
+### MAGNETIC_FIELD
on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback<MagneticFieldResponse>,options?: Options): void
@@ -321,8 +312,7 @@ Subscribes to data changes of the magnetic field sensor. If this API is called m
);
```
-
-## sensor.on(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED)
+### MAGNETIC_FIELD_UNCALIBRATED
on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback: Callback<MagneticFieldUncalibratedResponse>, options?: Options): void
@@ -351,8 +341,7 @@ Subscribes to data changes of the uncalibrated magnetic field sensor. If this AP
);
```
-
-## sensor.on(SensorType.SENSOR_TYPE_ID_PROXIMITY)
+### PROXIMITY
on(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: Callback<ProximityResponse>,options?: Options): void
@@ -376,8 +365,7 @@ Subscribes to data changes of the proximity sensor. If this API is called multip
);
```
-
-## sensor.on(SensorType.SENSOR_TYPE_ID_HUMIDITY)
+### HUMIDITY
on(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: Callback<HumidityResponse>,options?: Options): void
@@ -401,8 +389,7 @@ Subscribes to data changes of the humidity sensor. If this API is called multipl
);
```
-
-## sensor.on(SensorType.SENSOR_TYPE_ID_BAROMETER)
+### BAROMETER
on(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: Callback<BarometerResponse>,options?: Options): void
@@ -426,8 +413,7 @@ Subscribes to data changes of the barometer sensor. If this API is called multip
);
```
-
-## sensor.on(SensorType.SENSOR_TYPE_ID_HALL)
+### HALL
on(type: SensorType.SENSOR_TYPE_ID_HALL, callback: Callback<HallResponse>, options?: Options): void
@@ -451,8 +437,7 @@ Subscribes to data changes of the Hall effect sensor. If this API is called mult
);
```
-
-## sensor.on(SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT)
+### AMBIENT_LIGHT
on(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: Callback<LightResponse>, options?: Options): void
@@ -476,8 +461,7 @@ Subscribes to data changes of the ambient light sensor. If this API is called mu
);
```
-
-## sensor.on(SensorType.SENSOR_TYPE_ID_ORIENTATION)
+### ORIENTATION
on(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback<OrientationResponse>, options?: Options): void
@@ -503,7 +487,7 @@ Subscribes to data changes of the orientation sensor. If this API is called mult
);
```
-## sensor.on(SensorType.SENSOR_TYPE_ID_HEART_RATE)
+### HEART_RATE
on(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: Callback<HeartRateResponse>, options?: Options): void
@@ -530,7 +514,7 @@ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HEART_RATE,function(data){
);
```
-## sensor.on(SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR)
+### ROTATION_VECTOR
on(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR,callback: Callback<RotationVectorResponse>,options?: Options): void
@@ -557,8 +541,7 @@ Subscribes to data changes of the rotation vector sensor. If this API is called
);
```
-
-## sensor.on(SensorType.SENSOR_TYPE_ID_WEAR_DETECTION)
+### WEAR_DETECTION
on(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: Callback<WearDetectionResponse>,options?: Options): void
@@ -582,8 +565,9 @@ Subscribes to data changes of the wear detection sensor. If this API is called m
);
```
+## sensor.once
-## sensor.once(SensorType.SENSOR_TYPE_ID_ACCELEROMETER)
+### ACCELEROMETER
once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback<AccelerometerResponse>): void
@@ -609,8 +593,7 @@ Subscribes to only one data change of the acceleration sensor.
);
```
-
-## sensor.once(SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION)
+### LINEAR_ACCELERATION
once(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback<LinearAccelerometerResponse>): void
@@ -636,8 +619,7 @@ Subscribes to only one data change of the linear acceleration sensor.
);
```
-
-## sensor.once(SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED)
+### ACCELEROMETER_UNCALIBRATED
once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callback<AccelerometerUncalibratedResponse>): void
@@ -666,8 +648,7 @@ Subscribes to only one data change of the uncalibrated acceleration sensor.
);
```
-
-## sensor.once(SensorType.SENSOR_TYPE_ID_GRAVITY)
+### GRAVITY
once(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: Callback<GravityResponse>): void
@@ -691,8 +672,7 @@ Subscribes to only one data change of the gravity sensor.
);
```
-
-## sensor.once(SensorType.SENSOR_TYPE_ID_GYROSCOPE)
+### GYROSCOPE
once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback<GyroscopeResponse>): void
@@ -718,8 +698,7 @@ Subscribes to only one data change of the gyroscope sensor.
);
```
-
-## sensor.once(SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED)
+### GYROSCOPE_UNCALIBRATED
once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback: Callback<GyroscopeUncalibratedResponse>): void
@@ -748,8 +727,7 @@ Subscribes to only one data change of the uncalibrated gyroscope sensor.
);
```
-
-## sensor.once(SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION)
+### SIGNIFICANT_MOTION
once(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION,callback: Callback<SignificantMotionResponse>): void
@@ -771,8 +749,7 @@ Subscribes to only one data change of the significant motion sensor.
);
```
-
-## sensor.once(SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION)
+### PEDOMETER_DETECTION
once(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION,callback: Callback<PedometerDetectionResponse>): void
@@ -796,8 +773,7 @@ Subscribes to only one data change of the pedometer detection sensor.
);
```
-
-## sensor.once(SensorType.SENSOR_TYPE_ID_PEDOMETER)
+### PEDOMETER
once(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: Callback<PedometerResponse>): void
@@ -821,8 +797,7 @@ Subscribes to only one data change of the pedometer sensor.
);
```
-
-## sensor.once(SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE)
+### AMBIENT_TEMPERATURE
once(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback: Callback<AmbientTemperatureResponse>): void
@@ -844,8 +819,7 @@ Subscribes to only one data change of the ambient temperature sensor.
);
```
-
-## sensor.once(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD)
+### MAGNETIC_FIELD
once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback<MagneticFieldResponse>): void
@@ -869,8 +843,7 @@ Subscribes to only one data change of the magnetic field sensor.
);
```
-
-## sensor.once(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED)
+### MAGNETIC_FIELD_UNCALIBRATED
once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback: Callback<MagneticFieldUncalibratedResponse>): void
@@ -897,8 +870,7 @@ Subscribes to only one data change of the uncalibrated magnetic field sensor.
);
```
-
-## sensor.once(SensorType.SENSOR_TYPE_ID_PROXIMITY)
+### PROXIMITY
once(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: Callback<ProximityResponse>): void
@@ -924,8 +896,7 @@ Subscribes to only one data change of the proximity sensor.
);
```
-
-## sensor.once(SensorType.SENSOR_TYPE_ID_HUMIDITY)
+### HUMIDITY
once(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: Callback<HumidityResponse>): void
@@ -947,8 +918,7 @@ Subscribes to only one data change of the humidity sensor.
);
```
-
-## sensor.once(SensorType.SENSOR_TYPE_ID_BAROMETER)
+### BAROMETER
once(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: Callback<BarometerResponse>): void
@@ -970,8 +940,7 @@ Subscribes to only one data change of the barometer sensor.
);
```
-
-## sensor.once(SensorType.SENSOR_TYPE_ID_HALL)
+### HALL
once(type: SensorType.SENSOR_TYPE_ID_HALL, callback: Callback<HallResponse>): void
@@ -993,8 +962,7 @@ Subscribes to only one data change of the Hall effect sensor.
);
```
-
-## sensor.once(SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT)
+### AMBIENT_LIGHT
once(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: Callback<LightResponse>): void
@@ -1016,8 +984,7 @@ Subscribes to only one data change of the ambient light sensor.
);
```
-
-## sensor.once(SensorType.SENSOR_TYPE_ID_ORIENTATION)
+### ORIENTATION
once(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback<OrientationResponse>): void
@@ -1041,8 +1008,7 @@ Subscribes to only one data change of the orientation sensor.
);
```
-
-## sensor.once(SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR)
+### ROTATION_VECTOR
once(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback: Callback<RotationVectorResponse>): void
@@ -1067,8 +1033,7 @@ Subscribes to only one data change of the rotation vector sensor.
);
```
-
-## sensor.once(SensorType.SENSOR_TYPE_ID_HEART_RATE)
+### HEART_RATE
once(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: Callback<HeartRateResponse>): void
@@ -1092,8 +1057,7 @@ Subscribes to only one data change of the heart rate sensor.
);
```
-
-## sensor.once(SensorType.SENSOR_TYPE_ID_WEAR_DETECTION)
+### WEAR_DETECTION
once(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: Callback<WearDetectionResponse>): void
@@ -1115,7 +1079,9 @@ Subscribes to only one data change of the wear detection sensor.
);
```
-## sensor.off(SensorType.SENSOR_TYPE_ID_ACCELEROMETER)
+## sensor.off
+
+### ACCELEROMETER
off(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback?: Callback<AccelerometerResponse>): void
@@ -1143,7 +1109,7 @@ function callback(data) {
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback);
```
-## sensor.off(SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED)
+### ACCELEROMETER_UNCALIBRATED
off(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, callback?: Callback<AccelerometerUncalibratedResponse>): void
@@ -1174,7 +1140,7 @@ function callback(data) {
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, callback);
```
-## sensor.off(SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT)
+### AMBIENT_LIGHT
off(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback?: Callback<LightResponse>): void
@@ -1198,7 +1164,7 @@ function callback(data) {
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback);
```
-## sensor.off(SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE)
+### AMBIENT_TEMPERATURE
off(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, callback?: Callback<AmbientTemperatureResponse>): void
@@ -1222,7 +1188,7 @@ function callback(data) {
sensor.off( sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, callback);
```
-## sensor.off(SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE)
+### AMBIENT_TEMPERATURE
off(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback?: Callback<BarometerResponse>): void
@@ -1246,7 +1212,7 @@ function callback(data) {
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER, callback);
```
-## sensor.off(SensorType.SENSOR_TYPE_ID_GRAVITY)
+### GRAVITY
off(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback?: Callback<GravityResponse>): void
@@ -1272,7 +1238,7 @@ function callback(data) {
sensor.off( sensor.SensorType.SENSOR_TYPE_ID_GRAVITY, callback);
```
-## sensor.off(SensorType.SENSOR_TYPE_ID_GYROSCOPE)
+### GYROSCOPE
off(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback?: Callback<GyroscopeResponse>): void
@@ -1300,7 +1266,7 @@ function callback(data) {
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback);
```
-## sensor.off(SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED)
+### GYROSCOPE_UNCALIBRATED
off(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, callback?: Callback<GyroscopeUncalibratedResponse>): void
@@ -1328,7 +1294,7 @@ function callback(data) {
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, callback);
```
-## sensor.off(SensorType.SENSOR_TYPE_ID_HALL)
+### HALL
off(type: SensorType.SENSOR_TYPE_ID_HALL, callback?: Callback<HallResponse>): void
@@ -1352,7 +1318,7 @@ function callback(data) {
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_HALL, callback);
```
-## sensor.off(SensorType.SENSOR_TYPE_ID_HEART_RATE)
+### HEART_RATE
off(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback?: Callback<HeartRateResponse>): void
@@ -1378,7 +1344,7 @@ function callback(data) {
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_HEART_RATE, callback);
```
-## sensor.off(SensorType.SENSOR_TYPE_ID_HUMIDITY)
+### HUMIDITY
off(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback?: Callback<HumidityResponse>): void
@@ -1404,7 +1370,7 @@ function callback(data) {
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY, callback);
```
-## sensor.off(SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION)
+### LINEAR_ACCELERATION
off(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, callback?: Callback<LinearAccelerometerResponse>): void
@@ -1432,7 +1398,7 @@ function callback(data) {
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, callback);
```
-## sensor.off(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD)
+### MAGNETIC_FIELD
off(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback?: Callback<MagneticFieldResponse>): void
@@ -1460,7 +1426,7 @@ function callback(data) {
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback);
```
-## sensor.off(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED)
+### MAGNETIC_FIELD_UNCALIBRATED
off(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, callback?: Callback<MagneticFieldUncalibratedResponse>): void
@@ -1489,7 +1455,7 @@ function callback(data) {
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, callback);
```
-## sensor.off(SensorType.SENSOR_TYPE_ID_ORIENTATION)
+### ORIENTATION
off(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback?: Callback<OrientationResponse>): void
@@ -1515,7 +1481,7 @@ function callback(data) {
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION, callback);
```
-## sensor.off(SensorType.SENSOR_TYPE_ID_PEDOMETER)
+### PEDOMETER
off(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback?: Callback<PedometerResponse>): void
@@ -1539,7 +1505,7 @@ function callback(data) {
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER, callback);
```
-## sensor.off(SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION)
+### PEDOMETER_DETECTION
off(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback?: Callback<PedometerDetectionResponse>): void
@@ -1565,7 +1531,7 @@ function callback(data) {
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback);
```
-## sensor.off(SensorType.SENSOR_TYPE_ID_PROXIMITY)
+### PROXIMITY
off(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback?: Callback<ProximityResponse>): void
@@ -1589,7 +1555,7 @@ function callback(data) {
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY, callback);
```
-## sensor.off(SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR)
+### ROTATION_VECTOR
off(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback?: Callback<RotationVectorResponse>): void
@@ -1616,7 +1582,7 @@ function callback(data) {
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback);
```
-## sensor.off(SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION)
+### SIGNIFICANT_MOTION
off(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback?: Callback<SignificantMotionResponse>): void
@@ -1640,7 +1606,7 @@ function callback(data) {
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback);
```
-## sensor.off(SensorType.SENSOR_TYPE_ID_WEAR_DETECTION)
+### WEAR_DETECTION
off(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback?: Callback<WearDetectionResponse>): void
@@ -1773,10 +1739,9 @@ 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.|
-
-**Example**
+| Promise<[GeomagneticResponse](#geomagneticresponse)> | Promise used to return the geomagnetic field. |
+**Example**
```js
const promise = sensor.getGeomagneticField({latitude:80, longitude:0, altitude:0}, 1580486400000);
promise.then((data) => {
@@ -1936,7 +1901,7 @@ Obtains the angle change between two rotation matrices. This API uses a callback
}
console.info("SensorJsAPI--->Successed to get getAngleModifiy interface get data: " + data.x);
for (var i=0; i < data.length; i++) {
- console.info(LABEL + "data[" + i + "]: " + data[i]);
+ console.info("data[" + i + "]: " + data[i]);
}
})
```
@@ -1970,10 +1935,10 @@ Obtains the angle change between two rotation matrices. This API uses a promise
promise.then((data) => {
console.info('getAngleModifiy_promise success');
for (var i=0; i < data.length; i++) {
- console.info(LABEL + "data[" + i + "]: " + data[i]);
+ console.info("data[" + i + "]: " + data[i]);
}
}).catch((reason) => {
- console.info(LABEL + "promise::catch", reason);
+ console.info("promise::catch", reason);
})
```
@@ -2004,7 +1969,7 @@ Converts a rotation vector into a rotation matrix. This API uses a callback to r
}
console.info("SensorJsAPI--->Successed to get createRotationMatrix interface get data: " + data.x);
for (var i=0; i < data.length; i++) {
- console.info(LABEL + "data[" + i + "]: " + data[i]);
+ console.info("data[" + i + "]: " + data[i]);
}
})
```
@@ -2037,10 +2002,10 @@ Converts a rotation vector into a rotation matrix. This API uses a promise to re
promise.then((data) => {
console.info('createRotationMatrix_promise success');
for (var i=0; i < data.length; i++) {
- console.info(LABEL + "data[" + i + "]: " + data[i]);
+ console.info("data[" + i + "]: " + data[i]);
}
}).catch((reason) => {
- console.info(LABEL + "promise::catch", reason);
+ console.info("promise::catch", reason);
})
```
@@ -2071,7 +2036,7 @@ Converts a rotation vector into a quaternion. This API uses a callback to return
}
console.info("SensorJsAPI--->Successed to get createQuaternion interface get data: " + data.x);
for (var i=0; i < data.length; i++) {
- console.info(LABEL + "data[" + i + "]: " + data[i]);
+ console.info("data[" + i + "]: " + data[i]);
}
})
```
@@ -2136,7 +2101,7 @@ Obtains the device direction based on the rotation matrix. This API uses a callb
err.message);
return;
}
- console.info("SensorJsAPI--->Successed to get getDirection interface get data: " + data.x);
+ console.info("SensorJsAPI--->Successed to get getDirection interface get data: " + data);
for (var i = 1; i < data.length; i++) {
console.info("sensor_getDirection_callback" + data[i]);
}
@@ -2169,7 +2134,7 @@ Obtains the device direction based on the rotation matrix. This API uses a promi
```js
const promise = sensor.getDirection([1, 0, 0, 0, 1, 0, 0, 0, 1]);
promise.then((data) => {
- console.info('sensor_getAltitude_Promise success', data.x);
+ console.info('sensor_getAltitude_Promise success', data);
for (var i = 1; i < data.length; i++) {
console.info("sensor_getDirection_promise" + data[i]);
}
@@ -2240,7 +2205,7 @@ Creates a rotation matrix based on the gravity vector and geomagnetic vector. Th
promise.then((data) => {
console.info('createRotationMatrix_promise successed');
for (var i=0; i < data.length; i++) {
- console.info(LABEL + "data[" + i + "]: " + data[i]);
+ console.info("data[" + i + "]: " + data[i]);
}
}).catch((err) => {
console.info('promise failed');
@@ -2357,11 +2322,11 @@ Describes the orientation sensor data. It extends from [Response](#response).
**System capability**: SystemCapability.Sensors.Sensor
-| Name | Type | Readable | Writable | Description |
-| ----- | ------ | ---- | ---- | ------------------------ |
-| alpha | number | Yes | Yes | Rotation angle of the device around the z-axis, in rad.|
-| beta | number | Yes | Yes | Rotation angle of the device around the x-axis, in rad. |
-| gamma | number | Yes | Yes | Rotation angle of the device around the y-axis, in rad. |
+| Name | Type | Readable | Writable | Description |
+| ----- | ------ | ---- | ---- | ----------------- |
+| alpha | number | Yes | Yes | Rotation angle of the device around the z-axis, in degrees.|
+| beta | number | Yes | Yes | Rotation angle of the device around the x-axis, in degrees.|
+| gamma | number | Yes | Yes | Rotation angle of the device around the y-axis, in degrees.|
## RotationVectorResponse
diff --git a/en/application-dev/reference/apis/js-apis-system-prompt.md b/en/application-dev/reference/apis/js-apis-system-prompt.md
index c9b37ef403d7e6f958f91f2747710ad53ad4f983..e37601dbfa3ec72d13a7722fb4dc56a8b3fe6fef 100644
--- a/en/application-dev/reference/apis/js-apis-system-prompt.md
+++ b/en/application-dev/reference/apis/js-apis-system-prompt.md
@@ -1,8 +1,8 @@
# Prompt
-> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**
+> **NOTE**
>
-> - The APIs of this module are no longer maintained since API version 8. You are advised to use ['@ohos.prompt](js-apis-prompt.md)' instead.
+> - The APIs of this module are no longer maintained since API version 8. You are advised to use [`@ohos.prompt`](js-apis-prompt.md) instead.
>
>
> - The initial APIs of this module are supported since API version 3. Newly added APIs will be marked with a superscript to indicate their earliest API version.
@@ -11,7 +11,7 @@
## Modules to Import
-```
+```js
import prompt from '@system.prompt';
```
@@ -25,13 +25,13 @@ Shows the toast.
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------- | ------------------------------------- | --------- | ------------------------------ |
-| options | [ShowToastOptions](#showtoastoptions) | Yes | Options for showing the toast. |
+| Name | Type | Mandatory | Description |
+| ------- | ------------------------------------- | ---- | --------------- |
+| options | [ShowToastOptions](#showtoastoptions) | Yes | Options for showing the toast.|
**Example**
-```
+```js
export default {
showToast() {
prompt.showToast({
@@ -53,14 +53,14 @@ Shows the dialog box.
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------- | --------------------------------------- | --------- | ----------------------------------- |
-| options | [ShowDialogOptions](#showdialogoptions) | Yes | Options for showing the dialog box. |
+| Name | Type | Mandatory | Description |
+| ------- | --------------------------------------- | ---- | ----------- |
+| options | [ShowDialogOptions](#showdialogoptions) | Yes | Options for showing the dialog box.|
**Example**
-```
+```js
export default {
showDialog() {
prompt.showDialog({
@@ -93,14 +93,14 @@ Shows the action menu.
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------- | ---------------------------------------- | --------- | ------------------------------------ |
-| options | [ShowActionMenuOptions](#showactionmenuoptions) | Yes | Options for showing the action menu. |
+| Name | Type | Mandatory | Description |
+| ------- | ---------------------------------------- | ---- | -------------------- |
+| options | [ShowActionMenuOptions](#showactionmenuoptions) | Yes | Options for showing the action menu.|
**Example**
-```
+```js
export default {
showActionMenu() {
prompt.showActionMenu({
@@ -115,11 +115,11 @@ export default {
color: '#000000',
},
],
- success: function(data) {
+ success: function(tapIndex) {
console.log('dialog success callback, click button : ' + data.tapIndex);
},
- fail: function(data) {
- console.log('dialog fail callback' + data.errMsg);
+ fail: function(errMsg) {
+ console.log('dialog fail callback' + errMsg);
},
});
}
@@ -131,11 +131,11 @@ Describes the options for showing the toast.
**System capability**: SystemCapability.ArkUI.ArkUI.Full
-| Name | Type | Mandatory | Description |
-| ------------------- | -------------- | --------- | ---------------------------------------- |
-| message | string | Yes | Text to display. |
-| duration | number | No | Duration that the toast will remain on the screen. The default value is 1500 ms. The recommended value range is 1500 ms to 10000 ms. If a value less than 1500 ms is set, the default value is used. |
-| bottom5+ | string\|number | No | Distance between the toast frame and the bottom of the screen. |
+| Name | Type | Mandatory | Description |
+| ------------------- | -------------- | ---- | ---------------------------------------- |
+| message | string | Yes | Text to display. |
+| duration | number | No | Duration that the toast will remain on the screen. The default value is 1500 ms. The recommended value range is 1500 ms to 10000 ms. If a value less than 1500 ms is set, the default value is used.|
+| bottom5+ | string\|number | No | Distance between the toast border and the bottom of the screen. |
## Button
@@ -143,10 +143,10 @@ Defines the prompt information of a button.
**System capability**: SystemCapability.ArkUI.ArkUI.Full
-| Name | Type | Mandatory | Description |
-| ----- | ------ | --------- | ----------------------------- |
-| text | string | Yes | Text displayed on the button. |
-| color | string | Yes | Color of the button. |
+| Name | Type | Mandatory | Description |
+| ----- | ------ | ---- | ------- |
+| text | string | Yes | Text displayed on the button.|
+| color | string | Yes | Color of the button.|
## ShowDialogSuccessResponse
@@ -154,9 +154,9 @@ Defines the dialog box response result.
**System capability**: SystemCapability.ArkUI.ArkUI.Full
-| Name | Type | Mandatory | Description |
-| ----- | ------ | --------- | ----------- |
-| index | number | Yes | Data index. |
+| Name | Type | Mandatory | Description |
+| ----- | ------ | ---- | ---------- |
+| index | number | Yes | Data index.|
## ShowDialogOptions
@@ -164,14 +164,14 @@ Describes the options for showing the dialog box.
**System capability**: SystemCapability.ArkUI.ArkUI.Full
-| Name | Type | Mandatory | Description |
-| -------- | ---------------------------------------- | --------- | ---------------------------------------- |
-| title | string | No | Title of the text to display. |
-| message | string | No | Text body. |
-| buttons | [[Button](#button), [Button](#button)?, [Button](#button)?] | No | Array of buttons in the dialog box. The array structure is **{text:'button', color: '\#666666'}**. One to six buttons are supported. If there are more than six buttons, extra buttons will not be displayed. |
-| success | (data: [ShowDialogSuccessResponse](#showdialogsuccessresponse)) => void | No | Callback upon success. |
-| cancel | (data: string, code: string) => void | No | Callback upon failure. |
-| complete | (data: string) => void | No | Called when the API call is complete. |
+| Name | Type | Mandatory | Description |
+| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
+| title | string | No | Title of the text to display. |
+| message | string | No | Text body. |
+| buttons | [[Button](#button), [Button](#button)?, [Button](#button)?] | No | Array of buttons in the dialog box. The array structure is **{text:'button', color: '\#666666'}**. One to six buttons are supported. If there are more than six buttons, extra buttons will not be displayed.|
+| success | (data: [ShowDialogSuccessResponse](#showdialogsuccessresponse)) => void | No | Callback upon success. |
+| cancel | (data: string, code: string) => void | No | Callback upon failure. |
+| complete | (data: string) => void | No | Called when the API call is complete. |
## ShowActionMenuOptions6+
@@ -179,10 +179,10 @@ Describes the options for showing the action menu.
**System capability**: SystemCapability.ArkUI.ArkUI.Full
-| Name | Type | Mandatory | Description |
-| -------- | ---------------------------------------- | --------- | ---------------------------------------- |
-| title | string | No | Title of the text to display. |
-| buttons | [[Button](#button), [Button](#button)?, [Button](#button)?, [Button](#button)?, [Button](#button)?, [Button](#button)?] | Yes | Array of buttons in the dialog box. The array structure is **{text:'button', color: '\#666666'}**. One to six buttons are supported. |
-| success | (tapIndex: number, errMsg: string) => void | No | Invoked when a dialog box is displayed. |
-| fail | (errMsg: string) => void | No | Callback upon failure. |
-| complete | (data: string) => void | No | Invoked when a dialog box is closed. |
+| Name | Type | Mandatory | Description |
+| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
+| title | string | No | Title of the text to display. |
+| buttons | [[Button](#button), [Button](#button)?, [Button](#button)?, [Button](#button)?, [Button](#button)?, [Button](#button)?] | Yes | Array of buttons in the dialog box. The array structure is **{text:'button', color: '\#666666'}**. One to six buttons are supported.|
+| success | (tapIndex: number, errMsg: string) => void | No | Invoked when a dialog box is displayed. |
+| fail | (errMsg: string) => void | No | Callback upon failure. |
+| complete | (data: string) => void | No | Invoked when a dialog box is closed. |
diff --git a/en/application-dev/reference/apis/js-apis-system-router.md b/en/application-dev/reference/apis/js-apis-system-router.md
index a93ffdfa68f6406c6290221d4c5fe757fd7c906b..0f1f932efe54af1337ce19354d19343b6f637687 100644
--- a/en/application-dev/reference/apis/js-apis-system-router.md
+++ b/en/application-dev/reference/apis/js-apis-system-router.md
@@ -1,6 +1,6 @@
# Page Routing
-> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**
+> **NOTE**
>
> - The APIs of this module are no longer maintained since API version 8. You are advised to use [`@ohos.router`](js-apis-router.md) instead.
>
@@ -11,7 +11,7 @@
## Modules to Import
-```
+```js
import router from '@system.router';
```
@@ -31,7 +31,7 @@ Navigates to a specified page in the application.
**Example**
-```
+```js
// Current page
export default {
pushPage() {
@@ -49,7 +49,7 @@ export default {
```
-```
+```js
// routerpage2 page
export default {
data: {
@@ -85,7 +85,7 @@ Replaces the current page with another one in the application and destroys the c
**Example**
-```
+```js
// Current page
export default {
replacePage() {
@@ -100,7 +100,7 @@ export default {
```
-```
+```js
// detail page
export default {
data: {
@@ -128,7 +128,7 @@ Returns to the previous page or a specified page.
**Example**
-```
+```js
// index page
export default {
indexPushPage() {
@@ -140,7 +140,7 @@ export default {
```
-```
+```js
// detail page
export default {
detailPushPage() {
@@ -152,7 +152,7 @@ export default {
```
-```
+```js
// Navigate from the mall page to the detail page through router.back().
export default {
mallBackPage() {
@@ -162,7 +162,7 @@ export default {
```
-```
+```js
// Navigate from the detail page to the index page through router.back().
export default {
defaultBack() {
@@ -172,7 +172,7 @@ export default {
```
-```
+```js
// Return to the detail page through router.back().
export default {
backToDetail() {
@@ -208,7 +208,7 @@ Clears all historical pages in the stack and retains only the current page at th
**Example**
-```
+```js
export default {
clearPage() {
router.clear();
@@ -232,7 +232,7 @@ Obtains the number of pages in the current stack.
**Example**
-```
+```js
export default {
getLength() {
var size = router.getLength();
@@ -257,7 +257,7 @@ Obtains state information about the current page.
**Example**
-```
+```js
export default {
getState() {
var page = router.getState();
@@ -284,7 +284,7 @@ Enables the display of a confirm dialog box before returning to the previous pag
**Example**
-```
+```js
export default {
enableAlertBeforeBackPage() {
router.enableAlertBeforeBackPage({
@@ -292,8 +292,8 @@ export default {
success: function() {
console.log('success');
},
- fail: function() {
- console.log('fail');
+ cancel: function() {
+ console.log('cancel');
},
});
}
@@ -316,15 +316,15 @@ Disables the display of a confirm dialog box before returning to the previous pa
**Example**
-```
+```js
export default {
disableAlertBeforeBackPage() {
router.disableAlertBeforeBackPage({
success: function() {
console.log('success');
},
- fail: function() {
- console.log('fail');
+ cancel: function() {
+ console.log('cancel');
},
});
}