1# 通用事件 2 3> **说明：** 4> 5> 从API version 4开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 6 7## 事件说明 8 9- 事件绑定在组件上，当组件达到事件触发条件时，会执行JS中对应的事件回调函数，实现页面UI视图和页面JS逻辑层的交互； 10 11- 事件回调函数中通过参数可以携带额外的信息，如组件上的数据对象dataset，事件特有的回调参数。 12 13 14相对于私有事件，大部分组件都可以绑定如下事件。 15 16 17| 名称 | 参数 | 描述 | 是否支持冒泡 | 是否支持捕获 | 18| ------------------------ | ---------- | ------------------------------------------------------------ | ----------------------------------------------------- | --------------- | 19| touchstart | TouchEvent | 手指刚触摸屏幕时触发该事件。TouchEvent具体可参考表2 。 | 是<sup>5+</sup> | 是<sup>5+</sup> | 20| touchmove | TouchEvent | 手指触摸屏幕后移动时触发该事件。 | 是<sup>5+</sup> | 是<sup>5+</sup> | 21| touchcancel | TouchEvent | 手指触摸屏幕中动作被打断时触发该事件。 | 是<sup>5+</sup> | 是<sup>5+</sup> | 22| touchend | TouchEvent | 手指触摸结束离开屏幕时触发该事件。 | 是<sup>5+</sup> | 是<sup>5+</sup> | 23| click | - | 点击动作触发该事件。 | 是<sup>6+</sup> | 否 | 24| doubleclick<sup>7+</sup> | - | 双击动作触发该事件 | 否<br/> 从API Version 9 开始支持冒泡。 | 否 | 25| longpress | - | 长按动作触发该事件。 | 否<br/>从API Version 9 开始支持冒泡。 | 否 | 26| swipe<sup>5+</sup> | SwipeEvent | 组件上快速滑动后触发该事件。 SwipeEvent具体可参考表4 。 | 否<br/>从API Version 9 开始支持冒泡。 | 否 | 27| attached<sup>6+</sup> | - | 当前组件节点挂载在渲染树后触发。 | 否 | 否 | 28| detached<sup>6+</sup> | - | 当前组件节点从渲染树中移除后触发。 | 否 | 否 | 29| pinchstart<sup>7+</sup> | PinchEvent | 手指开始执行捏合操作时触发该事件。<br/>PinchEvent具体可参考表5。 | 否 | 否 | 30| pinchupdate<sup>7+</sup> | PinchEvent | 手指执行捏合操作过程中触发该事件。 | 否 | 否 | 31| pinchend<sup>7+</sup> | PinchEvent | 手指捏合操作结束离开屏幕时触发该事件。 | 否 | 否 | 32| pinchcancel<sup>7+</sup> | PinchEvent | 手指捏合操作被打断时触发该事件。 | 否 | 否 | 33| dragstart<sup>7+</sup> | DragEvent | 用户开始拖拽时触发该事件。<br/>DragEvent具体可参考表6。 | 否 | 否 | 34| drag<sup>7+</sup> | DragEvent | 拖拽过程中触发该事件。 | 否 | 否 | 35| dragend<sup>7+</sup> | DragEvent | 用户拖拽完成后触发。 | 否 | 否 | 36| dragenter<sup>7+</sup> | DragEvent | 进入释放目标时触发该事件。 | 否 | 否 | 37| dragover<sup>7+</sup> | DragEvent | 在释放目标内拖动时触发。 | 否 | 否 | 38| dragleave<sup>7+</sup> | DragEvent | 离开释放目标区域时触发。 | 否 | 否 | 39| drop<sup>7+</sup> | DragEvent | 在可释放目标区域内释放时触发。 | 否 | 否 | 40 41 42> **说明：** 43> 除上述事件外，其他事件均为非冒泡事件，如[input的change事件](../arkui-js/js-components-basic-input.md#事件)，详见各个组件。 44 45**表1** BaseEvent对象属性列表 46 47| 属性 | 类型 | 说明 | 48| --------------------- | -------------------- | --------------------------- | 49| type | string | 当前事件的类型，比如click、longpress等。 | 50| timestamp | number | 该事件触发时的时间戳。 | 51| deviceId<sup>6+</sup> | number | 触发该事件的设备ID信息。 | 52| target<sup>6+</sup> | [Target](#target对象6) | 触发该事件的目标对象。 | 53 54**表2** TouchEvent对象属性列表(继承BaseEvent) 55 56| 属性 | 类型 | 说明 | 57| -------------- | ---------------------- | ---------------------------------------- | 58| touches | Array<TouchInfo> | 触摸事件时的属性集合，包含屏幕触摸点的信息数组。 | 59| changedTouches | Array<TouchInfo> | 触摸事件时的属性集合，包括产生变化的屏幕触摸点的信息数组。数据格式和touches一样。该属性表示有变化的触摸点，如从无变有，位置变化，从有变无。例如用户手指刚接触屏幕时，touches数组中有数据，但changedTouches无数据。 | 60 61**表3** TouchInfo 62 63| 属性 | 类型 | 说明 | 64| ------------------ | ------ | ------------------------------ | 65| globalX | number | 距离屏幕左上角（不包括状态栏）横向距离。屏幕的左上角为原点。 | 66| globalY | number | 距离屏幕左上角（不包括状态栏）纵向距离。屏幕的左上角为原点。 | 67| localX | number | 距离被触摸组件左上角横向距离。组件的左上角为原点。 | 68| localY | number | 距离被触摸组件左上角纵向距离。组件的左上角为原点。 | 69| size | number | 触摸接触面积。 | 70| force<sup>6+</sup> | number | 接触力信息。 | 71 72**表4** SwipeEvent 基础事件对象属性列表（继承BaseEvent） 73 74| 属性 | 类型 | 说明 | 75| --------------------- | ------ | ---------------------------------------- | 76| direction | string | 滑动方向，可能值有：<br/>- left：向左滑动；<br/>- right：向右滑动；<br/>- up：向上滑动；<br/>- down：向下滑动。 | 77| distance<sup>6+</sup> | number | 在滑动方向上的滑动距离。 | 78 79**表5** PinchEvent 对象属性列表<sup>7+</sup> 80 81| 属性 | 类型 | 说明 | 82| ------------ | ------ | -------------- | 83| scale | number | 缩放比例 | 84| pinchCenterX | number | 捏合中心点X轴坐标，单位px | 85| pinchCenterY | number | 捏合中心点Y轴坐标，单位px | 86 87**表6** DragEvent对象属性列表(继承BaseEvent)<sup>7+</sup> 88 89| 属性 | 类型 | 说明 | 90| ------------------------- | -------------------------------- | ---------------- | 91| type | string | 事件名称。 | 92| globalX | number | 距离屏幕左上角坐标原点横向距离。 | 93| globalY | number | 距离屏幕左上角坐标原点纵向距离。 | 94| timestamp | number | 时间戳。 | 95| dataTransfer<sup>9+</sup> | [DataTransfer](#datatransfer对象9) | 用于传输数据。 | 96 97## Target对象<sup>6+</sup> 98 99当组件触发事件后，事件回调函数默认会收到一个事件对象，通过该事件对象可以获取相应的信息。 100 101 102 103| 属性 | 类型 | 说明 | 104| -------------------- | ------ | ---------------------------------------- | 105| dataSet<sup>6+</sup> | Object | 组件上通过通用属性设置的[data-*](../arkui-js/js-components-common-attributes.md)的自定义属性组成的集合。 | 106 107**示例：** 108 109```html 110<!-- xxx.hml --> 111<div> 112 <div data-a="dataA" data-b="dataB" 113 style="width: 100%; height: 50%; background-color: saddlebrown;"@touchstart='touchstartfunc'></div> 114</div> 115``` 116 117```js 118// xxx.js 119export default { 120 touchstartfunc(msg) { 121 console.info(`on touch start, point is: ${msg.touches[0].globalX}`); 122 console.info(`on touch start, data is: ${msg.target.dataSet.a}`); 123 } 124} 125``` 126 127## DataTransfer对象<sup>9+</sup> 128 129在拖拽操作的过程中，可以通过dataTransfer对象来传输数据，以便在拖拽操作结束的时候对数据进行其他操作。 130 131### setData<sup>9+</sup> 132 133setData(key: string, value: object): boolean 134 135设置给定key关联的数据。如果没有与该key关联的数据，则将其添加到末尾。如果该key关联的数据已经存在，则在相同位置替换现有数据。 136 137**参数：** 138 139| 参数名 | 参数类型 | 必填 | 描述 | 140| ----- | ------ | ---- | ------- | 141| key | string | 是 | 数据键值。 | 142| value | object | 是 | 要存储的数据。 | 143 144**返回值：** 145 146| 类型 | 说明 | 147| ------- | ------------------------ | 148| boolean | 执行结果，true表示成功，false表示失败。 | 149 150**示例：** 151 152```js 153// setData的value参数，可以是基本数据类型。 154dragStart(e) { 155 var isSetOk = e.dataTransfer.setData('name', 1); 156}, 157// setData的value参数，也可以是对象类型。 158dragStart(e) { 159 var person = new Object(); 160 person.name = "tom"; 161 person.age = 21; 162 var isSetOk = e.dataTransfer.setData('person', person); 163} 164``` 165### getData<sup>9+</sup> 166 167getData(key: string): object 168 169获取给定key关联的数据，如果没有与该key关联的数据，则返回空字符串。 170 171**参数：** 172 173| 参数名 | 参数类型 | 必填 | 描述 | 174| ---- | ------ | ---- | ----- | 175| key | string | 是 | 数据键值。 | 176 177**返回值：** 178 179| 类型 | 说明 | 180| ------ | ------ | 181| object | 获取的数据。 | 182 183**示例：** 184 185```js 186dragStart(e) { 187 var person = new Object(); 188 person.name = "tom"; 189 person.age = 21; 190 e.dataTransfer.setData('person', person); 191}, 192dragEnd(e){ 193 var person = e.dataTransfer.getData('person'); 194}, 195``` 196### clearData<sup>9+</sup> 197 198clearData(key?: string): boolean 199 200删除给定key关联的数据。如果没有与该key关联的数据，则该方法不会产生任何效果。 201如果key为空，则删除所有数据。 202 203**参数：** 204 205| 参数名 | 参数类型 | 必填 | 描述 | 206| ---- | ------ | ---- | ----- | 207| key | string | 否 | 数据键值。 | 208 209**返回值：** 210 211| 类型 | 说明 | 212| ------- | ------------------------ | 213| boolean | 执行结果，true表示成功，false表示失败。 | 214 215**示例：** 216 217```js 218dragEnd(e) { 219 var isSuccess = e.dataTransfer.clearData('name'); 220} 221``` 222### setDragImage<sup>9+</sup> 223 224setDragImage(pixelmap: PixelMap, offsetX: number,offsetY: number): boolean 225 226用于设置自定义的拖动图像。 227 228**参数：** 229 230| 参数名 | 参数类型 | 必填 | 描述 | 231| -------- | -------- | ---- | ---------------------------------------- | 232| pixelmap | [PixelMap](../apis/js-apis-image.md#pixelmap7) | 是 | 前端传入的图片资源。 | 233| offsetX | number | 是 | 相对于图片的横向偏移量。 | 234| offsetY | number | 是 | 相对于图片的纵向偏移量。 | 235 236**返回值：** 237 238| 类型 | 说明 | 239| ---- | ------------------------ | 240| boolean | 执行结果，true表示成功，false表示失败。 | 241 242**示例：** 243 244```js 245import image from '@ohos.multimedia.image'; 246 247export default { 248 createPixelMap() { 249 let color = new ArrayBuffer(4 * 96 * 96); 250 var buffer = new Uint8Array(color); 251 for (var i = 0; i < buffer.length; i++) { 252 buffer[i] = (i + 1) % 255; 253 } 254 let opts = { 255 alphaType: 0, 256 editable: true, 257 pixelFormat: 4, 258 scaleMode: 1, 259 size: { 260 height: 96, width: 96 261 } 262 } 263 const promise = image.createPixelMap(color, opts); 264 promise.then((data) => { 265 console.error('-create pixmap has info message:' + JSON.stringify(data)); 266 this.pixelMap = data; 267 this.pixelMapReader = data; 268 }) 269 }, 270 271 onInit() { 272 this.createPixelMap 273 }, 274 275 dragStart(e) { 276 e.dataTransfer.setDragImage(this.pixelMapReader, 50, 50); 277 } 278} 279```