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