1# 设置事件回调
2
3>**说明:**
4>
5>本模块首批接口从API version 12开始支持,后续版本的新增接口,采用上角标单独标记接口的起始版本。
6
7## UICommonEvent
8用于设置基础事件回调。方法入参为undefined的时候,重置对应的事件回调。
9### setOnClick
10
11setOnClick(callback: Callback\<ClickEvent> | undefined): void
12
13设置[点击事件](./ts-universal-events-click.md#点击事件)的回调。
14
15**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
16
17**系统能力:** SystemCapability.ArkUI.ArkUI.Full
18
19**参数:**
20
21| 参数名 | 类型   | 必填 | 说明                       |
22| ------ | ------ | ---- | -------------------------- |
23| callback  | [Callback](./ts-types.md#callback12)<[ClickEvent](./ts-universal-events-click.md#clickevent对象说明)> \| undefined | 是   | 点击事件的回调函数。 |
24
25### setOnTouch
26
27setOnTouch(callback: Callback\<TouchEvent> | undefined): void
28
29设置[触摸事件](./ts-universal-events-touch.md#触摸事件)的回调。
30
31**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
32
33**系统能力:** SystemCapability.ArkUI.ArkUI.Full
34
35**参数:**
36
37| 参数名 | 类型   | 必填 | 说明                       |
38| ------ | ------ | ---- | -------------------------- |
39| callback  | [Callback](./ts-types.md#callback12)<[TouchEvent](./ts-universal-events-touch.md#touchevent对象说明)> \| undefined | 是   | 触摸事件的回调函数。 |
40
41
42### setOnAppear
43
44setOnAppear(callback: Callback\<void> | undefined): void
45
46设置[onAppear](./ts-universal-events-show-hide.md#onappear)事件的回调。
47
48**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
49
50**系统能力:** SystemCapability.ArkUI.ArkUI.Full
51
52**参数:**
53
54| 参数名 | 类型   | 必填 | 说明                       |
55| ------ | ------ | ---- | -------------------------- |
56| callback  | [Callback](./ts-types.md#callback12)\<void> \| undefined | 是   | onAppear事件的回调函数。 |
57
58
59### setOnDisappear
60
61setOnDisappear(callback: Callback\<void> | undefined): void
62
63设置[onDisappear](./ts-universal-events-show-hide.md#ondisappear)事件的回调。
64
65**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
66
67**系统能力:** SystemCapability.ArkUI.ArkUI.Full
68
69**参数:**
70
71| 参数名 | 类型   | 必填 | 说明                       |
72| ------ | ------ | ---- | -------------------------- |
73| callback  | [Callback](./ts-types.md#callback12)\<void> \| undefined | 是   | onDisappear事件的回调。 |
74
75### setOnKeyEvent
76
77setOnKeyEvent(callback: Callback\<KeyEvent> | undefined): void
78
79设置[按键事件](./ts-universal-events-key.md#按键事件)的回调。
80
81**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
82
83**系统能力:** SystemCapability.ArkUI.ArkUI.Full
84
85**参数:**
86
87| 参数名 | 类型   | 必填 | 说明                       |
88| ------ | ------ | ---- | -------------------------- |
89| callback  | [Callback](./ts-types.md#callback12)<[KeyEvent](./ts-universal-events-key.md#keyevent对象说明)>  \| undefined | 是   | 按键事件的回调函数。 |
90
91### setOnFocus
92
93setOnFocus(callback:  Callback\<void> | undefined): void
94
95设置[onFocus](./ts-universal-focus-event.md#onfocus)事件的回调。
96
97**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
98
99**系统能力:** SystemCapability.ArkUI.ArkUI.Full
100
101**参数:**
102
103| 参数名 | 类型   | 必填 | 说明                       |
104| ------ | ------ | ---- | -------------------------- |
105| callback  | [Callback](./ts-types.md#callback12)\<void> \| undefined | 是   | onFocus事件的回调。 |
106
107### setOnBlur
108
109setOnBlur(callback: Callback\<void> | undefined): void
110
111设置[onBlur](./ts-universal-focus-event.md#onblur)事件的回调。
112
113**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
114
115**系统能力:** SystemCapability.ArkUI.ArkUI.Full
116
117**参数:**
118
119| 参数名 | 类型   | 必填 | 说明                       |
120| ------ | ------ | ---- | -------------------------- |
121| callback  | [Callback](./ts-types.md#callback12)\<void> \| undefined | 是   | onBlur事件的回调。 |
122
123### setOnHover
124
125setOnHover(callback: HoverCallback | undefined): void
126
127设置[onHover](./ts-universal-mouse-key.md#onhover)事件的回调。
128
129**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
130
131**系统能力:** SystemCapability.ArkUI.ArkUI.Full
132
133**参数:**
134
135| 参数名 | 类型   | 必填 | 说明                       |
136| ------ | ------ | ---- | -------------------------- |
137| callback  | [HoverCallback](./ts-types.md#hovercallback12)  \| undefined | 是   | onHover事件的回调函数。 |
138
139### setOnMouse
140
141setOnMouse(callback: Callback\<MouseEvent> | undefined): void
142
143设置[onMouse](./ts-universal-mouse-key.md#onmouse)事件的回调。
144
145**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
146
147**系统能力:** SystemCapability.ArkUI.ArkUI.Full
148
149**参数:**
150
151| 参数名 | 类型   | 必填 | 说明                       |
152| ------ | ------ | ---- | -------------------------- |
153| callback  |  [Callback](./ts-types.md#callback12)<[MouseEvent](./ts-universal-mouse-key.md#mouseevent对象说明)>   \| undefined | 是   | onMouse事件的回调函数。 |
154
155### setOnSizeChange
156
157setOnSizeChange(callback: SizeChangeCallback | undefined): void
158
159设置[onSizeChange](./ts-universal-component-size-change-event.md#onsizechange)事件的回调。
160
161**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
162
163**系统能力:** SystemCapability.ArkUI.ArkUI.Full
164
165**参数:**
166
167| 参数名 | 类型   | 必填 | 说明                       |
168| ------ | ------ | ---- | -------------------------- |
169| callback  | [SizeChangeCallback](./ts-universal-component-size-change-event.md#sizechangecallback)   \| undefined | 是   | onSizeChange事件的回调函数。 |
170
171### setOnVisibleAreaApproximateChange
172
173setOnVisibleAreaApproximateChange(options: VisibleAreaEventOptions, event: VisibleAreaChangeCallback | undefined): void
174
175设置限制回调间隔的[onVisibleAreaChange](./ts-universal-component-visible-area-change-event.md#onvisibleareachange)事件的回调。
176
177**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
178
179**系统能力:** SystemCapability.ArkUI.ArkUI.Full
180
181**参数:**
182
183| 参数名 | 类型   | 必填 | 说明                       |
184| ------ | ------ | ---- | -------------------------- |
185| options  | [VisibleAreaEventOptions](./ts-types.md#visibleareaeventoptions12) | 是   | 可见区域变化相关的参数。 |
186| event  | [VisibleAreaChangeCallback](./ts-types.md#visibleareachangecallback12)   \| undefined | 是   | onVisibleAreaChange事件的回调函数。当组件可见面积与自身面积的比值接近options中设置的阈值时触发该回调。 |
187
188>**说明:**
189>
190> 非实时回调,实际回调与预期间隔可能存在差别。
191>
192> 两次可见区域回调的时间间隔不小于预期更新间隔。当开发者设置的预期间隔过小时,由系统负载决定实际回调间隔时间。
193>
194> 当前接口的可见区域回调阈值默认包含0。例如,开发者设置回调阈值为[0.5],实际生效的阈值为[0.0, 0.5]。
195