9ed81e3e创建于 2025年2月21日历史提交

触摸事件

当手指在组件上按下、滑动、抬起时触发。

说明：

从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。

onTouch

onTouch(event: (event: TouchEvent) => void): T

手指触摸动作触发该回调。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
event	TouchEvent	是	获得TouchEvent对象。

返回值：

类型	说明
T	返回当前组件。

TouchEvent对象说明

继承于BaseEvent。非事件注入场景下，changedTouches是按屏幕显示刷新率重采样的点，touches是按器件刷新率报上来的点，changedTouches的数据可能会和touches里面的不相同。

系统能力： SystemCapability.ArkUI.ArkUI.Full

名称	类型	描述
type	TouchType	触摸事件的类型。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
touches	Array<TouchObject>	全部手指信息。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
changedTouches	Array<TouchObject>	当前发生变化的手指信息。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
stopPropagation	() => void	阻塞事件冒泡。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
preventDefault¹²⁺	() => void	阻止默认事件。说明：该接口仅支持部分组件使用，当前支持组件：Hyperlink。暂不支持异步调用和提供Modifier接口。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。

getHistoricalPoints¹⁰⁺

getHistoricalPoints(): Array<HistoricalPoint>

获取当前帧所有的历史点。不同设备每帧的触摸事件频率不同，且该接口只能在TouchEvent中调用，可以通过该接口获取触发onTouch时当前帧历史点的相关信息。onTouch一帧只会调用一次，若当前帧收到的TouchEvent大于1，会将该帧最后一个点通过onTouch返还，剩余点作为历史点。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

返回值:

类型	描述
Array<HistoricalPoint>	由历史点组成的数组。

TouchObject对象说明

系统能力： SystemCapability.ArkUI.ArkUI.Full

名称	类型	描述
type	TouchType	触摸事件的类型。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
id	number	手指唯一标识符。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
x	number	触摸点相对于事件响应组件的左上角的X坐标。单位：vp 原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
y	number	触摸点相对于事件响应组件的左上角的Y坐标。单位：vp 原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
windowX¹⁰⁺	number	触摸点相对于应用窗口左上角的X坐标。单位：vp 原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
windowY¹⁰⁺	number	触摸点相对于应用窗口左上角的Y坐标。单位：vp 原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
displayX¹⁰⁺	number	触摸点相对于应用屏幕左上角的X坐标。单位：vp 原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
displayY¹⁰⁺	number	触摸点相对于应用屏幕左上角的Y坐标。单位：vp 原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
screenX^(deprecated)	number	触摸点相对于应用窗口左上角的X坐标。单位：vp 从API version 10开始不再维护，建议使用windowX代替。
screenY^(deprecated)	number	触摸点相对于应用窗口左上角的Y坐标。单位：vp 从API version 10开始不再维护，建议使用windowY代替。
PressedTime¹⁵⁺	number	当前手指按下的时间。原子化服务API：从API version 15开始，该接口支持在原子化服务中使用。
pressure¹⁵⁺	number	当前手指按着的压力值。原子化服务API：从API version 15开始，该接口支持在原子化服务中使用。
width¹⁵⁺	number	当前手指按压区域的宽。原子化服务API：从API version 15开始，该接口支持在原子化服务中使用。
height¹⁵⁺	number	当前手指按压区域的高。原子化服务API：从API version 15开始，该接口支持在原子化服务中使用。
hand¹⁵⁺	InteractionHand	表示事件是由左手点击还是右手点击触发。原子化服务API：从API version 15开始，该接口支持在原子化服务中使用。

HistoricalPoint¹⁰⁺对象说明

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

名称	类型	描述
touchObject	TouchObject	历史点对应触摸事件的基础信息。
size	number	历史点对应触摸事件的手指与屏幕的触摸区域大小。默认值：0
force	number	历史点对应触摸事件的压力大小。默认值：0 取值范围：[0,65535)，压力越大值越大。
timestamp	number	历史点对应触摸事件的时间戳。触发事件时距离系统启动的时间间隔。单位：ns

示例

该示例通过按钮设置了触摸事件，手指点击按钮时可获取触摸事件的相关参数。

// 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){
            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 + '\ntargetDisplayId:' +
            event.targetDisplayId + '\npressedTime:' + event.touches[0].pressedTime + '\npressure:' +
            event.touches[0].pressure +
              '\nwidth:' + event.touches[0].width + '\nheight:' + event.touches[0].height
          }
        })
      Button('Touch').height(50).width(200).margin(20)
        .onTouch((event?: TouchEvent) => {
          if(event){
            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 + '\ntargetDisplayId:' +
            event.targetDisplayId + '\npressedTime:' + event.touches[0].pressedTime + '\npressure:' +
            event.touches[0].pressure +
              '\nwidth:' + event.touches[0].width + '\nheight:' + event.touches[0].height
          }
        })
      Text(this.text)
    }.width('100%').padding(30)
  }
}

touch

触摸事件

onTouch

TouchEvent对象说明

getHistoricalPoints10+

TouchObject对象说明

HistoricalPoint10+对象说明

示例

getHistoricalPoints¹⁰⁺

HistoricalPoint¹⁰⁺对象说明