• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Types
2<!--Kit: ArkUI-->
3<!--Subsystem: ArkUI-->
4<!--Owner: @jiangtao92-->
5<!--Designer: @piggyguy-->
6<!--Tester: @songyanhong-->
7<!--Adviser: @HelloCrease-->
8
9> **说明:**
10>
11> 本模块首批接口从API version 12开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
12
13## CustomBuilderWithId<sup>18+</sup>
14
15type CustomBuilderWithId = (id: number)&nbsp;=&gt;&nbsp;void
16
17组件属性、方法参数可使用CustomBuilderWithId类型来自定义UI描述,并且可以指定组件ID生成用户自定义组件。
18
19**原子化服务API:** 从API version 18开始,该接口支持在原子化服务中使用。
20
21**系统能力:** SystemCapability.ArkUI.ArkUI.Full
22
23**参数:**
24
25| 参数名 | 类型 | 必填 | 说明 |
26| -------- | -------- | -------- | -------- |
27| id | number | 是 | 组件ID。 |
28
29## ClickEventListenerCallback<sup>12+</sup>
30
31type ClickEventListenerCallback = (event: ClickEvent, node?: FrameNode) => void
32
33ArkTS GestureEvent事件监听函数类型。
34
35**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
36
37**系统能力:** SystemCapability.ArkUI.ArkUI.Full
38
39**参数:**
40
41| 参数名  | 类型   | 必填 | 说明                          |
42| ------- | ------ | ---- | --------------------------- |
43| event | [ClickEvent](../apis-arkui/arkui-ts/ts-universal-events-click.md#clickevent对象说明) | 是 | 触发事件监听的点击事件的相关信息。 |
44| node | [FrameNode](js-apis-arkui-frameNode.md) | 否 | 触发事件监听的点击事件所绑定的组件。 |
45
46## PanListenerCallback<sup>19+</sup>
47
48type PanListenerCallback = (event: GestureEvent, current: GestureRecognizer, node?: FrameNode) => void
49
50Pan手势事件监听函数类型。
51
52**原子化服务API:** 从API version 19开始,该接口支持在原子化服务中使用。
53
54**系统能力:** SystemCapability.ArkUI.ArkUI.Full
55
56**参数:**
57
58| 参数名  | 类型              | 必填 | 说明                                |
59| ------- | ----------------- | ---- | --------------------------------- |
60| event   | [GestureEvent](../apis-arkui/arkui-ts/ts-gesture-common.md#gestureevent对象说明)      | 是   | 触发事件监听的手势事件的相关信息。   |
61| current | [GestureRecognizer](arkui-ts/ts-gesture-common.md#gesturerecognizer12) | 是   | 触发事件监听的手势识别器的相关信息。  |
62| node    | [FrameNode](js-apis-arkui-frameNode.md)         | 否   | 触发事件监听的手势事件所绑定的组件。 |
63
64## GestureEventListenerCallback<sup>12+</sup>
65
66type GestureEventListenerCallback = (event: GestureEvent, node?: FrameNode) => void
67
68ArkTS GestureEvent事件监听函数类型。
69
70**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
71
72**系统能力:** SystemCapability.ArkUI.ArkUI.Full
73
74**参数:**
75
76| 参数名  | 类型   | 必填 | 说明                          |
77| ------- | ------ | ---- | --------------------------- |
78| event | [GestureEvent](../apis-arkui/arkui-ts/ts-gesture-common.md#gestureevent对象说明) | 是 | 触发事件监听的手势事件的相关信息。 |
79| node | [FrameNode](js-apis-arkui-frameNode.md) | 否 | 触发事件监听的手势事件所绑定的组件。 |
80
81## NodeIdentity<sup>20+</sup>
82
83type NodeIdentity = string | number
84
85组件标识。
86
87**原子化服务API:** 从API version 20开始,该接口支持在原子化服务中使用。
88
89**系统能力:** SystemCapability.ArkUI.ArkUI.Full
90
91| 类型              | 说明                                |
92| ----------------- | --------------------------------- |
93| string      | 指定组件id,该id通过通用属性[id](./arkui-ts/ts-universal-attributes-component-id.md#id)设置。   |
94| number | 系统分配的唯一标识的节点UniqueID,可通过[getUniqueId](js-apis-arkui-frameNode.md#getuniqueid12)获取。  |
95
96## NodeRenderStateChangeCallback<sup>20+</sup>
97
98type NodeRenderStateChangeCallback = (state: NodeRenderState, node?: FrameNode) => void
99
100定义了用于在UIObserver中监控某个特定节点渲染状态的回调类型。
101
102**原子化服务API:** 从API version 20开始,该接口支持在原子化服务中使用。
103
104**系统能力:** SystemCapability.ArkUI.ArkUI.Full
105
106**参数:**
107
108| 参数名  | 类型              | 必填 | 说明                                |
109| ------- | ----------------- | ---- | --------------------------------- |
110| state   | [NodeRenderState](arkts-apis-uicontext-e.md#noderenderstate20)     | 是   | 触发事件监听的手势事件的相关信息。   |
111| node    | [FrameNode](js-apis-arkui-frameNode.md)         | 否   | 触发事件监听的手势事件所绑定的组件,如果组件被释放将返回null。 |
112
113## GestureListenerCallback<sup>20+</sup>
114
115type GestureListenerCallback = (info: GestureTriggerInfo) => void
116
117定义了用于在UIObserver中监控特定手势触发信息的回调类型。
118
119**原子化服务API:** 从API version 20开始,该接口支持在原子化服务中使用。
120
121**系统能力:** SystemCapability.ArkUI.ArkUI.Full
122
123**参数:**
124
125| 参数名  | 类型              | 必填 | 说明                                |
126| ------- | ----------------- | ---- | --------------------------------- |
127| info   | [GestureTriggerInfo](arkts-apis-uicontext-i.md#gesturetriggerinfo20)     | 是   |  交互触发的手势详情。 |
128
129## PointerStyle<sup>12+</sup>
130
131type PointerStyle = pointer.PointerStyle
132
133光标样式。
134
135**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
136
137**系统能力:** SystemCapability.MultimodalInput.Input.Pointer
138
139|类型|说明|
140| -- | -- |
141|[pointer.PointerStyle](../apis-input-kit/js-apis-pointer.md#pointerstyle) |光标样式。|
142
143## Context<sup>12+</sup>
144
145type Context = common.Context
146
147当前组件所在Ability的上下文。
148
149**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
150
151**系统能力:** SystemCapability.Ability.AbilityRuntime.Core
152
153**模型约束:** 此接口仅可在Stage模型下使用。
154
155| 类型 |说明   |
156| ------ | ------------------- |
157| [common.Context](../apis-ability-kit/js-apis-app-ability-common.md#context) |Context的具体类型为当前Ability关联的Context对象。|