提交 900b7454 编写于 作者: H HelloCrease

update docs

Signed-off-by: NHelloCrease <lian15@huawei.com>
上级 eeddf4c7
......@@ -69,12 +69,12 @@ off(type: “change”, listener?: Callback&lt;DeviceListener&gt;): void
**示例:**
```js
listener: function(data) {
function listener(data) {
console.log("type: " + data.type + ", deviceId: " + data.deviceId);
}
// 单独取消listener的监听。
inputDevice.off("change", this.listener);
inputDevice.off("change", listener);
// 取消所有监听
inputDevice.off("change");
......
# 媒体查询
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
## 导入模块
```
```js
import mediaquery from '@ohos.mediaquery'
```
......@@ -22,19 +22,19 @@ matchMediaSync(condition: string): MediaQueryListener
设置媒体查询的查询条件,并返回对应的监听句柄。
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| condition | string | 是 | 媒体事件的匹配条件。 |
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ---------- |
| condition | string | 是 | 媒体事件的匹配条件。 |
- 返回值
| 类型 | 说明 |
| -------- | -------- |
| MediaQueryListener | 媒体事件监听句柄,用于注册和去注册监听回调。 |
**返回值:**
| 类型 | 说明 |
| ------------------ | ---------------------- |
| MediaQueryListener | 媒体事件监听句柄,用于注册和去注册监听回调。 |
- 示例
```
listener = mediaquery.matchMediaSync('(orientation: landscape)'); //监听横屏事件
**示例:**
```js
let listener = mediaquery.matchMediaSync('(orientation: landscape)'); //监听横屏事件
```
......@@ -45,10 +45,10 @@ matchMediaSync(condition: string): MediaQueryListener
### 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| matches | boolean | 是 | 否 | 是否符合匹配条件。 |
| media | string | 是 | 否 | 媒体事件的匹配条件。 |
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------- | ------- | ---- | ---- | ---------- |
| matches | boolean | 是 | 否 | 是否符合匹配条件。 |
| media | string | 是 | 否 | 媒体事件的匹配条件。 |
### on
......@@ -57,13 +57,13 @@ on(type: 'change', callback: Callback&lt;MediaQueryResult&gt;): void
通过句柄向对应的查询条件注册回调,当媒体属性发生变更时会触发该回调。
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 必须填写字符串'change'。 |
| callback | Callback&lt;MediaQueryResult&gt; | 是 | 向媒体查询注册的回调 |
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------- | ---- | ---------------- |
| type | string | 是 | 必须填写字符串'change'。 |
| callback | Callback&lt;MediaQueryResult&gt; | 是 | 向媒体查询注册的回调 |
- 示例
**示例:**
详见[off示例](#off)
......@@ -72,14 +72,14 @@ on(type: 'change', callback: Callback&lt;MediaQueryResult&gt;): void
off(type: 'change', callback?: Callback&lt;MediaQueryResult&gt;): void
通过句柄向对应的查询条件去注册回调,当媒体属性发生变更时不在触发指定的回调。
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | boolean | 是 | 必须填写字符串'change'。 |
| callback | Callback&lt;MediaQueryResult&gt; | 否 | 需要去注册的回调,如果参数缺省则去注册该句柄下所有的回调。 |
- 示例
```
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------- | ---- | ----------------------------- |
| type | boolean | 是 | 必须填写字符串'change'。 |
| callback | Callback&lt;MediaQueryResult&gt; | 否 | 需要去注册的回调,如果参数缺省则去注册该句柄下所有的回调。 |
**示例:**
```js
import mediaquery from '@ohos.mediaquery'
let listener = mediaquery.matchMediaSync('(orientation: landscape)'); //监听横屏事件
......@@ -90,8 +90,8 @@ off(type: 'change', callback?: Callback&lt;MediaQueryResult&gt;): void
// do something here
}
}
this.listener.on('change', this.onPortrait) // 注册回调
this.listener.off('change', this.onPortrait) // 去注册回调
listener.on('change', onPortrait) // 注册回调
listener.off('change', onPortrait) // 去注册回调
```
......@@ -100,15 +100,15 @@ off(type: 'change', callback?: Callback&lt;MediaQueryResult&gt;): void
### 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| matches | boolean | 是 | 否 | 是否符合匹配条件。 |
| media | string | 是 | 否 | 媒体事件的匹配条件。 |
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------- | ------- | ---- | ---- | ---------- |
| matches | boolean | 是 | 否 | 是否符合匹配条件。 |
| media | string | 是 | 否 | 媒体事件的匹配条件。 |
### 示例
```
```js
import mediaquery from '@ohos.mediaquery'
let portraitFunc = null
......
......@@ -11,7 +11,7 @@
## 导入模块
```
```js
import prompt from '@system.prompt';
```
......@@ -31,7 +31,7 @@ showToast(options: ShowToastOptions): void
**示例:**
```
```js
export default {
showToast() {
prompt.showToast({
......@@ -60,7 +60,7 @@ showDialog(options: ShowDialogOptions): void
**示例:**
```
```js
export default {
showDialog() {
prompt.showDialog({
......@@ -100,7 +100,7 @@ showActionMenu(options: ShowActionMenuOptions): void
**示例:**
```
```js
export default {
showActionMenu() {
prompt.showActionMenu({
......@@ -115,11 +115,11 @@ export default {
color: '#000000',
},
],
success: function(data) {
console.log('dialog success callback,click button : ' + data.tapIndex);
success: function(tapIndex) {
console.log('dialog success callback,click button : ' + tapIndex);
},
fail: function(data) {
console.log('dialog fail callback' + data.errMsg);
fail: function(errMsg) {
console.log('dialog fail callback' + errMsg);
},
});
}
......
# 页面路由
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> - 从API Version 8 开始,该接口不再维护,推荐使用新接口[`@ohos.router`](js-apis-router.md)。
>
......@@ -11,7 +11,7 @@
## 导入模块
```
```js
import router from '@system.router';
```
......@@ -31,7 +31,7 @@ push(options: RouterOptions): void
**示例:**
```
```js
// 在当前页面中
export default {
pushPage() {
......@@ -49,7 +49,7 @@ export default {
```
```
```js
// 在routerpage2页面中
export default {
data: {
......@@ -85,7 +85,7 @@ replace(options: RouterOptions): void
**示例:**
```
```js
// 在当前页面中
export default {
replacePage() {
......@@ -100,7 +100,7 @@ export default {
```
```
```js
// 在detail页面中
export default {
data: {
......@@ -128,7 +128,7 @@ back(options?: BackRouterOptions): void
**示例:**
```
```js
// index页面
export default {
indexPushPage() {
......@@ -140,7 +140,7 @@ export default {
```
```
```js
// detail页面
export default {
detailPushPage() {
......@@ -152,7 +152,7 @@ export default {
```
```
```js
// mall页面通过back,将返回detail页面
export default {
mallBackPage() {
......@@ -162,7 +162,7 @@ export default {
```
```
```js
// detail页面通过back,将返回index页面
export default {
defaultBack() {
......@@ -172,7 +172,7 @@ export default {
```
```
```js
// 通过back,返回到detail页面
export default {
backToDetail() {
......@@ -208,7 +208,7 @@ clear(): void
**示例:**
```
```js
export default {
clearPage() {
router.clear();
......@@ -232,7 +232,7 @@ getLength(): string
**示例:**
```
```js
export default {
getLength() {
var size = router.getLength();
......@@ -257,7 +257,7 @@ getState(): RouterState
**示例:**
```
```js
export default {
getState() {
var page = router.getState();
......@@ -284,7 +284,7 @@ enableAlertBeforeBackPage(options: EnableAlertBeforeBackPageOptions): void
**示例:**
```
```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 @@ disableAlertBeforeBackPage(options?: DisableAlertBeforeBackPageOptions): void
**示例:**
```
```js
export default {
disableAlertBeforeBackPage() {
router.disableAlertBeforeBackPage({
success: function() {
console.log('success');
},
fail: function() {
console.log('fail');
cancel: function() {
console.log('cancel');
},
});
}
......
......@@ -25,9 +25,9 @@ init(curve?: Curve): Object
- 参数
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| curve | Curve | 否 | Linear | 曲线对象。 |
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
| ----- | ----- | ---- | ------ | ----- |
| curve | Curve | 否 | Linear | 曲线对象。 |
- 返回值
曲线对象Object。
......@@ -42,10 +42,10 @@ steps(count: number, end: boolean): Object
- 参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| count | number | 是 | - | 阶梯的数量,需要为正整数。 |
| end | boolean | 是 | true | 在每个间隔的起点或是终点发生阶跃变化&nbsp;,默认值为true,即在终点发生阶跃变化。 |
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
| ----- | ------- | ---- | ---- | ---------------------------------------- |
| count | number | 是 | - | 阶梯的数量,需要为正整数。 |
| end | boolean | 是 | true | 在每个间隔的起点或是终点发生阶跃变化&nbsp;,默认值为true,即在终点发生阶跃变化。 |
- 返回值
曲线对象Object。
......@@ -60,12 +60,12 @@ cubicBezier(x1: number, y1: number, x2: number, y2: number): Object
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| x1 | number | 是 | 确定贝塞尔曲线第一点横坐标。 |
| y1 | number | 是 | 确定贝塞尔曲线第一点纵坐标。 |
| x2 | number | 是 | 确定贝塞尔曲线第二点横坐标。 |
| y2 | number | 是 | 确定贝塞尔曲线第二点纵坐标。 |
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | -------------- |
| x1 | number | 是 | 确定贝塞尔曲线第一点横坐标。 |
| y1 | number | 是 | 确定贝塞尔曲线第一点纵坐标。 |
| x2 | number | 是 | 确定贝塞尔曲线第二点横坐标。 |
| y2 | number | 是 | 确定贝塞尔曲线第二点纵坐标。 |
- 返回值
曲线对象Object。
......@@ -80,12 +80,12 @@ spring(velocity: number, mass: number, stiffness: number, damping: number): Obje
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| velocity | number | 是 | 初始速度。 |
| mass | number | 是 | 质量。 |
| stiffness | number | 是 | 刚度。 |
| damping | number | 是 | 阻尼。 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ----- |
| velocity | number | 是 | 初始速度。 |
| mass | number | 是 | 质量。 |
| stiffness | number | 是 | 刚度。 |
| damping | number | 是 | 阻尼。 |
- 返回值
曲线对象Object。
......@@ -103,9 +103,9 @@ let curve3 = Curves.cubicBezier(0.1, 0.0, 0.1, 1.0) // 创建一个三阶贝塞
曲线对象只能通过上面的接口创建。
| 接口名称 | 功能描述 |
| -------- | -------- |
| interpolate(time:&nbsp;number):&nbsp;number | 插值曲线的插值计算函数,可以通过传入的归一化时间参数返回当前的插值。<br/>time:&nbsp;当前的归一化时间参数,有效值范围0到1。<br/>返回归一化time时间点对应的曲线插值。 |
| 接口名称 | 功能描述 |
| ---------------------------------------- | ---------------------------------------- |
| interpolate(time:&nbsp;number):&nbsp;number | 插值曲线的插值计算函数,可以通过传入的归一化时间参数返回当前的插值。<br/>time:&nbsp;当前的归一化时间参数,有效值范围0到1。<br/>返回归一化time时间点对应的曲线插值。 |
- 示例
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册