提交 2c594f5c 编写于 作者: X xixian_2023

mmi_multiFingers_gesture_Docs

Signed-off-by:xixian_2023<xixian@huawei.com>
上级 b410869c
......@@ -369,6 +369,7 @@
- [@ohos.deviceInfo (设备信息)](js-apis-device-info.md)
- [@ohos.distributedHardware.deviceManager (设备管理)](js-apis-device-manager.md)
- [@ohos.geoLocationManager (位置服务)](js-apis-geoLocationManager.md)
- [@ohos.multimodalInput.gestureEvent (手势事件)](js-apis-multimodalinput-gestureevent.md)
- [@ohos.multimodalInput.inputConsumer (组合按键)](js-apis-inputconsumer.md)
- [@ohos.multimodalInput.inputDevice (输入设备)](js-apis-inputdevice.md)
- [@ohos.multimodalInput.inputDeviceCooperate (键鼠穿越)(待停用)](js-apis-cooperate.md)
......
......@@ -211,3 +211,240 @@ try {
console.log(`Monitor on failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## inputMonitor.on(pinch)<sup>10+</sup>
on(type: "pinch", receiver: Callback&lt;[Pinch](js-apis-multimodalinput-gestureevent.md/#pinch)&gt;): void
开始监听全局触控板捏合事件。
**需要权限:** ohos.permission.INPUT_MONITORING
**系统能力:** SystemCapability.MultimodalInput.Input.InputMonitor
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ------------------- |
| type | string | 是 | 输入设备事件类型,取值“pinch”。 |
| receiver | Callback&lt;[Pinch](js-apis-multimodalinput-gestureevent.md/#pinch)&gt; | 是 | 回调函数,异步上报捏合输入事件。 |
**示例:**
```js
try {
inputMonitor.on("pinch", (pinchEvent) => {
console.log(`Monitor on success ${JSON.stringify(pinchEvent)}`);
return false;
});
} catch (error) {
console.log(`Monitor on failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## inputMonitor.off(pinch)<sup>10+</sup>
off(type: "pinch", receiver?: Callback&lt;[Pinch](js-apis-multimodalinput-gestureevent.md/#pinch)&gt;): void
停止监听全局触控板捏合事件。
**需要权限:** ohos.permission.INPUT_MONITORING
**系统能力:** SystemCapability.MultimodalInput.Input.InputMonitor
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ------------------- |
| type | string | 是 | 输入设备事件类型,取值“pinch”。 |
| receiver | Callback&lt;[Pinch](js-apis-multimodalinput-gestureevent.md/#pinch)&gt; | 否 | 需要取消监听的回调函数,若无此参数,则取消当前应用监听的所有回调函数。 |
**示例:**
```js
// 取消监听单个回调函数
function callback(pinchEvent) {
console.log(`Monitor on success ${JSON.stringify(pinchEvent)}`);
return false;
};
try {
inputMonitor.on("pinch", callback);
inputMonitor.off("pinch", callback);
console.log(`Monitor off success`);
} catch (error) {
console.log(`Monitor execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
```js
// 取消监听所有回调函数
function callback(pinchEvent) {
console.log(`Monitor on success ${JSON.stringify(pinchEvent)}`);
return false;
};
try {
inputMonitor.on("pinch", callback);
inputMonitor.off("pinch");
console.log(`Monitor off success`);
} catch (error) {
console.log(`Monitor execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## inputMonitor.on(threeFingersSwipe)<sup>10+</sup>
on(type: "threeFingersSwipe", receiver: Callback&lt;[ThreeFingersSwipe](js-apis-multimodalinput-gestureevent.md/#threefingersswipe)&gt;): void
开始监听全局触控板三指滑动事件。
**需要权限:** ohos.permission.INPUT_MONITORING
**系统能力:** SystemCapability.MultimodalInput.Input.InputMonitor
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ------------------- |
| type | string | 是 | 输入设备事件类型,取值“threeFingersSwipe”。 |
| receiver | Callback&lt;[ThreeFingersSwipe](js-apis-multimodalinput-gestureevent.md/#threefingersswipe)&gt; | 是 | 回调函数,异步上报三指滑动输入事件。 |
**示例:**
```js
try {
inputMonitor.on("threeFingersSwipe", (threeFingersSwipe) => {
console.log(`Monitor on success ${JSON.stringify(threeFingersSwipe)}`);
return false;
});
} catch (error) {
console.log(`Monitor on failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## inputMonitor.off(threeFingersSwipe)<sup>10+</sup>
off(type: "threeFingersSwipe", receiver?: Callback&lt;[ThreeFingersSwipe](js-apis-multimodalinput-gestureevent.md/#threefingersswipe)&gt;): void
停止监听全局触控板三指滑动事件。
**需要权限:** ohos.permission.INPUT_MONITORING
**系统能力:** SystemCapability.MultimodalInput.Input.InputMonitor
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ------------------- |
| type | string | 是 | 输入设备事件类型,取值“threeFingersSwipe”。 |
| receiver | Callback&lt;[ThreeFingersSwipe](js-apis-multimodalinput-gestureevent.md/#threefingersswipe)&gt; | 否 | 需要取消监听的回调函数,若无此参数,则取消当前应用监听的所有回调函数。 |
**示例:**
```js
// 取消监听单个回调函数
function callback(threeFingersSwipe) {
console.log(`Monitor on success ${JSON.stringify(threeFingersSwipe)}`);
return false;
};
try {
inputMonitor.on("threeFingersSwipe", callback);
inputMonitor.off("threeFingersSwipe", callback);
console.log(`Monitor off success`);
} catch (error) {
console.log(`Monitor execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
```js
// 取消监听所有回调函数
function callback(threeFingersSwipe) {
console.log(`Monitor on success ${JSON.stringify(threeFingersSwipe)}`);
return false;
};
try {
inputMonitor.on("threeFingersSwipe", callback);
inputMonitor.off("threeFingersSwipe");
console.log(`Monitor off success`);
} catch (error) {
console.log(`Monitor execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## inputMonitor.on(fourFingersSwipe)<sup>10+</sup>
on(type: "fourFingersSwipe", receiver: Callback&lt;[FourFingersSwipe](js-apis-multimodalinput-gestureevent.md/#fourfingersswipe)&gt;): void
开始监听全局触控板四指滑动事件。
**需要权限:** ohos.permission.INPUT_MONITORING
**系统能力:** SystemCapability.MultimodalInput.Input.InputMonitor
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ------------------- |
| type | string | 是 | 输入设备事件类型,取值“fourFingersSwipe”。 |
| receiver | Callback&lt;[FourFingersSwipe](js-apis-multimodalinput-gestureevent.md/#fourfingersswipe)&gt; | 是 | 回调函数,异步上报四指滑动输入事件。 |
**示例:**
```js
try {
inputMonitor.on("fourFingersSwipe", (fourFingersSwipe) => {
console.log(`Monitor on success ${JSON.stringify(fourFingersSwipe)}`);
return false;
});
} catch (error) {
console.log(`Monitor on failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
## inputMonitor.off(fourFingersSwipe)<sup>10+</sup>
off(type: "fourFingersSwipe", receiver?: Callback&lt;[FourFingersSwipe](js-apis-multimodalinput-gestureevent.md/#fourfingersswipe)&gt;): void
停止监听全局触控板四指滑动事件。
**需要权限:** ohos.permission.INPUT_MONITORING
**系统能力:** SystemCapability.MultimodalInput.Input.InputMonitor
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ------------------- |
| type | string | 是 | 输入设备事件类型,取值“fourFingersSwipe”。 |
| receiver | Callback&lt;[FourFingersSwipe](js-apis-multimodalinput-gestureevent.md/#fourfingersswipe)&gt; | 否 | 需要取消监听的回调函数,若无此参数,则取消当前应用监听的所有回调函数。 |
**示例:**
```js
// 取消监听单个回调函数
function callback(fourFingersSwipe) {
console.log(`Monitor on success ${JSON.stringify(fourFingersSwipe)}`);
return false;
};
try {
inputMonitor.on("fourFingersSwipe", callback);
inputMonitor.off("fourFingersSwipe", callback);
console.log(`Monitor off success`);
} catch (error) {
console.log(`Monitor execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
```js
// 取消监听所有回调函数
function callback(fourFingersSwipe) {
console.log(`Monitor on success ${JSON.stringify(fourFingersSwipe)}`);
return false;
};
try {
inputMonitor.on("fourFingersSwipe", callback);
inputMonitor.off("fourFingersSwipe");
console.log(`Monitor off success`);
} catch (error) {
console.log(`Monitor execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
```
# @ohos.multimodalInput.gestureEvent (手势输入事件)
设备上报的手势事件。
> **说明:**
>
> 本模块首批接口从API version 10开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```js
import { Pinch, ThreeFingersSwipe, FourFingersSwipe, ActionType } from '@ohos.multimodalInput.gestureEvent';
```
## Pinch
捏合事件。
**系统能力**:SystemCapability.MultimodalInput.Input.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------------- | ----------- | ---- | ---- | ---------------------------------------- |
| type | [ActionType](#actiontype) | 是 | 否 | 捏合事件类型 |
| scale | number | 是 | 否 | 捏合度 |
## ThreeFingersSwipe
三指滑动事件。
**系统能力**:SystemCapability.MultimodalInput.Input.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------------- | ----------- | ---- | ---- | ---------------------------------------- |
| type | [ActionType](#actiontype) | 是 | 否 | 三指滑动事件类型 |
| x | number | 是 | 否 | 坐标x |
| y | number | 是 | 否 | 坐标y |
## FourFingersSwipe
四指滑动事件。
**系统能力**:SystemCapability.MultimodalInput.Input.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------------- | ----------- | ---- | ---- | ---------------------------------------- |
| type | [ActionType](#actiontype) | 是 | 否 | 四指滑动事件类型 |
| x | number | 是 | 否 | 坐标x |
| y | number | 是 | 否 | 坐标y |
## ActionType
手势事件类型。
**系统能力**:SystemCapability.MultimodalInput.Input.Core
| 名称 | 值 | 说明 |
| ----------- | --- | --------------- |
| CANCEL | 0 | 取消 |
| BEGIN | 1 | 手势开始 |
| UPDATE | 2 | 手势更新 |
| END | 3 | 手势结束 |
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册