# 触摸事件
当手指在组件上按下、滑动、抬起时触发。
> **说明:**
>
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
## 事件
| 名称 | 是否冒泡 | 功能描述 |
| ------------------------------------------------------------ | -------- | ------------------------------------------------------------ |
| onTouch(event: (event?: TouchEvent) => void) | 是 | 手指触摸动作触发该回调,event返回值见[TouchEvent](#touchevent对象说明)介绍。 |
## TouchEvent对象说明
| 名称 | 类型 | 描述 |
| ------------------- | ---------------------------------------- | ------------ |
| type | [TouchType](ts-appendix-enums.md#touchtype) | 触摸事件的类型。 |
| touches | Array<[TouchObject](#touchobject对象说明)> | 全部手指信息。 |
| changedTouches | Array<[TouchObject](#touchobject对象说明)> | 当前发生变化的手指信息。 |
| stopPropagation | () => void | 阻塞事件冒泡。 |
| timestamp8+ | number | 事件时间戳。触发事件时距离系统启动的时间间隔,单位毫秒。 |
| target8+ | [EventTarget](ts-universal-events-click.md#eventtarget8对象说明) | 触发事件的元素对象显示区域。 |
| source8+ | [SourceType](ts-gesture-settings.md#sourcetype枚举说明) | 事件输入设备。 |
| getHistoricalPoints10+ | Array<[HistoricalPoint](#historicalpoint10对象说明)>| 获取当前帧所有的历史点(不同设备每帧的触摸事件频率不同,当前帧所有的触摸事件被称为历史点)。 |
## TouchObject对象说明
| 名称 | 类型 | 描述 |
| ------- | ------------------------------------------- | ------------------------------------- |
| type | [TouchType](ts-appendix-enums.md#touchtype) | 触摸事件的类型。 |
| id | number | 手指唯一标识符。 |
| x | number | 触摸点相对于被触摸元素左上角的X坐标。 |
| y | number | 触摸点相对于被触摸元素左上角的Y坐标。 |
| windowX10+ | number | 触摸点相对于应用窗口左上角的X坐标。 |
| windowY10+ | number | 触摸点相对于应用窗口左上角的Y坐标。 |
| displayX10+ | number | 触摸点相对于应用屏幕左上角的X坐标。 |
| displayY10+ | number | 触摸点相对于应用屏幕左上角的Y坐标。 |
| screenX(deprecated) | number | 触摸点相对于应用窗口左上角的X坐标。
从API verdion 10开始不再维护,建议使用windowX代替。 |
| screenY(deprecated) | number | 触摸点相对于应用窗口左上角的Y坐标。
从API verdion 10开始不再维护,建议使用windowX代替。 |
## HistoricalPoint10+对象说明
| 名称 | 类型 | 描述 |
| ----------- | ----------------------------------- | ----------------------------------------------------------------------------- |
| touchObject | [TouchObject](#touchobject对象说明) | 历史点对应触摸事件的基础信息。 |
| size | number | 历史点对应触摸事件的手指与屏幕的触摸区域大小。
默认值:0 |
| force | number | 历史点对应触摸事件的压力大小。
默认值:0
取值范围:[0,1],压力越大值越大。
此接口根据硬件设备不同,支持情况不同。当前只支持Tablet。|
| timestamp | number | 历史点对应触摸事件的时间戳。触发事件时距离系统启动的时间间隔,单位毫秒。 |
## 示例
```ts
// xxx.ets
@Entry
@Component
struct TouchExample {
@State text: string = ''
@State eventType: string = ''
build() {
Column() {
Button('Touch').height(40).width(100)
.onTouch((event: TouchEvent) => {
if (event.type === TouchType.Down) {
this.eventType = 'Down'
}
if (event.type === TouchType.Up) {
this.eventType = 'Up'
}
if (event.type === TouchType.Move) {
this.eventType = 'Move'
}
this.text = 'TouchType:' + this.eventType + '\nDistance between touch point and touch element:\nx: '
+ event.touches[0].x + '\n' + 'y: ' + event.touches[0].y + '\nComponent globalPos:('
+ event.target.area.globalPosition.x + ',' + event.target.area.globalPosition.y + ')\nwidth:'
+ event.target.area.width + '\nheight:' + event.target.area.height
})
Button('Touch').height(50).width(200).margin(20)
.onTouch((event: TouchEvent) => {
if (event.type === TouchType.Down) {
this.eventType = 'Down'
}
if (event.type === TouchType.Up) {
this.eventType = 'Up'
}
if (event.type === TouchType.Move) {
this.eventType = 'Move'
}
this.text = 'TouchType:' + this.eventType + '\nDistance between touch point and touch element:\nx: '
+ event.touches[0].x + '\n' + 'y: ' + event.touches[0].y + '\nComponent globalPos:('
+ event.target.area.globalPosition.x + ',' + event.target.area.globalPosition.y + ')\nwidth:'
+ event.target.area.width + '\nheight:' + event.target.area.height
})
Text(this.text)
}.width('100%').padding(30)
}
}
```
