点击事件

组件被点击时触发的事件。

说明：

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

onClick

onClick(event: (event: ClickEvent) => void): T

点击动作触发该回调。

卡片能力： 从API version 9开始，该接口支持在ArkTS卡片中使用。

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

参数：

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

返回值：

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

ClickEvent对象说明

从API version 9开始，该接口支持在ArkTS卡片中使用。

名称 类型 描述
x number 点击位置相对于被点击元素左边缘的X坐标。
单位：vp
y number 点击位置相对于被点击元素原始区域左上角的Y坐标。
单位：vp
timestamp8+ number 事件时间戳。触发事件时距离系统启动的时间间隔。
单位：ns
target8+ EventTarget 触发事件的元素对象显示区域。
source8+ SourceType 事件输入设备。
windowX10+ number 点击位置相对于应用窗口左上角的X坐标。
单位：vp
windowY10+ number 点击位置相对于应用窗口左上角的Y坐标。
单位：vp
displayX10+ number 点击位置相对于应用屏幕左上角的X坐标。
单位：vp
displayY10+ number 点击位置相对于应用屏幕左上角的Y坐标。
单位：vp
screenX(deprecated) number 点击位置相对于应用窗口左上角的X坐标。
从API verdion 10开始不再维护，建议使用windowX代替。
screenY(deprecated) number 点击位置相对于应用窗口左上角的Y坐标。
从API verdion 10开始不再维护，建议使用windowY代替。

EventTarget8+对象说明

从API version 9开始，该接口支持在ArkTS卡片中使用。

名称 参数类型 描述
area Area 目标元素的区域信息。

示例

// xxx.ets
@Entry
@Component
struct ClickExample {
  @State text: string = ''

  build() {
    Column() {
      Row({ space: 20 }) {
        Button('Click').width(100).height(40)
          .onClick((event?: ClickEvent) => {
            if(event){
              this.text = 'Click Point:' + '\n  windowX:' + event.windowX + '\n  windowY:' + event.windowY
              + '\n  x:' + event.x + '\n  y:' + event.y + '\ntarget:' + '\n  component globalPos:('
              + event.target.area.globalPosition.x + ',' + event.target.area.globalPosition.y + ')\n  width:'
              + event.target.area.width + '\n  height:' + event.target.area.height + '\ntimestamp' + event.timestamp;
            }
          })
        Button('Click').width(200).height(50)
          .onClick((event?: ClickEvent) => {
            if(event){
              this.text = 'Click Point:' + '\n  windowX:' + event.windowX + '\n  windowY:' + event.windowY
              + '\n  x:' + event.x + '\n  y:' + event.y + '\ntarget:' + '\n  component globalPos:('
              + event.target.area.globalPosition.x + ',' + event.target.area.globalPosition.y + ')\n  width:'
              + event.target.area.width + '\n  height:' + event.target.area.height + '\ntimestamp' + event.timestamp;
            }
          })
      }.margin(20)

      Text(this.text).margin(15)
    }.width('100%')
  }
}

zh-cn_image_0000001210353788