• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# ArkUI_NativeModule
2
3
4## 概述
5
6提供ArkUI在Native侧的通用拖拽及主动发起拖拽能力。更多详细介绍请参考[拖拽事件](../../ui/ndk-drag-event.md)。
7
8提供ArkUI在Native侧的通用按键事件能力。
9
10提供ArkUI在Native侧的注册手势回调的能力。更多详细介绍请参考[绑定手势事件](../../ui/ndk-bind-gesture-events.md)。
11
12提供ArkUI在Native侧动画回调的能力。更多详细介绍请参考[使用动画](../../ui/ndk-use-animation.md)。
13
14提供ArkUI在Native侧的UI能力,如UI组件创建销毁、树节点操作,属性设置,事件监听等。更多详细介绍请参考[接入ArkTS页面](../../ui/ndk-access-the-arkts-page.md)。
15
16**起始版本:** 12
17
18
19## 汇总
20
21
22### 文件
23
24| 名称 | 描述 |
25| -------- | -------- |
26| [drag_and_drop.h](drag__and__drop_8h.md) | 提供NativeDrag相关接口定义。  |
27| [drawable_descriptor.h](drawable__descriptor_8h.md) | 提供NativeDrawableDescriptor接口的类型定义。  |
28| [native_animate.h](native__animate_8h.md) | 提供ArkUI在Native侧的动画接口定义集合。  |
29| [native_dialog.h](native__dialog_8h.md) | 提供ArkUI在Native侧的自定义弹窗接口定义集合。  |
30| [native_gesture.h](native__gesture_8h.md) | 提供NativeGesture接口的类型定义。  |
31| [native_interface.h](native__interface_8h.md) | 提供NativeModule接口的统一入口函数。  |
32| [native_interface_focus.h](native__interface__focus_8h.md) | 提供NativeFocus相关接口定义。 |
33| [native_key_event.h](native__key_event_8h.md) | 提供NativeKeyEvent相关接口定义。  |
34| [native_node.h](native__node_8h.md) | 提供NativeNode接口的类型定义。  |
35| [native_node_napi.h](native__node__napi_8h.md) | 提供ArkTS侧的FrameNode转换NodeHandle的方式。  |
36| [native_type.h](native__type_8h.md) | 提供NativeModule公共的类型定义。  |
37| [styled_string.h](styled__string_8h.md) | 提供ArkUI在Native侧的属性字符串能力。  |
38
39
40### 结构体
41
42| 名称 | 描述 |
43| -------- | -------- |
44| struct  [ArkUI_ExpectedFrameRateRange](_ark_u_i___expected_frame_rate_range.md) | 设置动画的期望帧率。  |
45| struct  [ArkUI_AnimateCompleteCallback](_ark_u_i___animate_complete_callback.md) | 动画播放完成回调类型。  |
46| struct  [ArkUI_NativeAnimateAPI_1](_ark_u_i___native_animate_a_p_i__1.md) | ArkUI提供的Native侧动画接口集合。  |
47| struct  [ArkUI_NativeDialogAPI_1](_ark_u_i___native_dialog_a_p_i__1.md) | ArkUI提供的Native侧自定义弹窗接口集合。  |
48| struct  [ArkUI_NativeGestureAPI_1](_ark_u_i___native_gesture_a_p_i__1.md) | 手势模块接口集合。  |
49| struct  [ArkUI_NativeGestureAPI_2](_ark_u_i___native_gesture_a_p_i__2.md) | 新增手势模块接口集合,支持设置手势中断事件的回调函数。 |
50| struct  [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) | 定义**setAttribute**函数通用入参结构。  |
51| struct  [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) | 定义组件回调事件的参数类型。  |
52| struct  [ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md) | 定义组件回调事件使用字符串参数的类型。  |
53| struct  [ArkUI_NativeNodeAPI_1](_ark_u_i___native_node_a_p_i__1.md) | ArkUI提供的Native侧Node类型接口集合。  |
54| struct  [ArkUI_ContextCallback](_ark_u_i___context_callback.md) | 事件回调类型。  |
55| union  [ArkUI_NumberValue](union_ark_u_i___number_value.md) | ArkUI在native侧的数字类型定义。  |
56| struct  [ARKUI_TextPickerRangeContent](_a_r_k_u_i___text_picker_range_content.md) | 定义单列滑动数据选择器支持图片资源的输入结构体。  |
57| struct  [ARKUI_TextPickerCascadeRangeContent](_a_r_k_u_i___text_picker_cascade_range_content.md) | 定义多列带联动能力的滑动数据选择器的输入结构体。  |
58| struct  [ArkUI_ColorStop](_ark_u_i___color_stop.md) | 定义渐变色结构。  |
59| struct  [ArkUI_Rect](_ark_u_i___rect.md) | 定义遮罩屏蔽区域的范围结构体。  |
60| struct  [ArkUI_IntSize](_ark_u_i___int_size.md) | 尺寸类型,用于描述组件的宽高。  |
61| struct  [ArkUI_IntOffset](_ark_u_i___int_offset.md) | 位置,用于描述组件的位置。  |
62| struct  [ArkUI_Margin](_ark_u_i___margin.md) | 外边距属性,用于描述组件的外边距属性。  |
63| struct  [ArkUI_TranslationOptions](_ark_u_i___translation_options.md) | 定义组件转场时的平移效果对象。  |
64| struct  [ArkUI_ScaleOptions](_ark_u_i___scale_options.md) | 定义组件转场时的缩放效果对象。  |
65| struct  [ArkUI_RotationOptions](_ark_u_i___rotation_options.md) | 定义组件转场时的旋转效果对象。  |
66| struct  [ArkUI_TextChangeEvent](_ark_u_i___text_change_event.md) | 定义输入框内容改变(包含预上屏内容)回调事件的返回值类型。  |
67
68
69### 宏定义
70
71| 名称 | 描述 |
72| -------- | -------- |
73| [OH_ArkUI_GetModuleInterface](#oh_arkui_getmoduleinterface)(nativeAPIVariantKind, structType, structPtr) | 基于结构体类型获取对应结构体指针的宏函数。  |
74| **MAX_NODE_SCOPE_NUM** | 1000 |
75| **MAX_COMPONENT_EVENT_ARG_NUM** | 12 |
76| **UDMF_KEY_BUFFER_LEN** | 512 |
77
78
79### 类型定义
80
81| 名称 | 描述 |
82| -------- | -------- |
83| typedef struct [ArkUI_NodeEvent](#arkui_nodeevent-12) [ArkUI_NodeEvent](#arkui_nodeevent-12) | 组件事件的通用结构类型。  |
84| typedef struct [ArkUI_Context](#arkui_context) [ArkUI_Context](#arkui_context) | native UI的上下文实例对象。  |
85| typedef struct [ArkUI_Context](#arkui_context) \* [ArkUI_ContextHandle](#arkui_contexthandle-12) | native UI的上下文实例对象指针定义。  |
86| typedef struct [ArkUI_DragEvent](#arkui_dragevent) [ArkUI_DragEvent](#arkui_dragevent) | 拖拽事件。  |
87| typedef struct [ArkUI_DragPreviewOption](#arkui_dragpreviewoption) [ArkUI_DragPreviewOption](#arkui_dragpreviewoption) | 设置拖拽跟手图的相关自定义参数。  |
88| typedef struct [ArkUI_DragAction](#arkui_dragaction) [ArkUI_DragAction](#arkui_dragaction) | 拖拽行为,用于主动发起拖拽。  |
89| typedef struct [ArkUI_DragAndDropInfo](#arkui_draganddropinfo) [ArkUI_DragAndDropInfo](#arkui_draganddropinfo) | 主动发起拖拽后,通过拖拽状态监听返回的系统拖拽相关数据。  |
90| typedef struct [OH_UdmfData](#oh_udmfdata) [OH_UdmfData](#oh_udmfdata) | UDMF 统一数据定义。  |
91| typedef struct [OH_PixelmapNative](#oh_pixelmapnative) [OH_PixelmapNative](#oh_pixelmapnative) | Pixelmap结构体类型,用于执行Pixelmap相关操作。  |
92| typedef struct [ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) [ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) | 定义 DrawableDescriptor 对象。  |
93| typedef struct [OH_PixelmapNative](#oh_pixelmapnative) \* [OH_PixelmapNativeHandle](#oh_pixelmapnativehandle) | 定义OH_PixelmapNative对象指针类型。  |
94| typedef struct [ArkUI_AnimateOption](#arkui_animateoption) [ArkUI_AnimateOption](#arkui_animateoption) | 设置动画效果相关参数。  |
95| typedef struct ArkUI_Curve \* [ArkUI_CurveHandle](#arkui_curvehandle) | 定义曲线的插值对象指针定义。  |
96| typedef struct [ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) [ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) | 定义关键帧动画参数对象。  |
97| typedef struct [ArkUI_AnimatorOption](#arkui_animatoroption) [ArkUI_AnimatorOption](#arkui_animatoroption) | 定义animator动画参数对象。  |
98| typedef struct ArkUI_Animator \* [ArkUI_AnimatorHandle](#arkui_animatorhandle) | 定义animator动画对象指针。  |
99| typedef struct [ArkUI_TransitionEffect](#arkui_transitioneffect) [ArkUI_TransitionEffect](#arkui_transitioneffect) | 定义transition属性配置转场参数对象。  |
100| typedef bool(\* [ArkUI_OnWillDismissEvent](#arkui_onwilldismissevent)) (int32_t reason) | 弹窗关闭的回调函数。  |
101| typedef struct [ArkUI_DialogDismissEvent](#arkui_dialogdismissevent) [ArkUI_DialogDismissEvent](#arkui_dialogdismissevent) | 定义弹窗关闭事件对象。  |
102| typedef struct [ArkUI_CustomDialogOptions ](#arkui_customdialogoptions) [ArkUI_CustomDialogOptions ](#arkui_customdialogoptions) | 定义自定义弹窗的内容对象。  |
103| typedef uint32_t [ArkUI_GestureEventActionTypeMask](#arkui_gestureeventactiontypemask) | 定义手势事件类型集合。  |
104| typedef uint32_t [ArkUI_GestureDirectionMask](#arkui_gesturedirectionmask) | 定义滑动手势方向集合。  |
105| typedef ArkUI_GestureRecognizer \* [ArkUI_GestureRecognizerHandle](#arkui_gesturerecognizerhandle) | 提供手势识别器句柄类型对象定义。  |
106| typedef [ArkUI_GestureRecognizerHandle](#arkui_gesturerecognizerhandle) \* [ArkUI_GestureRecognizerHandleArray](#arkui_gesturerecognizerhandlearray) | 提供手势识别器句柄类型数组对象定义。  |
107| typedef ArkUI_TouchRecognizer  \* [ArkUI_TouchRecognizerHandle](#arkui_touchrecognizerhandle) | 提供触摸识别器句柄类型对象定义。  |
108| typedef [ArkUI_TouchRecognizerHandle](#arkui_touchrecognizerhandle) \* [ArkUI_TouchRecognizerHandleArray](#arkui_touchrecognizerhandlearray) | 提供触摸识别器句柄类型数组对象定义。  |
109| typedef struct [ArkUI_GestureEventTargetInfo](#arkui_gestureeventtargetinfo) [ArkUI_GestureEventTargetInfo](#arkui_gestureeventtargetinfo) | 提供手势事件目标信息类型对象定义。  |
110| typedef struct [ArkUI_ParallelInnerGestureEvent](#arkui_parallelinnergestureevent) [ArkUI_ParallelInnerGestureEvent](#arkui_parallelinnergestureevent) | 提供并行内部手势事件类型对象定义。  |
111| typedef void(\* [ArkUI_GestureRecognizerDisposeNotifyCallback](#arkui_gesturerecognizerdisposenotifycallback)) (ArkUI_GestureRecognizer \*recognizer, void \*userData) | 定义手势识别器析构通知事件的回调函数类型。  |
112| typedef struct [ArkUI_NodeEvent](#arkui_nodeevent-12) [ArkUI_NodeEvent](#arkui_nodeevent-12) | 定义组件事件的通用结构类型。  |
113| typedef struct [ArkUI_NodeCustomEvent](#arkui_nodecustomevent) [ArkUI_NodeCustomEvent](#arkui_nodecustomevent) | 定义自定义组件事件的通用结构类型。  |
114| typedef struct ArkUI_NodeAdapter \* [ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) | 定义组件适配器对象,用于滚动类组件的元素懒加载。  |
115| typedef struct [ArkUI_NodeAdapterEvent](#arkui_nodeadapterevent) [ArkUI_NodeAdapterEvent](#arkui_nodeadapterevent) | 定义适配器事件对象。  |
116| typedef struct [ArkUI_NodeContentEvent](#arkui_nodecontentevent) [ArkUI_NodeContentEvent](#arkui_nodecontentevent) | 定义NodeContent事件的通用结构类型。  |
117| typedef void(\* [ArkUI_NodeContentCallback](#arkui_nodecontentcallback)) ([ArkUI_NodeContentEvent](#arkui_nodecontentevent) \*event) | 定义NodeContent事件的回调函数类型。  |
118| typedef struct [ArkUI_LayoutConstraint](#arkui_layoutconstraint) [ArkUI_LayoutConstraint](#arkui_layoutconstraint) | 约束尺寸,组件布局时,进行尺寸范围限制。  |
119| typedef struct [ArkUI_DrawContext](#arkui_drawcontext) [ArkUI_DrawContext](#arkui_drawcontext) | 定义组件绘制上下文类型结构。  |
120| typedef struct ArkUI_Node \* [ArkUI_NodeHandle](#arkui_nodehandle) | 定义ArkUI native组件实例对象指针定义。  |
121| typedef struct ArkUI_NativeDialog \* [ArkUI_NativeDialogHandle](#arkui_nativedialoghandle) | 定义ArkUI在Native侧的自定义弹窗控制器对象指针。  |
122| typedef struct [ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) [ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) | 定义FlowItem分组配置信息。  |
123| typedef struct [ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) [ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) | 定义ListItemSwipeActionOption方法内Item的配置信息。  |
124| typedef struct [ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption) [ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption) | 定义ListItemSwipeActionOption方法的配置信息。  |
125| typedef struct [ArkUI_Context](#arkui_context) \* [ArkUI_ContextHandle](#arkui_contexthandle-12) | 定义ArkUI native UI的上下文实例对象指针定义。  |
126| typedef struct ArkUI_NodeContent \* [ArkUI_NodeContentHandle](#arkui_nodecontenthandle) | 定义ArkUI NodeContent实例在Native侧的实例对象指针定义。  |
127| typedef struct [ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) [ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) | 指定设置在相对容器中子组件的对齐规则。  |
128| typedef struct [ArkUI_GuidelineOption](#arkui_guidelineoption) [ArkUI_GuidelineOption](#arkui_guidelineoption) | guideLine参数,用于定义guideline的id、方向和位置。  |
129| typedef struct [ArkUI_BarrierOption](#arkui_barrieroption) [ArkUI_BarrierOption](#arkui_barrieroption) | barrier参数,用于定义barrier的id、方向和生成时所依赖的组件。  |
130| typedef struct [ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) [ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) | 定义图片帧信息。  |
131| typedef struct [ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) [ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) | 定义List的ChildrenMainSize类信息。  |
132| typedef struct [ArkUI_AccessibilityState](#arkui_accessibilitystate) [ArkUI_AccessibilityState](#arkui_accessibilitystate) | 定义组件无障碍状态。  |
133| typedef struct [ArkUI_AccessibilityValue](#arkui_accessibilityvalue) [ArkUI_AccessibilityValue](#arkui_accessibilityvalue) | 定义组件无障碍信息值。  |
134| typedef struct [ArkUI_SystemFontStyleEvent](#arkui_systemfontstyleevent) [ArkUI_SystemFontStyleEvent](#arkui_systemfontstyleevent) | 系统字体变更事件定义。  |
135| typedef struct [ArkUI_CustomSpanMeasureInfo](#arkui_customspanmeasureinfo) [ArkUI_CustomSpanMeasureInfo](#arkui_customspanmeasureinfo) | 自定义段落组件的测量信息。  |
136| typedef struct [ArkUI_CustomSpanMetrics](#arkui_customspanmetrics) [ArkUI_CustomSpanMetrics](#arkui_customspanmetrics) | 自定义段落组件的度量指标。  |
137| typedef struct [ArkUI_CustomSpanDrawInfo](#arkui_customspandrawinfo) [ArkUI_CustomSpanDrawInfo](#arkui_customspandrawinfo) | 自定义段落组件的绘制信息。  |
138| typedef struct [ArkUI_SwiperIndicator](#arkui_swiperindicator) [ArkUI_SwiperIndicator](#arkui_swiperindicator) | 定义 Swiper 组件的导航指示器风格。  |
139| typedef struct [ArkUI_StyledString_Descriptor](#arkui_styledstring_descriptor) [ArkUI_StyledString_Descriptor](#arkui_styledstring_descriptor) | 定义文本组件支持的属性字符串的数据对象。  |
140| typedef struct [ArkUI_StyledString](#arkui_styledstring) [ArkUI_StyledString](#arkui_styledstring) | 定义文本组件支持的格式化字符串数据对象。  |
141| typedef struct [OH_UdmfGetDataParams](#oh_udmfgetdataparams) [OH_UdmfGetDataParams](#oh_udmfgetdataparams) | 从UDMF获取数据时的参数。  |
142| typedef struct [ArkUI_ProgressLinearStyleOption](#arkui_progresslinearstyleoption) [ArkUI_ProgressLinearStyleOption](#arkui_progresslinearstyleoption) | 定义进度条线性进度条样式对象。 |
143| typedef struct [ArkUI_VisibleAreaEventOptions](#arkui_visibleareaeventoptions) [ArkUI_VisibleAreaEventOptions](#arkui_visibleareaeventoptions) | 可见区域变化监听的参数。  |
144| typedef struct [ArkUI_CustomProperty](#arkui_customproperty) [ArkUI_CustomProperty](#arkui_customproperty) | 定义自定义属性的CustomProperty类信息。  |
145| typedef struct [ArkUI_HostWindowInfo](#arkui_hostwindowinfo) [ArkUI_HostWindowInfo](#arkui_hostwindowinfo) | 定义窗口属性的HostWindowInfo类信息。  |
146| typedef struct [ArkUI_ActiveChildrenInfo](#arkui_activechildreninfo) [ArkUI_HostWindowInfo](#arkui_activechildreninfo) | 定义ActiveChildrenInfo类信息。  |
147
148
149### 枚举
150
151| 名称 | 描述 |
152| -------- | -------- |
153| [ArkUI_DragResult](#arkui_dragresult) { ARKUI_DRAG_RESULT_SUCCESSFUL = 0, ARKUI_DRAG_RESULT_FAILED, ARKUI_DRAG_RESULT_CANCELED } | 拖拽结果定义,由数据接收方设置,并由系统传递给数据拖出方,拖出方可感知接收方对数据的处理结果。  |
154| [ArkUI_DropOperation](#arkui_dropoperation) { ARKUI_DROP_OPERATION_COPY = 0, ARKUI_DROP_OPERATION_MOVE } | 定义拖拽释放时的数据处理方式,可影响角标的显示。  |
155| [ArkUI_PreDragStatus](#arkui_predragstatus) {<br/>ARKUI_PRE_DRAG_STATUS_UNKNOWN = -1, ARKUI_PRE_DRAG_STATUS_ACTION_DETECTING, ARKUI_PRE_DRAG_STATUS_READY_TO_TRIGGER_DRAG, ARKUI_PRE_DRAG_STATUS_PREVIEW_LIFT_STARTED,<br/>ARKUI_PRE_DRAG_STATUS_PREVIEW_LIFT_FINISHED, ARKUI_PRE_DRAG_STATUS_PREVIEW_LANDING_STARTED, ARKUI_PRE_DRAG_STATUS_PREVIEW_LANDING_FINISHED, ARKUI_PRE_DRAG_STATUS_CANCELED_BEFORE_DRAG<br/>} | 定义拖拽发起前的长按交互阶段的变化状态。  |
156| [ArkUI_DragPreviewScaleMode](#arkui_dragpreviewscalemode) { ARKUI_DRAG_PREVIEW_SCALE_AUTO = 0, ARKUI_DRAG_PREVIEW_SCALE_DISABLED } | 拖拽预览缩放模式。  |
157| [ArkUI_DragStatus](#arkui_dragstatus) { ARKUI_DRAG_STATUS_UNKNOWN = -1, ARKUI_DRAG_STATUS_STARTED, ARKUI_DRAG_STATUS_ENDED } | 拖拽状态。  |
158| [ArkUI_DismissReason](#arkui_dismissreason) { DIALOG_DISMISS_BACK_PRESS = 0, DIALOG_DISMISS_TOUCH_OUTSIDE, DIALOG_DISMISS_CLOSE_BUTTON, DIALOG_DISMISS_SLIDE_DOWN } | 弹窗关闭的触发方式。  |
159| [ArkUI_LevelMode](#arkui_levelmode) { ARKUI_LEVEL_MODE_OVERLAY = 0, ARKUI_LEVEL_MODE_EMBEDDED } | 设置弹窗显示层级。  |
160| [ArkUI_ImmersiveMode](#arkui_immersivemode) { ARKUI_IMMERSIVE_MODE_DEFAULT = 0, ARKUI_IMMERSIVE_MODE_EXTEND } | 指定嵌入式弹窗的蒙层覆盖区域。  |
161| [ArkUI_GestureEventActionType](#arkui_gestureeventactiontype) { GESTURE_EVENT_ACTION_ACCEPT = 0x01, GESTURE_EVENT_ACTION_UPDATE = 0x02, GESTURE_EVENT_ACTION_END = 0x04, GESTURE_EVENT_ACTION_CANCEL = 0x08 } | 定义手势事件类型。  |
162| [ArkUI_GesturePriority](#arkui_gesturepriority) { NORMAL = 0, PRIORITY = 1, PARALLEL = 2 } | 定义手势事件模式。  |
163| [ArkUI_GroupGestureMode](#arkui_groupgesturemode) { SEQUENTIAL_GROUP = 0, PARALLEL_GROUP = 1, EXCLUSIVE_GROUP = 2 } | 定义手势组事件模式。  |
164| [ArkUI_GestureDirection](#arkui_gesturedirection) {<br/>GESTURE_DIRECTION_ALL = 0b1111, GESTURE_DIRECTION_HORIZONTAL = 0b0011, GESTURE_DIRECTION_VERTICAL = 0b1100, GESTURE_DIRECTION_LEFT = 0b0001,<br/>GESTURE_DIRECTION_RIGHT = 0b0010, GESTURE_DIRECTION_UP = 0b0100, GESTURE_DIRECTION_DOWN = 0b1000, GESTURE_DIRECTION_NONE = 0<br/>} | 定义滑动手势方向。  |
165| [ArkUI_GestureMask](#arkui_gesturemask) { NORMAL_GESTURE_MASK = 0, IGNORE_INTERNAL_GESTURE_MASK } | 定义手势屏蔽模式。  |
166| [ArkUI_GestureRecognizerType](#arkui_gesturerecognizertype) {<br/>TAP_GESTURE = 0, LONG_PRESS_GESTURE, PAN_GESTURE, PINCH_GESTURE,<br/>ROTATION_GESTURE, SWIPE_GESTURE, GROUP_GESTURE<br/>} | 定义手势类型。  |
167| [ArkUI_GestureInterruptResult](#arkui_gestureinterruptresult) { GESTURE_INTERRUPT_RESULT_CONTINUE = 0, GESTURE_INTERRUPT_RESULT_REJECT } | 定义手势打断结果。  |
168| [ArkUI_GestureRecognizerState](#arkui_gesturerecognizerstate) {<br/>ARKUI_GESTURE_RECOGNIZER_STATE_READY = 0, ARKUI_GESTURE_RECOGNIZER_STATE_DETECTING = 1, ARKUI_GESTURE_RECOGNIZER_STATE_PENDING = 2, ARKUI_GESTURE_RECOGNIZER_STATE_BLOCKED = 3,<br/>ARKUI_GESTURE_RECOGNIZER_STATE_SUCCESSFUL = 4, ARKUI_GESTURE_RECOGNIZER_STATE_FAILED = 5<br/>} | 定义手势识别器状态。  |
169| [ArkUI_NativeAPIVariantKind](#arkui_nativeapivariantkind) { ARKUI_NATIVE_NODE, ARKUI_NATIVE_DIALOG, ARKUI_NATIVE_GESTURE, ARKUI_NATIVE_ANIMATE } | 定义Native接口集合类型。  |
170| [ArkUI_KeyCode](#arkui_keycode) {<br/>ARKUI_KEYCODE_UNKNOWN = -1, ARKUI_KEYCODE_FN = 0, ARKUI_KEYCODE_VOLUME_UP = 16, ARKUI_KEYCODE_VOLUME_DOWN = 17,<br/>ARKUI_KEYCODE_POWER = 18, ARKUI_KEYCODE_CAMERA = 19, ARKUI_KEYCODE_VOLUME_MUTE = 22, ARKUI_KEYCODE_MUTE = 23,<br/>ARKUI_KEYCODE_BRIGHTNESS_UP = 40, ARKUI_KEYCODE_BRIGHTNESS_DOWN = 41, ARKUI_KEYCODE_0 = 2000, ARKUI_KEYCODE_1 = 2001,<br/>ARKUI_KEYCODE_2 = 2002, ARKUI_KEYCODE_3 = 2003, ARKUI_KEYCODE_4 = 2004, ARKUI_KEYCODE_5 = 2005,<br/>ARKUI_KEYCODE_6 = 2006, ARKUI_KEYCODE_7 = 2007, ARKUI_KEYCODE_8 = 2008, ARKUI_KEYCODE_9 = 2009,<br/>ARKUI_KEYCODE_STAR = 2010, ARKUI_KEYCODE_POUND = 2011, ARKUI_KEYCODE_DPAD_UP = 2012, ARKUI_KEYCODE_DPAD_DOWN = 2013,<br/>ARKUI_KEYCODE_DPAD_LEFT = 2014, ARKUI_KEYCODE_DPAD_RIGHT = 2015, ARKUI_KEYCODE_DPAD_CENTER = 2016, ARKUI_KEYCODE_A = 2017,<br/>ARKUI_KEYCODE_B = 2018, ARKUI_KEYCODE_C = 2019, ARKUI_KEYCODE_D = 2020, ARKUI_KEYCODE_E = 2021,<br/>ARKUI_KEYCODE_F = 2022, ARKUI_KEYCODE_G = 2023, ARKUI_KEYCODE_H = 2024, ARKUI_KEYCODE_I = 2025,<br/>ARKUI_KEYCODE_J = 2026, ARKUI_KEYCODE_K = 2027, ARKUI_KEYCODE_L = 2028, ARKUI_KEYCODE_M = 2029,<br/>ARKUI_KEYCODE_N = 2030, ARKUI_KEYCODE_O = 2031, ARKUI_KEYCODE_P = 2032, ARKUI_KEYCODE_Q = 2033,<br/>ARKUI_KEYCODE_R = 2034, ARKUI_KEYCODE_S = 2035, ARKUI_KEYCODE_T = 2036, ARKUI_KEYCODE_U = 2037,<br/>ARKUI_KEYCODE_V = 2038, ARKUI_KEYCODE_W = 2039, ARKUI_KEYCODE_X = 2040, ARKUI_KEYCODE_Y = 2041,<br/>ARKUI_KEYCODE_Z = 2042, ARKUI_KEYCODE_COMMA = 2043, ARKUI_KEYCODE_PERIOD = 2044, ARKUI_KEYCODE_ALT_LEFT = 2045,<br/>ARKUI_KEYCODE_ALT_RIGHT = 2046, ARKUI_KEYCODE_SHIFT_LEFT = 2047, ARKUI_KEYCODE_SHIFT_RIGHT = 2048, ARKUI_KEYCODE_TAB = 2049,<br/>ARKUI_KEYCODE_SPACE = 2050, ARKUI_KEYCODE_SYM = 2051, ARKUI_KEYCODE_EXPLORER = 2052, ARKUI_KEYCODE_ENVELOPE = 2053,<br/>ARKUI_KEYCODE_ENTER = 2054, ARKUI_KEYCODE_DEL = 2055, ARKUI_KEYCODE_GRAVE = 2056, ARKUI_KEYCODE_MINUS = 2057,<br/>ARKUI_KEYCODE_EQUALS = 2058, ARKUI_KEYCODE_LEFT_BRACKET = 2059, ARKUI_KEYCODE_RIGHT_BRACKET = 2060, ARKUI_KEYCODE_BACKSLASH = 2061,<br/>ARKUI_KEYCODE_SEMICOLON = 2062, ARKUI_KEYCODE_APOSTROPHE = 2063, ARKUI_KEYCODE_SLASH = 2064, ARKUI_KEYCODE_AT = 2065,<br/>ARKUI_KEYCODE_PLUS = 2066, ARKUI_KEYCODE_MENU = 2067, ARKUI_KEYCODE_PAGE_UP = 2068, ARKUI_KEYCODE_PAGE_DOWN = 2069,<br/>ARKUI_KEYCODE_ESCAPE = 2070, ARKUI_KEYCODE_FORWARD_DEL = 2071, ARKUI_KEYCODE_CTRL_LEFT = 2072, ARKUI_KEYCODE_CTRL_RIGHT = 2073,<br/>ARKUI_KEYCODE_CAPS_LOCK = 2074, ARKUI_KEYCODE_SCROLL_LOCK = 2075, ARKUI_KEYCODE_META_LEFT = 2076, ARKUI_KEYCODE_META_RIGHT = 2077,<br/>ARKUI_KEYCODE_FUNCTION = 2078, ARKUI_KEYCODE_SYSRQ = 2079, ARKUI_KEYCODE_BREAK = 2080, ARKUI_KEYCODE_MOVE_HOME = 2081,<br/>ARKUI_KEYCODE_MOVE_END = 2082, ARKUI_KEYCODE_INSERT = 2083, ARKUI_KEYCODE_FORWARD = 2084, ARKUI_KEYCODE_MEDIA_PLAY = 2085,<br/>ARKUI_KEYCODE_MEDIA_PAUSE = 2086, ARKUI_KEYCODE_MEDIA_CLOSE = 2087, ARKUI_KEYCODE_MEDIA_EJECT = 2088, ARKUI_KEYCODE_MEDIA_RECORD = 2089,<br/>ARKUI_KEYCODE_F1 = 2090, ARKUI_KEYCODE_F2 = 2091, ARKUI_KEYCODE_F3 = 2092, ARKUI_KEYCODE_F4 = 2093,<br/>ARKUI_KEYCODE_F5 = 2094, ARKUI_KEYCODE_F6 = 2095, ARKUI_KEYCODE_F7 = 2096, ARKUI_KEYCODE_F8 = 2097,<br/>ARKUI_KEYCODE_F9 = 2098, ARKUI_KEYCODE_F10 = 2099, ARKUI_KEYCODE_F11 = 2100, ARKUI_KEYCODE_F12 = 2101,<br/>ARKUI_KEYCODE_NUM_LOCK = 2102, ARKUI_KEYCODE_NUMPAD_0 = 2103, ARKUI_KEYCODE_NUMPAD_1 = 2104, ARKUI_KEYCODE_NUMPAD_2 = 2105,<br/>ARKUI_KEYCODE_NUMPAD_3 = 2106, ARKUI_KEYCODE_NUMPAD_4 = 2107, ARKUI_KEYCODE_NUMPAD_5 = 2108, ARKUI_KEYCODE_NUMPAD_6 = 2109,<br/>ARKUI_KEYCODE_NUMPAD_7 = 2110, ARKUI_KEYCODE_NUMPAD_8 = 2111, ARKUI_KEYCODE_NUMPAD_9 = 2112, ARKUI_KEYCODE_NUMPAD_DIVIDE = 2113,<br/>ARKUI_KEYCODE_NUMPAD_MULTIPLY = 2114, ARKUI_KEYCODE_NUMPAD_SUBTRACT = 2115, ARKUI_KEYCODE_NUMPAD_ADD = 2116, ARKUI_KEYCODE_NUMPAD_DOT = 2117,<br/>ARKUI_KEYCODE_NUMPAD_COMMA = 2118, ARKUI_KEYCODE_NUMPAD_ENTER = 2119, ARKUI_KEYCODE_NUMPAD_EQUALS = 2120, ARKUI_KEYCODE_NUMPAD_LEFT_PAREN = 2121,<br/>ARKUI_KEYCODE_NUMPAD_RIGHT_PAREN = 2122<br/>} | 按键事件的键码  |
171| [ArkUI_KeyEventType](#arkui_keyeventtype) {<br/>ARKUI_KEY_EVENT_UNKNOWN = -1, ARKUI_KEY_EVENT_DOWN = 0, ARKUI_KEY_EVENT_UP = 1, ARKUI_KEY_EVENT_LONG_PRESS = 2,<br/>ARKUI_KEY_EVENT_CLICK = 3<br/>} | 按键的类型。  |
172| [ArkUI_KeySourceType](#arkui_keysourcetype) { ARKUI_KEY_SOURCE_UNKNOWN = 0, ARKUI_KEY_SOURCE_TYPE_MOUSE = 1, ARKUI_KEY_SOURCE_TYPE_KEYBOARD = 4, ARKUI_KEY_SOURCE_TYPE_JOYSTICK = 5 } | 触发当前按键的输入设备类型。  |
173| [ArkUI_KeyIntension](#arkui_keyintension) {<br/>ARKUI_KEY_INTENSION_UNKNOWN = -1, ARKUI_KEY_INTENSION_UP = 1, ARKUI_KEY_INTENSION_DOWN = 2, ARKUI_KEY_INTENSION_LEFT = 3,<br/>ARKUI_KEY_INTENSION_RIGHT = 4, ARKUI_KEY_INTENSION_SELECT = 5, ARKUI_KEY_INTENSION_ESCAPE = 6, ARKUI_KEY_INTENSION_BACK = 7,<br/>ARKUI_KEY_INTENSION_FORWARD = 8, ARKUI_KEY_INTENSION_MENU = 9, ARKUI_KEY_INTENSION_HOME = 10, ARKUI_KEY_INTENSION_PAGE_UP = 11,<br/>ARKUI_KEY_INTENSION_PAGE_DOWN = 12, ARKUI_KEY_INTENSION_ZOOM_OUT = 13, ARKUI_KEY_INTENSION_ZOOM_IN = 14, ARKUI_KEY_INTENTION_MEDIA_PLAY_PAUSE = 100,<br/>ARKUI_KEY_INTENTION_MEDIA_FAST_FORWARD = 101, ARKUI_KEY_INTENTION_MEDIA_FAST_PLAYBACK = 103, ARKUI_KEY_INTENTION_MEDIA_NEXT = 104, ARKUI_KEY_INTENTION_MEDIA_PREVIOUS = 105,<br/>ARKUI_KEY_INTENTION_MEDIA_MUTE = 106, ARKUI_KEY_INTENTION_VOLUME_UP = 107, ARKUI_KEY_INTENTION_VOLUME_DOWN = 108, ARKUI_KEY_INTENTION_CALL = 200,<br/>ARKUI_KEY_INTENTION_CAMERA = 300<br/>} | 按键对应的意图。  |
174| [ArkUI_NodeType](#arkui_nodetype) {<br/>ARKUI_NODE_CUSTOM = 0, ARKUI_NODE_TEXT = 1, ARKUI_NODE_SPAN = 2, ARKUI_NODE_IMAGE_SPAN = 3,<br/>ARKUI_NODE_IMAGE = 4, ARKUI_NODE_TOGGLE = 5, ARKUI_NODE_LOADING_PROGRESS = 6, ARKUI_NODE_TEXT_INPUT = 7,<br/>ARKUI_NODE_TEXT_AREA = 8, ARKUI_NODE_BUTTON = 9, ARKUI_NODE_PROGRESS = 10, ARKUI_NODE_CHECKBOX = 11,<br/>ARKUI_NODE_XCOMPONENT = 12, ARKUI_NODE_DATE_PICKER = 13, ARKUI_NODE_TIME_PICKER = 14, ARKUI_NODE_TEXT_PICKER = 15,<br/>ARKUI_NODE_CALENDAR_PICKER = 16, ARKUI_NODE_SLIDER = 17, ARKUI_NODE_RADIO = 18, ARKUI_NODE_IMAGE_ANIMATOR = 19,<br/>ARKUI_NODE_XCOMPONENT_TEXTURE = 20,<br/>ARKUI_NODE_CHECKBOX_GROUP = 21,<br/>ARKUI_NODE_STACK = MAX_NODE_SCOPE_NUM, ARKUI_NODE_SWIPER, ARKUI_NODE_SCROLL,<br/>ARKUI_NODE_LIST, ARKUI_NODE_LIST_ITEM, ARKUI_NODE_LIST_ITEM_GROUP, ARKUI_NODE_COLUMN,<br/>ARKUI_NODE_ROW, ARKUI_NODE_FLEX, ARKUI_NODE_REFRESH, ARKUI_NODE_WATER_FLOW,<br/>ARKUI_NODE_FLOW_ITEM, ARKUI_NODE_RELATIVE_CONTAINER, ARKUI_NODE_GRID, ARKUI_NODE_GRID_ITEM,<br/>ARKUI_NODE_CUSTOM_SPAN<br/>} | 提供ArkUI在Native侧可创建组件类型。  |
175| [ArkUI_NodeAttributeType](#arkui_nodeattributetype) {<br/>NODE_WIDTH = 0, NODE_HEIGHT, NODE_BACKGROUND_COLOR, NODE_BACKGROUND_IMAGE,<br/>NODE_PADDING, NODE_ID, NODE_ENABLED, NODE_MARGIN,<br/>NODE_TRANSLATE, NODE_SCALE, NODE_ROTATE, NODE_BRIGHTNESS,<br/>NODE_SATURATION, NODE_BLUR, NODE_LINEAR_GRADIENT, NODE_ALIGNMENT,<br/>NODE_OPACITY, NODE_BORDER_WIDTH, NODE_BORDER_RADIUS, NODE_BORDER_COLOR,<br/>NODE_BORDER_STYLE, NODE_Z_INDEX, NODE_VISIBILITY, NODE_CLIP,<br/>NODE_CLIP_SHAPE, NODE_TRANSFORM, NODE_HIT_TEST_BEHAVIOR, NODE_POSITION,<br/>NODE_SHADOW, NODE_CUSTOM_SHADOW, NODE_BACKGROUND_IMAGE_SIZE, NODE_BACKGROUND_IMAGE_SIZE_WITH_STYLE,<br/>NODE_BACKGROUND_BLUR_STYLE, NODE_TRANSFORM_CENTER, NODE_OPACITY_TRANSITION, NODE_ROTATE_TRANSITION,<br/>NODE_SCALE_TRANSITION, NODE_TRANSLATE_TRANSITION, NODE_MOVE_TRANSITION, NODE_FOCUSABLE,<br/>NODE_DEFAULT_FOCUS, NODE_RESPONSE_REGION, NODE_OVERLAY, NODE_SWEEP_GRADIENT,<br/>NODE_RADIAL_GRADIENT, NODE_MASK, NODE_BLEND_MODE, NODE_DIRECTION,<br/>NODE_CONSTRAINT_SIZE, NODE_GRAY_SCALE, NODE_INVERT, NODE_SEPIA,<br/>NODE_CONTRAST, NODE_FOREGROUND_COLOR, NODE_OFFSET, NODE_MARK_ANCHOR,<br/>NODE_BACKGROUND_IMAGE_POSITION, NODE_ALIGN_RULES, NODE_ALIGN_SELF, NODE_FLEX_GROW,<br/>NODE_FLEX_SHRINK, NODE_FLEX_BASIS, NODE_ACCESSIBILITY_GROUP, NODE_ACCESSIBILITY_TEXT,<br/>NODE_ACCESSIBILITY_MODE, NODE_ACCESSIBILITY_DESCRIPTION, NODE_FOCUS_STATUS, NODE_ASPECT_RATIO,<br/>NODE_LAYOUT_WEIGHT, NODE_DISPLAY_PRIORITY, NODE_OUTLINE_WIDTH, NODE_WIDTH_PERCENT,<br/>NODE_HEIGHT_PERCENT, NODE_PADDING_PERCENT, NODE_MARGIN_PERCENT, NODE_GEOMETRY_TRANSITION,<br/>NODE_RELATIVE_LAYOUT_CHAIN_MODE, NODE_RENDER_FIT, NODE_OUTLINE_COLOR, NODE_SIZE,<br/>NODE_RENDER_GROUP, NODE_COLOR_BLEND, NODE_FOREGROUND_BLUR_STYLE, NODE_LAYOUT_RECT,<br/>NODE_FOCUS_ON_TOUCH, NODE_BORDER_WIDTH_PERCENT, NODE_BORDER_RADIUS_PERCENT, NODE_ACCESSIBILITY_ID = 87,<br/>NODE_ACCESSIBILITY_ACTIONS = 88, NODE_ACCESSIBILITY_ROLE = 89, NODE_ACCESSIBILITY_STATE = 90, NODE_ACCESSIBILITY_VALUE = 91,<br/>NODE_EXPAND_SAFE_AREA = 92, NODE_VISIBLE_AREA_CHANGE_RATIO = 93, NODE_TRANSITION = 94, NODE_UNIQUE_ID = 95, NODE_FOCUS_BOX = 96,<br/>NODE_CLICK_DISTANCE = 97, NODE_TAB_STOP = 98, NODE_BACKGROUND_IMAGE_RESIZABLE_WITH_SLICE = 100, NODE_NEXT_FOCUS = 101, NODE_VISIBLE_AREA_APPROXIMATE_CHANGE_RATIO = 102, NODE_TEXT_CONTENT = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_TEXT, NODE_FONT_COLOR,<br/>NODE_FONT_SIZE, NODE_FONT_STYLE, NODE_FONT_WEIGHT, NODE_TEXT_LINE_HEIGHT,<br/>NODE_TEXT_DECORATION, NODE_TEXT_CASE, NODE_TEXT_LETTER_SPACING, NODE_TEXT_MAX_LINES,<br/>NODE_TEXT_ALIGN, NODE_TEXT_OVERFLOW, NODE_FONT_FAMILY, NODE_TEXT_COPY_OPTION,<br/>NODE_TEXT_BASELINE_OFFSET, NODE_TEXT_TEXT_SHADOW, NODE_TEXT_MIN_FONT_SIZE, NODE_TEXT_MAX_FONT_SIZE,<br/>NODE_TEXT_FONT, NODE_TEXT_HEIGHT_ADAPTIVE_POLICY, NODE_TEXT_INDENT, NODE_TEXT_WORD_BREAK,<br/>NODE_TEXT_ELLIPSIS_MODE, NODE_TEXT_LINE_SPACING, NODE_FONT_FEATURE, NODE_TEXT_ENABLE_DATA_DETECTOR,<br/>NODE_TEXT_ENABLE_DATA_DETECTOR_CONFIG, NODE_TEXT_SELECTED_BACKGROUND_COLOR, NODE_TEXT_CONTENT_WITH_STYLED_STRING, NODE_TEXT_HALF_LEADING = 1029,NODE_IMMUTABLE_FONT_WEIGHT = 1030,<br/>NODE_SPAN_CONTENT = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_SPAN, NODE_SPAN_TEXT_BACKGROUND_STYLE, NODE_SPAN_BASELINE_OFFSET, NODE_IMAGE_SPAN_SRC = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_IMAGE_SPAN,<br/>NODE_IMAGE_SPAN_VERTICAL_ALIGNMENT, NODE_IMAGE_SPAN_ALT, NODE_IMAGE_SPAN_BASELINE_OFFSET = 3003, NODE_IMAGE_SRC = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_IMAGE,<br/>NODE_IMAGE_OBJECT_FIT, NODE_IMAGE_INTERPOLATION, NODE_IMAGE_OBJECT_REPEAT, NODE_IMAGE_COLOR_FILTER,<br/>NODE_IMAGE_AUTO_RESIZE, NODE_IMAGE_ALT, NODE_IMAGE_DRAGGABLE, NODE_IMAGE_RENDER_MODE,<br/>NODE_IMAGE_FIT_ORIGINAL_SIZE, NODE_IMAGE_FILL_COLOR, NODE_IMAGE_RESIZABLE, NODE_TOGGLE_SELECTED_COLOR = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_TOGGLE,<br/>NODE_TOGGLE_SWITCH_POINT_COLOR, NODE_TOGGLE_VALUE, NODE_TOGGLE_UNSELECTED_COLOR, NODE_LOADING_PROGRESS_COLOR = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_LOADING_PROGRESS,<br/>NODE_LOADING_PROGRESS_ENABLE_LOADING, NODE_TEXT_INPUT_PLACEHOLDER = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_TEXT_INPUT, NODE_TEXT_INPUT_TEXT, NODE_TEXT_INPUT_CARET_COLOR,<br/>NODE_TEXT_INPUT_CARET_STYLE, NODE_TEXT_INPUT_SHOW_UNDERLINE, NODE_TEXT_INPUT_MAX_LENGTH, NODE_TEXT_INPUT_ENTER_KEY_TYPE,<br/>NODE_TEXT_INPUT_PLACEHOLDER_COLOR, NODE_TEXT_INPUT_PLACEHOLDER_FONT, NODE_TEXT_INPUT_ENABLE_KEYBOARD_ON_FOCUS, NODE_TEXT_INPUT_TYPE,<br/>NODE_TEXT_INPUT_SELECTED_BACKGROUND_COLOR, NODE_TEXT_INPUT_SHOW_PASSWORD_ICON, NODE_TEXT_INPUT_EDITING, NODE_TEXT_INPUT_CANCEL_BUTTON,<br/>NODE_TEXT_INPUT_TEXT_SELECTION, NODE_TEXT_INPUT_UNDERLINE_COLOR, NODE_TEXT_INPUT_ENABLE_AUTO_FILL, NODE_TEXT_INPUT_CONTENT_TYPE,<br/>NODE_TEXT_INPUT_PASSWORD_RULES, NODE_TEXT_INPUT_SELECT_ALL, NODE_TEXT_INPUT_INPUT_FILTER, NODE_TEXT_INPUT_STYLE,<br/>NODE_TEXT_INPUT_CARET_OFFSET, NODE_TEXT_INPUT_CONTENT_RECT, NODE_TEXT_INPUT_CONTENT_LINE_COUNT, NODE_TEXT_INPUT_SELECTION_MENU_HIDDEN,<br/>NODE_TEXT_INPUT_BLUR_ON_SUBMIT, NODE_TEXT_INPUT_CUSTOM_KEYBOARD, NODE_TEXT_INPUT_WORD_BREAK, NODE_TEXT_INPUT_NUMBER_OF_LINES,<br/>NODE_TEXT_INPUT_SHOW_KEYBOARD_ON_FOCUS, NODE_TEXT_INPUT_LETTER_SPACING = 7032, NODE_TEXT_INPUT_ENABLE_PREVIEW_TEXT = 7033,NODE_TEXT_INPUT_HALF_LEADING = 7034, NODE_TEXT_INPUT_KEYBOARD_APPEARANCE = 7035, NODE_TEXT_AREA_PLACEHOLDER = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_TEXT_AREA, NODE_TEXT_AREA_TEXT, NODE_TEXT_AREA_MAX_LENGTH,<br/>NODE_TEXT_AREA_PLACEHOLDER_COLOR, NODE_TEXT_AREA_PLACEHOLDER_FONT, NODE_TEXT_AREA_CARET_COLOR, NODE_TEXT_AREA_EDITING,<br/>NODE_TEXT_AREA_TYPE, NODE_TEXT_AREA_SHOW_COUNTER, NODE_TEXT_AREA_SELECTION_MENU_HIDDEN, NODE_TEXT_AREA_BLUR_ON_SUBMIT,<br/>NODE_TEXT_AREA_INPUT_FILTER, NODE_TEXT_AREA_SELECTED_BACKGROUND_COLOR, NODE_TEXT_AREA_ENTER_KEY_TYPE, NODE_TEXT_AREA_ENABLE_KEYBOARD_ON_FOCUS,<br/>NODE_TEXT_AREA_CARET_OFFSET, NODE_TEXT_AREA_CONTENT_RECT, NODE_TEXT_AREA_CONTENT_LINE_COUNT, NODE_TEXT_AREA_TEXT_SELECTION,<br/>NODE_TEXT_AREA_ENABLE_AUTO_FILL, NODE_TEXT_AREA_CONTENT_TYPE, NODE_TEXT_AREA_NUMBER_OF_LINES, NODE_TEXT_AREA_SHOW_KEYBOARD_ON_FOCUS, NODE_TEXT_AREA_LETTER_SPACING = 8023, NODE_TEXT_AREA_ENABLE_PREVIEW_TEXT = 8024, NODE_TEXT_AREA_HALF_LEADING = 8025, NODE_TEXT_AREA_KEYBOARD_APPEARANCE = 8026,<br/>NODE_BUTTON_LABEL = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_BUTTON, NODE_BUTTON_TYPE, NODE_BUTTON_MIN_FONT_SCALE, NODE_BUTTON_MAX_FONT_SCALE, NODE_PROGRESS_VALUE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_PROGRESS, NODE_PROGRESS_TOTAL,<br/>NODE_PROGRESS_COLOR, NODE_PROGRESS_TYPE, NODE_PROGRESS_LINEAR_STYLE, NODE_CHECKBOX_SELECT = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_CHECKBOX, NODE_CHECKBOX_SELECT_COLOR,<br/>NODE_CHECKBOX_UNSELECT_COLOR, NODE_CHECKBOX_MARK, NODE_CHECKBOX_SHAPE, NODE_XCOMPONENT_ID = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_XCOMPONENT,<br/>NODE_XCOMPONENT_TYPE, NODE_XCOMPONENT_SURFACE_SIZE, NODE_XCOMPONENT_SURFACE_RECT, NODE_XCOMPONENT_ENABLE_ANALYZER, NODE_DATE_PICKER_LUNAR = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_DATE_PICKER, NODE_DATE_PICKER_START,<br/>NODE_DATE_PICKER_END, NODE_DATE_PICKER_SELECTED, NODE_DATE_PICKER_DISAPPEAR_TEXT_STYLE, NODE_DATE_PICKER_TEXT_STYLE,<br/>NODE_DATE_PICKER_SELECTED_TEXT_STYLE, NODE_DATE_PICKER_MODE, NODE_DATE_PICKER_ENABLE_HAPTIC_FEEDBACK = 13008, NODE_TIME_PICKER_SELECTED = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_TIME_PICKER, NODE_TIME_PICKER_USE_MILITARY_TIME, NODE_TIME_PICKER_DISAPPEAR_TEXT_STYLE,<br/>NODE_TIME_PICKER_TEXT_STYLE, NODE_TIME_PICKER_SELECTED_TEXT_STYLE, NODE_TIME_PICKER_START, NODE_TIME_PICKER_END, NODE_TIME_PICKER_ENABLE_CASCADE = 14007, NODE_TEXT_PICKER_OPTION_RANGE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_TEXT_PICKER, NODE_TEXT_PICKER_OPTION_SELECTED,<br/>NODE_TEXT_PICKER_OPTION_VALUE, NODE_TEXT_PICKER_DISAPPEAR_TEXT_STYLE, NODE_TEXT_PICKER_TEXT_STYLE, NODE_TEXT_PICKER_SELECTED_TEXT_STYLE,<br/>NODE_TEXT_PICKER_SELECTED_INDEX, NODE_TEXT_PICKER_CAN_LOOP, NODE_TEXT_PICKER_DEFAULT_PICKER_ITEM_HEIGHT,NODE_TEXT_PICKER_ENABLE_HAPTIC_FEEDBACK = 15010, NODE_CALENDAR_PICKER_HINT_RADIUS = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_CALENDAR_PICKER,<br/>NODE_CALENDAR_PICKER_SELECTED_DATE, NODE_CALENDAR_PICKER_EDGE_ALIGNMENT, NODE_CALENDAR_PICKER_TEXT_STYLE, NODE_CALENDAR_PICKER_START = 16004, NODE_CALENDAR_PICKER_END = 16005,<br/>NODE_SLIDER_BLOCK_COLOR = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_SLIDER,<br/>NODE_SLIDER_TRACK_COLOR, NODE_SLIDER_SELECTED_COLOR, NODE_SLIDER_SHOW_STEPS, NODE_SLIDER_BLOCK_STYLE,<br/>NODE_SLIDER_VALUE, NODE_SLIDER_MIN_VALUE, NODE_SLIDER_MAX_VALUE, NODE_SLIDER_STEP,<br/>NODE_SLIDER_DIRECTION, NODE_SLIDER_REVERSE, NODE_SLIDER_STYLE, NODE_SLIDER_TRACK_THICKNESS,NODE_SLIDER_ENABLE_HAPTIC_FEEDBACK = 17013,<br/>NODE_RADIO_CHECKED = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_RADIO, NODE_RADIO_STYLE, NODE_RADIO_VALUE, NODE_RADIO_GROUP,<br/>NODE_CHECKBOX_GROUP_NAME = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_CHECKBOX_GROUP, NODE_CHECKBOX_GROUP_SELECT_ALL, NODE_CHECKBOX_GROUP_SELECTED_COLOR, NODE_CHECKBOX_GROUP_UNSELECTED_COLOR, NODE_CHECKBOX_GROUP_MARK, NODE_CHECKBOX_GROUP_SHAPE,<br/>NODE_STACK_ALIGN_CONTENT = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_STACK, NODE_SCROLL_BAR_DISPLAY_MODE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_SCROLL, NODE_SCROLL_BAR_WIDTH, NODE_SCROLL_BAR_COLOR,<br/>NODE_SCROLL_SCROLL_DIRECTION, NODE_SCROLL_EDGE_EFFECT, NODE_SCROLL_ENABLE_SCROLL_INTERACTION, NODE_SCROLL_FRICTION,<br/>NODE_SCROLL_SNAP, NODE_SCROLL_NESTED_SCROLL, NODE_SCROLL_OFFSET, NODE_SCROLL_EDGE,<br/>NODE_SCROLL_ENABLE_PAGING, NODE_SCROLL_PAGE, NODE_SCROLL_BY, NODE_SCROLL_FLING,<br/>NODE_SCROLL_FADING_EDGE, NODE_SCROLL_SIZE, NODE_SCROLL_CONTENT_END_OFFSET, NODE_SCROLL_FLING_SPEED_LIMIT = 1002019, NODE_SCROLL_CLIP_CONTENT = 1002020, NODE_LIST_DIRECTION = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_LIST, NODE_LIST_STICKY,<br/>NODE_LIST_SPACE, NODE_LIST_NODE_ADAPTER, NODE_LIST_CACHED_COUNT, NODE_LIST_SCROLL_TO_INDEX,<br/>NODE_LIST_ALIGN_LIST_ITEM, NODE_LIST_CHILDREN_MAIN_SIZE = 1003007, NODE_LIST_INITIAL_INDEX = 1003008, NODE_LIST_DIVIDER = 1003009, NODE_LIST_SCROLL_TO_INDEX_IN_GROUP = 1003010, NODE_LIST_LANES = 1003011, NODE_LIST_SCROLL_SNAP_ALIGN = 1003012, NODE_LIST_MAINTAIN_VISIBLE_CONTENT_POSITION = 1003013, NODE_LIST_STACK_FROM_END = 1003014,<br/>NODE_SWIPER_LOOP = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_SWIPER, NODE_SWIPER_AUTO_PLAY, NODE_SWIPER_SHOW_INDICATOR, NODE_SWIPER_INTERVAL,<br/>NODE_SWIPER_VERTICAL, NODE_SWIPER_DURATION, NODE_SWIPER_CURVE, NODE_SWIPER_ITEM_SPACE,<br/>NODE_SWIPER_INDEX, NODE_SWIPER_DISPLAY_COUNT, NODE_SWIPER_DISABLE_SWIPE, NODE_SWIPER_SHOW_DISPLAY_ARROW,<br/>NODE_SWIPER_EDGE_EFFECT_MODE, NODE_SWIPER_NODE_ADAPTER, NODE_SWIPER_CACHED_COUNT, NODE_SWIPER_PREV_MARGIN,<br/>NODE_SWIPER_NEXT_MARGIN, NODE_SWIPER_INDICATOR, NODE_SWIPER_NESTED_SCROLL, NODE_SWIPER_SWIPE_TO_INDEX,<br/>NODE_SWIPER_INDICATOR_INTERACTIVE, NODE_SWIPER_PAGE_FLIP_MODE, NODE_SWIPER_AUTO_FILL, NODE_LIST_ITEM_SWIPE_ACTION = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_LIST_ITEM, NODE_LIST_ITEM_GROUP_SET_HEADER = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_LIST_ITEM_GROUP,<br/>NODE_LIST_ITEM_GROUP_SET_FOOTER, NODE_LIST_ITEM_GROUP_SET_DIVIDER, NODE_LIST_ITEM_GROUP_CHILDREN_MAIN_SIZE = 1005003, NODE_LIST_ITEM_GROUP_NODE_ADAPTER = 1005004, NODE_COLUMN_ALIGN_ITEMS = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_COLUMN,<br/>NODE_COLUMN_JUSTIFY_CONTENT, NODE_ROW_ALIGN_ITEMS = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_ROW, NODE_ROW_JUSTIFY_CONTENT, NODE_FLEX_OPTION = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_FLEX,<br/>NODE_REFRESH_REFRESHING = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_REFRESH, NODE_REFRESH_CONTENT, NODE_REFRESH_PULL_DOWN_RATIO = 1009002, NODE_REFRESH_OFFSET = 1009003,<br/>NODE_REFRESH_PULL_TO_REFRESH = 1009004, NODE_WATER_FLOW_LAYOUT_DIRECTION = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_WATER_FLOW, NODE_WATER_FLOW_COLUMN_TEMPLATE, NODE_WATER_FLOW_ROW_TEMPLATE,<br/>NODE_WATER_FLOW_COLUMN_GAP, NODE_WATER_FLOW_ROW_GAP, NODE_WATER_FLOW_SECTION_OPTION, NODE_WATER_FLOW_NODE_ADAPTER,<br/>NODE_WATER_FLOW_CACHED_COUNT, NODE_WATER_FLOW_FOOTER, NODE_WATER_FLOW_SCROLL_TO_INDEX, NODE_WATER_FLOW_ITEM_CONSTRAINT_SIZE, NODE_WATER_FLOW_LAYOUT_MODE,<br/>NODE_RELATIVE_CONTAINER_GUIDE_LINE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_RELATIVE_CONTAINER, NODE_RELATIVE_CONTAINER_BARRIER, NODE_GRID_COLUMN_TEMPLATE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_GRID, NODE_GRID_ROW_TEMPLATE,<br/>NODE_GRID_COLUMN_GAP, NODE_GRID_ROW_GAP, NODE_GRID_NODE_ADAPTER, NODE_GRID_CACHED_COUNT, NODE_TEXT_PICKER_COLUMN_WIDTHS = 15009,<br/>NODE_IMAGE_ANIMATOR_IMAGES = ARKUI_NODE_IMAGE_ANIMATOR \* MAX_NODE_SCOPE_NUM, NODE_IMAGE_ANIMATOR_STATE, NODE_IMAGE_ANIMATOR_DURATION, NODE_IMAGE_ANIMATOR_REVERSE,<br/>NODE_IMAGE_ANIMATOR_FIXED_SIZE, NODE_IMAGE_ANIMATOR_FILL_MODE, NODE_IMAGE_ANIMATOR_ITERATION<br/>} | 定义ArkUI在Native侧可以设置的属性样式集合。  |
176| [ArkUI_NodeEventType](#arkui_nodeeventtype) {<br/>NODE_TOUCH_EVENT = 0, NODE_EVENT_ON_APPEAR, NODE_EVENT_ON_DISAPPEAR, NODE_EVENT_ON_AREA_CHANGE,<br/>NODE_ON_FOCUS, NODE_ON_BLUR, NODE_ON_CLICK, NODE_ON_TOUCH_INTERCEPT,<br/>NODE_EVENT_ON_VISIBLE_AREA_CHANGE, NODE_ON_HOVER, NODE_ON_MOUSE, NODE_EVENT_ON_ATTACH,<br/>NODE_EVENT_ON_DETACH, NODE_ON_ACCESSIBILITY_ACTIONS = 13, NODE_ON_PRE_DRAG = 14, NODE_ON_DRAG_START = 15,<br/>NODE_ON_DRAG_ENTER = 16, NODE_ON_DRAG_MOVE = 17, NODE_ON_DRAG_LEAVE = 18, NODE_ON_DROP = 19,<br/>NODE_ON_DRAG_END = 20, NODE_ON_KEY_EVENT = 21, NODE_ON_KEY_PRE_IME = 22, NODE_DISPATCH_KEY_EVENT = 24, NODE_ON_AXIS = 25, NODE_ON_CLICK_EVENT = 26, NODE_ON_HOVER_EVENT = 27, NODE_VISIBLE_AREA_APPROXIMATE_CHANGE_EVENT = 28, NODE_ON_HOVER_MOVE = 29, NODE_TEXT_ON_DETECT_RESULT_UPDATE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_TEXT,<br/>NODE_IMAGE_ON_COMPLETE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_IMAGE, NODE_IMAGE_ON_ERROR, NODE_IMAGE_ON_SVG_PLAY_FINISH, NODE_IMAGE_ON_DOWNLOAD_PROGRESS,<br/>NODE_TOGGLE_ON_CHANGE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_TOGGLE, NODE_TEXT_INPUT_ON_CHANGE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_TEXT_INPUT, NODE_TEXT_INPUT_ON_SUBMIT, NODE_TEXT_INPUT_ON_CUT,<br/>NODE_TEXT_INPUT_ON_PASTE, NODE_TEXT_INPUT_ON_TEXT_SELECTION_CHANGE, NODE_TEXT_INPUT_ON_EDIT_CHANGE, NODE_TEXT_INPUT_ON_INPUT_FILTER_ERROR,<br/>NODE_TEXT_INPUT_ON_CONTENT_SCROLL, NODE_TEXT_INPUT_ON_CONTENT_SIZE_CHANGE, NODE_TEXT_INPUT_ON_WILL_INSERT = 7009, NODE_TEXT_INPUT_ON_DID_INSERT = 7010,<br/>NODE_TEXT_INPUT_ON_WILL_DELETE = 7011, NODE_TEXT_INPUT_ON_DID_DELETE = 7012, NODE_TEXT_INPUT_ON_CHANGE_WITH_PREVIEW_TEXT = 7013, NODE_TEXT_AREA_ON_CHANGE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_TEXT_AREA, NODE_TEXT_AREA_ON_PASTE,<br/>NODE_TEXT_AREA_ON_TEXT_SELECTION_CHANGE, NODE_TEXT_AREA_ON_EDIT_CHANGE, NODE_TEXT_AREA_ON_SUBMIT, NODE_TEXT_AREA_ON_INPUT_FILTER_ERROR,<br/>NODE_TEXT_AREA_ON_CONTENT_SCROLL, NODE_TEXT_AREA_ON_CONTENT_SIZE_CHANGE, NODE_TEXT_AREA_ON_WILL_INSERT = 8008, NODE_TEXT_AREA_ON_DID_INSERT = 8009,<br/>NODE_TEXT_AREA_ON_WILL_DELETE = 8010, NODE_TEXT_AREA_ON_DID_DELETE = 8011, NODE_TEXT_AREA_ON_CHANGE_WITH_PREVIEW_TEXT = 8012, NODE_CHECKBOX_EVENT_ON_CHANGE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_CHECKBOX, NODE_DATE_PICKER_EVENT_ON_DATE_CHANGE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_DATE_PICKER,<br/>NODE_TIME_PICKER_EVENT_ON_CHANGE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_TIME_PICKER, NODE_TEXT_PICKER_EVENT_ON_CHANGE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_TEXT_PICKER, NODE_TEXT_PICKER_EVENT_ON_SCROLL_STOP, NODE_CALENDAR_PICKER_EVENT_ON_CHANGE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_CALENDAR_PICKER, NODE_SLIDER_EVENT_ON_CHANGE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_SLIDER,<br/>NODE_RADIO_EVENT_ON_CHANGE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_RADIO, NODE_IMAGE_ANIMATOR_EVENT_ON_START = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_IMAGE_ANIMATOR, NODE_IMAGE_ANIMATOR_EVENT_ON_PAUSE, NODE_IMAGE_ANIMATOR_EVENT_ON_REPEAT,<br/>NODE_IMAGE_ANIMATOR_EVENT_ON_CANCEL, NODE_IMAGE_ANIMATOR_EVENT_ON_FINISH, <br/>NODE_CHECKBOX_GROUP_EVENT_ON_CHANGE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_CHECKBOX_GROUP,<br/> NODE_SWIPER_EVENT_ON_CHANGE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_SWIPER, NODE_SWIPER_EVENT_ON_ANIMATION_START,<br/>NODE_SWIPER_EVENT_ON_ANIMATION_END, NODE_SWIPER_EVENT_ON_GESTURE_SWIPE, NODE_SWIPER_EVENT_ON_CONTENT_DID_SCROLL, NODE_SWIPER_EVENT_ON_SELECTED = 1001005, NODE_SWIPER_EVENT_ON_UNSELECTED = 1001006, NODE_SWIPER_EVENT_ON_CONTENT_WILL_SCROLL = 1001007, NODE_SCROLL_EVENT_ON_SCROLL = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_SCROLL,<br/>NODE_SCROLL_EVENT_ON_SCROLL_FRAME_BEGIN, NODE_SCROLL_EVENT_ON_WILL_SCROLL, NODE_SCROLL_EVENT_ON_DID_SCROLL, NODE_SCROLL_EVENT_ON_SCROLL_START,<br/>NODE_SCROLL_EVENT_ON_SCROLL_STOP, NODE_SCROLL_EVENT_ON_SCROLL_EDGE, NODE_SCROLL_EVENT_ON_REACH_START, NODE_SCROLL_EVENT_ON_REACH_END,<br/>NODE_LIST_ON_SCROLL_INDEX = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_LIST, NODE_LIST_ON_WILL_SCROLL, NODE_LIST_ON_DID_SCROLL, NODE_LIST_ON_SCROLL_VISIBLE_CONTENT_CHANGE, NODE_REFRESH_STATE_CHANGE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_REFRESH,<br/>NODE_REFRESH_ON_REFRESH, NODE_REFRESH_ON_OFFSET_CHANGE, NODE_ON_WILL_SCROLL = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_WATER_FLOW, NODE_WATER_FLOW_ON_DID_SCROLL,<br/>NODE_WATER_FLOW_ON_SCROLL_INDEX<br/>} | 提供NativeNode组件支持的事件类型定义。  |
177| [ArkUI_NodeDirtyFlag](#arkui_nodedirtyflag) { NODE_NEED_MEASURE = 1, NODE_NEED_LAYOUT, NODE_NEED_RENDER } | 自定义组件调用&lt;b&gt;::markDirty是传递的脏区标识类型。  |
178| [ArkUI_NodeCustomEventType](#arkui_nodecustomeventtype) {<br/>ARKUI_NODE_CUSTOM_EVENT_ON_MEASURE = 1 &lt;&lt; 0, ARKUI_NODE_CUSTOM_EVENT_ON_LAYOUT = 1 &lt;&lt; 1, ARKUI_NODE_CUSTOM_EVENT_ON_DRAW = 1 &lt;&lt; 2, ARKUI_NODE_CUSTOM_EVENT_ON_FOREGROUND_DRAW = 1 &lt;&lt; 3,<br/>ARKUI_NODE_CUSTOM_EVENT_ON_OVERLAY_DRAW = 1 &lt;&lt; 4<br/>} | 定义自定义组件事件类型。  |
179| [ArkUI_NodeAdapterEventType](#arkui_nodeadaptereventtype) {<br/>NODE_ADAPTER_EVENT_WILL_ATTACH_TO_NODE = 1, NODE_ADAPTER_EVENT_WILL_DETACH_FROM_NODE = 2, NODE_ADAPTER_EVENT_ON_GET_NODE_ID = 3, NODE_ADAPTER_EVENT_ON_ADD_NODE_TO_ADAPTER = 4,<br/>NODE_ADAPTER_EVENT_ON_REMOVE_NODE_FROM_ADAPTER = 5<br/>} | 定义节点适配器事件枚举值。  |
180| [ArkUI_NodeContentEventType](#arkui_nodecontenteventtype) { NODE_CONTENT_EVENT_ON_ATTACH_TO_WINDOW = 0, NODE_CONTENT_EVENT_ON_DETACH_FROM_WINDOW = 1 } | 定义NodeContent事件类型。  |
181| [ArkUI_Alignment](#arkui_alignment) {<br/>ARKUI_ALIGNMENT_TOP_START = 0, ARKUI_ALIGNMENT_TOP, ARKUI_ALIGNMENT_TOP_END, ARKUI_ALIGNMENT_START,<br/>ARKUI_ALIGNMENT_CENTER, ARKUI_ALIGNMENT_END, ARKUI_ALIGNMENT_BOTTOM_START, ARKUI_ALIGNMENT_BOTTOM,<br/>ARKUI_ALIGNMENT_BOTTOM_END<br/>} | 定义布局对齐枚举值。  |
182| [ArkUI_ImageRepeat](#arkui_imagerepeat) { ARKUI_IMAGE_REPEAT_NONE = 0, ARKUI_IMAGE_REPEAT_X, ARKUI_IMAGE_REPEAT_Y, ARKUI_IMAGE_REPEAT_XY } | 定义图片重复铺设枚举值。  |
183| [ArkUI_FontStyle](#arkui_fontstyle) { ARKUI_FONT_STYLE_NORMAL = 0, ARKUI_FONT_STYLE_ITALIC } | 定义字体样式枚举值。  |
184| [ArkUI_FontWeight](#arkui_fontweight) {<br/>ARKUI_FONT_WEIGHT_W100 = 0, ARKUI_FONT_WEIGHT_W200, ARKUI_FONT_WEIGHT_W300, ARKUI_FONT_WEIGHT_W400,<br/>ARKUI_FONT_WEIGHT_W500, ARKUI_FONT_WEIGHT_W600, ARKUI_FONT_WEIGHT_W700, ARKUI_FONT_WEIGHT_W800,<br/>ARKUI_FONT_WEIGHT_W900, ARKUI_FONT_WEIGHT_BOLD, ARKUI_FONT_WEIGHT_NORMAL, ARKUI_FONT_WEIGHT_BOLDER,<br/>ARKUI_FONT_WEIGHT_LIGHTER, ARKUI_FONT_WEIGHT_MEDIUM, ARKUI_FONT_WEIGHT_REGULAR<br/>} | 定义字体粗细/字重枚举值。  |
185| [ArkUI_TextAlignment](#arkui_textalignment) { ARKUI_TEXT_ALIGNMENT_START = 0, ARKUI_TEXT_ALIGNMENT_CENTER, ARKUI_TEXT_ALIGNMENT_END, ARKUI_TEXT_ALIGNMENT_JUSTIFY } | 定义字体水平对齐样式枚举值。  |
186| [ArkUI_EnterKeyType](#arkui_enterkeytype) {<br/>ARKUI_ENTER_KEY_TYPE_GO = 2, ARKUI_ENTER_KEY_TYPE_SEARCH = 3, ARKUI_ENTER_KEY_TYPE_SEND, ARKUI_ENTER_KEY_TYPE_NEXT,<br/>ARKUI_ENTER_KEY_TYPE_DONE, ARKUI_ENTER_KEY_TYPE_PREVIOUS, ARKUI_ENTER_KEY_TYPE_NEW_LINE<br/>} | 定义单行文本输入法回车键类型枚举值。  |
187| [ArkUI_TextInputType](#arkui_textinputtype) {<br/>ARKUI_TEXTINPUT_TYPE_NORMAL = 0, ARKUI_TEXTINPUT_TYPE_NUMBER = 2, ARKUI_TEXTINPUT_TYPE_PHONE_NUMBER = 3, ARKUI_TEXTINPUT_TYPE_EMAIL = 5,<br/>ARKUI_TEXTINPUT_TYPE_PASSWORD = 7, ARKUI_TEXTINPUT_TYPE_NUMBER_PASSWORD = 8, ARKUI_TEXTINPUT_TYPE_SCREEN_LOCK_PASSWORD = 9, ARKUI_TEXTINPUT_TYPE_USER_NAME = 10,<br/>ARKUI_TEXTINPUT_TYPE_NEW_PASSWORD = 11, ARKUI_TEXTINPUT_TYPE_NUMBER_DECIMAL = 12<br/>} | 定义单行文本输入法类型枚举值。  |
188| [ArkUI_TextAreaType](#arkui_textareatype) { ARKUI_TEXTAREA_TYPE_NORMAL = 0, ARKUI_TEXTAREA_TYPE_NUMBER = 2, ARKUI_TEXTAREA_TYPE_PHONE_NUMBER = 3, ARKUI_TEXTAREA_TYPE_EMAIL = 5 } | 定义多行文本输入法类型枚举值。  |
189| [ArkUI_CancelButtonStyle](#arkui_cancelbuttonstyle) { ARKUI_CANCELBUTTON_STYLE_CONSTANT = 0, ARKUI_CANCELBUTTON_STYLE_INVISIBLE, ARKUI_CANCELBUTTON_STYLE_INPUT } | 定义清除按钮样式枚举值。  |
190| [ArkUI_XComponentType](#arkui_xcomponenttype) { ARKUI_XCOMPONENT_TYPE_SURFACE = 0, ARKUI_XCOMPONENT_TYPE_TEXTURE = 2 } | 定义XComponent类型枚举值。  |
191| [ArkUI_ProgressType](#arkui_progresstype) {<br/>ARKUI_PROGRESS_TYPE_LINEAR = 0, ARKUI_PROGRESS_TYPE_RING, ARKUI_PROGRESS_TYPE_ECLIPSE, ARKUI_PROGRESS_TYPE_SCALE_RING,<br/>ARKUI_PROGRESS_TYPE_CAPSULE<br/>} | 定义进度条类型枚举值。  |
192| [ArkUI_TextDecorationType](#arkui_textdecorationtype) { ARKUI_TEXT_DECORATION_TYPE_NONE = 0, ARKUI_TEXT_DECORATION_TYPE_UNDERLINE, ARKUI_TEXT_DECORATION_TYPE_OVERLINE, ARKUI_TEXT_DECORATION_TYPE_LINE_THROUGH } | 定义装饰线类型枚举值。  |
193| [ArkUI_TextDecorationStyle](#arkui_textdecorationstyle) {<br/>ARKUI_TEXT_DECORATION_STYLE_SOLID = 0, ARKUI_TEXT_DECORATION_STYLE_DOUBLE, ARKUI_TEXT_DECORATION_STYLE_DOTTED, ARKUI_TEXT_DECORATION_STYLE_DASHED,<br/>ARKUI_TEXT_DECORATION_STYLE_WAVY<br/>} | 定义装饰线样式枚举值。  |
194| [ArkUI_TextCase](#arkui_textcase) { ARKUI_TEXT_CASE_NORMAL = 0, ARKUI_TEXT_CASE_LOWER, ARKUI_TEXT_CASE_UPPER } | 定义文本大小写枚举值。  |
195| [ArkUI_CopyOptions](#arkui_copyoptions) { ARKUI_COPY_OPTIONS_NONE = 0, ARKUI_COPY_OPTIONS_IN_APP, ARKUI_COPY_OPTIONS_LOCAL_DEVICE, ARKUI_COPY_OPTIONS_CROSS_DEVICE } | 定义文本复制黏贴模式枚举值。  |
196| [ArkUI_ShadowType](#arkui_shadowtype) { ARKUI_SHADOW_TYPE_COLOR = 0, ARKUI_SHADOW_TYPE_BLUR } | 定义阴影类型枚举值。  |
197| [ArkUI_TextPickerRangeType](#arkui_textpickerrangetype) { ARKUI_TEXTPICKER_RANGETYPE_SINGLE = 0, ARKUI_TEXTPICKER_RANGETYPE_MULTI, ARKUI_TEXTPICKER_RANGETYPE_RANGE_CONTENT, ARKUI_TEXTPICKER_RANGETYPE_CASCADE_RANGE_CONTENT } | 定义滑动选择文本选择器输入类型。  |
198| [ArkUI_AccessibilityCheckedState](#arkui_accessibilitycheckedstate) { ARKUI_ACCESSIBILITY_UNCHECKED = 0, ARKUI_ACCESSIBILITY_CHECKED } | 定义无障碍复选框状态类型枚举值。  |
199| [ArkUI_AccessibilityActionType](#arkui_accessibilityactiontype) {<br/>ARKUI_ACCESSIBILITY_ACTION_CLICK = 1 &lt;&lt; 0, ARKUI_ACCESSIBILITY_ACTION_LONG_CLICK = 1 &lt;&lt; 1, ARKUI_ACCESSIBILITY_ACTION_CUT = 1 &lt;&lt; 2, ARKUI_ACCESSIBILITY_ACTION_COPY = 1 &lt;&lt; 3,<br/>ARKUI_ACCESSIBILITY_ACTION_PASTE = 1 &lt;&lt; 4<br/>} | 定义无障碍操作类型。  |
200| [ArkUI_EdgeEffect](#arkui_edgeeffect) { ARKUI_EDGE_EFFECT_SPRING = 0, ARKUI_EDGE_EFFECT_FADE, ARKUI_EDGE_EFFECT_NONE } | 定义边缘滑动效果枚举值。  |
201| [ArkUI_EffectEdge](#arkui_effectedge) { ARKUI_EFFECT_EDGE_START = 1, ARKUI_EFFECT_EDGE_END = 2 } | 定义边缘效果生效边缘的方向枚举值。  |
202| [ArkUI_ScrollDirection](#arkui_scrolldirection) { ARKUI_SCROLL_DIRECTION_VERTICAL = 0, ARKUI_SCROLL_DIRECTION_HORIZONTAL, ARKUI_SCROLL_DIRECTION_NONE = 3 } | 定义Scroll组件排列方向枚举值。  |
203| [ArkUI_ScrollSnapAlign](#arkui_scrollsnapalign) { ARKUI_SCROLL_SNAP_ALIGN_NONE = 0, ARKUI_SCROLL_SNAP_ALIGN_START, ARKUI_SCROLL_SNAP_ALIGN_CENTER, ARKUI_SCROLL_SNAP_ALIGN_END } | 定义列表项滚动结束对齐效果枚举值。  |
204| [ArkUI_ScrollBarDisplayMode](#arkui_scrollbardisplaymode) { ARKUI_SCROLL_BAR_DISPLAY_MODE_OFF = 0, ARKUI_SCROLL_BAR_DISPLAY_MODE_AUTO, ARKUI_SCROLL_BAR_DISPLAY_MODE_ON } | 定义滚动条状态枚举值。  |
205| [ArkUI_Axis](#arkui_axis) { ARKUI_AXIS_VERTICAL = 0, ARKUI_AXIS_HORIZONTAL } | 定义滚动方向和List组件排列方向枚举值。  |
206| [ArkUI_StickyStyle](#arkui_stickystyle) { ARKUI_STICKY_STYLE_NONE = 0, ARKUI_STICKY_STYLE_HEADER = 1, ARKUI_STICKY_STYLE_FOOTER = 2, ARKUI_STICKY_STYLE_BOTH = 3 } | 定义列表是否吸顶和吸底枚举值。  |
207| [ArkUI_BorderStyle](#arkui_borderstyle) { ARKUI_BORDER_STYLE_SOLID = 0, ARKUI_BORDER_STYLE_DASHED, ARKUI_BORDER_STYLE_DOTTED } | 边框线条样式枚举值。  |
208| [ArkUI_HitTestMode](#arkui_hittestmode) { ARKUI_HIT_TEST_MODE_DEFAULT = 0, ARKUI_HIT_TEST_MODE_BLOCK, ARKUI_HIT_TEST_MODE_TRANSPARENT, ARKUI_HIT_TEST_MODE_NONE } | 触摸测试控制枚举值。  |
209| [ArkUI_ShadowStyle](#arkui_shadowstyle) {<br/>ARKUI_SHADOW_STYLE_OUTER_DEFAULT_XS = 0, ARKUI_SHADOW_STYLE_OUTER_DEFAULT_SM, ARKUI_SHADOW_STYLE_OUTER_DEFAULT_MD, ARKUI_SHADOW_STYLE_OUTER_DEFAULT_LG,<br/>ARKUI_SHADOW_STYLE_OUTER_FLOATING_SM, ARKUI_SHADOW_STYLE_OUTER_FLOATING_MD<br/>} | 阴影效果枚举值。  |
210| [ArkUI_AnimationCurve](#arkui_animationcurve) {<br/>ARKUI_CURVE_LINEAR = 0, ARKUI_CURVE_EASE, ARKUI_CURVE_EASE_IN, ARKUI_CURVE_EASE_OUT,<br/>ARKUI_CURVE_EASE_IN_OUT, ARKUI_CURVE_FAST_OUT_SLOW_IN, ARKUI_CURVE_LINEAR_OUT_SLOW_IN, ARKUI_CURVE_FAST_OUT_LINEAR_IN,<br/>ARKUI_CURVE_EXTREME_DECELERATION, ARKUI_CURVE_SHARP, ARKUI_CURVE_RHYTHM, ARKUI_CURVE_SMOOTH,<br/>ARKUI_CURVE_FRICTION<br/>} | 动画曲线枚举值。  |
211| [ArkUI_SwiperArrow](#arkui_swiperarrow) { ARKUI_SWIPER_ARROW_HIDE = 0, ARKUI_SWIPER_ARROW_SHOW, ARKUI_SWIPER_ARROW_SHOW_ON_HOVER } | Swiper导航点箭头枚举值。  |
212| [ArkUI_SwiperNestedScrollMode](#arkui_swipernestedscrollmode) { ARKUI_SWIPER_NESTED_SRCOLL_SELF_ONLY = 0, ARKUI_SWIPER_NESTED_SRCOLL_SELF_FIRST } | Swiper组件和父组件的嵌套滚动模式。  |
213| [ArkUI_PageFlipMode](#arkui_pageflipmode) { ARKUI_PAGE_FLIP_MODE_CONTINUOUS = 0, ARKUI_PAGE_FLIP_MODE_SINGLE } | Swiper组件鼠标滚轮翻页模式。  |
214| [ArkUI_SwiperAnimationMode](#arkui_swiperanimationmode) { ARKUI_SWIPER_NO_ANIMATION = 0, ARKUI_SWIPER_DEFAULT_ANIMATION, ARKUI_SWIPER_FAST_ANIMATION } | Swiper组件跳转到目标index的动画模式。  |
215| [ArkUI_AccessibilityMode](#arkui_accessibilitymode) { ARKUI_ACCESSIBILITY_MODE_AUTO = 0, ARKUI_ACCESSIBILITY_MODE_ENABLED, ARKUI_ACCESSIBILITY_MODE_DISABLED, ARKUI_ACCESSIBILITY_MODE_DISABLED_FOR_DESCENDANTS } | 定义无障碍辅助服务模式。  |
216| [ArkUI_TextCopyOptions](#arkui_textcopyoptions) { ARKUI_TEXT_COPY_OPTIONS_NONE = 0, ARKUI_TEXT_COPY_OPTIONS_IN_APP, ARKUI_TEXT_COPY_OPTIONS_LOCAL_DEVICE, ARKUI_TEXT_COPY_OPTIONS_CROSS_DEVICE } | 定义组件支持设置文本是否可复制粘贴。  |
217| [ArkUI_TextHeightAdaptivePolicy](#arkui_textheightadaptivepolicy) { ARKUI_TEXT_HEIGHT_ADAPTIVE_POLICY_MAX_LINES_FIRST = 0, ARKUI_TEXT_HEIGHT_ADAPTIVE_POLICY_MIN_FONT_SIZE_FIRST, ARKUI_TEXT_HEIGHT_ADAPTIVE_POLICY_LAYOUT_CONSTRAINT_FIRST } | 定义文本自适应高度的方式。  |
218| [ArkUI_ScrollNestedMode](#arkui_scrollnestedmode) { ARKUI_SCROLL_NESTED_MODE_SELF_ONLY = 0, ARKUI_SCROLL_NESTED_MODE_SELF_FIRST, ARKUI_SCROLL_NESTED_MODE_PARENT_FIRST, ARKUI_SCROLL_NESTED_MODE_PARALLEL } | 定义嵌套滚动选项。  |
219| [ArkUI_ScrollEdge](#arkui_scrolledge) { ARKUI_SCROLL_EDGE_TOP = 0, ARKUI_SCROLL_EDGE_BOTTOM, ARKUI_SCROLL_EDGE_START, ARKUI_SCROLL_EDGE_END } | 定义滚动到的边缘位置。  |
220| [ArkUI_ScrollAlignment](#arkui_scrollalignment) { ARKUI_SCROLL_ALIGNMENT_START = 0, ARKUI_SCROLL_ALIGNMENT_CENTER, ARKUI_SCROLL_ALIGNMENT_END, ARKUI_SCROLL_ALIGNMENT_AUTO } | 滚动到具体item时的对齐方式。  |
221| [ArkUI_ScrollState](#arkui_scrollstate) { ARKUI_SCROLL_STATE_IDLE = 0, ARKUI_SCROLL_STATE_SCROLL, ARKUI_SCROLL_STATE_FLING } | 定义当前滚动状态。  |
222| [ArkUI_SliderBlockStyle](#arkui_sliderblockstyle) { ARKUI_SLIDER_BLOCK_STYLE_DEFAULT = 0, ARKUI_SLIDER_BLOCK_STYLE_IMAGE, ARKUI_SLIDER_BLOCK_STYLE_SHAPE } | 定义滑块形状。  |
223| [ArkUI_SliderDirection](#arkui_sliderdirection) { ARKUI_SLIDER_DIRECTION_VERTICAL = 0, ARKUI_SLIDER_DIRECTION_HORIZONTAL } | 定义滑动条滑动方向。  |
224| [ArkUI_SliderStyle](#arkui_sliderstyle) { ARKUI_SLIDER_STYLE_OUT_SET = 0, ARKUI_SLIDER_STYLE_IN_SET, ARKUI_SLIDER_STYLE_NONE } | 定义滑块与滑轨显示样式。  |
225| [ArkUI_CheckboxShape](#arkui_checkboxshape) { ArkUI_CHECKBOX_SHAPE_CIRCLE = 0, ArkUI_CHECKBOX_SHAPE_ROUNDED_SQUARE } | 定义CheckBox组件形状。  |
226| [ArkUI_AnimationPlayMode](#arkui_animationplaymode) { ARKUI_ANIMATION_PLAY_MODE_NORMAL = 0, ARKUI_ANIMATION_PLAY_MODE_REVERSE, ARKUI_ANIMATION_PLAY_MODE_ALTERNATE, ARKUI_ANIMATION_PLAY_MODE_ALTERNATE_REVERSE } | 定义动画播放模式。  |
227| [ArkUI_ImageSize](#arkui_imagesize) { ARKUI_IMAGE_SIZE_AUTO = 0, ARKUI_IMAGE_SIZE_COVER, ARKUI_IMAGE_SIZE_CONTAIN } | 定义图片宽高样式。  |
228| [ArkUI_AdaptiveColor](#arkui_adaptivecolor) { ARKUI_ADAPTIVE_COLOR_DEFAULT = 0, ARKUI_ADAPTIVE_COLOR_AVERAGE } | 定义取色模式。  |
229| [ArkUI_ColorMode](#arkui_colormode) { ARKUI_COLOR_MODE_SYSTEM = 0, ARKUI_COLOR_MODE_LIGHT, ARKUI_COLOR_MODE_DARK } | 定义深浅色模式。  |
230| [ArkUI_SystemColorMode](#arkui_systemcolormode) { ARKUI_SYSTEM_COLOR_MODE_LIGHT = 0, ARKUI_SYSTEM_COLOR_MODE_DARK } | 定义系统深浅色模式。  |
231| [ArkUI_BlurStyle](#arkui_blurstyle) {<br/>ARKUI_BLUR_STYLE_THIN = 0, ARKUI_BLUR_STYLE_REGULAR, ARKUI_BLUR_STYLE_THICK, ARKUI_BLUR_STYLE_BACKGROUND_THIN,<br/>ARKUI_BLUR_STYLE_BACKGROUND_REGULAR, ARKUI_BLUR_STYLE_BACKGROUND_THICK, ARKUI_BLUR_STYLE_BACKGROUND_ULTRA_THICK, ARKUI_BLUR_STYLE_NONE,<br/>ARKUI_BLUR_STYLE_COMPONENT_ULTRA_THIN, ARKUI_BLUR_STYLE_COMPONENT_THIN, ARKUI_BLUR_STYLE_COMPONENT_REGULAR, ARKUI_BLUR_STYLE_COMPONENT_THICK,<br/>ARKUI_BLUR_STYLE_COMPONENT_ULTRA_THICK<br/>} | 定义背景模糊样式。  |
232| [ArkUI_VerticalAlignment](#arkui_verticalalignment) { ARKUI_VERTICAL_ALIGNMENT_TOP = 0, ARKUI_VERTICAL_ALIGNMENT_CENTER, ARKUI_VERTICAL_ALIGNMENT_BOTTOM } | 定义垂直对齐方式。  |
233| [ArkUI_HorizontalAlignment](#arkui_horizontalalignment) { ARKUI_HORIZONTAL_ALIGNMENT_START = 0, ARKUI_HORIZONTAL_ALIGNMENT_CENTER, ARKUI_HORIZONTAL_ALIGNMENT_END } | 定义语言方向对齐方式。  |
234| [ArkUI_TextOverflow](#arkui_textoverflow) { ARKUI_TEXT_OVERFLOW_NONE = 0, ARKUI_TEXT_OVERFLOW_CLIP, ARKUI_TEXT_OVERFLOW_ELLIPSIS, ARKUI_TEXT_OVERFLOW_MARQUEE } | 定义文本超长时的显示方式。  |
235| [ArkUI_ImageSpanAlignment](#arkui_imagespanalignment) { ARKUI_IMAGE_SPAN_ALIGNMENT_BASELINE = 0, ARKUI_IMAGE_SPAN_ALIGNMENT_BOTTOM, ARKUI_IMAGE_SPAN_ALIGNMENT_CENTER, ARKUI_IMAGE_SPAN_ALIGNMENT_TOP } | 定义图片基于文本的对齐方式。  |
236| [ArkUI_ObjectFit](#arkui_objectfit) {<br/>ARKUI_OBJECT_FIT_CONTAIN = 0, ARKUI_OBJECT_FIT_COVER, ARKUI_OBJECT_FIT_AUTO, ARKUI_OBJECT_FIT_FILL,<br/>ARKUI_OBJECT_FIT_SCALE_DOWN, ARKUI_OBJECT_FIT_NONE, ARKUI_OBJECT_FIT_NONE_AND_ALIGN_TOP_START, ARKUI_OBJECT_FIT_NONE_AND_ALIGN_TOP,<br/>ARKUI_OBJECT_FIT_NONE_AND_ALIGN_TOP_END, ARKUI_OBJECT_FIT_NONE_AND_ALIGN_START, ARKUI_OBJECT_FIT_NONE_AND_ALIGN_CENTER, ARKUI_OBJECT_FIT_NONE_AND_ALIGN_END,<br/>ARKUI_OBJECT_FIT_NONE_AND_ALIGN_BOTTOM_START, ARKUI_OBJECT_FIT_NONE_AND_ALIGN_BOTTOM, ARKUI_OBJECT_FIT_NONE_AND_ALIGN_BOTTOM_END<br/>} | 定义image填充效果。 ImageSpanAlignment  |
237| [ArkUI_ImageInterpolation](#arkui_imageinterpolation) { ARKUI_IMAGE_INTERPOLATION_NONE = 0, ARKUI_IMAGE_INTERPOLATION_LOW, ARKUI_IMAGE_INTERPOLATION_MEDIUM, ARKUI_IMAGE_INTERPOLATION_HIGH } | 定义图片插值效果。  |
238| [ArkUI_BlendMode](#arkui_blendmode) {<br/>ARKUI_BLEND_MODE_NONE = 0, ARKUI_BLEND_MODE_CLEAR, ARKUI_BLEND_MODE_SRC, ARKUI_BLEND_MODE_DST,<br/>ARKUI_BLEND_MODE_SRC_OVER, ARKUI_BLEND_MODE_DST_OVER, ARKUI_BLEND_MODE_SRC_IN, ARKUI_BLEND_MODE_DST_IN,<br/>ARKUI_BLEND_MODE_SRC_OUT, ARKUI_BLEND_MODE_DST_OUT, ARKUI_BLEND_MODE_SRC_ATOP, ARKUI_BLEND_MODE_DST_ATOP,<br/>ARKUI_BLEND_MODE_XOR, ARKUI_BLEND_MODE_PLUS, ARKUI_BLEND_MODE_MODULATE, ARKUI_BLEND_MODE_SCREEN,<br/>ARKUI_BLEND_MODE_OVERLAY, ARKUI_BLEND_MODE_DARKEN, ARKUI_BLEND_MODE_LIGHTEN, ARKUI_BLEND_MODE_COLOR_DODGE,<br/>ARKUI_BLEND_MODE_COLOR_BURN, ARKUI_BLEND_MODE_HARD_LIGHT, ARKUI_BLEND_MODE_SOFT_LIGHT, ARKUI_BLEND_MODE_DIFFERENCE,<br/>ARKUI_BLEND_MODE_EXCLUSION, ARKUI_BLEND_MODE_MULTIPLY, ARKUI_BLEND_MODE_HUE, ARKUI_BLEND_MODE_SATURATION,<br/>ARKUI_BLEND_MODE_COLOR, ARKUI_BLEND_MODE_LUMINOSITY<br/>} | 混合模式枚举值。  |
239| [ArkUI_Direction](#arkui_direction) { ARKUI_DIRECTION_LTR = 0, ARKUI_DIRECTION_RTL, ARKUI_DIRECTION_AUTO = 3 } | 设置容器元素内主轴方向上的布局枚举值。  |
240| [ArkUI_ItemAlignment](#arkui_itemalignment) {<br/>ARKUI_ITEM_ALIGNMENT_AUTO = 0, ARKUI_ITEM_ALIGNMENT_START, ARKUI_ITEM_ALIGNMENT_CENTER, ARKUI_ITEM_ALIGNMENT_END,<br/>ARKUI_ITEM_ALIGNMENT_STRETCH, ARKUI_ITEM_ALIGNMENT_BASELINE<br/>} | 设置子组件在父容器交叉轴的对齐格式枚举值。  |
241| [ArkUI_ColorStrategy](#arkui_colorstrategy) { ARKUI_COLOR_STRATEGY_INVERT = 0, ARKUI_COLOR_STRATEGY_AVERAGE, ARKUI_COLOR_STRATEGY_PRIMARY } | 前景色枚举值。  |
242| [ArkUI_FlexAlignment](#arkui_flexalignment) {<br/>ARKUI_FLEX_ALIGNMENT_START = 1, ARKUI_FLEX_ALIGNMENT_CENTER = 2, ARKUI_FLEX_ALIGNMENT_END = 3, ARKUI_FLEX_ALIGNMENT_SPACE_BETWEEN = 6,<br/>ARKUI_FLEX_ALIGNMENT_SPACE_AROUND = 7, ARKUI_FLEX_ALIGNMENT_SPACE_EVENLY = 8<br/>} | 定义垂直方向对齐方式。  |
243| [ArkUI_FlexDirection](#arkui_flexdirection) { ARKUI_FLEX_DIRECTION_ROW = 0, ARKUI_FLEX_DIRECTION_COLUMN, ARKUI_FLEX_DIRECTION_ROW_REVERSE, ARKUI_FLEX_DIRECTION_COLUMN_REVERSE } | 定义Flex容器的主轴方向。  |
244| [ArkUI_FlexWrap](#arkui_flexwrap) { ARKUI_FLEX_WRAP_NO_WRAP = 0, ARKUI_FLEX_WRAP_WRAP, ARKUI_FLEX_WRAP_WRAP_REVERSE } | 定义Flex行列布局模式模式。  |
245| [ArkUI_Visibility](#arkui_visibility) { ARKUI_VISIBILITY_VISIBLE = 0, ARKUI_VISIBILITY_HIDDEN, ARKUI_VISIBILITY_NONE } | 控制组件的显隐枚举值。  |
246| [ArkUI_CalendarAlignment](#arkui_calendaralignment) { ARKUI_CALENDAR_ALIGNMENT_START = 0, ARKUI_CALENDAR_ALIGNMENT_CENTER, ARKUI_CALENDAR_ALIGNMENT_END } | 日历选择器与入口组件对齐方式。  |
247| [ArkUI_MaskType](#arkui_masktype) {<br/>ARKUI_MASK_TYPE_RECTANGLE = 0, ARKUI_MASK_TYPE_CIRCLE, ARKUI_MASK_TYPE_ELLIPSE, ARKUI_MASK_TYPE_PATH,<br/>ARKUI_MASK_TYPE_PROGRESS<br/>} | 遮罩类型枚举。  |
248| [ArkUI_ClipType](#arkui_cliptype) { ARKUI_CLIP_TYPE_RECTANGLE = 0, ARKUI_CLIP_TYPE_CIRCLE, ARKUI_CLIP_TYPE_ELLIPSE, ARKUI_CLIP_TYPE_PATH } | 裁剪类型枚举。  |
249| [ArkUI_ShapeType](#arkui_shapetype) { ARKUI_SHAPE_TYPE_RECTANGLE = 0, ARKUI_SHAPE_TYPE_CIRCLE, ARKUI_SHAPE_TYPE_ELLIPSE, ARKUI_SHAPE_TYPE_PATH } | 自定义形状。  |
250| [ArkUI_LinearGradientDirection](#arkui_lineargradientdirection) {<br/>ARKUI_LINEAR_GRADIENT_DIRECTION_LEFT = 0, ARKUI_LINEAR_GRADIENT_DIRECTION_TOP, ARKUI_LINEAR_GRADIENT_DIRECTION_RIGHT, ARKUI_LINEAR_GRADIENT_DIRECTION_BOTTOM,<br/>ARKUI_LINEAR_GRADIENT_DIRECTION_LEFT_TOP, ARKUI_LINEAR_GRADIENT_DIRECTION_LEFT_BOTTOM, ARKUI_LINEAR_GRADIENT_DIRECTION_RIGHT_TOP, ARKUI_LINEAR_GRADIENT_DIRECTION_RIGHT_BOTTOM,<br/>ARKUI_LINEAR_GRADIENT_DIRECTION_NONE, ARKUI_LINEAR_GRADIENT_DIRECTION_CUSTOM<br/>} | 定义渐变方向结构。  |
251| [ArkUI_WordBreak](#arkui_wordbreak) { ARKUI_WORD_BREAK_NORMAL = 0, ARKUI_WORD_BREAK_BREAK_ALL, ARKUI_WORD_BREAK_BREAK_WORD, ARKUI_WORD_BREAK_HYPHENATION } | 定义文本断行规则。  |
252| [ArkUI_EllipsisMode](#arkui_ellipsismode) { ARKUI_ELLIPSIS_MODE_START = 0, ARKUI_ELLIPSIS_MODE_CENTER, ARKUI_ELLIPSIS_MODE_END } | 定义文本省略位置。  |
253| [ArkUI_ImageRenderMode](#arkui_imagerendermode) { ARKUI_IMAGE_RENDER_MODE_ORIGINAL = 0, ARKUI_IMAGE_RENDER_MODE_TEMPLATE } | 定义图片渲染模式。  |
254| [ArkUI_TransitionEdge](#arkui_transitionedge) { ARKUI_TRANSITION_EDGE_TOP = 0, ARKUI_TRANSITION_EDGE_BOTTOM, ARKUI_TRANSITION_EDGE_START, ARKUI_TRANSITION_EDGE_END } | 定义转场从边缘滑入和滑出的效果。  |
255| [ArkUI_FinishCallbackType](#arkui_finishcallbacktype) { ARKUI_FINISH_CALLBACK_REMOVED = 0, ARKUI_FINISH_CALLBACK_LOGICALLY } | 在动画中定义onFinish回调的类型。  |
256| [ArkUI_ListItemAlignment](#arkui_listitemalignment) { ARKUI_LIST_ITEM_ALIGNMENT_START = 0, ARKUI_LIST_ITEM_ALIGNMENT_CENTER, ARKUI_LIST_ITEM_ALIGNMENT_END } | 交叉轴方向的布局方式。  |
257| [ArkUI_BlendApplyType](#arkui_blendapplytype) { BLEND_APPLY_TYPE_FAST = 0, BLEND_APPLY_TYPE_OFFSCREEN } | 指定的混合模式应用于视图的内容选项.  |
258| [ArkUI_LengthMetricUnit](#arkui_lengthmetricunit) { ARKUI_LENGTH_METRIC_UNIT_DEFAULT = -1, ARKUI_LENGTH_METRIC_UNIT_PX = 0, ARKUI_LENGTH_METRIC_UNIT_VP, ARKUI_LENGTH_METRIC_UNIT_FP } | 定义组件的单位模式。  |
259| [ArkUI_TextInputContentType](#arkui_textinputcontenttype) {<br/>ARKUI_TEXTINPUT_CONTENT_TYPE_USER_NAME = 0, ARKUI_TEXTINPUT_CONTENT_TYPE_PASSWORD, ARKUI_TEXTINPUT_CONTENT_TYPE_NEW_PASSWORD, ARKUI_TEXTINPUT_CONTENT_TYPE_FULL_STREET_ADDRESS,<br/>ARKUI_TEXTINPUT_CONTENT_TYPE_HOUSE_NUMBER, ARKUI_TEXTINPUT_CONTENT_TYPE_DISTRICT_ADDRESS, ARKUI_TEXTINPUT_CONTENT_TYPE_CITY_ADDRESS, ARKUI_TEXTINPUT_CONTENT_TYPE_PROVINCE_ADDRESS,<br/>ARKUI_TEXTINPUT_CONTENT_TYPE_COUNTRY_ADDRESS, ARKUI_TEXTINPUT_CONTENT_TYPE_PERSON_FULL_NAME, ARKUI_TEXTINPUT_CONTENT_TYPE_PERSON_LAST_NAME, ARKUI_TEXTINPUT_CONTENT_TYPE_PERSON_FIRST_NAME,<br/>ARKUI_TEXTINPUT_CONTENT_TYPE_PHONE_NUMBER, ARKUI_TEXTINPUT_CONTENT_TYPE_PHONE_COUNTRY_CODE, ARKUI_TEXTINPUT_CONTENT_TYPE_FULL_PHONE_NUMBER, ARKUI_TEXTINPUT_CONTENT_EMAIL_ADDRESS,<br/>ARKUI_TEXTINPUT_CONTENT_TYPE_BANK_CARD_NUMBER, ARKUI_TEXTINPUT_CONTENT_TYPE_ID_CARD_NUMBER, ARKUI_TEXTINPUT_CONTENT_TYPE_NICKNAME, ARKUI_TEXTINPUT_CONTENT_TYPE_DETAIL_INFO_WITHOUT_STREET,<br/>ARKUI_TEXTINPUT_CONTENT_TYPE_FORMAT_ADDRESS,<br/>ARKUI_TEXTINPUT_CONTENT_TYPE_PASSPORT_NUMBER,<br/>ARKUI_TEXTINPUT_CONTENT_TYPE_VALIDITY,<br/>ARKUI_TEXTINPUT_CONTENT_TYPE_ISSUE_AT,<br/>ARKUI_TEXTINPUT_CONTENT_TYPE_ORGANIZATION,<br/>ARKUI_TEXTINPUT_CONTENT_TYPE_TAX_ID,<br/>ARKUI_TEXTINPUT_CONTENT_TYPE_ADDRESS_CITY_AND_STATE,<br/>ARKUI_TEXTINPUT_CONTENT_TYPE_FLIGHT_NUMBER,<br/>ARKUI_TEXTINPUT_CONTENT_TYPE_LICENSE_NUMBER,<br/>ARKUI_TEXTINPUT_CONTENT_TYPE_LICENSE_FILE_NUMBER,<br/>ARKUI_TEXTINPUT_CONTENT_TYPE_LICENSE_PLATE,<br/>ARKUI_TEXTINPUT_CONTENT_TYPE_ENGINE_NUMBER,<br/>ARKUI_TEXTINPUT_CONTENT_TYPE_LICENSE_CHASSIS_NUMBER,<br/>} | 定义自动填充类型。  |
260| [ArkUI_BarrierDirection](#arkui_barrierdirection) { ARKUI_BARRIER_DIRECTION_START = 0, ARKUI_BARRIER_DIRECTION_END, ARKUI_BARRIER_DIRECTION_TOP, ARKUI_BARRIER_DIRECTION_BOTTOM } | 定义屏障线的方向。  |
261| [ArkUI_RelativeLayoutChainStyle](#arkui_relativelayoutchainstyle) { ARKUI_RELATIVE_LAYOUT_CHAIN_STYLE_SPREAD = 0, ARKUI_RELATIVE_LAYOUT_CHAIN_STYLE_SPREAD_INSIDE, ARKUI_RELATIVE_LAYOUT_CHAIN_STYLE_PACKED } | 定义链的风格。  |
262| [ArkUI_TextInputStyle](#arkui_textinputstyle) { ARKUI_TEXTINPUT_STYLE_DEFAULT = 0, ARKUI_TEXTINPUT_STYLE_INLINE } | 定义输入框风格。  |
263| [ArkUI_TextDataDetectorType](#arkui_textdatadetectortype) { ARKUI_TEXT_DATA_DETECTOR_TYPE_PHONE_NUMBER = 0, ARKUI_TEXT_DATA_DETECTOR_TYPE_URL, ARKUI_TEXT_DATA_DETECTOR_TYPE_EMAIL, ARKUI_TEXT_DATA_DETECTOR_TYPE_ADDRESS } | 定义文本识别的实体类型。  |
264| [ArkUI_ButtonType](#arkui_buttontype) { ARKUI_BUTTON_TYPE_NORMAL = 0, ARKUI_BUTTON_TYPE_CAPSULE, ARKUI_BUTTON_TYPE_CIRCLE } | 定义按钮样式枚举值。  |
265| [ArkUI_RenderFit](#arkui_renderfit) {<br/>ARKUI_RENDER_FIT_CENTER = 0, ARKUI_RENDER_FIT_TOP, ARKUI_RENDER_FIT_BOTTOM, ARKUI_RENDER_FIT_LEFT,<br/>ARKUI_RENDER_FIT_RIGHT, ARKUI_RENDER_FIT_TOP_LEFT, ARKUI_RENDER_FIT_TOP_RIGHT, ARKUI_RENDER_FIT_BOTTOM_LEFT,<br/>ARKUI_RENDER_FIT_BOTTOM_RIGHT, ARKUI_RENDER_FIT_RESIZE_FILL, ARKUI_RENDER_FIT_RESIZE_CONTAIN, ARKUI_RENDER_FIT_RESIZE_CONTAIN_TOP_LEFT,<br/>ARKUI_RENDER_FIT_RESIZE_CONTAIN_BOTTOM_RIGHT, ARKUI_RENDER_FIT_RESIZE_COVER, ARKUI_RENDER_FIT_RESIZE_COVER_TOP_LEFT, ARKUI_RENDER_FIT_RESIZE_COVER_BOTTOM_RIGHT<br/>} | 定义动画终态内容的状态。 |
266| [ArkUI_SwiperIndicatorType](#arkui_swiperindicatortype) { ARKUI_SWIPER_INDICATOR_TYPE_DOT, ARKUI_SWIPER_INDICATOR_TYPE_DIGIT } | 定义 Swiper 组件的导航指示器类型。  |
267| [ArkUI_AnimationDirection](#arkui_animationdirection) { ARKUI_ANIMATION_DIRECTION_NORMAL = 0, ARKUI_ANIMATION_DIRECTION_REVERSE, ARKUI_ANIMATION_DIRECTION_ALTERNATE, ARKUI_ANIMATION_DIRECTION_ALTERNATE_REVERSE } | 动画播放模式。  |
268| [ArkUI_SwiperDisplayModeType](#arkui_swiperdisplaymodetype) { ARKUI_SWIPER_DISPLAY_MODE_STRETCH, ARKUI_SWIPER_DISPLAY_MODE_AUTO_LINEAR } | 定义 Swiper 组件的主轴方向上元素排列的模式。  |
269| [ArkUI_ListItemSwipeActionState](#arkui_listitemswipeactionstate) { ARKUI_LIST_ITEM_SWIPE_ACTION_STATE_COLLAPSED = 0, ARKUI_LIST_ITEM_SWIPE_ACTION_STATE_EXPANDED, ARKUI_LIST_ITEM_SWIPE_ACTION_STATE_ACTIONING } | 定义 Listitem 组件SwipeAction方法的显隐模式。  |
270| [ArkUI_ListItemSwipeEdgeEffect](#arkui_listitemswipeedgeeffect) { ARKUI_LIST_ITEM_SWIPE_EDGE_EFFECT_SPRING = 0, ARKUI_LIST_ITEM_SWIPE_EDGE_EFFECT_NONE } | 定义 Listitem 组件SwipeAction方法的滚动模式。  |
271| [ArkUI_AnimationStatus](#arkui_animationstatus) { ARKUI_ANIMATION_STATUS_INITIAL, ARKUI_ANIMATION_STATUS_RUNNING, ARKUI_ANIMATION_STATUS_PAUSED, ARKUI_ANIMATION_STATUS_STOPPED } | 定义帧动画的播放状态。  |
272| [ArkUI_AnimationFillMode](#arkui_animationfillmode) { ARKUI_ANIMATION_FILL_MODE_NONE, ARKUI_ANIMATION_FILL_MODE_FORWARDS, ARKUI_ANIMATION_FILL_MODE_BACKWARDS, ARKUI_ANIMATION_FILL_MODE_BOTH } | 定义帧动画组件在动画开始前和结束后的状态。  |
273| [ArkUI_ErrorCode](#arkui_errorcode) {<br/>ARKUI_ERROR_CODE_NO_ERROR = 0, ARKUI_ERROR_CODE_PARAM_INVALID = 401, ARKUI_ERROR_CODE_CAPI_INIT_ERROR = 500, ARKUI_ERROR_CODE_INTERNAL_ERROR = 100001,<br/>ARKUI_ERROR_CODE_XCOMPONENT_STATE_INVALID = 103501, ARKUI_ERROR_CODE_ATTRIBUTE_OR_EVENT_NOT_SUPPORTED = 106102, ARKUI_ERROR_CODE_ARKTS_NODE_NOT_SUPPORTED = 106103, ARKUI_ERROR_CODE_ADAPTER_NOT_BOUND = 106104,<br/>ARKUI_ERROR_CODE_ADAPTER_EXIST = 106105, ARKUI_ERROR_CODE_CHILD_NODE_EXIST = 106106, ARKUI_ERROR_CODE_NODE_EVENT_PARAM_INDEX_OUT_OF_RANGE = 106107, ARKUI_ERROR_CODE_NODE_EVENT_PARAM_INVALID = 106108,<br/>ARKUI_ERROR_CODE_NODE_EVENT_NO_RETURN = 106109, ARKUI_ERROR_CODE_NODE_INDEX_INVALID = 106200, ARKUI_ERROR_CODE_GET_INFO_FAILED = 106201, ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR = 106202,<br/>ARKUI_ERROR_CODE_NODE_NOT_ON_MAIN_TREE = 106203, ARKUI_ERROR_CODE_FOCUS_NON_FOCUSABLE = 150001, ARKUI_ERROR_CODE_FOCUS_NON_FOCUSABLE_ANCESTOR = 150002, ARKUI_ERROR_CODE_FOCUS_NON_EXISTENT = 150003,<br/>ARKUI_ERROR_CODE_COMPONENT_SNAPSHOT_TIMEOUT = 160002, ARKUI_ERROR_CODE_NON_SCROLLABLE_CONTAINER = 180001, ARKUI_ERROR_CODE_BUFFER_SIZE_NOT_ENOUGH = 180002, ARKUI_ERROR_CODE_NOT_CLONED_POINTER_EVENT = 180003,<br/>ARKUI_ERROR_CODE_POST_CLONED_COMPONENT_STATUS_ABNORMAL = 180004, ARKUI_ERROR_CODE_POST_CLONED_NO_COMPONENT_HIT_TO_RESPOND_TO_THE_EVENT = 180005, ARKUI_ERROR_CODE_INVALID_STYLED_STRING = 180101, ARKUI_ERROR_CODE_UI_CONTEXT_INVALID = 190001,<br/>ARKUI_ERROR_CODE_CALLBACK_INVALID = 190002, ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED = 180102, ARKUI_ERROR_CODE_DRAG_DROP_OPERATION_NOT_ALLOWED = 190004<br/>} | 定义错误码枚举值。  |
274| [ArkUI_ScrollSource](#arkui_scrollsource) {<br/>ARKUI_SCROLL_SOURCE_DRAG = 0, ARKUI_SCROLL_SOURCE_FLING, ARKUI_SCROLL_SOURCE_EDGE_EFFECT, ARKUI_SCROLL_SOURCE_OTHER_USER_INPUT,<br/>ARKUI_SCROLL_SOURCE_SCROLL_BAR, ARKUI_SCROLL_SOURCE_SCROLL_BAR_FLING, ARKUI_SCROLL_SOURCE_SCROLLER, ARKUI_SCROLL_SOURCE_ANIMATION<br/>} | 定义滚动来源枚举值。  |
275| [ArkUI_SafeAreaType](#arkui_safeareatype) { ARKUI_SAFE_AREA_TYPE_SYSTEM = 1, ARKUI_SAFE_AREA_TYPE_CUTOUT = 1 &lt;&lt; 1, ARKUI_SAFE_AREA_TYPE_KEYBOARD = 1 &lt;&lt; 2 } | 定义扩展安全区域的枚举值。  |
276| [ArkUI_ListItemGroupArea](#arkui_listitemgrouparea) { ARKUI_LIST_ITEM_GROUP_AREA_OUTSIDE = 0, ARKUI_LIST_ITEM_SWIPE_AREA_NONE = 1, ARKUI_LIST_ITEM_SWIPE_AREA_ITEM = 2, ARKUI_LIST_ITEM_SWIPE_AREA_HEADER = 3, ARKUI_LIST_ITEM_SWIPE_AREA_FOOTER = 4<br/>} | 定义组件区域的枚举值。 |
277| [ArkUI_SafeAreaEdge](#arkui_safeareaedge) { ARKUI_SAFE_AREA_EDGE_TOP = 1, ARKUI_SAFE_AREA_EDGE_BOTTOM = 1 &lt;&lt; 1, ARKUI_SAFE_AREA_EDGE_START = 1 &lt;&lt; 2, ARKUI_SAFE_AREA_EDGE_END = 1 &lt;&lt; 3 } | 定义扩展安全区域的方向的枚举值。  |
278| [ArkUI_NavDestinationState](#arkui_navdestinationstate) {<br/>ARKUI_NAV_DESTINATION_STATE_ON_SHOW = 0, ARKUI_NAV_DESTINATION_STATE_ON_HIDE = 1, ARKUI_NAV_DESTINATION_STATE_ON_APPEAR = 2, ARKUI_NAV_DESTINATION_STATE_ON_DISAPPEAR = 3,<br/>ARKUI_NAV_DESTINATION_STATE_ON_WILL_SHOW = 4, ARKUI_NAV_DESTINATION_STATE_ON_WILL_HIDE = 5, ARKUI_NAV_DESTINATION_STATE_ON_WILL_APPEAR = 6, ARKUI_NAV_DESTINATION_STATE_ON_WILL_DISAPPEAR = 7,<br/>ARKUI_NAV_DESTINATION_STATE_ON_BACK_PRESS = 100<br/>} | 定义NavDestination组件的状态。  |
279| [ArkUI_FocusMove](#arkui_focusmove) { ARKUI_FOCUS_MOVE_FORWARD = 0, ARKUI_FOCUS_MOVE_BACKWARD, ARKUI_FOCUS_MOVE_UP, ARKUI_FOCUS_MOVE_DOWN, ARKUI_FOCUS_MOVE_LEFT, ARKUI_FOCUS_MOVE_RIGHT, } | 定义自定义走焦的按键的枚举值。  |
280| [ArkUI_RouterPageState](#arkui_routerpagestate) {<br/>ARKUI_ROUTER_PAGE_STATE_ABOUT_TO_APPEAR = 0, ARKUI_ROUTER_PAGE_STATE_ABOUT_TO_DISAPPEAR = 1, ARKUI_ROUTER_PAGE_STATE_ON_SHOW = 2, ARKUI_ROUTER_PAGE_STATE_ON_HIDE = 3,<br/>ARKUI_ROUTER_PAGE_STATE_ON_BACK_PRESS = 4<br/>} | 定义Router Page的状态。  |
281| [ArkUI_DatePickerMode](#arkui_datepickermode) {<br/>ARKUI_DATEPICKER_MODE_DATE = 0, ARKUI_DATEPICKER_YEAR_AND_MONTH = 1, ARKUI_DATEPICKER_MONTH_AND_DAY = 2<br/> } | 定义要显示的日期选项列样式。  |
282| [ArkUI_ExpandMode](#arkui_expandmode) { <br/>ARKUI_NOT_EXPAND = 0, ARKUI_EXPAND = 1, ARKUI_LAZY_EXPAND = 2 <br/>} | 定义子节点展开模式枚举值。 |
283
284
285### 函数
286
287| 名称 | 描述 |
288| -------- | -------- |
289| [ArkUI_DragEvent](#arkui_dragevent) \* [OH_ArkUI_NodeEvent_GetDragEvent](#oh_arkui_nodeevent_getdragevent) ([ArkUI_NodeEvent](#arkui_nodeevent-12) \*nodeEvent) | 从 NodeEvent 中获取DragEvent。  |
290| [ArkUI_PreDragStatus](#arkui_predragstatus) [OH_ArkUI_NodeEvent_GetPreDragStatus](#oh_arkui_nodeevent_getpredragstatus) ([ArkUI_NodeEvent](#arkui_nodeevent-12) \*nodeEvent) | 获取预览拖拽事件状态。  |
291| int32_t [OH_ArkUI_DragEvent_DisableDefaultDropAnimation](#oh_arkui_dragevent_disabledefaultdropanimation) ([ArkUI_DragEvent](#arkui_dragevent) \*event, bool disable) | 设置是否禁用松手时的系统默认动效,默认不禁用,通常在应用需要自定义落位动效时配置。  |
292| int32_t [OH_ArkUI_DragEvent_SetSuggestedDropOperation](#oh_arkui_dragevent_setsuggesteddropoperation) ([ArkUI_DragEvent](#arkui_dragevent) \*event, [ArkUI_DropOperation](#arkui_dropoperation) dropOperation) | 设置数据处理方式  |
293| int32_t [OH_ArkUI_DragEvent_SetDragResult](#oh_arkui_dragevent_setdragresult) ([ArkUI_DragEvent](#arkui_dragevent) \*event, [ArkUI_DragResult](#arkui_dragresult) result) | 设置拖拽事件的结果。  |
294| int32_t [OH_ArkUI_DragEvent_SetData](#oh_arkui_dragevent_setdata) ([ArkUI_DragEvent](#arkui_dragevent) \*event, [OH_UdmfData](#oh_udmfdata) \*data) | 向ArkUI_DragEvent中设置拖拽数据。  |
295| int32_t [OH_ArkUI_DragEvent_GetUdmfData](#oh_arkui_dragevent_getudmfdata) ([ArkUI_DragEvent](#arkui_dragevent) \*event, [OH_UdmfData](#oh_udmfdata) \*data) | 从ArkUI_DragEvent中获取拖拽默认相关数据。  |
296| int32_t [OH_ArkUI_DragEvent_GetDataTypeCount](#oh_arkui_dragevent_getdatatypecount) ([ArkUI_DragEvent](#arkui_dragevent) \*event, int32_t \*count) | 从ArkUI_DragEvent中获取所拖拽的数据类型种类个数。  |
297| int32_t [OH_ArkUI_DragEvent_GetDataTypes](#oh_arkui_dragevent_getdatatypes) ([ArkUI_DragEvent](#arkui_dragevent) \*event, char \*\*result[], int32_t length) | 从ArkUI_DragEvent中获取拖拽数据的类型列表。  |
298| int32_t [OH_ArkUI_DragEvent_GetDragResult](#oh_arkui_dragevent_getdragresult) ([ArkUI_DragEvent](#arkui_dragevent) \*event, [ArkUI_DragResult](#arkui_dragresult) \*result) | 从ArkUI_DragEvent中获取拖拽结果。  |
299| int32_t [OH_ArkUI_DragEvent_GetDropOperation](#oh_arkui_dragevent_getdropoperation) ([ArkUI_DragEvent](#arkui_dragevent) \*event, [ArkUI_DropOperation](#arkui_dropoperation) \*operation) | 从ArkUI_DragEvent中获取数据处理方式。  |
300| float [OH_ArkUI_DragEvent_GetPreviewTouchPointX](#oh_arkui_dragevent_getpreviewtouchpointx) ([ArkUI_DragEvent](#arkui_dragevent) \*event) | 从ArkUI_DragEvent中获取预览图跟手点的x轴坐标。  |
301| float [OH_ArkUI_DragEvent_GetPreviewTouchPointY](#oh_arkui_dragevent_getpreviewtouchpointy) ([ArkUI_DragEvent](#arkui_dragevent) \*event) | 从ArkUI_DragEvent中获取预览图跟手点的y轴坐标。  |
302| float [OH_ArkUI_DragEvent_GetPreviewRectWidth](#oh_arkui_dragevent_getpreviewrectwidth) ([ArkUI_DragEvent](#arkui_dragevent) \*event) | 从ArkUI_DragEvent中获取预览图的宽。  |
303| float [OH_ArkUI_DragEvent_GetPreviewRectHeight](#oh_arkui_dragevent_getpreviewrectheight) ([ArkUI_DragEvent](#arkui_dragevent) \*event) | 从ArkUI_DragEvent中获取预览图的高。  |
304| float [OH_ArkUI_DragEvent_GetTouchPointXToWindow](#oh_arkui_dragevent_gettouchpointxtowindow) ([ArkUI_DragEvent](#arkui_dragevent) \*event) | 从ArkUI_DragEvent中获取跟手点相对于window的x轴坐标。  |
305| float [OH_ArkUI_DragEvent_GetTouchPointYToWindow](#oh_arkui_dragevent_gettouchpointytowindow) ([ArkUI_DragEvent](#arkui_dragevent) \*event) | 从ArkUI_DragEvent中获取跟手点相对于window的y轴坐标。  |
306| float [OH_ArkUI_DragEvent_GetTouchPointXToDisplay](#oh_arkui_dragevent_gettouchpointxtodisplay) ([ArkUI_DragEvent](#arkui_dragevent) \*event) | 从ArkUI_DragEvent中获取跟手点相对于当前Display的x轴坐标。  |
307| float [OH_ArkUI_DragEvent_GetTouchPointYToDisplay](#oh_arkui_dragevent_gettouchpointytodisplay) ([ArkUI_DragEvent](#arkui_dragevent) \*event) | 从ArkUI_DragEvent中获取跟手点相对于当前Display的y轴坐标。  |
308| float [OH_ArkUI_DragEvent_GetVelocityX](#oh_arkui_dragevent_getvelocityx) ([ArkUI_DragEvent](#arkui_dragevent) \*event) | 获取当前拖拽的x轴方向拖动速度。  |
309| float [OH_ArkUI_DragEvent_GetVelocityY](#oh_arkui_dragevent_getvelocityy) ([ArkUI_DragEvent](#arkui_dragevent) \*event) | 获取当前拖拽的y轴方向拖动速度。  |
310| float [OH_ArkUI_DragEvent_GetVelocity](#oh_arkui_dragevent_getvelocity) ([ArkUI_DragEvent](#arkui_dragevent) \*event) | 获取当前拖拽的主方向拖动速度。  |
311| int32_t [OH_ArkUI_DragEvent_GetModifierKeyStates](#oh_arkui_dragevent_getmodifierkeystates) ([ArkUI_DragEvent](#arkui_dragevent) \*event, uint64_t \*keys) | 获取功能键按压状态。  |
312| int32_t [OH_ArkUI_SetDragEventStrictReportWithNode](#oh_arkui_setdrageventstrictreportwithnode) ([ArkUI_NodeHandle](#arkui_nodehandle) node, bool enabled) | 控制是否使能严格dragEvent上报,建议开启;默认是不开启的; 当不开启时,从父组件拖移进子组件时,父组件并不会收到leave的通知;而开启之后,只要前后两个组件发生变化,上一个组件就会收到 leave,新的组件收到enter通知;该配置与具体的UI实例相关,需要通过传入一个当前UI实例上的一个具体的组件节点来关联。  |
313| int32_t [OH_ArkUI_SetDragEventStrictReportWithContext](#oh_arkui_setdrageventstrictreportwithcontext) ([ArkUI_ContextHandle](#arkui_contexthandle-12) uiContext, bool enabled) | 控制是否使能严格dragEvent上报,建议开启;默认是不开启的; 当不开启时,从父组件拖移进子组件时,父组件并不会收到leave的通知;而开启之后,只要前后两个组件发生变化,上一个组件就会收到 leave,新的组件收到enter通知;该配置与具体的UI实例相关,可通过传入一个UI实例进行关联。  |
314| int32_t [OH_ArkUI_SetNodeAllowedDropDataTypes](#oh_arkui_setnodealloweddropdatatypes) ([ArkUI_NodeHandle](#arkui_nodehandle) node, const char \*typesArray[], int32_t count) | 配置组件允许接受落入的数据类型,该接口会重置通过 [OH_ArkUI_DisallowNodeAnyDropDataTypes](#oh_arkui_disallownodeanydropdatatypes) 或 [OH_ArkUI_AllowNodeAllDropDataTypes](#oh_arkui_allownodealldropdatatypes)进行的配置。  |
315| int32_t [OH_ArkUI_DisallowNodeAnyDropDataTypes](#oh_arkui_disallownodeanydropdatatypes) ([ArkUI_NodeHandle](#arkui_nodehandle) node) | 配置组件不允许接受任何数据类型,该接口会重置通过[OH_ArkUI_SetNodeAllowedDropDataTypes](#oh_arkui_setnodealloweddropdatatypes)配置的数据类型。  |
316| int32_t [OH_ArkUI_AllowNodeAllDropDataTypes](#oh_arkui_allownodealldropdatatypes) ([ArkUI_NodeHandle](#arkui_nodehandle) node) | 配置组件允许接受任意数据类型,该接口会重置通过[OH_ArkUI_SetNodeAllowedDropDataTypes](#oh_arkui_setnodealloweddropdatatypes)配置的数据类型。  |
317| int32_t [OH_ArkUI_SetNodeDraggable](#oh_arkui_setnodedraggable) ([ArkUI_NodeHandle](#arkui_nodehandle) node, bool enabled) | 设置该组件是否允许进行拖拽。  |
318| int32_t [OH_ArkUI_SetNodeDragPreview](#oh_arkui_setnodedragpreview) ([ArkUI_NodeHandle](#arkui_nodehandle) node, [OH_PixelmapNative](#oh_pixelmapnative) \*preview) | 设置组件在被拖拽时的自定义跟手图。  |
319| [ArkUI_DragPreviewOption](#arkui_dragpreviewoption) \* [OH_ArkUI_CreateDragPreviewOption](#oh_arkui_createdragpreviewoption) (void) | 构建一个ArkUI_DragPreviewOption对象。  |
320| void [OH_ArkUI_DragPreviewOption_Dispose](#oh_arkui_dragpreviewoption_dispose) ([ArkUI_DragPreviewOption](#arkui_dragpreviewoption) \*option) | 销毁跟手图自定义参数对象实例。  |
321| int32_t [OH_ArkUI_DragPreviewOption_SetScaleMode](#oh_arkui_dragpreviewoption_setscalemode) ([ArkUI_DragPreviewOption](#arkui_dragpreviewoption) \*option, [ArkUI_DragPreviewScaleMode](#arkui_dragpreviewscalemode) scaleMode) | 设置拖拽跟手图是否根据系统定义自动进行缩放。  |
322| int32_t [OH_ArkUI_DragPreviewOption_SetDefaultShadowEnabled](#oh_arkui_dragpreviewoption_setdefaultshadowenabled) ([ArkUI_DragPreviewOption](#arkui_dragpreviewoption) \*option, bool enabled) | 设置跟手图背板默认的投影效果,默认使能。  |
323| int32_t [OH_ArkUI_DragPreviewOption_SetDefaultRadiusEnabled](#oh_arkui_dragpreviewoption_setdefaultradiusenabled) ([ArkUI_DragPreviewOption](#arkui_dragpreviewoption) \*option, bool enabled) | 设置跟手图背板默认的圆角效果,默认使能。  |
324| int32_t [OH_ArkUI_DragPreviewOption_SetNumberBadgeEnabled](#oh_arkui_dragpreviewoption_setnumberbadgeenabled) ([ArkUI_DragPreviewOption](#arkui_dragpreviewoption) \*option, bool enabled) | 设置跟手图背板是否显示角标,默认使能,开启后,系统会根据拖拽数量自动进行角标显示。  |
325| int32_t [OH_ArkUI_DragPreviewOption_SetBadgeNumber](#oh_arkui_dragpreviewoption_setbadgenumber) ([ArkUI_DragPreviewOption](#arkui_dragpreviewoption) \*option, uint32_t forcedNumber) | 强制显示角标的数量,覆盖SetDragPreviewNumberBadgeEnabled设置的值。  |
326| int32_t [OH_ArkUI_DragPreviewOption_SetDefaultAnimationBeforeLiftingEnabled](#oh_arkui_dragpreviewoption_setdefaultanimationbeforeliftingenabled) ([ArkUI_DragPreviewOption](#arkui_dragpreviewoption) \*option, bool enabled) | 配置是否开启点按时的默认动画。  |
327| int32_t [OH_ArkUI_SetNodeDragPreviewOption](#oh_arkui_setnodedragpreviewoption) ([ArkUI_NodeHandle](#arkui_nodehandle) node, [ArkUI_DragPreviewOption](#arkui_dragpreviewoption) \*option) | 将构造的ArkUI_DragPreviewOption设置给组件。  |
328| [ArkUI_DragAction](#arkui_dragaction) \* [OH_ArkUI_CreateDragActionWithNode](#oh_arkui_createdragactionwithnode) ([ArkUI_NodeHandle](#arkui_nodehandle) node) | 创建一个拖拽操作对象,该对象需与一个UI实例相关联,可通过传入一个当前UI实例的某个组件节点来指定。  |
329| [ArkUI_DragAction](#arkui_dragaction) \* [OH_ArkUI_CreateDragActionWithContext](#oh_arkui_createdragactionwithcontext) ([ArkUI_ContextHandle](#arkui_contexthandle-12) uiContext) | 创建一个拖拽操作对象,该对象需与一个UI实例相关联,可通过传入一个UI实例指针来关联。  |
330| void [OH_ArkUI_DragAction_Dispose](#oh_arkui_dragaction_dispose) ([ArkUI_DragAction](#arkui_dragaction) \*dragAction) | 销毁创建的 ArkUI_DragAction 对象。  |
331| int32_t [OH_ArkUI_DragAction_SetPointerId](#oh_arkui_dragaction_setpointerid) ([ArkUI_DragAction](#arkui_dragaction) \*dragAction, int32_t pointer) | 设置手指ID,当屏幕上仅有一只手指在操作时,pointer ID 为 0;一般情况下,配置 0 即可。  |
332| int32_t [OH_ArkUI_DragAction_SetPixelMaps](#oh_arkui_dragaction_setpixelmaps) ([ArkUI_DragAction](#arkui_dragaction) \*dragAction, [OH_PixelmapNative](#oh_pixelmapnative) \*pixelmapArray[], int32_t size) | 设置拖拽跟手图,只能使用 pixelmap 格式对象。  |
333| int32_t [OH_ArkUI_DragAction_SetTouchPointX](#oh_arkui_dragaction_settouchpointx) ([ArkUI_DragAction](#arkui_dragaction) \*dragAction, float x) | 设置跟手点,相对于设置的第一个pixelmap的左上角。  |
334| int32_t [OH_ArkUI_DragAction_SetTouchPointY](#oh_arkui_dragaction_settouchpointy) ([ArkUI_DragAction](#arkui_dragaction) \*dragAction, float y) | 设置跟手点,相对于设置的第一个pixelmap的左上角。  |
335| int32_t [OH_ArkUI_DragAction_SetData](#oh_arkui_dragaction_setdata) ([ArkUI_DragAction](#arkui_dragaction) \*dragAction, [OH_UdmfData](#oh_udmfdata) \*data) | 设置拖拽数据。  |
336| int32_t [OH_ArkUI_DragAction_SetDragPreviewOption](#oh_arkui_dragaction_setdragpreviewoption) ([ArkUI_DragAction](#arkui_dragaction) \*dragAction, [ArkUI_DragPreviewOption](#arkui_dragpreviewoption) \*option) | 将构造的ArkUI_DragPreviewOption设置给ArkUI_DragAction。  |
337| int32_t [OH_ArkUI_DragAction_RegisterStatusListener](#oh_arkui_dragaction_registerstatuslistener) ([ArkUI_DragAction](#arkui_dragaction) \*dragAction, void \*userData, void(\*listener)([ArkUI_DragAndDropInfo](#arkui_draganddropinfo) \*dragAndDropInfo, void \*userData)) | 注册拖拽状态监听回调,该回调可感知到拖拽已经发起或用户松手结束的状态,可通过该监听获取到落入方对数据的接收处理是否成功。  |
338| void [OH_ArkUI_DragAction_UnregisterStatusListener](#oh_arkui_dragaction_unregisterstatuslistener) ([ArkUI_DragAction](#arkui_dragaction) \*dragAction) | 解注册拖拽状态监听回调。  |
339| [ArkUI_DragStatus](#arkui_dragstatus) [OH_ArkUI_DragAndDropInfo_GetDragStatus](#oh_arkui_draganddropinfo_getdragstatus) ([ArkUI_DragAndDropInfo](#arkui_draganddropinfo) \*dragAndDropInfo) | 获取dragaction发起拖拽的状态,获取异常时返回 ArkUI_DRAG_STATUS_UNKNOWN。  |
340| [ArkUI_DragEvent](#arkui_dragevent) \* [OH_ArkUI_DragAndDropInfo_GetDragEvent](#oh_arkui_draganddropinfo_getdragevent) ([ArkUI_DragAndDropInfo](#arkui_draganddropinfo) \*dragAndDropInfo) | 通过dragAndDropInfo获取到DragEvent,可通过DragEvent获取释放结果等。  |
341| int32_t [OH_ArkUI_StartDrag](#oh_arkui_startdrag) ([ArkUI_DragAction](#arkui_dragaction) \*dragAction) | 通过构造的DragAction对象发起拖拽。  |
342| [ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) \* [OH_ArkUI_DrawableDescriptor_CreateFromPixelMap](#oh_arkui_drawabledescriptor_createfrompixelmap) ([OH_PixelmapNativeHandle](#oh_pixelmapnativehandle) pixelMap) | 使用 PixelMap 创建 DrawableDescriptor 对象。  |
343| [ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) \* [OH_ArkUI_DrawableDescriptor_CreateFromAnimatedPixelMap](#oh_arkui_drawabledescriptor_createfromanimatedpixelmap) ([OH_PixelmapNativeHandle](#oh_pixelmapnativehandle) \*array, int32_t size) | 使用 PixelMap 图片数组创建DrawableDescriptor 对象。  |
344| void [OH_ArkUI_DrawableDescriptor_Dispose](#oh_arkui_drawabledescriptor_dispose) ([ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) \*drawableDescriptor) | 销毁 DrawableDescriptor 对象指针。  |
345| [OH_PixelmapNativeHandle](#oh_pixelmapnativehandle) [OH_ArkUI_DrawableDescriptor_GetStaticPixelMap](#oh_arkui_drawabledescriptor_getstaticpixelmap) ([ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) \*drawableDescriptor) | 获取 PixelMap 图片对象指针。  |
346| [OH_PixelmapNativeHandle](#oh_pixelmapnativehandle) \* [OH_ArkUI_DrawableDescriptor_GetAnimatedPixelMapArray](#oh_arkui_drawabledescriptor_getanimatedpixelmaparray) ([ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) \*drawableDescriptor) | 获取用于播放动画的 PixelMap 图片数组数据。  |
347| int32_t [OH_ArkUI_DrawableDescriptor_GetAnimatedPixelMapArraySize](#oh_arkui_drawabledescriptor_getanimatedpixelmaparraysize) ([ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) \*drawableDescriptor) | 获取用于播放动画的 PixelMap 图片数组数据。  |
348| void [OH_ArkUI_DrawableDescriptor_SetAnimationDuration](#oh_arkui_drawabledescriptor_setanimationduration) ([ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) \*drawableDescriptor, int32_t duration) | 设置 PixelMap 图片数组播放总时长。  |
349| int32_t [OH_ArkUI_DrawableDescriptor_GetAnimationDuration](#oh_arkui_drawabledescriptor_getanimationduration) ([ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) \*drawableDescriptor) | 获取 PixelMap 图片数组播放总时长。  |
350| void [OH_ArkUI_DrawableDescriptor_SetAnimationIteration](#oh_arkui_drawabledescriptor_setanimationiteration) ([ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) \*drawableDescriptor, int32_t iteration) | 设置 PixelMap 图片数组播放次数。  |
351| int32_t [OH_ArkUI_DrawableDescriptor_GetAnimationIteration](#oh_arkui_drawabledescriptor_getanimationiteration) ([ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) \*drawableDescriptor) | 获取 PixelMap 图片数组播放次数。  |
352| [ArkUI_AnimateOption](#arkui_animateoption) \* [OH_ArkUI_AnimateOption_Create](#oh_arkui_animateoption_create) () | 创建动画效果参数。  |
353| void [OH_ArkUI_AnimateOption_Dispose](#oh_arkui_animateoption_dispose) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | 销毁动画效果参数指针。  |
354| int32_t [OH_ArkUI_AnimateOption_GetDuration](#oh_arkui_animateoption_getduration) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | 获取动画持续时间,单位为ms(毫秒)。  |
355| float [OH_ArkUI_AnimateOption_GetTempo](#oh_arkui_animateoption_gettempo) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | 获取动画播放速度。  |
356| [ArkUI_AnimationCurve](#arkui_animationcurve) [OH_ArkUI_AnimateOption_GetCurve](#oh_arkui_animateoption_getcurve) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | 获取动画曲线。  |
357| int32_t [OH_ArkUI_AnimateOption_GetDelay](#oh_arkui_animateoption_getdelay) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | 获取动画延迟播放时间,单位为ms(毫秒)。  |
358| int32_t [OH_ArkUI_AnimateOption_GetIterations](#oh_arkui_animateoption_getiterations) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | 获取动画播放次数。  |
359| [ArkUI_AnimationPlayMode](#arkui_animationplaymode) [OH_ArkUI_AnimateOption_GetPlayMode](#oh_arkui_animateoption_getplaymode) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | 获取动画播放模式。  |
360| [ArkUI_ExpectedFrameRateRange](_ark_u_i___expected_frame_rate_range.md) \* [OH_ArkUI_AnimateOption_GetExpectedFrameRateRange](#oh_arkui_animateoption_getexpectedframeraterange) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | 获取动画的期望帧率。  |
361| void [OH_ArkUI_AnimateOption_SetDuration](#oh_arkui_animateoption_setduration) ([ArkUI_AnimateOption](#arkui_animateoption) \*option, int32_t value) | 设置动画持续时间。  |
362| void [OH_ArkUI_AnimateOption_SetTempo](#oh_arkui_animateoption_settempo) ([ArkUI_AnimateOption](#arkui_animateoption) \*option, float value) | 设置动画播放速度。  |
363| void [OH_ArkUI_AnimateOption_SetCurve](#oh_arkui_animateoption_setcurve) ([ArkUI_AnimateOption](#arkui_animateoption) \*option, [ArkUI_AnimationCurve](#arkui_animationcurve) value) | 设置动画曲线。  |
364| void [OH_ArkUI_AnimateOption_SetDelay](#oh_arkui_animateoption_setdelay) ([ArkUI_AnimateOption](#arkui_animateoption) \*option, int32_t value) | 设置动画延迟播放时间。  |
365| void [OH_ArkUI_AnimateOption_SetIterations](#oh_arkui_animateoption_setiterations) ([ArkUI_AnimateOption](#arkui_animateoption) \*option, int32_t value) | 设置动画播放次数。  |
366| void [OH_ArkUI_AnimateOption_SetPlayMode](#oh_arkui_animateoption_setplaymode) ([ArkUI_AnimateOption](#arkui_animateoption) \*option, [ArkUI_AnimationPlayMode](#arkui_animationplaymode) value) | 设置动画播放模式。  |
367| void [OH_ArkUI_AnimateOption_SetExpectedFrameRateRange](#oh_arkui_animateoption_setexpectedframeraterange) ([ArkUI_AnimateOption](#arkui_animateoption) \*option, [ArkUI_ExpectedFrameRateRange](_ark_u_i___expected_frame_rate_range.md) \*value) | 设置动画的期望帧率。  |
368| void [OH_ArkUI_AnimateOption_SetICurve](#oh_arkui_animateoption_seticurve) ([ArkUI_AnimateOption](#arkui_animateoption) \*option, [ArkUI_CurveHandle](#arkui_curvehandle) value) | 设置动画的动画曲线。  |
369| [ArkUI_CurveHandle](#arkui_curvehandle) [OH_ArkUI_AnimateOption_GetICurve](#oh_arkui_animateoption_geticurve) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | 获取动画的动画曲线。  |
370| [ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) \* [OH_ArkUI_KeyframeAnimateOption_Create](#oh_arkui_keyframeanimateoption_create) (int32_t size) | 获取关键帧动画参数。  |
371| void [OH_ArkUI_KeyframeAnimateOption_Dispose](#oh_arkui_keyframeanimateoption_dispose) ([ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) \*option) | 销毁关键帧动画参数。  |
372| int32_t [OH_ArkUI_KeyframeAnimateOption_SetDelay](#oh_arkui_keyframeanimateoption_setdelay) ([ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) \*option, int32_t value) | 设置关键帧动画的整体延时时间,单位为ms(毫秒),默认不延时播放。  |
373| int32_t [OH_ArkUI_KeyframeAnimateOption_SetIterations](#oh_arkui_keyframeanimateoption_setiterations) ([ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) \*option, int32_t value) | 设置关键帧动画的动画播放次数。默认播放一次,设置为-1时表示无限次播放。设置为0时表示无动画效果。  |
374| int32_t [OH_ArkUI_KeyframeAnimateOption_RegisterOnFinishCallback](#oh_arkui_keyframeanimateoption_registeronfinishcallback) ([ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) \*option, void \*userData, void(\*onFinish)(void \*userData)) | 设置关键帧动画播放完成回调。当keyframe动画所有次数播放完成后调用。  |
375| int32_t [OH_ArkUI_KeyframeAnimateOption_SetDuration](#oh_arkui_keyframeanimateoption_setduration) ([ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) \*option, int32_t value, int32_t index) | 设置关键帧动画某段关键帧动画的持续时间,单位为毫秒。  |
376| int32_t [OH_ArkUI_KeyframeAnimateOption_SetCurve](#oh_arkui_keyframeanimateoption_setcurve) ([ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) \*option, [ArkUI_CurveHandle](#arkui_curvehandle) value, int32_t index) | 设置关键帧动画某段关键帧使用的动画曲线。  |
377| int32_t [OH_ArkUI_KeyframeAnimateOption_RegisterOnEventCallback](#oh_arkui_keyframeanimateoption_registeroneventcallback) ([ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) \*option, void \*userData, void(\*event)(void \*userData), int32_t index) | 设置关键帧时刻状态的闭包函数,即在该关键帧时刻要达到的状态。  |
378| int32_t [OH_ArkUI_KeyframeAnimateOption_GetDelay](#oh_arkui_keyframeanimateoption_getdelay) ([ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) \*option) | 获取关键帧整体延时时间。  |
379| int32_t [OH_ArkUI_KeyframeAnimateOption_GetIterations](#oh_arkui_keyframeanimateoption_getiterations) ([ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) \*option) | 获取关键帧动画播放次数。  |
380| int32_t [OH_ArkUI_KeyframeAnimateOption_GetDuration](#oh_arkui_keyframeanimateoption_getduration) ([ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) \*option, int32_t index) | 获取关键帧动画某段状态持续时间。  |
381| [ArkUI_CurveHandle](#arkui_curvehandle) [OH_ArkUI_KeyframeAnimateOption_GetCurve](#oh_arkui_keyframeanimateoption_getcurve) ([ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) \*option, int32_t index) | 获取关键帧动画某段状态动画曲线。  |
382| [ArkUI_AnimatorOption](#arkui_animatoroption) \* [OH_ArkUI_AnimatorOption_Create](#oh_arkui_animatoroption_create) (int32_t keyframeSize) | 创建animator动画对象参数。  |
383| void [OH_ArkUI_AnimatorOption_Dispose](#oh_arkui_animatoroption_dispose) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | 销毁animator动画对象参数。  |
384| int32_t [OH_ArkUI_AnimatorOption_SetDuration](#oh_arkui_animatoroption_setduration) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, int32_t value) | 设置animator动画播放的时长,单位毫秒。  |
385| int32_t [OH_ArkUI_AnimatorOption_SetDelay](#oh_arkui_animatoroption_setdelay) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, int32_t value) | 设置animator动画延时播放时长,单位毫秒。  |
386| int32_t [OH_ArkUI_AnimatorOption_SetIterations](#oh_arkui_animatoroption_setiterations) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, int32_t value) | 设置animator动画播放次数。设置为0时不播放,设置为-1时无限次播放。  |
387| int32_t [OH_ArkUI_AnimatorOption_SetFill](#oh_arkui_animatoroption_setfill) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, [ArkUI_AnimationFillMode](#arkui_animationfillmode) value) | 设置animator动画执行后是否恢复到初始状态。  |
388| int32_t [OH_ArkUI_AnimatorOption_SetDirection](#oh_arkui_animatoroption_setdirection) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, [ArkUI_AnimationDirection](#arkui_animationdirection) value) | 设置animator动画播放方向。  |
389| int32_t [OH_ArkUI_AnimatorOption_SetCurve](#oh_arkui_animatoroption_setcurve) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, [ArkUI_CurveHandle](#arkui_curvehandle) value) | 设置animator动画插值曲线。  |
390| int32_t [OH_ArkUI_AnimatorOption_SetBegin](#oh_arkui_animatoroption_setbegin) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, float value) | 设置animator动画插值起点。  |
391| int32_t [OH_ArkUI_AnimatorOption_SetEnd](#oh_arkui_animatoroption_setend) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, float value) | 设置animator动画插值终点。  |
392| int32_t [OH_ArkUI_AnimatorOption_SetExpectedFrameRateRange](#oh_arkui_animatoroption_setexpectedframeraterange) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, [ArkUI_ExpectedFrameRateRange](_ark_u_i___expected_frame_rate_range.md) \*value) | 设置animator动画期望的帧率范围。  |
393| int32_t [OH_ArkUI_AnimatorOption_SetKeyframe](#oh_arkui_animatoroption_setkeyframe) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, float time, float value, int32_t index) | 设置animator动画关键帧参数。  |
394| int32_t [OH_ArkUI_AnimatorOption_SetKeyframeCurve](#oh_arkui_animatoroption_setkeyframecurve) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, [ArkUI_CurveHandle](#arkui_curvehandle) value, int32_t index) | 设置animator动画关键帧曲线类型。  |
395| int32_t [OH_ArkUI_AnimatorOption_GetDuration](#oh_arkui_animatoroption_getduration) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | 获取animator动画播放的时长。  |
396| int32_t [OH_ArkUI_AnimatorOption_GetDelay](#oh_arkui_animatoroption_getdelay) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | 获取animator动画延时播放时长。  |
397| int32_t [OH_ArkUI_AnimatorOption_GetIterations](#oh_arkui_animatoroption_getiterations) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | 获取animator动画播放次数。  |
398| [ArkUI_AnimationDirection](#arkui_animationdirection) [OH_ArkUI_AnimatorOption_GetDirection](#oh_arkui_animatoroption_getdirection) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | 获取animator动画播放方向。  |
399| [ArkUI_CurveHandle](#arkui_curvehandle) [OH_ArkUI_AnimatorOption_GetCurve](#oh_arkui_animatoroption_getcurve) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | 获取animator动画插值曲线。  |
400| float [OH_ArkUI_AnimatorOption_GetBegin](#oh_arkui_animatoroption_getbegin) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | 获取animator动画插值起点。  |
401| float [OH_ArkUI_AnimatorOption_GetEnd](#oh_arkui_animatoroption_getend) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | 获取animator动画插值终点。  |
402| [ArkUI_ExpectedFrameRateRange](_ark_u_i___expected_frame_rate_range.md) \* [OH_ArkUI_AnimatorOption_GetExpectedFrameRateRange](#oh_arkui_animatoroption_getexpectedframeraterange) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | 获取animator动画期望的帧率范围。  |
403| float [OH_ArkUI_AnimatorOption_GetKeyframeTime](#oh_arkui_animatoroption_getkeyframetime) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, int32_t index) | 获取animator动画关键帧时间。  |
404| float [OH_ArkUI_AnimatorOption_GetKeyframeValue](#oh_arkui_animatoroption_getkeyframevalue) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, int32_t index) | 获取animator动画关键帧数值。  |
405| [ArkUI_CurveHandle](#arkui_curvehandle) [OH_ArkUI_AnimatorOption_GetKeyframeCurve](#oh_arkui_animatoroption_getkeyframecurve) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, int32_t index) | 获取animator动画关键帧动画插值曲线。  |
406| void \* [OH_ArkUI_AnimatorEvent_GetUserData](#oh_arkui_animatorevent_getuserdata) (ArkUI_AnimatorEvent \*event) | 获取动画事件对象中的用户自定义对象。  |
407| void \* [OH_ArkUI_AnimatorOnFrameEvent_GetUserData](#oh_arkui_animatoronframeevent_getuserdata) (ArkUI_AnimatorOnFrameEvent \*event) | 获取动画事件对象中的用户自定义对象。  |
408| float [OH_ArkUI_AnimatorOnFrameEvent_GetValue](#oh_arkui_animatoronframeevent_getvalue) (ArkUI_AnimatorOnFrameEvent \*event) | 获取动画事件对象中的当前进度。  |
409| int32_t [OH_ArkUI_AnimatorOption_RegisterOnFrameCallback](#oh_arkui_animatoroption_registeronframecallback) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, void \*userData, void(\*callback)(ArkUI_AnimatorOnFrameEvent \*event)) | 设置animator动画接收到帧时回调。  |
410| int32_t [OH_ArkUI_AnimatorOption_RegisterOnFinishCallback](#oh_arkui_animatoroption_registeronfinishcallback) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, void \*userData, void(\*callback)(ArkUI_AnimatorEvent \*event)) | 设置animator动画完成时回调。  |
411| int32_t [OH_ArkUI_AnimatorOption_RegisterOnCancelCallback](#oh_arkui_animatoroption_registeroncancelcallback) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, void \*userData, void(\*callback)(ArkUI_AnimatorEvent \*event)) | 设置animator动画被取消时回调。  |
412| int32_t [OH_ArkUI_AnimatorOption_RegisterOnRepeatCallback](#oh_arkui_animatoroption_registeronrepeatcallback) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, void \*userData, void(\*callback)(ArkUI_AnimatorEvent \*event)) | 设置animator动画重复时回调。  |
413| int32_t [OH_ArkUI_Animator_ResetAnimatorOption](#oh_arkui_animator_resetanimatoroption) ([ArkUI_AnimatorHandle](#arkui_animatorhandle) animator, [ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | 更新animator动画。  |
414| int32_t [OH_ArkUI_Animator_Play](#oh_arkui_animator_play) ([ArkUI_AnimatorHandle](#arkui_animatorhandle) animator) | 启动animator动画。  |
415| int32_t [OH_ArkUI_Animator_Finish](#oh_arkui_animator_finish) ([ArkUI_AnimatorHandle](#arkui_animatorhandle) animator) | 结束animator动画。  |
416| int32_t [OH_ArkUI_Animator_Pause](#oh_arkui_animator_pause) ([ArkUI_AnimatorHandle](#arkui_animatorhandle) animator) | 暂停animator动画。  |
417| int32_t [OH_ArkUI_Animator_Cancel](#oh_arkui_animator_cancel) ([ArkUI_AnimatorHandle](#arkui_animatorhandle) animator) | 取消animator动画。  |
418| int32_t [OH_ArkUI_Animator_Reverse](#oh_arkui_animator_reverse) ([ArkUI_AnimatorHandle](#arkui_animatorhandle) animator) | 以相反的顺序播放animator动画。  |
419| [ArkUI_CurveHandle](#arkui_curvehandle) [OH_ArkUI_Curve_CreateCurveByType](#oh_arkui_curve_createcurvebytype) ([ArkUI_AnimationCurve](#arkui_animationcurve) curve) | 插值曲线的初始化函数,可以根据入参创建一个插值曲线对象。  |
420| [ArkUI_CurveHandle](#arkui_curvehandle) [OH_ArkUI_Curve_CreateStepsCurve](#oh_arkui_curve_createstepscurve) (int32_t count, bool end) | 构造阶梯曲线对象。  |
421| [ArkUI_CurveHandle](#arkui_curvehandle) [OH_ArkUI_Curve_CreateCubicBezierCurve](#oh_arkui_curve_createcubicbeziercurve) (float x1, float y1, float x2, float y2) | 构造三阶贝塞尔曲线对象。  |
422| [ArkUI_CurveHandle](#arkui_curvehandle) [OH_ArkUI_Curve_CreateSpringCurve](#oh_arkui_curve_createspringcurve) (float velocity, float mass, float stiffness, float damping) | 构造弹簧曲线对象,曲线形状由弹簧参数决定,动画时长受animation、animateTo中的duration参数控制。  |
423| [ArkUI_CurveHandle](#arkui_curvehandle) [OH_ArkUI_Curve_CreateSpringMotion](#oh_arkui_curve_createspringmotion) (float response, float dampingFraction, float overlapDuration) | 构造弹性动画曲线对象。如果对同一对象的同一属性进行多个弹性动画,每个动画会替换掉前一个动画,并继承之前的速度。  |
424| [ArkUI_CurveHandle](#arkui_curvehandle) [OH_ArkUI_Curve_CreateResponsiveSpringMotion](#oh_arkui_curve_createresponsivespringmotion) (float response, float dampingFraction, float overlapDuration) | 构造弹性跟手动画曲线对象,是springMotion的一种特例,仅默认参数不同,可与springMotion混合使用。  |
425| [ArkUI_CurveHandle](#arkui_curvehandle) [OH_ArkUI_Curve_CreateInterpolatingSpring](#oh_arkui_curve_createinterpolatingspring) (float velocity, float mass, float stiffness, float damping) | 构造插值器弹簧曲线对象,生成一条从0到1的动画曲线,实际动画值根据曲线进行插值计算。  |
426| [ArkUI_CurveHandle](#arkui_curvehandle) [OH_ArkUI_Curve_CreateCustomCurve](#oh_arkui_curve_createcustomcurve) (void \*userData, float(\*interpolate)(float fraction, void \*userdata)) | 构造自定义曲线对象。  |
427| void [OH_ArkUI_Curve_DisposeCurve](#oh_arkui_curve_disposecurve) ([ArkUI_CurveHandle](#arkui_curvehandle) curveHandle) | 销毁自定义曲线对象。  |
428| [ArkUI_TransitionEffect](#arkui_transitioneffect) \* [OH_ArkUI_CreateOpacityTransitionEffect](#oh_arkui_createopacitytransitioneffect) (float opacity) | 创建组件转场时的透明度效果对象。  |
429| [ArkUI_TransitionEffect](#arkui_transitioneffect) \* [OH_ArkUI_CreateTranslationTransitionEffect](#oh_arkui_createtranslationtransitioneffect) ([ArkUI_TranslationOptions](_ark_u_i___translation_options.md) \*translate) | 创建组件转场时的平移效果对象。  |
430| [ArkUI_TransitionEffect](#arkui_transitioneffect) \* [OH_ArkUI_CreateScaleTransitionEffect](#oh_arkui_createscaletransitioneffect) ([ArkUI_ScaleOptions](_ark_u_i___scale_options.md) \*scale) | 创建组件转场时的缩放效果对象。  |
431| [ArkUI_TransitionEffect](#arkui_transitioneffect) \* [OH_ArkUI_CreateRotationTransitionEffect](#oh_arkui_createrotationtransitioneffect) ([ArkUI_RotationOptions](_ark_u_i___rotation_options.md) \*rotate) | 创建组件转场时的旋转效果对象。  |
432| [ArkUI_TransitionEffect](#arkui_transitioneffect) \* [OH_ArkUI_CreateMovementTransitionEffect](#oh_arkui_createmovementtransitioneffect) ([ArkUI_TransitionEdge](#arkui_transitionedge) move) | 创建组件平移效果对象。  |
433| [ArkUI_TransitionEffect](#arkui_transitioneffect) \* [OH_ArkUI_CreateAsymmetricTransitionEffect](#oh_arkui_createasymmetrictransitioneffect) ([ArkUI_TransitionEffect](#arkui_transitioneffect) \*appear, [ArkUI_TransitionEffect](#arkui_transitioneffect) \*disappear) | 创建非对称的转场效果对象。  |
434| void [OH_ArkUI_TransitionEffect_Dispose](#oh_arkui_transitioneffect_dispose) ([ArkUI_TransitionEffect](#arkui_transitioneffect) \*option) | 销毁转场效果对象。  |
435| int32_t [OH_ArkUI_TransitionEffect_Combine](#oh_arkui_transitioneffect_combine) ([ArkUI_TransitionEffect](#arkui_transitioneffect) \*option, [ArkUI_TransitionEffect](#arkui_transitioneffect) \*combine) | 设置转场效果链式组合,以形成包含多种转场效果的TransitionEffect。  |
436| int32_t [OH_ArkUI_TransitionEffect_SetAnimation](#oh_arkui_transitioneffect_setanimation) ([ArkUI_TransitionEffect](#arkui_transitioneffect) \*option, [ArkUI_AnimateOption](#arkui_animateoption) \*animation) | 设置转场效果动画参数。  |
437| void [OH_ArkUI_DialogDismissEvent_SetShouldBlockDismiss](#oh_arkui_dialogdismissevent_setshouldblockdismiss) ([ArkUI_DialogDismissEvent](#arkui_dialogdismissevent) \*event, bool shouldBlockDismiss) | 设置是否需要屏蔽系统关闭弹窗行为,true表示屏蔽系统行为不关闭弹窗,false表示不屏蔽。  |
438| void \* [OH_ArkUI_DialogDismissEvent_GetUserData](#oh_arkui_dialogdismissevent_getuserdata) ([ArkUI_DialogDismissEvent](#arkui_dialogdismissevent) \*event) | 获取弹窗关闭事件对象中的用户自定义数据指针。  |
439| int32_t [OH_ArkUI_DialogDismissEvent_GetDismissReason](#oh_arkui_dialogdismissevent_getdismissreason) ([ArkUI_DialogDismissEvent](#arkui_dialogdismissevent) \*event) | 获取交互式关闭事件指针中的关闭原因。  |
440| bool [OH_ArkUI_GestureInterruptInfo_GetSystemFlag](#oh_arkui_gestureinterruptinfo_getsystemflag) (const ArkUI_GestureInterruptInfo \*event) | 判断是否组件内置手势。  |
441| ArkUI_GestureRecognizer \* [OH_ArkUI_GestureInterruptInfo_GetRecognizer](#oh_arkui_gestureinterruptinfo_getrecognizer) (const ArkUI_GestureInterruptInfo \*event) | 返回被打断的手势指针。  |
442| ArkUI_GestureEvent \* [OH_ArkUI_GestureInterruptInfo_GetGestureEvent](#oh_arkui_gestureinterruptinfo_getgestureevent) (const ArkUI_GestureInterruptInfo \*event) | 返回打断的手势事件数据。  |
443| int32_t [OH_ArkUI_GestureInterruptInfo_GetSystemRecognizerType](#oh_arkui_gestureinterruptinfo_getsystemrecognizertype) (const ArkUI_GestureInterruptInfo \*event) | 当要触发的是系统内部手势时,使用该方法可返回该系统内部手势的类型。  |
444| int32_t [OH_ArkUI_GestureInterruptInfo_GetTouchRecognizers](#oh_arkui_gestureinterruptinfo_gettouchrecognizers) (const ArkUI_GestureInterruptInfo \*info, ArkUI_TouchRecognizerHandleArray\* recognizers, int32_t\* size) | 使用该方法可返回与该手势相关的所有触摸识别器。  |
445| int32_t [OH_ArkUI_TouchRecognizer_GetNodeHandle](#oh_arkui_touchrecognizer_getnodehandle) (const ArkUI_TouchRecognizerHandle recognizer) | 使用该方法可返回与触摸识别器绑定的组件句柄。  |
446| int32_t [OH_ArkUI_TouchRecognizer_CancelTouch](#oh_arkui_touchrecognizer_canceltouch) (ArkUI_TouchRecognizerHandle recognizer, ArkUI_GestureInterruptInfo\* info) | 使用该方法向对应触摸识别器分发Cancel事件拦截后续触摸事件。  |
447| [ArkUI_GestureEventActionType](#arkui_gestureeventactiontype) [OH_ArkUI_GestureEvent_GetActionType](#oh_arkui_gestureevent_getactiontype) (const ArkUI_GestureEvent \*event) | 返回手势事件类型。  |
448| const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \* [OH_ArkUI_GestureEvent_GetRawInputEvent](#oh_arkui_gestureevent_getrawinputevent) (const ArkUI_GestureEvent \*event) | 返回手势输入。  |
449| int32_t [OH_ArkUI_LongPress_GetRepeatCount](#oh_arkui_longpress_getrepeatcount) (const ArkUI_GestureEvent \*event) | 返回长按手势定时触发次数。  |
450| float [OH_ArkUI_PanGesture_GetVelocity](#oh_arkui_pangesture_getvelocity) (const ArkUI_GestureEvent \*event) | 滑动手势返回手势主方向速度。  |
451| float [OH_ArkUI_PanGesture_GetVelocityX](#oh_arkui_pangesture_getvelocityx) (const ArkUI_GestureEvent \*event) | 滑动手势返回当前手势的x轴方向速度。  |
452| float [OH_ArkUI_PanGesture_GetVelocityY](#oh_arkui_pangesture_getvelocityy) (const ArkUI_GestureEvent \*event) | 滑动手势返回当前手势的y轴方向速度。  |
453| float [OH_ArkUI_PanGesture_GetOffsetX](#oh_arkui_pangesture_getoffsetx) (const ArkUI_GestureEvent \*event) | 滑动手势返回当前手势事件x轴相对偏移量。  |
454| float [OH_ArkUI_PanGesture_GetOffsetY](#oh_arkui_pangesture_getoffsety) (const ArkUI_GestureEvent \*event) | 滑动手势返回当前手势事件y轴相对偏移量。  |
455| float [OH_ArkUI_SwipeGesture_GetAngle](#oh_arkui_swipegesture_getangle) (const ArkUI_GestureEvent \*event) | 滑动手势返回当前手势事件角度信息。  |
456| float [OH_ArkUI_SwipeGesture_GetVelocity](#oh_arkui_swipegesture_getvelocity) (const ArkUI_GestureEvent \*event) | 滑动手势场景中所有手指滑动平均速度。  |
457| float [OH_ArkUI_RotationGesture_GetAngle](#oh_arkui_rotationgesture_getangle) (const ArkUI_GestureEvent \*event) | 旋转手势返回当前手势事件角度信息。  |
458| float [OH_ArkUI_PinchGesture_GetScale](#oh_arkui_pinchgesture_getscale) (const ArkUI_GestureEvent \*event) | 捏合手势返回当前手势事件缩放信息。  |
459| float [OH_ArkUI_PinchGesture_GetCenterX](#oh_arkui_pinchgesture_getcenterx) (const ArkUI_GestureEvent \*event) | 捏合手势中心点相对于当前组件元素左上角x轴坐标。  |
460| float [OH_ArkUI_PinchGesture_GetCenterY](#oh_arkui_pinchgesture_getcentery) (const ArkUI_GestureEvent \*event) | 捏合手势中心点相对于当前组件元素左上角y轴坐标。  |
461| [ArkUI_NodeHandle](#arkui_nodehandle) [OH_ArkUI_GestureEvent_GetNode](#oh_arkui_gestureevent_getnode) (const ArkUI_GestureEvent \*event) | 获取被绑定手势的ARKUI组件。  |
462| int32_t [OH_ArkUI_GetResponseRecognizersFromInterruptInfo](#oh_arkui_getresponserecognizersfrominterruptinfo) (const ArkUI_GestureInterruptInfo \*event, [ArkUI_GestureRecognizerHandleArray](#arkui_gesturerecognizerhandlearray) \*responseChain, int32_t \*count) | 获取手势响应链的信息。  |
463| int32_t [OH_ArkUI_SetGestureRecognizerEnabled](#oh_arkui_setgesturerecognizerenabled) (ArkUI_GestureRecognizer \*recognizer, bool enabled) | 设置手势识别器的使能状态。  |
464| int32_t(\* [OH_ArkUI_SetGestureRecognizerLimitFingerCount](#oh_arkui_setgesturerecognizerlimitfingercount) )(ArkUI_GestureRecognizer \*recognizer, bool limitFingerCount) | 设置是否检查触摸屏幕的手指数量。  |
465| bool [OH_ArkUI_GetGestureRecognizerEnabled](#oh_arkui_getgesturerecognizerenabled) (ArkUI_GestureRecognizer \*recognizer) | 获取手势识别器的使能状态。  |
466| int32_t [OH_ArkUI_GetGestureRecognizerState](#oh_arkui_getgesturerecognizerstate) (ArkUI_GestureRecognizer \*recognizer, [ArkUI_GestureRecognizerState](#arkui_gesturerecognizerstate) \*state) | 获取手势识别器的状态。  |
467| int32_t [OH_ArkUI_GetGestureEventTargetInfo](#oh_arkui_getgestureeventtargetinfo) (ArkUI_GestureRecognizer \*recognizer, [ArkUI_GestureEventTargetInfo](#arkui_gestureeventtargetinfo) \*\*info) | 获取手势事件目标信息。  |
468| int32_t [OH_ArkUI_GestureEventTargetInfo_IsScrollBegin](#oh_arkui_gestureeventtargetinfo_isscrollbegin) ([ArkUI_GestureEventTargetInfo](#arkui_gestureeventtargetinfo) \*info, bool \*ret) | 当前滚动类容器组件是否在顶部。  |
469| int32_t [OH_ArkUI_GestureEventTargetInfo_IsScrollEnd](#oh_arkui_gestureeventtargetinfo_isscrollend) ([ArkUI_GestureEventTargetInfo](#arkui_gestureeventtargetinfo) \*info, bool \*ret) | 当前滚动类容器组件是否在底部。  |
470| int32_t [OH_ArkUI_GetPanGestureDirectionMask](#oh_arkui_getpangesturedirectionmask) (ArkUI_GestureRecognizer \*recognizer, [ArkUI_GestureDirectionMask](#arkui_gesturedirectionmask) \*directionMask) | 获取滑动手势的滑动方向。  |
471| bool [OH_ArkUI_IsBuiltInGesture](#oh_arkui_isbuiltingesture) (ArkUI_GestureRecognizer \*recognizer) | 当前手势是否为系统内置手势。  |
472| int32_t [OH_ArkUI_GetGestureTag](#oh_arkui_getgesturetag) (ArkUI_GestureRecognizer \*recognizer, char \*buffer, int32_t bufferSize, int32_t \*result) | 获取手势识别器的标记。  |
473| int32_t [OH_ArkUI_GetGestureBindNodeId](#oh_arkui_getgesturebindnodeid) (ArkUI_GestureRecognizer \*recognizer, char \*nodeId, int32_t size, int32_t \*result) | 获取手势识别器绑定的组件的ID。  |
474| bool [OH_ArkUI_IsGestureRecognizerValid](#oh_arkui_isgesturerecognizervalid) (ArkUI_GestureRecognizer \*recognizer) | 当前手势识别器是否有效。  |
475| void \* [OH_ArkUI_ParallelInnerGestureEvent_GetUserData](#oh_arkui_parallelinnergestureevent_getuserdata) ([ArkUI_ParallelInnerGestureEvent](#arkui_parallelinnergestureevent) \*event) | 获取并行内部手势事件中的用户自定义数据。  |
476| void* [OH_ArkUI_GestureInterrupter_GetUserData](#oh_arkui_gestureinterrupter_getuserdata) ([ArkUI_GestureInterruptInfo](#arkui_gestureinterruptinfo)* event) | 获取手势中断事件中的用户自定义数据。 |
477| ArkUI_GestureRecognizer \* [OH_ArkUI_ParallelInnerGestureEvent_GetCurrentRecognizer](#oh_arkui_parallelinnergestureevent_getcurrentrecognizer) ([ArkUI_ParallelInnerGestureEvent](#arkui_parallelinnergestureevent) \*event) | 获取并行内部手势事件中的当前手势识别器。  |
478| int32_t [OH_ArkUI_ParallelInnerGestureEvent_GetConflictRecognizers](#oh_arkui_parallelinnergestureevent_getconflictrecognizers) ([ArkUI_ParallelInnerGestureEvent](#arkui_parallelinnergestureevent) \*event, [ArkUI_GestureRecognizerHandleArray](#arkui_gesturerecognizerhandlearray) \*array, int32_t \*size) | 获取并行内部手势事件中的冲突的手势识别器。  |
479| int32_t [OH_ArkUI_SetArkUIGestureRecognizerDisposeNotify](#oh_arkui_setarkuigesturerecognizerdisposenotify) (ArkUI_GestureRecognizer \*recognizer, [ArkUI_GestureRecognizerDisposeNotifyCallback](#arkui_gesturerecognizerdisposenotifycallback) callback, void \*userData) | 设置手势识别器对象析构通知回调函数。  |
480| void \* [OH_ArkUI_QueryModuleInterfaceByName](#oh_arkui_querymoduleinterfacebyname) ([ArkUI_NativeAPIVariantKind](#arkui_nativeapivariantkind) type, const char \*structName) | 获取指定类型的Native模块接口集合。  |
481| [ArkUI_KeyEventType](#arkui_keyeventtype) [OH_ArkUI_KeyEvent_GetType](#oh_arkui_keyevent_gettype) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | 获取按键的类型。  |
482| int32_t [OH_ArkUI_KeyEvent_GetKeyCode](#oh_arkui_keyevent_getkeycode) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | 获取按键的键码。  |
483| const char \* [OH_ArkUI_KeyEvent_GetKeyText](#oh_arkui_keyevent_getkeytext) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | 获取按键的键值。  |
484| [ArkUI_KeySourceType](#arkui_keysourcetype) [OH_ArkUI_KeyEvent_GetKeySource](#oh_arkui_keyevent_getkeysource) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | 获取当前按键的输入设备类型。  |
485| void [OH_ArkUI_KeyEvent_StopPropagation](#oh_arkui_keyevent_stoppropagation) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, bool stopPropagation) | 阻塞事件冒泡传递。  |
486| void [OH_ArkUI_KeyEvent_Dispatch](#oh_arkui_keyevent_dispatch) ([ArkUI_NodeHandle](#arkui_nodehandle) \*node, const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | 将按键事件分发到特定组件节点。  |
487| [ArkUI_KeyIntension](#arkui_keyintension) [OH_ArkUI_KeyEvent_GetKeyIntensionCode](#oh_arkui_keyevent_getkeyintensioncode) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | 获取按键对应的意图。  |
488| uint32_t [OH_ArkUI_KeyEvent_GetUnicode](#oh_arkui_keyevent_getunicode) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | 获取按键的unicode码值。支持范围为非空格的基本拉丁字符:0x0021-0x007E,不支持字符为0。组合键场景下,返回当前keyEvent对应按键的unicode码值。  |
489| void [OH_ArkUI_KeyEvent_SetConsumed](#oh_arkui_keyevent_setconsumed) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, bool isConsumed) | 在按键事件回调中,设置事件是否被该回调消费  |
490| [ArkUI_NodeEventType](#arkui_nodeeventtype) [OH_ArkUI_NodeEvent_GetEventType](#oh_arkui_nodeevent_geteventtype) ([ArkUI_NodeEvent](#arkui_nodeevent-12) \*event) | 获取组件事件类型。  |
491| int32_t [OH_ArkUI_NodeEvent_GetTargetId](#oh_arkui_nodeevent_gettargetid) ([ArkUI_NodeEvent](#arkui_nodeevent-12) \*event) | 获取事件自定义标识ID。  |
492| [ArkUI_NodeHandle](#arkui_nodehandle) [OH_ArkUI_NodeEvent_GetNodeHandle](#oh_arkui_nodeevent_getnodehandle) ([ArkUI_NodeEvent](#arkui_nodeevent-12) \*event) | 获取触发该事件的组件对象。  |
493| [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \* [OH_ArkUI_NodeEvent_GetInputEvent](#oh_arkui_nodeevent_getinputevent) ([ArkUI_NodeEvent](#arkui_nodeevent-12) \*event) | 获取组件事件中的输入事件(如触碰事件)数据。  |
494| [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) \* [OH_ArkUI_NodeEvent_GetNodeComponentEvent](#oh_arkui_nodeevent_getnodecomponentevent) ([ArkUI_NodeEvent](#arkui_nodeevent-12) \*event) | 获取组件事件中的数字类型数据。  |
495| [ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md) \* [OH_ArkUI_NodeEvent_GetStringAsyncEvent](#oh_arkui_nodeevent_getstringasyncevent) ([ArkUI_NodeEvent](#arkui_nodeevent-12) \*event) | 获取组件事件中的字符串数据。  |
496| void \* [OH_ArkUI_NodeEvent_GetUserData](#oh_arkui_nodeevent_getuserdata) ([ArkUI_NodeEvent](#arkui_nodeevent-12) \*event) | 获取组件事件中的用户自定义数据。  |
497| int32_t [OH_ArkUI_NodeEvent_GetNumberValue](#oh_arkui_nodeevent_getnumbervalue) ([ArkUI_NodeEvent](#arkui_nodeevent-12) \*event, int32_t index, [ArkUI_NumberValue](union_ark_u_i___number_value.md) \*value) | 获取组件回调事件的数字类型参数。  |
498| int32_t [OH_ArkUI_NodeEvent_GetStringValue](#oh_arkui_nodeevent_getstringvalue) ([ArkUI_NodeEvent](#arkui_nodeevent-12) \*event, int32_t index, char \*\*string, int32_t \*stringSize) | 获取组件回调事件的字符串类型参数,字符串数据仅在事件回调过程中有效,需要在事件回调外使用建议进行额外拷贝处理。  |
499| int32_t [OH_ArkUI_NodeEvent_SetReturnNumberValue](#oh_arkui_nodeevent_setreturnnumbervalue) ([ArkUI_NodeEvent](#arkui_nodeevent-12) \*event, [ArkUI_NumberValue](union_ark_u_i___number_value.md) \*value, int32_t size) | 设置组件回调事件的返回值。  |
500| [ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) [OH_ArkUI_NodeAdapter_Create](#oh_arkui_nodeadapter_create) () | 创建组件适配器对象。  |
501| void [OH_ArkUI_NodeAdapter_Dispose](#oh_arkui_nodeadapter_dispose) ([ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) handle) | 销毁组件适配器对象。  |
502| int32_t [OH_ArkUI_NodeAdapter_SetTotalNodeCount](#oh_arkui_nodeadapter_settotalnodecount) ([ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) handle, uint32_t size) | 设置Adapter中的元素总数。  |
503| uint32_t [OH_ArkUI_NodeAdapter_GetTotalNodeCount](#oh_arkui_nodeadapter_gettotalnodecount) ([ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) handle) | 获取Adapter中的元素总数。  |
504| int32_t [OH_ArkUI_NodeAdapter_RegisterEventReceiver](#oh_arkui_nodeadapter_registereventreceiver) ([ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) handle, void \*userData, void(\*receiver)([ArkUI_NodeAdapterEvent](#arkui_nodeadapterevent) \*event)) | 注册Adapter相关回调事件。  |
505| void [OH_ArkUI_NodeAdapter_UnregisterEventReceiver](#oh_arkui_nodeadapter_unregistereventreceiver) ([ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) handle) | 注销Adapter相关回调事件。  |
506| int32_t [OH_ArkUI_NodeAdapter_ReloadAllItems](#oh_arkui_nodeadapter_reloadallitems) ([ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) handle) | 通知Adapter进行全量元素变化。  |
507| int32_t [OH_ArkUI_NodeAdapter_ReloadItem](#oh_arkui_nodeadapter_reloaditem) ([ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) handle, uint32_t startPosition, uint32_t itemCount) | 通知Adapter进行局部元素变化。  |
508| int32_t [OH_ArkUI_NodeAdapter_RemoveItem](#oh_arkui_nodeadapter_removeitem) ([ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) handle, uint32_t startPosition, uint32_t itemCount) | 通知Adapter进行局部元素删除。  |
509| int32_t [OH_ArkUI_NodeAdapter_InsertItem](#oh_arkui_nodeadapter_insertitem) ([ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) handle, uint32_t startPosition, uint32_t itemCount) | 通知Adapter进行局部元素插入。  |
510| int32_t [OH_ArkUI_NodeAdapter_MoveItem](#oh_arkui_nodeadapter_moveitem) ([ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) handle, uint32_t from, uint32_t to) | 通知Adapter进行局部元素移位。  |
511| int32_t [OH_ArkUI_NodeAdapter_GetAllItems](#oh_arkui_nodeadapter_getallitems) ([ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) handle, [ArkUI_NodeHandle](#arkui_nodehandle) \*\*items, uint32_t \*size) | 获取存储在Adapter中的所有元素。  |
512| void \* [OH_ArkUI_NodeAdapterEvent_GetUserData](#oh_arkui_nodeadapterevent_getuserdata) ([ArkUI_NodeAdapterEvent](#arkui_nodeadapterevent) \*event) | 获取注册事件时传入的自定义数据。  |
513| [ArkUI_NodeAdapterEventType](#arkui_nodeadaptereventtype) [OH_ArkUI_NodeAdapterEvent_GetType](#oh_arkui_nodeadapterevent_gettype) ([ArkUI_NodeAdapterEvent](#arkui_nodeadapterevent) \*event) | 获取事件类型。  |
514| [ArkUI_NodeHandle](#arkui_nodehandle) [OH_ArkUI_NodeAdapterEvent_GetRemovedNode](#oh_arkui_nodeadapterevent_getremovednode) ([ArkUI_NodeAdapterEvent](#arkui_nodeadapterevent) \*event) | 获取需要销毁的事件中待销毁的元素。  |
515| uint32_t [OH_ArkUI_NodeAdapterEvent_GetItemIndex](#oh_arkui_nodeadapterevent_getitemindex) ([ArkUI_NodeAdapterEvent](#arkui_nodeadapterevent) \*event) | 获取适配器事件时需要操作的元素序号。  |
516| [ArkUI_NodeHandle](#arkui_nodehandle) [OH_ArkUI_NodeAdapterEvent_GetHostNode](#oh_arkui_nodeadapterevent_gethostnode) ([ArkUI_NodeAdapterEvent](#arkui_nodeadapterevent) \*event) | 获取使用该适配器的滚动类容器节点。  |
517| int32_t [OH_ArkUI_NodeAdapterEvent_SetItem](#oh_arkui_nodeadapterevent_setitem) ([ArkUI_NodeAdapterEvent](#arkui_nodeadapterevent) \*event, [ArkUI_NodeHandle](#arkui_nodehandle) node) | 设置需要新增到Adapter中的组件。  |
518| int32_t [OH_ArkUI_NodeAdapterEvent_SetNodeId](#oh_arkui_nodeadapterevent_setnodeid) ([ArkUI_NodeAdapterEvent](#arkui_nodeadapterevent) \*event, int32_t id) | 设置生成的组件标识。  |
519| [ArkUI_LayoutConstraint](#arkui_layoutconstraint) \* [OH_ArkUI_NodeCustomEvent_GetLayoutConstraintInMeasure](#oh_arkui_nodecustomevent_getlayoutconstraintinmeasure) ([ArkUI_NodeCustomEvent](#arkui_nodecustomevent) \*event) | 通过自定义组件事件获取测算过程中的约束尺寸。  |
520| [ArkUI_IntOffset](_ark_u_i___int_offset.md) [OH_ArkUI_NodeCustomEvent_GetPositionInLayout](#oh_arkui_nodecustomevent_getpositioninlayout) ([ArkUI_NodeCustomEvent](#arkui_nodecustomevent) \*event) | 通过自定义组件事件获取在布局阶段期望自身相对父组件的位置。  |
521| [ArkUI_DrawContext](#arkui_drawcontext) \* [OH_ArkUI_NodeCustomEvent_GetDrawContextInDraw](#oh_arkui_nodecustomevent_getdrawcontextindraw) ([ArkUI_NodeCustomEvent](#arkui_nodecustomevent) \*event) | 通过自定义组件事件获取绘制上下文。  |
522| int32_t [OH_ArkUI_NodeCustomEvent_GetEventTargetId](#oh_arkui_nodecustomevent_geteventtargetid) ([ArkUI_NodeCustomEvent](#arkui_nodecustomevent) \*event) | 通过自定义组件事件获取自定义事件ID。  |
523| void \* [OH_ArkUI_NodeCustomEvent_GetUserData](#oh_arkui_nodecustomevent_getuserdata) ([ArkUI_NodeCustomEvent](#arkui_nodecustomevent) \*event) | 通过自定义组件事件获取自定义事件参数。  |
524| [ArkUI_NodeHandle](#arkui_nodehandle) [OH_ArkUI_NodeCustomEvent_GetNodeHandle](#oh_arkui_nodecustomevent_getnodehandle) ([ArkUI_NodeCustomEvent](#arkui_nodecustomevent) \*event) | 通过自定义组件事件获取组件对象。  |
525| [ArkUI_NodeCustomEventType](#arkui_nodecustomeventtype) [OH_ArkUI_NodeCustomEvent_GetEventType](#oh_arkui_nodecustomevent_geteventtype) ([ArkUI_NodeCustomEvent](#arkui_nodecustomevent) \*event) | 通过自定义组件事件获取事件类型。  |
526| int32_t [OH_ArkUI_NodeCustomEvent_GetCustomSpanMeasureInfo](#oh_arkui_nodecustomevent_getcustomspanmeasureinfo) ([ArkUI_NodeCustomEvent](#arkui_nodecustomevent) \*event, [ArkUI_CustomSpanMeasureInfo](#arkui_customspanmeasureinfo) \*info) | 通过自定义组件事件获取自定义段落组件的测量信息。  |
527| int32_t [OH_ArkUI_NodeCustomEvent_SetCustomSpanMetrics](#oh_arkui_nodecustomevent_setcustomspanmetrics) ([ArkUI_NodeCustomEvent](#arkui_nodecustomevent) \*event, [ArkUI_CustomSpanMetrics](#arkui_customspanmetrics) \*metrics) | 通过自定义组件事件设置自定义段落的度量指标。  |
528| int32_t [OH_ArkUI_NodeCustomEvent_GetCustomSpanDrawInfo](#oh_arkui_nodecustomevent_getcustomspandrawinfo) ([ArkUI_NodeCustomEvent](#arkui_nodecustomevent) \*event, [ArkUI_CustomSpanDrawInfo](#arkui_customspandrawinfo) \*info) | 通过自定义组件事件获取自定义段落组件的绘制信息。  |
529| int32_t [OH_ArkUI_NodeContent_RegisterCallback](#oh_arkui_nodecontent_registercallback) ([ArkUI_NodeContentHandle](#arkui_nodecontenthandle) content, [ArkUI_NodeContentCallback](#arkui_nodecontentcallback) callback) | 注册NodeContent事件函数。  |
530| [ArkUI_NodeContentEventType](#arkui_nodecontenteventtype) [OH_ArkUI_NodeContentEvent_GetEventType](#oh_arkui_nodecontentevent_geteventtype) ([ArkUI_NodeContentEvent](#arkui_nodecontentevent) \*event) | 获取触发NodeContent事件的事件类型。  |
531| [ArkUI_NodeContentHandle](#arkui_nodecontenthandle) [OH_ArkUI_NodeContentEvent_GetNodeContentHandle](#oh_arkui_nodecontentevent_getnodecontenthandle) ([ArkUI_NodeContentEvent](#arkui_nodecontentevent) \*event) | 获取触发事件的NodeContent对象。  |
532| int32_t [OH_ArkUI_NodeContent_SetUserData](#oh_arkui_nodecontent_setuserdata) ([ArkUI_NodeContentHandle](#arkui_nodecontenthandle) content, void \*userData) | 在NodeContent对象上保存自定义数据。  |
533| void \* [OH_ArkUI_NodeContent_GetUserData](#oh_arkui_nodecontent_getuserdata) ([ArkUI_NodeContentHandle](#arkui_nodecontenthandle) content) | 获取在NodeContent对象上保存的自定义数据。  |
534| int32_t [OH_ArkUI_NodeContent_AddNode](#oh_arkui_nodecontent_addnode) ([ArkUI_NodeContentHandle](#arkui_nodecontenthandle) content, [ArkUI_NodeHandle](#arkui_nodehandle) node) | 将一个ArkUI组件节点添加到对应的NodeContent对象下。  |
535| int32_t [OH_ArkUI_NodeContent_RemoveNode](#oh_arkui_nodecontent_removenode) ([ArkUI_NodeContentHandle](#arkui_nodecontenthandle) content, [ArkUI_NodeHandle](#arkui_nodehandle) node) | 删除NodeContent对象下的一个ArkUI组件节点  |
536| int32_t [OH_ArkUI_NodeContent_InsertNode](#oh_arkui_nodecontent_insertnode) ([ArkUI_NodeContentHandle](#arkui_nodecontenthandle) content, [ArkUI_NodeHandle](#arkui_nodehandle) node, int32_t position) | 将一个ArkUI组件节点插入到对应的NodeContent对象的特定位置下。  |
537| int32_t [OH_ArkUI_NodeUtils_GetLayoutSize](#oh_arkui_nodeutils_getlayoutsize) ([ArkUI_NodeHandle](#arkui_nodehandle) node, [ArkUI_IntSize](_ark_u_i___int_size.md) \*size) | 获取组件布局区域的大小。 布局区域大小不包含图形变化属性,如缩放。  |
538| int32_t [OH_ArkUI_NodeUtils_GetLayoutPosition](#oh_arkui_nodeutils_getlayoutposition) ([ArkUI_NodeHandle](#arkui_nodehandle) node, [ArkUI_IntOffset](_ark_u_i___int_offset.md) \*localOffset) | 获取组件布局区域相对父组件的位置。 布局区域相对位置不包含图形变化属性,如平移。  |
539| int32_t [OH_ArkUI_NodeUtils_GetLayoutPositionInWindow](#oh_arkui_nodeutils_getlayoutpositioninwindow) ([ArkUI_NodeHandle](#arkui_nodehandle) node, [ArkUI_IntOffset](_ark_u_i___int_offset.md) \*globalOffset) | 获取组件布局区域相对窗口的位置。 布局区域相对位置不包含图形变化属性,如平移。  |
540| int32_t [OH_ArkUI_NodeUtils_GetLayoutPositionInScreen](#oh_arkui_nodeutils_getlayoutpositioninscreen) ([ArkUI_NodeHandle](#arkui_nodehandle) node, [ArkUI_IntOffset](_ark_u_i___int_offset.md) \*screenOffset) | 获取组件布局区域相对屏幕的位置。 布局区域相对位置不包含图形变化属性,如平移。  |
541| int32_t [OH_ArkUI_NodeUtils_GetPositionWithTranslateInWindow](#oh_arkui_nodeutils_getpositionwithtranslateinwindow) ([ArkUI_NodeHandle](#arkui_nodehandle) node, [ArkUI_IntOffset](_ark_u_i___int_offset.md) \*translateOffset) | 获取组件在窗口中的位置,包含了图形平移变化属性。  |
542| int32_t [OH_ArkUI_NodeUtils_GetPositionWithTranslateInScreen](#oh_arkui_nodeutils_getpositionwithtranslateinscreen) ([ArkUI_NodeHandle](#arkui_nodehandle) node, [ArkUI_IntOffset](_ark_u_i___int_offset.md) \*translateOffset) | 获取组件在屏幕中的位置,包含了图形平移变化属性。  |
543| void [OH_ArkUI_NodeUtils_AddCustomProperty](#oh_arkui_nodeutils_addcustomproperty) ([ArkUI_NodeHandle](#arkui_nodehandle) node, const char \*name, const char \*value) | 设置组件的自定义属性。该接口仅在主线程生效。  |
544| void [OH_ArkUI_NodeUtils_RemoveCustomProperty](#oh_arkui_nodeutils_removecustomproperty) ([ArkUI_NodeHandle](#arkui_nodehandle) node, const char \*name) | 移除组件已设置的自定义属性。  |
545| int32_t [OH_ArkUI_NodeUtils_GetCustomProperty](#oh_arkui_nodeutils_getcustomproperty) ([ArkUI_NodeHandle](#arkui_nodehandle) node, const char \*name, [ArkUI_CustomProperty](#arkui_customproperty) \*\*handle) | 获取组件的自定义属性的值。  |
546| [ArkUI_NodeHandle](#arkui_nodehandle) [OH_ArkUI_NodeUtils_GetParentInPageTree](#oh_arkui_nodeutils_getparentinpagetree) ([ArkUI_NodeHandle](#arkui_nodehandle) node) | 获取父节点,可获取由ArkTs创建的组件节点。  |
547| int32_t [OH_ArkUI_NodeUtils_GetActiveChildrenInfo](#oh_arkui_nodeutils_getactivechildreninfo) ([ArkUI_NodeHandle](#arkui_nodehandle) head, ArkUI_ActiveChildrenInfo \*\*handle) | 获取某个节点所有活跃的子节点。Span将不会被计入子结点的统计中。  |
548| [ArkUI_NodeHandle](#arkui_nodehandle) [OH_ArkUI_NodeUtils_GetCurrentPageRootNode](#oh_arkui_nodeutils_getcurrentpagerootnode) ([ArkUI_NodeHandle](#arkui_nodehandle) node) | 获取当前页面的根节点。  |
549| bool [OH_ArkUI_NodeUtils_IsCreatedByNDK](#oh_arkui_nodeutils_iscreatedbyndk) ([ArkUI_NodeHandle](#arkui_nodehandle) node) | 获取组件是否由C-API创建的标签。  |
550| int32_t [OH_ArkUI_NodeUtils_GetNodeType](#oh_arkui_nodeutils_getnodetype) ([ArkUI_NodeHandle](#arkui_nodehandle) node) | 获取节点的类型。  |
551| int32_t [OH_ArkUI_List_CloseAllSwipeActions](#oh_arkui_list_closeallswipeactions) ([ArkUI_NodeHandle](#arkui_nodehandle) node, void \*userData, void(\*onFinish)(void \*userData)) | 收起展开状态下的ListItem。  |
552| [ArkUI_ContextHandle](#arkui_contexthandle-12) [OH_ArkUI_GetContextByNode](#oh_arkui_getcontextbynode) ([ArkUI_NodeHandle](#arkui_nodehandle) node) | 获取当前节点所在页面的UI的上下文实例对象指针。  |
553| int32_t [OH_ArkUI_RegisterSystemColorModeChangeEvent](#oh_arkui_registersystemcolormodechangeevent) ([ArkUI_NodeHandle](#arkui_nodehandle) node, void \*userData, void(\*onColorModeChange)([ArkUI_SystemColorMode](#arkui_systemcolormode) colorMode, void \*userData)) | 注册系统深浅色变更事件。同一组件仅能注册一个系统深浅变更回调。  |
554| void [OH_ArkUI_UnregisterSystemColorModeChangeEvent](#oh_arkui_unregistersystemcolormodechangeevent) ([ArkUI_NodeHandle](#arkui_nodehandle) node) | 注销系统深浅色变更事件。  |
555| int32_t [OH_ArkUI_RegisterSystemFontStyleChangeEvent](#oh_arkui_registersystemfontstylechangeevent) ([ArkUI_NodeHandle](#arkui_nodehandle) node, void \*userData, void(\*onFontStyleChange)([ArkUI_SystemFontStyleEvent](#arkui_systemfontstyleevent) \*event, void \*userData)) | 注册系统字体变更事件。同一组件仅能注册一个系统字体变更回调。  |
556| void [OH_ArkUI_UnregisterSystemFontStyleChangeEvent](#oh_arkui_unregistersystemfontstylechangeevent) ([ArkUI_NodeHandle](#arkui_nodehandle) node) | 注销系统字体变更事件。  |
557| float [OH_ArkUI_SystemFontStyleEvent_GetFontSizeScale](#oh_arkui_systemfontstyleevent_getfontsizescale) (const [ArkUI_SystemFontStyleEvent](#arkui_systemfontstyleevent) \*event) | 获取系统字体变更事件的字体大小值。  |
558| float [OH_ArkUI_SystemFontStyleEvent_GetFontWeightScale](#oh_arkui_systemfontstyleevent_getfontweightscale) (const [ArkUI_SystemFontStyleEvent](#arkui_systemfontstyleevent) \*event) | 获取系统字体变更事件的字体粗细值。  |
559| int32_t [OH_ArkUI_GetNodeHandleFromNapiValue](#oh_arkui_getnodehandlefromnapivalue) (napi_env env, napi_value frameNode, [ArkUI_NodeHandle](#arkui_nodehandle) \*handle) | 获取ArkTS侧创建的FrameNode节点对象映射到native侧的ArkUI_NodeHandle。  |
560| int32_t [OH_ArkUI_GetContextFromNapiValue](#oh_arkui_getcontextfromnapivalue) (napi_env env, napi_value value, [ArkUI_ContextHandle](#arkui_contexthandle-12) \*context) | 获取ArkTS侧创建的UIContext对象映射到native侧的ArkUI_ContextHandle。  |
561| int32_t [OH_ArkUI_GetNodeContentFromNapiValue](#oh_arkui_getnodecontentfromnapivalue) (napi_env env, napi_value value, [ArkUI_NodeContentHandle](#arkui_nodecontenthandle) \*content) | 获取ArkTS侧创建的NodeContent对象映射到native侧的ArkUI_NodeContentHandle。  |
562| int32_t [OH_ArkUI_GetDrawableDescriptorFromNapiValue](#oh_arkui_getdrawabledescriptorfromnapivalue) (napi_env env, napi_value value, [ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) \*\*drawableDescriptor) | 将ArkTS侧创建的DrawableDescriptor对象映射到native侧的ArkUI_DrawableDescriptor。  |
563| int32_t [OH_ArkUI_GetDrawableDescriptorFromResourceNapiValue](#oh_arkui_getdrawabledescriptorfromresourcenapivalue) (napi_env env, napi_value value, [ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) \*\*drawableDescriptor) | 将ArkTS侧创建的$r资源对象映射到native侧的ArkUI_DrawableDescriptor。  |
564| [ArkUI_ErrorCode](#arkui_errorcode) [OH_ArkUI_GetNavigationId](#oh_arkui_getnavigationid) ([ArkUI_NodeHandle](#arkui_nodehandle) node, char \*buffer, int32_t bufferSize, int32_t \*writeLength) | 获取当前节点所在的Navigation组件的ID。  |
565| [ArkUI_ErrorCode](#arkui_errorcode) [OH_ArkUI_GetNavDestinationName](#oh_arkui_getnavdestinationname) ([ArkUI_NodeHandle](#arkui_nodehandle) node, char \*buffer, int32_t bufferSize, int32_t \*writeLength) | 获取当前节点所在的NavDestination组件的名称。  |
566| [ArkUI_ErrorCode](#arkui_errorcode) [OH_ArkUI_GetNavStackLength](#oh_arkui_getnavstacklength) ([ArkUI_NodeHandle](#arkui_nodehandle) node, int32_t \*length) | 根据给定索引值,获取当前节点所在的Navigation栈的长度。  |
567| [ArkUI_ErrorCode](#arkui_errorcode) [OH_ArkUI_GetNavDestinationNameByIndex](#oh_arkui_getnavdestinationnamebyindex) ([ArkUI_NodeHandle](#arkui_nodehandle) node, int32_t index, char \*buffer, int32_t bufferSize, int32_t \*writeLength) | 根据给定索引值,获取当前节点所在的Navigation栈中对应位置的页面名称。 索引值从0开始计数,0为栈底。  |
568| [ArkUI_ErrorCode](#arkui_errorcode) [OH_ArkUI_GetNavDestinationId](#oh_arkui_getnavdestinationid) ([ArkUI_NodeHandle](#arkui_nodehandle) node, char \*buffer, int32_t bufferSize, int32_t \*writeLength) | 获取当前节点所在的NavDestination组件的ID。  |
569| [ArkUI_ErrorCode](#arkui_errorcode) [OH_ArkUI_GetNavDestinationState](#oh_arkui_getnavdestinationstate) ([ArkUI_NodeHandle](#arkui_nodehandle) node, [ArkUI_NavDestinationState](#arkui_navdestinationstate) \*state) | 获取当前节点所在的NavDestination组件的状态。  |
570| [ArkUI_ErrorCode](#arkui_errorcode) [OH_ArkUI_GetNavDestinationIndex](#oh_arkui_getnavdestinationindex) ([ArkUI_NodeHandle](#arkui_nodehandle) node, int32_t \*index) | 获取当前节点所在的NavDestination组件在页面栈的索引。  |
571| napi_value [OH_ArkUI_GetNavDestinationParam](#oh_arkui_getnavdestinationparam) ([ArkUI_NodeHandle](#arkui_nodehandle) node) | 获取当前节点所在的NavDestination组件的参数。  |
572| [ArkUI_ErrorCode](#arkui_errorcode) [OH_ArkUI_GetRouterPageIndex](#oh_arkui_getrouterpageindex) ([ArkUI_NodeHandle](#arkui_nodehandle) node, int32_t \*index) | 获取当前节点所在页面在Router页面栈中的索引。  |
573| [ArkUI_ErrorCode](#arkui_errorcode) [OH_ArkUI_GetRouterPageName](#oh_arkui_getrouterpagename) ([ArkUI_NodeHandle](#arkui_nodehandle) node, char \*buffer, int32_t bufferSize, int32_t \*writeLength) | 获取当前节点所在页面的名称。  |
574| [ArkUI_ErrorCode](#arkui_errorcode) [OH_ArkUI_GetRouterPagePath](#oh_arkui_getrouterpagepath) ([ArkUI_NodeHandle](#arkui_nodehandle) node, char \*buffer, int32_t bufferSize, int32_t \*writeLength) | 获取当前节点所在页面的Page组件的路径。  |
575| [ArkUI_ErrorCode](#arkui_errorcode) [OH_ArkUI_GetRouterPageState](#oh_arkui_getrouterpagestate) ([ArkUI_NodeHandle](#arkui_nodehandle) node, [ArkUI_RouterPageState](#arkui_routerpagestate) \*state) | 获取当前节点所在页面的Page组件的状态。  |
576| [ArkUI_ErrorCode](#arkui_errorcode) [OH_ArkUI_GetRouterPageId](#oh_arkui_getrouterpageid) ([ArkUI_NodeHandle](#arkui_nodehandle) node, char \*buffer, int32_t bufferSize, int32_t \*writeLength) | 获取当前节点所在页面的Page组件的ID。  |
577| [ArkUI_LayoutConstraint](#arkui_layoutconstraint) \* [OH_ArkUI_LayoutConstraint_Create](#oh_arkui_layoutconstraint_create) () | 创建约束尺寸。  |
578| [ArkUI_LayoutConstraint](#arkui_layoutconstraint) \* [OH_ArkUI_LayoutConstraint_Copy](#oh_arkui_layoutconstraint_copy) (const [ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint) | 约束尺寸深拷贝。  |
579| void \* [OH_ArkUI_LayoutConstraint_Dispose](#oh_arkui_layoutconstraint_dispose) ([ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint) | 销毁约束尺寸指针。  |
580| int32_t [OH_ArkUI_LayoutConstraint_GetMaxWidth](#oh_arkui_layoutconstraint_getmaxwidth) (const [ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint) | 通过约束尺寸获取最大宽度,单位为px。  |
581| int32_t [OH_ArkUI_LayoutConstraint_GetMinWidth](#oh_arkui_layoutconstraint_getminwidth) (const [ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint) | 通过约束尺寸获取最小宽度,单位为px。  |
582| int32_t [OH_ArkUI_LayoutConstraint_GetMaxHeight](#oh_arkui_layoutconstraint_getmaxheight) (const [ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint) | 通过约束尺寸获取最大高度,单位为px。  |
583| int32_t [OH_ArkUI_LayoutConstraint_GetMinHeight](#oh_arkui_layoutconstraint_getminheight) (const [ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint) | 通过约束尺寸获取最小高度,单位为px。  |
584| int32_t [OH_ArkUI_LayoutConstraint_GetPercentReferenceWidth](#oh_arkui_layoutconstraint_getpercentreferencewidth) (const [ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint) | 通过约束尺寸获取宽度百分比基准,单位为px。  |
585| int32_t [OH_ArkUI_LayoutConstraint_GetPercentReferenceHeight](#oh_arkui_layoutconstraint_getpercentreferenceheight) (const [ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint) | 通过约束尺寸获取高度百分比基准,单位为px。  |
586| void [OH_ArkUI_LayoutConstraint_SetMaxWidth](#oh_arkui_layoutconstraint_setmaxwidth) ([ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint, int32_t value) | 设置最大宽度。  |
587| void [OH_ArkUI_LayoutConstraint_SetMinWidth](#oh_arkui_layoutconstraint_setminwidth) ([ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint, int32_t value) | 设置最小宽度。  |
588| void [OH_ArkUI_LayoutConstraint_SetMaxHeight](#oh_arkui_layoutconstraint_setmaxheight) ([ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint, int32_t value) | 设置最大高度。  |
589| void [OH_ArkUI_LayoutConstraint_SetMinHeight](#oh_arkui_layoutconstraint_setminheight) ([ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint, int32_t value) | 设置最小高度。  |
590| void [OH_ArkUI_LayoutConstraint_SetPercentReferenceWidth](#oh_arkui_layoutconstraint_setpercentreferencewidth) ([ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint, int32_t value) | 设置宽度百分比基准。  |
591| void [OH_ArkUI_LayoutConstraint_SetPercentReferenceHeight](#oh_arkui_layoutconstraint_setpercentreferenceheight) ([ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint, int32_t value) | 设置高度百分比基准。  |
592| void \* [OH_ArkUI_DrawContext_GetCanvas](#oh_arkui_drawcontext_getcanvas) ([ArkUI_DrawContext](#arkui_drawcontext) \*context) | 获取绘制canvas指针,可以转换为图形库的OH_Drawing_Canvas指针进行绘制。  |
593| [ArkUI_IntSize](_ark_u_i___int_size.md) [OH_ArkUI_DrawContext_GetSize](#oh_arkui_drawcontext_getsize) ([ArkUI_DrawContext](#arkui_drawcontext) \*context) | 获取可绘制区域大小。  |
594| [ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \* [OH_ArkUI_WaterFlowSectionOption_Create](#oh_arkui_waterflowsectionoption_create) () | 创建FlowItem分组配置信息。  |
595| void [OH_ArkUI_WaterFlowSectionOption_Dispose](#oh_arkui_waterflowsectionoption_dispose) ([ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \*option) | 销毁FlowItem分组配置信息指针。  |
596| void [OH_ArkUI_WaterFlowSectionOption_SetSize](#oh_arkui_waterflowsectionoption_setsize) ([ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \*option, int32_t size) | 设置FlowItem分组配置信息数组长度。  |
597| int32_t [OH_ArkUI_WaterFlowSectionOption_GetSize](#oh_arkui_waterflowsectionoption_getsize) ([ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \*option) | 设置FlowItem分组配置信息数组长度。  |
598| void [OH_ArkUI_WaterFlowSectionOption_SetItemCount](#oh_arkui_waterflowsectionoption_setitemcount) ([ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \*option, int32_t index, int32_t itemCount) | 设置分组中FlowItem数量。  |
599| int32_t [OH_ArkUI_WaterFlowSectionOption_GetItemCount](#oh_arkui_waterflowsectionoption_getitemcount) ([ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \*option, int32_t index) | 通过FlowItem分组配置信息获取对应索引下的FlowItem数量。  |
600| void [OH_ArkUI_WaterFlowSectionOption_SetCrossCount](#oh_arkui_waterflowsectionoption_setcrosscount) ([ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \*option, int32_t index, int32_t crossCount) | 设置布局栅格,纵向布局时为列数,横向布局时为行数。  |
601| int32_t [OH_ArkUI_WaterFlowSectionOption_GetCrossCount](#oh_arkui_waterflowsectionoption_getcrosscount) ([ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \*option, int32_t index) | 通过FlowItem分组配置信息获取对应索引下的布局栅格数。  |
602| void [OH_ArkUI_WaterFlowSectionOption_SetColumnGap](#oh_arkui_waterflowsectionoption_setcolumngap) ([ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \*, int32_t index, float columnGap) | 设置分组的列间距。  |
603| float [OH_ArkUI_WaterFlowSectionOption_GetColumnGap](#oh_arkui_waterflowsectionoption_getcolumngap) ([ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \*option, int32_t index) | 通过FlowItem分组配置信息获取对应索引下的分组的列间距。  |
604| void [OH_ArkUI_WaterFlowSectionOption_SetRowGap](#oh_arkui_waterflowsectionoption_setrowgap) ([ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \*option, int32_t index, float rowGap) | 设置分组的行间距。  |
605| float [OH_ArkUI_WaterFlowSectionOption_GetRowGap](#oh_arkui_waterflowsectionoption_getrowgap) ([ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \*option, int32_t index) | 通过FlowItem分组配置信息获取对应索引下的分组的行间距。  |
606| void [OH_ArkUI_WaterFlowSectionOption_SetMargin](#oh_arkui_waterflowsectionoption_setmargin) ([ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \*option, int32_t index, float marginTop, float marginRight, float marginBottom, float marginLeft) | 设置分组的外边距。  |
607| [ArkUI_Margin](_ark_u_i___margin.md) [OH_ArkUI_WaterFlowSectionOption_GetMargin](#oh_arkui_waterflowsectionoption_getmargin) ([ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \*option, int32_t index) | 通过FlowItem分组配置信息获取对应索引下的分组的外边距。  |
608| void [OH_ArkUI_WaterFlowSectionOption_RegisterGetItemMainSizeCallbackByIndex](#oh_arkui_waterflowsectionoption_registergetitemmainsizecallbackbyindex) ([ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \*option, int32_t index, float(\*callback)(int32_t itemIndex)) | 通过FlowItem分组配置信息根据flowItemIndex获取指定Item的主轴大小。  |
609| void [OH_ArkUI_WaterFlowSectionOption_RegisterGetItemMainSizeCallbackByIndexWithUserData](#oh_arkui_waterflowsectionoption_registergetitemmainsizecallbackbyindexwithuserdata) ([ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \*option, int32_t index, void \*userData, float(\*callback)(int32_t itemIndex, void \*userData)) | 通过FlowItem分组配置信息根据flowItemIndex获取指定Item的主轴大小。  |
610| [ArkUI_GuidelineOption](#arkui_guidelineoption) \* [OH_ArkUI_GuidelineOption_Create](#oh_arkui_guidelineoption_create) (int32_t size) | 创建RelativeContaine容器内的辅助线信息。  |
611| void [OH_ArkUI_GuidelineOption_Dispose](#oh_arkui_guidelineoption_dispose) ([ArkUI_GuidelineOption](#arkui_guidelineoption) \*guideline) | 销毁辅助线信息。  |
612| void [OH_ArkUI_GuidelineOption_SetId](#oh_arkui_guidelineoption_setid) ([ArkUI_GuidelineOption](#arkui_guidelineoption) \*guideline, const char \*value, int32_t index) | 设置辅助线的Id。  |
613| void [OH_ArkUI_GuidelineOption_SetDirection](#oh_arkui_guidelineoption_setdirection) ([ArkUI_GuidelineOption](#arkui_guidelineoption) \*guideline, [ArkUI_Axis](#arkui_axis) value, int32_t index) | 设置辅助线的方向。  |
614| void [OH_ArkUI_GuidelineOption_SetPositionStart](#oh_arkui_guidelineoption_setpositionstart) ([ArkUI_GuidelineOption](#arkui_guidelineoption) \*guideline, float value, int32_t index) | 设置距离容器左侧或者顶部的距离。  |
615| void [OH_ArkUI_GuidelineOption_SetPositionEnd](#oh_arkui_guidelineoption_setpositionend) ([ArkUI_GuidelineOption](#arkui_guidelineoption) \*guideline, float value, int32_t index) | 设置距离容器右侧或者底部的距离。  |
616| const char \* [OH_ArkUI_GuidelineOption_GetId](#oh_arkui_guidelineoption_getid) ([ArkUI_GuidelineOption](#arkui_guidelineoption) \*guideline, int32_t index) | 获取辅助线的Id。  |
617| [ArkUI_Axis](#arkui_axis) [OH_ArkUI_GuidelineOption_GetDirection](#oh_arkui_guidelineoption_getdirection) ([ArkUI_GuidelineOption](#arkui_guidelineoption) \*guideline, int32_t index) | 获取辅助线的方向。  |
618| float [OH_ArkUI_GuidelineOption_GetPositionStart](#oh_arkui_guidelineoption_getpositionstart) ([ArkUI_GuidelineOption](#arkui_guidelineoption) \*guideline, int32_t index) | 获取距离容器左侧或者顶部的距离。  |
619| float [OH_ArkUI_GuidelineOption_GetPositionEnd](#oh_arkui_guidelineoption_getpositionend) ([ArkUI_GuidelineOption](#arkui_guidelineoption) \*guideline, int32_t index) | 获取距离容器右侧或者底部的距离。  |
620| [ArkUI_BarrierOption](#arkui_barrieroption) \* [OH_ArkUI_BarrierOption_Create](#oh_arkui_barrieroption_create) (int32_t size) | 创建RelativeContaine容器内的屏障信息。  |
621| void [OH_ArkUI_BarrierOption_Dispose](#oh_arkui_barrieroption_dispose) ([ArkUI_BarrierOption](#arkui_barrieroption) \*barrierStyle) | 销毁屏障信息。  |
622| void [OH_ArkUI_BarrierOption_SetId](#oh_arkui_barrieroption_setid) ([ArkUI_BarrierOption](#arkui_barrieroption) \*barrierStyle, const char \*value, int32_t index) | 设置屏障的Id。  |
623| void [OH_ArkUI_BarrierOption_SetDirection](#oh_arkui_barrieroption_setdirection) ([ArkUI_BarrierOption](#arkui_barrieroption) \*barrierStyle, [ArkUI_BarrierDirection](#arkui_barrierdirection) value, int32_t index) | 设置屏障的方向。  |
624| void [OH_ArkUI_BarrierOption_SetReferencedId](#oh_arkui_barrieroption_setreferencedid) ([ArkUI_BarrierOption](#arkui_barrieroption) \*barrierStyle, const char \*value, int32_t index) | 设置屏障的依赖的组件。  |
625| const char \* [OH_ArkUI_BarrierOption_GetId](#oh_arkui_barrieroption_getid) ([ArkUI_BarrierOption](#arkui_barrieroption) \*barrierStyle, int32_t index) | 获取屏障的Id。  |
626| [ArkUI_BarrierDirection](#arkui_barrierdirection) [OH_ArkUI_BarrierOption_GetDirection](#oh_arkui_barrieroption_getdirection) ([ArkUI_BarrierOption](#arkui_barrieroption) \*barrierStyle, int32_t index) | 获取屏障的方向。  |
627| const char \* [OH_ArkUI_BarrierOption_GetReferencedId](#oh_arkui_barrieroption_getreferencedid) ([ArkUI_BarrierOption](#arkui_barrieroption) \*barrierStyle, int32_t index, int32_t referencedIndex) | 获取屏障的依赖的组件。  |
628| int32_t [OH_ArkUI_BarrierOption_GetReferencedIdSize](#oh_arkui_barrieroption_getreferencedidsize) ([ArkUI_BarrierOption](#arkui_barrieroption) \*barrierStyle, int32_t index) | 获取屏障的依赖的组件的个数。  |
629| [ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \* [OH_ArkUI_AlignmentRuleOption_Create](#oh_arkui_alignmentruleoption_create) () | 创建相对容器中子组件的对齐规则信息。  |
630| void [OH_ArkUI_AlignmentRuleOption_Dispose](#oh_arkui_alignmentruleoption_dispose) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | 销毁相对容器中子组件的对齐规则信息。  |
631| void [OH_ArkUI_AlignmentRuleOption_SetStart](#oh_arkui_alignmentruleoption_setstart) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option, const char \*id, [ArkUI_HorizontalAlignment](#arkui_horizontalalignment) alignment) | 设置左对齐参数。  |
632| void [OH_ArkUI_AlignmentRuleOption_SetEnd](#oh_arkui_alignmentruleoption_setend) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option, const char \*id, [ArkUI_HorizontalAlignment](#arkui_horizontalalignment) alignment) | 设置右对齐参数。  |
633| void [OH_ArkUI_AlignmentRuleOption_SetCenterHorizontal](#oh_arkui_alignmentruleoption_setcenterhorizontal) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option, const char \*id, [ArkUI_HorizontalAlignment](#arkui_horizontalalignment) alignment) | 设置横向居中对齐方式的参数。  |
634| void [OH_ArkUI_AlignmentRuleOption_SetTop](#oh_arkui_alignmentruleoption_settop) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option, const char \*id, [ArkUI_VerticalAlignment](#arkui_verticalalignment) alignment) | 设置顶部对齐的参数。  |
635| void [OH_ArkUI_AlignmentRuleOption_SetBottom](#oh_arkui_alignmentruleoption_setbottom) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option, const char \*id, [ArkUI_VerticalAlignment](#arkui_verticalalignment) alignment) | 设置底部对齐的参数。  |
636| void [OH_ArkUI_AlignmentRuleOption_SetCenterVertical](#oh_arkui_alignmentruleoption_setcentervertical) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option, const char \*id, [ArkUI_VerticalAlignment](#arkui_verticalalignment) alignment) | 设置纵向居中对齐方式的参数。  |
637| void [OH_ArkUI_AlignmentRuleOption_SetBiasHorizontal](#oh_arkui_alignmentruleoption_setbiashorizontal) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option, float horizontal) | 设置组件在锚点约束下的水平方向上偏移参数。  |
638| void [OH_ArkUI_AlignmentRuleOption_SetBiasVertical](#oh_arkui_alignmentruleoption_setbiasvertical) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option, float vertical) | 设置组件在锚点约束下的垂直方向上偏移参数。  |
639| const char \* [OH_ArkUI_AlignmentRuleOption_GetStartId](#oh_arkui_alignmentruleoption_getstartid) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | 获取左对齐参数的Id。  |
640| [ArkUI_HorizontalAlignment](#arkui_horizontalalignment) [OH_ArkUI_AlignmentRuleOption_GetStartAlignment](#oh_arkui_alignmentruleoption_getstartalignment) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | 获取左对齐参数的对齐方式。  |
641| const char \* [OH_ArkUI_AlignmentRuleOption_GetEndId](#oh_arkui_alignmentruleoption_getendid) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | 获取右对齐参数。  |
642| [ArkUI_HorizontalAlignment](#arkui_horizontalalignment) [OH_ArkUI_AlignmentRuleOption_GetEndAlignment](#oh_arkui_alignmentruleoption_getendalignment) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | 获取右对齐参数。  |
643| const char \* [OH_ArkUI_AlignmentRuleOption_GetCenterIdHorizontal](#oh_arkui_alignmentruleoption_getcenteridhorizontal) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | 获取横向居中对齐方式的参数。  |
644| [ArkUI_HorizontalAlignment](#arkui_horizontalalignment) [OH_ArkUI_AlignmentRuleOption_GetCenterAlignmentHorizontal](#oh_arkui_alignmentruleoption_getcenteralignmenthorizontal) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | 获取横向居中对齐方式的参数。  |
645| const char \* [OH_ArkUI_AlignmentRuleOption_GetTopId](#oh_arkui_alignmentruleoption_gettopid) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | 获取顶部对齐的参数。  |
646| [ArkUI_VerticalAlignment](#arkui_verticalalignment) [OH_ArkUI_AlignmentRuleOption_GetTopAlignment](#oh_arkui_alignmentruleoption_gettopalignment) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | 获取顶部对齐的参数。  |
647| const char \* [OH_ArkUI_AlignmentRuleOption_GetBottomId](#oh_arkui_alignmentruleoption_getbottomid) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | 获取底部对齐的参数。  |
648| [ArkUI_VerticalAlignment](#arkui_verticalalignment) [OH_ArkUI_AlignmentRuleOption_GetBottomAlignment](#oh_arkui_alignmentruleoption_getbottomalignment) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | 获取底部对齐的参数。  |
649| const char \* [OH_ArkUI_AlignmentRuleOption_GetCenterIdVertical](#oh_arkui_alignmentruleoption_getcenteridvertical) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | 获取纵向居中对齐方式的参数。  |
650| [ArkUI_VerticalAlignment](#arkui_verticalalignment) [OH_ArkUI_AlignmentRuleOption_GetCenterAlignmentVertical](#oh_arkui_alignmentruleoption_getcenteralignmentvertical) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | 获取纵向居中对齐方式的参数。  |
651| float [OH_ArkUI_AlignmentRuleOption_GetBiasHorizontal](#oh_arkui_alignmentruleoption_getbiashorizontal) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | 获取水平方向上的bias值。  |
652| float [OH_ArkUI_AlignmentRuleOption_GetBiasVertical](#oh_arkui_alignmentruleoption_getbiasvertical) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | 获取垂直方向上的bias值。  |
653| [ArkUI_SwiperIndicator](#arkui_swiperindicator) \* [OH_ArkUI_SwiperIndicator_Create](#oh_arkui_swiperindicator_create) ([ArkUI_SwiperIndicatorType](#arkui_swiperindicatortype) type) | 创建 Swiper 组件的导航指示器。  |
654| void [OH_ArkUI_SwiperIndicator_Dispose](#oh_arkui_swiperindicator_dispose) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | 销毁Swiper组件的导航指示器指针。  |
655| void [OH_ArkUI_SwiperIndicator_SetStartPosition](#oh_arkui_swiperindicator_setstartposition) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, float value) | 设置导航点距离 Swiper 组件左边的距离。  |
656| float [OH_ArkUI_SwiperIndicator_GetStartPosition](#oh_arkui_swiperindicator_getstartposition) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | 获取导航点距离 Swiper 组件左边的距离。  |
657| void [OH_ArkUI_SwiperIndicator_SetTopPosition](#oh_arkui_swiperindicator_settopposition) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, float value) | 设置导航点距离 Swiper 组件顶部的距离。  |
658| float [OH_ArkUI_SwiperIndicator_GetTopPosition](#oh_arkui_swiperindicator_gettopposition) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | 获取导航点距离 Swiper 组件顶部的距离。  |
659| void [OH_ArkUI_SwiperIndicator_SetEndPosition](#oh_arkui_swiperindicator_setendposition) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, float value) | 设置导航点距离 Swiper 组件右边的距离。  |
660| float [OH_ArkUI_SwiperIndicator_GetEndPosition](#oh_arkui_swiperindicator_getendposition) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | 获取导航点距离 Swiper 组件右边的距离。  |
661| void [OH_ArkUI_SwiperIndicator_SetBottomPosition](#oh_arkui_swiperindicator_setbottomposition) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, float value) | 设置导航点距离 Swiper 组件底部的距离。  |
662| float [OH_ArkUI_SwiperIndicator_GetBottomPosition](#oh_arkui_swiperindicator_getbottomposition) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | 获取导航点距离 Swiper 组件底部的距离。  |
663| void [OH_ArkUI_SwiperIndicator_SetItemWidth](#oh_arkui_swiperindicator_setitemwidth) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, float value) | 设置 Swiper 组件圆点导航指示器的宽。  |
664| float [OH_ArkUI_SwiperIndicator_GetItemWidth](#oh_arkui_swiperindicator_getitemwidth) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | 获取 Swiper 组件圆点导航指示器的宽。  |
665| void [OH_ArkUI_SwiperIndicator_SetItemHeight](#oh_arkui_swiperindicator_setitemheight) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, float value) | 设置 Swiper 组件圆点导航指示器的高。  |
666| float [OH_ArkUI_SwiperIndicator_GetItemHeight](#oh_arkui_swiperindicator_getitemheight) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | 获取 Swiper 组件圆点导航指示器的高。  |
667| void [OH_ArkUI_SwiperIndicator_SetSelectedItemWidth](#oh_arkui_swiperindicator_setselecteditemwidth) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, float value) | 设置被选中的 Swiper 组件圆点导航指示器的宽。  |
668| float [OH_ArkUI_SwiperIndicator_GetSelectedItemWidth](#oh_arkui_swiperindicator_getselecteditemwidth) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | 获取被选中 Swiper 组件圆点导航指示器的宽。  |
669| void [OH_ArkUI_SwiperIndicator_SetSelectedItemHeight](#oh_arkui_swiperindicator_setselecteditemheight) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, float value) | 设置被选中的 Swiper 组件圆点导航指示器的高。  |
670| float [OH_ArkUI_SwiperIndicator_GetSelectedItemHeight](#oh_arkui_swiperindicator_getselecteditemheight) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | 获取被选中 Swiper 组件圆点导航指示器的高。  |
671| void [OH_ArkUI_SwiperIndicator_SetMask](#oh_arkui_swiperindicator_setmask) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, int32_t mask) | 设置是否显示 Swiper 组件圆点导航指示器的蒙版样式。  |
672| int32_t [OH_ArkUI_SwiperIndicator_GetMask](#oh_arkui_swiperindicator_getmask) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | 获取是否显示 Swiper 组件圆点导航指示器的蒙版样式。  |
673| void [OH_ArkUI_SwiperIndicator_SetColor](#oh_arkui_swiperindicator_setcolor) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, uint32_t color) | 设置 Swiper 组件圆点导航指示器的颜色。  |
674| uint32_t [OH_ArkUI_SwiperIndicator_GetColor](#oh_arkui_swiperindicator_getcolor) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | 获取 Swiper 组件圆点导航指示器的颜色。  |
675| void [OH_ArkUI_SwiperIndicator_SetSelectedColor](#oh_arkui_swiperindicator_setselectedcolor) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, uint32_t selectedColor) | 设置被选中 Swiper 组件圆点导航指示器的颜色。  |
676| uint32_t [OH_ArkUI_SwiperIndicator_GetSelectedColor](#oh_arkui_swiperindicator_getselectedcolor) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | 获取被选中 Swiper 组件圆点导航指示器的颜色。  |
677| int32_t [OH_ArkUI_SwiperIndicator_SetMaxDisplayCount](#oh_arkui_swiperindicator_setmaxdisplaycount) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, int32_t maxDisplayCount) | 设置圆点导航点指示器样式下,导航点显示个数的最大值。  |
678| int32_t [OH_ArkUI_SwiperIndicator_GetMaxDisplayCount](#oh_arkui_swiperindicator_getmaxdisplaycount) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | 获取圆点导航点指示器样式下,导航点显示个数的最大值。  |
679| [ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* [OH_ArkUI_SwiperDigitIndicator_Create](#oh_arkui_swiperdigitindicator_create)() | 创建 Swiper 组件的数字导航指示器。  |
680| void [OH_ArkUI_SwiperDigitIndicator_SetStartPosition](#oh_arkui_swiperdigitindicator_setstartposition)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator, float value) | 设置数字导航指示器距离 Swiper 组件左边的距离,在从右至左显示的语言模式下,设置其距离 Swiper 组件右边的距离。  |
681| float [OH_ArkUI_SwiperDigitIndicator_GetStartPosition](#oh_arkui_swiperdigitindicator_getstartposition)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator) | 获取数字导航指示器距离 Swiper 组件左边的距离,在从右至左显示的语言模式下,获取其距离 Swiper 组件右边的距离。  |
682| void [OH_ArkUI_SwiperDigitIndicator_SetTopPosition](#oh_arkui_swiperdigitindicator_settopposition)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator, float value) | 设置数字导航指示器距离 Swiper 组件顶部的距离。 |
683| float [OH_ArkUI_SwiperDigitIndicator_GetTopPosition](#oh_arkui_swiperdigitindicator_gettopposition)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator) | 获取数字导航指示器距离 Swiper 组件顶部的距离。  |
684| void [OH_ArkUI_SwiperDigitIndicator_SetEndPosition](#oh_arkui_swiperdigitindicator_setendposition)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator, float value) | 设置数字导航指示器距离 Swiper 组件右边的距离,从右至左显示的语言模式下,设置其距离 Swiper 左边的距离。 |
685| float [OH_ArkUI_SwiperDigitIndicator_GetEndPosition](#oh_arkui_swiperdigitindicator_getendposition)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator) | 获取数字导航指示器距离 Swiper 组件右边的距离,从右至左显示语言模式下,获取其距离 Swiper 组件左边的距离。  |
686| void [OH_ArkUI_SwiperDigitIndicator_SetBottomPosition](#oh_arkui_swiperdigitindicator_setbottomposition)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator, float value) | 设置数字导航指示器距离 Swiper 组件底部的距离。 |
687| float [OH_ArkUI_SwiperDigitIndicator_GetBottomPosition](#oh_arkui_swiperdigitindicator_getbottomposition)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator) | 获取数字导航指示器距离 Swiper 组件底部的距离。  |
688| void [OH_ArkUI_SwiperDigitIndicator_SetFontColor](#oh_arkui_swiperdigitindicator_setfontcolor)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator, uint32_t color) | 设置 Swiper 组件数字导航指示器字体颜色。 |
689| uint32_t [OH_ArkUI_SwiperDigitIndicator_GetFontColor](#oh_arkui_swiperdigitindicator_getfontcolor)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator) | 获取 Swiper 组件数字导航指示器字体颜色。  |
690| void [OH_ArkUI_SwiperDigitIndicator_SetSelectedFontColor](#oh_arkui_swiperdigitindicator_setselectedfontcolor)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator, uint32_t selectedColor) | 设置被选中 Swiper 组件数字导航指示器字体颜色。 |
691| uint32_t [OH_ArkUI_SwiperDigitIndicator_GetSelectedFontColor](#oh_arkui_swiperdigitindicator_getselectedfontcolor)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator) | 获取被选中 Swiper 组件数字导航指示器字体颜色。  |
692| void [OH_ArkUI_SwiperDigitIndicator_SetFontSize](#oh_arkui_swiperdigitindicator_setfontsize)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator, float size) | 设置 Swiper 组件数字导航指示器字体大小。 |
693| float [OH_ArkUI_SwiperDigitIndicator_GetFontSize](#oh_arkui_swiperdigitindicator_getfontsize)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator) | 获取 Swiper 组件数字导航指示器字体大小。  |
694| void [OH_ArkUI_SwiperDigitIndicator_SetSelectedFontSize](#oh_arkui_swiperdigitindicator_setselectedfontsize)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator, float size) | 设置被选中 Swiper 组件数字导航指示器字体大小。 |
695| float [OH_ArkUI_SwiperDigitIndicator_GetSelectedFontSize](#oh_arkui_swiperdigitindicator_getselectedfontsize)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator) | 获取被选中 Swiper 组件数字导航指示器字体大小。  |
696| void [OH_ArkUI_SwiperDigitIndicator_SetFontWeight](#oh_arkui_swiperdigitindicator_setfontweight)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator, [ArkUI_FontWeight](#arkui_fontweight) fontWeight) | 设置 Swiper 组件数字导航指示器字体粗细属性。 |
697| [ArkUI_FontWeight](#arkui_fontweight) [OH_ArkUI_SwiperDigitIndicator_GetFontWeight](#oh_arkui_swiperdigitindicator_getfontweight)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator) | 获取 Swiper 组件数字导航指示器字体粗细属性。  |
698| void [OH_ArkUI_SwiperDigitIndicator_SetSelectedFontWeight](#oh_arkui_swiperdigitindicator_setselectedfontweight)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator, [ArkUI_FontWeight](#arkui_fontweight) selectedFontWeight) | 设置被选中 Swiper 组件数字导航指示器字体粗细属性。 |
699| [ArkUI_FontWeight](#arkui_fontweight) [OH_ArkUI_SwiperDigitIndicator_GetSelectedFontWeight](#oh_arkui_swiperdigitindicator_getselectedfontweight)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator) | 获取被选中 Swiper 组件数字导航指示器字体粗细属性。  |
700|void [OH_ArkUI_SwiperDigitIndicator_Dispose](#oh_arkui_swiperdigitindicator_dispose)() | 销毁Swiper组件的数字导航指示器指针。  |
701| [ArkUI_SwiperArrowStyle](#arkui_swiperarrowstyle)* [OH_ArkUI_SwiperArrowStyle_Create](#oh_arkui_swiperarrowstyle_create)() | 创建 Swiper 组件的导航箭头。  |
702| void [OH_ArkUI_SwiperArrowStyle_SetShowBackground](#oh_arkui_swiperarrowstyle_setshowbackground)([ArkUI_SwiperArrowStyle](#arkui_swiperarrowstyle)* indicator, int32_t showBackground) | 设置 Swiper 组件导航箭头底板是否显示。 |
703| int32_t [OH_ArkUI_SwiperArrowStyle_GetShowBackground](#oh_arkui_swiperarrowstyle_getshowbackground)([ArkUI_SwiperArrowStyle](#arkui_swiperarrowstyle)* indicator) | 获取 Swiper 组件导航箭头底板是否显示。  |
704| void [OH_ArkUI_SwiperArrowStyle_SetShowSidebarMiddle](#oh_arkui_swiperarrowstyle_setshowsidebarmiddle)([ArkUI_SwiperArrowStyle](#arkui_swiperarrowstyle)* indicator, int32_t showSidebarMiddle) | 设置 Swiper 组件导航箭头显示位置。 |
705| int32_t [OH_ArkUI_SwiperArrowStyle_GetShowSidebarMiddle](#oh_arkui_swiperarrowstyle_getshowsidebarmiddle)([ArkUI_SwiperArrowStyle](#arkui_swiperarrowstyle)* indicator) | 获取 Swiper 组件导航箭头显示位置。  |
706| void [OH_ArkUI_SwiperArrowStyle_SetBackgroundSize](#oh_arkui_swiperarrowstyle_setbackgroundsize)([ArkUI_SwiperArrowStyle](#arkui_swiperarrowstyle)* indicator, float backgroundSize) | 设置 Swiper 组件导航箭头底板大小。 |
707| float [OH_ArkUI_SwiperArrowStyle_GetBackgroundSize](#oh_arkui_swiperarrowstyle_getbackgroundsize)([ArkUI_SwiperArrowStyle](#arkui_swiperarrowstyle)* indicator) | 获取 Swiper 组件导航箭头底板大小。  |
708| void [OH_ArkUI_SwiperArrowStyle_SetBackgroundColor](#oh_arkui_swiperarrowstyle_setbackgroundcolor)([ArkUI_SwiperArrowStyle](#arkui_swiperarrowstyle)* indicator, uint32_t backgroundColor) | 设置 Swiper 组件导航箭头底板颜色。 |
709| uint32_t [OH_ArkUI_SwiperArrowStyle_GetBackgroundColor](#oh_arkui_swiperarrowstyle_getbackgroundcolor)([ArkUI_SwiperArrowStyle](#arkui_swiperarrowstyle)* indicator) | 获取 Swiper 组件导航箭头底板颜色。  |
710| void [OH_ArkUI_SwiperArrowStyle_SetArrowSize](#oh_arkui_swiperarrowstyle_setarrowsize)([ArkUI_SwiperArrowStyle](#arkui_swiperarrowstyle)* indicator, float arrowSize) | 设置 Swiper 组件导航箭头大小。 |
711| float [OH_ArkUI_SwiperArrowStyle_GetArrowSize](#oh_arkui_swiperarrowstyle_getarrowsize)([ArkUI_SwiperArrowStyle](#arkui_swiperarrowstyle)* indicator) | 获取 Swiper 组件导航箭头大小。  |
712| void [OH_ArkUI_SwiperArrowStyle_SetArrowColor](#oh_arkui_swiperarrowstyle_setarrowcolor)([ArkUI_SwiperArrowStyle](#arkui_swiperarrowstyle)* indicator, uint32_t arrowColor) | 设置 Swiper 组件导航箭头颜色。 |
713| uint32_t [OH_ArkUI_SwiperArrowStyle_GetArrowColor](#oh_arkui_swiperarrowstyle_getarrowcolor)([ArkUI_SwiperArrowStyle](#arkui_swiperarrowstyle)* indicator) | 获取 Swiper 组件导航箭头颜色。  |
714|void [OH_ArkUI_SwiperArrowStyle_Dispose](#oh_arkui_swiperarrowstyle_dispose)() | 销毁 Swiper 组件的导航箭头指针。  |
715| [ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \* [OH_ArkUI_ListItemSwipeActionItem_Create](#oh_arkui_listitemswipeactionitem_create) () | 创建ListItemSwipeActionItem接口设置的配置项。  |
716| void [OH_ArkUI_ListItemSwipeActionItem_Dispose](#oh_arkui_listitemswipeactionitem_dispose) ([ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item) | 销毁ListItemSwipeActionItem实例。  |
717| void [OH_ArkUI_ListItemSwipeActionItem_SetContent](#oh_arkui_listitemswipeactionitem_setcontent) ([ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item, [ArkUI_NodeHandle](#arkui_nodehandle) node) | 设置ListItemSwipeActionItem的布局内容。  |
718| void [OH_ArkUI_ListItemSwipeActionItem_SetActionAreaDistance](#oh_arkui_listitemswipeactionitem_setactionareadistance) ([ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item, float distance) | 设置组件长距离滑动删除距离阈值。  |
719| float [OH_ArkUI_ListItemSwipeActionItem_GetActionAreaDistance](#oh_arkui_listitemswipeactionitem_getactionareadistance) ([ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item) | 获取组件长距离滑动删除距离阈值。  |
720| void [OH_ArkUI_ListItemSwipeActionItem_SetOnEnterActionArea](#oh_arkui_listitemswipeactionitem_setonenteractionarea) ([ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item, void(\*callback)()) | 设置滑动条目进入删除区域时调用的事件。  |
721| void [OH_ArkUI_ListItemSwipeActionItem_SetOnEnterActionAreaWithUserData](#oh_arkui_listitemswipeactionitem_setonenteractionareawithuserdata) ([ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item, void \*userData, void(\*callback)(void \*userData)) | 设置滑动条目进入删除区域时调用的事件。  |
722| void [OH_ArkUI_ListItemSwipeActionItem_SetOnAction](#oh_arkui_listitemswipeactionitem_setonaction) ([ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item, void(\*callback)()) | 设置组件进入长距删除区后删除ListItem时调用的事件。  |
723| void [OH_ArkUI_ListItemSwipeActionItem_SetOnActionWithUserData](#oh_arkui_listitemswipeactionitem_setonactionwithuserdata) ([ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item, void \*userData, void(\*callback)(void \*userData)) | 设置组件进入长距删除区后删除ListItem时调用的事件。  |
724| void [OH_ArkUI_ListItemSwipeActionItem_SetOnExitActionArea](#oh_arkui_listitemswipeactionitem_setonexitactionarea) ([ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item, void(\*callback)()) | 设置滑动条目退出删除区域时调用的事件。  |
725| void [OH_ArkUI_ListItemSwipeActionItem_SetOnExitActionAreaWithUserData](#oh_arkui_listitemswipeactionitem_setonexitactionareawithuserdata) ([ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item, void \*userData, void(\*callback)(void \*userData)) | 设置滑动条目退出删除区域时调用的事件。  |
726| void [OH_ArkUI_ListItemSwipeActionItem_SetOnStateChange](#oh_arkui_listitemswipeactionitem_setonstatechange) ([ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item, void(\*callback)([ArkUI_ListItemSwipeActionState](#arkui_listitemswipeactionstate) swipeActionState)) | 设置列表项滑动状态变化时候触发的事件。  |
727| void [OH_ArkUI_ListItemSwipeActionItem_SetOnStateChangeWithUserData](#oh_arkui_listitemswipeactionitem_setonstatechangewithuserdata) ([ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item, void \*userData, void(\*callback)([ArkUI_ListItemSwipeActionState](#arkui_listitemswipeactionstate) swipeActionState, void \*userData)) | 设置列表项滑动状态变化时候触发的事件。  |
728| [ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption) \* [OH_ArkUI_ListItemSwipeActionOption_Create](#oh_arkui_listitemswipeactionoption_create) () | 创建ListItemSwipeActionOption接口设置的配置项。  |
729| void [OH_ArkUI_ListItemSwipeActionOption_Dispose](#oh_arkui_listitemswipeactionoption_dispose) ([ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption) \*option) | 销毁ListItemSwipeActionOption实例。  |
730| void [OH_ArkUI_ListItemSwipeActionOption_SetStart](#oh_arkui_listitemswipeactionoption_setstart) ([ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption) \*option, [ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item) | 设置ListItemSwipeActionItem的左侧(垂直布局)或上方(横向布局)布局内容。  |
731| void [OH_ArkUI_ListItemSwipeActionOption_SetEnd](#oh_arkui_listitemswipeactionoption_setend) ([ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption) \*option, [ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item) | 设置ListItemSwipeActionItem的右侧(垂直布局)或下方(横向布局)布局内容。  |
732| void [OH_ArkUI_ListItemSwipeActionOption_SetEdgeEffect](#oh_arkui_listitemswipeactionoption_setedgeeffect) ([ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption) \*option, [ArkUI_ListItemSwipeEdgeEffect](#arkui_listitemswipeedgeeffect) edgeEffect) | 设置滑动效果。  |
733| int32_t [OH_ArkUI_ListItemSwipeActionOption_GetEdgeEffect](#oh_arkui_listitemswipeactionoption_getedgeeffect) ([ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption) \*option) | 获取滑动效果。  |
734| void [OH_ArkUI_ListItemSwipeActionOption_SetOnOffsetChange](#oh_arkui_listitemswipeactionoption_setonoffsetchange) ([ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption) \*option, void(\*callback)(float offset)) | 滑动操作偏移量更改时调用的事件。  |
735| void [OH_ArkUI_ListItemSwipeActionOption_SetOnOffsetChangeWithUserData](#oh_arkui_listitemswipeactionoption_setonoffsetchangewithuserdata) ([ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption) \*option, void \*userData, void(\*callback)(float offset, void \*userData)) | 滑动操作偏移量更改时调用的事件。  |
736| [ArkUI_AccessibilityState](#arkui_accessibilitystate) \* [OH_ArkUI_AccessibilityState_Create](#oh_arkui_accessibilitystate_create) (void) | 创建无障碍状态。  |
737| void [OH_ArkUI_AccessibilityState_Dispose](#oh_arkui_accessibilitystate_dispose) ([ArkUI_AccessibilityState](#arkui_accessibilitystate) \*state) | 销毁无障碍状态指针。  |
738| void [OH_ArkUI_AccessibilityState_SetDisabled](#oh_arkui_accessibilitystate_setdisabled) ([ArkUI_AccessibilityState](#arkui_accessibilitystate) \*state, int32_t isDisabled) | 设置无障碍状态是否禁用。  |
739| int32_t [OH_ArkUI_AccessibilityState_IsDisabled](#oh_arkui_accessibilitystate_isdisabled) ([ArkUI_AccessibilityState](#arkui_accessibilitystate) \*state) | 获取无障碍状态是否禁用。  |
740| void [OH_ArkUI_AccessibilityState_SetSelected](#oh_arkui_accessibilitystate_setselected) ([ArkUI_AccessibilityState](#arkui_accessibilitystate) \*state, int32_t isSelected) | 设置无障碍状态是否选中。  |
741| int32_t [OH_ArkUI_AccessibilityState_IsSelected](#oh_arkui_accessibilitystate_isselected) ([ArkUI_AccessibilityState](#arkui_accessibilitystate) \*state) | 获取无障碍状态是否选中。  |
742| void [OH_ArkUI_AccessibilityState_SetCheckedState](#oh_arkui_accessibilitystate_setcheckedstate) ([ArkUI_AccessibilityState](#arkui_accessibilitystate) \*state, int32_t checkedState) | 设置无障碍状态复选框状态。  |
743| int32_t [OH_ArkUI_AccessibilityState_GetCheckedState](#oh_arkui_accessibilitystate_getcheckedstate) ([ArkUI_AccessibilityState](#arkui_accessibilitystate) \*state) | 获取无障碍状态复选框状态。  |
744| [ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \* [OH_ArkUI_AccessibilityValue_Create](#oh_arkui_accessibilityvalue_create) (void) | 创建无障碍信息。  |
745| void [OH_ArkUI_AccessibilityValue_Dispose](#oh_arkui_accessibilityvalue_dispose) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value) | 销毁无障碍信息指针。  |
746| void [OH_ArkUI_AccessibilityValue_SetMin](#oh_arkui_accessibilityvalue_setmin) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value, int32_t min) | 设置无障碍最小值信息。  |
747| int32_t [OH_ArkUI_AccessibilityValue_GetMin](#oh_arkui_accessibilityvalue_getmin) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value) | 获取无障碍最小值信息。  |
748| void [OH_ArkUI_AccessibilityValue_SetMax](#oh_arkui_accessibilityvalue_setmax) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value, int32_t max) | 设置无障碍最大值信息。  |
749| int32_t [OH_ArkUI_AccessibilityValue_GetMax](#oh_arkui_accessibilityvalue_getmax) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value) | 获取无障碍最大值信息。  |
750| void [OH_ArkUI_AccessibilityValue_SetCurrent](#oh_arkui_accessibilityvalue_setcurrent) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value, int32_t current) | 设置无障碍当前值信息。  |
751| int32_t [OH_ArkUI_AccessibilityValue_GetCurrent](#oh_arkui_accessibilityvalue_getcurrent) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value) | 获取无障碍当前值信息。  |
752| void [OH_ArkUI_AccessibilityValue_SetText](#oh_arkui_accessibilityvalue_settext) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value, const char \*text) | 设置无障碍文本描述信息。  |
753| const char \* [OH_ArkUI_AccessibilityValue_GetText](#oh_arkui_accessibilityvalue_gettext) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value) | 获取无障碍文本描述信息。  |
754| [ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \* [OH_ArkUI_ImageAnimatorFrameInfo_CreateFromString](#oh_arkui_imageanimatorframeinfo_createfromstring) (char \*src) | 使用图片路径创建帧图片信息,图片格式为svg,png和jpg。  |
755| [ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \* [OH_ArkUI_ImageAnimatorFrameInfo_CreateFromDrawableDescriptor](#oh_arkui_imageanimatorframeinfo_createfromdrawabledescriptor) ([ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) \*drawable) | 使用 DrawableDescriptor 对象创建帧图片信息,图片格式为Resource和PixelMap。  |
756| void [OH_ArkUI_ImageAnimatorFrameInfo_Dispose](#oh_arkui_imageanimatorframeinfo_dispose) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo) | 销毁帧图片对象指针。  |
757| void [OH_ArkUI_ImageAnimatorFrameInfo_SetWidth](#oh_arkui_imageanimatorframeinfo_setwidth) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo, int32_t width) | 设置图片宽度。  |
758| int32_t [OH_ArkUI_ImageAnimatorFrameInfo_GetWidth](#oh_arkui_imageanimatorframeinfo_getwidth) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo) | 获取图片宽度。  |
759| void [OH_ArkUI_ImageAnimatorFrameInfo_SetHeight](#oh_arkui_imageanimatorframeinfo_setheight) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo, int32_t height) | 设置图片高度。  |
760| int32_t [OH_ArkUI_ImageAnimatorFrameInfo_GetHeight](#oh_arkui_imageanimatorframeinfo_getheight) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo) | 获取图片高度。  |
761| void [OH_ArkUI_ImageAnimatorFrameInfo_SetTop](#oh_arkui_imageanimatorframeinfo_settop) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo, int32_t top) | 设置图片相对于组件左上角的纵向坐标。  |
762| int32_t [OH_ArkUI_ImageAnimatorFrameInfo_GetTop](#oh_arkui_imageanimatorframeinfo_gettop) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo) | 获取图片相对于组件左上角的纵向坐标。  |
763| void [OH_ArkUI_ImageAnimatorFrameInfo_SetLeft](#oh_arkui_imageanimatorframeinfo_setleft) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo, int32_t left) | 设置图片相对于组件左上角的横向坐标。  |
764| int32_t [OH_ArkUI_ImageAnimatorFrameInfo_GetLeft](#oh_arkui_imageanimatorframeinfo_getleft) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo) | 获取图片相对于组件左上角的横向坐标。  |
765| void [OH_ArkUI_ImageAnimatorFrameInfo_SetDuration](#oh_arkui_imageanimatorframeinfo_setduration) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo, int32_t duration) | 设置图片的播放时长。  |
766| int32_t [OH_ArkUI_ImageAnimatorFrameInfo_GetDuration](#oh_arkui_imageanimatorframeinfo_getduration) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo) | 获取图片的播放时长。  |
767| [ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) \* [OH_ArkUI_ListChildrenMainSizeOption_Create](#oh_arkui_listchildrenmainsizeoption_create) () | 创建ListChildrenMainSize接口设置的配置项。  |
768| void [OH_ArkUI_ListChildrenMainSizeOption_Dispose](#oh_arkui_listchildrenmainsizeoption_dispose) ([ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) \*option) | 销毁ListChildrenMainSize实例。  |
769| int32_t [OH_ArkUI_ListChildrenMainSizeOption_SetDefaultMainSize](#oh_arkui_listchildrenmainsizeoption_setdefaultmainsize) ([ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) \*option, float defaultMainSize) | 设置List组件的ChildrenMainSizeOption默认大小。  |
770| float [OH_ArkUI_ListChildrenMainSizeOption_GetDefaultMainSize](#oh_arkui_listchildrenmainsizeoption_getdefaultmainsize) ([ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) \*option) | 获取List组件的ChildrenMainSizeOption默认大小。  |
771| void [OH_ArkUI_ListChildrenMainSizeOption_Resize](#oh_arkui_listchildrenmainsizeoption_resize) ([ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) \*option, int32_t totalSize) | 重置List组件的ChildrenMainSizeOption的数组大小。  |
772| int32_t [OH_ArkUI_ListChildrenMainSizeOption_Splice](#oh_arkui_listchildrenmainsizeoption_splice) ([ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) \*option, int32_t index, int32_t deleteCount, int32_t addCount) | 对List组件的ChildrenMainSizeOption数组操作大小调整。  |
773| int32_t [OH_ArkUI_ListChildrenMainSizeOption_UpdateSize](#oh_arkui_listchildrenmainsizeoption_updatesize) ([ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) \*option, int32_t index, float mainSize) | 更新List组件的ChildrenMainSizeOption数组的值。  |
774| float [OH_ArkUI_ListChildrenMainSizeOption_GetMainSize](#oh_arkui_listchildrenmainsizeoption_getmainsize) ([ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) \*option, int32_t index) | 获取List组件的ChildrenMainSizeOption数组的值。  |
775| [ArkUI_CustomSpanMeasureInfo](#arkui_customspanmeasureinfo) \* [OH_ArkUI_CustomSpanMeasureInfo_Create](#oh_arkui_customspanmeasureinfo_create) (void) | 创建自定义段落组件测量信息。  |
776| void [OH_ArkUI_CustomSpanMeasureInfo_Dispose](#oh_arkui_customspanmeasureinfo_dispose) ([ArkUI_CustomSpanMeasureInfo](#arkui_customspanmeasureinfo) \*info) | 销毁自定义段落组件测量信息。  |
777| float [OH_ArkUI_CustomSpanMeasureInfo_GetFontSize](#oh_arkui_customspanmeasureinfo_getfontsize) ([ArkUI_CustomSpanMeasureInfo](#arkui_customspanmeasureinfo) \*info) | 获取自定义段落组件的父节点Text的字体大小。  |
778| [ArkUI_CustomSpanMetrics](#arkui_customspanmetrics) \* [OH_ArkUI_CustomSpanMetrics_Create](#oh_arkui_customspanmetrics_create) (void) | 创建自定义段落组件度量信息。  |
779| void [OH_ArkUI_CustomSpanMetrics_Dispose](#oh_arkui_customspanmetrics_dispose) ([ArkUI_CustomSpanMetrics](#arkui_customspanmetrics) \*metrics) | 销毁自定义段落组件度量信息。  |
780| int32_t [OH_ArkUI_CustomSpanMetrics_SetWidth](#oh_arkui_customspanmetrics_setwidth) ([ArkUI_CustomSpanMetrics](#arkui_customspanmetrics) \*metrics, float width) | 设置自定义段落组件的宽度。  |
781| int32_t [OH_ArkUI_CustomSpanMetrics_SetHeight](#oh_arkui_customspanmetrics_setheight) ([ArkUI_CustomSpanMetrics](#arkui_customspanmetrics) \*metrics, float height) | 设置自定义段落组件的高度。  |
782| [ArkUI_CustomSpanDrawInfo](#arkui_customspandrawinfo) \* [OH_ArkUI_CustomSpanDrawInfo_Create](#oh_arkui_customspandrawinfo_create) (void) | 创建自定义段落组件绘制信息。  |
783| void [OH_ArkUI_CustomSpanDrawInfo_Dispose](#oh_arkui_customspandrawinfo_dispose) ([ArkUI_CustomSpanDrawInfo](#arkui_customspandrawinfo) \*info) | 销毁自定义段落组件绘制信息。  |
784| float [OH_ArkUI_CustomSpanDrawInfo_GetXOffset](#oh_arkui_customspandrawinfo_getxoffset) ([ArkUI_CustomSpanDrawInfo](#arkui_customspandrawinfo) \*info) | 获取自定义段落组件相对于挂载组件的x轴偏移值。  |
785| float [OH_ArkUI_CustomSpanDrawInfo_GetLineTop](#oh_arkui_customspandrawinfo_getlinetop) ([ArkUI_CustomSpanDrawInfo](#arkui_customspandrawinfo) \*info) | 获取自定义段落组件相对于挂载组件的上边距。  |
786| float [OH_ArkUI_CustomSpanDrawInfo_GetLineBottom](#oh_arkui_customspandrawinfo_getlinebottom) ([ArkUI_CustomSpanDrawInfo](#arkui_customspandrawinfo) \*info) | 获取自定义段落组件相对于挂载组件的下边距。  |
787| float [OH_ArkUI_CustomSpanDrawInfo_GetBaseline](#oh_arkui_customspandrawinfo_getbaseline) ([ArkUI_CustomSpanDrawInfo](#arkui_customspandrawinfo) \*info) | 获取自定义段落组件相对于挂载组件的基线偏移量。  |
788| void [OH_ArkUI_CustomProperty_Destroy](#oh_arkui_customproperty_destroy) ([ArkUI_CustomProperty](#arkui_customproperty) \*handle) | 销毁CustomProperty实例。  |
789| const char \* [OH_ArkUI_CustomProperty_GetStringValue](#oh_arkui_customproperty_getstringvalue) ([ArkUI_CustomProperty](#arkui_customproperty) \*handle) | 获取自定义属性value信息。  |
790| void [OH_ArkUI_ActiveChildrenInfo_Destroy](#oh_arkui_activechildreninfo_destroy) (ArkUI_ActiveChildrenInfo \*handle) | 销毁ActiveChildrenInfo实例。  |
791| [ArkUI_NodeHandle](#arkui_nodehandle) [OH_ArkUI_ActiveChildrenInfo_GetNodeByIndex](#oh_arkui_activechildreninfo_getnodebyindex) (ArkUI_ActiveChildrenInfo \*handle, int32_t index) | 获取ActiveChildrenInfo结构体的下标为index的子节点。  |
792| int32_t [OH_ArkUI_ActiveChildrenInfo_GetCount](#oh_arkui_activechildreninfo_getcount) (ArkUI_ActiveChildrenInfo \*handle) | 获取ActiveChildrenInfo结构体内的节点数量。  |
793| [ArkUI_StyledString](#arkui_styledstring) \* [OH_ArkUI_StyledString_Create](#oh_arkui_styledstring_create) (OH_Drawing_TypographyStyle \*style, OH_Drawing_FontCollection \*collection) | 创建指向ArkUI_StyledString对象的指针。  |
794| void [OH_ArkUI_StyledString_Destroy](#oh_arkui_styledstring_destroy) ([ArkUI_StyledString](#arkui_styledstring) \*handle) | 释放被ArkUI_StyledString对象占据的内存。  |
795| void [OH_ArkUI_StyledString_PushTextStyle](#oh_arkui_styledstring_pushtextstyle) ([ArkUI_StyledString](#arkui_styledstring) \*handle, OH_Drawing_TextStyle \*style) | 将新的排版风格设置到当前格式化字符串样式栈顶。  |
796| void [OH_ArkUI_StyledString_AddText](#oh_arkui_styledstring_addtext) ([ArkUI_StyledString](#arkui_styledstring) \*handle, const char \*content) | 基于当前格式化字符串样式设置对应的文本内容。  |
797| void [OH_ArkUI_StyledString_PopTextStyle](#oh_arkui_styledstring_poptextstyle) ([ArkUI_StyledString](#arkui_styledstring) \*handle) | 将当前格式化字符串对象中栈顶样式出栈。  |
798| OH_Drawing_Typography \* [OH_ArkUI_StyledString_CreateTypography](#oh_arkui_styledstring_createtypography) ([ArkUI_StyledString](#arkui_styledstring) \*handle) | 基于格式字符串对象创建指向OH_Drawing_Typography对象的指针,用于提前进行文本测算排版。  |
799| void [OH_ArkUI_StyledString_AddPlaceholder](#oh_arkui_styledstring_addplaceholder) ([ArkUI_StyledString](#arkui_styledstring) \*handle, OH_Drawing_PlaceholderSpan \*placeholder) | 设置占位符。  |
800| [ArkUI_StyledString_Descriptor](#arkui_styledstring_descriptor) \* [OH_ArkUI_StyledString_Descriptor_Create](#oh_arkui_styledstring_descriptor_create) (void) | 创建属性字符串数据对象。  |
801| void [OH_ArkUI_StyledString_Descriptor_Destroy](#oh_arkui_styledstring_descriptor_destroy) ([ArkUI_StyledString_Descriptor](#arkui_styledstring_descriptor) \*descriptor) | 释放被ArkUI_StyledString_Descriptor对象占据的内存。  |
802| int32_t [OH_ArkUI_UnmarshallStyledStringDescriptor](#oh_arkui_unmarshallstyledstringdescriptor) (uint8_t \*buffer, size_t bufferSize, [ArkUI_StyledString_Descriptor](#arkui_styledstring_descriptor) \*descriptor) | 将包含属性字符串信息的字节数组反序列化为属性字符串。  |
803| int32_t [OH_ArkUI_MarshallStyledStringDescriptor](#oh_arkui_marshallstyledstringdescriptor) (uint8_t \*buffer, size_t bufferSize, [ArkUI_StyledString_Descriptor](#arkui_styledstring_descriptor) \*descriptor, size_t \*resultSize) | 将属性字符串信息序列化为字节数组。  |
804| const char \* [OH_ArkUI_ConvertToHtml](#oh_arkui_converttohtml) ([ArkUI_StyledString_Descriptor](#arkui_styledstring_descriptor) \*descriptor) | 将属性字符串信息转化成html。  |
805| int32_t [OH_ArkUI_PostFrameCallback](#oh_arkui_postframecallback)([ArkUI_ContextHandle](#arkui_contexthandle-12) uiContext, void\* userData, void (\*callback)(uint64_t nanoTimestamp, uint32_t frameCount, void\* userData))| 注册一个回调函数,以便在下一帧渲染时执行。不允许在非UI线程调用,检查到非UI线程调用程序会主动abort。 |
806| int32_t [OH_ArkUI_RegisterLayoutCallbackOnNodeHandle](#oh_arkui_registerlayoutcallbackonnodehandle)([ArkUI_NodeHandle](#arkui_nodehandle) node, void\* userData, void (\*onLayoutCompleted)(void\* userData))| 注册组件布局完成回调方法。同一组件仅能注册一个布局完成回调方法。  |
807| int32_t [OH_ArkUI_RegisterDrawCallbackOnNodeHandle](#oh_arkui_registerdrawcallbackonnodehandle)([ArkUI_NodeHandle](#arkui_nodehandle) node, void\* userData, void (\*onDrawCompleted)(void\* userData))| 注册组件绘制完成回调方法。同一组件仅能注册一个绘制完成回调方法。  |
808| int32_t [OH_ArkUI_UnregisterLayoutCallbackOnNodeHandle](#oh_arkui_unregisterlayoutcallbackonnodehandle)([ArkUI_NodeHandle](#arkui_nodehandle) node)| 取消注册组件布局完成回调方法。  |
809| int32_t [OH_ArkUI_UnregisterDrawCallbackOnNodeHandle](#oh_arkui_unregisterdrawcallbackonnodehandle)([ArkUI_NodeHandle](#arkui_nodehandle) node)| 取消注册组件绘制完成回调方法。  |
810| [ArkUI_TextChangeEvent](_ark_u_i___text_change_event.md) [OH_ArkUI_NodeEvent_GetTextChangeEvent](#oh_arkui_nodeevent_gettextchangeevent)([ArkUI_NodeEvent](#arkui_nodeevent-12) \*event) | 获取输入框内容改变(包括预上屏内容)事件的相关数据。  |
811|[ArkUI_ErrorCode](_ark_u_i___native_module.md#arkui_errorcode)  OH_ArkUI_FocusRequest([ArkUI_NodeHandle](_ark_u_i___native_module.md#arkui_nodehandle) node); | 请求焦点。|
812| void OH_ArkUI_FocusClear([ArkUI_ContextHandle](_ark_u_i___native_module.md#arkui_contexthandle-12) uiContext); | 将当前焦点清除到根容器节点。 |
813| void OH_ArkUI_FocusActivate([ArkUI_ContextHandle](_ark_u_i___native_module.md#arkui_contexthandle-12) uiContext, bool isActive, bool isAutoInactive); | 设置当前界面的焦点激活态,获焦节点显示焦点框。|
814| void OH_ArkUI_FocusSetAutoTransfer([ArkUI_ContextHandle](_ark_u_i___native_module.md#arkui_contexthandle-12) uiContext, bool autoTransfer); | 设置页面切换时,焦点转移行为。 |
815| void OH_ArkUI_FocusSetKeyProcessingMode([ArkUI_ContextHandle](_ark_u_i___native_module.md#arkui_contexthandle-12) uiContext, ArkUI_KeyProcessingMode mode); | 设置按键事件处理的优先级。 |
816| void [OH_ArkUI_DragEvent_StartDataLoading](#oh_arkui_dragevent_startdataloading)([ArkUI_DragEvent](_ark_u_i___native_module.md#arkui_dragevent)\* event, [OH_UdmfGetDataParams](#oh_udmfgetdataparams)\* options, char\* key, unsigned int keyLen); | 异步获取拖拽数据。 |
817| void OH_ArkUI_[CancelDataLoading](#oh_arkui_canceldataloading)([ArkUI_Context](_ark_u_i___native_module.md#arkui_context) uiContext, const char\* key); | 取消异步获取拖拽数据。 |
818| void OH_ArkUI_[DisableDropDataPrefetchOnNode](#oh_arkui_disabledropdataprefetchonnode)([ArkUI_NodeHandle](_ark_u_i___native_module.md#arkui_nodehandle) node, bool disable); | 设置拖拽是否提前获取数据。true为不提前获取数据,默认值为false。 |
819| [ArkUI_ProgressLinearStyleOption](#arkui_progresslinearstyleoption)\* [OH_ArkUI_ProgressLinearStyleOption_Create](#oh_arkui_progresslinearstyleoption_create)(void) | 创建线性进度条样式信息。 |
820| void [OH_ArkUI_ProgressLinearStyleOption_Destroy](#oh_arkui_progresslinearstyleoption_destroy)([ArkUI_ProgressLinearStyleOption](#arkui_progresslinearstyleoption)* option) | 销毁线性进度条样式信息。 |
821| void [OH_ArkUI_ProgressLinearStyleOption_SetScanEffectEnabled](#oh_arkui_progresslinearstyleoption_setscaneffectenabled)([ArkUI_ProgressLinearStyleOption](#arkui_progresslinearstyleoption)\* option, bool enabled) | 设置线性进度条进度平滑动效的开关。 |
822| void [OH_ArkUI_ProgressLinearStyleOption_SetSmoothEffectEnabled](#oh_arkui_progresslinearstyleoption_setsmootheffectenabled)([ArkUI_ProgressLinearStyleOption](#arkui_progresslinearstyleoption)\* option, bool enabled) | 设置线性进度条扫光效果的开关。 |
823| void [OH_ArkUI_ProgressLinearStyleOption_SetStrokeWidth](#oh_arkui_progresslinearstyleoption_setstrokewidth)([ArkUI_ProgressLinearStyleOption](#arkui_progresslinearstyleoption)\* option, float strokeWidth) | 设置线性进度条宽度。 |
824| void [OH_ArkUI_ProgressLinearStyleOption_SetStrokeRadius](#oh_arkui_progresslinearstyleoption_setstrokeradius)([ArkUI_ProgressLinearStyleOption](#arkui_progresslinearstyleoption)\* option, float strokeRadius) | 设置线性进度条圆角半径。 |
825| bool [OH_ArkUI_ProgressLinearStyleOption_GetScanEffectEnabled](#oh_arkui_progresslinearstyleoption_getscaneffectenabled)([ArkUI_ProgressLinearStyleOption](#arkui_progresslinearstyleoption)\* option) | 获取线性进度条进度平滑动效的开关信息。 |
826| bool [OH_ArkUI_ProgressLinearStyleOption_GetSmoothEffectEnabled](#oh_arkui_progresslinearstyleoption_getsmootheffectenabled)([ArkUI_ProgressLinearStyleOption](#arkui_progresslinearstyleoption)\* option) | 获取线性进度条扫光效果的开关信息。 |
827| float [OH_ArkUI_ProgressLinearStyleOption_GetStrokeWidth](#oh_arkui_progresslinearstyleoption_getstrokewidth)([ArkUI_ProgressLinearStyleOption](#arkui_progresslinearstyleoption)\* option) | 获取线性进度条宽度。 |
828| float [OH_ArkUI_ProgressLinearStyleOption_GetStrokeRadius](#oh_arkui_progresslinearstyleoption_getstrokeradius)([ArkUI_ProgressLinearStyleOption](#arkui_progresslinearstyleoption)\* option) | 获取线性进度条圆角半径值。 |
829| int32_t [OH_ArkUI_NodeUtils_GetPositionToParent](#oh_arkui_nodeutils_getpositiontoparent) ([ArkUI_NodeHandle](#arkui_nodehandle) node, [ArkUI_IntOffset](_ark_u_i___int_offset.md)\* globalOffset) | 获取目标节点相对于父节点的偏移值。  |
830| int32_t [OH_ArkUI_GetGestureParam_DirectMask](#oh_arkui_getgestureparam_directmask) (ArkUI_GestureRecognizer \*recognizer, [ArkUI_GestureDirectionMask](#arkui_gesturedirectionmask)\* directMask) | 获取手势识别器的滑动方向。 |
831| int32_t [OH_ArkUI_GetGestureParam_FingerCount](#oh_arkui_getgestureparam_fingercount) (ArkUI_GestureRecognizer \*recognizer, int\* finger) | 获取手势识别器的手指数。 |
832| int32_t [OH_ArkUI_GetGestureParam_limitFingerCount](#oh_arkui_getgestureparam_limitfingercount) (ArkUI_GestureRecognizer \*recognizer, bool\* isLimited) | 获取手势识别器是否有手指数限制。  |
833| int32_t [OH_ArkUI_GetGestureParam_repeat](#oh_arkui_getgestureparam_repeat) (ArkUI_GestureRecognizer \*recognizer, bool\* isRepeat) | 获取手势识别器是否连续触发事件回调。 |
834| int32_t [OH_ArkUI_GetGestureParam_distance](#oh_arkui_getgestureparam_distance) (ArkUI_GestureRecognizer \*recognizer, double\* distance) | 获取手势识别器的手指允许的移动距离范围。 |
835| int32_t [OH_ArkUI_GetGestureParam_speed](#oh_arkui_getgestureparam_speed) (ArkUI_GestureRecognizer \*recognizer, double\* speed) | 获取手势识别器的识别滑动的最小速度。 |
836| int32_t [OH_ArkUI_GetGestureParam_duration](#oh_arkui_getgestureparam_duration) (ArkUI_GestureRecognizer \*recognizer, int\* duration) | 获取手势识别器的触发长按的最短时间。 |
837| int32_t [OH_ArkUI_GetGestureParam_angle](#oh_arkui_getgestureparam_angle) (ArkUI_GestureRecognizer \*recognizer, double\* angle) | 获取手势识别器的旋转手势的最小改变度数。 |
838| int32_t [OH_ArkUI_GetGestureParam_distanceThreshold](#oh_arkui_getgestureparam_distancethreshold) (ArkUI_GestureRecognizer \*recognizer, double\* distanceThreshold) | 获取手势识别器的手势移动阈值。 |
839| int32_t [OH_ArkUI_GetNodeSnapshot](#oh_arkui_getnodesnapshot)(ArkUI_NodeHandle node, ArkUI_SnapshotOptions* snapshotOptions, OH_PixelmapNative** pixelMap);| 获取指定组件节点的截图,执行过程为同步,调用时应确保对应节点已被渲染(避免在把节点挂树时就立即执行截图,因为图形的渲染一般需要一帧时间生效)。|
840| ArkUI_SnapshotOptions* [OH_ArkUI_CreateSnapshotOptions](#oh_arkui_createsnapshotoptions)();| 创建一个截图选项,当返回值不再使用时必须通过`OH_ArkUI_SnapshotOptions_Dispose`释放。|
841| void [OH_ArkUI_DestroySnapshotOptions](#oh_arkui_destroysnapshotoptions)(ArkUI_SnapshotOptions* snapshotOptions);| 销毁截图选项指针。|
842| int32_t [OH_ArkUI_SnapshotOptions_SetScale](#oh_arkui_snapshotoptions_setscale)(ArkUI_SnapshotOptions* snapshotOptions, float scale);| 配置截图选项中的缩放属性。|
843
844
845## 宏定义说明
846
847
848### OH_ArkUI_GetModuleInterface
849
850```
851#define OH_ArkUI_GetModuleInterface( nativeAPIVariantKind,  structType,  structPtr )
852```
853**Value:**
854```
855 do { \
856 void* anyNativeAPI = OH_ArkUI_QueryModuleInterfaceByName(nativeAPIVariantKind, #structType); \
857 if (anyNativeAPI) { \
858 structPtr = (structType*)(anyNativeAPI); \
859 } \
860 } while (0)
861#include<arkui/native_interface.h>
862#include<arkui/native_node.h>
863
864ArkUI_NativeNodeAPI_1* nativeNodeApi = nullptr;
865OH_ArkUI_GetModuleInterface(ARKUI_NATIVE_NODE, ArkUI_NativeNodeAPI_1, nativeNodeApi);
866```
867**描述:**
868
869基于结构体类型获取对应结构体指针的宏函数。
870
871**起始版本:** 12
872
873
874## 类型定义说明
875
876
877### ArkUI_AccessibilityState
878
879```
880typedef struct ArkUI_AccessibilityState ArkUI_AccessibilityState
881```
882**描述:**
883
884定义组件无障碍状态。
885
886**起始版本:** 12
887
888
889### ArkUI_AccessibilityValue
890
891```
892typedef struct ArkUI_AccessibilityValue ArkUI_AccessibilityValue
893```
894**描述:**
895
896定义组件无障碍信息值。
897
898**起始版本:** 12
899
900
901### ArkUI_AlignmentRuleOption
902
903```
904typedef struct ArkUI_AlignmentRuleOption ArkUI_AlignmentRuleOption
905```
906**描述:**
907
908指定设置在相对容器中子组件的对齐规则。
909
910**起始版本:** 12
911
912
913### ArkUI_AnimateOption
914
915```
916typedef struct ArkUI_AnimateOption ArkUI_AnimateOption
917```
918**描述:**
919
920设置动画效果相关参数。
921
922**起始版本:** 12
923
924
925### ArkUI_AnimatorHandle
926
927```
928typedef struct ArkUI_Animator* ArkUI_AnimatorHandle
929```
930**描述:**
931
932定义animator动画对象指针。
933
934**起始版本:** 12
935
936
937### ArkUI_AnimatorOption
938
939```
940typedef struct ArkUI_AnimatorOption ArkUI_AnimatorOption
941```
942**描述:**
943
944定义animator动画参数对象。
945
946**起始版本:** 12
947
948
949### ArkUI_BarrierOption
950
951```
952typedef struct ArkUI_BarrierOption ArkUI_BarrierOption
953```
954**描述:**
955
956barrier参数,用于定义barrier的id、方向和生成时所依赖的组件。
957
958**起始版本:** 12
959
960
961### ArkUI_Context
962
963```
964typedef struct ArkUI_Context ArkUI_Context
965```
966**描述:**
967
968native UI的上下文实例对象。
969
970**起始版本:** 12
971
972
973### ArkUI_ContextHandle [1/2]
974
975```
976typedef struct ArkUI_Context* ArkUI_ContextHandle
977```
978**描述:**
979
980native UI的上下文实例对象指针定义。
981
982**起始版本:** 12
983
984
985### ArkUI_ContextHandle [2/2]
986
987```
988typedef struct ArkUI_Context* ArkUI_ContextHandle
989```
990**描述:**
991
992定义ArkUI native UI的上下文实例对象指针定义。
993
994**起始版本:** 12
995
996
997### ArkUI_CurveHandle
998
999```
1000typedef struct ArkUI_Curve* ArkUI_CurveHandle
1001```
1002**描述:**
1003
1004定义曲线的插值对象指针定义。
1005
1006**起始版本:** 12
1007
1008
1009### ArkUI_CustomSpanDrawInfo
1010
1011```
1012typedef struct ArkUI_CustomSpanDrawInfo ArkUI_CustomSpanDrawInfo
1013```
1014**描述:**
1015
1016自定义段落组件的绘制信息。
1017
1018**起始版本:** 12
1019
1020
1021### ArkUI_CustomSpanMeasureInfo
1022
1023```
1024typedef struct ArkUI_CustomSpanMeasureInfo ArkUI_CustomSpanMeasureInfo
1025```
1026**描述:**
1027
1028自定义段落组件的测量信息。
1029
1030**起始版本:** 12
1031
1032
1033### ArkUI_CustomSpanMetrics
1034
1035```
1036typedef struct ArkUI_CustomSpanMetrics ArkUI_CustomSpanMetrics
1037```
1038**描述:**
1039
1040自定义段落组件的度量指标。
1041
1042**起始版本:** 12
1043
1044
1045### ArkUI_DialogDismissEvent
1046
1047```
1048typedef struct ArkUI_DialogDismissEvent ArkUI_DialogDismissEvent
1049```
1050**描述:**
1051
1052定义弹窗关闭事件对象。
1053
1054**起始版本:** 12
1055
1056### ArkUI_CustomDialogOptions
1057
1058```
1059typedef struct ArkUI_CustomDialogOptions ArkUI_CustomDialogOptions
1060```
1061**描述:**
1062
1063定义自定义弹窗的内容对象。
1064
1065**起始版本:** 16
1066
1067
1068### ArkUI_DragAction
1069
1070```
1071typedef struct ArkUI_DragAction ArkUI_DragAction
1072```
1073**描述:**
1074
1075拖拽行为,用于主动发起拖拽。
1076
1077**起始版本:** 12
1078
1079
1080### ArkUI_DragAndDropInfo
1081
1082```
1083typedef struct ArkUI_DragAndDropInfo ArkUI_DragAndDropInfo
1084```
1085**描述:**
1086
1087主动发起拖拽后,通过拖拽状态监听返回的系统拖拽相关数据。
1088
1089**起始版本:** 12
1090
1091### ArkUI_DragEvent
1092
1093```
1094typedef struct ArkUI_DragEvent ArkUI_DragEvent
1095```
1096**描述:**
1097
1098拖拽事件。
1099
1100**起始版本:** 12
1101
1102
1103### ArkUI_DragPreviewOption
1104
1105```
1106typedef struct ArkUI_DragPreviewOption ArkUI_DragPreviewOption
1107```
1108**描述:**
1109
1110设置拖拽跟手图的相关自定义参数。
1111
1112**起始版本:** 12
1113
1114
1115### ArkUI_DrawableDescriptor
1116
1117```
1118typedef struct ArkUI_DrawableDescriptor ArkUI_DrawableDescriptor
1119```
1120**描述:**
1121
1122定义 DrawableDescriptor 对象。
1123
1124**起始版本:** 12
1125
1126
1127### ArkUI_DrawContext
1128
1129```
1130typedef struct ArkUI_DrawContext ArkUI_DrawContext
1131```
1132**描述:**
1133
1134定义组件绘制上下文类型结构。
1135
1136**起始版本:** 12
1137
1138
1139### ArkUI_GestureDirectionMask
1140
1141```
1142typedef uint32_t ArkUI_GestureDirectionMask
1143```
1144**描述:**
1145
1146定义滑动手势方向集合。
1147
1148**起始版本:** 12
1149
1150
1151### ArkUI_GestureEventActionTypeMask
1152
1153```
1154typedef uint32_t ArkUI_GestureEventActionTypeMask
1155```
1156**描述:**
1157
1158定义手势事件类型集合。
1159
1160例:ArkUI_GestureEventActionTypeMask actions = GESTURE_EVENT_ACTION_ACCEPT | GESTURE_EVENT_ACTION_UPDATE;
1161
1162**起始版本:** 12
1163
1164
1165### ArkUI_GestureEventTargetInfo
1166
1167```
1168typedef struct ArkUI_GestureEventTargetInfo ArkUI_GestureEventTargetInfo
1169```
1170**描述:**
1171
1172提供手势事件目标信息类型对象定义。
1173
1174**起始版本:** 12
1175
1176
1177### ArkUI_GestureRecognizerDisposeNotifyCallback
1178
1179```
1180typedef void(* ArkUI_GestureRecognizerDisposeNotifyCallback) (ArkUI_GestureRecognizer *recognizer, void *userData)
1181```
1182**描述:**
1183
1184定义手势识别器析构通知事件的回调函数类型。
1185
1186**起始版本:** 12
1187
1188
1189### ArkUI_GestureRecognizerHandle
1190
1191```
1192typedef ArkUI_GestureRecognizer* ArkUI_GestureRecognizerHandle
1193```
1194**描述:**
1195
1196提供手势识别器句柄类型对象定义。
1197
1198**起始版本:** 12
1199
1200
1201### ArkUI_GestureRecognizerHandleArray
1202
1203```
1204typedef ArkUI_GestureRecognizerHandle* ArkUI_GestureRecognizerHandleArray
1205```
1206**描述:**
1207
1208提供手势识别器句柄类型数组对象定义。
1209
1210**起始版本:** 12
1211
1212
1213### ArkUI_TouchRecognizerHandle
1214
1215```
1216typedef ArkUI_TouchRecognizer* ArkUI_TouchRecognizerHandle
1217```
1218**描述:**
1219
1220提供触摸识别器句柄类型对象定义。
1221
1222**起始版本:** 15
1223
1224
1225### ArkUI_TouchRecognizerHandleArray
1226
1227```
1228typedef ArkUI_TouchRecognizerHandle* ArkUI_TouchRecognizerHandleArray
1229```
1230**描述:**
1231
1232提供触摸识别器句柄类型数组对象定义。
1233
1234**起始版本:** 15
1235
1236### ArkUI_GuidelineOption
1237
1238```
1239typedef struct ArkUI_GuidelineOption ArkUI_GuidelineOption
1240```
1241**描述:**
1242
1243guideLine参数,用于定义guideline的id、方向和位置。
1244
1245**起始版本:** 12
1246
1247
1248### ArkUI_ImageAnimatorFrameInfo
1249
1250```
1251typedef struct ArkUI_ImageAnimatorFrameInfo ArkUI_ImageAnimatorFrameInfo
1252```
1253**描述:**
1254
1255定义图片帧信息。
1256
1257**起始版本:** 12
1258
1259
1260### ArkUI_KeyframeAnimateOption
1261
1262```
1263typedef struct ArkUI_KeyframeAnimateOption ArkUI_KeyframeAnimateOption
1264```
1265**描述:**
1266
1267定义关键帧动画参数对象。
1268
1269**起始版本:** 12
1270
1271
1272### ArkUI_LayoutConstraint
1273
1274```
1275typedef struct ArkUI_LayoutConstraint ArkUI_LayoutConstraint
1276```
1277**描述:**
1278
1279约束尺寸,组件布局时,进行尺寸范围限制。
1280
1281**起始版本:** 12
1282
1283
1284### ArkUI_ListChildrenMainSize
1285
1286```
1287typedef struct ArkUI_ListChildrenMainSize ArkUI_ListChildrenMainSize
1288```
1289**描述:**
1290
1291定义List的ChildrenMainSize类信息。
1292
1293**起始版本:** 12
1294
1295
1296### ArkUI_ListItemSwipeActionItem
1297
1298```
1299typedef struct ArkUI_ListItemSwipeActionItem ArkUI_ListItemSwipeActionItem
1300```
1301**描述:**
1302
1303定义ListItemSwipeActionOption方法内Item的配置信息。
1304
1305**起始版本:** 12
1306
1307
1308### ArkUI_ListItemSwipeActionOption
1309
1310```
1311typedef struct ArkUI_ListItemSwipeActionOption ArkUI_ListItemSwipeActionOption
1312```
1313**描述:**
1314
1315定义ListItemSwipeActionOption方法的配置信息。
1316
1317**起始版本:** 12
1318
1319
1320### ArkUI_NativeDialogHandle
1321
1322```
1323typedef struct ArkUI_NativeDialog* ArkUI_NativeDialogHandle
1324```
1325**描述:**
1326
1327定义ArkUI在Native侧的自定义弹窗控制器对象指针。
1328
1329**起始版本:** 12
1330
1331
1332### ArkUI_NodeAdapterEvent
1333
1334```
1335typedef struct ArkUI_NodeAdapterEvent ArkUI_NodeAdapterEvent
1336```
1337**描述:**
1338
1339定义适配器事件对象。
1340
1341**起始版本:** 12
1342
1343
1344### ArkUI_NodeAdapterHandle
1345
1346```
1347typedef struct ArkUI_NodeAdapter* ArkUI_NodeAdapterHandle
1348```
1349**描述:**
1350
1351定义组件适配器对象,用于滚动类组件的元素懒加载。
1352
1353**起始版本:** 12
1354
1355
1356### ArkUI_NodeContentCallback
1357
1358```
1359typedef void(* ArkUI_NodeContentCallback) (ArkUI_NodeContentEvent *event)
1360```
1361**描述:**
1362
1363定义NodeContent事件的回调函数类型。
1364
1365**起始版本:** 12
1366
1367
1368### ArkUI_NodeContentEvent
1369
1370```
1371typedef struct ArkUI_NodeContentEvent ArkUI_NodeContentEvent
1372```
1373**描述:**
1374
1375定义NodeContent事件的通用结构类型。
1376
1377**起始版本:** 12
1378
1379
1380### ArkUI_NodeContentHandle
1381
1382```
1383typedef struct ArkUI_NodeContent* ArkUI_NodeContentHandle
1384```
1385**描述:**
1386
1387定义ArkUI NodeContent实例在Native侧的实例对象指针定义。
1388
1389**起始版本:** 12
1390
1391
1392### ArkUI_NodeCustomEvent
1393
1394```
1395typedef struct ArkUI_NodeCustomEvent ArkUI_NodeCustomEvent
1396```
1397**描述:**
1398
1399定义自定义组件事件的通用结构类型。
1400
1401**起始版本:** 12
1402
1403
1404### ArkUI_NodeEvent [1/2]
1405
1406```
1407typedef struct ArkUI_NodeEvent ArkUI_NodeEvent
1408```
1409**描述:**
1410
1411组件事件的通用结构类型。
1412
1413**起始版本:** 12
1414
1415
1416### ArkUI_NodeEvent [2/2]
1417
1418```
1419typedef struct ArkUI_NodeEventArkUI_NodeEvent
1420```
1421**描述:**
1422
1423定义组件事件的通用结构类型。
1424
1425**起始版本:** 12
1426
1427
1428### ArkUI_NodeHandle
1429
1430```
1431typedef struct ArkUI_Node* ArkUI_NodeHandle
1432```
1433**描述:**
1434
1435定义ArkUI native组件实例对象指针定义。
1436
1437**起始版本:** 12
1438
1439
1440### ArkUI_OnWillDismissEvent
1441
1442```
1443typedef bool(* ArkUI_OnWillDismissEvent) (int32_t reason)
1444```
1445**描述:**
1446
1447弹窗关闭的回调函数。
1448
1449**起始版本:** 12
1450
1451
1452### ArkUI_ParallelInnerGestureEvent
1453
1454```
1455typedef struct ArkUI_ParallelInnerGestureEvent ArkUI_ParallelInnerGestureEvent
1456```
1457**描述:**
1458
1459提供并行内部手势事件类型对象定义。
1460
1461**起始版本:** 12
1462
1463
1464### ArkUI_GestureInterruptInfo
1465
1466```
1467typedef struct ArkUI_GestureInterruptInfo ArkUI_GestureInterruptInfo
1468```
1469
1470**描述:**
1471
1472提供手势中断信息对象定义。
1473
1474**起始版本:** 12
1475
1476
1477### ArkUI_StyledString
1478
1479```
1480typedef struct ArkUI_StyledString ArkUI_StyledString
1481```
1482**描述:**
1483
1484定义文本组件支持的格式化字符串数据对象。
1485
1486**起始版本:** 12
1487
1488
1489### ArkUI_StyledString_Descriptor
1490
1491```
1492typedef struct ArkUI_StyledString_Descriptor ArkUI_StyledString_Descriptor
1493```
1494**描述:**
1495
1496定义文本组件支持的属性字符串的数据对象。
1497
1498**起始版本:** 14
1499
1500
1501### ArkUI_SwiperIndicator
1502
1503```
1504typedef struct ArkUI_SwiperIndicator ArkUI_SwiperIndicator
1505```
1506**描述:**
1507
1508定义 Swiper 组件的导航指示器风格。
1509
1510**起始版本:** 12
1511
1512
1513### ArkUI_SystemFontStyleEvent
1514
1515```
1516typedef struct ArkUI_SystemFontStyleEvent ArkUI_SystemFontStyleEvent
1517```
1518**描述:**
1519
1520系统字体变更事件定义。
1521
1522**起始版本:** 12
1523
1524### ArkUI_SwiperDigitIndicator
1525
1526```
1527typedef struct ArkUI_SwiperDigitIndicator ArkUI_SwiperDigitIndicator
1528```
1529**描述:**
1530
1531定义 Swiper 组件的数字导航指示器风格。
1532
1533**起始版本:** 18
1534
1535### ArkUI_SwiperArrowStyle
1536
1537```
1538typedef struct ArkUI_SwiperArrowStyle ArkUI_SwiperArrowStyle
1539```
1540**描述:**
1541
1542定义 Swiper 组件的导航箭头风格。
1543
1544**起始版本:** 18
1545
1546### ArkUI_TransitionEffect
1547
1548```
1549typedef struct ArkUI_TransitionEffect ArkUI_TransitionEffect
1550```
1551**描述:**
1552
1553定义transition属性配置转场参数对象。
1554
1555**起始版本:** 12
1556
1557
1558### ArkUI_WaterFlowSectionOption
1559
1560```
1561typedef struct ArkUI_WaterFlowSectionOption ArkUI_WaterFlowSectionOption
1562```
1563**描述:**
1564
1565定义FlowItem分组配置信息。
1566
1567**起始版本:** 12
1568
1569
1570### OH_PixelmapNative
1571
1572```
1573typedef struct OH_PixelmapNative OH_PixelmapNative
1574```
1575**描述:**
1576
1577Pixelmap结构体类型,用于执行Pixelmap相关操作。
1578
1579**起始版本:** 12
1580
1581
1582### OH_PixelmapNativeHandle
1583
1584```
1585typedef struct OH_PixelmapNative* OH_PixelmapNativeHandle
1586```
1587**描述:**
1588
1589定义OH_PixelmapNative对象指针类型。
1590
1591**起始版本:** 12
1592
1593
1594### OH_UdmfData
1595
1596```
1597typedef struct OH_UdmfData OH_UdmfData
1598```
1599**描述:**
1600
1601UDMF 统一数据定义。
1602
1603**起始版本:** 12
1604
1605
1606### ArkUI_ProgressLinearStyleOption
1607
1608```
1609typedef struct ArkUI_ProgressLinearStyleOption ArkUI_ProgressLinearStyleOption
1610```
1611**描述:**
1612
1613定义Progress的ProgressLinearStyle信息。
1614
1615**起始版本:** 15
1616
1617### ArkUI_HostWindowInfo
1618
1619```
1620typedef struct ArkUI_HostWindowInfo ArkUI_HostWindowInfo
1621```
1622**描述:**
1623
1624定义窗口属性的HostWindowInfo类信息。
1625
1626**起始版本:** 15
1627
1628
1629### OH_UdmfGetDataParams
1630
1631```
1632typedef struct OH_UdmfGetDataParams OH_UdmfGetDataParams
1633```
1634**描述:**
1635
1636从UDMF获取数据时的参数。
1637
1638**起始版本:** 15
1639
1640### ArkUI_VisibleAreaEventOptions
1641
1642```
1643typedef struct ArkUI_VisibleAreaEventOptions ArkUI_VisibleAreaEventOptions
1644```
1645**描述:**
1646
1647可见区域变化监听的参数。
1648
1649**起始版本:** 18
1650
1651### ArkUI_SnapshotOptions
1652
1653```
1654typedef struct ArkUI_SnapshotOptions ArkUI_SnapshotOptions
1655```
1656
1657**描述**
1658
1659定义截图的可选项。
1660
1661**起始版本:** 15
1662
1663### ArkUI_CustomProperty
1664
1665```
1666typedef struct ArkUI_CustomProperty ArkUI_CustomProperty
1667```
1668**描述:**
1669
1670定义自定义属性的CustomProperty类信息。
1671
1672**起始版本:** 14
1673
1674
1675### ArkUI_ActiveChildrenInfo
1676
1677```
1678typedef struct ArkUI_ActiveChildrenInfo ArkUI_ActiveChildrenInfo
1679```
1680**描述:**
1681
1682定义ActiveChildrenInfo类信息。
1683
1684**起始版本:** 14
1685
1686
1687## 枚举类型说明
1688
1689
1690### ArkUI_AccessibilityActionType
1691
1692```
1693enum ArkUI_AccessibilityActionType
1694```
1695**描述:**
1696
1697定义无障碍操作类型。
1698
1699**起始版本:** 12
1700
1701| 枚举值 | 描述 |
1702| -------- | -------- |
1703| ARKUI_ACCESSIBILITY_ACTION_CLICK  | 点击操作。  |
1704| ARKUI_ACCESSIBILITY_ACTION_LONG_CLICK  | 长按操作。  |
1705| ARKUI_ACCESSIBILITY_ACTION_CUT  | 剪切操作。  |
1706| ARKUI_ACCESSIBILITY_ACTION_COPY  | 复制操作。  |
1707| ARKUI_ACCESSIBILITY_ACTION_PASTE  | 粘贴操作。  |
1708
1709
1710### ArkUI_AccessibilityCheckedState
1711
1712```
1713enum ArkUI_AccessibilityCheckedState
1714```
1715**描述:**
1716
1717定义无障碍复选框状态类型枚举值。
1718
1719**起始版本:** 12
1720
1721| 枚举值 | 描述 |
1722| -------- | -------- |
1723| ARKUI_ACCESSIBILITY_UNCHECKED  | 复选框未被选中。  |
1724| ARKUI_ACCESSIBILITY_CHECKED  | 复选框被选中。  |
1725
1726
1727### ArkUI_AccessibilityMode
1728
1729```
1730enum ArkUI_AccessibilityMode
1731```
1732**描述:**
1733
1734定义无障碍辅助服务模式。
1735
1736**起始版本:** 12
1737
1738| 枚举值 | 描述 |
1739| -------- | -------- |
1740| ARKUI_ACCESSIBILITY_MODE_AUTO  | 根据组件不同会转换为“enabled”或者“disabled”。  |
1741| ARKUI_ACCESSIBILITY_MODE_ENABLED  | 当前组件可被无障碍辅助服务所识别。  |
1742| ARKUI_ACCESSIBILITY_MODE_DISABLED  | 当前组件不可被无障碍辅助服务所识别。  |
1743| ARKUI_ACCESSIBILITY_MODE_DISABLED_FOR_DESCENDANTS  | 当前组件及其所有子组件不可被无障碍辅助服务所识别。  |
1744
1745
1746### ArkUI_AdaptiveColor
1747
1748```
1749enum ArkUI_AdaptiveColor
1750```
1751**描述:**
1752
1753定义取色模式。
1754
1755**起始版本:** 12
1756
1757| 枚举值 | 描述 |
1758| -------- | -------- |
1759| ARKUI_ADAPTIVE_COLOR_DEFAULT  | 不使用取色模糊。  |
1760| ARKUI_ADAPTIVE_COLOR_AVERAGE  | 使用取色模糊。  |
1761
1762
1763### ArkUI_Alignment
1764
1765```
1766enum ArkUI_Alignment
1767```
1768**描述:**
1769
1770定义布局对齐枚举值。
1771
1772**起始版本:** 12
1773
1774| 枚举值 | 描述 |
1775| -------- | -------- |
1776| ARKUI_ALIGNMENT_TOP_START  | 顶部起始。  |
1777| ARKUI_ALIGNMENT_TOP  | 顶部居中。  |
1778| ARKUI_ALIGNMENT_TOP_END  | 顶部尾端。  |
1779| ARKUI_ALIGNMENT_START  | 起始端纵向居中。  |
1780| ARKUI_ALIGNMENT_CENTER  | 横向和纵向居中。  |
1781| ARKUI_ALIGNMENT_END  | 尾端纵向居中。  |
1782| ARKUI_ALIGNMENT_BOTTOM_START  | 底部起始端。  |
1783| ARKUI_ALIGNMENT_BOTTOM  | 底部横向居中。  |
1784| ARKUI_ALIGNMENT_BOTTOM_END  | 底部尾端。  |
1785
1786
1787### ArkUI_AnimationCurve
1788
1789```
1790enum ArkUI_AnimationCurve
1791```
1792**描述:**
1793
1794动画曲线枚举值。
1795
1796**起始版本:** 12
1797
1798| 枚举值 | 描述 |
1799| -------- | -------- |
1800| ARKUI_CURVE_LINEAR  | 动画从头到尾的速度都是相同。  |
1801| ARKUI_CURVE_EASE  | 动画以低速开始,然后加快,在结束前变慢。  |
1802| ARKUI_CURVE_EASE_IN  | 动画以低速开始。  |
1803| ARKUI_CURVE_EASE_OUT  | 动画以低速结束。  |
1804| ARKUI_CURVE_EASE_IN_OUT  | 动画以低速开始和结束。  |
1805| ARKUI_CURVE_FAST_OUT_SLOW_IN  | 动画标准曲线。  |
1806| ARKUI_CURVE_LINEAR_OUT_SLOW_IN  | 动画减速曲线。  |
1807| ARKUI_CURVE_FAST_OUT_LINEAR_IN  | 动画加速曲线。  |
1808| ARKUI_CURVE_EXTREME_DECELERATION  | 动画急缓曲线。  |
1809| ARKUI_CURVE_SHARP  | 动画锐利曲线。  |
1810| ARKUI_CURVE_RHYTHM  | 动画节奏曲线。  |
1811| ARKUI_CURVE_SMOOTH  | 动画平滑曲线。  |
1812| ARKUI_CURVE_FRICTION  | 动画阻尼曲线。  |
1813
1814
1815### ArkUI_AnimationDirection
1816
1817```
1818enum ArkUI_AnimationDirection
1819```
1820**描述:**
1821
1822动画播放模式。
1823
1824**起始版本:** 12
1825
1826| 枚举值 | 描述 |
1827| -------- | -------- |
1828| ARKUI_ANIMATION_DIRECTION_NORMAL  | 动画正向循环播放。  |
1829| ARKUI_ANIMATION_DIRECTION_REVERSE  | 动画反向循环播放。  |
1830| ARKUI_ANIMATION_DIRECTION_ALTERNATE  | 动画交替循环播放,奇数次正向播放,偶数次反向播放。  |
1831| ARKUI_ANIMATION_DIRECTION_ALTERNATE_REVERSE  | 动画反向交替循环播放,奇数次反向播放,偶数次正向播放。  |
1832
1833
1834### ArkUI_AnimationFillMode
1835
1836```
1837enum ArkUI_AnimationFillMode
1838```
1839**描述:**
1840
1841定义帧动画组件在动画开始前和结束后的状态。
1842
1843**起始版本:** 12
1844
1845| 枚举值 | 描述 |
1846| -------- | -------- |
1847| ARKUI_ANIMATION_FILL_MODE_NONE  | 动画未执行时不会将任何样式应用于目标,动画播放完成之后恢复初始默认状态。  |
1848| ARKUI_ANIMATION_FILL_MODE_FORWARDS  | 目标将保留动画执行期间最后一个关键帧的状态。  |
1849| ARKUI_ANIMATION_FILL_MODE_BACKWARDS  | 动画将在应用于目标时立即应用第一个关键帧中定义的值,并在delay期间保留此值。  |
1850| ARKUI_ANIMATION_FILL_MODE_BOTH  | 动画将遵循Forwards和Backwards的规则,从而在两个方向上扩展动画属性。  |
1851
1852
1853### ArkUI_AnimationPlayMode
1854
1855```
1856enum ArkUI_AnimationPlayMode
1857```
1858**描述:**
1859
1860定义动画播放模式。
1861
1862**起始版本:** 12
1863
1864| 枚举值 | 描述 |
1865| -------- | -------- |
1866| ARKUI_ANIMATION_PLAY_MODE_NORMAL  | 动画正向播放。  |
1867| ARKUI_ANIMATION_PLAY_MODE_REVERSE  | 动画反向播放。  |
1868| ARKUI_ANIMATION_PLAY_MODE_ALTERNATE  | 动画在奇数次(1、3、5...)正向播放,在偶数次(2、4、6...)反向播放。  |
1869| ARKUI_ANIMATION_PLAY_MODE_ALTERNATE_REVERSE  | 动画在奇数次(1、3、5...)反向播放,在偶数次(2、4、6...)正向播放。  |
1870
1871
1872### ArkUI_AnimationStatus
1873
1874```
1875enum ArkUI_AnimationStatus
1876```
1877**描述:**
1878
1879定义帧动画的播放状态。
1880
1881**起始版本:** 12
1882
1883| 枚举值 | 描述 |
1884| -------- | -------- |
1885| ARKUI_ANIMATION_STATUS_INITIAL  | 动画初始状态。  |
1886| ARKUI_ANIMATION_STATUS_RUNNING  | 动画处于播放状态。  |
1887| ARKUI_ANIMATION_STATUS_PAUSED  | 动画处于暂停状态。  |
1888| ARKUI_ANIMATION_STATUS_STOPPED  | 动画处于停止状态。  |
1889
1890
1891### ArkUI_Axis
1892
1893```
1894enum ArkUI_Axis
1895```
1896**描述:**
1897
1898定义滚动方向和List组件排列方向枚举值。
1899
1900**起始版本:** 12
1901
1902| 枚举值 | 描述 |
1903| -------- | -------- |
1904| ARKUI_AXIS_VERTICAL  | 仅支持竖直方向滚动。  |
1905| ARKUI_AXIS_HORIZONTAL  | 仅支持水平方向滚动。  |
1906
1907
1908### ArkUI_BarrierDirection
1909
1910```
1911enum ArkUI_BarrierDirection
1912```
1913**描述:**
1914
1915定义屏障线的方向。
1916
1917**起始版本:** 12
1918
1919| 枚举值 | 描述 |
1920| -------- | -------- |
1921| ARKUI_BARRIER_DIRECTION_START  | 屏障在其所有referencedId的最左侧。  |
1922| ARKUI_BARRIER_DIRECTION_END  | 屏障在其所有referencedId的最右侧。  |
1923| ARKUI_BARRIER_DIRECTION_TOP  | 屏障在其所有referencedId的最上方。  |
1924| ARKUI_BARRIER_DIRECTION_BOTTOM  | 屏障在其所有referencedId的最下方。  |
1925
1926
1927### ArkUI_BlendApplyType
1928
1929```
1930enum ArkUI_BlendApplyType
1931```
1932**描述:**
1933
1934指定的混合模式应用于视图的内容选项。
1935
1936**起始版本:** 12
1937
1938| 枚举值 | 描述 |
1939| -------- | -------- |
1940| BLEND_APPLY_TYPE_FAST  | 在目标图像上按顺序混合视图的内容。  |
1941| BLEND_APPLY_TYPE_OFFSCREEN  | 将此组件和子组件内容绘制到离屏画布上,然后整体进行混合。  |
1942
1943
1944### ArkUI_BlendMode
1945
1946```
1947enum ArkUI_BlendMode
1948```
1949**描述:**
1950
1951混合模式枚举值。
1952
1953**起始版本:** 12
1954
1955| 枚举值 | 描述 |
1956| -------- | -------- |
1957| ARKUI_BLEND_MODE_NONE  | 将上层图像直接覆盖到下层图像上,不进行任何混合操作。  |
1958| ARKUI_BLEND_MODE_CLEAR  | 将源像素覆盖的目标像素清除为完全透明。  |
1959| ARKUI_BLEND_MODE_SRC  | r = s,只显示源像素。  |
1960| ARKUI_BLEND_MODE_DST  | r = d,只显示目标像素。  |
1961| ARKUI_BLEND_MODE_SRC_OVER  | r = s + (1 - sa) \* d,将源像素按照透明度进行混合,覆盖在目标像素上。  |
1962| ARKUI_BLEND_MODE_DST_OVER  | r = d + (1 - da) \* s,将目标像素按照透明度进行混合,覆盖在源像素上。  |
1963| ARKUI_BLEND_MODE_SRC_IN  | r = s \* da,只显示源像素中与目标像素重叠的部分。  |
1964| ARKUI_BLEND_MODE_DST_IN  | r = d \* sa,只显示目标像素中与源像素重叠的部分。  |
1965| ARKUI_BLEND_MODE_SRC_OUT  | r = s \* (1 - da),只显示源像素中与目标像素不重叠的部分。  |
1966| ARKUI_BLEND_MODE_DST_OUT  | r = d \* (1 - sa),只显示目标像素中与源像素不重叠的部分。  |
1967| ARKUI_BLEND_MODE_SRC_ATOP  | r = s \* da + d \* (1 - sa),在源像素和目标像素重叠的地方绘制源像素,在源像素和目标像素不重叠的地方绘制目标像素。  |
1968| ARKUI_BLEND_MODE_DST_ATOP  | r = d \* sa + s \* (1 - da),在源像素和目标像素重叠的地方绘制目标像素,在源像素和目标像素不重叠的地方绘制源像素。  |
1969| ARKUI_BLEND_MODE_XOR  | r = s \* (1 - da) + d \* (1 - sa),只显示源像素与目标像素不重叠的部分。  |
1970| ARKUI_BLEND_MODE_PLUS  | r = min(s + d, 1),将源像素值与目标像素值相加,并将结果作为新的像素值。  |
1971| ARKUI_BLEND_MODE_MODULATE  | r = s \* d,将源像素与目标像素进行乘法运算,并将结果作为新的像素值。  |
1972| ARKUI_BLEND_MODE_SCREEN  | r = s + d - s \* d,将两个图像的像素值相加,然后减去它们的乘积来实现混合。  |
1973| ARKUI_BLEND_MODE_OVERLAY  | 根据目标像素来决定使用MULTIPLY混合模式还是SCREEN混合模式。  |
1974| ARKUI_BLEND_MODE_DARKEN  | rc = s + d - max(s \* da, d \* sa), ra = kSrcOver,当两个颜色重叠时,较暗的颜色会覆盖较亮的颜色。  |
1975| ARKUI_BLEND_MODE_LIGHTEN  | rc = s + d - min(s \* da, d \* sa), ra = kSrcOver,将源图像和目标图像中的像素进行比较,选取两者中较亮的像素作为最终的混合结果。  |
1976| ARKUI_BLEND_MODE_COLOR_DODGE  | 使目标像素变得更亮来反映源像素。  |
1977| ARKUI_BLEND_MODE_COLOR_BURN  | 使目标像素变得更暗来反映源像素。  |
1978| ARKUI_BLEND_MODE_HARD_LIGHT  | 根据源像素的值来决定目标像素变得更亮或者更暗。根据源像素来决定使用MULTIPLY混合模式还是SCREEN混合模式。  |
1979| ARKUI_BLEND_MODE_SOFT_LIGHT  | 根据源像素来决定使用LIGHTEN混合模式还是DARKEN混合模式。  |
1980| ARKUI_BLEND_MODE_DIFFERENCE  | rc = s + d - 2 \* (min(s \* da, d \* sa)), ra = kSrcOver,对比源像素和目标像素,亮度更高的像素减去亮度更低的像素,产生高对比度的效果。  |
1981| ARKUI_BLEND_MODE_EXCLUSION  | rc = s + d - two(s \* d), ra = kSrcOver,对比源像素和目标像素,亮度更高的像素减去亮度更低的像素,产生柔和的效果。  |
1982| ARKUI_BLEND_MODE_MULTIPLY  | r = s \* (1 - da) + d \* (1 - sa) + s \* d,将源图像与目标图像进行乘法混合,得到一张新的图像。 |
1983| ARKUI_BLEND_MODE_HUE  | 保留源图像的亮度和饱和度,但会使用目标图像的色调来替换源图像的色调。  |
1984| ARKUI_BLEND_MODE_SATURATION  | 保留目标像素的亮度和色调,但会使用源像素的饱和度来替换目标像素的饱和度。  |
1985| ARKUI_BLEND_MODE_COLOR  | 保留源像素的饱和度和色调,但会使用目标像素的亮度来替换源像素的亮度。  |
1986| ARKUI_BLEND_MODE_LUMINOSITY  | 保留目标像素的色调和饱和度,但会用源像素的亮度替换目标像素的亮度。  |
1987
1988
1989### ArkUI_BlurStyle
1990
1991```
1992enum ArkUI_BlurStyle
1993```
1994**描述:**
1995
1996定义背景模糊样式。
1997
1998**起始版本:** 12
1999
2000| 枚举值 | 描述 |
2001| -------- | -------- |
2002| ARKUI_BLUR_STYLE_THIN  | 轻薄材质模糊。  |
2003| ARKUI_BLUR_STYLE_REGULAR  | 普通厚度材质模糊。  |
2004| ARKUI_BLUR_STYLE_THICK  | 厚材质模糊。  |
2005| ARKUI_BLUR_STYLE_BACKGROUND_THIN  | 近距景深模糊。  |
2006| ARKUI_BLUR_STYLE_BACKGROUND_REGULAR  | 中距景深模糊。  |
2007| ARKUI_BLUR_STYLE_BACKGROUND_THICK  | 远距景深模糊。  |
2008| ARKUI_BLUR_STYLE_BACKGROUND_ULTRA_THICK  | 超远距景深模糊。  |
2009| ARKUI_BLUR_STYLE_NONE  | 关闭模糊。  |
2010| ARKUI_BLUR_STYLE_COMPONENT_ULTRA_THIN  | 组件超轻薄材质模糊。  |
2011| ARKUI_BLUR_STYLE_COMPONENT_THIN  | 组件轻薄材质模糊。  |
2012| ARKUI_BLUR_STYLE_COMPONENT_REGULAR  | 组件普通材质模糊。  |
2013| ARKUI_BLUR_STYLE_COMPONENT_THICK  | 组件厚材质模糊。  |
2014| ARKUI_BLUR_STYLE_COMPONENT_ULTRA_THICK  | 组件超厚材质模糊。  |
2015
2016
2017### ArkUI_BorderStyle
2018
2019```
2020enum ArkUI_BorderStyle
2021```
2022**描述:**
2023
2024边框线条样式枚举值。
2025
2026**起始版本:** 12
2027
2028| 枚举值 | 描述 |
2029| -------- | -------- |
2030| ARKUI_BORDER_STYLE_SOLID  | 显示为一条实线。  |
2031| ARKUI_BORDER_STYLE_DASHED  | 显示为一系列短的方形虚线。  |
2032| ARKUI_BORDER_STYLE_DOTTED  | 显示为一系列圆点。  |
2033
2034
2035### ArkUI_ButtonType
2036
2037```
2038enum ArkUI_ButtonType
2039```
2040**描述:**
2041
2042定义按钮样式枚举值。
2043
2044**起始版本:** 12
2045
2046| 枚举值 | 描述 |
2047| -------- | -------- |
2048| ARKUI_BUTTON_TYPE_NORMAL  | 普通按钮,默认不带圆角。  |
2049| ARKUI_BUTTON_TYPE_CAPSULE  | 胶囊型按钮,圆角默认为高度的一半。  |
2050| ARKUI_BUTTON_TYPE_CIRCLE  | 圆形按钮。  |
2051
2052
2053### ArkUI_CalendarAlignment
2054
2055```
2056enum ArkUI_CalendarAlignment
2057```
2058**描述:**
2059
2060日历选择器与入口组件对齐方式。
2061
2062**起始版本:** 12
2063
2064| 枚举值 | 描述 |
2065| -------- | -------- |
2066| ARKUI_CALENDAR_ALIGNMENT_START  | 选择器和入口组件左对齐方式。  |
2067| ARKUI_CALENDAR_ALIGNMENT_CENTER  | 选择器和入口组件居中对齐方式。  |
2068| ARKUI_CALENDAR_ALIGNMENT_END  | 选择器和入口组件右对齐方式。  |
2069
2070
2071### ArkUI_CancelButtonStyle
2072
2073```
2074enum ArkUI_CancelButtonStyle
2075```
2076**描述:**
2077
2078定义清除按钮样式枚举值。
2079
2080**起始版本:** 12
2081
2082| 枚举值 | 描述 |
2083| -------- | -------- |
2084| ARKUI_CANCELBUTTON_STYLE_CONSTANT  | 清除按钮常显样式。  |
2085| ARKUI_CANCELBUTTON_STYLE_INVISIBLE  | 清除按钮常隐样式。  |
2086| ARKUI_CANCELBUTTON_STYLE_INPUT  | 清除按钮输入样式。  |
2087
2088
2089### ArkUI_CheckboxShape
2090
2091```
2092enum ArkUI_CheckboxShape
2093```
2094**描述:**
2095
2096定义CheckBox组件形状。
2097
2098**起始版本:** 12
2099
2100| 枚举值 | 描述 |
2101| -------- | -------- |
2102| ArkUI_CHECKBOX_SHAPE_CIRCLE  | 圆形。  |
2103| ArkUI_CHECKBOX_SHAPE_ROUNDED_SQUARE  | 圆角方形。  |
2104
2105
2106### ArkUI_ClipType
2107
2108```
2109enum ArkUI_ClipType
2110```
2111**描述:**
2112
2113裁剪类型枚举。
2114
2115**起始版本:** 12
2116
2117| 枚举值 | 描述 |
2118| -------- | -------- |
2119| ARKUI_CLIP_TYPE_RECTANGLE  | 矩形类型。  |
2120| ARKUI_CLIP_TYPE_CIRCLE  | 圆形类型。  |
2121| ARKUI_CLIP_TYPE_ELLIPSE  | 椭圆形类型。  |
2122| ARKUI_CLIP_TYPE_PATH  | 路径类型。  |
2123
2124
2125### ArkUI_ColorMode
2126
2127```
2128enum ArkUI_ColorMode
2129```
2130**描述:**
2131
2132定义深浅色模式。
2133
2134**起始版本:** 12
2135
2136| 枚举值 | 描述 |
2137| -------- | -------- |
2138| ARKUI_COLOR_MODE_SYSTEM  | 跟随系统深浅色模式。  |
2139| ARKUI_COLOR_MODE_LIGHT  | 固定使用浅色模式。  |
2140| ARKUI_COLOR_MODE_DARK  | 固定使用深色模式。  |
2141
2142
2143### ArkUI_ColorStrategy
2144
2145```
2146enum ArkUI_ColorStrategy
2147```
2148**描述:**
2149
2150前景色枚举值。
2151
2152**起始版本:** 12
2153
2154| 枚举值 | 描述 |
2155| -------- | -------- |
2156| ARKUI_COLOR_STRATEGY_INVERT  | 前景色为控件背景色的反色。  |
2157| ARKUI_COLOR_STRATEGY_AVERAGE  | 控件背景阴影色为控件背景阴影区域的平均色。  |
2158| ARKUI_COLOR_STRATEGY_PRIMARY  | 控件背景阴影色为控件背景阴影区域的主色。  |
2159
2160
2161### ArkUI_CopyOptions
2162
2163```
2164enum ArkUI_CopyOptions
2165```
2166**描述:**
2167
2168定义文本复制黏贴模式枚举值。
2169
2170**起始版本:** 12
2171
2172| 枚举值 | 描述 |
2173| -------- | -------- |
2174| ARKUI_COPY_OPTIONS_NONE  | 不支持复制。  |
2175| ARKUI_COPY_OPTIONS_IN_APP  | 支持应用内复制。  |
2176| ARKUI_COPY_OPTIONS_LOCAL_DEVICE  | 支持设备内复制。  |
2177| ARKUI_COPY_OPTIONS_CROSS_DEVICE  | 支持跨设备复制。  |
2178
2179
2180### ArkUI_ContentClipMode
2181
2182```
2183enum ArkUI_ContentClipMode
2184```
2185**描述:**
2186
2187定义滚动容器的内容层裁剪区域枚举值。
2188
2189**起始版本:** 18
2190
2191| 枚举值 | 描述 |
2192| -------- | -------- |
2193| ARKUI_CONTENT_CLIP_MODE_CONTENT_ONLY  | 按内容区裁剪。  |
2194| ARKUI_CONTENT_CLIP_MODE_BOUNDARY  | 按组件区域裁剪。  |
2195| ARKUI_CONTENT_CLIP_MODE_SAFE_AREA  | 按组件配置的SafeArea区域裁剪。  |
2196
2197
2198### ArkUI_Direction
2199
2200```
2201enum ArkUI_Direction
2202```
2203**描述:**
2204
2205设置容器元素内主轴方向上的布局枚举值。
2206
2207**起始版本:** 12
2208
2209| 枚举值 | 描述 |
2210| -------- | -------- |
2211| ARKUI_DIRECTION_LTR  | 元素从左到右布局。  |
2212| ARKUI_DIRECTION_RTL  | 元素从右到左布局。  |
2213| ARKUI_DIRECTION_AUTO  | 使用系统默认布局方向。  |
2214
2215
2216### ArkUI_DismissReason
2217
2218```
2219enum ArkUI_DismissReason
2220```
2221**描述:**
2222
2223弹窗关闭的触发方式。
2224
2225**起始版本:** 12
2226
2227| 枚举值 | 描述 |
2228| -------- | -------- |
2229| DIALOG_DISMISS_BACK_PRESS  | 系统定义的返回操作、键盘ESC触发。  |
2230| DIALOG_DISMISS_TOUCH_OUTSIDE  | 点击遮障层触发。  |
2231| DIALOG_DISMISS_CLOSE_BUTTON  | 点击关闭按钮。  |
2232| DIALOG_DISMISS_SLIDE_DOWN  | 下拉关闭。  |
2233
2234
2235### ArkUI_LevelMode
2236
2237```
2238enum ArkUI_LevelMode
2239```
2240**描述:**
2241
2242设置弹窗显示层级。
2243
2244**起始版本:** 15
2245
2246| 枚举值 | 描述 |
2247| -------- | -------- |
2248| ARKUI_LEVEL_MODE_OVERLAY  | 显示在应用最上层。  |
2249| ARKUI_LEVEL_MODE_EMBEDDED  | 嵌入式显示在应用的页面内。  |
2250
2251### ArkUI_ImmersiveMode
2252
2253```
2254enum ArkUI_ImmersiveMode
2255```
2256**描述:**
2257
2258指定嵌入式弹窗的蒙层覆盖区域。
2259
2260**起始版本:** 15
2261
2262| 枚举值 | 描述 |
2263| -------- | -------- |
2264| ARKUI_IMMERSIVE_MODE_DEFAULT  | 弹窗蒙层按照显示页面给定的布局约束显示。  |
2265| ARKUI_IMMERSIVE_MODE_EXTEND  | 弹窗蒙层可扩展至覆盖状态栏和导航条。  |
2266
2267### ArkUI_DragPreviewScaleMode
2268
2269```
2270enum ArkUI_DragPreviewScaleMode
2271```
2272**描述:**
2273
2274拖拽预览缩放模式。
2275
2276**起始版本:** 12
2277
2278| 枚举值 | 描述 |
2279| -------- | -------- |
2280| ARKUI_DRAG_PREVIEW_SCALE_AUTO  | 系统根据拖拽场景自动改变跟手点位置,根据规则自动对拖拽背板图进行缩放变换等。  |
2281| ARKUI_DRAG_PREVIEW_SCALE_DISABLED  | 禁用系统对拖拽背板图的缩放行为。  |
2282
2283
2284### ArkUI_DragResult
2285
2286```
2287enum ArkUI_DragResult
2288```
2289**描述:**
2290
2291拖拽结果定义,由数据接收方设置,并由系统传递给数据拖出方,拖出方可感知接收方对数据的处理结果。
2292
2293**起始版本:** 12
2294
2295| 枚举值 | 描述 |
2296| -------- | -------- |
2297| ARKUI_DRAG_RESULT_SUCCESSFUL  | 拖拽处理成功。  |
2298| ARKUI_DRAG_RESULT_FAILED  | 拖拽处理失败。  |
2299| ARKUI_DRAG_RESULT_CANCELED  | 拖拽处理取消。  |
2300
2301
2302### ArkUI_DragStatus
2303
2304```
2305enum ArkUI_DragStatus
2306```
2307**描述:**
2308
2309拖拽状态。
2310
2311**起始版本:** 12
2312
2313| 枚举值 | 描述 |
2314| -------- | -------- |
2315| ArkUI_DRAG_STATUS_UNKNOWN  | Unknown。  |
2316| ArkUI_DRAG_STATUS_STARTED  | Started。  |
2317| ArkUI_DRAG_STATUS_ENDED  | Ended。  |
2318
2319
2320### ArkUI_DropOperation
2321
2322```
2323enum ArkUI_DropOperation
2324```
2325**描述:**
2326
2327定义拖拽释放时的数据处理方式,可影响角标的显示。
2328
2329**起始版本:** 12
2330
2331| 枚举值 | 描述 |
2332| -------- | -------- |
2333| ARKUI_DROP_OPERATION_COPY  | 复制行为。  |
2334| ARKUI_DROP_OPERATION_MOVE  | 剪切行为。  |
2335
2336
2337### ArkUI_EdgeEffect
2338
2339```
2340enum ArkUI_EdgeEffect
2341```
2342**描述:**
2343
2344定义边缘滑动效果枚举值。
2345
2346**起始版本:** 12
2347
2348| 枚举值 | 描述 |
2349| -------- | -------- |
2350| ARKUI_EDGE_EFFECT_SPRING  | 弹性物理动效,滑动到边缘后可以根据初始速度或通过触摸事件继续滑动一段距离,松手后回弹。  |
2351| ARKUI_EDGE_EFFECT_FADE  | 阴影效果,滑动到边缘后会有圆弧状的阴影。  |
2352| ARKUI_EDGE_EFFECT_NONE  | 滑动到边缘后无效果。  |
2353
2354
2355### ArkUI_EffectEdge
2356
2357```
2358enum ArkUI_EffectEdge
2359```
2360**描述:**
2361
2362定义边缘效果生效边缘的方向枚举值。
2363
2364**起始版本:** 18
2365
2366| 枚举值 | 描述 |
2367| -------- | -------- |
2368| ARKUI_EFFECT_EDGE_START  | 起始边生效。  |
2369| ARKUI_EFFECT_EDGE_END  | 末尾边生效。  |
2370
2371
2372### ArkUI_EllipsisMode
2373
2374```
2375enum ArkUI_EllipsisMode
2376```
2377**描述:**
2378
2379定义文本省略位置。
2380
2381**起始版本:** 12
2382
2383| 枚举值 | 描述 |
2384| -------- | -------- |
2385| ARKUI_ELLIPSIS_MODE_START  | 省略行首内容。  |
2386| ARKUI_ELLIPSIS_MODE_CENTER  | 省略行中内容。  |
2387| ARKUI_ELLIPSIS_MODE_END  | 省略行末内容。  |
2388
2389
2390### ArkUI_EnterKeyType
2391
2392```
2393enum ArkUI_EnterKeyType
2394```
2395**描述:**
2396
2397定义单行文本输入法回车键类型枚举值。
2398
2399**起始版本:** 12
2400
2401| 枚举值 | 描述 |
2402| -------- | -------- |
2403| ARKUI_ENTER_KEY_TYPE_GO  | 显示为开始样式。  |
2404| ARKUI_ENTER_KEY_TYPE_SEARCH  | 显示为搜索样式。  |
2405| ARKUI_ENTER_KEY_TYPE_SEND  | 显示为发送样式。  |
2406| ARKUI_ENTER_KEY_TYPE_NEXT  | 显示为下一个样式。  |
2407| ARKUI_ENTER_KEY_TYPE_DONE  | 显示为完成样式。  |
2408| ARKUI_ENTER_KEY_TYPE_PREVIOUS  | 显示为上一个样式。  |
2409| ARKUI_ENTER_KEY_TYPE_NEW_LINE  | 显示为换行样式。  |
2410
2411
2412### ArkUI_ErrorCode
2413
2414```
2415enum ArkUI_ErrorCode
2416```
2417**描述:**
2418
2419定义错误码枚举值。
2420
2421**起始版本:** 12
2422
2423| 枚举值 | 描述 |
2424| -------- | -------- |
2425| ARKUI_ERROR_CODE_NO_ERROR  | 无错误。  |
2426| ARKUI_ERROR_CODE_PARAM_INVALID  | 参数错误。  |
2427| ARKUI_ERROR_CODE_CAPI_INIT_ERROR  | 接口初始化错误。<br/>起始版本:18  |
2428| ARKUI_ERROR_CODE_INTERNAL_ERROR  | 出现内部错误,例如内部环境错误导致失败,或者由于内部执行失败导致操作失败。<br/>起始版本:15  |
2429| ARKUI_ERROR_CODE_XCOMPONENT_STATE_INVALID  | XComponent组件处于非法状态。<br/>起始版本:18  |
2430| ARKUI_ERROR_CODE_ATTRIBUTE_OR_EVENT_NOT_SUPPORTED  | 组件不支持特定的属性或者事件。  |
2431| ARKUI_ERROR_CODE_ARKTS_NODE_NOT_SUPPORTED  | 对应的操作不支持ArkTS创建的节点。  |
2432| ARKUI_ERROR_CODE_ADAPTER_NOT_BOUND  | 懒加载适配器未绑定到组件上。  |
2433| ARKUI_ERROR_CODE_ADAPTER_EXIST  | 适配器已存在。  |
2434| ARKUI_ERROR_CODE_CHILD_NODE_EXIST  | 对应节点已存在子节点,无法添加适配器。  |
2435| ARKUI_ERROR_CODE_NODE_EVENT_PARAM_INDEX_OUT_OF_RANGE  | 组件事件中参数长度超限。  |
2436| ARKUI_ERROR_CODE_NODE_EVENT_PARAM_INVALID  | 组件事件中不存在该数据。  |
2437| ARKUI_ERROR_CODE_NODE_EVENT_NO_RETURN  | 组件事件不支持返回值。  |
2438| ARKUI_ERROR_CODE_NODE_INDEX_INVALID  | 传入的索引值非法。  |
2439| ARKUI_ERROR_CODE_GET_INFO_FAILED  | 查询路由导航信息失败。  |
2440| ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR  | 传入的buffer size异常。  |
2441| ARKUI_ERROR_CODE_NODE_NOT_ON_MAIN_TREE  | 传入的节点未挂载到组件树上。<br/>起始版本:15  |
2442| ARKUI_ERROR_CODE_FOCUS_NON_FOCUSABLE  | 当前节点无法获得焦点。<br/>起始版本:15  |
2443| ARKUI_ERROR_CODE_FOCUS_NON_FOCUSABLE_ANCESTOR  | 当前节点对应的祖先节点中存在无法获焦节点。<br/>起始版本:15  |
2444| ARKUI_ERROR_CODE_FOCUS_NON_EXISTENT>  | 当前节点不存在。<br/>起始版本:15  |
2445| ARKUI_ERROR_CODE_COMPONENT_SNAPSHOT_TIMEOUT  | 截图超时。<br/>起始版本:15  |
2446| ARKUI_ERROR_CODE_NON_SCROLLABLE_CONTAINER  | 非滚动类容器。  |
2447| ARKUI_ERROR_CODE_BUFFER_SIZE_NOT_ENOUGH  | 存储区大小不足。  |
2448| ARKUI_ERROR_CODE_NOT_CLONED_POINTER_EVENT  | 该事件不是克隆事件。<br/>起始版本:15  |
2449| ARKUI_ERROR_CODE_POST_CLONED_COMPONENT_STATUS_ABNORMAL  | 组件状态异常。<br/>起始版本:15  |
2450| ARKUI_ERROR_CODE_POST_CLONED_NO_COMPONENT_HIT_TO_RESPOND_TO_THE_EVENT  | 未命中可响应事件的组件。<br/>起始版本:15  |
2451| ARKUI_ERROR_CODE_INVALID_STYLED_STRING  | 无效的属性字符串。<br/>起始版本:14  |
2452| ARKUI_ERROR_CODE_UI_CONTEXT_INVALID  | 无效的UIContext对象。<br/>起始版本:18  |
2453| ARKUI_ERROR_CODE_CALLBACK_INVALID  | 无效的回调函数。<br/>起始版本:18  |
2454| ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED  | 不支持手势识别器类型。<br/>起始版本:18  |
2455| ARKUI_ERROR_CODE_DRAG_DROP_OPERATION_NOT_ALLOWED  | 当前阶段不允许该操作。<br/>起始版本:18  |
2456
2457
2458### ArkUI_FinishCallbackType
2459
2460```
2461enum ArkUI_FinishCallbackType
2462```
2463**描述:**
2464
2465在动画中定义onFinish回调的类型。
2466
2467**起始版本:** 12
2468
2469| 枚举值 | 描述 |
2470| -------- | -------- |
2471| ARKUI_FINISH_CALLBACK_REMOVED  | 当整个动画结束并立即删除时,将触发回调。  |
2472| ARKUI_FINISH_CALLBACK_LOGICALLY  | 当动画在逻辑上处于下降状态,但可能仍处于其长尾状态时,将触发回调。  |
2473
2474
2475### ArkUI_FlexAlignment
2476
2477```
2478enum ArkUI_FlexAlignment
2479```
2480**描述:**
2481
2482定义垂直方向对齐方式。
2483
2484**起始版本:** 12
2485
2486| 枚举值 | 描述 |
2487| -------- | -------- |
2488| ARKUI_FLEX_ALIGNMENT_START  | 主轴方向首端对齐。  |
2489| ARKUI_FLEX_ALIGNMENT_CENTER  | 主轴方向中心对齐。  |
2490| ARKUI_FLEX_ALIGNMENT_END  | 主轴方向尾部对齐。  |
2491| ARKUI_FLEX_ALIGNMENT_SPACE_BETWEEN  | Flex主轴方向均匀分配弹性元素,相邻元素之间距离相同,第一个元素行首对齐,最后的元素行尾对齐。  |
2492| ARKUI_FLEX_ALIGNMENT_SPACE_AROUND  | Flex主轴方向均匀分配弹性元素,相邻元素之间距离相同,第一个元素到行首的距离时相邻元素间距离的一半。  |
2493| ARKUI_FLEX_ALIGNMENT_SPACE_EVENLY  | Flex主轴方向均匀分配弹性元素,相邻元素之间距离、第一个元素到行首的距离和最后的元素到行尾的距离均相等。  |
2494
2495
2496### ArkUI_FlexDirection
2497
2498```
2499enum ArkUI_FlexDirection
2500```
2501**描述:**
2502
2503定义Flex容器的主轴方向。
2504
2505**起始版本:** 12
2506
2507| 枚举值 | 描述 |
2508| -------- | -------- |
2509| ARKUI_FLEX_DIRECTION_ROW  | 主轴与行方向一致。  |
2510| ARKUI_FLEX_DIRECTION_COLUMN  | 主轴与列方向一致。  |
2511| ARKUI_FLEX_DIRECTION_ROW_REVERSE  | 主轴与行方向相反。  |
2512| ARKUI_FLEX_DIRECTION_COLUMN_REVERSE  | 主轴与列方向相反。  |
2513
2514
2515### ArkUI_FlexWrap
2516
2517```
2518enum ArkUI_FlexWrap
2519```
2520**描述:**
2521
2522定义Flex行列布局模式模式。
2523
2524**起始版本:** 12
2525
2526| 枚举值 | 描述 |
2527| -------- | -------- |
2528| ARKUI_FLEX_WRAP_NO_WRAP  | 单行/单列布局,子项不能超出容器。  |
2529| ARKUI_FLEX_WRAP_WRAP  | 多行/多列布局,子项允许超出容器。  |
2530| ARKUI_FLEX_WRAP_WRAP_REVERSE  | 反向多行/多列布局,子项允许超出容器。  |
2531
2532
2533### ArkUI_FontStyle
2534
2535```
2536enum ArkUI_FontStyle
2537```
2538**描述:**
2539
2540定义字体样式枚举值。
2541
2542**起始版本:** 12
2543
2544| 枚举值 | 描述 |
2545| -------- | -------- |
2546| ARKUI_FONT_STYLE_NORMAL  | 标准字体样式。  |
2547| ARKUI_FONT_STYLE_ITALIC  | 斜体字体样式。  |
2548
2549
2550### ArkUI_FontWeight
2551
2552```
2553enum ArkUI_FontWeight
2554```
2555**描述:**
2556
2557定义字体粗细/字重枚举值。
2558
2559**起始版本:** 12
2560
2561| 枚举值 | 描述 |
2562| -------- | -------- |
2563| ARKUI_FONT_WEIGHT_W100  | 100  |
2564| ARKUI_FONT_WEIGHT_W200  | 200  |
2565| ARKUI_FONT_WEIGHT_W300  | 300  |
2566| ARKUI_FONT_WEIGHT_W400  | 400  |
2567| ARKUI_FONT_WEIGHT_W500  | 500  |
2568| ARKUI_FONT_WEIGHT_W600  | 600  |
2569| ARKUI_FONT_WEIGHT_W700  | 700  |
2570| ARKUI_FONT_WEIGHT_W800  | 800  |
2571| ARKUI_FONT_WEIGHT_W900  | 900  |
2572| ARKUI_FONT_WEIGHT_BOLD  | 字体较粗。  |
2573| ARKUI_FONT_WEIGHT_NORMAL  | 字体粗细正常。  |
2574| ARKUI_FONT_WEIGHT_BOLDER  | 字体非常粗。  |
2575| ARKUI_FONT_WEIGHT_LIGHTER  | 字体较细。  |
2576| ARKUI_FONT_WEIGHT_MEDIUM  | 字体粗细适中。  |
2577| ARKUI_FONT_WEIGHT_REGULAR  | 字体粗细正常。  |
2578
2579
2580### ArkUI_GestureDirection
2581
2582```
2583enum ArkUI_GestureDirection
2584```
2585**描述:**
2586
2587定义滑动手势方向。
2588
2589**起始版本:** 12
2590
2591| 枚举值 | 描述 |
2592| -------- | -------- |
2593| GESTURE_DIRECTION_ALL  | 所有方向。  |
2594| GESTURE_DIRECTION_HORIZONTAL  | 水平方向。  |
2595| GESTURE_DIRECTION_VERTICAL  | 竖直方向。  |
2596| GESTURE_DIRECTION_LEFT  | 向左方向。  |
2597| GESTURE_DIRECTION_RIGHT  | 向右方向。  |
2598| GESTURE_DIRECTION_UP  | 向上方向。  |
2599| GESTURE_DIRECTION_DOWN  | 向下方向。  |
2600| GESTURE_DIRECTION_NONE  | 任何方向都不触发手势事件。  |
2601
2602
2603### ArkUI_GestureEventActionType
2604
2605```
2606enum ArkUI_GestureEventActionType
2607```
2608**描述:**
2609
2610定义手势事件类型。
2611
2612**起始版本:** 12
2613
2614| 枚举值 | 描述 |
2615| -------- | -------- |
2616| GESTURE_EVENT_ACTION_ACCEPT  | 手势事件触发。  |
2617| GESTURE_EVENT_ACTION_UPDATE  | 手势事件更新。  |
2618| GESTURE_EVENT_ACTION_END  | 手势事件结束。  |
2619| GESTURE_EVENT_ACTION_CANCEL  | 手势事件取消。  |
2620
2621
2622### ArkUI_GestureInterruptResult
2623
2624```
2625enum ArkUI_GestureInterruptResult
2626```
2627**描述:**
2628
2629定义手势打断结果。
2630
2631**起始版本:** 12
2632
2633| 枚举值 | 描述 |
2634| -------- | -------- |
2635| GESTURE_INTERRUPT_RESULT_CONTINUE  | 手势继续。  |
2636| GESTURE_INTERRUPT_RESULT_REJECT  | 手势打断。  |
2637
2638
2639### ArkUI_GestureMask
2640
2641```
2642enum ArkUI_GestureMask
2643```
2644**描述:**
2645
2646定义手势屏蔽模式。
2647
2648**起始版本:** 12
2649
2650| 枚举值 | 描述 |
2651| -------- | -------- |
2652| NORMAL_GESTURE_MASK  | 不屏蔽子组件的手势,按照默认手势识别顺序进行识别。  |
2653| IGNORE_INTERNAL_GESTURE_MASK  | 屏蔽子组件的手势,包括子组件上系统内置的手势。  |
2654
2655
2656### ArkUI_GesturePriority
2657
2658```
2659enum ArkUI_GesturePriority
2660```
2661**描述:**
2662
2663定义手势事件模式。
2664
2665**起始版本:** 12
2666
2667| 枚举值 | 描述 |
2668| -------- | -------- |
2669| NORMAL  | 正常手势。  |
2670| PRIORITY  | 高优先级手势。  |
2671| PARALLEL  | 并发手势。  |
2672
2673
2674### ArkUI_GestureRecognizerState
2675
2676```
2677enum ArkUI_GestureRecognizerState
2678```
2679**描述:**
2680
2681定义手势识别器状态。
2682
2683**起始版本:** 12
2684
2685| 枚举值 | 描述 |
2686| -------- | -------- |
2687| ARKUI_GESTURE_RECOGNIZER_STATE_READY  | 准备状态。  |
2688| ARKUI_GESTURE_RECOGNIZER_STATE_DETECTING  | 检测状态。  |
2689| ARKUI_GESTURE_RECOGNIZER_STATE_PENDING  | 等待状态。  |
2690| ARKUI_GESTURE_RECOGNIZER_STATE_BLOCKED  | 阻塞状态。  |
2691| ARKUI_GESTURE_RECOGNIZER_STATE_SUCCESSFUL  | 成功状态。  |
2692| ARKUI_GESTURE_RECOGNIZER_STATE_FAILED  | 失败状态。  |
2693
2694
2695### ArkUI_GestureRecognizerType
2696
2697```
2698enum ArkUI_GestureRecognizerType
2699```
2700**描述:**
2701
2702定义手势类型。
2703
2704**起始版本:** 12
2705
2706| 枚举值 | 描述 |
2707| -------- | -------- |
2708| TAP_GESTURE  | 敲击手势。  |
2709| LONG_PRESS_GESTURE  | 长按手势。  |
2710| PAN_GESTURE  | 拖动手势。  |
2711| PINCH_GESTURE  | 捏合手势。  |
2712| ROTATION_GESTURE  | 旋转手势。  |
2713| SWIPE_GESTURE  | 滑动手势。  |
2714| GROUP_GESTURE  | 手势组合。  |
2715
2716
2717### ArkUI_GroupGestureMode
2718
2719```
2720enum ArkUI_GroupGestureMode
2721```
2722**描述:**
2723
2724定义手势组事件模式。
2725
2726**起始版本:** 12
2727
2728| 枚举值 | 描述 |
2729| -------- | -------- |
2730| SEQUENTIAL_GROUP  | 顺序手势模式,按照注册顺序识别手势,直到所有手势识别成功。若有识别失败,后续识别均失败。仅有最后一个手势响应结束事件。  |
2731| PARALLEL_GROUP  | 并发手势模式,注册的手势同时识别,直到所有手势识别结束,手势识别互相不影响。  |
2732| EXCLUSIVE_GROUP  | 互斥手势模式,注册的手势同时识别,若有一个手势识别成功,则结束手势识别。  |
2733
2734
2735### ArkUI_HitTestMode
2736
2737```
2738enum ArkUI_HitTestMode
2739```
2740**描述:**
2741
2742触摸测试控制枚举值。
2743
2744**起始版本:** 12
2745
2746| 枚举值 | 描述 |
2747| -------- | -------- |
2748| ARKUI_HIT_TEST_MODE_DEFAULT  | 默认触摸测试效果。  |
2749| ARKUI_HIT_TEST_MODE_BLOCK  | 自身响应触摸测试。  |
2750| ARKUI_HIT_TEST_MODE_TRANSPARENT  | 自身和子节点都响应触摸测试。  |
2751| ARKUI_HIT_TEST_MODE_NONE  | 自身不响应触摸测试。  |
2752
2753
2754### ArkUI_HorizontalAlignment
2755
2756```
2757enum ArkUI_HorizontalAlignment
2758```
2759**描述:**
2760
2761定义语言方向对齐方式。
2762
2763**起始版本:** 12
2764
2765| 枚举值 | 描述 |
2766| -------- | -------- |
2767| ARKUI_HORIZONTAL_ALIGNMENT_START  | 按照语言方向起始端对齐。  |
2768| ARKUI_HORIZONTAL_ALIGNMENT_CENTER  | 居中对齐,默认对齐方式。  |
2769| ARKUI_HORIZONTAL_ALIGNMENT_END  | 按照语言方向末端对齐。  |
2770
2771
2772### ArkUI_ImageInterpolation
2773
2774```
2775enum ArkUI_ImageInterpolation
2776```
2777**描述:**
2778
2779定义图片插值效果。
2780
2781**起始版本:** 12
2782
2783| 枚举值 | 描述 |
2784| -------- | -------- |
2785| ARKUI_IMAGE_INTERPOLATION_NONE  | 不使用图片插值。  |
2786| ARKUI_IMAGE_INTERPOLATION_LOW  | 低图片插值。  |
2787| ARKUI_IMAGE_INTERPOLATION_MEDIUM  | 中图片插值。  |
2788| ARKUI_IMAGE_INTERPOLATION_HIGH  | 高图片插值,插值质量最高。  |
2789
2790
2791### ArkUI_ImageRenderMode
2792
2793```
2794enum ArkUI_ImageRenderMode
2795```
2796**描述:**
2797
2798定义图片渲染模式。
2799
2800**起始版本:** 12
2801
2802| 枚举值 | 描述 |
2803| -------- | -------- |
2804| ARKUI_IMAGE_RENDER_MODE_ORIGINAL  | 原色渲染模式。  |
2805| ARKUI_IMAGE_RENDER_MODE_TEMPLATE  | 黑白渲染模式。  |
2806
2807
2808### ArkUI_ImageRepeat
2809
2810```
2811enum ArkUI_ImageRepeat
2812```
2813**描述:**
2814
2815定义图片重复铺设枚举值。
2816
2817**起始版本:** 12
2818
2819| 枚举值 | 描述 |
2820| -------- | -------- |
2821| ARKUI_IMAGE_REPEAT_NONE  | 不重复。  |
2822| ARKUI_IMAGE_REPEAT_X  | 在X轴方向重复。  |
2823| ARKUI_IMAGE_REPEAT_Y  | 在Y轴方向重复。  |
2824| ARKUI_IMAGE_REPEAT_XY  | 在X轴和Y轴方向重复。  |
2825
2826
2827### ArkUI_ImageSize
2828
2829```
2830enum ArkUI_ImageSize
2831```
2832**描述:**
2833
2834定义图片宽高样式。
2835
2836**起始版本:** 12
2837
2838| 枚举值 | 描述 |
2839| -------- | -------- |
2840| ARKUI_IMAGE_SIZE_AUTO  | 默认值,保持原图的比例不变。  |
2841| ARKUI_IMAGE_SIZE_COVER  | 保持宽高比进行缩小或者放大,使得图片两边都大于或等于显示边界。  |
2842| ARKUI_IMAGE_SIZE_CONTAIN  | 保持宽高比进行缩小或者放大,使得图片完全显示在显示边界内。  |
2843
2844
2845### ArkUI_ImageSpanAlignment
2846
2847```
2848enum ArkUI_ImageSpanAlignment
2849```
2850**描述:**
2851
2852定义图片基于文本的对齐方式。
2853
2854**起始版本:** 12
2855
2856| 枚举值 | 描述 |
2857| -------- | -------- |
2858| ARKUI_IMAGE_SPAN_ALIGNMENT_BASELINE  | 图片下边沿与文本BaseLine对齐。  |
2859| ARKUI_IMAGE_SPAN_ALIGNMENT_BOTTOM  | 图片下边沿与文本下边沿对齐。  |
2860| ARKUI_IMAGE_SPAN_ALIGNMENT_CENTER  | 图片中间与文本中间对齐。  |
2861| ARKUI_IMAGE_SPAN_ALIGNMENT_TOP  | 图片上边沿与文本上边沿对齐。  |
2862
2863
2864### ArkUI_ItemAlignment
2865
2866```
2867enum ArkUI_ItemAlignment
2868```
2869**描述:**
2870
2871设置子组件在父容器交叉轴的对齐格式枚举值。
2872
2873**起始版本:** 12
2874
2875| 枚举值 | 描述 |
2876| -------- | -------- |
2877| ARKUI_ITEM_ALIGNMENT_AUTO  | 使用Flex容器中默认配置。  |
2878| ARKUI_ITEM_ALIGNMENT_START  | 元素在Flex容器中,交叉轴方向首部对齐。  |
2879| ARKUI_ITEM_ALIGNMENT_CENTER  | 元素在Flex容器中,交叉轴方向居中对齐。  |
2880| ARKUI_ITEM_ALIGNMENT_END  | 元素在Flex容器中,交叉轴方向底部对齐。  |
2881| ARKUI_ITEM_ALIGNMENT_STRETCH  | 元素在Flex容器中,交叉轴方向拉伸填充。  |
2882| ARKUI_ITEM_ALIGNMENT_BASELINE  | 元素在Flex容器中,交叉轴方向文本基线对齐。  |
2883
2884
2885### ArkUI_KeyCode
2886
2887```
2888enum ArkUI_KeyCode
2889```
2890**描述:**
2891
2892按键事件的键码
2893
2894**起始版本:** 14
2895
2896| 枚举值 | 描述 |
2897| -------- | -------- |
2898| ARKUI_KEYCODE_UNKNOWN  | 未知按键  |
2899| ARKUI_KEYCODE_FN  | 功能(Fn)键  |
2900| ARKUI_KEYCODE_VOLUME_UP  | 音量增加键  |
2901| ARKUI_KEYCODE_VOLUME_DOWN  | 音量减小键  |
2902| ARKUI_KEYCODE_POWER  | 电源键  |
2903| ARKUI_KEYCODE_CAMERA  | 拍照键  |
2904| ARKUI_KEYCODE_VOLUME_MUTE  | 扬声器静音键  |
2905| ARKUI_KEYCODE_MUTE  | 话筒静音键  |
2906| ARKUI_KEYCODE_BRIGHTNESS_UP  | 亮度调节按键 调亮  |
2907| ARKUI_KEYCODE_BRIGHTNESS_DOWN  | 亮度调节按键 调暗  |
2908| ARKUI_KEYCODE_0  | 按键'0'  |
2909| ARKUI_KEYCODE_1  | 按键'1'  |
2910| ARKUI_KEYCODE_2  | 按键'2'  |
2911| ARKUI_KEYCODE_3  | 按键'3'  |
2912| ARKUI_KEYCODE_4  | 按键'4'  |
2913| ARKUI_KEYCODE_5  | 按键'5'  |
2914| ARKUI_KEYCODE_6  | 按键'6'  |
2915| ARKUI_KEYCODE_7  | 按键'7'  |
2916| ARKUI_KEYCODE_8  | 按键'8'  |
2917| ARKUI_KEYCODE_9  | 按键'9'  |
2918| ARKUI_KEYCODE_STAR  | 按键'\*'  |
2919| ARKUI_KEYCODE_POUND  | 按键'\#'  |
2920| ARKUI_KEYCODE_DPAD_UP  | 导航键 向上  |
2921| ARKUI_KEYCODE_DPAD_DOWN  | 导航键 向下  |
2922| ARKUI_KEYCODE_DPAD_LEFT  | 导航键 向左  |
2923| ARKUI_KEYCODE_DPAD_RIGHT  | 导航键 向右  |
2924| ARKUI_KEYCODE_DPAD_CENTER  | 导航键 确定键  |
2925| ARKUI_KEYCODE_A  | 按键'A'  |
2926| ARKUI_KEYCODE_B  | 按键'B'  |
2927| ARKUI_KEYCODE_C  | 按键'C'  |
2928| ARKUI_KEYCODE_D  | 按键'D'  |
2929| ARKUI_KEYCODE_E  | 按键'E'  |
2930| ARKUI_KEYCODE_F  | 按键'F'  |
2931| ARKUI_KEYCODE_G  | 按键'G'  |
2932| ARKUI_KEYCODE_H  | 按键'H'  |
2933| ARKUI_KEYCODE_I  | 按键'I'  |
2934| ARKUI_KEYCODE_J  | 按键'J'  |
2935| ARKUI_KEYCODE_K  | 按键'K'  |
2936| ARKUI_KEYCODE_L  | 按键'L'  |
2937| ARKUI_KEYCODE_M  | 按键'M'  |
2938| ARKUI_KEYCODE_N  | 按键'N'  |
2939| ARKUI_KEYCODE_O  | 按键'O'  |
2940| ARKUI_KEYCODE_P  | 按键'P'  |
2941| ARKUI_KEYCODE_Q  | 按键'R'  |
2942| ARKUI_KEYCODE_R  | 按键'R'  |
2943| ARKUI_KEYCODE_S  | 按键'S'  |
2944| ARKUI_KEYCODE_T  | 按键'T'  |
2945| ARKUI_KEYCODE_U  | 按键'U'  |
2946| ARKUI_KEYCODE_V  | 按键'V'  |
2947| ARKUI_KEYCODE_W  | 按键'W'  |
2948| ARKUI_KEYCODE_X  | 按键'X'  |
2949| ARKUI_KEYCODE_Y  | 按键'Y'  |
2950| ARKUI_KEYCODE_Z  | 按键'Z'  |
2951| ARKUI_KEYCODE_COMMA  | 按键','  |
2952| ARKUI_KEYCODE_PERIOD  | 按键'.'  |
2953| ARKUI_KEYCODE_ALT_LEFT  | 左Alt键  |
2954| ARKUI_KEYCODE_ALT_RIGHT  | 右Alt键  |
2955| ARKUI_KEYCODE_SHIFT_LEFT  | 左Shift键  |
2956| ARKUI_KEYCODE_SHIFT_RIGHT  | 右Shift键  |
2957| ARKUI_KEYCODE_TAB  | Tab键  |
2958| ARKUI_KEYCODE_SPACE  | 空格键  |
2959| ARKUI_KEYCODE_SYM  | 符号修改器按键  |
2960| ARKUI_KEYCODE_EXPLORER  | 浏览器功能键,此键用于启动浏览器应用程序。  |
2961| ARKUI_KEYCODE_ENVELOPE  | 电子邮件功能键,此键用于启动电子邮件应用程序。  |
2962| ARKUI_KEYCODE_ENTER  | 回车键  |
2963| ARKUI_KEYCODE_DEL  | 退格键  |
2964| ARKUI_KEYCODE_GRAVE  | 按键'‘’  |
2965| ARKUI_KEYCODE_MINUS  | 按键'-'  |
2966| ARKUI_KEYCODE_EQUALS  | 按键'='  |
2967| ARKUI_KEYCODE_LEFT_BRACKET  | 按键'['  |
2968| ARKUI_KEYCODE_RIGHT_BRACKET  | 按键']'  |
2969| ARKUI_KEYCODE_BACKSLASH  | 按键'\'  |
2970| ARKUI_KEYCODE_SEMICOLON  | 按键';'  |
2971| ARKUI_KEYCODE_APOSTROPHE  | 按键''' (单引号)  |
2972| ARKUI_KEYCODE_SLASH  | 按键'/'  |
2973| ARKUI_KEYCODE_AT  | 按键'\@'  |
2974| ARKUI_KEYCODE_PLUS  | 按键'+'  |
2975| ARKUI_KEYCODE_MENU  | 菜单键  |
2976| ARKUI_KEYCODE_PAGE_UP  | 向上翻页键  |
2977| ARKUI_KEYCODE_PAGE_DOWN  | 向下翻页键  |
2978| ARKUI_KEYCODE_ESCAPE  | ESC键  |
2979| ARKUI_KEYCODE_FORWARD_DEL  | 删除键  |
2980| ARKUI_KEYCODE_CTRL_LEFT  | 左Ctrl键  |
2981| ARKUI_KEYCODE_CTRL_RIGHT  | 右Ctrl键  |
2982| ARKUI_KEYCODE_CAPS_LOCK  | 大写锁定键  |
2983| ARKUI_KEYCODE_SCROLL_LOCK  | 滚动锁定键  |
2984| ARKUI_KEYCODE_META_LEFT  | 左元修改器键  |
2985| ARKUI_KEYCODE_META_RIGHT  | 右元修改器键  |
2986| ARKUI_KEYCODE_FUNCTION  | 功能键  |
2987| ARKUI_KEYCODE_SYSRQ  | 系统请求/打印屏幕键  |
2988| ARKUI_KEYCODE_BREAK  | Break/Pause键  |
2989| ARKUI_KEYCODE_MOVE_HOME  | 光标移动到开始键  |
2990| ARKUI_KEYCODE_MOVE_END  | 光标移动到末尾键  |
2991| ARKUI_KEYCODE_INSERT  | 插入键  |
2992| ARKUI_KEYCODE_FORWARD  | 前进键  |
2993| ARKUI_KEYCODE_MEDIA_PLAY  | 多媒体键 播放  |
2994| ARKUI_KEYCODE_MEDIA_PAUSE  | 多媒体键 暂停  |
2995| ARKUI_KEYCODE_MEDIA_CLOSE  | 多媒体键 关闭  |
2996| ARKUI_KEYCODE_MEDIA_EJECT  | 多媒体键 弹出  |
2997| ARKUI_KEYCODE_MEDIA_RECORD  | 多媒体键 录音  |
2998| ARKUI_KEYCODE_F1  | 按键'F1'  |
2999| ARKUI_KEYCODE_F2  | 按键'F2'  |
3000| ARKUI_KEYCODE_F3  | 按键'F3'  |
3001| ARKUI_KEYCODE_F4  | 按键'F4'  |
3002| ARKUI_KEYCODE_F5  | 按键'F5'  |
3003| ARKUI_KEYCODE_F6  | 按键'F6'  |
3004| ARKUI_KEYCODE_F7  | 按键'F7'  |
3005| ARKUI_KEYCODE_F8  | 按键'F8'  |
3006| ARKUI_KEYCODE_F9  | 按键'F9'  |
3007| ARKUI_KEYCODE_F10  | 按键'F10'  |
3008| ARKUI_KEYCODE_F11  | 按键'F11'  |
3009| ARKUI_KEYCODE_F12  | 按键'F12'  |
3010| ARKUI_KEYCODE_NUM_LOCK  | 小键盘锁  |
3011| ARKUI_KEYCODE_NUMPAD_0  | 小键盘按键'0'  |
3012| ARKUI_KEYCODE_NUMPAD_1  | 小键盘按键'1'  |
3013| ARKUI_KEYCODE_NUMPAD_2  | 小键盘按键'2'  |
3014| ARKUI_KEYCODE_NUMPAD_3  | 小键盘按键'3'  |
3015| ARKUI_KEYCODE_NUMPAD_4  | 小键盘按键'4'  |
3016| ARKUI_KEYCODE_NUMPAD_5  | 小键盘按键'5'  |
3017| ARKUI_KEYCODE_NUMPAD_6  | 小键盘按键'6'  |
3018| ARKUI_KEYCODE_NUMPAD_7  | 小键盘按键'7'  |
3019| ARKUI_KEYCODE_NUMPAD_8  | 小键盘按键'8'  |
3020| ARKUI_KEYCODE_NUMPAD_9  | 小键盘按键'9'  |
3021| ARKUI_KEYCODE_NUMPAD_DIVIDE  | 小键盘按键'/'  |
3022| ARKUI_KEYCODE_NUMPAD_MULTIPLY  | 小键盘按键'\*'  |
3023| ARKUI_KEYCODE_NUMPAD_SUBTRACT  | 小键盘按键'-'  |
3024| ARKUI_KEYCODE_NUMPAD_ADD  | 小键盘按键'+'  |
3025| ARKUI_KEYCODE_NUMPAD_DOT  | 小键盘按键'.'  |
3026| ARKUI_KEYCODE_NUMPAD_COMMA  | 小键盘按键','  |
3027| ARKUI_KEYCODE_NUMPAD_ENTER  | 小键盘按键回车  |
3028| ARKUI_KEYCODE_NUMPAD_EQUALS  | 小键盘按键'='  |
3029| ARKUI_KEYCODE_NUMPAD_LEFT_PAREN  | 小键盘按键'('  |
3030| ARKUI_KEYCODE_NUMPAD_RIGHT_PAREN  | 小键盘按键')'  |
3031
3032
3033### ArkUI_KeyEventType
3034
3035```
3036enum ArkUI_KeyEventType
3037```
3038**描述:**
3039
3040按键的类型。
3041
3042**起始版本:** 14
3043
3044| 枚举值 | 描述 |
3045| -------- | -------- |
3046| ARKUI_KEY_EVENT_UNKNOWN  | 未知类型  |
3047| ARKUI_KEY_EVENT_DOWN  | 按键按下  |
3048| ARKUI_KEY_EVENT_UP  | 按键松开  |
3049| ARKUI_KEY_EVENT_LONG_PRESS  | 按键长按  |
3050| ARKUI_KEY_EVENT_CLICK  | 按键点击  |
3051
3052
3053### ArkUI_KeyIntension
3054
3055```
3056enum ArkUI_KeyIntension
3057```
3058**描述:**
3059
3060按键对应的意图。
3061
3062**起始版本:** 14
3063
3064| 枚举值 | 描述 |
3065| -------- | -------- |
3066| ARKUI_KEY_INTENSION_UNKNOWN  | 未知意图  |
3067| ARKUI_KEY_INTENSION_UP  | 向上  |
3068| ARKUI_KEY_INTENSION_DOWN  | 向下  |
3069| ARKUI_KEY_INTENSION_LEFT  | 向左  |
3070| ARKUI_KEY_INTENSION_RIGHT  | 向右  |
3071| ARKUI_KEY_INTENSION_SELECT  | 选中  |
3072| ARKUI_KEY_INTENSION_ESCAPE  | 返回  |
3073| ARKUI_KEY_INTENSION_BACK  | 后退  |
3074| ARKUI_KEY_INTENSION_FORWARD  | 前进  |
3075| ARKUI_KEY_INTENSION_MENU  | 菜单  |
3076| ARKUI_KEY_INTENSION_HOME  | 主页  |
3077| ARKUI_KEY_INTENSION_PAGE_UP  | 上一页  |
3078| ARKUI_KEY_INTENSION_PAGE_DOWN  | 下一页  |
3079| ARKUI_KEY_INTENSION_ZOOM_OUT  | 缩小  |
3080| ARKUI_KEY_INTENSION_ZOOM_IN  | 放大  |
3081| ARKUI_KEY_INTENTION_MEDIA_PLAY_PAUSE  | 播放  |
3082| ARKUI_KEY_INTENTION_MEDIA_FAST_FORWARD  | 快进  |
3083| ARKUI_KEY_INTENTION_MEDIA_FAST_PLAYBACK  | 快速播放  |
3084| ARKUI_KEY_INTENTION_MEDIA_NEXT  | 下一首  |
3085| ARKUI_KEY_INTENTION_MEDIA_PREVIOUS  | 上一首  |
3086| ARKUI_KEY_INTENTION_MEDIA_MUTE  | 静音  |
3087| ARKUI_KEY_INTENTION_VOLUME_UP  | 音量增加  |
3088| ARKUI_KEY_INTENTION_VOLUME_DOWN  | 音量降低  |
3089| ARKUI_KEY_INTENTION_CALL  | 接听电话  |
3090| ARKUI_KEY_INTENTION_CAMERA  | 拍照  |
3091
3092
3093### ArkUI_KeySourceType
3094
3095```
3096enum ArkUI_KeySourceType
3097```
3098**描述:**
3099
3100触发当前按键的输入设备类型。
3101
3102**起始版本:** 14
3103
3104| 枚举值 | 描述 |
3105| -------- | -------- |
3106| ARKUI_KEY_SOURCE_UNKNOWN  | 未知类型  |
3107| ARKUI_KEY_SOURCE_TYPE_MOUSE  | 鼠标  |
3108| ARKUI_KEY_SOURCE_TYPE_KEYBOARD  | 键盘  |
3109| ARKUI_KEY_SOURCE_TYPE_JOYSTICK  | 游戏手柄  |
3110
3111
3112### ArkUI_LengthMetricUnit
3113
3114```
3115enum ArkUI_LengthMetricUnit
3116```
3117**描述:**
3118
3119定义组件的单位模式。
3120
3121**起始版本:** 12
3122
3123| 枚举值 | 描述 |
3124| -------- | -------- |
3125| ARKUI_LENGTH_METRIC_UNIT_DEFAULT  | 默认,字体类单位为FP,非字体类单位为VP。  |
3126| ARKUI_LENGTH_METRIC_UNIT_PX  | 单位为PX。  |
3127| ARKUI_LENGTH_METRIC_UNIT_VP  | 单位为VP。  |
3128| ARKUI_LENGTH_METRIC_UNIT_FP  | 单位为FP。  |
3129
3130
3131### ArkUI_LinearGradientDirection
3132
3133```
3134enum ArkUI_LinearGradientDirection
3135```
3136**描述:**
3137
3138定义渐变方向结构。
3139
3140**起始版本:** 12
3141
3142| 枚举值 | 描述 |
3143| -------- | -------- |
3144| ARKUI_LINEAR_GRADIENT_DIRECTION_LEFT  | 向左渐变。  |
3145| ARKUI_LINEAR_GRADIENT_DIRECTION_TOP  | 向上渐变。  |
3146| ARKUI_LINEAR_GRADIENT_DIRECTION_RIGHT  | 向右渐变。  |
3147| ARKUI_LINEAR_GRADIENT_DIRECTION_BOTTOM  | 向下渐变。  |
3148| ARKUI_LINEAR_GRADIENT_DIRECTION_LEFT_TOP  | 向左上渐变。  |
3149| ARKUI_LINEAR_GRADIENT_DIRECTION_LEFT_BOTTOM  | 向左下渐变。  |
3150| ARKUI_LINEAR_GRADIENT_DIRECTION_RIGHT_TOP  | 向右上渐变。  |
3151| ARKUI_LINEAR_GRADIENT_DIRECTION_RIGHT_BOTTOM  | 向右下渐变。  |
3152| ARKUI_LINEAR_GRADIENT_DIRECTION_NONE  | 不渐变。  |
3153| ARKUI_LINEAR_GRADIENT_DIRECTION_CUSTOM  | 自定义渐变方向.  |
3154
3155
3156### ArkUI_ListItemAlignment
3157
3158```
3159enum ArkUI_ListItemAlignment
3160```
3161**描述:**
3162
3163交叉轴方向的布局方式。
3164
3165**起始版本:** 12
3166
3167| 枚举值 | 描述 |
3168| -------- | -------- |
3169| ARKUI_LIST_ITEM_ALIGNMENT_START  | ListItem在List中,交叉轴方向首部对齐。  |
3170| ARKUI_LIST_ITEM_ALIGNMENT_CENTER  | ListItem在List中,交叉轴方向居中对齐。  |
3171| ARKUI_LIST_ITEM_ALIGNMENT_END  | ListItem在List中,交叉轴方向尾部对齐。  |
3172
3173
3174### ArkUI_ListItemSwipeActionState
3175
3176```
3177enum ArkUI_ListItemSwipeActionState
3178```
3179**描述:**
3180
3181定义 Listitem 组件SwipeAction方法的显隐模式。
3182
3183**起始版本:** 12
3184
3185| 枚举值 | 描述 |
3186| -------- | -------- |
3187| ARKUI_LIST_ITEM_SWIPE_ACTION_STATE_COLLAPSED  | 收起状态,当ListItem与主轴方向相反滑动时操作项处于隐藏状态。  |
3188| ARKUI_LIST_ITEM_SWIPE_ACTION_STATE_EXPANDED  | 收起状态,当ListItem与主轴方向相反滑动时操作项处于显示状态。  |
3189| ARKUI_LIST_ITEM_SWIPE_ACTION_STATE_ACTIONING  | 长距离状态,当ListItem进入长距删除区后删除ListItem的状态。  |
3190
3191
3192### ArkUI_ListItemSwipeEdgeEffect
3193
3194```
3195enum ArkUI_ListItemSwipeEdgeEffect
3196```
3197**描述:**
3198
3199定义 Listitem 组件SwipeAction方法的滚动模式。
3200
3201**起始版本:** 12
3202
3203| 枚举值 | 描述 |
3204| -------- | -------- |
3205| ARKUI_LIST_ITEM_SWIPE_EDGE_EFFECT_SPRING  | ListItem划动距离超过划出组件大小后可以继续划动。  |
3206| ARKUI_LIST_ITEM_SWIPE_EDGE_EFFECT_NONE  | ListItem划动距离不能超过划出组件大小。  |
3207
3208
3209### ArkUI_MaskType
3210
3211```
3212enum ArkUI_MaskType
3213```
3214**描述:**
3215
3216遮罩类型枚举。
3217
3218**起始版本:** 12
3219
3220| 枚举值 | 描述 |
3221| -------- | -------- |
3222| ARKUI_MASK_TYPE_RECTANGLE  | 矩形类型。  |
3223| ARKUI_MASK_TYPE_CIRCLE  | 圆形类型。  |
3224| ARKUI_MASK_TYPE_ELLIPSE  | 椭圆形类型。  |
3225| ARKUI_MASK_TYPE_PATH  | 路径类型。  |
3226| ARKUI_MASK_TYPE_PROGRESS  | 进度类型。  |
3227
3228
3229### ArkUI_NativeAPIVariantKind
3230
3231```
3232enum ArkUI_NativeAPIVariantKind
3233```
3234**描述:**
3235
3236定义Native接口集合类型。
3237
3238**起始版本:** 12
3239
3240| 枚举值 | 描述 |
3241| -------- | -------- |
3242| ARKUI_NATIVE_NODE  | UI组件相关接口类型,详见&lt;arkui/native_node.h&gt;中的结构体类型定义。  |
3243| ARKUI_NATIVE_DIALOG  | 弹窗相关接口类型,详见&lt;arkui/native_dialog.h&gt;中的结构体类型定义。  |
3244| ARKUI_NATIVE_GESTURE  | 手势相关接口类型,详见&lt;arkui/native_gesture.h&gt;中的结构体类型定义。  |
3245| ARKUI_NATIVE_ANIMATE  | 动画相关接口类型。详见&lt;arkui/native_animate.h&gt;中的结构体类型定义。  |
3246
3247
3248### ArkUI_NavDestinationState
3249
3250```
3251enum ArkUI_NavDestinationState
3252```
3253**描述:**
3254
3255定义NavDestination组件的状态。
3256
3257**起始版本:** 12
3258
3259| 枚举值 | 描述 |
3260| -------- | -------- |
3261| ARKUI_NAV_DESTINATION_STATE_ON_SHOW  | NavDestination组件显示。  |
3262| ARKUI_NAV_DESTINATION_STATE_ON_HIDE  | NavDestination组件隐藏。  |
3263| ARKUI_NAV_DESTINATION_STATE_ON_APPEAR  | NavDestination从组件树上挂载。  |
3264| ARKUI_NAV_DESTINATION_STATE_ON_DISAPPEAR  | NavDestination从组件树上卸载。  |
3265| ARKUI_NAV_DESTINATION_STATE_ON_WILL_SHOW  | NavDestination组件显示之前。  |
3266| ARKUI_NAV_DESTINATION_STATE_ON_WILL_HIDE  | NavDestination组件隐藏之前。  |
3267| ARKUI_NAV_DESTINATION_STATE_ON_WILL_APPEAR  | NavDestination挂载到组件树之前。  |
3268| ARKUI_NAV_DESTINATION_STATE_ON_WILL_DISAPPEAR  | NavDestination从组件树上卸载之前。  |
3269| ARKUI_NAV_DESTINATION_STATE_ON_BACK_PRESS  | NavDestination从组件返回。  |
3270
3271
3272### ArkUI_NodeAdapterEventType
3273
3274```
3275enum ArkUI_NodeAdapterEventType
3276```
3277**描述:**
3278
3279定义节点适配器事件枚举值。
3280
3281**起始版本:** 12
3282
3283| 枚举值 | 描述 |
3284| -------- | -------- |
3285| NODE_ADAPTER_EVENT_WILL_ATTACH_TO_NODE  | 组件和adapter关联时产生该事件。  |
3286| NODE_ADAPTER_EVENT_WILL_DETACH_FROM_NODE  | 组件和adapter取消关联时产生该事件。  |
3287| NODE_ADAPTER_EVENT_ON_GET_NODE_ID  | Adapter需要添加新元素时获取新元素的唯一标识符时产生该事件。  |
3288| NODE_ADAPTER_EVENT_ON_ADD_NODE_TO_ADAPTER  | Adapter需要添加新元素时获取新元素的内容时产生该事件。  |
3289| NODE_ADAPTER_EVENT_ON_REMOVE_NODE_FROM_ADAPTER  | Adapter将元素移除时产生该事件。  |
3290
3291### ArkUI_NodeAttributeType
3292
3293```
3294enum ArkUI_NodeAttributeType
3295```
3296**描述:**
3297
3298定义ArkUI在Native侧可以设置的属性样式集合。
3299
3300**起始版本:** 12
3301
3302| 枚举值 | 描述 |
3303| -------- | -------- |
3304| NODE_WIDTH  | 宽度属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:宽度数值,单位为vp;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:宽度数值,单位为vp; |
3305| NODE_HEIGHT  | 高度属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:高度数值,单位为vp;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:高度数值,单位为vp; |
3306| NODE_BACKGROUND_COLOR  | 背景色属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:背景色数值,0xargb格式,形如 0xFFFF0000 表示红色;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:背景色数值,0xargb格式,形如 0xFFFF0000 表示红色; |
3307| NODE_BACKGROUND_IMAGE  | 背景色图片属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 图片地址,支持网络图片地址、本地图片地址、Base64或PixelMap对象。不支持SVG类型的图片。<br/>.value[0]?.i32:可选值,repeat参数,参数类型[ArkUI_ImageRepeat](#arkui_imagerepeat),默认值为ARKUI_IMAGE_REPEAT_NONE;<br/>.object:PixelMap 图片数据,参数类型为[ArkUI_DrawableDescriptor](#arkui_drawabledescriptor)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 图片地址,支持网络图片地址、本地图片地址、Base64或PixelMap对象。不支持SVG类型的图片。<br/>.value[0].i32:repeat参数,参数类型[ArkUI_ImageRepeat](#arkui_imagerepeat);<br/>.object:PixelMap 图片数据, 参数类型为[ArkUI_DrawableDescriptor](#arkui_drawabledescriptor);.object参数和.string参数二选一,不可同时设置。 |
3308| NODE_PADDING  | 内间距属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式有两种:<br/>1:上下左右四个位置的内间距值相等。<br/>.value[0].f32:内间距数值,单位为vp;<br/>2:分别指定上下左右四个位置的内间距值。<br/>.value[0].f32:上内间距数值,单位为vp;<br/>.value[1].f32:右内间距数值,单位为vp;<br/>.value[2].f32:下内间距数值,单位为vp;<br/>.value[3].f32:左内间距数值,单位为vp;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:上内间距数值,单位为vp;<br/>.value[1].f32:右内间距数值,单位为vp;<br/>.value[2].f32:下内间距数值,单位为vp;<br/>.value[3].f32:左内间距数值,单位为vp; |
3309| NODE_ID  | 组件ID属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: ID的内容;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: ID的内容; |
3310| NODE_ENABLED  | 设置组件是否可交互,支持属性设置,属性重置和属性获取。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:false表示不可交互,true表示可交互;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:0表示不可交互,1表示可交互; |
3311| NODE_MARGIN  | 外间距属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式有两种:<br/>1:上下左右四个位置的外间距值相等。<br/>.value[0].f32:外间距数值,单位为vp;<br/>2:分别指定上下左右四个位置的外间距值。<br/>.value[0].f32:上外间距数值,单位为vp;<br/>.value[1].f32:右外间距数值,单位为vp;<br/>.value[2].f32:下外间距数值,单位为vp;<br/>.value[3].f32:左外间距数值,单位为vp;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:上外间距数值,单位为vp;<br/>.value[1].f32:右外间距数值,单位为vp;<br/>.value[2].f32:下外间距数值,单位为vp;<br/>.value[3].f32:左外间距数值,单位为vp; |
3312| NODE_TRANSLATE  | 设置组件平移,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: x轴移动距离,单位vp,默认值0;<br/>.value[1].f32: y轴移动距离,单位vp,默认值0;<br/>.value[2].f32: z轴移动距离,单位vp,默认值0。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: x轴移动距离,单位vp;<br/>.value[1].f32: y轴移动距离,单位vp;<br/>.value[2].f32: z轴移动距离,单位vp。<br/>**说明:**<br/>设置的参数个数超过3个时,当次设置不生效,也不返回错误码。 |
3313| NODE_SCALE  | 设置组件缩放,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: x轴的缩放系数,默认值1;<br/>.value[1].f32: y轴的缩放系数,默认值1。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: x轴的缩放系数;<br/>.value[1].f32: y轴的缩放系数。 |
3314| NODE_ROTATE  | 设置组件旋转,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 旋转轴向量x坐标,默认值0;<br/>.value[1].f32: 旋转轴向量y坐标,默认值0;<br/>.value[2].f32: 旋转轴向量z坐标,默认值0;<br/>.value[3].f32: 旋转角度,默认值0;<br/>.value[4].f32: 视距,即视点到z=0平面的距离,单位vp,默认值0。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 旋转轴向量x坐标;<br/>.value[1].f32: 旋转轴向量y坐标;<br/>.value[2].f32: 旋转轴向量z坐标;<br/>.value[3].f32: 旋转角度;<br/>.value[4].f32: 视距,即视点到z=0平面的距离,单位vp。 |
3315| NODE_BRIGHTNESS  | 设置组件高光效果,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 亮度值,默认值1.0,推荐取值范围[0,2]。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 亮度值。 |
3316| NODE_SATURATION  | 设置组件饱和度效果,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 饱和度值,默认值1.0,推荐取值范围[0,50)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 饱和度值。 |
3317| NODE_BLUR  | 设置组件内容模糊效果,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 模糊半径,模糊半径越大越模糊,为0时不模糊,小于0时按0处理且不会返回错误码。单位px,默认值0.0。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 模糊半径,模糊半径越大越模糊,为0时不模糊。单位px。 |
3318| NODE_LINEAR_GRADIENT  | 设置组件颜色渐变效果,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 线性渐变的起始角度,当[ArkUI_LinearGradientDirection](#arkui_lineargradientdirection) 为ARKUI_LINEAR_GRADIENT_DIRECTION_CUSTOM时,angle属性生效,否则按direction为主要布局方式。 0点方向顺时针旋转为正向角度,默认值:180;<br/>.value[1].i32:线性渐变的方向,设置除ARKUI_LINEAR_GRADIENT_DIRECTION_CUSTOM的线性渐变方向后,angle不生效。数据类型[ArkUI_LinearGradientDirection](#arkui_lineargradientdirection)<br/>.value[2].i32: 为渐变的颜色重复着色,默认值 false。<br/>.object: 参数类型为[ArkUI_ColorStop](_ark_u_i___color_stop.md)。指定某百分比位置处的渐变色颜色,设置非法颜色直接跳过:<br/>colors:渐变色颜色颜色。<br/>stops:渐变位置。<br/>size:颜色个数。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 线性渐变的起始角度。 当为ARKUI_LINEAR_GRADIENT_DIRECTION_CUSTOM时,angle为设置值,其他情况均为默认值。<br/>.value[1].i32:线性渐变的方向。<br/>.value[2].i32: 为渐变的颜色重复着色。<br/>.object: 参数类型为[ArkUI_ColorStop](_ark_u_i___color_stop.md)。指定某百分比位置处的渐变色颜色,设置非法颜色直接跳过:<br/>colors:渐变色颜色颜色。<br/>stops:渐变位置。<br/>size:颜色个数。 |
3319| NODE_ALIGNMENT  | 设置组件内容在元素绘制区域内的对齐方式,支持属性设置,属性重置和属性获取接口。<br/>在Stack中该属性与NODE_STACK_ALIGN_CONTENT效果一致,只能设置子组件在容器内的对齐方式。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 对齐方式,数据类型[ArkUI_Alignment](#arkui_alignment),默认值ARKUI_ALIGNMENT_CENTER。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 对齐方式,数据类型[ArkUI_Alignment](#arkui_alignment)。 |
3320| NODE_OPACITY  | 透明度属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:透明度数值,取值范围为0到1。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:透明度数值,取值范围为0到1。 |
3321| NODE_BORDER_WIDTH  | 边框宽度属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>1: .value[0].f32:统一设置四条边的边框宽度。<br/>2: .value[0].f32:设置上边框的边框宽度。<br/>.value[1].f32:设置右边框的边框宽度。<br/>.value[2].f32:设置下边框的边框宽度。<br/>.value[3].f32:设置左边框的边框宽度。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:设置上边框的边框宽度。<br/>.value[1].f32:设置右边框的边框宽度。<br/>.value[2].f32:设置下边框的边框宽度。<br/>.value[3].f32:设置左边框的边框宽度。 |
3322| NODE_BORDER_RADIUS  | 边框圆角属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>1: .value[0].f32:统一设置四条边的边框圆角。<br/>2: .value[0].f32:设置左上角圆角半径。<br/>.value[1].f32:设置右上角圆角半径。<br/>.value[2].f32:设置左下角圆角半径。<br/>.value[3].f32:设置右下角圆角半径。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:设置左上角圆角半径。<br/>.value[1].f32:设置右上角圆角半径。<br/>.value[2].f32:设置左下角圆角半径。<br/>.value[3].f32:设置右下角圆角半径。 |
3323| NODE_BORDER_COLOR  | 边框颜色属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>1: .value[0].u32:统一设置四条边的边框颜色,使用0xargb表示,如0xFFFF11FF。<br/>2: .value[0].u32:设置上侧边框颜色,使用0xargb表示,如0xFFFF11FF。<br/>.value[1].u32:设置右侧边框颜色,使用0xargb表示,如0xFFFF11FF。<br/>.value[2].u32:设置下侧边框颜色,使用0xargb表示,如0xFFFF11FF。<br/>.value[3].u32:设置左侧边框颜色,使用0xargb表示,如0xFFFF11FF。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:设置上侧边框颜色,使用0xargb表示,如0xFFFF11FF。<br/>.value[1].u32:设置右侧边框颜色,使用0xargb表示,如0xFFFF11FF。<br/>.value[2].u32:设置下侧边框颜色,使用0xargb表示,如0xFFFF11FF。<br/>.value[3].u32:设置左侧边框颜色,使用0xargb表示,如0xFFFF11FF。 |
3324| NODE_BORDER_STYLE  | 边框线条样式属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>1: .value[0].i32:统一设置四条边的边框线条样式,参数类型[ArkUI_BorderStyle](#arkui_borderstyle),默认值为ARKUI_BORDER_STYLE_SOLID。<br/>2:.value[0].i32:设置上侧边框线条样式,参数类型{\@linkArkUI_BorderStyle},默认值为ARKUI_BORDER_STYLE_SOLID。<br/>.value[1].i32:设置右侧边框线条样式,参数类型[ArkUI_BorderStyle](#arkui_borderstyle),默认值为ARKUI_BORDER_STYLE_SOLID。<br/>.value[2].i32:设置下侧边框线条样式,参数类型[ArkUI_BorderStyle](#arkui_borderstyle),默认值为ARKUI_BORDER_STYLE_SOLID。<br/>.value[3].i32:设置左侧边框线条样式,参数类型[ArkUI_BorderStyle](#arkui_borderstyle),默认值为ARKUI_BORDER_STYLE_SOLID。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:上侧边框线条样式对应的数值。<br/>.value[1].i32:右侧边框线条样式对应的数值。<br/>.value[2].i32:下侧边框线条样式对应的数值。<br/>.value[3].i32:左侧边框线条样式对应的数值。 |
3325| NODE_Z_INDEX  | 组件的堆叠顺序属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:堆叠顺序数值。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:堆叠顺序数值。 |
3326| NODE_VISIBILITY  | 组件是否可见属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:控制当前组件显示或隐藏,参数类型[ArkUI_Visibility](#arkui_visibility),默认值为ARKUI_VISIBILITY_VISIBLE。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:控制当前组件显示或隐藏,参数类型[ArkUI_Visibility](#arkui_visibility),默认值为ARKUI_VISIBILITY_VISIBLE。 |
3327| NODE_CLIP  | 组件进行裁剪、遮罩处理属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:控制是否按照父容器边缘轮廓进行裁剪,0表示不裁切,1表示裁切。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:控制是否按照父容器边缘轮廓进行裁剪,0表示不裁切,1表示裁切。 |
3328| NODE_CLIP_SHAPE  | 组件上指定形状的裁剪,支持属性设置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式,共有5种类型:<br/>1.rect类型:<br/>.value[0].i32:裁剪类型,参数类型[ArkUI_ClipType](#arkui_cliptype),ARKUI_CLIP_TYPE_RECTANGLE;<br/>.value[1].f32:矩形宽度;<br/>.value[2].f32:矩形高度;<br/>.value[3].f32:矩形圆角宽度;<br/>.value[4].f32:矩形圆角高度;<br/>.value[5]?.f32:矩形形状的左上圆角半径;<br/>.value[6]?.f32:矩形形状的左下圆角半径;<br/>.value[7]?.f32:矩形形状的右上圆角半径;<br/>.value[8]?.f32:矩形形状的右下圆角半径;<br/>2.circle类型:<br/>.value[0].i32:裁剪类型,参数类型[ArkUI_ClipType](#arkui_cliptype),ARKUI_CLIP_TYPE_CIRCLE;<br/>.value[1].f32:圆形宽度;<br/>.value[2].f32:圆形高度;<br/>3.ellipse类型:<br/>.value[0].i32:裁剪类型,参数类型[ArkUI_ClipType](#arkui_cliptype),ARKUI_CLIP_TYPE_ELLIPSE;<br/>.value[1].f32:椭圆形宽度;<br/>.value[2].f32:椭圆形高度;<br/>4.path类型:<br/>.value[0].i32:裁剪类型,参数类型[ArkUI_ClipType](#arkui_cliptype),ARKUI_CLIP_TYPE_PATH;<br/>.value[1].f32:路径宽度;<br/>.value[2].f32:路径高度;<br/>.string:路径绘制的命令字符串;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式,共有5种类型:<br/>1.rect类型:<br/>.value[0].i32:裁剪类型,参数类型[ArkUI_ClipType](#arkui_cliptype),ARKUI_CLIP_TYPE_RECTANGLE;<br/>.value[1].f32:矩形宽度;<br/>.value[2].f32:矩形高度;<br/>.value[3].f32:矩形圆角宽度;<br/>.value[4].f32:矩形圆角高度;<br/>.value[5]?.f32:矩形形状的左上圆角半径;<br/>.value[6]?.f32:矩形形状的左下圆角半径;<br/>.value[7]?.f32:矩形形状的右上圆角半径;<br/>.value[8]?.f32:矩形形状的右下圆角半径;<br/>2.circle类型:<br/>.value[0].i32:裁剪类型,参数类型[ArkUI_ClipType](#arkui_cliptype),ARKUI_CLIP_TYPE_CIRCLE;<br/>.value[1].f32:圆形宽度;<br/>.value[2].f32:圆形高度;<br/>3.ellipse类型::<br/>.value[0].i32:裁剪类型,参数类型[ArkUI_ClipType](#arkui_cliptype),ARKUI_CLIP_TYPE_ELLIPSE;<br/>.value[1].f32:椭圆形宽度;<br/>.value[2].f32:椭圆形高度;<br/>4.path类型:<br/>.value[0].i32:裁剪类型,参数类型[ArkUI_ClipType](#arkui_cliptype),ARKUI_CLIP_TYPE_PATH;<br/>.value[1].f32:路径宽度;<br/>.value[2].f32:路径高度;<br/>.string:路径绘制的命令字符串; |
3329| NODE_TRANSFORM  | 矩阵变换功能,可对图形进行平移、旋转和缩放等,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0...15].f32: 16个浮点数字。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0...15].f32: 16个浮点数字。 |
3330| NODE_HIT_TEST_BEHAVIOR  | 触摸测试类型,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:控制当前组件的触摸测试类型,参数类型[ArkUI_HitTestMode](#arkui_hittestmode),默认值为ARKUI_HIT_TEST_MODE_DEFAULT。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:控制当前组件的触摸测试类型,参数类型**ArkKUI_HitTestMode**,默认值为ARKUI_HIT_TEST_MODE_DEFAULT。 |
3331| NODE_POSITION  | 元素左上角相对于父容器左上角偏移位置,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:x轴坐标。<br/>.value[1].f32: y轴坐标。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:x轴坐标。<br/>.value[1].f32: y轴坐标。 |
3332| NODE_SHADOW  | 阴影效果属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:设置当前组件阴影效果,参数类型[ArkUI_ShadowStyle](#arkui_shadowstyle)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:设置当前组件阴影效果,参数类型[ArkUI_ShadowStyle](#arkui_shadowstyle)。 |
3333| NODE_CUSTOM_SHADOW  | 自定义阴影效果,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0]?.f32:阴影模糊半径,单位为vp;<br/>.value[1]?.i32:是否开启智能取色,0代表不开启,1代表开启,默认不开启;<br/>.value[2]?.f32:阴影X轴偏移量,单位为px;<br/>.value[3]?.f32:阴影Y轴偏移量,单位为px;<br/>.value[4]?.i32:阴影类型[ArkUI_ShadowType](#arkui_shadowtype),默认值为ARKUI_SHADOW_TYPE_COLOR;<br/>.value[5]?.u32:阴影颜色,0xargb格式,形如 0xFFFF0000 表示红色;<br/>.value[6]?.u32:阴影是否内部填充,,0表示不填充,1表示填充;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:阴影模糊半径,单位为vp;<br/>.value[1].i32:是否开启智能取色;<br/>.value[2].f32:阴影X轴偏移量,单位为px;<br/>.value[3].f32:阴影Y轴偏移量,单位为px;<br/>.value[4].i32:阴影类型[ArkUI_ShadowType](#arkui_shadowtype),默认值为ARKUI_SHADOW_TYPE_COLOR;<br/>.value[5].u32:阴影颜色,0xargb格式,形如 0xFFFF0000 表示红色;<br/>.value[6].u32:阴影是否内部填充,,0表示不填充,1表示填充; |
3334| NODE_BACKGROUND_IMAGE_SIZE  | 背景图片的宽高属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32 表示图片的宽度值,取值范围[0,+∞),单位为vp。<br/>.value[1].f32 表示图片的高度值,取值范围[0,+∞),单位为vp。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32 表示图片的宽度值,单位为vp。<br/>.value[1].f32 表示图片的高度值,单位为vp。 |
3335| NODE_BACKGROUND_IMAGE_SIZE_WITH_STYLE  | 背景图片的宽高样式属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32 表示背景图片的宽高样式,取[ArkUI_ImageSize](#arkui_imagesize)枚举值。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32 表示背景图片的宽高样式,取[ArkUI_ImageSize](#arkui_imagesize)枚举值。 |
3336| NODE_BACKGROUND_BLUR_STYLE  | 背景和内容之间的模糊属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32 表示模糊类型,取[ArkUI_BlurStyle](#arkui_blurstyle)枚举值。<br/>.value[1]?.i32 表示深浅色模式,取[ArkUI_ColorMode](#arkui_colormode)枚举值。<br/>.value[2]?.i32 表示取色模式,取[ArkUI_AdaptiveColor](#arkui_adaptivecolor)枚举值。<br/>.value[3]?.f32 表示模糊效果程度,取[0.0,1.0]范围内的值。<br/>.value[4]?.f32 表示灰阶模糊起始边界。<br/>.value[5]?.f32 表示灰阶模糊终点边界。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32 表示模糊类型,取[ArkUI_BlurStyle](#arkui_blurstyle)枚举值。<br/>.value[1].i32 表示深浅色模式,取[ArkUI_ColorMode](#arkui_colormode)枚举值。<br/>.value[2].i32 表示取色模式,取[ArkUI_AdaptiveColor](#arkui_adaptivecolor)枚举值。<br/>.value[3].f32 表示模糊效果程度,取[0.0,1.0]范围内的值。<br/>.value[4].f32 表示灰阶模糊起始边界。<br/>.value[5].f32 表示灰阶模糊终点边界。 |
3337| NODE_TRANSFORM_CENTER  | 图形变换和转场的中心点属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0]?.f32 表示中心点X轴坐标值,单位为vp<br/>.value[1]?.f32 表示中心点Y轴坐标,单位为vp<br/>.value[2]?.f32 表示中心点Z轴坐标,单位为vp<br/>.value[3]?.f32 表示中心点X轴坐标的百分比位置,如0.2表示百分之20的位置,该属性覆盖value[0].f32,默认值:0.5f。<br/>.value[4]?.f32 表示中心点Y轴坐标的百分比位置,如0.2表示百分之20的位置,该属性覆盖value[1].f32,默认值:0.5f。<br/>.value[5]?.f32 表示中心点Z轴坐标的百分比位置,如0.2表示百分之20的位置,该属性覆盖value[2].f32,默认值:0.0f。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32 表示中心点X轴坐标,单位为vp<br/>.value[1].f32 表示中心点Y轴坐标,单位为vp<br/>.value[2].f32 表示中心点Z轴坐标,单位为vp<br/>注:如果设置坐标百分比位置,属性获取方法返回计算后的vp为单位的值。 |
3338| NODE_OPACITY_TRANSITION  | 转场时的透明度效果属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32 表示起终点的透明度值<br/>.value[1].i32 表示动画时长,单位ms<br/>.value[2].i32 表示动画曲线类型,取[ArkUI_AnimationCurve](#arkui_animationcurve)枚举值<br/>.value[3]?.i32 表示动画延迟时长,单位ms<br/>.value[4]?.i32 表示动画播放次数<br/>.value[5]?.i32 表示动画播放模式,取[ArkUI_AnimationPlayMode](#arkui_animationplaymode)枚举值<br/>.value[6]?.f32 表示动画播放速度<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32 表示起终点的透明度值<br/>.value[1].i32 表示动画时长,单位ms<br/>.value[2].i32 表示动画曲线类型,取[ArkUI_AnimationCurve](#arkui_animationcurve)枚举值<br/>.value[3].i32 表示动画延迟时长,单位ms<br/>.value[4].i32 表示动画播放次数<br/>.value[5].i32 表示动画播放模式,取[ArkUI_AnimationPlayMode](#arkui_animationplaymode)枚举值<br/>.value[6].f32 表示动画播放速度 |
3339| NODE_ROTATE_TRANSITION  | 转场时的旋转效果属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32 表示横向旋转分量。<br/>.value[1].f32 表示纵向的旋转分量。<br/>.value[2].f32 表示竖向的旋转分量。<br/>.value[3].f32 表示角度。<br/>.value[4].f32 表示视距,默认值:0.0f。<br/>.value[5].i32 表示动画时长,单位ms。<br/>.value[6].i32 表示动画曲线类型,取[ArkUI_AnimationCurve](#arkui_animationcurve)枚举值。<br/>.value[7]?.i32 表示动画延迟时长,单位ms。<br/>.value[8]?.i32 表示动画播放次数。<br/>.value[9]?.i32 表示动画播放模式,取[ArkUI_AnimationPlayMode](#arkui_animationplaymode)枚举值。<br/>.value[10]?.f32 表示动画播放速度。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32 表示横向旋转分量。<br/>.value[1].f32 表示纵向的旋转分量。<br/>.value[2].f32 表示竖向的旋转分量。<br/>.value[3].f32 表示角度。<br/>.value[4].f32 表示视距。<br/>.value[5].i32 表示动画时长,单位ms。<br/>.value[6].i32 表示动画曲线类型,取[ArkUI_AnimationCurve](#arkui_animationcurve)枚举值。<br/>.value[7].i32 表示动画延迟时长,单位ms。<br/>.value[8].i32 表示动画播放次数。<br/>.value[9].i32 表示动画播放模式,取[ArkUI_AnimationPlayMode](#arkui_animationplaymode)枚举值。<br/>.value[10].f32 表示动画播放速度。 |
3340| NODE_SCALE_TRANSITION  | 转场时的缩放效果属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32 横向放大倍数。<br/>.value[1].f32 纵向放大倍数。<br/>.value[2].f32 竖向放大倍数。<br/>.value[3].i32 表示动画时长,单位ms。<br/>.value[4].i32 表示动画曲线类型,取[ArkUI_AnimationCurve](#arkui_animationcurve)枚举值。<br/>.value[5]?.i32 表示动画延迟时长,单位ms。<br/>.value[6]?.i32 表示动画播放次数。<br/>.value[7]?.i32 表示动画播放模式,取[ArkUI_AnimationPlayMode](#arkui_animationplaymode)枚举值。<br/>.value[8]?.f32 表示动画播放速度。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32 横向放大倍数。<br/>.value[1].f32 纵向放大倍数。<br/>.value[2].f32 竖向放大倍数。<br/>.value[3].i32 表示动画时长,单位ms。<br/>.value[4].i32 表示动画曲线类型,取[ArkUI_AnimationCurve](#arkui_animationcurve)枚举值。<br/>.value[5].i32 表示动画延迟时长,单位ms。<br/>.value[6].i32 表示动画播放次数。<br/>.value[7].i32 表示动画播放模式,取[ArkUI_AnimationPlayMode](#arkui_animationplaymode)枚举值。<br/>.value[8].f32 表示动画播放速度。 |
3341| NODE_TRANSLATE_TRANSITION  | 转场时的平移效果属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>value[0].f32 表示横向平移距离值,单位为vp<br/>value[1].f32 表示纵向平移距离值,单位为vp<br/>value[2].f32 表示竖向平移距离值,单位为vp<br/>value[3].i32 表示动画时长,单位ms。<br/>value[4].i32 表示动画曲线类型,取[ArkUI_AnimationCurve](#arkui_animationcurve)枚举值。<br/>value[5]?.i32 表示动画延迟时长,单位ms。<br/>value[6]?.i32 表示动画播放次数。<br/>value[7]?.i32 表示动画播放模式,取[ArkUI_AnimationPlayMode](#arkui_animationplaymode)枚举值。<br/>value[8]?.f32 表示动画播放速度。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>value[0].f32 表示横向平移距离值,单位为vp<br/>value[1].f32 表示纵向平移距离值,单位为vp<br/>value[2].f32 表示竖向平移距离值,单位为vp<br/>value[3].i32 表示动画时长,单位ms。<br/>value[4].i32 表示动画曲线类型,取[ArkUI_AnimationCurve](#arkui_animationcurve)枚举值。<br/>value[5].i32 表示动画延迟时长,单位ms。<br/>value[6].i32 表示动画播放次数。<br/>value[7].i32 表示动画播放模式,取[ArkUI_AnimationPlayMode](#arkui_animationplaymode)枚举值。<br/>value[8].f32 表示动画播放速度。 |
3342| NODE_MOVE_TRANSITION  | 转场时从屏幕边缘滑入和滑出的效果属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32 参数类型[ArkUI_TransitionEdge](#arkui_transitionedge)<br/>.value[1].i32 表示动画时长,单位ms<br/>.value[2].i32 表示动画曲线类型,取[ArkUI_AnimationCurve](#arkui_animationcurve)枚举值<br/>.value[3]?.i32 表示动画延迟时长,单位ms<br/>.value[4]?.i32 表示动画播放次数<br/>.value[5]?.i32 表示动画播放模式,取[ArkUI_AnimationPlayMode](#arkui_animationplaymode)枚举值<br/>.value[6]?.f32 表示动画播放速度<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32 参数类型[ArkUI_TransitionEdge](#arkui_transitionedge)<br/>.value[1].i32 表示动画时长,单位ms<br/>.value[2].i32 表示动画曲线类型,取[ArkUI_AnimationCurve](#arkui_animationcurve)枚举值<br/>.value[3].i32 表示动画延迟时长,单位ms<br/>.value[4].i32 表示动画播放次数<br/>.value[5].i32 表示动画播放模式,取[ArkUI_AnimationPlayMode](#arkui_animationplaymode)枚举值<br/>.value[6].f32 表示动画播放速度 |
3343| NODE_FOCUSABLE  | 获焦属性,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].i32:参数类型为1或者0。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:参数类型为1或者0。 |
3344| NODE_DEFAULT_FOCUS  | 默认焦点属性,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>value[0].i32:参数类型为1或者0。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>value[0].i32:参数类型为1或者0。 |
3345| NODE_RESPONSE_REGION  | 触摸热区属性,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.data[0].f32:触摸点相对于组件左上角的x轴坐标,单位为vp。<br/>.data[1].f32:触摸点相对于组件左上角的y轴坐标,单位为vp。<br/>.data[2].f32:触摸热区的宽度 ,单位为百分比。<br/>.data[3].f32:触摸热区的高度,单位为百分比。<br/>.data[4...].f32:可以设置多个手势响应区域,顺序和上述一致。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.data[0].f32:触摸点相对于组件左上角的x轴坐标,单位为vp。<br/>.data[1].f32:触摸点相对于组件左上角的y轴坐标,单位为vp。<br/>.data[2].f32:触摸热区的宽度 ,单位为百分比。<br/>.data[3].f32:触摸热区的高度,单位为百分比。<br/>.data[4...].f32:可以设置多个手势响应区域,顺序和上述一致。 |
3346| NODE_OVERLAY  | 遮罩文本属性,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.string 遮罩文本;<br/>.value[0]?.i32:可选值,浮层相对于组件的位置,参数类型[ArkUI_Alignment](#arkui_alignment), 默认值为ARKUI_ALIGNMENT_TOP_START。<br/>.value[1]?.f32:可选值,浮层基于自身左上角的偏移量X,单位为vp。<br/>.value[2]?.f32:可选值,浮层基于自身左上角的偏移量Y,单位为vp。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string 遮罩文本;<br/>.value[0].i32:浮层相对于组件的位置,参数类型[ArkUI_Alignment](#arkui_alignment), 默认值为ARKUI_ALIGNMENT_TOP_START。<br/>.value[1].f32:浮层基于自身左上角的偏移量X,单位为vp。<br/>.value[2].f32:浮层基于自身左上角的偏移量Y,单位为vp。 |
3347| NODE_SWEEP_GRADIENT  | 角度渐变效果,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0]?.f32:为角度渐变的中心点,即相对于当前组件左上角的坐标,X轴坐标<br/>.value[1]?.f32:为角度渐变的中心点,即相对于当前组件左上角的坐标,Y轴坐标<br/>.value[2]?.f32:角度渐变的起点,默认值0。<br/>.value[3]?.f32:角度渐变的终点,默认值0。<br/>.value[4]?.f32:角度渐变的旋转角度,默认值0。<br/>.value[5]?.i32:为渐变的颜色重复着色,0表示不重复着色,1表示重复着色<br/>.object: 参数类型为[ArkUI_ColorStop](_ark_u_i___color_stop.md)。指定某百分比位置处的渐变色颜色,设置非法颜色直接跳过:<br/>colors:渐变色颜色颜色。<br/>stops:渐变位置。<br/>size:颜色个数。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:为角度渐变的中心点,即相对于当前组件左上角的坐标,X轴坐标<br/>.value[1].f32:为角度渐变的中心点,即相对于当前组件左上角的坐标,Y轴坐标<br/>.value[2].f32:角度渐变的起点,默认值0。<br/>.value[3].f32:角度渐变的终点,默认值0。<br/>.value[4].f32:角度渐变的旋转角度,默认值0。<br/>.value[5].i32:为渐变的颜色重复着色,0表示不重复着色,1表示重复着色<br/>.object: 参数类型为[ArkUI_ColorStop](_ark_u_i___color_stop.md)。指定某百分比位置处的渐变色颜色,设置非法颜色直接跳过:<br/>colors:渐变色颜色颜色。<br/>stops:渐变位置。<br/>size:颜色个数。 |
3348| NODE_RADIAL_GRADIENT  | 径向渐变渐变效果,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0]?.f32:为径向渐变的中心点,即相对于当前组件左上角的坐标,X轴坐标<br/>.value[1]?.f32:为径向渐变的中心点,即相对于当前组件左上角的坐标,Y轴坐标<br/>.value[2]?.f32:径向渐变的半径,默认值0。<br/>.value[3]?.i32:为渐变的颜色重复着色,0表示不重复着色,1表示重复着色<br/>.object: 参数类型为[ArkUI_ColorStop](_ark_u_i___color_stop.md)。指定某百分比位置处的渐变色颜色,设置非法颜色直接跳过:<br/>colors:渐变色颜色颜色。<br/>stops:渐变位置。<br/>size:颜色个数。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:为径向渐变的中心点,即相对于当前组件左上角的坐标,X轴坐标<br/>.value[1].f32:为径向渐变的中心点,即相对于当前组件左上角的坐标,Y轴坐标<br/>.value[2].f32:径向渐变的半径,默认值0。<br/>.value[3].i32:为渐变的颜色重复着色,0表示不重复着色,1表示重复着色<br/>.object: 参数类型为[ArkUI_ColorStop](_ark_u_i___color_stop.md)。指定某百分比位置处的渐变色颜色,设置非法颜色直接跳过:<br/>colors:渐变色颜色颜色。<br/>stops:渐变位置。<br/>size:颜色个数。 |
3349| NODE_MASK  | 组件上加上指定形状的遮罩,支持属性设置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式,共有5种类型:<br/>1.rect类型:<br/>.value[0].u32:填充颜色,0xargb类型;<br/>.value[1].u32:描边颜色,0xargb类型;<br/>.value[2].f32:描边宽度,单位为vp;<br/>.value[3].i32:遮罩类型,参数类型[ArkUI_MaskType](#arkui_masktype),ARKUI_MASK_TYPE_RECTANGLE;<br/>.value[4].f32:矩形宽度;<br/>.value[5].f32:矩形高度;<br/>.value[6].f32:矩形圆角宽度;<br/>.value[7].f32:矩形圆角高度;<br/>.value[8]?.f32:矩形形状的左上圆角半径;<br/>.value[9]?.f32:矩形形状的左下圆角半径;<br/>.value[10]?.f32:矩形形状的右上圆角半径;<br/>.value[11]?.f32:矩形形状的右下圆角半径;<br/>2.circle类型:<br/>.value[0].u32:填充颜色,0xargb类型;<br/>.value[1].u32:描边颜色,0xargb类型;<br/>.value[2].f32:描边宽度,单位为vp;<br/>.value[3].i32:遮罩类型,参数类型[ArkUI_MaskType](#arkui_masktype),ARKUI_MASK_TYPE_CIRCLE;<br/>.value[4].f32:圆形宽度;<br/>.value[5].f32:圆形高度;<br/>3.ellipse类型:<br/>.value[0].u32:填充颜色,0xargb类型;<br/>.value[1].u32:描边颜色,0xargb类型;<br/>.value[2].f32:描边宽度,单位为vp;<br/>.value[3].i32:遮罩类型,参数类型[ArkUI_MaskType](#arkui_masktype),ARKUI_MASK_TYPE_ELLIPSE;<br/>.value[4].f32:椭圆形宽度;<br/>.value[5].f32:椭圆形高度;<br/>4.path类型:<br/>.value[0].u32:填充颜色,0xargb类型;<br/>.value[1].u32:描边颜色,0xargb类型;<br/>.value[2].f32:描边宽度,单位为vp;<br/>.value[3].i32:遮罩类型,参数类型[ArkUI_MaskType](#arkui_masktype),ARKUI_MASK_TYPE_PATH;<br/>.value[4].f32:路径宽度;<br/>.value[5].f32:路径高度;<br/>.string:路径绘制的命令字符串;<br/>5.progress类型:<br/>.value[0].i32:遮罩类型,参数类型[ArkUI_MaskType](#arkui_masktype),ARKUI_MASK_TYPE_PROGRESS;<br/>.value[1].f32:进度遮罩的当前值;<br/>.value[2].f32:进度遮罩的最大值;<br/>.value[3].u32:进度遮罩的颜色;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式,共有5种类型:<br/>1.rect类型:<br/>.value[0].u32:填充颜色,0xargb类型;<br/>.value[1].u32:描边颜色,0xargb类型;<br/>.value[2].f32:描边宽度,单位为vp;<br/>.value[3].i32:遮罩类型;<br/>.value[4].f32:矩形宽度;<br/>.value[5].f32:矩形高度;<br/>.value[6].f32:矩形圆角宽度;<br/>.value[7].f32:矩形圆角高度;<br/>.value[8]?.f32:矩形形状的左上圆角半径;<br/>.value[9]?.f32:矩形形状的左下圆角半径;<br/>.value[10]?.f32:矩形形状的右上圆角半径;<br/>.value[11]?.f32:矩形形状的右下圆角半径;<br/>2.circle类型:<br/>.value[0].u32:填充颜色,0xargb类型;<br/>.value[1].u32:描边颜色,0xargb类型;<br/>.value[2].f32:描边宽度,单位为vp;<br/>.value[3].i32:遮罩类型;<br/>.value[4].f32:圆形宽度;<br/>.value[5].f32:圆形高度;<br/>3.ellipse类型:<br/>.value[0].u32:填充颜色,0xargb类型;<br/>.value[1].u32:描边颜色,0xargb类型;<br/>.value[2].f32:描边宽度,单位为vp;<br/>.value[3].i32:遮罩类型;<br/>.value[4].f32:椭圆形宽度;<br/>.value[5].f32:椭圆形高度;<br/>4.path类型:<br/>.value[0].u32:填充颜色,0xargb类型;<br/>.value[1].u32:描边颜色,0xargb类型;<br/>.value[2].f32:描边宽度,单位为vp;<br/>.value[3].i32:遮罩类型;<br/>.value[4].f32:路径宽度;<br/>.value[5].f32:路径高度;<br/>.string:路径绘制的命令字符串;<br/>5.progress类型:<br/>.value[0].i32:遮罩类型;<br/>.value[1].f32:进度遮罩的当前值;<br/>.value[2].f32:进度遮罩的最大值;<br/>.value[3].u32:进度遮罩的颜色; |
3350| NODE_BLEND_MODE  | 当前控件背景与子节点内容进行混合,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:控制当前组件的混合模式类型,参数类型[ArkUI_BlendMode](#arkui_blendmode),默认值为ARKUI_BLEND_MODE_NONE。<br/>.value[1].?i32:blendMode实现方式是否离屏,参数类型[ArkUI_BlendApplyType](#arkui_blendapplytype),默认值为BLEND_APPLY_TYPE_FAST。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:控制当前组件的混合模式类型,参数类型[ArkUI_BlendMode](#arkui_blendmode),默认值为ARKUI_BLEND_MODE_NONE。<br/>.value[1].i32:blendMode实现方式是否离屏,参数类型[ArkUI_BlendApplyType](#arkui_blendapplytype),默认值为BLEND_APPLY_TYPE_FAST。 |
3351| NODE_DIRECTION  | 设置容器元素内主轴方向上的布局,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:设置容器元素内主轴方向上的布局类型,<br/>参数类型[ArkUI_Direction](#arkui_direction),默认值为ARKUI_DIRECTION_AUTO。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:设置容器元素内主轴方向上的布局类型,<br/>参数类型[ArkUI_Direction](#arkui_direction),默认值为ARKUI_DIRECTION_AUTO。 |
3352| NODE_CONSTRAINT_SIZE  | 约束尺寸属性,组件布局时,进行尺寸范围限制,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:最小宽度,单位vp;<br/>.value[1].f32:最大宽度,单位vp;<br/>.value[2].f32:最小高度,单位vp;<br/>.value[3].f32:最大高度,单位vp;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:最小宽度,单位vp;<br/>.value[1].f32:最大宽度,单位vp;<br/>.value[2].f32:最小高度,单位vp;<br/>.value[3].f32:最大高度,单位vp; |
3353| NODE_GRAY_SCALE  | 灰度效果属性,支持属性设置,属性重置和属性获取接口.<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:灰度转换比例,范围0-1之间,比如0.5指按照50进行灰度处理;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:灰度转换比例,范围0-1之间; |
3354| NODE_INVERT  | 反转输入的图像比例属性,支持属性设置,属性重置和属性获取接口.<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:图像反转比例,范围0-1之间,比如0.5指按照50进行反转处理;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:图像反转比例,范围0-1之间; |
3355| NODE_SEPIA  | 图像转换为深褐色比例属性,支持属性设置,属性重置和属性获取接口.<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:图像转换为深褐色比例,范围0-1之间,比如0.5指按照50进行深褐色处理;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:图像转换为深褐色比例,范围0-1之间; |
3356| NODE_CONTRAST  | 对比度属性,支持属性设置,属性重置和属性获取接口.<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:对比度,等于1时为原图,越大则对比度越高,取值范围:[0, 10);<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:对比度,取值范围:[0, 10); |
3357| NODE_FOREGROUND_COLOR  | 前景颜色属性,支持属性设置和属性获取接口。属性重置接口无效果。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式,支持两种入参格式:<br/>1:.value[0].u32:颜色数值,0xargb类型,如0xFFFF0000表示红色;<br/>2:.value[0].i32:颜色数值枚举**ArkUI_ColoringStrategy**;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:颜色数值,0xargb类型; |
3358| NODE_OFFSET  | 组件子元素相对组件自身的额外偏移属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32 表示x轴方向的偏移值, 单位为vp。<br/>.value[1].f32 表示y轴方向的偏移值, 单位为vp。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32 表示x轴方向的偏移值, 单位为vp。<br/>.value[1].f32 表示y轴方向的偏移值, 单位为vp。 |
3359| NODE_MARK_ANCHOR  | 组件子元素在位置定位时的锚点属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32 表示锚点x坐标值, 单位为vp<br/>.value[1].f32 表示锚点y坐标值, 单位为vp<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32 表示锚点x坐标值, 单位为vp<br/>.value[1].f32 表示锚点y坐标值, 单位为vp |
3360| NODE_BACKGROUND_IMAGE_POSITION  | 背景图在组件中显示位置,即相对于组件左上角的坐标,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32 表示x轴方向的位置,单位为px。<br/>.value[1].f32 表示y轴方向的位置,单位为px。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32 表示x轴方向的位置,单位为px。<br/>.value[1].f32 表示y轴方向的位置,单位为px。 |
3361| NODE_ALIGN_RULES  | 相对容器中子组件的对齐规则属性,支持属性设置,属性重置,获取属性接口。<br/>.object:使用[ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption)对象作为组件的对齐规则。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object:使用[ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption)对象作为组件的对齐规则。 |
3362| NODE_ALIGN_SELF  | 设置子组件在父容器交叉轴的对齐格式,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:设置子组件在父容器交叉轴的对齐格式类型,<br/>参数类型[ArkUI_ItemAlignment](#arkui_itemalignment),默认值为ARKUI_ITEM_ALIGNMENT_AUTO。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:设置子组件在父容器交叉轴的对齐格式类型,<br/>参数类型[ArkUI_ItemAlignment](#arkui_itemalignment),默认值为ARKUI_ITEM_ALIGNMENT_AUTO。 |
3363| NODE_FLEX_GROW  | 设置组件在父容器的剩余空间所占比例,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:父容器的剩余空间所占比例。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:父容器的剩余空间所占比例。 |
3364| NODE_FLEX_SHRINK  | 设置父容器压缩尺寸分配给此属性所在组件的比例,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:父容器压缩尺寸分配给此属性所在组件的比例数值。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:父容器压缩尺寸分配给此属性所在组件的比例数值。 |
3365| NODE_FLEX_BASIS  | 设置组件的基准尺寸,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:组件在父容器主轴方向上的基准尺寸。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:组件在父容器主轴方向上的基准尺寸。 |
3366| NODE_ACCESSIBILITY_GROUP  | 无障碍组属性, 支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].i32:为1时表示该组件及其所有子组件为一整个可以选中的组件 无障碍服务将不再关注其子组件内容。参数类型为1或者0。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:为1时表示该组件及其所有子组件为一整个可以选中的组件 无障碍服务将不再关注其子组件内容。参数类型为1或者0。 |
3367| NODE_ACCESSIBILITY_TEXT  | 无障碍文本属性,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.string:无障碍文本。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string:无障碍文本。 |
3368| NODE_ACCESSIBILITY_MODE  | 无障碍辅助服务模式,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].i32:辅助服务模式,参数类型[ArkUI_AccessibilityMode](#arkui_accessibilitymode)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:辅助服务模式,参数类型[ArkUI_AccessibilityMode](#arkui_accessibilitymode)。 |
3369| NODE_ACCESSIBILITY_DESCRIPTION  | 无障碍说明属性,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.string:无障碍说明。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string:无障碍说明。 |
3370| NODE_FOCUS_STATUS  | 组件获取焦点属性,支持属性设置,属性获取。<br/>注解<br/>设置参数为0时,当前层级页面获焦组件失焦,焦点转移到根容器上。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].i32:参数类型为1或者0。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:参数类型为1或者0。 |
3371| NODE_ASPECT_RATIO  | 设置组件的宽高比,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:组件的宽高比,输入值为 width/height。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:组件的宽高比,width/height的比值。 |
3372| NODE_LAYOUT_WEIGHT  | Row/Column/Flex 布局下的子组件布局权重参数,支持属性设置、属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:子组件占主轴尺寸的权重。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:子组件占主轴尺寸的权重。 |
3373| NODE_DISPLAY_PRIORITY  | Row/Column/Flex(单行) 布局下的子组件在布局容器中显示的优先级,支持属性设置、属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:子组件在父容器中的显示优先级。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:子组件在父容器中的显示优先级。 |
3374| NODE_OUTLINE_WIDTH  | 设置元素的外描边宽度。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:元素左边的外描边宽度。<br/>.value[1].f32:元素上边的外描边宽度。<br/>.value[2].f32:元素右边的外描边宽度。<br/>.value[3].f32:元素下边的外描边宽度。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:元素左边的外描边宽度。<br/>.value[1].f32:元素上边的外描边宽度。<br/>.value[2].f32:元素右边的外描边宽度。<br/>.value[3].f32:元素下边的外描边宽度。 |
3375| NODE_WIDTH_PERCENT  | 宽度属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:宽度数值,单位为百分比;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:宽度数值,单位为百分比; |
3376| NODE_HEIGHT_PERCENT  | 高度属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:高度数值,单位为百分比;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:高度数值,单位为百分比; |
3377| NODE_PADDING_PERCENT  | 内间距属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式有两种:<br/>1:上下左右四个位置的内间距值相等。<br/>.value[0].f32:内间距数值,单位为百分比;<br/>2:分别指定上下左右四个位置的内间距值。<br/>.value[0].f32:上内间距数值,单位为百分比;<br/>.value[1].f32:右内间距数值,单位为百分比;<br/>.value[2].f32:下内间距数值,单位为百分比;<br/>.value[3].f32:左内间距数值,单位为百分比;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:上内间距数值,单位为百分比;<br/>.value[1].f32:右内间距数值,单位为百分比;<br/>.value[2].f32:下内间距数值,单位为百分比;<br/>.value[3].f32:左内间距数值,单位为百分比; |
3378| NODE_MARGIN_PERCENT  | 外间距属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式有两种:<br/>1:上下左右四个位置的外间距值相等。<br/>.value[0].f32:外间距数值,单位为百分比;<br/>2:分别指定上下左右四个位置的外间距值。<br/>.value[0].f32:上外间距数值,单位为百分比;<br/>.value[1].f32:右外间距数值,单位为百分比;<br/>.value[2].f32:下外间距数值,单位为百分比;<br/>.value[3].f32:左外间距数值,单位为百分比;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:上外间距数值,单位为百分比;<br/>.value[1].f32:右外间距数值,单位为百分比;<br/>.value[2].f32:下外间距数值,单位为百分比;<br/>.value[3].f32:左外间距数值,单位为百分比; |
3379| NODE_GEOMETRY_TRANSITION  | 组件内隐式共享元素转场,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0]?.i32:参数类型为1或者0。共享元素绑定的2个组件, 针对出场元素未进行删除时是否要继续参与共享元素动画,默认为false,不参与保持原始位置不动。<br/>.string 用于设置绑定关系,id置""清除绑定关系避免参与共享行为, id可更换重新建立绑定关系。同一个id只能有两个组件绑定且是in/out不同类型角色, 不能多个组件绑定同一个id。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:参数类型为1或者0。共享元素绑定的2个组件, 针对出场元素未进行删除时是否要继续参与共享元素动画,默认未false,不参与保持原始位置不动。<br/>.string 用于设置绑定关系,id置""清除绑定关系避免参与共享行为, id可更换重新建立绑定关系。同一个id只能有两个组件绑定且是in/out不同类型角色, 不能多个组件绑定同一个id。 |
3380| NODE_RELATIVE_LAYOUT_CHAIN_MODE  | 指定以该组件为链头所构成的链的参数,支持属性设置、属性重置和属性获取接口。<br/>仅当父容器为RelativeContainer时生效<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:链的方向。枚举[ArkUI_Axis](#arkui_axis)。<br/>.value[1].i32:链的样式。枚举[ArkUI_RelativeLayoutChainStyle](#arkui_relativelayoutchainstyle)。<br/>.value[0].i32:链的方向。枚举[ArkUI_Axis](#arkui_axis)。<br/>.value[1].i32:链的样式。枚举[ArkUI_RelativeLayoutChainStyle](#arkui_relativelayoutchainstyle)。 |
3381| NODE_RENDER_FIT  | 设置宽高动画过程中的组件内容填充方式,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32 内容填充方式,使用[ArkUI_RenderFit](#arkui_renderfit)枚举值。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32 内容填充方式,使用[ArkUI_RenderFit](#arkui_renderfit)枚举值。 |
3382| NODE_OUTLINE_COLOR  | 外描边颜色属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>1: .value[0].u32:统一设置四条边的边框颜色,使用0xargb表示,如0xFFFF11FF。<br/>2: .value[0].u32:设置上侧边框颜色,使用0xargb表示,如0xFFFF11FF。<br/>.value[1].u32:设置右侧边框颜色,使用0xargb表示,如0xFFFF11FF。<br/>.value[2].u32:设置下侧边框颜色,使用0xargb表示,如0xFFFF11FF。<br/>.value[3].u32:设置左侧边框颜色,使用0xargb表示,如0xFFFF11FF。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:设置上侧边框颜色,使用0xargb表示,如0xFFFF11FF。<br/>.value[1].u32:设置右侧边框颜色,使用0xargb表示,如0xFFFF11FF。<br/>.value[2].u32:设置下侧边框颜色,使用0xargb表示,如0xFFFF11FF。<br/>.value[3].u32:设置左侧边框颜色,使用0xargb表示,如0xFFFF11FF。 |
3383| NODE_SIZE  | 设置高宽尺寸,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:宽度数值,单位为vp;<br/>.value[1].f32:高度数值,单位为vp;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:宽度数值,单位为vp;<br/>.value[1].f32:高度数值,单位为vp; |
3384| NODE_RENDER_GROUP  | 设置当前组件和子组件是否先整体离屏渲染绘制后再与父控件融合绘制,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].i32:参数类型为1或者0。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:参数类型为1或者0。 |
3385| NODE_COLOR_BLEND  | 为组件添加颜色叠加效果,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:叠加的颜色,使用0xargb表示,如0xFFFF11FF。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:叠加的颜色,使用0xargb表示,如0xFFFF11FF。 |
3386| NODE_FOREGROUND_BLUR_STYLE  | 为当前组件提供内容模糊能力,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32 表示内容模糊样式,取[ArkUI_BlurStyle](#arkui_blurstyle)枚举值。<br/>.value[1]?.i32 表示内容模糊效果使用的深浅色模式,取[ArkUI_ColorMode](#arkui_colormode)枚举值。<br/>.value[2]?.i32 表示内容模糊效果使用的取色模式,取[ArkUI_AdaptiveColor](#arkui_adaptivecolor)枚举值。<br/>.value[3]?.f32 表示模糊效果程度,取[0.0,1.0]范围内的值。<br/>.value[4]?.i32 表示灰阶模糊参数,对黑色的提亮程度,取值范围为[0,127]。<br/>.value[5]?.i32 表示灰阶模糊参数,对白色的压暗程度,取值范围为[0,127]。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32 表示内容模糊样式,取[ArkUI_BlurStyle](#arkui_blurstyle)枚举值。<br/>.value[1].i32 表示内容模糊效果使用的深浅色模式,取[ArkUI_ColorMode](#arkui_colormode)枚举值。<br/>.value[2].i32 表示内容模糊效果使用的取色模式,取[ArkUI_AdaptiveColor](#arkui_adaptivecolor)枚举值。<br/>.value[3].f32 表示模糊效果程度,取[0.0,1.0]范围内的值。<br/>.value[4].i32 表示灰阶模糊参数,对黑色的提亮程度,取值范围为[0,127]。<br/>.value[5].i32 表示灰阶模糊参数,对白色的压暗程度,取值范围为[0,127]。 |
3387| NODE_LAYOUT_RECT  | 组件布局大小位置属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:组件X轴坐标,单位为px;<br/>.value[1].i32:组件Y轴坐标,单位为px;<br/>.value[2].i32:组件宽度,单位为px;<br/>.value[3].i32:组件高度,单位为px;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:组件X轴坐标,单位为px;<br/>.value[1].i32:组件Y轴坐标,单位为px;<br/>.value[2].i32:组件宽度,单位为px;<br/>.value[3].i32:组件高度,单位为px; |
3388| NODE_FOCUS_ON_TOUCH  | 设置当前组件是否支持点击获焦能力,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].i32:参数类型为1或者0。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:参数类型为1或者0。 |
3389| NODE_BORDER_WIDTH_PERCENT  | 边框宽度属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>1: .value[0].f32:统一设置四条边的边框宽度,单位为百分比。<br/>2: .value[0].f32:设置上边框的边框宽度,单位为百分比。<br/>.value[1].f32:设置右边框的边框宽度,单位为百分比。<br/>.value[2].f32:设置下边框的边框宽度,单位为百分比。<br/>.value[3].f32:设置左边框的边框宽度,单位为百分比。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:设置上边框的边框宽度,单位为百分比。<br/>.value[1].f32:设置右边框的边框宽度,单位为百分比。<br/>.value[2].f32:设置下边框的边框宽度,单位为百分比。<br/>.value[3].f32:设置左边框的边框宽度,单位为百分比。 |
3390| NODE_BORDER_RADIUS_PERCENT  | 边框圆角属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>1: .value[0].f32:统一设置四条边的边框圆角半径,单位为百分比。<br/>2: .value[0].f32:设置左上角圆角半径,单位为百分比。<br/>.value[1].f32:设置右上角圆角半径,单位为百分比。<br/>.value[2].f32:设置左下角圆角半径,单位为百分比。<br/>.value[3].f32:设置右下角圆角半径,单位为百分比。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:设置左上角圆角半径,单位为百分比。<br/>.value[1].f32:设置右上角圆角半径,单位为百分比。<br/>.value[2].f32:设置左下角圆角半径,单位为百分比。<br/>.value[3].f32:设置右下角圆角半径,单位为百分比。 |
3391| NODE_ACCESSIBILITY_ID  | 无障碍自定义标识ID,支持属性获取。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:无障碍自定义标识ID。 |
3392| NODE_ACCESSIBILITY_ACTIONS  | 定义无障碍支持操作类型属性,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].u32:配置无障碍操作类型,参数类型[ArkUI_AccessibilityActionType](#arkui_accessibilityactiontype)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:配置无障碍操作类型,参数类型[ArkUI_AccessibilityActionType](#arkui_accessibilityactiontype)。 |
3393| NODE_ACCESSIBILITY_ROLE  | 定义无障碍组件类型属性,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].u32:无障碍组件类型,参数类型[ArkUI_NodeType](#arkui_nodetype)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:无障碍组件类型,参数类型[ArkUI_NodeType](#arkui_nodetype)。 |
3394| NODE_ACCESSIBILITY_STATE  | 定义无障碍状态属性,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.object:参数类型为[ArkUI_AccessibilityState](#arkui_accessibilitystate)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object:参数类型为[ArkUI_AccessibilityState](#arkui_accessibilitystate)。 |
3395| NODE_ACCESSIBILITY_VALUE  | 定义无障碍信息属性,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.object:参数类型为[ArkUI_AccessibilityValue](#arkui_accessibilityvalue)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object:参数类型为[ArkUI_AccessibilityValue](#arkui_accessibilityvalue)。 |
3396| NODE_EXPAND_SAFE_AREA  | 定义控制组件扩展其安全区域,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0]?.u32:扩展安全区域的枚举值集合[ArkUI_SafeAreaType](#arkui_safeareatype), 例如:ARKUI_SAFE_AREA_TYPE_SYSTEM \| ARKUI_SAFE_AREA_TYPE_CUTOUT;<br/>.value[1]?.u32:扩展安全区域的方向枚举值集合[ArkUI_SafeAreaEdge](#arkui_safeareaedge);<br/>例如:ARKUI_SAFE_AREA_EDGE_TOP \| ARKUI_SAFE_AREA_EDGE_BOTTOM;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:扩展安全区域;<br/>。<br/>.value[1].u32:扩展安全区域的方向;<br/>。 |
3397| NODE_VISIBLE_AREA_CHANGE_RATIO  | 定义控制组件触发可视区域面积变更事件的可视区域面积占组件本身面积的比例阈值。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[...].f32:占比数值,输入范围0-1。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[...].f32:占比数值。 |
3398| NODE_TRANSITION  | 定义组件插入和删除时显示过渡动效,支持属性设置,属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.object:参数类型为[ArkUI_TransitionEffect](#arkui_transitioneffect)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object:参数类型为[ArkUI_TransitionEffect](#arkui_transitioneffect)。 |
3399| NODE_UNIQUE_ID  | 组件标识ID,支持属性获取。<br/>注解<br/>组件标识ID只读,且进程内唯一。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:组件标识ID。 |
3400| NODE_FOCUS_BOX  | 设置当前组件系统焦点框样式。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 焦点框相对组件边缘的距离。正数代表外侧,负数代表内侧。不支持百分比。<br/>.value[1].f32: 焦点框宽度。 不支持负数和百分比。<br/>.value[2].u32: 焦点框颜色。 |
3401| NODE_CLICK_DISTANCE  | 组件所绑定的点击手势移动距离限制,支持属性设置。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32 表示识别点击手势时允许手指在该范围内移动,单位为vp |
3402| NODE_TAB_STOP  | 控制焦点是否能停在当前组件,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].i32:参数类型为1或者0。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:参数类型为1或者0。 |
3403| NODE_BACKGROUND_IMAGE_RESIZABLE_WITH_SLICE  | 设置背景图在拉伸时可调整大小的属性,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].f32: 图片左部拉伸时,图片的像素值保持不变,单位为vp。<br/>.value[1].f32: 图片顶部拉伸时,图片的像素值保持不变,单位为vp。<br/>.value[2].f32: 图片右部拉伸时,图片的像素值保持不变,单位为vp。<br/>.value[3].f32: 图片底部拉伸时,图片的像素值保持不变,单位为vp。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 图片左部拉伸时,图片的像素值保持不变,单位为vp。<br/>.value[1].f32: 图片顶部拉伸时,图片的像素值保持不变,单位为vp。<br/>.value[2].f32: 图片右部拉伸时,图片的像素值保持不变,单位为vp。<br/>.value[3].f32: 图片底部拉伸时,图片的像素值保持不变,单位为vp。 <br/>起始版本:<br/>18 |
3404| NODE_NEXT_FOCUS   | 设置下一个走焦节点。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].i32:走焦类型。参数类型为{@link ArkUI_FocusMove}。<br/>.object:下一个焦点。参数类型为{@link ArkUI_NodeHandle}。 <br/>起始版本:<br/>18 |
3405| NODE_VISIBLE_AREA_APPROXIMATE_CHANGE_RATIO  | 设置可见区域变化监听的参数。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.object:参数类型为{@link ArkUI_VisibleAreaEventOptions}。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>object:参数类型为{@link ArkUI_VisibleAreaEventOptions}。 <br/>起始版本:<br/>17 |
3406| NODE_TEXT_CONTENT  | text组件设置文本内容属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string 表示文本内容<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string 表示文本内容 |
3407| NODE_FONT_COLOR  | 组件字体颜色属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:字体颜色数值,0xargb格式,形如 0xFFFF0000 表示红色;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:字体颜色数值,0xargb格式; |
3408| NODE_FONT_SIZE  | 组件字体大小属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:字体大小数值,单位为fp;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:字体大小数值,单位为fp; |
3409| NODE_FONT_STYLE  | 组件字体样式属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:字体样式[ArkUI_FontStyle](#arkui_fontstyle),默认值为ARKUI_FONT_STYLE_NORMAL;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:字体样式[ArkUI_FontStyle](#arkui_fontstyle); |
3410| NODE_FONT_WEIGHT  | 组件字体粗细属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:字体粗细样式[ArkUI_FontWeight](#arkui_fontweight),默认值为ARKUI_FONT_WEIGHT_NORMAL;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:字体粗细样式[ArkUI_FontWeight](#arkui_fontweight); |
3411| NODE_TEXT_LINE_HEIGHT  | 文本行高属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32 表示lineHeight值,单位为fp<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32 表示lineHeight值,单位为fp |
3412| NODE_TEXT_DECORATION  | 置文本装饰线样式及其颜色属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:文本装饰线类型[ArkUI_TextDecorationType](#arkui_textdecorationtype),默认值为ARKUI_TEXT_DECORATION_TYPE_NONE;<br/>.value[1]?.u32:可选值,装饰线颜色,0xargb格式,形如 0xFFFF0000 表示红色;<br/>.value[2]?.i32:文本装饰线样式[ArkUI_TextDecorationStyle](#arkui_textdecorationstyle);<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:文本装饰线类型[ArkUI_TextDecorationType](#arkui_textdecorationtype);<br/>.value[1].u32:装饰线颜色,0xargb格式。<br/>.value[2].i32:文本装饰线样式[ArkUI_TextDecorationStyle](#arkui_textdecorationstyle); |
3413| NODE_TEXT_CASE  | 文本大小写属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32 表示文本大小写类型<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32 表示文本大小写类型 |
3414| NODE_TEXT_LETTER_SPACING  | 文本字符间距属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32 表示字符间距值,单位为fp<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32 表示字符间距值,单位为fp |
3415| NODE_TEXT_MAX_LINES  | 文本最大行数属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32 表示最大行数<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32 表示最大行数 |
3416| NODE_TEXT_ALIGN  | 文本水平对齐方式, 支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:表示文本水平对齐方式,取[ArkUI_TextAlignment](#arkui_textalignment)枚举值。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:表示文本水平对齐方式,取[ArkUI_TextAlignment](#arkui_textalignment)枚举值。 |
3417| NODE_TEXT_OVERFLOW  | 文本超长时的显示方式属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:表示文本超长时的显示方式。{\@ArkUI_TextOverflow}<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:表示文本超长时的显示方式。{\@ArkUI_TextOverflow} |
3418| NODE_FONT_FAMILY  | Text字体列表属性,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.string:字体字符串,多个用,分隔。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string:字体字符串,多个用,分隔。 |
3419| NODE_TEXT_COPY_OPTION  | 文本复制粘贴属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:复制粘贴方式[ArkUI_CopyOptions](#arkui_copyoptions),默认值为ARKUI_COPY_OPTIONS_NONE;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:复制粘贴方式[ArkUI_CopyOptions](#arkui_copyoptions)。 |
3420| NODE_TEXT_BASELINE_OFFSET  | 文本基线的偏移量属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:偏移量数值,单位为fp;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:偏移量数值,单位为fp。 |
3421| NODE_TEXT_TEXT_SHADOW  | 文字阴影效果属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:阴影模糊半径,单位为vp;<br/>.value[1].i32:阴影类型[ArkUI_ShadowType](#arkui_shadowtype),默认值为ARKUI_SHADOW_TYPE_COLOR;<br/>.value[2].u32:阴影颜色,0xargb格式,形如 0xFFFF0000 表示红色;<br/>.value[3].f32:阴影X轴偏移量,单位为vp;<br/>.value[4].f32:阴影Y轴偏移量,单位为vp;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:阴影模糊半径,单位为vp;<br/>.value[1].i32:阴影类型[ArkUI_ShadowType](#arkui_shadowtype);<br/>.value[2].u32:阴影颜色,0xargb格式;<br/>.value[3].f32:阴影X轴偏移量,单位为vp;<br/>.value[4].f32:阴影Y轴偏移量,单位为vp; |
3422| NODE_TEXT_MIN_FONT_SIZE  | Text最小显示字号,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].f32:文本最小显示字号,单位FP。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:文本最小显示字号,单位FP。 |
3423| NODE_TEXT_MAX_FONT_SIZE  | Text最大显示字号,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].f32:文本最大显示字号 单位FP。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:文本最大显示字号 单位FP。 |
3424| NODE_TEXT_FONT  | Text样式,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.string?:可选值 字体列表,使用多个字体,使用','进行分割。<br/>.value[0].f32:文本尺寸 单位FP。<br/>.value[1]?.i32:可选值,文本的字体粗细,参数类型[ArkUI_FontWeight](#arkui_fontweight)。 默认值为ARKUI_FONT_WEIGHT_NORMAL。<br/>.value[2]?.i32:可选值,字体样式,参数类型[ArkUI_FontStyle](#arkui_fontstyle)。 默认值为ARKUI_FONT_STYLE_NORMAL。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string:字体列表,使用多个字体,使用','进行分割。<br/>.value[0].f32:文本尺寸 单位FP。<br/>.value[1].i32:文本的字体粗细,参数类型[ArkUI_FontWeight](#arkui_fontweight)。 默认值为ARKUI_FONT_WEIGHT_NORMAL。<br/>.value[2].i32:字体样式,参数类型[ArkUI_FontStyle](#arkui_fontstyle)。 默认值为ARKUI_FONT_STYLE_NORMAL。 |
3425| NODE_TEXT_HEIGHT_ADAPTIVE_POLICY  | Text自适应高度的方式,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].i32:参数类型[ArkUI_TextHeightAdaptivePolicy](#arkui_textheightadaptivepolicy)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:参数类型[ArkUI_TextHeightAdaptivePolicy](#arkui_textheightadaptivepolicy)。 |
3426| NODE_TEXT_INDENT  | 文本首行缩进属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 表示首行缩进值。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 表示首行缩进值。 |
3427| NODE_TEXT_WORD_BREAK  | 文本断行规则属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 参数类型[ArkUI_WordBreak](#arkui_wordbreak)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 参数类型[ArkUI_WordBreak](#arkui_wordbreak)。 |
3428| NODE_TEXT_ELLIPSIS_MODE  | 设置文本省略位置,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 参数类型[ArkUI_EllipsisMode](#arkui_ellipsismode)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 参数类型[ArkUI_EllipsisMode](#arkui_ellipsismode)。 |
3429| NODE_TEXT_LINE_SPACING  | 文本行间距属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32 表示lineSpacing值,单位为fp<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32 表示lineSpacing值,单位为fp |
3430| NODE_FONT_FEATURE  | 设置文本特性效果,设置NODE_FONT_FEATURE属性, NODE_FONT_FEATURE是 OpenType 字体的高级排版能力,<br/>如支持连字、数字等宽等特性,一般用在自定义字体中,其能力需要字体本身支持, 支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string 符合文本特性格式的字符串,格式为normal \| &lt;feature-tag-value&gt;,<br/>&lt;feature-tag-value&gt;的格式为:&lt;string&gt; [ &lt;integer&gt; \| on \| off ],<br/>&lt;feature-tag-value&gt;的个数可以有多个,中间用','隔开,例如,使用等宽数字的输入格式为:ss01 on。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string 表示文本特性的内容,多个文本特性之间使用逗号分隔。 |
3431| NODE_TEXT_ENABLE_DATA_DETECTOR  | 设置使能文本识别。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:使能文本识别,默认值false。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:使能文本识别。 |
3432| NODE_TEXT_ENABLE_DATA_DETECTOR_CONFIG  | 设置文本识别配置。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0...].i32: 实体类型数组,参数类型[ArkUI_TextDataDetectorType](#arkui_textdatadetectortype)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0...].i32:实体类型数组,参数类型[ArkUI_TextDataDetectorType](#arkui_textdatadetectortype)。 |
3433| NODE_TEXT_SELECTED_BACKGROUND_COLOR  | 文本选中时的背景色属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:颜色数值,0xargb格式,形如 0xFFFF0000 表示红色。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:颜色数值,0xargb格式。 |
3434| NODE_TEXT_CONTENT_WITH_STYLED_STRING  | text组件使用格式化字符串对象设置文本内容属性,支持属性设置,属性重置,属性获取接口。 配置自定义**OH_Drawing_Typography**对象到text组件,会跳过文本控件的布局测算阶段,需要注意:<br/>1、需要保证**OH_ArkUI_StyledString**对象、**OH_Drawing_Typography**对象的生命周期跟随Text 组件生命周期,Text组件析构时重置**OH_ArkUI_StyledString**对象,否则会导致应用出现空指针崩溃。<br/>2、保证**OH_Drawing_TypographyLayout**方法调用时序在Text组件的布局测算之前。<br/>3、释放**OH_ArkUI_StyledString**对象、**OH_Drawing_Typography**对象时,需要同步调用Text 组件的reset方法,否则会导致应用出现空指针崩溃。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object 表示 ArkUI_StyledString 格式化字符串数据,参数类型为[ArkUI_StyledString](#arkui_styledstring)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object 表示 ArkUI_StyledString 格式化字符串数据,参数类型为[ArkUI_StyledString](#arkui_styledstring)。 |
3435| NODE_TEXT_HALF_LEADING  | text组件设置文本纵向居中显示。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:文本是否纵向居中显示,默认值false。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:文本是否纵向居中显示。 |
3436| NODE_IMMUTABLE_FONT_WEIGHT  | 组件字体粗细属性,支持属性设置,属性重置和属性获取接口。通过此接口设置的文字粗细属性不会跟随系统字体粗细而变化。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:字体粗细样式[ArkUI_FontWeight](#arkui_fontweight),默认值为ARKUI_FONT_WEIGHT_NORMAL;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:字体粗细样式[ArkUI_FontWeight](#arkui_fontweight); |
3437| NODE_SPAN_CONTENT  | 文本内容属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string 表示span的文本内容。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string 表示span的文本内容。 |
3438| NODE_SPAN_TEXT_BACKGROUND_STYLE  | 文本背景色属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32 表示文本背景颜色,0xargb格式,形如0xFFFF0000 表示红色。<br/>第二个参数为文本背景圆角设置,支持如下两种设置方式:<br/>1:.value[1].f32:四个方向的圆角半径统一设置,单位为vp。<br/>2: .value[1].f32:设置左上角圆角半径,单位为vp。<br/>.value[2].f32:设置右上角圆角半径,单位为vp。<br/>.value[3].f32:设置左下角圆角半径,单位为vp。<br/>.value[4].f32:设置右下角圆角半径,单位为vp。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:文本背景颜色,0xargb格式。<br/>.value[1].f32:左上角圆角半径,单位为vp。<br/>.value[2].f32:右上角圆角半径,单位为vp。<br/>.value[3].f32:左下角圆角半径,单位为vp。<br/>.value[4].f32:右下角圆角半径,单位为vp。 |
3439| NODE_SPAN_BASELINE_OFFSET  | 文本基线的偏移量属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:偏移量数值,单位为fp;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:偏移量数值,单位为fp。 |
3440| NODE_IMAGE_SPAN_SRC  | imageSpan组件图片地址属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string 表示imageSpan的图片地址<br/>.object 表示 PixelMap 图片数据,参数类型为[ArkUI_DrawableDescriptor](#arkui_drawabledescriptor)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string 表示imageSpan的图片地址<br/>.object 表示 PixelMap 图片数据,参数类型为[ArkUI_DrawableDescriptor](#arkui_drawabledescriptor);.object参数和.string参数二选一,不可同时设置。 |
3441| NODE_IMAGE_SPAN_VERTICAL_ALIGNMENT  | 图片基于文本的对齐方式属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32 表示图片基于文本的对齐方式,取[ArkUI_ImageSpanAlignment](#arkui_imagespanalignment)枚举值。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32 表示图片基于文本的对齐方式,取[ArkUI_ImageSpanAlignment](#arkui_imagespanalignment)枚举值。 |
3442| NODE_IMAGE_SPAN_ALT  | imageSpan组件占位图地址属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string 表示image组件占位图地址(不支持gif类型图源)。<br/>.object 表示 PixelMap 图片数据,参数类型为[ArkUI_DrawableDescriptor](#arkui_drawabledescriptor);.object参数和.string参数二选一,不可同时设置。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string 表示image组件占位图地址。<br/>.object 表示 PixelMap 图片数据,参数类型为[ArkUI_DrawableDescriptor](#arkui_drawabledescriptor)。 |
3443| NODE_IMAGE_SPAN_BASELINE_OFFSET  | imageSpan组件的基线偏移量属性,支持属性设置,属性重置和属性获取接口。 偏移量数值为正数时向上偏移,负数时向下偏移,默认值0,单位为fp。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:偏移量数值,单位为fp;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:偏移量数值,单位为fp。 |
3444| NODE_IMAGE_SRC  | image组件设置图片地址属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string 表示image组件地址。<br/>.object 表示 PixelMap 图片数据,参数类型为[ArkUI_DrawableDescriptor](#arkui_drawabledescriptor);.object参数和.string参数二选一,不可同时设置。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string 表示image组件地址。<br/>.object 表示 PixelMap 图片数据,参数类型为[ArkUI_DrawableDescriptor](#arkui_drawabledescriptor)。 |
3445| NODE_IMAGE_OBJECT_FIT  | 图片填充效果属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32 表示图片填充效果,取[ArkUI_ObjectFit](#arkui_objectfit)枚举值。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32 表示图片填充效果,取[ArkUI_ObjectFit](#arkui_objectfit)枚举值。 |
3446| NODE_IMAGE_INTERPOLATION  | 图片插值效果效果属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32 表示插值效果效果,取[ArkUI_ImageInterpolation](#arkui_imageinterpolation)枚举值。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32 表示插值效果效果,取[ArkUI_ImageInterpolation](#arkui_imageinterpolation)枚举值。 |
3447| NODE_IMAGE_OBJECT_REPEAT  | 图片重复样式属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32 表示图片重复样式,取[ArkUI_ImageRepeat](#arkui_imagerepeat)枚举值。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32 表示图片重复样式,取[ArkUI_ImageRepeat](#arkui_imagerepeat)枚举值。 |
3448| NODE_IMAGE_COLOR_FILTER  | 图片滤镜效果属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32 ~ .value[19].f32 表示滤镜矩阵数组。<br/>.size 表示滤镜数组大小 5\*4。<br/>.object 颜色滤波器指针,参数类型为**OH_Drawing_ColorFilter**,.object和.size参数只能二选一,不可同时设置。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32 ~ .value[19].f32 表示滤镜矩阵数组。<br/>.size 表示滤镜数组大小 5\*4。<br/>.object 颜色滤波器指针,参数类型为**OH_Drawing_ColorFilter**。 |
3449| NODE_IMAGE_AUTO_RESIZE  | 图源自动缩放属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32 表示是否缩放布尔值。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32 表示是否缩放布尔值。 |
3450| NODE_IMAGE_ALT  | 占位图地址属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string 表示image组件占位图地址。<br/>.object 表示 PixelMap 图片数据,参数类型为[ArkUI_DrawableDescriptor](#arkui_drawabledescriptor);.object参数和.string参数二选一,不可同时设置。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string 表示image组件占位图地址。<br/>.object 表示 PixelMap 图片数据,参数类型为[ArkUI_DrawableDescriptor](#arkui_drawabledescriptor)。 |
3451| NODE_IMAGE_DRAGGABLE  | 图片拖拽效果属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32 表示是否支持拖拽,设置为true表示支持。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32 表示是否支持拖拽。 |
3452| NODE_IMAGE_RENDER_MODE  | 图片渲染模式属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32 参数类型[ArkUI_ImageRenderMode](#arkui_imagerendermode)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32 参数类型[ArkUI_ImageRenderMode](#arkui_imagerendermode)。 |
3453| NODE_IMAGE_FIT_ORIGINAL_SIZE  | 设置图片的显示尺寸是否跟随图源尺寸,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32,设置图片的显示尺寸是否跟随图源尺寸,1表示跟随,0表示不跟随,默认值为0。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32,1表示图片的显示尺寸跟随图源尺寸,0表示图片的显示尺寸不跟随图源尺寸。 |
3454| NODE_IMAGE_FILL_COLOR  | 设置填充颜色,设置后填充颜色会覆盖在图片上,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:填充色数值,0xargb格式,形如 0xFFFF0000 表示红色。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:填充色数值,0xargb格式。 |
3455| NODE_IMAGE_RESIZABLE  | 设置图像拉伸时,可调整大小的图像选项。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32 图片左部拉伸时,保持不变距离。单位vp。<br/>.value[1].f32 图片上部拉伸时,保持不变距离。单位vp。<br/>.value[2].f32 图片右部拉伸时,保持不变距离。单位vp。<br/>.value[3].f32 图片下部拉伸时,保持不变距离。单位vp。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32 图片左部拉伸时,保持不变距离。单位vp。<br/>.value[1].f32 图片上部拉伸时,保持不变距离。单位vp。<br/>.value[2].f32 图片右部拉伸时,保持不变距离。单位vp。<br/>.value[3].f32 图片下部拉伸时,保持不变距离。单位vp。 |
3456| NODE_TOGGLE_SELECTED_COLOR  | 组件打开状态的背景颜色属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:背景色数值,0xargb格式,形如 0xFFFF0000 表示红色。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:背景色数值,0xargb格式。 |
3457| NODE_TOGGLE_SWITCH_POINT_COLOR  | Switch类型的圆形滑块颜色属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:圆形滑块颜色数值,0xargb格式,形如 0xFFFF0000 表示红色。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:圆形滑块颜色数值,0xargb格式。 |
3458| NODE_TOGGLE_VALUE  | Switch类型的开关值,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:设置开关的值,true表示开启。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:设置开关的值。 |
3459| NODE_TOGGLE_UNSELECTED_COLOR  | 组件关闭状态的背景颜色属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:背景色数值,0xargb格式,形如 0xFFFF0000 表示红色。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:背景色数值,0xargb格式。 |
3460| NODE_LOADING_PROGRESS_COLOR  | 加载进度条前景色属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:前景颜色数值,0xargb格式,形如 0xFFFF0000 表示红色。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:前景颜色数值,0xargb格式。 |
3461| NODE_LOADING_PROGRESS_ENABLE_LOADING  | LoadingProgress动画显示属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:false时不显示动画,true时可以显示动画;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:0时不显示动画,1时可以显示动画。 |
3462| NODE_TEXT_INPUT_PLACEHOLDER  | 单行文本输入框的默认提示文本内容属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string:默认提示文本的内容。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string:默认提示文本的内容。 |
3463| NODE_TEXT_INPUT_TEXT  | 单行文本输入框的默认文本内容属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string:默认文本的内。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string:默认文本的内容。 |
3464| NODE_TEXT_INPUT_CARET_COLOR  | 光标颜色属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:光标颜色数值,0xargb格式,形如 0xFFFF0000 表示红色;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:光标颜色数值,0xargb格式。 |
3465| NODE_TEXT_INPUT_CARET_STYLE  | 光标风格属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:光标宽度数值,单位为vp;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:光标宽度数值,单位为vp。 |
3466| NODE_TEXT_INPUT_SHOW_UNDERLINE  | 单行文本输入框下划线属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:false表示不展示下划线,true表示展示下划线;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:0表示不展示下划线,1表示展示下划线。 |
3467| NODE_TEXT_INPUT_MAX_LENGTH  | 输入框支持的最大文本数属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:最大文本数的数字,无单位。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:最大文本数的数字。 |
3468| NODE_TEXT_INPUT_ENTER_KEY_TYPE  | 回车键类型属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:回车键类型枚举[ArkUI_EnterKeyType](#arkui_enterkeytype),默认值为ARKUI_ENTER_KEY_TYPE_DONE。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:回车键类型枚举[ArkUI_EnterKeyType](#arkui_enterkeytype)。 |
3469| NODE_TEXT_INPUT_PLACEHOLDER_COLOR  | 无输入时默认提示文本的颜色属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:颜色数值,0xargb格式,形如 0xFFFF0000 表示红色。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:颜色数值,0xargb格式。 |
3470| NODE_TEXT_INPUT_PLACEHOLDER_FONT  | 无输入时默认提示文本的字体配置(包括大小、字重、样式、字体列表)属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0]?.f32:可选字体大小数值,默认值16.0,单位为fp;<br/>.value[1]?.i32:可选字体样式[ArkUI_FontStyle](#arkui_fontstyle),默认值为ARKUI_FONT_STYLE_NORMAL;<br/>.value[2]?.i32:可选字体粗细样式[ArkUI_FontWeight](#arkui_fontweight),默认值为ARKUI_FONT_WEIGHT_NORMAL;<br/>?.string: 字体族内容,多个字体族之间使用逗号分隔,形如“字重;字体族1,字体族2”。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:字体大小数值,单位为fp;<br/>.value[1].i32:字体样式[ArkUI_FontStyle](#arkui_fontstyle);<br/>.value[2].i32:字体粗细样式[ArkUI_FontWeight](#arkui_fontweight);<br/>.string: 字体族内容,多个字体族之间使用逗号分隔。 |
3471| NODE_TEXT_INPUT_ENABLE_KEYBOARD_ON_FOCUS  | 聚焦时是否绑定输入法属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:false表示聚焦不拉起输入法,true表示拉起。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:0表示聚焦不拉起输入法,1表示拉起。 |
3472| NODE_TEXT_INPUT_TYPE  | 输入框的类型属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:输入框类型枚举[ArkUI_TextInputType](#arkui_textinputtype),默认值为ARKUI_TEXTINPUT_TYPE_NORMAL。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:输入框类型枚举[ArkUI_TextInputType](#arkui_textinputtype)。 |
3473| NODE_TEXT_INPUT_SELECTED_BACKGROUND_COLOR  | 输入框文本选中时的背景色属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:颜色数值,0xargb格式,形如 0xFFFF0000 表示红色。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:颜色数值,0xargb格式。 |
3474| NODE_TEXT_INPUT_SHOW_PASSWORD_ICON  | 密码输入模式时是否显示末尾图标属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:false表示不显示图标,true表示显示图标;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:0表示不显示图标,1表示显示图标。 |
3475| NODE_TEXT_INPUT_EDITING  | 控制单行文本输入框编辑态属性,支持属性设置。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:false表示退出编辑态,true表示维持现状。<br/>属性获取方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:false表示退出编辑态,true表示维持现状。 |
3476| NODE_TEXT_INPUT_CANCEL_BUTTON  | 单行文本右侧清除按钮样式属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:按钮样式[ArkUI_CancelButtonStyle](#arkui_cancelbuttonstyle),默认值为ARKUI_CANCELBUTTON_STYLE_INPUT;<br/>.value[1]?.f32:图标大小数值,单位为vp;<br/>.value[2]?.u32:按钮图标颜色数值,0xargb格式,形如 0xFFFF0000 表示红色;<br/>?.string:按钮图标地址,入参内容为图片本地地址,例如 /pages/icon.png。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:按钮样式[ArkUI_CancelButtonStyle](#arkui_cancelbuttonstyle);<br/>.value[1].f32:图标大小数值,单位为vp;<br/>.value[2].u32:按钮图标颜色数值,0xargb格式;<br/>.string:按钮图标地址。 |
3477| NODE_TEXT_INPUT_TEXT_SELECTION  | 单行文本设置文本选中并高亮的区域,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:选中文本的起始位置;<br/>.value[1].i32:选中文本的终止位置;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:选中文本的起始位置;<br/>.value[1].i32:选中文本的终止位置; |
3478| NODE_TEXT_INPUT_UNDERLINE_COLOR  | 开启下划线时,支持配置下划线颜色。<br/>主题配置的默认下划线颜色为'0x33182431'。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:typing,必填,键入时下划线颜色,0xargb类型;<br/>.value[1].u32:normal,必填,非特殊状态时下划线颜色,0xargb类型;<br/>.value[2].u32:error,必填,错误时下划线颜色,0xargb类型;<br/>.value[3].u32:disable,必填,禁用时下划线颜色,0xargb类型;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:typing,键入时下划线颜色,0xargb类型;<br/>.value[1].u32:normal,非特殊状态时下划线颜色,0xargb类型;<br/>.value[2].u32:error,错误时下划线颜色,0xargb类型;<br/>.value[3].u32:disable,禁用时下划线颜色,0xargb类型; |
3479| NODE_TEXT_INPUT_ENABLE_AUTO_FILL  | 设置是否启用自动填充。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 是否启用自动填充,默认值true。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 是否启用自动填充。 |
3480| NODE_TEXT_INPUT_CONTENT_TYPE  | 自动填充类型。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 参数类型[ArkUI_TextInputContentType](#arkui_textinputcontenttype)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 参数类型[ArkUI_TextInputContentType](#arkui_textinputcontenttype)。 |
3481| NODE_TEXT_INPUT_PASSWORD_RULES  | 定义生成密码的规则。在触发自动填充时,所设置的密码规则会透传给密码保险箱,用于新密码的生成。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 定义生成密码的规则。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 定义生成密码的规则。 |
3482| NODE_TEXT_INPUT_SELECT_ALL  | 设置当初始状态,是否全选文本。不支持内联模式。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 是否全选文本,默认值:false。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 是否全选文本。 |
3483| NODE_TEXT_INPUT_INPUT_FILTER  | 通过正则表达式设置输入过滤器。匹配表达式的输入允许显示,不匹配的输入将被过滤。仅支持单个字符匹配,不支持字符串匹配。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 正则表达式。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 正则表达式。 |
3484| NODE_TEXT_INPUT_STYLE  | 设置输入框为默认风格或内联输入风格。<br/>内联输入风格只支持InputType.Normal类型<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 参数类型[ArkUI_TextInputStyle](#arkui_textinputstyle)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 参数类型[ArkUI_TextInputStyle](#arkui_textinputstyle)。 |
3485| NODE_TEXT_INPUT_CARET_OFFSET  | 设置或获取光标所在位置信息。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>设置输入光标的位置。 .value[0].i32: 从字符串开始到光标所在位置的字符长度。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>返回当前光标所在位置信息。在当前帧更新光标位置同时调用该接口,该接口不生效 value[0].i32:光标所在位置的索引值。<br/>value[1].f32:光标相对输入框的x坐标位值。<br/>value[2].f32:光标相对输入框的y坐标位值。 |
3486| NODE_TEXT_INPUT_CONTENT_RECT  | 获取已编辑文本内容区域相对组件的位置和大小。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>value[0].f32:水平方向横坐标。<br/>value[1].f32:竖直方向纵坐标。<br/>value[2].f32:内容宽度大小。<br/>value[3].f32:内容高度大小。 |
3487| NODE_TEXT_INPUT_CONTENT_LINE_COUNT  | 获取已编辑文本内容的行数。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>value[0].i32:已编辑文本内容行数。 |
3488| NODE_TEXT_INPUT_SELECTION_MENU_HIDDEN  | 设置长按、双击输入框或者右键输入框时,是否不弹出文本选择菜单,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 长按、双击输入框或者右键输入框时,是否不弹出文本选择菜单。默认值false。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 长按、双击输入框或者右键输入框时,是否不弹出文本选择菜单。 |
3489| NODE_TEXT_INPUT_BLUR_ON_SUBMIT  | 设置输入框在submit状态下,触发回车键是否失焦。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:是否失焦。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:是否失焦。 |
3490| NODE_TEXT_INPUT_CUSTOM_KEYBOARD  | 设置自定义键盘。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object:自定义键盘,参数类型{\@Link ArkUI_NodeHandle}。<br/>.value[0]?.i32:设置自定义键盘是否支持避让功能,默认值false。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object:自定义键盘,参数类型{\@Link ArkUI_NodeHandle}。<br/>.value[0].i32:设置自定义键盘是否支持避让功能。 |
3491| NODE_TEXT_INPUT_WORD_BREAK  | 文本断行规则属性,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 参数类型[ArkUI_WordBreak](#arkui_wordbreak)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 参数类型[ArkUI_WordBreak](#arkui_wordbreak)。 |
3492| NODE_TEXT_INPUT_NUMBER_OF_LINES  | 设置该属性后,通过该属性计算textInput组件的高度。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 设置numberOfLines的值。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 设置numberOfLines的值。 |
3493| NODE_TEXT_INPUT_SHOW_KEYBOARD_ON_FOCUS  | 设置输入框获取焦点时是否弹出键盘,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 是否弹出键盘。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 是否弹出键盘。 |
3494| NODE_TEXT_INPUT_LETTER_SPACING  | 设置输入框字符间距,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 字符间距,默认单位为FP。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 字符间距,默认单位为FP。 |
3495| NODE_TEXT_INPUT_ENABLE_PREVIEW_TEXT  | 设置输入框开启字符预上屏,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 是否开启字符预上屏。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 是否开启字符预上屏。 |
3496| NODE_TEXT_INPUT_HALF_LEADING  | 设置文本将行间距平分至行的顶部与底部。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 文本是否将行间距平分至行的顶部与底部,默认值false。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 文本是否将行间距平分至行的顶部与底部。 |
3497| NODE_TEXT_INPUT_KEYBOARD_APPEARANCE  | 设置输入框拉起的键盘样式。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 设置对应的键盘样式,类型为[ArkUI_KeyboardAppearance](#arkui_keyboardappearance)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 对应的键盘样式,类型为[ArkUI_KeyboardAppearance](#arkui_keyboardappearance)。<br/>起始版本:<br/>15 |
3498| NODE_TEXT_AREA_PLACEHOLDER  | 多行文本输入框的默认提示文本内容属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string:默认提示文本的内容。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string:默认提示文本的内容。 |
3499| NODE_TEXT_AREA_TEXT  | 多行文本输入框的默认文本内容属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string:默认文本的内容。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string:默认文本的内容。 |
3500| NODE_TEXT_AREA_MAX_LENGTH  | 输入框支持的最大文本数属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:最大文本数的数字。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:最大文本数的数字。 |
3501| NODE_TEXT_AREA_PLACEHOLDER_COLOR  | 无输入时默认提示文本的颜色属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:颜色数值,0xargb格式,形如 0xFFFF0000 表示红色。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:颜色数值,0xargb格式。 |
3502| NODE_TEXT_AREA_PLACEHOLDER_FONT  | 无输入时默认提示文本的字体配置(包括大小、字重、样式、字体列表)属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0]?.f32:可选字体大小数值,默认值16.0,单位为fp;<br/>.value[1]?.i32:可选字体样式[ArkUI_FontStyle](#arkui_fontstyle),默认值为ARKUI_FONT_STYLE_NORMAL;<br/>.value[2]?.i32:可选字体粗细样式[ArkUI_FontWeight](#arkui_fontweight),默认值为ARKUI_FONT_WEIGHT_NORMAL;<br/>?.string: 字体族内容,多个字体族之间使用逗号分隔,形如“字重;字体族1,字体族2”。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:字体大小数值,单位为fp;<br/>.value[1].i32:字体样式[ArkUI_FontStyle](#arkui_fontstyle);<br/>.value[2].i32:字体粗细样式[ArkUI_FontWeight](#arkui_fontweight);<br/>.string: 字体族内容,多个字体族之间使用逗号分隔。 |
3503| NODE_TEXT_AREA_CARET_COLOR  | 光标颜色属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:背景色数值,0xargb格式,形如 0xFFFF0000 表示红色。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:背景色数值,0xargb格式。 |
3504| NODE_TEXT_AREA_EDITING  | 控制多行文本输入框编辑态属性,支持属性设置。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:false表示退出编辑态,true表示维持现状。<br/>属性获取方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:false表示退出编辑态,true表示维持现状。 |
3505| NODE_TEXT_AREA_TYPE  | 输入框的类型属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:输入框类型枚举[ArkUI_TextAreaType](#arkui_textareatype),默认值为ARKUI_TEXTAREA_TYPE_NORMAL。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:输入框类型枚举[ArkUI_TextAreaType](#arkui_textareatype)。 |
3506| NODE_TEXT_AREA_SHOW_COUNTER  | 设置输入的字符数超过阈值时是否显示计数器并设置计数器样式,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:是否开启计数器,值为true时为开启。<br/>.value[1]?.f32:可输入字符数占最大字符限制的百分比值,超过此值时显示计数器,取值范围1-100,小数时向下取整。<br/>.value[2]?.i32:输入字符超出限制时是否高亮边框。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:是否开启计数器。<br/>.value[1].f32:可输入字符数占最大字符限制的百分比值,超过此值时显示计数器,取值范围1-100。<br/>.value[2].i32:输入字符超出限制时是否高亮边框,默认高亮。 |
3507| NODE_TEXT_AREA_SELECTION_MENU_HIDDEN  | 设置长按、双击输入框或者右键输入框时,是否不弹出文本选择菜单,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 长按、双击输入框或者右键输入框时,是否不弹出文本选择菜单。默认值false。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 长按、双击输入框或者右键输入框时,是否不弹出文本选择菜单。 |
3508| NODE_TEXT_AREA_BLUR_ON_SUBMIT  | 设置多行输入框在submit状态下,触发回车键是否失焦。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:是否失焦。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:是否失焦。 |
3509| NODE_TEXT_AREA_INPUT_FILTER  | 通过正则表达式设置输入过滤器。匹配表达式的输入允许显示,不匹配的输入将被过滤。仅支持单个字符匹配,不支持字符串匹配。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 正则表达式。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 正则表达式。 |
3510| NODE_TEXT_AREA_SELECTED_BACKGROUND_COLOR  | 设置文本选中底板颜色,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:颜色数值,0xargb格式,形如 0xFFFF0000 表示红色。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:颜色数值,0xargb格式。 |
3511| NODE_TEXT_AREA_ENTER_KEY_TYPE  | 设置输入法回车键类型,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:回车键类型枚举[ArkUI_EnterKeyType](#arkui_enterkeytype),默认值为ARKUI_ENTER_KEY_TYPE_DONE。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:回车键类型枚举[ArkUI_EnterKeyType](#arkui_enterkeytype)。 |
3512| NODE_TEXT_AREA_ENABLE_KEYBOARD_ON_FOCUS  | 设置TextArea通过点击以外的方式获焦时,是否绑定输入法,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:false表示聚焦不拉起输入法,true表示拉起,默认值为true。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:0表示聚焦不拉起输入法,1表示拉起。 |
3513| NODE_TEXT_AREA_CARET_OFFSET  | 设置或获取光标所在位置信息。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>设置输入光标的位置。 .value[0].i32: 从字符串开始到光标所在位置的字符长度。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>返回当前光标所在位置信息。在当前帧更新光标位置同时调用该接口,该接口不生效 value[0].i32:光标所在位置的索引值。<br/>value[1].f32:光标相对输入框的x坐标位值。<br/>value[2].f32:光标相对输入框的y坐标位值。 |
3514| NODE_TEXT_AREA_CONTENT_RECT  | 获取已编辑文本内容区域相对组件的位置和大小。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>value[0].f32:水平方向横坐标。<br/>value[1].f32:竖直方向纵坐标。<br/>value[2].f32:内容宽度大小。<br/>value[3].f32:内容高度大小。 |
3515| NODE_TEXT_AREA_CONTENT_LINE_COUNT  | 获取已编辑文本内容的行数。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>value[0].i32:已编辑文本内容行数。 |
3516| NODE_TEXT_AREA_TEXT_SELECTION  | 组件在获焦状态下,调用该接口设置文本选择区域并高亮显示,且只有在selectionStart小于selectionEnd时,文字才会被选取、高亮显示。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:选中文本的起始位置;<br/>.value[1].i32:选中文本的终止位置;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:选中文本的起始位置;<br/>.value[1].i32:选中文本的终止位置; |
3517| NODE_TEXT_AREA_ENABLE_AUTO_FILL  | 设置是否启用自动填充。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 是否启用自动填充,默认值true。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 是否启用自动填充。 |
3518| NODE_TEXT_AREA_CONTENT_TYPE  | 自动填充类型。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 参数类型[ArkUI_TextInputContentType](#arkui_textinputcontenttype)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 参数类型[ArkUI_TextInputContentType](#arkui_textinputcontenttype)。 |
3519| NODE_TEXT_AREA_NUMBER_OF_LINES  | 设置该属性后,通过该属性计算textArea组件的高度。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 设置numberOfLines的值。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 设置numberOfLines的值。 |
3520| NODE_TEXT_AREA_SHOW_KEYBOARD_ON_FOCUS  | 设置输入框获取焦点时是否弹出键盘,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 是否弹出键盘。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 是否弹出键盘。 |
3521| NODE_TEXT_AREA_LETTER_SPACING  | 设置输入框字符间距,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 字符间距,默认单位为FP。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 字符间距,默认单位为FP。 |
3522| NODE_TEXT_AREA_ENABLE_PREVIEW_TEXT  | 设置输入框开启字符预上屏,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 是否开启字符预上屏。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 是否开启字符预上屏。 |
3523| NODE_TEXT_AREA_HALF_LEADING  | 设置文本将行间距平分至行的顶部与底部。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 文本是否将行间距平分至行的顶部与底部,默认值false。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 文本是否将行间距平分至行的顶部与底部。 |
3524| NODE_TEXT_AREA_KEYBOARD_APPEARANCE  | 设置输入框拉起的键盘样式。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 设置对应的键盘样式,类型为[ArkUI_KeyboardAppearance](#arkui_keyboardappearance)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 对应的键盘样式,类型为[ArkUI_KeyboardAppearance](#arkui_keyboardappearance)。<br/>起始版本:<br/>15 |
3525| NODE_BUTTON_LABEL  | button按钮的文本内容属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string:默认文本的内容。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string:默认文本的内容。 |
3526| NODE_BUTTON_TYPE  | Button按钮的样式属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:设置Button按钮的样式,参数类型[ArkUI_ButtonType](#arkui_buttontype),默认值为ARKUI_BUTTON_TYPE_CAPSULE。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:获取Button按钮的样式,参数类型[ArkUI_ButtonType](#arkui_buttontype),默认值为ARKUI_BUTTON_TYPE_CAPSULE。 |
3527| NODE_BUTTON_MIN_FONT_SCALE<sup>18+</sup>  | 设置文本最小的字体缩放倍数,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 设置Button按钮的最小字体缩放倍数,默认单位fp。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 获取Button按钮的最小字体缩放倍数,默认单位fp。 |
3528| NODE_BUTTON_MAX_FONT_SCALE<sup>18+</sup>  | 设置文本最大的字体缩放倍数,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 设置Button按钮的最大字体缩放倍数,默认单位fp。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 获取Button按钮的最大字体缩放倍数,默认单位fp。 |
3529| NODE_PROGRESS_VALUE  | 进度条的当前进度值属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:进度条当前值。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:进度条当前值。 |
3530| NODE_PROGRESS_TOTAL  | 进度条的总长属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:进度条总长。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:进度条总长。 |
3531| NODE_PROGRESS_COLOR  | 进度条显示进度值的颜色属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:颜色数值,0xargb格式,形如 0xFFFF0000 表示红色。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:颜色数值,0xargb格式。 |
3532| NODE_PROGRESS_TYPE  | 进度条的类型属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:进度条类型枚举值[ArkUI_ProgressType](#arkui_progresstype),默认值为ARKUI_PROGRESS_TYPE_LINEAR。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:进度条类型枚举值[ArkUI_ProgressType](#arkui_progresstype)。 |
3533| NODE_PROGRESS_LINEAR_STYLE | 线性进度条样式,支持属性设置,属性重置和属性获取接口,如果进度条类型不是线性样式则不生效。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object:使用{@link [ArkUI_ProgressLinearStyleOption](#arkui_progresslinearstyleoption)}对象设置组件样式。 <br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object:使用{@link [ArkUI_ProgressLinearStyleOption](#arkui_progresslinearstyleoption)}对象获取组件样式。|
3534| NODE_CHECKBOX_SELECT  | CheckBox多选框是否选中,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].i32:1表示选中,0表示不选中。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:1表示选中,0表示不选中。 |
3535| NODE_CHECKBOX_SELECT_COLOR  | CheckBox多选框选中状态颜色,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].u32:多选框选中状态颜色, 类型为0xargb,如0xFF1122FF。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:多选框选中状态颜色, 类型为0xargb,如0xFF1122FF。 |
3536| NODE_CHECKBOX_UNSELECT_COLOR  | CheckBox多选框非选中状态边框颜色,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].u32:边框颜色, 类型为0xargb,如0xFF1122FF。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:边框颜色, 类型为0xargb,如0xFF1122FF。 |
3537| NODE_CHECKBOX_MARK  | CheckBox多选框内部图标样式,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].u32:边框颜色, 类型为0xargb,如0xFF1122FF;<br/>.value[1]?.f32:可选,内部图标大小,单位vp;<br/>.value[2]?.f32:可选,内部图标粗细,单位vp,默认值2。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:边框颜色, 类型为0xargb,如0xFF1122FF;<br/>.value[1].f32:内部图标大小,单位vp;<br/>.value[2].f32:内部图标粗细,单位vp,默认值2。 |
3538| NODE_CHECKBOX_SHAPE  | CheckBox组件形状, 支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].i32:组件形状,参数类型[ArkUI_CheckboxShape](#arkui_checkboxshape)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:组件形状,参数类型[ArkUI_CheckboxShape](#arkui_checkboxshape)。 |
3539| NODE_CHECKBOX_NAME  | CheckBox名称设置, 支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.string:多选框名称。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string:多选框名称。<br/>起始版本:15 |
3540| NODE_CHECKBOX_GROUP  | CheckBox多选框所属群组的名称设置, 支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.string:多选框所属群组的名称。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string:多选框所属群组的名称。<br/>起始版本:15 |
3541| NODE_XCOMPONENT_ID  | XComponent组件ID属性,支持属性设置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: ID的内容。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: ID的内容。 |
3542| NODE_XCOMPONENT_TYPE  | XComponent的类型,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:字体样式[ArkUI_XComponentType](#arkui_xcomponenttype),默认值为ARKUI_XCOMPONENT_TYPE_SURFACE;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:字体样式[ArkUI_XComponentType](#arkui_xcomponenttype)。 |
3543| NODE_XCOMPONENT_SURFACE_SIZE  | 设置XComponent的宽高,支持属性设置和获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:宽数值,单位为px;<br/>.value[1].u32:高数值,单位为px;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:宽数值,单位为px;<br/>.value[1].u32:高数值,单位为px; |
3544| NODE_XCOMPONENT_SURFACE_RECT | 设置XComponent持有Surface的显示区域,仅XComponent类型为SURFACE("surface")或TEXTURE时有效。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:Surface显示区域相对于XComponent组件左上角的x轴坐标,单位为px。<br/>.value[1].i32:Surface显示区域相对于XComponent组件左上角的y轴坐标,单位为px。<br/>.value[2].i32:Surface显示区域的宽度,单位为px。<br/>.value[3].i32:Surface显示区域的高度,单位为px。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:Surface显示区域相对于XComponent组件左上角的x轴坐标,单位为px。<br/>.value[1].i32:Surface显示区域相对于XComponent组件左上角的y轴坐标,单位为px。<br/>.value[2].i32:Surface显示区域的宽度,单位为px。<br/>.value[3].i32:Surface显示区域的高度,单位为px。<br/>**起始版本**:18 |
3545| NODE_XCOMPONENT_ENABLE_ANALYZER | 设置组件支持AI分析,当前支持主体识别、文字识别和对象查找等功能。 本功能需要搭配XComponentController的StartImageAnalyzer和StopImageAnalyzer一起使用。 不能和overlay属性同时使用,两者同时设置时overlay中CustomBuilder属性将失效。该特性依赖设备能力。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:是否启用图像分析功能。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:是否启用图像分析功能。<br/>**起始版本**:18 |
3546| NODE_DATE_PICKER_LUNAR  | 设置日期选择器组件的日期是否显示农历,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 是否显示农历,默认值false。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 是否显示农历。 |
3547| NODE_DATE_PICKER_START  | 设置日期选择器组件选择器的起始日期,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 日期,默认值"1970-1-1"。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 日期。<br/>**起始版本:** 18 |
3548| NODE_DATE_PICKER_END  | 设置日期选择器组件选择器的结束日期,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 日期,默认值"2100-12-31"。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 日期。<br/>**起始版本:** 18 |
3549| NODE_DATE_PICKER_SELECTED  | 设置日期选择器组件选中项的日期,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 日期,默认值"2024-01-22"。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 日期。 |
3550| NODE_DATE_PICKER_DISAPPEAR_TEXT_STYLE  | 设置日期选择器组件的所有选项中最上和最下两个选项的文本颜色、字号、字体粗细,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 入参5个,格式为字符串,以 ';' 分割:<br/>入参1: 文本颜色,::argb类型<br/>入参2: 文本大小,数字类型,单位fp<br/>入参3: 文本粗细,字符串枚举("bold", "normal", "bolder", "lighter", "medium", "regular")<br/>入参4: 文本字体列表,使用 ',' 进行分割<br/>入参5: 文本样式,字符串枚举("normal", "italic")<br/>如 "\#ff182431;14;normal;Arial,HarmonyOS Sans;normal" 。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 参数5个,格式为字符串,以 ';' 分割:<br/>参数1: 文本颜色,::argb类型<br/>参数2: 文本大小,数字类型,单位fp<br/>参数3: 文本粗细,字符串枚举("bold", "normal", "bolder", "lighter", "medium", "regular")<br/>参数4: 文本字体列表,使用 ',' 进行分割<br/>参数5: 文本样式,字符串枚举("normal", "italic")<br/>如 "\#ff182431;14;normal;Arial,HarmonyOS Sans;normal" 。 |
3551| NODE_DATE_PICKER_TEXT_STYLE  | 设置日期选择器组件的所有选项中除了最上、最下及选中项以外的文本颜色、字号、字体粗细,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 入参5个,格式为字符串,以 ';' 分割:<br/>入参1: 文本颜色,::argb类型<br/>入参2: 文本大小,数字类型,单位fp<br/>入参3: 文本粗细,字符串枚举("bold", "normal", "bolder", "lighter", "medium", "regular")<br/>入参4: 文本字体列表,使用 ',' 进行分割<br/>入参5: 文本样式,字符串枚举("normal", "italic")<br/>如 "\#ff182431;14;normal;Arial,HarmonyOS Sans;normal" 。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 参数5个,格式为字符串,以 ';' 分割:<br/>参数1: 文本颜色,::argb类型<br/>参数2: 文本大小,数字类型,单位fp<br/>参数3: 文本粗细,字符串枚举("bold", "normal", "bolder", "lighter", "medium", "regular")<br/>参数4: 文本字体列表,使用 ',' 进行分割<br/>参数5: 文本样式,字符串枚举("normal", "italic")<br/>如 "\#ff182431;14;normal;Arial,HarmonyOS Sans;normal" 。 |
3552| NODE_DATE_PICKER_SELECTED_TEXT_STYLE  | 设置日期选择器组件的选中项的文本颜色、字号、字体粗细,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 入参5个,格式为字符串,以 ';' 分割:<br/>入参1: 文本颜色,::argb类型<br/>入参2: 文本大小,数字类型,单位fp<br/>入参3: 文本粗细,字符串枚举("bold", "normal", "bolder", "lighter", "medium", "regular")<br/>入参4: 文本字体列表,使用 ',' 进行分割<br/>入参5: 文本样式,字符串枚举("normal", "italic")<br/>如 "\#ff182431;14;normal;Arial,HarmonyOS Sans;normal" 。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 参数5个,格式为字符串,以 ';' 分割:<br/>参数1: 文本颜色,::argb类型<br/>参数2: 文本大小,数字类型,单位fp<br/>参数3: 文本粗细,字符串枚举("bold", "normal", "bolder", "lighter", "medium", "regular")<br/>参数4: 文本字体列表,使用 ',' 进行分割<br/>参数5: 文本样式,字符串枚举("normal", "italic")<br/>如 "\#ff182431;14;normal;Arial,HarmonyOS Sans;normal" 。 |
3553| NODE_DATE_PICKER_MODE | 设置要显示的日期选项列。DatePicker显示不同样式的日期列,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:显示的日期列类型,参数类型[ArkUI_DatePickerMode](#arkui_datepickermode)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:显示的日期列类型,参数类型[ArkUI_DatePickerMode](#arkui_datepickermode)。<br/>**起始版本:** 18 |
3554| NODE_DATE_PICKER_ENABLE_HAPTIC_FEEDBACK | 设置是否开启触控反馈。支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 是否开启触控反馈,默认值true。true表示开启触控反馈,false表示不开启触控反馈。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 是否开启触控反馈。<br/><br/>**起始版本:** 18 |
3555| NODE_TIME_PICKER_SELECTED  | 设置时间选择组件选中项的时间,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 时间,默认值当前系统时间。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 时间。 |
3556| NODE_TIME_PICKER_USE_MILITARY_TIME  | 设置时间选择组件展示时间是否为24小时制,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 是否为24小时制,默认值false。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 是否为24小时制。 |
3557| NODE_TIME_PICKER_DISAPPEAR_TEXT_STYLE  | 设置时间选择组件所有选项中最上和最下两个选项的文本颜色、字号、字体粗细,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 入参5个,格式为字符串,以 ';' 分割:<br/>入参1: 文本颜色,::argb类型<br/>入参2: 文本大小,数字类型,单位fp<br/>入参3: 文本粗细,字符串枚举("bold", "normal", "bolder", "lighter", "medium", "regular")<br/>入参4: 文本字体列表,使用 ',' 进行分割<br/>入参5: 文本样式,字符串枚举("normal", "italic")<br/>如 "\#ff182431;14;normal;Arial,HarmonyOS Sans;normal" 。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 参数5个,格式为字符串,以 ';' 分割:<br/>参数1: 文本颜色,::argb类型<br/>参数2: 文本大小,数字类型,单位fp<br/>参数3: 文本粗细,字符串枚举("bold", "normal", "bolder", "lighter", "medium", "regular")<br/>参数4: 文本字体列表,使用 ',' 进行分割<br/>参数5: 文本样式,字符串枚举("normal", "italic")<br/>如 "\#ff182431;14;normal;Arial,HarmonyOS Sans;normal" 。 |
3558| NODE_TIME_PICKER_TEXT_STYLE  | 设置时间选择组件所有选项中除了最上、最下及选中项以外的文本颜色、字号、字体粗细,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 入参5个,格式为字符串,以 ';' 分割:<br/>入参1: 文本颜色,::argb类型<br/>入参2: 文本大小,数字类型,单位fp<br/>入参3: 文本粗细,字符串枚举("bold", "normal", "bolder", "lighter", "medium", "regular")<br/>入参4: 文本字体列表,使用 ',' 进行分割<br/>入参5: 文本样式,字符串枚举("normal", "italic")<br/>如 "\#ff182431;14;normal;Arial,HarmonyOS Sans;normal" 。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 参数5个,格式为字符串,以 ';' 分割:<br/>参数1: 文本颜色,::argb类型<br/>参数2: 文本大小,数字类型,单位fp<br/>参数3: 文本粗细,字符串枚举("bold", "normal", "bolder", "lighter", "medium", "regular")<br/>参数4: 文本字体列表,使用 ',' 进行分割<br/>参数5: 文本样式,字符串枚举("normal", "italic")<br/>如 "\#ff182431;14;normal;Arial,HarmonyOS Sans;normal" 。 |
3559| NODE_TIME_PICKER_SELECTED_TEXT_STYLE  | 设置时间选择组件选中项的文本颜色、字号、字体粗细,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 入参5个,格式为字符串,以 ';' 分割:<br/>入参1: 文本颜色,::argb类型<br/>入参2: 文本大小,数字类型,单位fp<br/>入参3: 文本粗细,字符串枚举("bold", "normal", "bolder", "lighter", "medium", "regular")<br/>入参4: 文本字体列表,使用 ',' 进行分割<br/>入参5: 文本样式,字符串枚举("normal", "italic")<br/>如 "\#ff182431;14;normal;Arial,HarmonyOS Sans;normal" 。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 参数5个,格式为字符串,以 ';' 分割:<br/>参数1: 文本颜色,::argb类型<br/>参数2: 文本大小,数字类型,单位fp<br/>参数3: 文本粗细,字符串枚举("bold", "normal", "bolder", "lighter", "medium", "regular")<br/>参数4: 文本字体列表,使用 ',' 进行分割<br/>参数5: 文本样式,字符串枚举("normal", "italic")<br/>如 "\#ff182431;14;normal;Arial,HarmonyOS Sans;normal" 。 |
3560| NODE_TIME_PICKER_START  | 设置时间选择器组件的起始时间,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 时间,默认值"00:00",仅生效设置的小时和分钟。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 时间,默认值"00:00"。<br/>**起始版本**:18 |
3561| NODE_TIME_PICKER_END  | 设置时间选择器组件的结束日期,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 时间,默认值"23:59",仅生效设置的小时和分钟。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 时间,默认值"23:59"。<br/>**起始版本**:18 |
3562| NODE_TIME_PICKER_ENABLE_CASCADE  | 在设置12小时制时,上午和下午的标识会根据小时数自动切换。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 在12小时制时,设置上午和下午的标识是否会根据小时数自动切换,默认值false。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 在12小时制时,设置上午和下午的标识是否会根据小时数自动切换。<br/>**起始版本**:18 |
3563| NODE_TEXT_PICKER_OPTION_RANGE  | 设置滑动选择文本选择器的选择列表,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:使用的选择器类型[ArkUI_TextPickerRangeType](#arkui_textpickerrangetype),默认值为ARKUI_TEXTPICKER_RANGETYPE_SINGLE;<br/>?.string:针对不同选择器类型有如下输入范式:<br/>1:单列选择器,入参格式为用分号分隔的一组字符串;<br/>2:多列选择器,支持多对纯文本字符串对,多对之间使用分号分隔,每对内部使用逗号分隔;<br/>?.object:针对不同选择器类型有如下输入范式:<br/>1:单列支持图片的选择器,输入结构体为[ARKUI_TextPickerRangeContent](_a_r_k_u_i___text_picker_range_content.md);<br/>2:多列联动选择器,输入结构体为[ARKUI_TextPickerCascadeRangeContent](_a_r_k_u_i___text_picker_cascade_range_content.md);<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:使用的选择器类型[ArkUI_TextPickerRangeType](#arkui_textpickerrangetype);<br/>?.string:针对不同选择器类型有如下输出范式:<br/>1:单列选择器,输出格式为用分号分隔的一组字符串;<br/>2:多列选择器,输出多对纯文本字符串对,多对之间使用分号分隔,每对内部使用逗号分隔;<br/>?.object:针对不同选择器类型有如下输出范式:<br/>1:单列支持图片的选择器,输出结构体为[ARKUI_TextPickerRangeContent](_a_r_k_u_i___text_picker_range_content.md);<br/>2:多列联动选择器,输出结构体为[ARKUI_TextPickerCascadeRangeContent](_a_r_k_u_i___text_picker_cascade_range_content.md); |
3564| NODE_TEXT_PICKER_OPTION_SELECTED  | 设置滑动选择文本内容的组件默认选中项在数组中的索引值,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:索引值,如存在多个索引值则逐个添加。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:索引值,如存在多个索引值则逐个添加; |
3565| NODE_TEXT_PICKER_OPTION_VALUE  | 设置滑动选择文本内容的组件默认选中项的值,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string:选中项的值,如存在多个值则逐个添加,用分号分隔。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string:选中项的值,如存在多个值则逐个添加,用分号分隔; |
3566| NODE_TEXT_PICKER_DISAPPEAR_TEXT_STYLE  | 设置滑动选择文本内容的组件所有选项中最上和最下两个选项的文本颜色、字号、字体粗细,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 入参5个,格式为字符串,以 ';' 分割:<br/>入参1: 文本颜色,::argb类型<br/>入参2: 文本大小,数字类型,单位fp<br/>入参3: 文本粗细,字符串枚举("bold", "normal", "bolder", "lighter", "medium", "regular")<br/>入参4: 文本字体列表,使用 ',' 进行分割<br/>入参5: 文本样式,字符串枚举("normal", "italic")<br/>如 "\#ff182431;14;normal;Arial,HarmonyOS Sans;normal" 。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 参数5个,格式为字符串,以 ';' 分割:<br/>参数1: 文本颜色,::argb类型<br/>参数2: 文本大小,数字类型,单位fp<br/>参数3: 文本粗细,字符串枚举("bold", "normal", "bolder", "lighter", "medium", "regular")<br/>参数4: 文本字体列表,使用 ',' 进行分割<br/>参数5: 文本样式,字符串枚举("normal", "italic")<br/>如 "\#ff182431;14;normal;Arial,HarmonyOS Sans;normal" 。 |
3567| NODE_TEXT_PICKER_TEXT_STYLE  | 设置滑动选择文本内容的组件所有选项中除了最上、最下及选中项以外的文本颜色、字号、字体粗细,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 入参5个,格式为字符串,以 ';' 分割:<br/>入参1: 文本颜色,::argb类型<br/>入参2: 文本大小,数字类型,单位fp<br/>入参3: 文本粗细,字符串枚举("bold", "normal", "bolder", "lighter", "medium", "regular")<br/>入参4: 文本字体列表,使用 ',' 进行分割<br/>入参5: 文本样式,字符串枚举("normal", "italic")<br/>如 "\#ff182431;14;normal;Arial,HarmonyOS Sans;normal" 。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 参数5个,格式为字符串,以 ';' 分割:<br/>参数1: 文本颜色,::argb类型<br/>参数2: 文本大小,数字类型,单位fp<br/>参数3: 文本粗细,字符串枚举("bold", "normal", "bolder", "lighter", "medium", "regular")<br/>参数4: 文本字体列表,使用 ',' 进行分割<br/>参数5: 文本样式,字符串枚举("normal", "italic")<br/>如 "\#ff182431;14;normal;Arial,HarmonyOS Sans;normal" 。 |
3568| NODE_TEXT_PICKER_SELECTED_TEXT_STYLE  | 设置滑动选择文本内容的组件选中项的文本颜色、字号、字体粗细,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 入参5个,格式为字符串,以 ';' 分割:<br/>入参1: 文本颜色,::argb类型;<br/>入参2: 文本大小,数字类型,单位fp;<br/>入参3: 文本粗细,字符串枚举("bold", "normal", "bolder", "lighter", "medium", "regular");<br/>入参4: 文本字体列表,使用 ',' 进行分割;<br/>入参5: 文本样式,字符串枚举("normal", "italic");<br/>如 "\#ff182431;14;normal;Arial,HarmonyOS Sans;normal" 。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 参数5个,格式为字符串,以 ';' 分割:<br/>参数1: 文本颜色,::argb类型;<br/>参数2: 文本大小,数字类型,单位fp;<br/>参数3: 文本粗细,字符串枚举("bold", "normal", "bolder", "lighter", "medium", "regular");<br/>参数4: 文本字体列表,使用 ',' 进行分割;<br/>参数5: 文本样式,字符串枚举("normal", "italic");<br/>如 "\#ff182431;14;normal;Arial,HarmonyOS Sans;normal" 。 |
3569| NODE_TEXT_PICKER_SELECTED_INDEX  | 设置滑动选择文本内容的组件默认选中项在数组中的索引值,支持属性设置,属性重置和属性获取接口。<br/>[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数类型:<br/>.value[0...].i32:默认选中项在数组中的索引值数组。 |
3570| NODE_TEXT_PICKER_CAN_LOOP  | Picker组件可循环滚动属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:false表示不可循环,true表示可循环。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>value[0].i32:0表示不可循环,1表示可循环。 |
3571| NODE_TEXT_PICKER_DEFAULT_PICKER_ITEM_HEIGHT  | Picker各选择项的高度属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:子项高度属性,单位为vp。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>value[0].f32:子项高度属性,单位为vp。 |
3572| NODE_TEXT_PICKER_ENABLE_HAPTIC_FEEDBACK | 设置是否开启触控反馈。支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 是否开启触控反馈。默认值:true,true表示开启触控反馈,false则表示不开启触控反馈。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 是否开启触控反馈。<br/>**起始版本:** 18 |
3573| NODE_CALENDAR_PICKER_HINT_RADIUS  | 设置日历选中态底板圆角半径的参数,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 日历选中态底板圆角半径,取值范围[0,+∞),其中取值为0表示底板样式为直角矩形; 取值范围为(0, 16)时,底板样式为圆角矩形;取值范围为[16,+∞)时,底板样式为圆形。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 日历选中态底板圆角半径,取值范围[0,+∞),其中取值为0表示底板样式为直角矩形; 取值范围为(0, 16)时,底板样式为圆角矩形;取值范围为[16,+∞)时,底板样式为圆形。 |
3574| NODE_CALENDAR_PICKER_SELECTED_DATE  | 设置日历选择选中日期的参数,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32: 选中的年。<br/>.value[1].u32: 选中的月。<br/>.value[2].u32: 选中的日。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32: 选中的年。<br/>.value[1].u32: 选中的月。<br/>.value[2].u32: 选中的日。 |
3575| NODE_CALENDAR_PICKER_EDGE_ALIGNMENT  | 设置日历选择器与入口组件的对齐方式,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 对齐方式类型,参数类型[ArkUI_CalendarAlignment](#arkui_calendaralignment)。<br/>.value[1]?.f32: 按照对齐方式对齐后,选择器相对入口组件的x轴方向相对偏移。<br/>.value[2]?.f32: 按照对齐方式对齐后,选择器相对入口组件的y轴方向相对偏移。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 对齐方式类型,参数类型[ArkUI_CalendarAlignment](#arkui_calendaralignment)。<br/>.value[1].f32: 按照对齐方式对齐后,选择器相对入口组件的x轴方向相对偏移。<br/>.value[2].f32: 按照对齐方式对齐后,选择器相对入口组件的y轴方向相对偏移。 |
3576| NODE_CALENDAR_PICKER_TEXT_STYLE  | 设置日历选择器入口区的文本颜色、字号、字体粗细。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0]?.u32: 入口区的文本颜色。<br/>.value[1]?.f32: 入口区的文本字号,单位为fp。<br/>.value[2]?.i32: 入口区的文本字体粗细,参数类型[ArkUI_FontWeight](#arkui_fontweight)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32: 入口区的文本颜色。<br/>.value[1].f32: 入口区的文本字号,单位为fp。<br/>.value[2].i32: 入口区的文本字体粗细,参数类型[ArkUI_FontWeight](#arkui_fontweight)。 |
3577| NODE_CALENDAR_PICKER_START | 设置日历选择器的开始日期。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string:开始日期字符串。<br/>设置开始日期格式:"2025-02-14"。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string:开始日期字符串。<br/>**起始版本:** 18 |
3578| NODE_CALENDAR_PICKER_END  | 设置日历选择器的结束日期。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string:结束日期字符串。<br/>设置结束日期格式:"2025-02-27"。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string:结束日期字符串。<br/>**起始版本:** 18 |
3579| NODE_SLIDER_BLOCK_COLOR  | Slider滑块的颜色,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].u32:滑块的颜色, 类型为0xargb,如0xFF1122FF。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:滑块的颜色, 类型为0xargb,如0xFF1122FF。 |
3580| NODE_SLIDER_TRACK_COLOR  | Slider滑轨的背景颜色,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].u32:背景颜色, 类型为0xargb,如0xFF1122FF。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:背景颜色, 类型为0xargb,如0xFF1122FF。 |
3581| NODE_SLIDER_SELECTED_COLOR  | Slider滑轨的已滑动部分颜色,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].u32:已滑动部分颜色, 类型为0xargb,如0xFF1122FF。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:已滑动部分颜色, 类型为0xargb,如0xFF1122FF。 |
3582| NODE_SLIDER_SHOW_STEPS  | 设置是否显示步长刻度值,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].i32:是否显示步长刻度值,1表示显示,0表示不显示,默认值为0。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:是否显示步长刻度值,1表示显示,0表示不显示,默认值为0。 |
3583| NODE_SLIDER_BLOCK_STYLE  | Slider滑块形状参数,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].i32:形状参数。参数类型[ArkUI_SliderBlockStyle](#arkui_sliderblockstyle)。<br/>.string? 可选值,根据形状参数而定。<br/>ARKUI_SLIDER_BLOCK_STYLE_IMAGE: 滑块图片资源。如/pages/common/icon.png。<br/>ARKUI_SLIDER_BLOCK_STYLE_SHAPE: 滑块使用的自定义形状。<br/>共有5种类型:<br/>1.rect类型:<br/>.value[1].i32:裁剪类型,参数类型[ArkUI_ShapeType](#arkui_shapetype),ARKUI_SHAPE_TYPE_RECTANGLE;<br/>.value[2].f32:矩形宽度;<br/>.value[3].f32:矩形高度;<br/>.value[4].f32:矩形圆角宽度;<br/>.value[5].f32:矩形圆角高度;<br/>2.circle类型:<br/>.value[1].i32:裁剪类型,参数类型[ArkUI_ShapeType](#arkui_shapetype),ARKUI_SHAPE_TYPE_CIRCLE;<br/>.value[2].f32:圆形宽度;<br/>.value[3].f32:圆形高度;<br/>3.ellipse类型:<br/>.value[1].i32:裁剪类型,参数类型[ArkUI_ShapeType](#arkui_shapetype),ARKUI_SHAPE_TYPE_ELLIPSE;<br/>.value[2].f32:椭圆形宽度;<br/>.value[3].f32:椭圆形高度;<br/>4.path类型:<br/>.value[1].i32:裁剪类型,参数类型[ArkUI_ShapeType](#arkui_shapetype),ARKUI_SHAPE_TYPE_PATH;<br/>.value[2].f32:路径宽度;<br/>.value[3].f32:路径高度;<br/>.string:路径绘制的命令字符串;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:形状参数。参数类型[ArkUI_SliderBlockStyle](#arkui_sliderblockstyle)。<br/>.string? 可选值,根据形状参数而定。<br/>ARKUI_SLIDER_BLOCK_STYLE_IMAGE: 滑块图片资源。如/pages/common/icon.png。<br/>ARKUI_SLIDER_BLOCK_STYLE_SHAPE: 滑块使用的自定义形状。<br/>共有5种类型:<br/>1.rect类型:<br/>.value[1].i32:裁剪类型,参数类型[ArkUI_ShapeType](#arkui_shapetype),ARKUI_SHAPE_TYPE_RECTANGLE;<br/>.value[2].f32:矩形宽度;<br/>.value[3].f32:矩形高度;<br/>.value[4].f32:矩形圆角宽度;<br/>.value[5].f32:矩形圆角高度;<br/>2.circle类型:<br/>.value[1].i32:裁剪类型,参数类型[ArkUI_ShapeType](#arkui_shapetype),ARKUI_SHAPE_TYPE_CIRCLE;<br/>.value[2].f32:圆形宽度;<br/>.value[3].f32:圆形高度;<br/>3.ellipse类型:<br/>.value[1].i32:裁剪类型,参数类型[ArkUI_ShapeType](#arkui_shapetype),ARKUI_SHAPE_TYPE_ELLIPSE;<br/>.value[2].f32:椭圆形宽度;<br/>.value[3].f32:椭圆形高度;<br/>4.path类型:<br/>.value[1].i32:裁剪类型,参数类型[ArkUI_ShapeType](#arkui_shapetype),ARKUI_SHAPE_TYPE_PATH;<br/>.value[2].f32:路径宽度;<br/>.value[3].f32:路径高度;<br/>.string:路径绘制的命令字符串; |
3584| NODE_SLIDER_VALUE  | slider进度值,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].f32:进度值。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:进度值。 |
3585| NODE_SLIDER_MIN_VALUE  | slider最小值,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].f32:进度值的最小值。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:进度值的最小值。 |
3586| NODE_SLIDER_MAX_VALUE  | slider最大值,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].f32:进度值的最大值。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:进度值的最大值。 |
3587| NODE_SLIDER_STEP  | Slider滑动步长,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].f32:滑动步长,取值范围:[0.01, 100]。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:滑动步长,取值范围:[0.01, 100]。 |
3588| NODE_SLIDER_DIRECTION  | Slider滑动条滑动方向,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].i32:显示样式,参数类型[ArkUI_SliderDirection](#arkui_sliderdirection)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:显示样式,参数类型[ArkUI_SliderDirection](#arkui_sliderdirection)。 |
3589| NODE_SLIDER_REVERSE  | Slider滑动条取值范围是否反向,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].i32:是否反向,1表示反向,0表示不反向。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:是否反向,1表示反向,0表示不反向。 |
3590| NODE_SLIDER_STYLE  | Slider的滑块与滑轨显示样式,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].i32:显示样式,参数类型[ArkUI_SliderStyle](#arkui_sliderstyle)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:显示样式,参数类型[ArkUI_SliderStyle](#arkui_sliderstyle)。 |
3591| NODE_SLIDER_TRACK_THICKNESS  | Slider滑块的滑轨粗细属性,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].f32:滑轨的粗细,单位为vp;当参数NODE_SLIDER_STYLE的值设置为ARKUI_SLIDER_STYLE_OUT_SET时为4.0vp,设置为ARKUI_SLIDER_STYLE_IN_SET时为20.0vp<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:滑轨的粗细,单位为vp; |
3592| NODE_SLIDER_ENABLE_HAPTIC_FEEDBACK | 设置是否开启触控反馈。支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 是否开启触控反馈。默认值:true,true表示开启触控反馈,false则表示不开启触控反馈。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 是否开启触控反馈。<br/>开启触控反馈时,需要在工程的module.json5的requestPermissions字段中增加"name": "ohos.permission.VIBRATE",开启振动权限。 <br/>**起始版本:** 18 |
3593| NODE_RADIO_CHECKED  | 设置单选框的选中状态,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].i32:单选框的选中状态,默认值false。 属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:单选框的选中状态。 |
3594| NODE_RADIO_STYLE  | 设置单选框选中状态和非选中状态的样式,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0]?.u32:开启状态底板颜色, 类型为0xargb,默认值为0xFF007DFF。<br/>.value[1]?.u32:关闭状态描边颜色, 类型为0xargb,默认值为0xFF182431。<br/>.value[2]?.u32:开启状态内部圆饼颜色, 类型为0xargb,默认值为0xFFFFFFFF。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:开启状态底板颜色, 类型为0xargb,默认值为0xFF007DFF。<br/>.value[1].u32:关闭状态描边颜色, 类型为0xargb,默认值为0xFF182431。<br/>.value[2].u32:开启状态内部圆饼颜色, 类型为0xargb,默认值为0xFFFFFFF。 |
3595| NODE_RADIO_VALUE  | 设置当前单选框的值,支持属性设置、重置和获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.string: 单选框的值.<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 单选框的值. |
3596| NODE_RADIO_GROUP  | 设置当前单选框的所属群组名称,相同group的Radio只能有一个被选中,支持属性设置、重置和获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.string: 当前单选框的所属群组名称.<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 当前单选框的所属群组名称. |
3597| NODE_CHECKBOX_GROUP_NAME  | 设置多选框组名称,多个相同群组名称的CheckboxGroup,仅第一个CheckboxGroup生效,支持属性设置、重置和获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.string: 当前多选框组名称。<br/> 属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 多选框组名称。<br/>起始版本:15 |
3598| NODE_CHECKBOX_GROUP_SELECT_ALL  | 是否全选。设置是否全选。若同组的checkbox显式设置了select属性,则Checkbox的优先级高,支持属性设置,属性重置和属性获取。<br/>默认值:false<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].i32: 1表示选中,0表示未选中。<br/> 属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 1表示选中,0表示未选中。<br/>起始版本:15 |
3599| NODE_CHECKBOX_GROUP_SELECTED_COLOR  | 被选中或部分选中状态的颜色,支持属性设置,属性重置和属性获取。<br/>默认值:false<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].u32:多选框组被选中状态的颜色,类型为0xargb,如0xFF1122FF。<br/> 属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:多选框组被选中状态的颜色,类型为0xargb,如0xFF1122FF。<br/>起始版本:15 |
3600| NODE_CHECKBOX_GROUP_UNSELECTED_COLOR  | 非选中状态多选框组颜色,支持属性设置,属性重置和属性获取。<br/>默认值:false<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].u32:边框颜色,类型为0xargb,如0xFF1122FF。<br/> 属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:边框颜色,类型为0xargb,如0xFF1122FF。<br/>起始版本:15 |
3601| NODE_CHECKBOX_GROUP_MARK  | 多选框内部图标样式,支持属性设置,属性重置和属性获取。<br/>默认值:false<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].u32:边框颜色,类型为0xargb,如0xFF1122FF;<br/>.value[1]?.f32:可选,内部图标大小,单位vp;<br/>.value[2]?.f32:可选,内部图标粗细,单位vp,默认值2。<br/> 属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:边框颜色,类型为0xargb,如0xFF1122FF;<br/>.value[1]?.f32:可选,内部图标大小,单位vp;<br/>.value[2]?.f32:可选,内部图标粗细,单位vp,默认值2。<br/>起始版本:15 |
3602| NODE_CHECKBOX_GROUP_SHAPE  | CheckboxGroup组件形状,支持属性设置,属性重置和属性获取。<br/>默认值:false<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].i32:组件形状,参数类型[ArkUI_CheckboxShape](#arkui_checkboxshape)。<br/> 属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:组件形状,参数类型[ArkUI_CheckboxShape](#arkui_checkboxshape)。<br/>起始版本:15 |
3603| NODE_STACK_ALIGN_CONTENT  | 设置子组件在容器内的对齐方式,支持属性设置,属性重置和属性获取接口。<br/>该属性与通用属性NODE_ALIGNMENT同时设置时,后设置的属性生效。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 对齐方式,数据类型[ArkUI_Alignment](#arkui_alignment),默认值ARKUI_ALIGNMENT_CENTER。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 对齐方式,数据类型[ArkUI_Alignment](#arkui_alignment)。 |
3604| NODE_SCROLL_BAR_DISPLAY_MODE  | 设置滚动条状态,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 滚动条状态,数据类型[ArkUI_ScrollBarDisplayMode](#arkui_scrollbardisplaymode),默认值ARKUI_SCROLL_BAR_DISPLAY_MODE_AUTO。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 滚动条状态,数据类型[ArkUI_ScrollBarDisplayMode](#arkui_scrollbardisplaymode)。 |
3605| NODE_SCROLL_BAR_WIDTH  | 设置滚动条的宽度,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 滚动条宽度,单位vp,默认值4。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 滚动条宽度,单位vp。 |
3606| NODE_SCROLL_BAR_COLOR  | 设置滚动条的颜色,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.data[0].u32: 滚动条颜色,0xargb类型。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.data[0].u32: 滚动条颜色,0xargb类型。 |
3607| NODE_SCROLL_SCROLL_DIRECTION  | 设置滚动方向,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:滚动方向,数据类型[ArkUI_ScrollDirection](#arkui_scrolldirection),默认值ARKUI_SCROLL_DIRECTION_VERTICAL。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:滚动方向,数据类型[ArkUI_ScrollDirection](#arkui_scrolldirection)。 |
3608| NODE_SCROLL_EDGE_EFFECT  | 设置边缘滑动效果,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 边缘滑动效果,参数类型[ArkUI_EdgeEffect](#arkui_edgeeffect),默认值ARKUI_EDGE_EFFECT_NONE;<br/>.value[1]?.i32: 可选值,组件内容大小小于组件自身时,设置是否开启滑动效果,开启为1,关闭为0,默认值1;<br/>.value[2]?.i32: 边缘效果生效的方向,参数类型[ArkUI_EffectEdge](#arkui_effectedge),默认值ARKUI_EFFECT_EDGE_START \| ARKUI_EFFECT_EDGE_END。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 边缘滑动效果,参数类型[ArkUI_EdgeEffect](#arkui_edgeeffect);<br/>.value[1].i32: 组件内容大小小于组件自身时,设置是否开启滑动效果,开启为1,关闭为0;<br/>.value[2].i32: 边缘效果生效的方向,参数类型[ArkUI_EffectEdge](#arkui_effectedge)。<br/>起始版本:<br/>18 |
3609| NODE_SCROLL_ENABLE_SCROLL_INTERACTION  | 设置是否支持滚动手势,当设置为false时,无法通过手指或者鼠标滚动,但不影响控制器的滚动接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 是否支持滚动手势,默认值true。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 是否支持滚动手势。 |
3610| NODE_SCROLL_FRICTION  | 设置摩擦系数,手动划动滚动区域时生效,只对惯性滚动过程有影响,对惯性滚动过程中的链式效果有间接影响。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 摩擦系数,默认值:非可穿戴设备为0.6,可穿戴设备为0.9。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 摩擦系数。 |
3611| NODE_SCROLL_SNAP  | 设置Scroll组件的限位滚动模式,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: Scroll组件限位滚动时的对齐方式,数据类型[ArkUI_ScrollSnapAlign](#arkui_scrollsnapalign),默认值ARKUI_SCROLL_SNAP_ALIGN_NONE;<br/>.value[1].i32: 在Scroll组件限位滚动模式下,该属性设置为false后,允许Scroll在开头和第一页间自由滑动。默认值true,仅在分页点为多个时生效;<br/>.value[2].i32: 在Scroll组件限位滚动模式下,该属性设置为false后,允许Scroll在最后一页和末尾间自由滑动。默认值true,仅在分页点为多个时生效;<br/>.value[3...].f32: Scroll组件限位滚动时的分页点。分页点为1个时,系统按照该大小进行分页;分页点为多个时,系统按照分页点进行分页。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: Scroll组件限位滚动时的对齐方式,数据类型[ArkUI_ScrollSnapAlign](#arkui_scrollsnapalign);<br/>.value[1].i32: 在Scroll组件限位滚动模式下,该属性设置为false后,允许Scroll在开头和第一页间自由滑动;<br/>.value[2].i32: 在Scroll组件限位滚动模式下,该属性设置为false后,允许Scroll在最后一页和末尾间自由滑动;<br/>.value[3...].f32: Scroll组件限位滚动时的分页点。 |
3612| NODE_SCROLL_NESTED_SCROLL  | Scroll嵌套滚动选项,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].i32:可滚动组件往末尾端滚动时的嵌套滚动,参数类型[ArkUI_ScrollNestedMode](#arkui_scrollnestedmode)。<br/>.value[1].i32:可滚动组件往起始端滚动时的嵌套滚动,参数类型[ArkUI_ScrollNestedMode](#arkui_scrollnestedmode)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:可滚动组件往末尾端滚动时的嵌套滚动,参数类型[ArkUI_ScrollNestedMode](#arkui_scrollnestedmode)。<br/>.value[1].i32:可滚动组件往起始端滚动时的嵌套滚动,参数类型[ArkUI_ScrollNestedMode](#arkui_scrollnestedmode)。 |
3613| NODE_SCROLL_OFFSET  | Scroll滑动到指定位置,支持属性设置,属性重置和属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].f32:水平滑动偏移,单位为vp。<br/>.value[1].f32:垂直滑动偏移,单位为vp。<br/>.value[2]?.i32:可选值,滚动时长,单位为毫秒。<br/>.value[3]?.i32:可选值,滚动曲线,参数类型[ArkUI_AnimationCurve](#arkui_animationcurve)。默认值为ARKUI_CURVE_EASE。<br/>.value[4]?.i32:可选值,是否使能默认弹簧动效,默认值为0不使能。<br/>.value[5]?.i32:可选值,设置滚动是否可越界。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:水平滑动偏移,单位为vp。<br/>.value[1].f32:垂直滑动偏移,单位为vp。 |
3614| NODE_SCROLL_EDGE  | Scroll滚动到容器边缘,支持属性设置,属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].i32:容器边缘,参数类型[ArkUI_ScrollEdge](#arkui_scrolledge)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:容器是否位于边缘,-1:表示未处于边缘,如果处于边缘状态参数类型[ArkUI_ScrollEdge](#arkui_scrolledge)。 |
3615| NODE_SCROLL_ENABLE_PAGING  | 设置是否支持滑动翻页,支持属性设置,属性重置和属性获取接口。<br/>如果同时设置了划动翻页enablePaging和限位滚动scrollSnap,则scrollSnap优先生效,enablePaging不生效。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 是否支持划动翻页,默认值false。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 是否支持划动翻页。 |
3616| NODE_SCROLL_PAGE  | 滚动到下一页或者上一页。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32 是否向下翻页。0表示向下翻页,1表示向上翻页。<br/>.value[1]?.i32 是否开启翻页动画效果。1有动画,0无动画。默认值:0。 |
3617| NODE_SCROLL_BY  | 滑动指定距离。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:水平方向滚动距离,默认单位为vp;<br/>.value[1].f32: 竖直方向滚动距离,默认单位为vp。 |
3618| NODE_SCROLL_FLING  | 滚动类组件按传入的初始速度进行惯性滚动。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:惯性滚动的初始速度,默认单位为vp/s。值设置为0,视为异常值,本次滚动不生效。如果值为正数,则向下滚动;如果值为负数,则向上滚动。 |
3619| NODE_SCROLL_FADING_EDGE  | 设置滚动类组件边缘渐隐效果。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:是否使能边缘渐隐效果。0表示关闭边缘效果。1表示开启边缘效果。<br/>.value[1]?.f32:边缘渐隐效果长度。单位:vp,默认值:32。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:是否使能边缘渐隐效果。0表示关闭边缘效果。1表示开启边缘效果。<br/>.value[1].f32:边缘渐隐效果长度。单位:vp。<br/>起始版本:<br/>14 |
3620| NODE_SCROLL_SIZE  | 获取滚动类组件所有子组件全展开尺寸。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:滚动类组件所有子组件全展开的宽度,默认单位为vp。<br/>.value[1].f32:滚动类组件所有子组件全展开的高度,默认单位为vp。<br/>设置NODE_PADDING、NODE_MARGIN或NODE_BORDER_WIDTH后,NODE_PADDING、NODE_MARGIN或NODE_BORDER_WIDTH在单位vp转换成单位px时会进行像素取整, 返回值根据取整后的值计算。<br/>起始版本:<br/>14 |
3621| NODE_SCROLL_CONTENT_START_OFFSET | 设置内容区域起始偏移量。列表滚动到起始位置时,列表内容与列表显示区域边界保留指定距离。支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:内容区域起始偏移量,默认值:0,单位:vp。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:内容区域起始偏移量,单位:vp。 |
3622| NODE_SCROLL_CONTENT_END_OFFSET | 设置内容区末尾偏移量。列表滚动到末尾位置时,列表内容与列表显示区域边界保留指定距离。支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:内容区末尾偏移量,默认值:0,单位:vp。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:内容区末尾偏移量,单位:vp。 |
3623| NODE_SCROLL_FLING_SPEED_LIMIT | 限制跟手滑动结束后,Fling动效开始时的最大初始速度。支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:Fling动效开始时的最大初始速度,单位:vp/s。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:Fling动效开始时的最大初始速度。 |
3624| NODE_SCROLL_CLIP_CONTENT | 设置滚动容器的内容层裁剪区域。支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:内容裁剪模式,参数类型[ArkUI_ContentClipMode](_ark_u_i___native_module.md#arkui_contentclipmode)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:内容裁剪模式,参数类型[ArkUI_ContentClipMode](_ark_u_i___native_module.md#arkui_contentclipmode)。 |
3625| NODE_LIST_DIRECTION  | 设置List组件排列方向,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:List组件排列方向,数据类型[ArkUI_Axis](#arkui_axis),默认值ARKUI_AXIS_VERTICAL。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:List组件排列方向,数据类型[ArkUI_Axis](#arkui_axis)。 |
3626| NODE_LIST_STICKY  | 配合ListItemGroup组件使用,设置ListItemGroup中header和footer是否要吸顶或吸底,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:配合ListItemGroup组件使用,设置ListItemGroup中header和footer是否要吸顶或吸底。数据类型[ArkUI_StickyStyle](#arkui_stickystyle),默认值ARKUI_STICKY_STYLE_NONE。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:配合ListItemGroup组件使用,设置ListItemGroup中header和footer是否要吸顶或吸底。数据类型[ArkUI_StickyStyle](#arkui_stickystyle)。 |
3627| NODE_LIST_SPACE  | 设置列表项间距,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 子组件主轴方向的间隔。默认值0。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 子组件主轴方向的间隔。 |
3628| NODE_LIST_NODE_ADAPTER  | list组件适配器,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object:使用**ArkUI_NodeAdapter**对象作为适配器。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object:返回值格式为**ArkUI_NodeAdapter**。 |
3629| NODE_LIST_CACHED_COUNT  | list组件Adapter缓存数量,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:配合List组件Adapter使用,设置adapter中的缓存数量;<br/>.value[1].i32:设置被预加载的ListItem是否需要显示,1表示显示,0表示不显示。默认值:0。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:adapter中的缓存数量;<br/>.value[1].i32:设置被预加载的ListItem是否需要显示,1表示显示,0表示不显示。默认值:0。 |
3630| NODE_LIST_SCROLL_TO_INDEX  | 滑动到指定index。<br/>开启smooth动效时,会对经过的所有item进行加载和布局计算,当大量加载item时会导致性能问题。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:要滑动到的目标元素在当前容器中的索引值。<br/>.value[1]?.i32:设置滑动到列表项在列表中的索引值时是否有动效,1表示有动效,0表示没有动效。默认值:0。<br/>.value[2]?.i32:指定滑动到的元素与当前容器的对齐方式,参数类型[ArkUI_ScrollAlignment](#arkui_scrollalignment), 默认值:ARKUI_SCROLL_ALIGNMENT_START。<br/>.value[3]?.f32:设置滑动到指定Index的选项,如额外偏移量,单位vp。|
3631| NODE_LIST_ALIGN_LIST_ITEM  | 设置List交叉轴方向宽度大于ListItem交叉轴宽度 \* lanes时, ListItem在List交叉轴方向的布局方式,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:交叉轴方向的布局方式。参数类型**ArkUI_ListItemAlign**<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:交叉轴方向的布局方式。参数类型**ArkUI_ListItemAlign** |
3632| NODE_LIST_CHILDREN_MAIN_SIZE  | 设置List子组件默认主轴尺寸。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>object: 参数格式为{\@ArkUI_ListChildrenMainSize}.<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object: 参数格式为{\@ArkUI_ListChildrenMainSize}. |
3633| NODE_LIST_INITIAL_INDEX  | 设置当前List初次加载时视口起始位置显示的item的索引值, 支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 当前List初次加载时视口起始位置显示的item的索引值,默认值:0。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 当前List初次加载时视口起始位置显示的item的索引值,默认值:0。 |
3634| NODE_LIST_DIVIDER  | 设置ListItem分割线样式,默认无分割线,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32: 分割线颜色,0xargb类型;<br/>.value[1].f32: 分割线宽;<br/>.value[2].f32: 分割线距离列表侧边起始端的距离,单位vp;<br/>.value[3].f32: 分割线距离列表侧边结束端的距离,单位vp。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32: 分割线颜色,0xargb类型;<br/>.value[1].f32: 分割线宽;<br/>.value[2].f32: 分割线距离列表侧边起始端的距离,单位vp;<br/>.value[3].f32: 分割线距离列表侧边结束端的距离,单位vp。 |
3635| NODE_LIST_SCROLL_TO_INDEX_IN_GROUP | 滑动到指定的ListItemGroup中指定的ListItem。<br/>开启smooth动效时,会对经过的所有item进行加载和布局计算,当大量加载item时会导致性能问题。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:要滑动到的目标元素所在的ListItemGroup在当前容器中的索引值。<br/>.value[1].i32:要滑动到的目标元素在index指定的ListItemGroup中的索引值。<br/>.value[2]?.i32:设置滑动到列表项在列表中的索引值时是否有动效,1表示有动效,0表示没有动效。默认值:0。<br/>.value[3]?.i32:指定滑动到的元素与当前容器的对齐方式。参数类型[ArkUI_ScrollAlignment](#arkui_scrollalignment), 默认值:ARKUI_SCROLL_ALIGNMENT_START。 |
3636| NODE_LIST_LANES | 设置List组件的布局列数或行数,支持属性设置,属性重置和属性获取接口。<br/>使用规则:<br/>lanes为指定的数量时,根据指定的数量与List组件的交叉轴尺寸除以列数作为列的宽度。<br/>设置了{minLength,maxLength}时,lanse的指定数量不会生效,实际会根据List组件的宽度自适应决定lanes数量(即列数),保证缩放过程中lane的宽度符合{minLength,maxLength}的限制,其中,minLength条件会被优先满足,即优先保证符合ListItem的交叉轴尺寸符合最小限制。如果父组件交叉轴方向尺寸约束为无穷大时,固定按一列排列,列宽度按显示区域内最大的ListItem计算。ListItemGroup在多列模式下也是独占一行,ListItemGroup中的ListItem按照List组件的lanes属性设置值来布局,计算列数会按照ListItemGroup的交叉轴尺寸计算。当ListItemGroup交叉轴尺寸与List交叉轴尺寸不一致时ListItemGroup中的列数与List中的列数可能不一样。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32:设置list组件行数或列数(lanes)的数量,默认值为0。<br/>.value[1]?.f32:设置组件listItem的minLength,默认值为1,单位vp。<br/>.value[2]?.f32:设置组件listItem的maxLength,默认值为1,单位vp。<br/>.value[3]?.f32:设置组件listItem的列间距,当列数大于1时生效,默认值为1,单位vp。 <br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:list组件行列数的设定值,如果设置了{minLength,maxLength}时返回值为1。<br/>.value[1].f32:组件listItem的minLength,单位vp。<br/>.value[2].f32:组件listItem的maxLength,单位vp。<br/>.value[3].f32:组件listItem的列间距,单位vp。 |
3637| NODE_LIST_SCROLL_SNAP_ALIGN | 设置列表项滚动结束对齐效果。只支持ListItem等高情况下,设置列表项滚动结束对齐效果。触控板和鼠标滑动List结束后不支持对齐效果。对齐动画期间onWillScroll事件上报的滚动操作来源类型为ScrollSource.FLING。支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:设置列表项滚动结束对齐效果。数据类型[ArkUI_ScrollSnapAlign](#arkui_scrollsnapalign),默认值ARKUI_SCROLL_SNAP_ALIGN_NONE。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:设置列表项滚动结束对齐效果。数据类型[ArkUI_ScrollSnapAlign](#arkui_scrollsnapalign)。 |
3638| NODE_LIST_MAINTAIN_VISIBLE_CONTENT_POSITION | 设置显示区域上方插入或删除数据时是否要保持可见内容位置不变。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:设置显示区域上方插入或删除数据时是否要保持可见内容位置不变。0表示显示区域上方插入或删除数据时可见内容位置会跟随变化,1表示显示区域上方插入或删除数据时可见内容位置不变。默认值为0。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:设置显示区域上方插入或删除数据时是否要保持可见内容位置不变。0表示显示区域上方插入或删除数据时可见内容位置会跟随变化,1表示显示区域上方插入或删除数据时可见内容位置不变。 |
3639| NODE_LIST_STACK_FROM_END | 设置List从末尾开始布局。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:设置List是否从末尾开始布局。0表示从顶部开始布局,1表示从末尾开始布局,默认值为0。<br/> 属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:设置List是否从末尾开始布局。0表示从顶部开始布局,1表示从末尾开始布局。|
3640| NODE_SWIPER_LOOP  | Swiper是否开启循环,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:控制是否开启循环,0表示不循环,1表示循环,默认值为1。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:控制是否开启循环,0表示不循环,1表示循环,默认值为1。 |
3641| NODE_SWIPER_AUTO_PLAY  | Swiper子组件是否自动播放,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:控制子组件是否自动播放,0表示不自动播放,1表示自动播放,默认值为0。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:控制子组件是否自动播放,0表示不自动播放,1表示自动播放,默认值为0。 |
3642| NODE_SWIPER_SHOW_INDICATOR  | Swiper是否显示导航点指示器,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:是否显示导航点指示器,0表示不显示导航点指示器,1表示显示导航点指示器,默认值为1。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:是否显示导航点指示器,0表示不显示导航点指示器,1表示显示导航点指示器,默认值为1。 |
3643| NODE_SWIPER_INTERVAL  | 设置Swiper自动播放时播放的时间间隔,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:使用自动播放时播放的时间间隔,单位为毫秒。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:使用自动播放时播放的时间间隔,单位为毫秒。 |
3644| NODE_SWIPER_VERTICAL  | 设置Swiper是否为纵向滑动,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:是否为纵向滑动,0表示横向滑动,1表示纵向滑动,默认值为0。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:是否为纵向滑动,0表示横向滑动,1表示纵向滑动,默认值为0。 |
3645| NODE_SWIPER_DURATION  | 设置Swiper子组件切换的动画时长,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:子组件切换的动画时长,单位为毫秒, 默认值为400。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:子组件切换的动画时长,单位为毫秒, 默认值为400。 |
3646| NODE_SWIPER_CURVE  | 设置Swiper的动画曲线,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:设置动画曲线参数,参数类型[ArkUI_AnimationCurve](#arkui_animationcurve),默认值为ARKUI_CURVE_LINEAR。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:设置动画曲线参数,参数类型[ArkUI_AnimationCurve](#arkui_animationcurve),默认值为ARKUI_CURVE_LINEAR。 |
3647| NODE_SWIPER_ITEM_SPACE  | 设置Swiper子组件与子组件之间间隙,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:子组件与子组件之间间隙数值。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:子组件与子组件之间间隙数值。 |
3648| NODE_SWIPER_INDEX  | 设置Swiper当前在容器中显示的子组件的索引值,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:子组件的索引值。<br/>.value[1]?.i32:跳转动画模式,参数类型[ArkUI_SwiperAnimationMode](#arkui_swiperanimationmode)。仅当次调用有效。<br/>该参数自API 15开始支持。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:子组件的索引值。 |
3649| NODE_SWIPER_DISPLAY_COUNT  | 设置Swiper一页内元素显示个数,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:视窗内显示的子元素个数。<br/>.value[1]?.i32:是否按组翻页,0:按子元素翻页,1:视窗内显示的子元素按组翻页,默认值:0。<br/>.string?:此参数只能设置为“auto”。当设置为“auto”时,value[] 参数将被忽略。<br/>.起始版本:18<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:视窗内显示的子元素个数。<br/> .value[1].i32:是否按组翻页。<br/>起始版本:18|
3650| NODE_SWIPER_DISABLE_SWIPE  | 设置Swiper禁用组件滑动切换功能,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:是否禁用组件滑动切换功能,0表示不禁用滑动切换功能,1表示禁用滑动切换功能,默认值为0。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:是否禁用组件滑动切换功能,0表示不禁用滑动切换功能,1表示禁用滑动切换功能,默认值为0。 |
3651| NODE_SWIPER_SHOW_DISPLAY_ARROW  | 设置Swiper是否显示导航点箭头,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:设置是否显示导航点箭头,参数类型[ArkUI_SwiperArrow](#arkui_swiperarrow),<br/>默认值为ARKUI_SWIPER_ARROW_HIDE。<br/> .?object:显示导航箭头时设置箭头样式,参数类型[ArkUI_SwiperArrowStyle](#arkui_swiperarrowstyle)。<br/>起始版本:<br/>18 </br>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:设置是否显示导航点箭头,参数类型[ArkUI_SwiperArrow](#arkui_swiperarrow),<br/>默认值为ARKUI_SWIPER_ARROW_HIDE。<br/> .object:箭头样式,参数类型[ArkUI_SwiperArrowStyle](#arkui_swiperarrowstyle)。<br/>起始版本:<br/>18 |
3652| NODE_SWIPER_EDGE_EFFECT_MODE  | 设置Swiper的边缘滑动效果,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 边缘滑动效果,参数类型[ArkUI_EdgeEffect](#arkui_edgeeffect),<br/>默认值为ARKUI_EDGE_EFFECT_SPRING。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32: 边缘滑动效果,参数类型[ArkUI_EdgeEffect](#arkui_edgeeffect), |
3653| NODE_SWIPER_NODE_ADAPTER  | swiper组件适配器,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object:使用**ArkUI_NodeAdapter**对象作为适配器。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object:返回值格式为**ArkUI_NodeAdapter**。 |
3654| NODE_SWIPER_CACHED_COUNT  | swiper组件Adapter缓存数量,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:配合swiper组件Adapter使用,设置adapter中的缓存数量<br/>.value[1]?.i32:是否显示缓存节点,0:不显示,1:显示,默认值:0。<br/>起始版本:<br/>18<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:adapter中的缓存数量。<br/>.value[1].i32:是否显示缓存节点,0:不显示,1:显示。<br/>起始版本:<br/>18 |
3655| NODE_SWIPER_PREV_MARGIN  | 设置 Swiper 组件的前边距,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:前边距数值,单位为vp,默认值为0。<br/>.value[1]?.i32:是否忽略空白,1表示忽略空白,0表示不忽略空白。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:前边距数值,单位为vp。 .value[1].i32:是否忽略空白,1表示忽略空白,0表示不忽略空白。 |
3656| NODE_SWIPER_NEXT_MARGIN  | 设置 Swiper 组件的后边距,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:后边距数值,单位为vp,默认值为0。<br/>.value[1]?.i32:是否忽略空白,1表示忽略空白,0表示不忽略空白。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:后边距数值,单位为vp。 .value[1].i32:是否忽略空白,1表示忽略空白,0表示不忽略空白。 |
3657| NODE_SWIPER_INDICATOR  | 设置 Swiper 组件的导航指示器类型,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:设置导航指示器的类型,参数类型[ArkUI_SwiperIndicatorType](#arkui_swiperindicatortype)。<br/>.object:导航指示器的类型为ARKUI_SWIPER_INDICATOR_TYPE_DOT时参数类型[ArkUI_SwiperIndicator](#arkui_swiperindicator)。<br/> 导航指示器的类型为ARKUI_SWIPER_INDICATOR_TYPE_DIGIT时参数类型[ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)。<br/> 类型[ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)<br/>起始版本:<br/>18 <br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:导航指示器的类型,参数类型[ArkUI_SwiperIndicatorType](#arkui_swiperindicatortype)。<br/>.object:导航指示器的类型为ARKUI_SWIPER_INDICATOR_TYPE_DOT时参数类型[ArkUI_SwiperIndicator](#arkui_swiperindicator)。<br/> 导航指示器的类型为ARKUI_SWIPER_INDICATOR_TYPE_DIGIT时参数类型[ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)。<br/> 类型[ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)<br/>起始版本:<br/>18 |
3658| NODE_SWIPER_NESTED_SCROLL  | 设置Swiper组件和父组件的嵌套滚动模式。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:Swiper组件和父组件的嵌套滚动模式,参数类型[ArkUI_SwiperNestedScrollMode](#arkui_swipernestedscrollmode)<br/>默认值为:ARKUI_SWIPER_NESTED_SRCOLL_SELF_ONLY<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:Swiper组件和父组件的嵌套滚动模式,参数类型[ArkUI_SwiperNestedScrollMode](#arkui_swipernestedscrollmode) |
3659| NODE_SWIPER_SWIPE_TO_INDEX  | 设置swiper组件翻至指定页面。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:指定页面在Swiper中的索引值。<br/>.value[1]?.i32:设置翻至指定页面时是否有动效。1表示有动效,0表示没有动效, 默认值:0。 |
3660| NODE_SWIPER_INDICATOR_INTERACTIVE  | 设置禁用组件导航点交互功能。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:设置禁用组件导航点交互功能,设置为true时表示导航点可交互,默认值true。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:设置禁用组件导航点交互功能。 |
3661| NODE_SWIPER_PAGE_FLIP_MODE  | 设置组件鼠标滚轮翻页模式。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:设置组件鼠标滚轮翻页模式,参数类型[ArkUI_PageFlipMode](#arkui_pageflipmode)。<br/>属性获取方法返回值[ArkUI_PageFlipMode](#arkui_pageflipmode)格式:<br/>.value[0].i32:鼠标滚轮翻页模式。<br/>起始版本:<br/>15 |
3662| NODE_SWIPER_AUTO_FILL  | 设置Swiper一页内元素显示个数根据元素最小宽度自适应,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:元素显示最小宽度,单位:vp。<br/> .value[1]?.i32:是否按组翻页,0:按子元素翻页,1:视窗内显示的子元素按组翻页,默认值:0。 <br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:元素显示最小宽度,单位:vp。<br/> .value[1].i32:是否按组翻页。<br/>起始版本:<br/>18 |
3663| NODE_LIST_ITEM_SWIPE_ACTION  | 设置ListItem的划出组件,支持属性设置,属性重置,属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object:使用[ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption)对象构造。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object:使用[ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption)对象构造。 |
3664| NODE_LIST_ITEM_GROUP_SET_HEADER  | 设置 ListItemGroup 头部组件,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object:使用[ArkUI_NodeHandle](#arkui_nodehandle)对象作为ListItemGroup头部组件。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object:使用[ArkUI_NodeHandle](#arkui_nodehandle)对象作为ListItemGroup头部组件。 |
3665| NODE_LIST_ITEM_GROUP_SET_FOOTER  | 设置 ListItemGroup 尾部组件,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object:使用[ArkUI_NodeHandle](#arkui_nodehandle)对象作为ListItemGroup尾部组件。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object:使用[ArkUI_NodeHandle](#arkui_nodehandle)对象作为ListItemGroup尾部组件。 |
3666| NODE_LIST_ITEM_GROUP_SET_DIVIDER  | 设置ListItem分割线样式,默认无分割线,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32: 颜色,0xargb类型;<br/>.value[1].f32: 分割线宽,单位vp;<br/>.value[2].f32: 分割线距离列表侧边起始端的距离,单位vp;<br/>.value[3].f32: 分割线距离列表侧边结束端的距离,单位vp。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].u32: 颜色,0xargb类型;<br/>.value[1].f32: 分割线宽,单位vp;<br/>.value[2].f32: 分割线距离列表侧边起始端的距离,单位vp;<br/>.value[3].f32: 分割线距离列表侧边结束端的距离,单位vp。 |
3667| NODE_LIST_ITEM_GROUP_CHILDREN_MAIN_SIZE  | 设置ListItemGroup子组件默认主轴尺寸。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>object: 参数格式为{\@ArkUI_ListChildrenMainSize}.<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object: 参数格式为{\@ArkUI_ListChildrenMainSize}. |
3668| NODE_LIST_ITEM_GROUP_NODE_ADAPTER | ListItemGroup组件适配器,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object:使用**ArkUI_NodeAdapter**对象作为适配器。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object:返回值格式为**ArkUI_NodeAdapter**。  |
3669| NODE_COLUMN_ALIGN_ITEMS  | 设置Column子组件在水平方向上的对齐格式,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:子组件在水平方向上的对齐格式,数据类型[ArkUI_HorizontalAlignment](#arkui_horizontalalignment),<br/>默认值ARKUI_HORIZONTAL_ALIGNMENT_CENTER。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:子组件在水平方向上的对齐格式,数据类型[ArkUI_HorizontalAlignment](#arkui_horizontalalignment)。 |
3670| NODE_COLUMN_JUSTIFY_CONTENT  | 设置Column子组件在垂直方向上的对齐格式,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:子组件在垂直方向上的对齐格式,数据类型[ArkUI_FlexAlignment](#arkui_flexalignment),<br/>默认值ARKUI_FLEX_ALIGNMENT_START。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:子组件在垂直方向上的对齐格式,数据类型[ArkUI_FlexAlignment](#arkui_flexalignment)。 |
3671| NODE_ROW_ALIGN_ITEMS  | 设置Row子组件在垂直方向上的对齐格式,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:子组件在垂直方向上的对齐格式,数据类型[ArkUI_VerticalAlignment](#arkui_verticalalignment),<br/>默认值ARKUI_VERTICAL_ALIGNMENT_CENTER。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:子组件在垂直方向上的对齐格式,数据类型[ArkUI_VerticalAlignment](#arkui_verticalalignment)。 |
3672| NODE_ROW_JUSTIFY_CONTENT  | 设置Row子组件在水平方向上的对齐格式,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:子组件在水平方向上的对齐格式,数据类型[ArkUI_FlexAlignment](#arkui_flexalignment),<br/>默认值ARKUI_FLEX_ALIGNMENT_START。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:子组件在水平方向上的对齐格式,数据类型[ArkUI_FlexAlignment](#arkui_flexalignment)。 |
3673| NODE_FLEX_OPTION  | 设置Flex属性,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0]?.i32:子组件在Flex容器上排列的方向[ArkUI_FlexDirection](#arkui_flexdirection),默认值为ARKUI_FLEX_DIRECTION_ROW;<br/>.value[1]?.i32:排列规则[ArkUI_FlexWrap](#arkui_flexwrap),默认值为ARKUI_FLEX_WRAP_NO_WRAP;<br/>.value[2]?.i32:主轴上的对齐格式[ArkUI_FlexAlignment](#arkui_flexalignment),默认值为ARKUI_FLEX_ALIGNMENT_START;<br/>.value[3]?.i32:交叉轴上的对齐格式[ArkUI_ItemAlignment](#arkui_itemalignment),默认值为ARKUI_ITEM_ALIGNMENT_START;<br/>.value[4]?.i32: 交叉轴中有额外的空间时,多行内容的对齐方式[ArkUI_FlexAlignment](#arkui_flexalignment),默认值为ARKUI_FLEX_ALIGNMENT_START;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:子组件在Flex容器上排列的方向的枚举值;<br/>.value[1].i32:排列规则的枚举值;<br/>.value[2].i32:主轴上的对齐格式的枚举值;<br/>.value[3].i32:交叉轴上的对齐格式的枚举值;<br/>.value[4].i32:交叉轴中有额外的空间时,多行内容的对齐方式的枚举值; |
3674| NODE_REFRESH_REFRESHING  | 设置组件是否正在刷新,支持属性设置,属性获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].i32:参数类型为1或者0。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:参数类型为1或者0。 |
3675| NODE_REFRESH_CONTENT  | 设置下拉区域的自定义内容,支持属性设置和重置。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.object:参数类型{\@Link ArkUI_NodeHandle}。 |
3676| NODE_REFRESH_PULL_DOWN_RATIO  | 设置下拉跟手系数,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].f32:下拉跟手系数,有效值为0-1之间的值。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:下拉跟手系数,有效值为0-1之间的值。 |
3677| NODE_REFRESH_OFFSET  | 设置触发刷新的下拉偏移量,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].f32:下拉偏移量,单位vp, 默认值:64vp。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:下拉偏移量,单位vp, 默认值:64vp。 |
3678| NODE_REFRESH_PULL_TO_REFRESH  | 设置当下拉距离超过refreshOffset时是否触发刷新,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].i32:是否触发刷新,true为触发刷新,false为不触发刷新。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:是否触发刷新,1为触发刷新,0为不触发刷新。 |
3679| NODE_WATER_FLOW_LAYOUT_DIRECTION  | 定义瀑布流组件布局主轴方向,支持属性设置、重置和获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].i32 主轴方向,参数类型{\@Link ArkUI_FlexDirection}。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32 主轴方向,参数类型{\@Link ArkUI_FlexDirection}。 |
3680| NODE_WATER_FLOW_COLUMN_TEMPLATE  | 设置当前瀑布流组件布局列的数量,不设置时默认1列,支持属性设置、重置和获取。 例如,'1fr 1fr 2fr' 是将父组件分3列,将父组件允许的宽分为4等份,第一列占1份,第二列占1份,第三列占2份。 可使用columnsTemplate('repeat(auto-fill,track-size)')根据给定的列宽track-size自动计算列数, 其中repeat、auto-fill为关键字,track-size为可设置的宽度,支持的单位包括px、vp、或有效数字,默认单位为vp。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.string: 布局列的数量.<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 布局列的数量. |
3681| NODE_WATER_FLOW_ROW_TEMPLATE  | 设置当前瀑布流组件布局行的数量,不设置时默认1行,支持属性设置、重置和获取。 例如,'1fr 1fr 2fr'是将父组件分三行,将父组件允许的高分为4等份,第一行占1份,第二行占一份,第三行占2份。 可使用rowsTemplate('repeat(auto-fill,track-size)')根据给定的行高track-size自动计算行数, 其中repeat、auto-fill为关键字,track-size为可设置的高度,支持的单位包括px、vp、或有效数字,默认单位为vp。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.string: 布局行的数量.<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 布局行的数量. |
3682| NODE_WATER_FLOW_COLUMN_GAP  | 设置列与列的间距,支持属性设置、重置和获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].f32: 列与列的间距, 单位vp.<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 列与列的间距, 单位vp. |
3683| NODE_WATER_FLOW_ROW_GAP  | 设置行与行的间距,支持属性设置、重置和获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].f32: 行与行的间距, 单位vp.<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 行与行的间距, 单位vp. |
3684| NODE_WATER_FLOW_SECTION_OPTION  | 设置FlowItem分组配置信息,支持属性设置、重置和获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].i32: 从0开始计算的索引,会转换为整数,表示要开始改变分组的位置.<br/>.object: 参数格式为{\@ArkUI_WaterFlowSectionOption}.<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object: 返回值格式为{\@ArkUI_WaterFlowSectionOption}. |
3685| NODE_WATER_FLOW_NODE_ADAPTER  | waterFlow组件适配器,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object:使用**ArkUI_NodeAdapter**对象作为适配器。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object: 返回值格式为**ArkUI_NodeAdapter**. |
3686| NODE_WATER_FLOW_CACHED_COUNT  | waterFlow组件Adapter缓存数量,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:配合waterFlow组件Adapter使用,设置adapter中的缓存数量。<br/>.value[1].i32:是否显示缓存节点,0:不显示,1:显示,默认值:0。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:adapter中的缓存数量。<br/>.value[1].f32:是否显示缓存节点,0:不显示,1:显示。 |
3687| NODE_WATER_FLOW_FOOTER  | 设置瀑布流组件末尾的自定义显示组件。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.object:参数类型[ArkUI_NodeHandle](#arkui_nodehandle)。 |
3688| NODE_WATER_FLOW_SCROLL_TO_INDEX  | 滑动到指定index。<br/>开启smooth动效时,会对经过的所有item进行加载和布局计算,当大量加载item时会导致性能问题。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:要滑动到的目标元素在当前容器中的索引值。<br/>.value[1]?.i32:设置滑动到列表项在列表中的索引值时是否有动效,1表示有动效,0表示没有动效。默认值:0。<br/>.value[2]?.i32:指定滑动到的元素与当前容器的对齐方式,参数类型[ArkUI_ScrollAlignment](#arkui_scrollalignment)。默认值为:ARKUI_SCROLL_ALIGNMENT_START。 |
3689| NODE_WATER_FLOW_ITEM_CONSTRAINT_SIZE  | 设置当前瀑布流子组件的约束尺寸属性,组件布局时,进行尺寸范围限制,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:最小宽度,使用-1表示不设置;<br/>.value[1].f32:最大宽度,使用-1表示不设置;<br/>.value[2].f32:最小高度,使用-1表示不设置;<br/>.value[3].f32:最大高度,使用-1表示不设置;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:最小宽度,使用-1表示不设置;<br/>.value[1].f32:最大宽度,使用-1表示不设置;<br/>.value[2].f32:最小高度,使用-1表示不设置;<br/>.value[3].f32:最大高度,使用-1表示不设置; |
3690| NODE_WATER_FLOW_LAYOUT_MODE  | 定义瀑布流组件布局模式,支持属性设置、重置和获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].f32: 布局模式,参数类型[ArkUI_WaterFlowLayoutMode](_ark_u_i___native_module.md#arkui_waterflowlayoutmode)。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 布局模式,参数类型[ArkUI_WaterFlowLayoutMode](_ark_u_i___native_module.md#arkui_waterflowlayoutmode)。 |
3691| NODE_RELATIVE_CONTAINER_GUIDE_LINE  | 设置RelativeContaine容器内的辅助线,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object: RelativeContaine容器内的辅助线:<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object: RelativeContaine容器内的辅助线: |
3692| NODE_RELATIVE_CONTAINER_BARRIER  | 设置RelativeContaine容器内的屏障,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object: RelativeContaine容器内的辅助线:<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object: RelativeContaine容器内的屏障: |
3693| NODE_GRID_COLUMN_TEMPLATE  | 设置当前瀑布流组件布局列的数量,不设置时默认1列,支持属性设置、重置和获取。 例如,'1fr 1fr 2fr' 是将父组件分3列,将父组件允许的宽分为4等份,第一列占1份,第二列占1份,第三列占2份。 可使用columnsTemplate('repeat(auto-fill,track-size)')根据给定的列宽track-size自动计算列数, 其中repeat、auto-fill为关键字,track-size为可设置的宽度,支持的单位包括px、vp、或有效数字,默认单位为vp。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.string: 布局列的数量.<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 布局列的数量. |
3694| NODE_GRID_ROW_TEMPLATE  | 设置当前网格布局行的数量或最小行高值,不设置时默认1行,支持属性设置、重置和获取。 例如,'1fr 1fr 2fr'是将父组件分三行,将父组件允许的高分为4等份,第一行占1份,第二行占一份,第三行占2份。 可使用rowsTemplate('repeat(auto-fill,track-size)')根据给定的行高track-size自动计算行数, 其中repeat、auto-fill为关键字,track-size为可设置的高度,支持的单位包括px、vp、或有效数字,默认单位为vp。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.string: 布局行的数量.<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.string: 布局行的数量. |
3695| NODE_GRID_COLUMN_GAP  | 设置列与列的间距,支持属性设置、重置和获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].f32: 列与列的间距, 单位vp.<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 列与列的间距, 单位vp. |
3696| NODE_GRID_ROW_GAP  | 设置行与行的间距,支持属性设置、重置和获取。<br/>属性设置方法[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)参数格式:<br/>.value[0].f32: 行与行的间距, 单位vp.<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32: 行与行的间距, 单位vp. |
3697| NODE_GRID_NODE_ADAPTER  | grid组件适配器,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object:使用**ArkUI_NodeAdapter**对象作为适配器。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.object: 返回值格式为**ArkUI_NodeAdapter**. |
3698| NODE_GRID_CACHED_COUNT  | grid组件Adapter缓存数量,支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:配合waterFlow组件Adapter使用,设置adapter中的缓存数量 |
3699| NODE_TEXT_PICKER_COLUMN_WIDTHS<sup>18+</sup>  | 设置每一个选择项列宽。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:设置的第1个选择项列宽,为总宽度的百分比。默认情况下,所有选择项的列宽相等;<br/>.value[1].f32:设置的第2个选择项列宽,为总宽度的百分比。默认情况下,所有选择项的列宽相等;<br/>.value[2].f32:设置的第3个选择项列宽,为总宽度的百分比。默认情况下,所有选择项的列宽相等;<br/>...<br/>.value[n].f32:设置的第n+1个选择项列宽,为总宽度的百分比。默认情况下,所有选择项的列宽相等;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:第1列宽度,总宽度的百分;<br/>.value[1].f32:第2列宽度,总宽度的百分;<br/>.value[2].f32:第3列宽度,总宽度的百分;<br/>...<br/>.value[n].f32:第n+1列宽度,总宽度的百分; |
3700| NODE_IMAGE_ANIMATOR_IMAGES  | 设置帧动画组件的图片帧信息集合。不支持动态更新。支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.size:图片帧的数量;<br/>.object:图片帧数组,参数类型为{\@ArkUI_ImageAnimatorFrameInfo}数组;<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.size:图片帧的数量;<br/>.object:图片帧数组,参数类型为{\@ArkUI_ImageAnimatorFrameInfo}数组; |
3701| NODE_IMAGE_ANIMATOR_STATE  | 控制帧动画组件的播放状态。支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:控制动画的播放状态,参数类型为[ArkUI_AnimationStatus](#arkui_animationstatus),默认值为初始状态。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:控制动画的播放状态,参数类型为[ArkUI_AnimationStatus](#arkui_animationstatus)。 |
3702| NODE_IMAGE_ANIMATOR_DURATION  | 设置帧动画的播放时长,当数组中任意一帧图片单独设置了duration属性后,该属性设置无效。 支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:播放时长,单位为毫秒,默认值1000。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:播放时长,单位为毫秒,默认值1000。 |
3703| NODE_IMAGE_ANIMATOR_REVERSE  | 设置帧动画的播放方向。支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:播放方向,0表示从第一张图片播放到最后一张,1表示从最后一张图片播放到第一张,默认值为0。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:播放方向,0表示从第一张图片播放到最后一张,1表示从最后一张图片播放到第一张。 |
3704| NODE_IMAGE_ANIMATOR_FIXED_SIZE  | 设置图片大小是否固定为组件大小。支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:设置图片大小是否固定为组件大小,1表示图片大小与组件大小一致。0表示每一张图片的width、height、top和left都要单独设置,默认值为1。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:设置图片大小是否固定为组件大小,1表示图片大小与组件大小一致。0表示每一张图片的width、height、top和left都要单独设置。 |
3705| NODE_IMAGE_ANIMATOR_FILL_MODE  | 设置帧动画在当前播放方向下,动画开始前和结束后的状态。支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:当前播放方向下,动画开始前和结束后的状态,参数类型为{ArkUI_AnimationFillMode},默认值为FORWARDS。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:当前播放方向下,动画开始前和结束后的状态,参数类型为{ArkUI_AnimationFillMode}。 |
3706| NODE_IMAGE_ANIMATOR_ITERATION  | 设置帧动画的播放次数。支持属性设置,属性重置和属性获取接口。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:播放次数。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].i32:播放次数。 |
3707| NODE_BACKDROP_BLUR  | 设置背景模糊效果,支持属性设置,属性重置和属性获取。<br/>属性设置方法参数[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:表示背景模糊半径,取值范围[0,+∞)。单位px,默认值0.0。<br/>.value[1]?.f32:表示灰阶模糊参数,对黑色的提亮程度,取值范围为[0,127]。<br/>.value[2]?.f32:表示灰阶模糊参数,对白色的压暗程度,取值范围为[0,127]。<br/>属性获取方法返回值[ArkUI_AttributeItem](_ark_u_i___attribute_item.md)格式:<br/>.value[0].f32:表示背景模糊半径,取值范围[0,+∞)。单位px。<br/>.value[1].f32:表示灰阶模糊参数,对黑色的提亮程度,取值范围为[0,127]。<br/>.value[2].f32:表示灰阶模糊参数,对白色的压暗程度,取值范围为[0,127]。 |
3708
3709### ArkUI_DatePickerMode
3710
3711```
3712enum ArkUI_DatePickerMode
3713```
3714**描述:**
3715
3716定义要显示的日期选项列类型。
3717
3718**起始版本:** 18
3719
3720| 枚举值 | 描述 |
3721| -------- | -------- |
3722| ARKUI_DATEPICKER_MODE_DATE  | 默认值。日期列显示年、月、日三列。 |
3723| ARKUI_DATEPICKER_YEAR_AND_MONTH  | 日期列显示年、月二列。 |
3724| ARKUI_DATEPICKER_MONTH_AND_DAY  | 日期列显示月、日二列。<br/>此模式下,如果月份从12月变化到1月,年份不增加1年;如果月份从1月变化到12月,年份不减少1年;年份始终在当前设置的年份。 |
3725
3726### ArkUI_NodeContentEventType
3727
3728```
3729enum ArkUI_NodeContentEventType
3730```
3731**描述:**
3732
3733定义NodeContent事件类型。
3734
3735**起始版本:** 12
3736
3737| 枚举值 | 描述 |
3738| -------- | -------- |
3739| NODE_CONTENT_EVENT_ON_ATTACH_TO_WINDOW  | 上树事件。  |
3740| NODE_CONTENT_EVENT_ON_DETACH_FROM_WINDOW  | 下树事件。  |
3741
3742
3743### ArkUI_NodeCustomEventType
3744
3745```
3746enum ArkUI_NodeCustomEventType
3747```
3748**描述:**
3749
3750定义自定义组件事件类型。
3751
3752**起始版本:** 12
3753
3754| 枚举值 | 描述 |
3755| -------- | -------- |
3756| ARKUI_NODE_CUSTOM_EVENT_ON_MEASURE  | measure 类型。  |
3757| ARKUI_NODE_CUSTOM_EVENT_ON_LAYOUT  | layout 类型。  |
3758| ARKUI_NODE_CUSTOM_EVENT_ON_DRAW  | draw 类型。  |
3759| ARKUI_NODE_CUSTOM_EVENT_ON_FOREGROUND_DRAW  | foreground 类型。  |
3760| ARKUI_NODE_CUSTOM_EVENT_ON_OVERLAY_DRAW  | overlay 类型。  |
3761
3762### ArkUI_NodeDirtyFlag
3763
3764```
3765enum ArkUI_NodeDirtyFlag
3766```
3767**描述:**
3768
3769自定义组件调用&lt;b&gt;::markDirty是传递的脏区标识类型。
3770
3771**起始版本:** 12
3772
3773| 枚举值 | 描述 |
3774| -------- | -------- |
3775| NODE_NEED_MEASURE  | 重新测算大小。<br/>该flag类型触发时,同时也默认会触发重新布局。 |
3776| NODE_NEED_LAYOUT  | 重新布局位置。  |
3777| NODE_NEED_RENDER  | 重新进行绘制。  |
3778
3779
3780### ArkUI_NodeEventType
3781
3782```
3783enum ArkUI_NodeEventType
3784```
3785**描述:**
3786
3787提供NativeNode组件支持的事件类型定义。
3788
3789**起始版本:** 12
3790
3791| 枚举值 | 描述 |
3792| -------- | -------- |
3793| NODE_TOUCH_EVENT  | 手势事件类型。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent)。 |
3794| NODE_EVENT_ON_APPEAR  | 挂载事件。<br/>触发该事件的条件 :组件挂载显示时触发此回调。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中不包含参数。 |
3795| NODE_EVENT_ON_DISAPPEAR  | 卸载事件。<br/>触发该事件的条件 :组件卸载时触发此回调。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中不包含参数。 |
3796| NODE_EVENT_ON_AREA_CHANGE  | 组件区域变化事件<br/>触发该事件的条件:组件区域变化时触发该回调。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含12个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].f32**:表示过去目标元素的宽度,类型为number,单位vp。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].f32**:表示过去目标元素的高度,类型为number,单位vp。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[2].f32**:表示过去目标元素左上角相对父元素左上角的位置的x轴坐标,类型为number,单位vp。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[3].f32**:表示过去目标元素左上角相对父元素左上角的位置的y轴坐标,类型为number,单位vp。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[4].f32**:表示过去目标元素目标元素左上角相对页面左上角的位置的x轴坐标,类型为number,单位vp。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[5].f32**:表示过去目标元素目标元素左上角相对页面左上角的位置的y轴坐标,类型为number,单位vp。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[6].f32**:表示最新目标元素的宽度,类型为number,单位vp。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[7].f32**:表示最新目标元素的高度,类型为number,单位vp。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[8].f32**:表示最新目标元素左上角相对父元素左上角的位置的x轴坐标,类型为number,单位vp。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[9].f32**:表示最新目标元素左上角相对父元素左上角的位置的y轴坐标,类型为number,单位vp。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[10].f32**:表示最新目标元素目标元素左上角相对页面左上角的位置的x轴坐标,类型为number,单位vp。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[11].f32**:表示最新目标元素目标元素左上角相对页面左上角的位置的y轴坐标,类型为number,单位vp。 |
3797| NODE_ON_FOCUS  | 获焦事件。<br/>触发该事件的条件:组件获焦时触发此回调。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中不包含参数。 |
3798| NODE_ON_BLUR  | 失去焦点事件。<br/>触发该事件的条件:组件失去焦点时触发此回调。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中不包含参数。 |
3799| NODE_ON_CLICK  | 组件点击事件。<br/>触发该事件的条件:组件被点击时触发此回调。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含12个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].f32**:点击位置相对于被点击元素原始区域左上角的X坐标,单位px。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].f32**:点击位置相对于被点击元素原始区域左上角的Y坐标,单位px。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[2].f32**:事件时间戳。触发事件时距离系统启动的时间间隔,单位微秒。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[3].i32**:事件输入设备,1表示鼠标,2表示触屏,4表示按键。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[4].f32**:点击位置相对于应用窗口左上角的X坐标,单位px。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[5].f32**:点击位置相对于应用窗口左上角的Y坐标,单位px。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[6].f32**:点击位置相对于应用屏幕左上角的X坐标,单位px。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[7].f32**:点击位置相对于应用屏幕左上角的Y坐标,单位px。 |
3800| NODE_ON_CLICK_EVENT | 组件点击事件。<br/>触发该事件的条件:组件被点击时触发此回调。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent)。 |
3801| NODE_ON_TOUCH_INTERCEPT  | 组件自定义事件拦截。<br/>触发该事件的条件:组件被触摸时触发此回调。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent)。 |
3802| NODE_EVENT_ON_VISIBLE_AREA_CHANGE  | 组件可见区域变化事件。<br/>触发该事件的条件:组件可见面积与自身面积的比值接近设置的阈值时触发回调,注册事件前需先使用 NODE_VISIBLE_AREA_CHANGE_RATIO 配置阈值。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含2个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**:组件可见面积与自身面积的比值与上次变化相比的情况,变大为1,变小为0。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].f32**:触发回调时组件可见面积与自身面积的比值。 |
3803| NODE_ON_HOVER  | 鼠标进入或退出组件事件。<br/>触发该事件的条件:鼠标进入或退出组件时触发回调。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含1个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**:鼠标是否悬浮在组件上,鼠标进入时为1,退出时为0。 |
3804| NODE_ON_HOVER_EVENT  | 鼠标进入或退出组件事件。<br/>触发该事件的条件:鼠标进入或退出组件时触发回调。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent)。 |
3805| NODE_ON_MOUSE  | 组件点击事件。<br/>触发该事件的条件:组件被鼠标按键点击或者鼠标在组件上悬浮移动时触发该回调。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent)。 |
3806| NODE_EVENT_ON_ATTACH  | 上树事件。<br/>触发该事件的条件 :组件上树时触发此回调。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中不包含参数。 |
3807| NODE_EVENT_ON_DETACH  | 下树事件。<br/>触发该事件的条件 :组件下树时触发此回调。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中不包含参数。 |
3808| NODE_ON_ACCESSIBILITY_ACTIONS  | 无障碍支持操作事件触发。<br/>触发该事件的条件:已设置无障碍操作类型,并进行相应操作。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含1个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].u32**: 触发回调的操作类型,参数类型[ArkUI_AccessibilityActionType](#arkui_accessibilityactiontype) |
3809| NODE_ON_PRE_DRAG  | 在拖拽行为开始之前告诉侦听器详细的交互状态。<br/>触发该事件的条件:组件可拖拽,当长按浮起/松手/发起拖拽时,回调触发。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含1个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**:对应[ArkUI_PreDragStatus](#arkui_predragstatus)。 |
3810| NODE_ON_DRAG_START  | 用户已移动足够距离,即将发起拖拽。<br/>触发该事件的条件:长按拖动产生足够位移距离时触发。<br/>事件回调发生时,可从事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中获取[ArkUI_DragEvent](#arkui_dragevent)。 |
3811| NODE_ON_DRAG_ENTER  | 用户拖拽进入当前组件范围。<br/>触发该事件的条件: 拖拽对象进入监听了该事件的组件边界时触发。<br/>事件回调发生时,可从事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中获取[ArkUI_DragEvent](#arkui_dragevent)。 |
3812| NODE_ON_DRAG_MOVE  | 用户拖拽在当前组件范围内移动。<br/>触发该事件的条件: 拖拽对象在监听了该事件的组件范围内移动时触发。<br/>事件回调发生时,可从事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中获取[ArkUI_DragEvent](#arkui_dragevent)。 |
3813| NODE_ON_DRAG_LEAVE  | 用户拖拽从当前组件范围离开。<br/>触发该事件的条件: 拖拽对象离开监听了该事件的组件边界时触发。<br/>事件回调发生时,可从事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中获取[ArkUI_DragEvent](#arkui_dragevent)。 |
3814| NODE_ON_DROP  | 当用户在组件上方松手时,该组件上可通过该回调拿到拖拽数据进行处理。<br/>触发该事件的条件: 拖拽对象并在组件上方松手时触发。<br/>事件回调发生时,可从事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中获取[ArkUI_DragEvent](#arkui_dragevent)。 |
3815| NODE_ON_DRAG_END  | 拖拽发起方可通过注册该回调感知拖拽结束后的结果。<br/>触发该事件的条件:用户松手,拖拽行为结束时触发。 事件回调发生时,可从事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中获取[ArkUI_DragEvent](#arkui_dragevent)。 |
3816| NODE_ON_KEY_EVENT  | 绑定该方法的组件获焦后,按键动作触发该回调。<br/>触发该事件的条件 :由外设键盘等设备与获焦窗口交互触发此回调。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>起始版本:<br/>14 |
3817| NODE_ON_KEY_PRE_IME  | 绑定该方法的组件获焦后,按键动作在响应输入法前优先触发该回调。<br/>该回调的返回值为true时,视作该按键事件已被消费,后续的事件回调(keyboardShortcut、输入法事件、onKeyEvent)会被拦截,不再触发。 触发该事件的条件 :由外设键盘等设备与获焦窗口交互触发此回调。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>起始版本:<br/>14 |
3818| NODE_ON_AXIS | 绑定该方法的组件收到轴事件时触发该回调。<br/>当绑定组件接收到轴事件时,会触发该事件回调。<br/>事件发生时, [ArkUI_NodeEvent](#arkui_nodeevent-12) 对象中的联合类型为 [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent)。<br/>起始版本:<br/>18|
3819| NODE_DISPATCH_KEY_EVENT  | 组件按键事件重新派发事件。当组件节点接收到按键事件时,将触发此回调函数,而非将事件分发给其子节点。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>起始版本:<br/>15 |
3820| NODE_VISIBLE_AREA_APPROXIMATE_CHANGE_EVENT  | 组件可见区域变化事件。<br/>触发该事件的条件:组件可见面积与自身面积的比值接近设置的阈值时触发回调,注册事件前需先使用 NODE_VISIBLE_AREA_APPROXIMATE_CHANGE_RATIO 配置阈值。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含2个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**:组件可见面积与自身面积的比值与上次变化相比的情况,变大为1,变小为0。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].f32**:触发回调时组件可见面积与自身面积的比值。 <br/>起始版本:<br/>17 |
3821| NODE_ON_HOVER_MOVE  | 当手写笔设备指针悬停在组件内时会触发该事件。<br/>事件回调发生时, 事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象可以从[ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent)对象中获取。<br/>起始版本:<br/>15 |
3822| NODE_TEXT_ON_DETECT_RESULT_UPDATE  | 文本设置TextDataDetectorConfig且识别成功时,触发onDetectResultUpdate回调。<br/>触发该事件的条件:文本设置TextDataDetectorConfig且识别成功后。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md)。<br/>[ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md)中包含1个参数:<br/>**[ArkUI_StringAsyncEvent.pStr](_ark_u_i___string_async_event.md#pstr)**:表示文本识别的结果,Json格式。 |
3823| NODE_IMAGE_ON_COMPLETE  | 图片加载成功事件。<br/>触发该事件的条件 :图片数据加载成功和解码成功均触发该回调。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含9个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**:表示加载状态,0表示数据加载成功,1表示解码成功。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].f32**:表示图片的宽度,单位px。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[2].f32**:表示图片的高度,单位px。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[3].f32**:表示当前组件的宽度,单位px。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[4].f32**:表示当前组件的高度,单位px。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[5].f32**:图片绘制区域相对组件X轴位置,单位px。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[6].f32**:图片绘制区域相对组件Y轴位置,单位px。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[7].f32**:图片绘制区域宽度,单位px。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[8].f32**:图片绘制区域高度,单位px。 |
3824| NODE_IMAGE_ON_ERROR  | 图片加载失败事件。<br/>触发该事件的条件:图片加载异常时触发该回调。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含1个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**错误码信息:<br/>401: 图片路径参数异常,无法获取到图片数据。<br/>103101: 图片格式不支持。 |
3825| NODE_IMAGE_ON_SVG_PLAY_FINISH  | SVG图片动效播放完成事件。<br/>触发该事件的条件:带动效的SVG图片动画结束时触发。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中不包含参数。 |
3826| NODE_IMAGE_ON_DOWNLOAD_PROGRESS  | 定义图片下载过程中触发事件。<br/>触发该事件的条件 :页面组件下载网页图片时触发。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含2个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].u32**: 到目前为止已下载的字节数。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].u32**: 要下载图片的总字节数。 |
3827| NODE_TOGGLE_ON_CHANGE  | 开关状态发生变化时触发给事件。<br/>触发该事件的条件:开关状态发生变化。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含1个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**:当前开关状态,1表示开,0表示关。 |
3828| NODE_TEXT_INPUT_ON_CHANGE  | textInput输入内容发生变化时触发该事件。<br/>触发该事件的条件:输入内容发生变化时。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md)。<br/>[ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md)中包含1个参数:<br/>**[ArkUI_StringAsyncEvent.pStr](_ark_u_i___string_async_event.md#pstr)**:输入的文本内容。 |
3829| NODE_TEXT_INPUT_ON_SUBMIT  | textInput按下输入法回车键触发该事件。<br/>触发该事件的条件:按下输入法回车键。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含1个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**:输入法回车键类型。 |
3830| NODE_TEXT_INPUT_ON_CUT  | 长按输入框内部区域弹出剪贴板后,点击剪切板剪切按钮,触发该回调。<br/>触发该事件的条件:长按输入框内部区域弹出剪贴板后,点击剪切板剪切按钮。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md)。<br/>[ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md)中包含1个参数:<br/>**[ArkUI_StringAsyncEvent.pStr](_ark_u_i___string_async_event.md#pstr)**:剪切的文本内容。 |
3831| NODE_TEXT_INPUT_ON_PASTE  | 长按输入框内部区域弹出剪贴板后,点击剪切板粘贴按钮,触发该回调。<br/>触发该事件的条件:长按输入框内部区域弹出剪贴板后,点击剪切板粘贴按钮。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md)。<br/>[ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md)中包含1个参数:<br/>**[ArkUI_StringAsyncEvent.pStr](_ark_u_i___string_async_event.md#pstr)**:粘贴的文本内容。 |
3832| NODE_TEXT_INPUT_ON_TEXT_SELECTION_CHANGE  | 文本选择的位置发生变化时,触发该回调。<br/>触发该事件的条件:文本选择的位置发生变化时。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含2个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**:表示所选文本的起始位置。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32**:表示所选文本的结束位置。 |
3833| NODE_TEXT_INPUT_ON_EDIT_CHANGE  | 输入状态变化时,触发该回调。<br/>触发该事件的条件:输入状态变化时。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含1个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**:表示true表示正在输入。 |
3834| NODE_TEXT_INPUT_ON_INPUT_FILTER_ERROR  | 设置NODE_TEXT_INPUT_INPUT_FILTER,正则匹配失败时触发。<br/>触发该事件的条件:正则匹配失败时。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md)。<br/>[ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md)中包含1个参数:<br/>**[ArkUI_StringAsyncEvent.pStr](_ark_u_i___string_async_event.md#pstr)**:表示正则匹配失败时,被过滤的内容。 |
3835| NODE_TEXT_INPUT_ON_CONTENT_SCROLL  | 文本内容滚动时,触发该回调。<br/>触发该事件的条件:文本内容滚动时。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含2个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**:表示文本在内容区的横坐标偏移。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32**:表示文本在内容区的纵坐标偏移。 |
3836| NODE_TEXT_INPUT_ON_CONTENT_SIZE_CHANGE  | textInput输入内容发生变化时触发该事件。<br/>触发该事件的条件:输入内容发生变化时。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含2个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].f32**:表示文本的宽度。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].f32**:表示文本的高度。 |
3837| NODE_TEXT_INPUT_ON_WILL_INSERT  | 定义在将要输入时,触发回调的枚举值。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)。<br/>通过OH_ArkUI_NodeEvent_GetNumberValue获取到index为0的value.f32:插入的值的位置信息。<br/>通过OH_ArkUI_NodeEvent_GetStringValue获取到index为0的buffer字符串:插入的值。<br/>返回<br/>在返回true时,表示正常插入,返回false时,表示不插入。 可通过OH_ArkUI_NodeEvent_SetReturnNumberValue设置返回值。 |
3838| NODE_TEXT_INPUT_ON_DID_INSERT  | 定义在输入完成时,触发回调的枚举值。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)。<br/>通过OH_ArkUI_NodeEvent_GetNumberValue获取到index为0的value.f32:插入的值的位置信息。<br/>通过OH_ArkUI_NodeEvent_GetStringValue获取到index为0的buffer字符串:插入的值。 |
3839| NODE_TEXT_INPUT_ON_WILL_DELETE  | 定义在将要删除时,触发回调的枚举值。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)。<br/>通过OH_ArkUI_NodeEvent_GetNumberValue获取到index为0的value.f32:删除的值的位置信息。<br/>通过OH_ArkUI_NodeEvent_GetNumberValue获取到index为1的value.i32:删除值的方向,0为向后删除,1为向前删除。<br/>通过OH_ArkUI_NodeEvent_GetStringValue获取到index为0的buffer字符串:删除的值。<br/>返回<br/>在返回true时,表示正常插入,返回false时,表示不插入。<br/>可通过OH_ArkUI_NodeEvent_SetReturnNumberValue设置返回值。 |
3840| NODE_TEXT_INPUT_ON_DID_DELETE  | 定义在删除完成时,触发回调的枚举值。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)。<br/>通过OH_ArkUI_NodeEvent_GetNumberValue获取到index为0的value.f32:删除的值的位置信息。<br/>通过OH_ArkUI_NodeEvent_GetNumberValue获取到index为1的value.i32:删除值的方向,0为向后删除,1为向前删除。<br/>通过OH_ArkUI_NodeEvent_GetStringValue获取到index为0的buffer字符串:删除的值。 |
3841| NODE_TEXT_INPUT_ON_CHANGE_WITH_PREVIEW_TEXT  | 定义在文本内容(包含预上屏内容)改变时,触发回调的枚举值。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_TextChangeEvent](_ark_u_i___text_change_event.md)。<br/>[ArkUI_TextChangeEvent](_ark_u_i___text_change_event.md)中包含3个参数:<br/>**[ArkUI_TextChangeEvent.pStr](_ark_u_i___text_change_event.md#pstr)**:输入的文本内容。<br/>**[ArkUI_TextChangeEvent.pExtendStr](_ark_u_i___text_change_event.md#pextendstr)**:预上屏输入的文本内容。<br/>**[ArkUI_TextChangeEvent.number](_ark_u_i___text_change_event.md#number)**:预上屏文本插入的位置。<br/>**起始版本:** 15 |
3842| NODE_TEXT_AREA_ON_CHANGE  | 输入内容发生变化时,触发该回调。<br/>触发该事件的条件:输入内容发生变化时。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md)。<br/>[ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md)中包含1个参数:<br/>**[ArkUI_StringAsyncEvent.pStr](_ark_u_i___string_async_event.md#pstr)**:当前输入的文本内容。 |
3843| NODE_TEXT_AREA_ON_PASTE  | 长按输入框内部区域弹出剪贴板后,点击剪切板粘贴按钮,触发该回调。<br/>触发该事件的条件:长按输入框内部区域弹出剪贴板后,点击剪切板粘贴按钮。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md)。<br/>[ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md)中包含1个参数:<br/>**[ArkUI_StringAsyncEvent.pStr](_ark_u_i___string_async_event.md#pstr)**:粘贴的文本内容。 |
3844| NODE_TEXT_AREA_ON_TEXT_SELECTION_CHANGE  | 文本选择的位置发生变化时,触发该回调。<br/>触发该事件的条件:文本选择的位置发生变化时。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含2个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**:表示所选文本的起始位置。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32**:表示所选文本的结束位置。 |
3845| NODE_TEXT_AREA_ON_EDIT_CHANGE  | 输入状态变化时,触发该回调。<br/>触发该事件的条件:输入状态变化时。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含1个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**:表示true表示正在输入。 |
3846| NODE_TEXT_AREA_ON_SUBMIT  | textArea按下输入法回车键触发该事件。<br/>触发该事件的条件:按下输入法回车键。keyType为ARKUI_ENTER_KEY_TYPE_NEW_LINE时不触发<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含1个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**:输入法回车键类型。 |
3847| NODE_TEXT_AREA_ON_INPUT_FILTER_ERROR  | 设置NODE_TEXT_AREA_INPUT_FILTER,正则匹配失败时触发。<br/>触发该事件的条件:正则匹配失败时。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md)。<br/>[ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md)中包含1个参数:<br/>**[ArkUI_StringAsyncEvent.pStr](_ark_u_i___string_async_event.md#pstr)**:表示正则匹配失败时,被过滤的内容。 |
3848| NODE_TEXT_AREA_ON_CONTENT_SCROLL  | 文本内容滚动时,触发该回调。<br/>触发该事件的条件:文本内容滚动时。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含2个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**:表示文本在内容区的横坐标偏移。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32**:表示文本在内容区的纵坐标偏移。 |
3849| NODE_TEXT_AREA_ON_CONTENT_SIZE_CHANGE  | textArea输入内容发生变化时触发该事件。<br/>触发该事件的条件:输入内容发生变化时。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含2个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].f32**:表示文本的宽度。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].f32**:表示文本的高度。 |
3850| NODE_TEXT_AREA_ON_WILL_INSERT  | 定义在将要输入时,触发回调的枚举值。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)。<br/>通过OH_ArkUI_NodeEvent_GetNumberValue获取到index为0的value.f32:插入的值的位置信息。<br/>通过OH_ArkUI_NodeEvent_GetStringValue获取到index为0的buffer字符串:插入的值。<br/>返回<br/>在返回true时,表示正常插入,返回false时,表示不插入。 可通过OH_ArkUI_NodeEvent_SetReturnNumberValue设置返回值。 |
3851| NODE_TEXT_AREA_ON_DID_INSERT  | 定义在输入完成时,触发回调的枚举值。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)。<br/>通过OH_ArkUI_NodeEvent_GetNumberValue获取到index为0的value.f32:插入的值的位置信息。<br/>通过OH_ArkUI_NodeEvent_GetStringValue获取到index为0的buffer字符串:插入的值。 |
3852| NODE_TEXT_AREA_ON_WILL_DELETE  | 定义在将要删除时,触发回调的枚举值。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)。<br/>通过OH_ArkUI_NodeEvent_GetNumberValue获取到index为0的value.f32:删除的值的位置信息。<br/>通过OH_ArkUI_NodeEvent_GetNumberValue获取到index为1的value.i32:删除值的方向,0为向后删除,1为向前删除。<br/>通过OH_ArkUI_NodeEvent_GetStringValue获取到index为0的buffer字符串:删除的值。<br/>返回<br/>在返回true时,表示正常插入,返回false时,表示不插入。<br/>可通过OH_ArkUI_NodeEvent_SetReturnNumberValue设置返回值。 |
3853| NODE_TEXT_AREA_ON_DID_DELETE  | 定义在删除完成时,触发回调的枚举值。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)。<br/>通过OH_ArkUI_NodeEvent_GetNumberValue获取到index为0的value.f32:删除的值的位置信息。<br/>通过OH_ArkUI_NodeEvent_GetNumberValue获取到index为1的value.i32:删除值的方向,0为向后删除,1为向前删除。<br/>通过OH_ArkUI_NodeEvent_GetStringValue获取到index为0的buffer字符串:删除的值。 |
3854| NODE_TEXT_AREA_ON_CHANGE_WITH_PREVIEW_TEXT  | 定义在文本内容(包含预上屏内容)改变时,触发回调的枚举值。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_TextChangeEvent](_ark_u_i___text_change_event.md)。<br/>[ArkUI_TextChangeEvent](_ark_u_i___text_change_event.md)中包含3个参数:<br/>**[ArkUI_TextChangeEvent.pStr](_ark_u_i___text_change_event.md#pstr)**:输入的文本内容。<br/>**[ArkUI_TextChangeEvent.pExtendStr](_ark_u_i___text_change_event.md#pextendstr)**:预上屏输入的文本内容。<br/>**[ArkUI_TextChangeEvent.number](_ark_u_i___text_change_event.md#number)**:预上屏文本插入的位置。<br/>**起始版本:** 15 |
3855| NODE_CHECKBOX_EVENT_ON_CHANGE  | 定义ARKUI_NODE_CHECKBOX当选中状态发生变化时,触发该回调。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**1:表示已选中, 0: 表示未选中 |
3856| NODE_DATE_PICKER_EVENT_ON_DATE_CHANGE  | 定义ARKUI_NODE_DATE_PICKER列表组件的滚动触摸事件枚举值。<br/>触发该事件的条件:选择日期时触发该事件。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含3个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**:表示选中时间的年。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32**:表示选中时间的月,取值范围:[0-11]。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[2].i32**:表示选中时间的天。 |
3857| NODE_TIME_PICKER_EVENT_ON_CHANGE  | 定义ARKUI_NODE_TIME_PICKER列表组件的滚动触摸事件枚举值。<br/>触发该事件的条件:选择时间时触发该事件。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含2个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**:表示选中时间的时,取值范围:[0-23]。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32**:表示选中时间的分,取值范围:[0-59]。 |
3858| NODE_TEXT_PICKER_EVENT_ON_CHANGE  | 定义ARKUI_NODE_TEXT_PICKER列表组件的滚动触摸事件枚举值。<br/>触发该事件的条件 :选择文本时触发该事件。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含1个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0...11].i32**表示选中数据的维度。 |
3859| NODE_TEXT_PICKER_EVENT_ON_SCROLL_STOP  | 定义ARKUI_NODE_TEXT_PICKER列表组件的滚动触摸事件枚举值。<br/>触发该事件的条件 :滑动选择文本项停止时触发该事件。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含1个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0...11].i32**表示选中数据的维度。 |
3860| NODE_CALENDAR_PICKER_EVENT_ON_CHANGE  | 定义NODE_CALENDAR_PICKER选中日期时触发的事件。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>**ArkUI_NodeComponent.data[0].u32**选中的年。<br/>**ArkUI_NodeComponent.data[1].u32**选中的月。<br/>**ArkUI_NodeComponent.data[2].u32**选中的日。 |
3861| NODE_SLIDER_EVENT_ON_CHANGE  | 定义ARKUI_NODE_SLIDER拖动或点击时触发事件回调。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含2个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].f32**:当前滑动进度值。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32**:事件触发的相关状态值 |
3862| NODE_RADIO_EVENT_ON_CHANGE  | 定义ARKUI_NODE_RADIO拖动或点击时触发事件回调。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含1个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**:单选框的状态。 |
3863| NODE_CHECKBOX_GROUP_EVENT_ON_CHANGE  | 定义ARKUI_NODE_CHECKBOX_GROUP的选中状态或群组内的Checkbox的选中状态发生变化时,触发回调。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md)。<br/>[ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md)中包含一个参数:<br/>**[ArkUI_StringAsyncEvent.pStr](_ark_u_i___string_async_event.md#pstr)**:<br/>Name: 被选中的checkbox的名字。<br/>Status: <b>0</b>表示群组多选择框全部选择; <b>1</b>群组多选择框部分选择; <b>2</b>群组多选择框全部没有选择。<br/>起始版本:15 |
3864| NODE_IMAGE_ANIMATOR_EVENT_ON_START  | 定义帧动画开始的状态回调。<br/>触发该事件的条件:<br/>1、帧动画开始播放时。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中不包含参数。 |
3865| NODE_IMAGE_ANIMATOR_EVENT_ON_PAUSE  | 定义帧动画播放暂停时的状态回调。<br/>触发该事件的条件:<br/>1、帧动画暂停播放时。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中不包含参数。 |
3866| NODE_IMAGE_ANIMATOR_EVENT_ON_REPEAT  | 定义帧动画c重复播放时的状态回调。<br/>触发该事件的条件:<br/>1、帧动画重复播放时。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中不包含参数。 |
3867| NODE_IMAGE_ANIMATOR_EVENT_ON_CANCEL  | 定义帧动画返回最初状态时的状态回调。<br/>触发该事件的条件:<br/>1、帧动画返回最初状态时。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中不包含参数。 |
3868| NODE_IMAGE_ANIMATOR_EVENT_ON_FINISH  | 定义帧动画播放完成时或者停止播放时的状态回调。<br/>触发该事件的条件:<br/>1、帧动画播放完成时或停止播放时。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中不包含参数。 |
3869| NODE_SWIPER_EVENT_ON_CHANGE  | 定义ARKUI_NODE_SWIPER当前元素索引变化时触发事件回调。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含1个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**:表示当前显示元素的索引。 |
3870| NODE_SWIPER_EVENT_ON_ANIMATION_START  | 定义ARKUI_NODE_SWIPER切换动画开始时触发回调。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含5个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**:表示当前显示元素的索引。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32**:表示切换动画目标元素的索引。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[2].f32**:表示主轴方向上当前显示元素相对Swiper起始位置的位移。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[3].f32**:表示主轴方向上目标元素相对Swiper起始位置的位移。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[4].f32**:表示离手速度。 |
3871| NODE_SWIPER_EVENT_ON_ANIMATION_END  | 定义ARKUI_NODE_SWIPER切换动画结束是触发回调。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含2个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**:表示当前显示元素的索引。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].f32**:表示主轴方向上当前显示元素相对Swiper起始位置的位移。 |
3872| NODE_SWIPER_EVENT_ON_GESTURE_SWIPE  | 定义ARKUI_NODE_SWIPER在页面跟手滑动过程中,逐帧触发该回调。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含2个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**:表示当前显示元素的索引。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].f32**:表示主轴方向上当前显示元素相对Swiper起始位置的位移。 |
3873| NODE_SWIPER_EVENT_ON_CONTENT_DID_SCROLL  | 定义ARKUI_NODE_SWIPER监听Swiper页面滑动事件。 使用说明 :<br/>1、设置[ArkUI_SwiperDisplayModeType](#arkui_swiperdisplaymodetype)属性为ARKUI_SWIPER_DISPLAY_MODE_AUTO_LINEAR时,该接口不生效。<br/>2、循环场景下,设置prevMargin和nextMargin属性,使得Swiper前后端显示同一页面时,该接口不生效。<br/>3、在页面滑动过程中,会对视窗内所有页面逐帧触发ContentDidScrollCallback回调。<br/>例如,当视窗内有下标为0、1的两个页面时,会每帧触发两次index值分别为0和1的回调。<br/>4、设置displayCount属性的swipeByGroup参数为true时,若同组中至少有一个页面在视窗内时,<br/>则会对同组中所有页面触发回调。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含4个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**:Swiper组件的索引,和onChange事件中的index值变化保持一致。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32**:视窗内某个页面的索引。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[2].f32**:页面相对于Swiper主轴起始位置(selectedIndex对应页面的起始位置)的移动比例。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[3].f32**:主轴方向上页面的长度。 |
3874| NODE_SWIPER_EVENT_ON_SELECTED  | 定义当ARKUI_NODE_SWIPER选中元素改变时触发回调。<br/>触发该事件的条件 :<br/>1、滑动离手时满足翻页阈值,开始切换动画时。 <br/>2、通过NODE_SWIPER_INDEX或NODE_SWIPER_SWIPE_TO_INDEX切换页面时。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含1个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**:表示当前选中元素的索引。<br/>**起始版本:** 18 |
3875| NODE_SWIPER_EVENT_ON_UNSELECTED  | 定义当ARKUI_NODE_SWIPER选中元素改变时触发回调。<br/>触发该事件的条件 :<br/>1、滑动离手时满足翻页阈值,开始切换动画时。 <br/>2、通过NODE_SWIPER_INDEX或NODE_SWIPER_SWIPE_TO_INDEX切换页面时。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含1个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**:表示将要隐藏元素的索引。<br/>**起始版本:** 18 |
3876| NODE_SWIPER_EVENT_ON_CONTENT_WILL_SCROLL<sup>15+</sup>  | 定义ARKUI_NODE_SWIPER滑动行为拦截事件。 使用说明 :<br/>1、触发该事件的场景仅限于手势操作,具体包括手指滑动、滚动鼠标滚轮以及使用键盘方向键进行焦点移动。<br/>2、在手指滑动的过程中,每帧都将触发该事件,系统会依据事件的返回值判断是否对每帧的滑动做出响应。<br/>3、对于滚动鼠标滚轮和使用键盘方向键进行焦点移动的场景,每次翻页操作都会触发一次该事件,翻页是否被允许将根据事件的返回值来决定。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含3个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**:当前页面对应的index。在一次跟手滑动过程中,只要手指未离开屏幕,该值将保持不变,即使该页面已完全移出视窗,如在涉及多个页面的场景中。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32**:滑动方向上即将显示的页面index。。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[2].f32**:此次滑动的位移,带有符号,正负分别指示不同的翻页方向。正数表示从index=1向index=0翻页,负数表示从index=0向index=1翻页。<br>在手指滑动的场景中,该值为滑动事件中每帧传递下来的偏移量。在滚动鼠标滚轮和使用键盘方向键导航的场景中,该值代表即将翻页的距离。 <br/>**[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)**中包含1个返回值:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**:事件处理函数中可将是否允许本次滑动的值存于data[0].i32中,Swiper将根据返回值决定本次滑动是否响应。|
3877| NODE_SCROLL_EVENT_ON_SCROLL  | 定义滚动容器组件的滚动事件枚举值。<br/>触发该事件的条件 :<br/>1、滚动组件触发滚动时触发,支持键鼠操作等其他触发滚动的输入设置。<br/>2、通过滚动控制器API接口调用。<br/>3、越界回弹。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含2个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].f32**:表示距离上一次事件触发的X轴增量。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].f32**:表示距离上一次事件触发的Y轴增量。 |
3878| NODE_SCROLL_EVENT_ON_SCROLL_FRAME_BEGIN  | 定义滚动容器组件的滚动帧始事件枚举值。<br/>触发该事件的条件 :<br/>1、滚动组件触发滚动时触发,包括键鼠操作等其他触发滚动的输入设置。<br/>2、调用控制器接口时不触发。<br/>3、越界回弹不触发。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含2个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].f32**:表示即将发生的滚动量。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32**:表示当前滚动状态。<br/>**[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)**中包含1个返回值:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].f32**:事件处理函数中可根据应用场景计算实际需要的滚动量并存于data[0].f32中,Scroll将按照返回值的实际滚动量进行滚动。 |
3879| NODE_SCROLL_EVENT_ON_WILL_SCROLL  | 定义滚动容器组件的滑动前触发事件枚举值。<br/>触发该事件的条件 :<br/>1、滚动组件触发滚动时触发,支持键鼠操作等其他触发滚动的输入设置。<br/>2、通过滚动控制器API接口调用。<br/>3、越界回弹。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含4个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].f32**: 每帧滚动的偏移量,内容向左滚动时偏移量为正,向右滚动时偏移量为负,单位vp。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].f32**: 每帧滚动的偏移量,内容向上滚动时偏移量为正,向下滚动时偏移量为负,单位vp。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[2].i32**: 当前滑动状态,参数类型[ArkUI_ScrollState](#arkui_scrollstate)。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[3].i32**: 当前滚动的来源,参数类型[ArkUI_ScrollSource](#arkui_scrollsource)。<br/>返回<br/>不返回或返回一个number,用于设置滚动组件实际的滚动距离。 |
3880| NODE_SCROLL_EVENT_ON_DID_SCROLL  | 定义滚动容器组件的滑动时触发事件枚举值。<br/>触发该事件的条件 :<br/>1、滚动组件触发滚动时触发,支持键鼠操作等其他触发滚动的输入设置。<br/>2、通过滚动控制器API接口调用。<br/>3、越界回弹。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含3个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].f32**: 每帧滚动的偏移量,内容向左滚动时偏移量为正,向右滚动时偏移量为负,单位vp。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].f32**: 每帧滚动的偏移量,内容向上滚动时偏移量为正,向下滚动时偏移量为负,单位vp。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[2].i32**: 当前滑动状态,参数类型[ArkUI_ScrollState](#arkui_scrollstate)。 |
3881| NODE_SCROLL_EVENT_ON_SCROLL_START  | 定义滚动容器组件的滚动开始事件枚举值。<br/>触发该事件的条件 :<br/>1、滚动组件开始滚动时触发,支持键鼠操作等其他触发滚动的输入设置。<br/>2、通过滚动控制器API接口调用后开始,带过渡动效。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中不包含参数。 |
3882| NODE_SCROLL_EVENT_ON_SCROLL_STOP  | 定义滚动容器组件的滚动停止事件枚举值。<br/>触发该事件的条件 :<br/>1、滚动组件触发滚动后停止,支持键鼠操作等其他触发滚动的输入设置。<br/>2、通过滚动控制器API接口调用后停止,带过渡动效。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中不包含参数。 |
3883| NODE_SCROLL_EVENT_ON_SCROLL_EDGE  | 定义滚动容器组件的滚动边缘事件枚举值。<br/>触发该事件的条件 :<br/>1、滚动组件滚动到边缘时触发,支持键鼠操作等其他触发滚动的输入设置。<br/>2、通过滚动控制器API接口调用。<br/>3、越界回弹。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含1个参数。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**表示当前碰到的是上下左右哪个边。 |
3884| NODE_SCROLL_EVENT_ON_REACH_START  | 定义滚动容器组件到达起始位置时触发回调。<br/>触发该事件的条件 :<br/>1、组件到达起始位置时触发。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中不包含参数。 |
3885| NODE_SCROLL_EVENT_ON_REACH_END  | 定义滚动容器组件到底末尾位置时触发回调。<br/>触发该事件的条件 :<br/>1、组件到底末尾位置时触发。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中不包含参数。 |
3886| NODE_LIST_ON_SCROLL_INDEX  | 定义ARKUI_NODE_LIST有子组件划入或划出List显示区域时触发事件枚举值。<br/>触发该事件的条件 :<br/>列表初始化时会触发一次,List显示区域内第一个子组件的索引值或最后一个子组件的索引值有变化时会触发。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含3个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**: List显示区域内第一个子组件的索引值.<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32**: List显示区域内最后一个子组件的索引值.<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[2].i32**: List显示区域内中间位置子组件的索引值. |
3887| NODE_LIST_ON_WILL_SCROLL  | 定义ARKUI_NODE_LIST组件的滑动前触发事件枚举值。<br/>触发该事件的条件 :<br/>1、滚动组件触发滚动时触发,支持键鼠操作等其他触发滚动的输入设置。<br/>2、通过滚动控制器API接口调用。<br/>3、越界回弹。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含3个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].f32**: 每帧滚动的偏移量,list内容向上滚动时偏移量为正,向下滚动时偏移量为负.<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32**: 当前滑动状态,参数类型[ArkUI_ScrollState](#arkui_scrollstate)。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[2].i32**: 当前滚动的来源,参数类型[ArkUI_ScrollSource](#arkui_scrollsource)。<br/>返回<br/>不返回或返回一个number,用于设置滚动组件实际的滚动距离。 |
3888| NODE_LIST_ON_DID_SCROLL  | 定义ARKUI_NODE_LIST组件的滑动时触发事件枚举值。<br/>触发该事件的条件 :<br/>1、滚动组件触发滚动时触发,支持键鼠操作等其他触发滚动的输入设置。<br/>2、通过滚动控制器API接口调用。<br/>3、越界回弹。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含2个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].f32**: 每帧滚动的偏移量,list内容向上滚动时偏移量为正,向下滚动时偏移量为负.<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32**: 当前滑动状态. |
3889| NODE_LIST_ON_SCROLL_VISIBLE_CONTENT_CHANGE | 有子组件划入或划出List显示区域时触发。计算触发条件时,每一个ListItem、ListItemGroup中的header或footer都算一个子组件。List的边缘效果为弹簧效果时,在List划动到边缘继续划动和松手回弹过程不会触发NODE_LIST_ON_SCROLL_VISIBLE_CONTENT_CHANGE事件。<br/>触发该事件的条件 :<br/> 列表初始化时会触发一次,List显示区域内第一个子组件的索引值或最后一个子组件的索引值有变化时会触发。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含6个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**:列表显示区域中第一个子组件的索引。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32**:列表项组中列表显示区域开始的区域,参数类型为[ArkUI_ListItemGroupArea](#arkui_listitemgrouparea)。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[2].i32**:列表显示区域开头的列表项的索引,在ListItemGroup中如果列表显示区域的开头不在列表项上,则值为1。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[3].i32**:列表显示区域中最后一个子组件的索引。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[4].i32**:列表项组中列表显示区域结束的区域,参数类型为[ArkUI_ListItemGroupArea](#arkui_listitemgrouparea)。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[5].i32**:列表显示区域末尾的列表项的索引,在ListItemGroup中如果列表显示区域的末尾不在列表项上,则值为1。 |
3890| NODE_REFRESH_STATE_CHANGE  | 定义ARKUI_NODE_REFRESH刷新状态变更触发该事件。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含1个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**:刷新状态。 |
3891| NODE_REFRESH_ON_REFRESH  | 定义ARKUI_NODE_REFRESH进入刷新状态时触发该事件。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中不包含参数: |
3892| NODE_REFRESH_ON_OFFSET_CHANGE  | 定义ARKUI_NODE_REFRESH下拉距离发生变化时触发该事件。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含1个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].f32**:下拉距离。 |
3893| NODE_ON_WILL_SCROLL  | 定义ARKUI_NODE_WATER_FLOW组件的滑动前触发事件枚举值。<br/>触发该事件的条件 :<br/>1、滚动组件触发滚动时触发,支持键鼠操作等其他触发滚动的输入设置。<br/>2、通过滚动控制器API接口调用。<br/>3、越界回弹。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含3个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].f32**: 每帧滚动的偏移量,内容向上滚动时偏移量为正,向下滚动时偏移量为负.<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32**: 当前滑动状态,参数类型[ArkUI_ScrollState](#arkui_scrollstate)。<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[2].i32**: 当前滚动的来源,参数类型[ArkUI_ScrollSource](#arkui_scrollsource)。<br/>返回<br/>不返回或返回一个number,用于设置滚动组件实际的滚动距离。 |
3894| NODE_WATER_FLOW_ON_DID_SCROLL  | 定义ARKUI_NODE_WATER_FLOW组件的滑动时触发事件枚举值。<br/>触发该事件的条件 :<br/>1、滚动组件触发滚动时触发,支持键鼠操作等其他触发滚动的输入设置。<br/>2、通过滚动控制器API接口调用。<br/>3、越界回弹。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含2个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].f32**: 每帧滚动的偏移量,内容向上滚动时偏移量为正,向下滚动时偏移量为负.<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32**: 当前滑动状态. |
3895| NODE_WATER_FLOW_ON_SCROLL_INDEX  | 定义ARKUI_NODE_WATER_FLOW当前瀑布流显示的起始位置/终止位置的子组件发生变化时触发事件枚举值。<br/>触发该事件的条件 :<br/>瀑布流显示区域上第一个子组件/最后一个组件的索引值有变化就会触发。<br/>事件回调发生时,事件参数[ArkUI_NodeEvent](#arkui_nodeevent-12)对象中的联合体类型为[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)。<br/>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md)中包含3个参数:<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**: 当前显示的WaterFlow起始位置的索引值.<br/>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32**: 当前显示的瀑布流终止位置的索引值. |
3896
3897
3898### ArkUI_NodeType
3899
3900```
3901enum ArkUI_NodeType
3902```
3903**描述:**
3904
3905提供ArkUI在Native侧可创建组件类型。
3906
3907**起始版本:** 12
3908
3909| 枚举值 | 描述 |
3910| -------- | -------- |
3911| ARKUI_NODE_CUSTOM  | 自定义节点。  |
3912| ARKUI_NODE_TEXT  | 文本。  |
3913| ARKUI_NODE_SPAN  | 文本段落。  |
3914| ARKUI_NODE_IMAGE_SPAN  | 文本图片段落。  |
3915| ARKUI_NODE_IMAGE  | 图片。  |
3916| ARKUI_NODE_TOGGLE  | 状态开关。  |
3917| ARKUI_NODE_LOADING_PROGRESS  | 等待图标。  |
3918| ARKUI_NODE_TEXT_INPUT  | 单行文本输入。  |
3919| ARKUI_NODE_TEXT_AREA  | 多行文本。  |
3920| ARKUI_NODE_BUTTON  | 按钮。  |
3921| ARKUI_NODE_PROGRESS  | 进度条。  |
3922| ARKUI_NODE_CHECKBOX  | 复选框。  |
3923| ARKUI_NODE_XCOMPONENT  | SURFACE类型XComponent。  |
3924| ARKUI_NODE_DATE_PICKER  | 日期选择器组件。  |
3925| ARKUI_NODE_TIME_PICKER  | 时间选择组件。  |
3926| ARKUI_NODE_TEXT_PICKER  | 滑动选择文本内容的组件。  |
3927| ARKUI_NODE_CALENDAR_PICKER  | 日历选择器组件。  |
3928| ARKUI_NODE_SLIDER  | 滑动条组件  |
3929| ARKUI_NODE_RADIO  | 单选框  |
3930| ARKUI_NODE_IMAGE_ANIMATOR  | 帧动画组件  |
3931| ARKUI_NODE_XCOMPONENT_TEXTURE  | TEXTURE类型XComponent。 <br> **起始版本:** 16  |
3932| ARKUI_NODE_CHECKBOX_GROUP | 复选框组。 |
3933| ARKUI_NODE_STACK  | 堆叠容器。  |
3934| ARKUI_NODE_SWIPER  | 翻页容器。  |
3935| ARKUI_NODE_SCROLL  | 滚动容器。  |
3936| ARKUI_NODE_LIST  | 列表。  |
3937| ARKUI_NODE_LIST_ITEM  | 列表项。  |
3938| ARKUI_NODE_LIST_ITEM_GROUP  | 列表item分组。  |
3939| ARKUI_NODE_COLUMN  | 垂直布局容器。  |
3940| ARKUI_NODE_ROW  | 水平布局容器。  |
3941| ARKUI_NODE_FLEX  | 弹性布局容器。  |
3942| ARKUI_NODE_REFRESH  | 刷新组件。  |
3943| ARKUI_NODE_WATER_FLOW  | 瀑布流容器。  |
3944| ARKUI_NODE_FLOW_ITEM  | 瀑布流子组件。  |
3945| ARKUI_NODE_RELATIVE_CONTAINER  | 相对布局组件。  |
3946| ARKUI_NODE_GRID  | 网格容器。  |
3947| ARKUI_NODE_GRID_ITEM  | 网格子组件。  |
3948| ARKUI_NODE_CUSTOM_SPAN  | 自定义文本段落。  |
3949
3950
3951### ArkUI_ObjectFit
3952
3953```
3954enum ArkUI_ObjectFit
3955```
3956**描述:**
3957
3958定义image填充效果。 ImageSpanAlignment
3959
3960**起始版本:** 12
3961
3962| 枚举值 | 描述 |
3963| -------- | -------- |
3964| ARKUI_OBJECT_FIT_CONTAIN  | 保持宽高比进行缩小或者放大,使得图片完全显示在显示边界内。  |
3965| ARKUI_OBJECT_FIT_COVER  | 保持宽高比进行缩小或者放大,使得图片两边都大于或等于显示边界。  |
3966| ARKUI_OBJECT_FIT_AUTO  | 自适应显示。  |
3967| ARKUI_OBJECT_FIT_FILL  | 不保持宽高比进行放大缩小,使得图片充满显示边界。  |
3968| ARKUI_OBJECT_FIT_SCALE_DOWN  | 保持宽高比显示,图片缩小或者保持不变。  |
3969| ARKUI_OBJECT_FIT_NONE  | 保持原有尺寸显示。  |
3970| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_TOP_START  | 图片大小不变,在image组件中顶部起始端对齐。  |
3971| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_TOP  | 图片大小不变,在image组件中顶部横向居中对齐。  |
3972| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_TOP_END  | 图片大小不变,在image组件中顶部尾端对齐。  |
3973| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_START  | 图片大小不变,在image组件中起始端纵向居中对齐。  |
3974| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_CENTER  | 图片大小不变,在image组件中横向和纵向居中对齐。  |
3975| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_END  | 图片大小不变,在image组件中尾端纵向居中对齐。  |
3976| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_BOTTOM_START  | 图片大小不变,在image组件中底部起始端对齐。  |
3977| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_BOTTOM  | 图片大小不变,在image组件中底部横向居中对齐。  |
3978| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_BOTTOM_END  | 图片大小不变,在image组件中底部尾端对齐。  |
3979
3980
3981### ArkUI_PageFlipMode
3982
3983```
3984enum ArkUI_PageFlipMode
3985```
3986**描述:**
3987
3988Swiper组件鼠标滚轮翻页模式。
3989
3990**起始版本:** 15
3991
3992| 枚举值 | 描述 |
3993| -------- | -------- |
3994| ARKUI_PAGE_FLIP_MODE_CONTINUOUS  | 鼠标滚轮连续滚动时翻多页,根据鼠标事件上报次数确定。  |
3995| ARKUI_PAGE_FLIP_MODE_SINGLE  | 一次翻页动画结束前不响应其他鼠标滚轮事件。  |
3996
3997
3998### ArkUI_SwiperAnimationMode
3999
4000```
4001enum ArkUI_SwiperAnimationMode
4002```
4003**描述:**
4004
4005Swiper组件跳转到目标index的动画模式。
4006
4007**起始版本:** 15
4008
4009| 枚举值 | 描述 |
4010| -------- | -------- |
4011| ARKUI_SWIPER_NO_ANIMATION  | 无动画跳转到目标index。  |
4012| ARKUI_SWIPER_DEFAULT_ANIMATION  | 做动画跳转到目标index。  |
4013| ARKUI_SWIPER_FAST_ANIMATION  | 先无动画跳转到目标附近再做动画跳转到目标index。  |
4014
4015
4016### ArkUI_PreDragStatus
4017
4018```
4019enum ArkUI_PreDragStatus
4020```
4021**描述:**
4022
4023定义拖拽发起前的长按交互阶段的变化状态。
4024
4025**起始版本:** 12
4026
4027| 枚举值 | 描述 |
4028| -------- | -------- |
4029| ARKUI_PRE_DRAG_STATUS_UNKNOWN  | Unknown。  |
4030| ARKUI_PRE_DRAG_STATUS_ACTION_DETECTING  | 拖拽手势启动阶段。  |
4031| ARKUI_PRE_DRAG_STATUS_READY_TO_TRIGGER_DRAG  | 拖拽准备完成,可发起拖拽阶段。  |
4032| ARKUI_PRE_DRAG_STATUS_PREVIEW_LIFT_STARTED  | 拖拽浮起动效发起阶段。  |
4033| ARKUI_PRE_DRAG_STATUS_PREVIEW_LIFT_FINISHED  | 拖拽浮起动效结束阶段。  |
4034| ARKUI_PRE_DRAG_STATUS_PREVIEW_LANDING_STARTED  | 拖拽落回动效发起阶段。  |
4035| ARKUI_PRE_DRAG_STATUS_PREVIEW_LANDING_FINISHED  | 拖拽落回动效结束阶段。  |
4036| ARKUI_PRE_DRAG_STATUS_CANCELED_BEFORE_DRAG  | 拖拽浮起落位动效中断。  |
4037
4038
4039### ArkUI_ProgressType
4040
4041```
4042enum ArkUI_ProgressType
4043```
4044**描述:**
4045
4046定义进度条类型枚举值。
4047
4048**起始版本:** 12
4049
4050| 枚举值 | 描述 |
4051| -------- | -------- |
4052| ARKUI_PROGRESS_TYPE_LINEAR  | 线性样式。  |
4053| ARKUI_PROGRESS_TYPE_RING  | 环形无刻度样式。  |
4054| ARKUI_PROGRESS_TYPE_ECLIPSE  | 圆形样式。  |
4055| ARKUI_PROGRESS_TYPE_SCALE_RING  | 唤醒有刻度样式。  |
4056| ARKUI_PROGRESS_TYPE_CAPSULE  | 胶囊样式。  |
4057
4058
4059### ArkUI_RelativeLayoutChainStyle
4060
4061```
4062enum ArkUI_RelativeLayoutChainStyle
4063```
4064**描述:**
4065
4066定义链的风格。
4067
4068**起始版本:** 12
4069
4070| 枚举值 | 描述 |
4071| -------- | -------- |
4072| ARKUI_RELATIVE_LAYOUT_CHAIN_STYLE_SPREAD  | 组件在约束锚点间均匀分布。  |
4073| ARKUI_RELATIVE_LAYOUT_CHAIN_STYLE_SPREAD_INSIDE  | 除首尾2个子组件的其他组件在约束锚点间均匀分布。  |
4074| ARKUI_RELATIVE_LAYOUT_CHAIN_STYLE_PACKED  | 链内子组件无间隙。  |
4075
4076
4077### ArkUI_RenderFit
4078
4079```
4080enum ArkUI_RenderFit
4081```
4082
4083**描述:**
4084
4085定义动画终态内容的状态。
4086
4087| 枚举值 | 描述 |
4088| -------- | -------- |
4089| ARKUI_RENDER_FIT_CENTER  | 保持动画终态的内容大小,并且内容始终与组件保持中心对齐。  |
4090| ARKUI_RENDER_FIT_TOP  | 保持动画终态的内容大小,并且内容始终与组件保持顶部中心对齐。  |
4091| ARKUI_RENDER_FIT_BOTTOM  | 保持动画终态的内容大小,并且内容始终与组件保持底部中心对齐。  |
4092| ARKUI_RENDER_FIT_LEFT  | 保持动画终态的内容大小,并且内容始终与组件保持左侧对齐。  |
4093| ARKUI_RENDER_FIT_RIGHT  | 保持动画终态的内容大小,并且内容始终与组件保持右侧对齐。  |
4094| ARKUI_RENDER_FIT_TOP_LEFT  | 保持动画终态的内容大小,并且内容始终与组件保持左上角对齐。  |
4095| ARKUI_RENDER_FIT_TOP_RIGHT  | 保持动画终态的内容大小,并且内容始终与组件保持右上角对齐。  |
4096| ARKUI_RENDER_FIT_BOTTOM_LEFT  | 保持动画终态的内容大小,并且内容始终与组件保持左下角对齐。  |
4097| ARKUI_RENDER_FIT_BOTTOM_RIGHT  | 保持动画终态的内容大小,并且内容始终与组件保持右下角对齐。  |
4098| ARKUI_RENDER_FIT_RESIZE_FILL  | 不考虑动画终态内容的宽高比,并且内容始终缩放到组件的大小。  |
4099| ARKUI_RENDER_FIT_RESIZE_CONTAIN  | 保持动画终态内容的宽高比进行缩小或放大,使内容完整显示在组件内,且与组件保持中心对齐。  |
4100| ARKUI_RENDER_FIT_RESIZE_CONTAIN_TOP_LEFT  | 保持动画终态内容的宽高比进行缩小或放大,使内容完整显示在组件内。当组件宽方向有剩余时,内容与组件保持左侧对齐,当组件高方向有剩余时,内容与组件保持顶部对齐。  |
4101| ARKUI_RENDER_FIT_RESIZE_CONTAIN_BOTTOM_RIGHT  | 保持动画终态内容的宽高比进行缩小或放大,使内容完整显示在组件内。当组件宽方向有剩余时,内容与组件保持右侧对齐,当组件高方向有剩余时,内容与组件保持底部对齐。  |
4102| ARKUI_RENDER_FIT_RESIZE_COVER  | 保持动画终态内容的宽高比进行缩小或放大,使内容两边都大于或等于组件两边,且与组件保持中心对齐,显示内容的中间部分。  |
4103| ARKUI_RENDER_FIT_RESIZE_COVER_TOP_LEFT  | 保持动画终态内容的宽高比进行缩小或放大,使内容的两边都恰好大于或等于组件两边。当内容宽方向有剩余时,内容与组件保持左侧对齐,显示内容的左侧部分。当内容高方向有剩余时,内容与组件保持顶部对齐,显示内容的顶侧部分。  |
4104| ARKUI_RENDER_FIT_RESIZE_COVER_BOTTOM_RIGHT  | 保持动画终态内容的宽高比进行缩小或放大,使内容的两边都恰好大于或等于组件两边。当内容宽方向有剩余时,内容与组件保持右侧对齐,显示内容的右侧部分。当内容高方向有剩余时,内容与组件保持底部对齐,显示内容的底侧部分。  |
4105
4106
4107### ArkUI_RouterPageState
4108
4109```
4110enum ArkUI_RouterPageState
4111```
4112**描述:**
4113
4114定义Router Page的状态。
4115
4116**起始版本:** 12
4117
4118| 枚举值 | 描述 |
4119| -------- | -------- |
4120| ARKUI_ROUTER_PAGE_STATE_ABOUT_TO_APPEAR  | Router Page即将创建。  |
4121| ARKUI_ROUTER_PAGE_STATE_ABOUT_TO_DISAPPEAR  | Router Page即将销毁。  |
4122| ARKUI_ROUTER_PAGE_STATE_ON_SHOW  | Router Page显示。  |
4123| ARKUI_ROUTER_PAGE_STATE_ON_HIDE  | Router Page隐藏。  |
4124| ARKUI_ROUTER_PAGE_STATE_ON_BACK_PRESS  | Router Page返回时。  |
4125
4126
4127### ArkUI_SafeAreaEdge
4128
4129```
4130enum ArkUI_SafeAreaEdge
4131```
4132**描述:**
4133
4134定义扩展安全区域的方向的枚举值。
4135
4136**起始版本:** 12
4137
4138| 枚举值 | 描述 |
4139| -------- | -------- |
4140| ARKUI_SAFE_AREA_EDGE_TOP  | 上方区域。  |
4141| ARKUI_SAFE_AREA_EDGE_BOTTOM  | 下方区域。  |
4142| ARKUI_SAFE_AREA_EDGE_START  | 前部区域。  |
4143| ARKUI_SAFE_AREA_EDGE_END  | 尾部区域。  |
4144
4145
4146### ArkUI_SafeAreaType
4147
4148```
4149enum ArkUI_SafeAreaType
4150```
4151**描述:**
4152
4153定义扩展安全区域的枚举值。
4154
4155**起始版本:** 12
4156
4157| 枚举值 | 描述 |
4158| -------- | -------- |
4159| ARKUI_SAFE_AREA_TYPE_SYSTEM  | 系统默认非安全区域,包括状态栏、导航栏。  |
4160| ARKUI_SAFE_AREA_TYPE_CUTOUT  | 设备的非安全区域,例如刘海屏或挖孔屏区域。  |
4161| ARKUI_SAFE_AREA_TYPE_KEYBOARD  | 软键盘区域。  |
4162
4163
4164### ArkUI_ListItemGroupArea
4165
4166```
4167enum ArkUI_ListItemGroupArea
4168```
4169**描述:**
4170
4171定义组件区域的枚举值。
4172
4173**起始版本:** 15
4174
4175| 枚举值 | 描述 |
4176| -------- | -------- |
4177| ARKUI_LIST_ITEM_GROUP_AREA_OUTSIDE   | 组件的区域之外。  |
4178| ARKUI_LIST_ITEM_SWIPE_AREA_NONE  | 组件没有页眉、页脚或列表项时的区域。  |
4179| ARKUI_LIST_ITEM_SWIPE_AREA_ITEM  | 组件的列表项区域。  |
4180| ARKUI_LIST_ITEM_SWIPE_AREA_HEADER  | 组件的标题区域。  |
4181| ARKUI_LIST_ITEM_SWIPE_AREA_FOOTER  | 组件的页脚区域。  |
4182
4183
4184### ArkUI_FocusMove
4185
4186```
4187enum ArkUI_FocusMove
4188```
4189**描述:**
4190
4191定义自定义走焦的按键的枚举值。
4192
4193**起始版本:** 18
4194
4195| 枚举值 | 描述 |
4196| -------- | -------- |
4197| ARKUI_FOCUS_MOVE_FORWARD  | Tab按键。  |
4198| ARKUI_FOCUS_MOVE_BACKWARD  | Shift+Tab按键。  |
4199| ARKUI_FOCUS_MOVE_UP  | 方向上键。  |
4200| ARKUI_FOCUS_MOVE_DOWN  | 方向下键。  |
4201| ARKUI_FOCUS_MOVE_LEFT  | 方向左键。  |
4202| ARKUI_FOCUS_MOVE_RIGHT  | 方向右键。  |
4203
4204### ArkUI_ScrollAlignment
4205
4206```
4207enum ArkUI_ScrollAlignment
4208```
4209**描述:**
4210
4211滚动到具体item时的对齐方式。
4212
4213**起始版本:** 12
4214
4215| 枚举值 | 描述 |
4216| -------- | -------- |
4217| ARKUI_SCROLL_ALIGNMENT_START  | 首部对齐。指定item首部与容器首部对齐。  |
4218| ARKUI_SCROLL_ALIGNMENT_CENTER  | 居中对齐。指定item主轴方向居中对齐于容器。  |
4219| ARKUI_SCROLL_ALIGNMENT_END  | 尾部对齐。指定item尾部与容器尾部对齐。  |
4220| ARKUI_SCROLL_ALIGNMENT_AUTO  | 自动对齐。若指定item完全处于显示区,不做调整。否则依照滑动距离最短的原则,将指定item首部对齐或尾部对齐于容器,使指定item完全处于显示区。  |
4221
4222
4223### ArkUI_ScrollBarDisplayMode
4224
4225```
4226enum ArkUI_ScrollBarDisplayMode
4227```
4228**描述:**
4229
4230定义滚动条状态枚举值。
4231
4232**起始版本:** 12
4233
4234| 枚举值 | 描述 |
4235| -------- | -------- |
4236| ARKUI_SCROLL_BAR_DISPLAY_MODE_OFF  | 不显示。  |
4237| ARKUI_SCROLL_BAR_DISPLAY_MODE_AUTO  | 按需显示(触摸时显示,2s后消失)。  |
4238| ARKUI_SCROLL_BAR_DISPLAY_MODE_ON  | 常驻显示。  |
4239
4240
4241### ArkUI_ScrollDirection
4242
4243```
4244enum ArkUI_ScrollDirection
4245```
4246**描述:**
4247
4248定义Scroll组件排列方向枚举值。
4249
4250**起始版本:** 12
4251
4252| 枚举值 | 描述 |
4253| -------- | -------- |
4254| ARKUI_SCROLL_DIRECTION_VERTICAL  | 仅支持竖直方向滚动。  |
4255| ARKUI_SCROLL_DIRECTION_HORIZONTAL  | 仅支持水平方向滚动。  |
4256| ARKUI_SCROLL_DIRECTION_NONE  | 禁止滚动。  |
4257
4258
4259### ArkUI_ScrollEdge
4260
4261```
4262enum ArkUI_ScrollEdge
4263```
4264**描述:**
4265
4266定义滚动到的边缘位置。
4267
4268**起始版本:** 12
4269
4270| 枚举值 | 描述 |
4271| -------- | -------- |
4272| ARKUI_SCROLL_EDGE_TOP  | 竖直方向上边缘。  |
4273| ARKUI_SCROLL_EDGE_BOTTOM  | 竖直方向下边缘。  |
4274| ARKUI_SCROLL_EDGE_START  | 水平方向起始位置。  |
4275| ARKUI_SCROLL_EDGE_END  | 水平方向末尾位置。  |
4276
4277
4278### ArkUI_ScrollNestedMode
4279
4280```
4281enum ArkUI_ScrollNestedMode
4282```
4283**描述:**
4284
4285定义嵌套滚动选项。
4286
4287**起始版本:** 12
4288
4289| 枚举值 | 描述 |
4290| -------- | -------- |
4291| ARKUI_SCROLL_NESTED_MODE_SELF_ONLY  | 只自身滚动,不与父组件联动。  |
4292| ARKUI_SCROLL_NESTED_MODE_SELF_FIRST  | 自身先滚动,自身滚动到边缘以后父组件滚动。父组件滚动到边缘以后 如果父组件有边缘效果,则父组件触发边缘效果,否则子组件触发边缘效果。  |
4293| ARKUI_SCROLL_NESTED_MODE_PARENT_FIRST  | 父组件先滚动,父组件滚动到边缘以后自身滚动。 身滚动到边缘后,如果有边缘效果,会触发自身的边缘效果,否则触发父组件的边缘效果。  |
4294| ARKUI_SCROLL_NESTED_MODE_PARALLEL  | 自身和父组件同时滚动,自身和父组件都到达边缘以后 如果自身有边缘效果,则自身触发边缘效果,否则父组件触发边缘效果。  |
4295
4296
4297### ArkUI_ScrollSnapAlign
4298
4299```
4300enum ArkUI_ScrollSnapAlign
4301```
4302**描述:**
4303
4304定义列表项滚动结束对齐效果枚举值。
4305
4306**起始版本:** 12
4307
4308| 枚举值 | 描述 |
4309| -------- | -------- |
4310| ARKUI_SCROLL_SNAP_ALIGN_NONE  | 默认无项目滚动对齐效果。  |
4311| ARKUI_SCROLL_SNAP_ALIGN_START  | 视图中的第一项将在列表的开头对齐。  |
4312| ARKUI_SCROLL_SNAP_ALIGN_CENTER  | 视图中的中间项将在列表中心对齐。  |
4313| ARKUI_SCROLL_SNAP_ALIGN_END  | 视图中的最后一项将在列表末尾对齐。  |
4314
4315
4316### ArkUI_ScrollSource
4317
4318```
4319enum ArkUI_ScrollSource
4320```
4321**描述:**
4322
4323定义滚动来源枚举值。
4324
4325**起始版本:** 12
4326
4327| 枚举值 | 描述 |
4328| -------- | -------- |
4329| ARKUI_SCROLL_SOURCE_DRAG  | 手指拖动。  |
4330| ARKUI_SCROLL_SOURCE_FLING  | 手指拖动后的惯性滚动。  |
4331| ARKUI_SCROLL_SOURCE_EDGE_EFFECT  | 在过界时执行EdgeEffect.Spring边缘特效。  |
4332| ARKUI_SCROLL_SOURCE_OTHER_USER_INPUT  | 除了拖动以外的其他用户输入,如鼠标滚轮、键盘事件等。  |
4333| ARKUI_SCROLL_SOURCE_SCROLL_BAR  | 拖动滚动条。  |
4334| ARKUI_SCROLL_SOURCE_SCROLL_BAR_FLING  | 拖动滚动条后的惯性滚动。  |
4335| ARKUI_SCROLL_SOURCE_SCROLLER  | 滚动控制器引起的无动画的滚动。  |
4336| ARKUI_SCROLL_SOURCE_ANIMATION  | 滚动控制器引起的带动画的滚动。  |
4337
4338
4339### ArkUI_ScrollState
4340
4341```
4342enum ArkUI_ScrollState
4343```
4344**描述:**
4345
4346定义当前滚动状态。
4347
4348**起始版本:** 12
4349
4350| 枚举值 | 描述 |
4351| -------- | -------- |
4352| ARKUI_SCROLL_STATE_IDLE  | 空闲状态。使用控制器提供的方法控制滚动时触发,拖动滚动条滚动时触发。  |
4353| ARKUI_SCROLL_STATE_SCROLL  | 滚动状态。使用手指拖动容器滚动时触发。  |
4354| ARKUI_SCROLL_STATE_FLING  | 惯性滚动状态。快速划动松手后进行惯性滚动和划动到边缘回弹时触发。  |
4355
4356
4357### ArkUI_ShadowStyle
4358
4359```
4360enum ArkUI_ShadowStyle
4361```
4362**描述:**
4363
4364阴影效果枚举值。
4365
4366**起始版本:** 12
4367
4368| 枚举值 | 描述 |
4369| -------- | -------- |
4370| ARKUI_SHADOW_STYLE_OUTER_DEFAULT_XS  | 超小阴影。  |
4371| ARKUI_SHADOW_STYLE_OUTER_DEFAULT_SM  | 小阴影。  |
4372| ARKUI_SHADOW_STYLE_OUTER_DEFAULT_MD  | 中阴影。  |
4373| ARKUI_SHADOW_STYLE_OUTER_DEFAULT_LG  | 大阴影。  |
4374| ARKUI_SHADOW_STYLE_OUTER_FLOATING_SM  | 浮动小阴影。  |
4375| ARKUI_SHADOW_STYLE_OUTER_FLOATING_MD  | 浮动中阴影。  |
4376
4377
4378### ArkUI_ShadowType
4379
4380```
4381enum ArkUI_ShadowType
4382```
4383**描述:**
4384
4385定义阴影类型枚举值。
4386
4387**起始版本:** 12
4388
4389| 枚举值 | 描述 |
4390| -------- | -------- |
4391| ARKUI_SHADOW_TYPE_COLOR  | 颜色。  |
4392| ARKUI_SHADOW_TYPE_BLUR  | 模糊。  |
4393
4394### ArkUI_ShapeType
4395
4396```
4397enum ArkUI_ShapeType
4398```
4399**描述:**
4400
4401自定义形状。
4402
4403**起始版本:** 12
4404
4405| 枚举值 | 描述 |
4406| -------- | -------- |
4407| ARKUI_SHAPE_TYPE_RECTANGLE  | 矩形类型。  |
4408| ARKUI_SHAPE_TYPE_CIRCLE  | 圆形类型。  |
4409| ARKUI_SHAPE_TYPE_ELLIPSE  | 椭圆形类型。  |
4410| ARKUI_SHAPE_TYPE_PATH  | 路径类型。  |
4411
4412
4413### ArkUI_SliderBlockStyle
4414
4415```
4416enum ArkUI_SliderBlockStyle
4417```
4418**描述:**
4419
4420定义滑块形状。
4421
4422**起始版本:** 12
4423
4424| 枚举值 | 描述 |
4425| -------- | -------- |
4426| ARKUI_SLIDER_BLOCK_STYLE_DEFAULT  | 使用默认滑块(圆形)。  |
4427| ARKUI_SLIDER_BLOCK_STYLE_IMAGE  | 使用图片资源作为滑块。  |
4428| ARKUI_SLIDER_BLOCK_STYLE_SHAPE  | 使用自定义形状作为滑块。  |
4429
4430
4431### ArkUI_SliderDirection
4432
4433```
4434enum ArkUI_SliderDirection
4435```
4436**描述:**
4437
4438定义滑动条滑动方向。
4439
4440**起始版本:** 12
4441
4442| 枚举值 | 描述 |
4443| -------- | -------- |
4444| ARKUI_SLIDER_DIRECTION_VERTICAL  | 方向为纵向。  |
4445| ARKUI_SLIDER_DIRECTION_HORIZONTAL  | 方向为横向。  |
4446
4447
4448### ArkUI_SliderStyle
4449
4450```
4451enum ArkUI_SliderStyle
4452```
4453**描述:**
4454
4455定义滑块与滑轨显示样式。
4456
4457**起始版本:** 12
4458
4459| 枚举值 | 描述 |
4460| -------- | -------- |
4461| ARKUI_SLIDER_STYLE_OUT_SET  | 滑块在滑轨上。  |
4462| ARKUI_SLIDER_STYLE_IN_SET  | 滑块在滑轨内。  |
4463| ARKUI_SLIDER_STYLE_NONE  | 无滑块。  |
4464
4465
4466### ArkUI_StickyStyle
4467
4468```
4469enum ArkUI_StickyStyle
4470```
4471**描述:**
4472
4473定义列表是否吸顶和吸底枚举值。
4474
4475**起始版本:** 12
4476
4477| 枚举值 | 描述 |
4478| -------- | -------- |
4479| ARKUI_STICKY_STYLE_NONE  | ListItemGroup的header不吸顶,footer不吸底。  |
4480| ARKUI_STICKY_STYLE_HEADER  | ListItemGroup的header吸顶,footer不吸底。  |
4481| ARKUI_STICKY_STYLE_FOOTER  | ListItemGroup的footer吸底,header不吸顶。  |
4482| ARKUI_STICKY_STYLE_BOTH  | ListItemGroup的footer吸底,header吸顶。  |
4483
4484
4485### ArkUI_SwiperArrow
4486
4487```
4488enum ArkUI_SwiperArrow
4489```
4490**描述:**
4491
4492Swiper导航点箭头枚举值。
4493
4494**起始版本:** 12
4495
4496| 枚举值 | 描述 |
4497| -------- | -------- |
4498| ARKUI_SWIPER_ARROW_HIDE  | 不显示swiper中导航点箭头。  |
4499| ARKUI_SWIPER_ARROW_SHOW  | 显示swiper中导航点箭头。  |
4500| ARKUI_SWIPER_ARROW_SHOW_ON_HOVER  | 在hover状态下显示swiper中导航点箭头。  |
4501
4502
4503### ArkUI_SwiperDisplayModeType
4504
4505```
4506enum ArkUI_SwiperDisplayModeType
4507```
4508**描述:**
4509
4510定义 Swiper 组件的主轴方向上元素排列的模式。
4511
4512**起始版本:** 12
4513
4514| 枚举值 | 描述 |
4515| -------- | -------- |
4516| ARKUI_SWIPER_DISPLAY_MODE_STRETCH  | Swiper滑动一页的宽度为Swiper组件自身的宽度。  |
4517| ARKUI_SWIPER_DISPLAY_MODE_AUTO_LINEAR  | Swiper滑动一页的宽度为视窗内最左侧子组件的宽度。  |
4518
4519
4520### ArkUI_SwiperIndicatorType
4521
4522```
4523enum ArkUI_SwiperIndicatorType
4524```
4525**描述:**
4526
4527定义 Swiper 组件的导航指示器类型。
4528
4529**起始版本:** 12
4530
4531| 枚举值 | 描述 |
4532| -------- | -------- |
4533| ARKUI_SWIPER_INDICATOR_TYPE_DOT  | 圆点指示器类型。  |
4534| ARKUI_SWIPER_INDICATOR_TYPE_DIGIT  | 数字指示器类型。  |
4535
4536
4537### ArkUI_SwiperNestedScrollMode
4538
4539```
4540enum ArkUI_SwiperNestedScrollMode
4541```
4542**描述:**
4543
4544Swiper组件和父组件的嵌套滚动模式。
4545
4546**起始版本:** 12
4547
4548| 枚举值 | 描述 |
4549| -------- | -------- |
4550| ARKUI_SWIPER_NESTED_SRCOLL_SELF_ONLY  | Swiper只自身滚动,不与父组件联动。  |
4551| ARKUI_SWIPER_NESTED_SRCOLL_SELF_FIRST  | Swiper自身先滚动,自身滚动到边缘以后父组件滚动。父组件滚动到边缘以后,如果父组件有边缘效果,则父组件触发边缘效果,否则Swiper触发边缘效果。  |
4552
4553
4554### ArkUI_SystemColorMode
4555
4556```
4557enum ArkUI_SystemColorMode
4558```
4559**描述:**
4560
4561定义系统深浅色模式。
4562
4563**起始版本:** 12
4564
4565| 枚举值 | 描述 |
4566| -------- | -------- |
4567| ARKUI_SYSTEM_COLOR_MODE_LIGHT  | 浅色模式  |
4568| ARKUI_SYSTEM_COLOR_MODE_DARK  | 深色模式  |
4569
4570
4571### ArkUI_TextAlignment
4572
4573```
4574enum ArkUI_TextAlignment
4575```
4576**描述:**
4577
4578定义字体水平对齐样式枚举值。
4579
4580**起始版本:** 12
4581
4582| 枚举值 | 描述 |
4583| -------- | -------- |
4584| ARKUI_TEXT_ALIGNMENT_START  | 水平对齐首部。  |
4585| ARKUI_TEXT_ALIGNMENT_CENTER  | 水平居中对齐。  |
4586| ARKUI_TEXT_ALIGNMENT_END  | 水平对齐尾部。  |
4587| ARKUI_TEXT_ALIGNMENT_JUSTIFY  | 双端对齐。  |
4588
4589
4590### ArkUI_TextAreaType
4591
4592```
4593enum ArkUI_TextAreaType
4594```
4595**描述:**
4596
4597定义多行文本输入法类型枚举值。
4598
4599**起始版本:** 12
4600
4601| 枚举值 | 描述 |
4602| -------- | -------- |
4603| ARKUI_TEXTAREA_TYPE_NORMAL  | 基本输入模式。  |
4604| ARKUI_TEXTAREA_TYPE_NUMBER  | 纯数字模式。  |
4605| ARKUI_TEXTAREA_TYPE_PHONE_NUMBER  | 电话号码输入模式。  |
4606| ARKUI_TEXTAREA_TYPE_EMAIL  | 邮箱地址输入模式。  |
4607
4608
4609### ArkUI_TextCase
4610
4611```
4612enum ArkUI_TextCase
4613```
4614**描述:**
4615
4616定义文本大小写枚举值。
4617
4618**起始版本:** 12
4619
4620| 枚举值 | 描述 |
4621| -------- | -------- |
4622| ARKUI_TEXT_CASE_NORMAL  | 保持原有大小写。  |
4623| ARKUI_TEXT_CASE_LOWER  | 文本全小写。  |
4624| ARKUI_TEXT_CASE_UPPER  | 文本全大写。  |
4625
4626
4627### ArkUI_TextCopyOptions
4628
4629```
4630enum ArkUI_TextCopyOptions
4631```
4632**描述:**
4633
4634定义组件支持设置文本是否可复制粘贴。
4635
4636**起始版本:** 12
4637
4638| 枚举值 | 描述 |
4639| -------- | -------- |
4640| ARKUI_TEXT_COPY_OPTIONS_NONE  | 不支持复制。  |
4641| ARKUI_TEXT_COPY_OPTIONS_IN_APP  | 支持应用内复制。  |
4642| ARKUI_TEXT_COPY_OPTIONS_LOCAL_DEVICE  | 支持设备内复制。  |
4643| ARKUI_TEXT_COPY_OPTIONS_CROSS_DEVICE  | 支持跨设备复制。  |
4644
4645
4646### ArkUI_TextDataDetectorType
4647
4648```
4649enum ArkUI_TextDataDetectorType
4650```
4651**描述:**
4652
4653定义文本识别的实体类型。
4654
4655**起始版本:** 12
4656
4657| 枚举值 | 描述 |
4658| -------- | -------- |
4659| ARKUI_TEXT_DATA_DETECTOR_TYPE_PHONE_NUMBER  | 电话号码。  |
4660| ARKUI_TEXT_DATA_DETECTOR_TYPE_URL  | 链接。  |
4661| ARKUI_TEXT_DATA_DETECTOR_TYPE_EMAIL  | 邮箱。  |
4662| ARKUI_TEXT_DATA_DETECTOR_TYPE_ADDRESS  | 地址。  |
4663
4664
4665### ArkUI_TextDecorationStyle
4666
4667```
4668enum ArkUI_TextDecorationStyle
4669```
4670**描述:**
4671
4672定义装饰线样式枚举值。
4673
4674**起始版本:** 12
4675
4676| 枚举值 | 描述 |
4677| -------- | -------- |
4678| ARKUI_TEXT_DECORATION_STYLE_SOLID  | 单实线。  |
4679| ARKUI_TEXT_DECORATION_STYLE_DOUBLE  | 双实线。  |
4680| ARKUI_TEXT_DECORATION_STYLE_DOTTED  | 点线。  |
4681| ARKUI_TEXT_DECORATION_STYLE_DASHED  | 虚线。  |
4682| ARKUI_TEXT_DECORATION_STYLE_WAVY  | 波浪线。  |
4683
4684
4685### ArkUI_TextDecorationType
4686
4687```
4688enum ArkUI_TextDecorationType
4689```
4690**描述:**
4691
4692定义装饰线类型枚举值。
4693
4694**起始版本:** 12
4695
4696| 枚举值 | 描述 |
4697| -------- | -------- |
4698| ARKUI_TEXT_DECORATION_TYPE_NONE  | 不使用装饰线。  |
4699| ARKUI_TEXT_DECORATION_TYPE_UNDERLINE  | 文字下划线修饰。  |
4700| ARKUI_TEXT_DECORATION_TYPE_OVERLINE  | 文字上划线修饰。  |
4701| ARKUI_TEXT_DECORATION_TYPE_LINE_THROUGH  | 穿过文本的修饰线。  |
4702
4703
4704### ArkUI_TextHeightAdaptivePolicy
4705
4706```
4707enum ArkUI_TextHeightAdaptivePolicy
4708```
4709**描述:**
4710
4711定义文本自适应高度的方式。
4712
4713**起始版本:** 12
4714
4715| 枚举值 | 描述 |
4716| -------- | -------- |
4717| ARKUI_TEXT_HEIGHT_ADAPTIVE_POLICY_MAX_LINES_FIRST  | 设置文本高度自适应方式为以MaxLines优先。  |
4718| ARKUI_TEXT_HEIGHT_ADAPTIVE_POLICY_MIN_FONT_SIZE_FIRST  | 设置文本高度自适应方式为以缩小字体优先。  |
4719| ARKUI_TEXT_HEIGHT_ADAPTIVE_POLICY_LAYOUT_CONSTRAINT_FIRST  | 设置文本高度自适应方式为以布局约束(高度)优先。  |
4720
4721
4722### ArkUI_TextInputContentType
4723
4724```
4725enum ArkUI_TextInputContentType
4726```
4727**描述:**
4728
4729定义自动填充类型。
4730
4731**起始版本:** 12
4732
4733| 枚举值 | 描述 |
4734| -------- | -------- |
4735| ARKUI_TEXTINPUT_CONTENT_TYPE_USER_NAME  | 【用户名】在已启用密码保险箱的情况下,支持用户名的自动保存和自动填充。  |
4736| ARKUI_TEXTINPUT_CONTENT_TYPE_PASSWORD  | 【密码】在已启用密码保险箱的情况下,支持密码的自动保存和自动填充。  |
4737| ARKUI_TEXTINPUT_CONTENT_TYPE_NEW_PASSWORD  | 【新密码】在已启用密码保险箱的情况下,支持自动生成新密码。  |
4738| ARKUI_TEXTINPUT_CONTENT_TYPE_FULL_STREET_ADDRESS  | 【详细地址】在已启用情景化自动填充的情况下,支持详细地址的自动保存和自动填充。  |
4739| ARKUI_TEXTINPUT_CONTENT_TYPE_HOUSE_NUMBER  | 【门牌号】在已启用情景化自动填充的情况下,支持门牌号的自动保存和自动填充。  |
4740| ARKUI_TEXTINPUT_CONTENT_TYPE_DISTRICT_ADDRESS  | 【区/县】在已启用情景化自动填充的情况下,支持区/县的自动保存和自动填充。  |
4741| ARKUI_TEXTINPUT_CONTENT_TYPE_CITY_ADDRESS  | 【市】在已启用情景化自动填充的情况下,支持市的自动保存和自动填充。  |
4742| ARKUI_TEXTINPUT_CONTENT_TYPE_PROVINCE_ADDRESS  | 【省】在已启用情景化自动填充的情况下,支持省的自动保存和自动填充。  |
4743| ARKUI_TEXTINPUT_CONTENT_TYPE_COUNTRY_ADDRESS  | 【国家】在已启用情景化自动填充的情况下,支持国家的自动保存和自动填充。  |
4744| ARKUI_TEXTINPUT_CONTENT_TYPE_PERSON_FULL_NAME  | 【姓名】在已启用情景化自动填充的情况下,支持姓名的自动保存和自动填充。  |
4745| ARKUI_TEXTINPUT_CONTENT_TYPE_PERSON_LAST_NAME  | 【姓氏】在已启用情景化自动填充的情况下,支持姓氏的自动保存和自动填充。  |
4746| ARKUI_TEXTINPUT_CONTENT_TYPE_PERSON_FIRST_NAME  | 【名字】在已启用情景化自动填充的情况下,支持名字的自动保存和自动填充。  |
4747| ARKUI_TEXTINPUT_CONTENT_TYPE_PHONE_NUMBER  | 【手机号】在已启用情景化自动填充的情况下,支持手机号的自动保存和自动填充。  |
4748| ARKUI_TEXTINPUT_CONTENT_TYPE_PHONE_COUNTRY_CODE  | 【国家代码】在已启用情景化自动填充的情况下,支持国家代码的自动保存和自动填充。  |
4749| ARKUI_TEXTINPUT_CONTENT_TYPE_FULL_PHONE_NUMBER  | 【包含国家代码的手机号】在已启用情景化自动填充的情况下,支持包含国家代码的手机号的自动保存和自动填充。  |
4750| ARKUI_TEXTINPUT_CONTENT_EMAIL_ADDRESS  | 【邮箱地址】在已启用情景化自动填充的情况下,支持邮箱地址的自动保存和自动填充。  |
4751| ARKUI_TEXTINPUT_CONTENT_TYPE_BANK_CARD_NUMBER  | 【银行卡号】在已启用情景化自动填充的情况下,支持银行卡号的自动保存和自动填充。  |
4752| ARKUI_TEXTINPUT_CONTENT_TYPE_ID_CARD_NUMBER  | 【身份证号】在已启用情景化自动填充的情况下,支持身份证号的自动保存和自动填充。  |
4753| ARKUI_TEXTINPUT_CONTENT_TYPE_NICKNAME  | 【昵称】在已启用情景化自动填充的情况下,支持昵称的自动保存和自动填充。  |
4754| ARKUI_TEXTINPUT_CONTENT_TYPE_DETAIL_INFO_WITHOUT_STREET  | 【无街道地址】在已启用情景化自动填充的情况下,支持无街道地址的自动保存和自动填充。  |
4755| ARKUI_TEXTINPUT_CONTENT_TYPE_FORMAT_ADDRESS  | 【标准地址】在已启用情景化自动填充的情况下,支持标准地址的自动保存和自动填充。  |
4756| ARKUI_TEXTINPUT_CONTENT_TYPE_PASSPORT_NUMBER  | 【护照号】在已启用情景化自动填充的情况下,支持护照号的自动保存和自动填充。<br/>起始版本:18  |
4757| ARKUI_TEXTINPUT_CONTENT_TYPE_VALIDITY  | 【护照有效期】在已启用情景化自动填充的情况下,支持护照有效期的自动保存和自动填充。<br/>起始版本:18  |
4758| ARKUI_TEXTINPUT_CONTENT_TYPE_ISSUE_AT  | 【护照签发地】在已启用情景化自动填充的情况下,支持护照签发地的自动保存和自动填充。<br/>起始版本:18  |
4759| ARKUI_TEXTINPUT_CONTENT_TYPE_ORGANIZATION  | 【发票抬头名称】在已启用情景化自动填充的情况下,支持发票抬头名称的自动保存和自动填充。<br/>起始版本:18  |
4760| ARKUI_TEXTINPUT_CONTENT_TYPE_TAX_ID  | 【税号】在已启用情景化自动填充的情况下,支持税号的自动保存和自动填充。<br/>起始版本:18  |
4761| ARKUI_TEXTINPUT_CONTENT_TYPE_ADDRESS_CITY_AND_STATE  | 【所在地区】在已启用情景化自动填充的情况下,支持所在地区的自动保存和自动填充。<br/>起始版本:18  |
4762| ARKUI_TEXTINPUT_CONTENT_TYPE_FLIGHT_NUMBER  | 【航班号】暂不支持自动保存和自动填充。<br/>起始版本:18  |
4763| ARKUI_TEXTINPUT_CONTENT_TYPE_LICENSE_NUMBER  | 【驾驶证号】暂不支持自动保存和自动填充。<br/>起始版本:18  |
4764| ARKUI_TEXTINPUT_CONTENT_TYPE_LICENSE_FILE_NUMBER  | 【驾驶证档案编号】暂不支持自动保存和自动填充。<br/>起始版本:18 |
4765| ARKUI_TEXTINPUT_CONTENT_TYPE_LICENSE_PLATE  | 【车牌号】在已启用情景化自动填充的情况下,支持车牌号的自动保存和自动填充。<br/>起始版本:18  |
4766| ARKUI_TEXTINPUT_CONTENT_TYPE_ENGINE_NUMBER  | 【行驶证发动机号】暂不支持自动保存和自动填充。<br/>起始版本:18  |
4767| ARKUI_TEXTINPUT_CONTENT_TYPE_LICENSE_CHASSIS_NUMBER  | 【车牌识别号】暂不支持自动保存和自动填充。<br/>起始版本:18  |
4768
4769
4770### ArkUI_TextInputStyle
4771
4772```
4773enum ArkUI_TextInputStyle
4774```
4775**描述:**
4776
4777定义输入框风格。
4778
4779**起始版本:** 12
4780
4781| 枚举值 | 描述 |
4782| -------- | -------- |
4783| ARKUI_TEXTINPUT_STYLE_DEFAULT  | 默认风格,光标宽1.5vp,光标高度与文本选中底板高度和字体大小相关。  |
4784| ARKUI_TEXTINPUT_STYLE_INLINE  | 内联输入风格。文本选中底板高度与输入框高度相同。  |
4785
4786
4787### ArkUI_TextInputType
4788
4789```
4790enum ArkUI_TextInputType
4791```
4792**描述:**
4793
4794定义单行文本输入法类型枚举值。
4795
4796**起始版本:** 12
4797
4798| 枚举值 | 描述 |
4799| -------- | -------- |
4800| ARKUI_TEXTINPUT_TYPE_NORMAL  | 基本输入模式。  |
4801| ARKUI_TEXTINPUT_TYPE_NUMBER  | 纯数字模式。  |
4802| ARKUI_TEXTINPUT_TYPE_PHONE_NUMBER  | 电话号码输入模式。  |
4803| ARKUI_TEXTINPUT_TYPE_EMAIL  | 邮箱地址输入模式。  |
4804| ARKUI_TEXTINPUT_TYPE_PASSWORD  | 密码输入模式。  |
4805| ARKUI_TEXTINPUT_TYPE_NUMBER_PASSWORD  | 纯数字密码输入模式。  |
4806| ARKUI_TEXTINPUT_TYPE_SCREEN_LOCK_PASSWORD  | 锁屏应用密码输入模式。  |
4807| ARKUI_TEXTINPUT_TYPE_USER_NAME  | 用户名输入模式。  |
4808| ARKUI_TEXTINPUT_TYPE_NEW_PASSWORD  | 新密码输入模式。  |
4809| ARKUI_TEXTINPUT_TYPE_NUMBER_DECIMAL  | 带小数点的数字输入模式。  |
4810
4811
4812### ArkUI_TextOverflow
4813
4814```
4815enum ArkUI_TextOverflow
4816```
4817**描述:**
4818
4819定义文本超长时的显示方式。
4820
4821**起始版本:** 12
4822
4823| 枚举值 | 描述 |
4824| -------- | -------- |
4825| ARKUI_TEXT_OVERFLOW_NONE  | 文本超长时不裁剪显示。  |
4826| ARKUI_TEXT_OVERFLOW_CLIP  | 文本超长时进行裁剪显示。  |
4827| ARKUI_TEXT_OVERFLOW_ELLIPSIS  | 文本超长时显示不下的文本用省略号代替。  |
4828| ARKUI_TEXT_OVERFLOW_MARQUEE  | 文本超长时以跑马灯的方式展示。  |
4829
4830
4831### ArkUI_TextPickerRangeType
4832
4833```
4834enum ArkUI_TextPickerRangeType
4835```
4836**描述:**
4837
4838定义滑动选择文本选择器输入类型。
4839
4840**起始版本:** 12
4841
4842| 枚举值 | 描述 |
4843| -------- | -------- |
4844| ARKUI_TEXTPICKER_RANGETYPE_SINGLE  | 单列数据选择器。  |
4845| ARKUI_TEXTPICKER_RANGETYPE_MULTI  | 多列数据选择器。  |
4846| ARKUI_TEXTPICKER_RANGETYPE_RANGE_CONTENT  | 支持图片资源的单列数据选择器。  |
4847| ARKUI_TEXTPICKER_RANGETYPE_CASCADE_RANGE_CONTENT  | 支持联动的多列数据选择器。  |
4848
4849### ArkUI_TransitionEdge
4850
4851```
4852enum ArkUI_TransitionEdge
4853```
4854**描述:**
4855
4856定义转场从边缘滑入和滑出的效果。
4857
4858**起始版本:** 12
4859
4860| 枚举值 | 描述 |
4861| -------- | -------- |
4862| ARKUI_TRANSITION_EDGE_TOP  | 窗口的上边缘。  |
4863| ARKUI_TRANSITION_EDGE_BOTTOM  | 窗口的下边缘。  |
4864| ARKUI_TRANSITION_EDGE_START  | 窗口的左边缘。  |
4865| ARKUI_TRANSITION_EDGE_END  | 窗口的右边缘。  |
4866
4867
4868### ArkUI_VerticalAlignment
4869
4870```
4871enum ArkUI_VerticalAlignment
4872```
4873**描述:**
4874
4875定义垂直对齐方式。
4876
4877**起始版本:** 12
4878
4879| 枚举值 | 描述 |
4880| -------- | -------- |
4881| ARKUI_VERTICAL_ALIGNMENT_TOP  | 顶部对齐。  |
4882| ARKUI_VERTICAL_ALIGNMENT_CENTER  | 居中对齐,默认对齐方式。  |
4883| ARKUI_VERTICAL_ALIGNMENT_BOTTOM  | 底部对齐。  |
4884
4885
4886### ArkUI_Visibility
4887
4888```
4889enum ArkUI_Visibility
4890```
4891**描述:**
4892
4893控制组件的显隐枚举值。
4894
4895**起始版本:** 12
4896
4897| 枚举值 | 描述 |
4898| -------- | -------- |
4899| ARKUI_VISIBILITY_VISIBLE  | 显示。  |
4900| ARKUI_VISIBILITY_HIDDEN  | 隐藏,但参与布局进行占位。  |
4901| ARKUI_VISIBILITY_NONE  | 隐藏,但不参与布局,不进行占位。  |
4902
4903
4904### ArkUI_WaterFlowLayoutMode
4905
4906```
4907enum ArkUI_WaterFlowLayoutMode
4908```
4909**描述:**
4910
4911定义WaterFlow组件布局模式枚举值。
4912
4913**起始版本:** 18
4914
4915| 枚举值 | 描述 |
4916| -------- | -------- |
4917| ARKUI_WATER_FLOW_LAYOUT_MODE_ALWAYS_TOP_DOWN  | 从上到下布局。列数切换场景需要从第一个FlowItem开始布局到当前显示的FlowItem。  |
4918| ARKUI_WATER_FLOW_LAYOUT_MODE_SLIDING_WINDOW  | 移动窗口布局。列数切换场景只重新布局当前显示范围到FlowItem,手指向下滑动再布局从上方进入显示范围的FlowItem。  |
4919
4920
4921### ArkUI_WordBreak
4922
4923```
4924enum ArkUI_WordBreak
4925```
4926**描述:**
4927
4928定义文本断行规则。
4929
4930**起始版本:** 12
4931
4932| 枚举值 | 描述 |
4933| -------- | -------- |
4934| ARKUI_WORD_BREAK_NORMAL  | CJK(中文、日文、韩文)文本可以在任意2个字符间断行,而Non-CJK文本(如英文等)只能在空白符处断行。  |
4935| ARKUI_WORD_BREAK_BREAK_ALL  | 对于Non-CJK的文本,可在任意2个字符间断行。CJK(中文、日文、韩文)文本可以在任意2个字符间断行。  |
4936| ARKUI_WORD_BREAK_BREAK_WORD  | 对于Non-CJK的文本可在任意2个字符间断行,一行文本中有断行破发点(如空白符)时,优先按破发点换行。 CJK(中文、日文、韩文)文本可以在任意2个字符间断行  |
4937| ARKUI_WORD_BREAK_HYPHENATION  | 对于Non-CJK的文本,可以按照音节断行。对于CJK的文本,换行效果与NORMAL效果保持一致。<br/>起始版本:18  |
4938
4939
4940### ArkUI_XComponentType
4941
4942```
4943enum ArkUI_XComponentType
4944```
4945**描述:**
4946
4947定义XComponent类型枚举值。
4948
4949**起始版本:** 12
4950
4951| 枚举值 | 描述 |
4952| -------- | -------- |
4953| ARKUI_XCOMPONENT_TYPE_SURFACE  | 用于EGL/OpenGLES和媒体数据写入,开发者定制绘制内容单独显示在屏幕上。  |
4954| ARKUI_XCOMPONENT_TYPE_TEXTURE  | 用于EGL/OpenGLES和媒体数据写入,开发者定制绘制内容和XComponent组件内容合成后展示在屏幕上。  |
4955
4956### ArkUI_KeyboardAppearance
4957
4958```
4959enum ArkUI_KeyboardAppearance
4960```
4961**描述:**
4962
4963定义输入框拉起的键盘样式。
4964
4965**起始版本:** 15
4966
4967| 枚举值 | 描述 |
4968| -------- | -------- |
4969| ARKUI_KEYBOARD_APPEARANCE_NONE_IMMERSIVE   | 默认模式,不使用沉浸式样式。  |
4970| ARKUI_KEYBOARD_APPEARANCE_IMMERSIVE   | 沉浸式模式,由系统决定采用的样式。  |
4971| ARKUI_KEYBOARD_APPEARANCE_LIGHT_IMMERSIVE   | 浅色沉浸式样式。  |
4972| ARKUI_KEYBOARD_APPEARANCE_DARK_IMMERSIVE   | 深色沉浸式样式。  |
4973
4974### ArkUI_KeyboardAvoidMode
4975
4976```
4977enum ArkUI_KeyboardAvoidMode
4978```
4979**描述:**
4980
4981设置弹窗避让键盘模式。
4982
4983**起始版本:** 15
4984
4985| 枚举值 | 描述 |
4986| -------- | -------- |
4987| ARKUI_KEYBOARD_AVOID_MODE_DEFAULT   | 默认避让软键盘并在到达极限高度之后进行高度压缩。  |
4988| ARKUI_KEYBOARD_AVOID_MODE_NONE   | 不避让软键盘。  |
4989
4990### ArkUI_HoverModeAreaType
4991
4992```
4993enum ArkUI_HoverModeAreaType
4994```
4995**描述:**
4996
4997设置悬停态下弹窗默认展示区域。
4998
4999**起始版本:** 15
5000
5001| 枚举值 | 描述 |
5002| -------- | -------- |
5003| ARKUI_HOVER_MODE_AREA_TYPE_TOP   | 上半屏。  |
5004| ARKUI_HOVER_MODE_AREA_TYPE_BOTTOM   | 下半屏。  |
5005
5006### ArkUI_ExpandMode
5007
5008```
5009enum ArkUI_ExpandMode
5010```
5011**描述:**
5012
5013定义子节点展开模式枚举值。
5014
5015**起始版本:** 15
5016
5017| 枚举值 | 描述 |
5018| -------- | -------- |
5019| ARKUI_NOT_EXPAND   | 不展开。  |
5020| ARKUI_EXPAND   | 展开。  |
5021| ARKUI_LAZY_EXPAND   | 懒展开,按需展开当前节点的子节点。  |
5022
5023## 函数说明
5024
5025
5026### OH_ArkUI_AccessibilityState_Create()
5027
5028```
5029ArkUI_AccessibilityState* OH_ArkUI_AccessibilityState_Create (void )
5030```
5031**描述:**
5032
5033创建无障碍状态。
5034
5035**起始版本:** 12
5036
5037**返回:**
5038
5039无障碍状态对象指针。如果对象返回空指针,表示创建失败,失败的可能原因是应用地址空间满。
5040
5041
5042### OH_ArkUI_AccessibilityState_Dispose()
5043
5044```
5045void OH_ArkUI_AccessibilityState_Dispose (ArkUI_AccessibilityState * state)
5046```
5047**描述:**
5048
5049销毁无障碍状态指针。
5050
5051**起始版本:** 12
5052
5053**参数:**
5054
5055| 名称 | 描述 |
5056| -------- | -------- |
5057| state | 无障碍状态对象指针。  |
5058
5059
5060### OH_ArkUI_AccessibilityState_GetCheckedState()
5061
5062```
5063int32_t OH_ArkUI_AccessibilityState_GetCheckedState (ArkUI_AccessibilityState * state)
5064```
5065**描述:**
5066
5067获取无障碍状态复选框状态。
5068
5069**起始版本:** 12
5070
5071**参数:**
5072
5073| 名称 | 描述 |
5074| -------- | -------- |
5075| state | 无障碍状态对象指针。  |
5076
5077**返回:**
5078
5079复选框状态,参数类型[ArkUI_AccessibilityCheckedState](#arkui_accessibilitycheckedstate), 默认值:ARKUI_ACCESSIBILITY_UNCHECKED; 若函数参数异常,返回默认值。
5080
5081
5082### OH_ArkUI_AccessibilityState_IsDisabled()
5083
5084```
5085int32_t OH_ArkUI_AccessibilityState_IsDisabled (ArkUI_AccessibilityState * state)
5086```
5087**描述:**
5088
5089获取无障碍状态是否禁用。
5090
5091**起始版本:** 12
5092
5093**参数:**
5094
5095| 名称 | 描述 |
5096| -------- | -------- |
5097| state | 无障碍状态对象指针。  |
5098
5099**返回:**
5100
5101是否禁用, 1表示禁用,0表示未禁用,默认为0; 若state为空,返回默认值。
5102
5103
5104### OH_ArkUI_AccessibilityState_IsSelected()
5105
5106```
5107int32_t OH_ArkUI_AccessibilityState_IsSelected (ArkUI_AccessibilityState * state)
5108```
5109**描述:**
5110
5111获取无障碍状态是否选中。
5112
5113**起始版本:** 12
5114
5115**参数:**
5116
5117| 名称 | 描述 |
5118| -------- | -------- |
5119| state | 无障碍状态对象指针。  |
5120
5121**返回:**
5122
5123是否被选中, 1表示选中,0表示未选中,默认为0; 若state为空,返回默认值。
5124
5125
5126### OH_ArkUI_AccessibilityState_SetCheckedState()
5127
5128```
5129void OH_ArkUI_AccessibilityState_SetCheckedState (ArkUI_AccessibilityState * state, int32_t checkedState )
5130```
5131**描述:**
5132
5133设置无障碍状态复选框状态。
5134
5135**起始版本:** 12
5136
5137**参数:**
5138
5139| 名称 | 描述 |
5140| -------- | -------- |
5141| state | 无障碍状态对象指针。  |
5142| checkedState | 复选框状态,参数类型[ArkUI_AccessibilityCheckedState](#arkui_accessibilitycheckedstate), 默认值:ARKUI_ACCESSIBILITY_UNCHECKED。  |
5143
5144
5145### OH_ArkUI_AccessibilityState_SetDisabled()
5146
5147```
5148void OH_ArkUI_AccessibilityState_SetDisabled (ArkUI_AccessibilityState * state, int32_t isDisabled )
5149```
5150**描述:**
5151
5152设置无障碍状态是否禁用。
5153
5154**起始版本:** 12
5155
5156**参数:**
5157
5158| 名称 | 描述 |
5159| -------- | -------- |
5160| state | 无障碍状态对象指针。  |
5161| isDisabled | 无障碍状态是否禁用, 1表示禁用,0表示不禁用,默认为0。  |
5162
5163
5164### OH_ArkUI_AccessibilityState_SetSelected()
5165
5166```
5167void OH_ArkUI_AccessibilityState_SetSelected (ArkUI_AccessibilityState * state, int32_t isSelected )
5168```
5169**描述:**
5170
5171设置无障碍状态是否选中。
5172
5173**起始版本:** 12
5174
5175**参数:**
5176
5177| 名称 | 描述 |
5178| -------- | -------- |
5179| state | 无障碍状态对象指针。  |
5180| isSelected | 是否被选中, 1表示选中,0表示未选中,默认为0。  |
5181
5182
5183### OH_ArkUI_AccessibilityValue_Create()
5184
5185```
5186ArkUI_AccessibilityValue* OH_ArkUI_AccessibilityValue_Create (void )
5187```
5188**描述:**
5189
5190创建无障碍信息。
5191
5192**起始版本:** 12
5193
5194**返回:**
5195
5196无障碍信息对象指针。
5197
5198
5199### OH_ArkUI_AccessibilityValue_Dispose()
5200
5201```
5202void OH_ArkUI_AccessibilityValue_Dispose (ArkUI_AccessibilityValue * value)
5203```
5204**描述:**
5205
5206销毁无障碍信息指针。
5207
5208**起始版本:** 12
5209
5210**参数:**
5211
5212| 名称 | 描述 |
5213| -------- | -------- |
5214| state | 无障碍信息对象指针。  |
5215
5216
5217### OH_ArkUI_AccessibilityValue_GetCurrent()
5218
5219```
5220int32_t OH_ArkUI_AccessibilityValue_GetCurrent (ArkUI_AccessibilityValue * value)
5221```
5222**描述:**
5223
5224获取无障碍当前值信息。
5225
5226**起始版本:** 12
5227
5228**参数:**
5229
5230| 名称 | 描述 |
5231| -------- | -------- |
5232| value | 无障碍信息对象指针。  |
5233
5234**返回:**
5235
5236基于范围组件的当前值, 默认为-1; 若函数参数异常,返回-1。
5237
5238
5239### OH_ArkUI_AccessibilityValue_GetMax()
5240
5241```
5242int32_t OH_ArkUI_AccessibilityValue_GetMax (ArkUI_AccessibilityValue * value)
5243```
5244**描述:**
5245
5246获取无障碍最大值信息。
5247
5248**起始版本:** 12
5249
5250**参数:**
5251
5252| 名称 | 描述 |
5253| -------- | -------- |
5254| value | 无障碍信息对象指针。  |
5255
5256**返回:**
5257
5258基于范围组件的最大值, 默认为-1; 若函数参数异常,返回-1。
5259
5260
5261### OH_ArkUI_AccessibilityValue_GetMin()
5262
5263```
5264int32_t OH_ArkUI_AccessibilityValue_GetMin (ArkUI_AccessibilityValue * value)
5265```
5266**描述:**
5267
5268获取无障碍最小值信息。
5269
5270**起始版本:** 12
5271
5272**参数:**
5273
5274| 名称 | 描述 |
5275| -------- | -------- |
5276| value | 无障碍信息对象指针。  |
5277
5278**返回:**
5279
5280基于范围组件的最小值, 默认为-1; 若函数参数异常,返回-1。
5281
5282
5283### OH_ArkUI_AccessibilityValue_GetText()
5284
5285```
5286const char* OH_ArkUI_AccessibilityValue_GetText (ArkUI_AccessibilityValue * value)
5287```
5288**描述:**
5289
5290获取无障碍文本描述信息。
5291
5292**起始版本:** 12
5293
5294**参数:**
5295
5296| 名称 | 描述 |
5297| -------- | -------- |
5298| value | 无障碍信息对象指针。  |
5299
5300**返回:**
5301
5302组件的文本描述信息, 默认为空字符串; 若函数参数异常,返回空指针。
5303
5304
5305### OH_ArkUI_AccessibilityValue_SetCurrent()
5306
5307```
5308void OH_ArkUI_AccessibilityValue_SetCurrent (ArkUI_AccessibilityValue * value, int32_t current )
5309```
5310**描述:**
5311
5312设置无障碍当前值信息。
5313
5314**起始版本:** 12
5315
5316**参数:**
5317
5318| 名称 | 描述 |
5319| -------- | -------- |
5320| value | 无障碍信息对象指针。  |
5321| current | 基于范围组件的当前值, 默认为-1。  |
5322
5323
5324### OH_ArkUI_AccessibilityValue_SetMax()
5325
5326```
5327void OH_ArkUI_AccessibilityValue_SetMax (ArkUI_AccessibilityValue * value, int32_t max )
5328```
5329**描述:**
5330
5331设置无障碍最大值信息。
5332
5333**起始版本:** 12
5334
5335**参数:**
5336
5337| 名称 | 描述 |
5338| -------- | -------- |
5339| value | 无障碍信息对象指针。  |
5340| max | 基于范围组件的最大值, 默认为-1。  |
5341
5342
5343### OH_ArkUI_AccessibilityValue_SetMin()
5344
5345```
5346void OH_ArkUI_AccessibilityValue_SetMin (ArkUI_AccessibilityValue * value, int32_t min )
5347```
5348**描述:**
5349
5350设置无障碍最小值信息。
5351
5352**起始版本:** 12
5353
5354**参数:**
5355
5356| 名称 | 描述 |
5357| -------- | -------- |
5358| value | 无障碍信息对象指针。  |
5359| min | 基于范围组件的最小值, 默认为-1。  |
5360
5361
5362### OH_ArkUI_AccessibilityValue_SetText()
5363
5364```
5365void OH_ArkUI_AccessibilityValue_SetText (ArkUI_AccessibilityValue * value, const char * text )
5366```
5367**描述:**
5368
5369设置无障碍文本描述信息。
5370
5371**起始版本:** 12
5372
5373**参数:**
5374
5375| 名称 | 描述 |
5376| -------- | -------- |
5377| value | 无障碍信息对象指针。  |
5378| text | 组件的文本描述信息, 默认为空字符串。  |
5379
5380
5381### OH_ArkUI_ActiveChildrenInfo_Destroy()
5382
5383```
5384void OH_ArkUI_ActiveChildrenInfo_Destroy (ArkUI_ActiveChildrenInfo * handle)
5385```
5386**描述:**
5387
5388销毁ActiveChildrenInfo实例。
5389
5390**起始版本:** 14
5391
5392**参数:**
5393
5394| 名称 | 描述 |
5395| -------- | -------- |
5396| handle | 要销毁的ActiveChildrenInfo实例。  |
5397
5398
5399### OH_ArkUI_ActiveChildrenInfo_GetCount()
5400
5401```
5402int32_t OH_ArkUI_ActiveChildrenInfo_GetCount (ArkUI_ActiveChildrenInfo * handle)
5403```
5404**描述:**
5405
5406获取ActiveChildrenInfo结构体内的节点数量。
5407
5408**起始版本:** 14
5409
5410**参数:**
5411
5412| 名称 | 描述 |
5413| -------- | -------- |
5414| handle | 要获取信息的ActiveChildrenInfo实例。  |
5415
5416
5417### OH_ArkUI_ActiveChildrenInfo_GetNodeByIndex()
5418
5419```
5420ArkUI_NodeHandle OH_ArkUI_ActiveChildrenInfo_GetNodeByIndex (ArkUI_ActiveChildrenInfo * handle, int32_t index )
5421```
5422**描述:**
5423
5424获取ActiveChildrenInfo结构体的下标为index的子节点。
5425
5426**起始版本:** 14
5427
5428**参数:**
5429
5430| 名称 | 描述 |
5431| -------- | -------- |
5432| handle | 要获取信息的ActiveChildrenInfo实例。  |
5433
5434
5435### OH_ArkUI_AlignmentRuleOption_Create()
5436
5437```
5438ArkUI_AlignmentRuleOption* OH_ArkUI_AlignmentRuleOption_Create ()
5439```
5440**描述:**
5441
5442创建相对容器中子组件的对齐规则信息。
5443
5444**起始版本:** 12
5445
5446**返回:**
5447
5448对齐规则信息。
5449
5450
5451### OH_ArkUI_AlignmentRuleOption_Dispose()
5452
5453```
5454void OH_ArkUI_AlignmentRuleOption_Dispose (ArkUI_AlignmentRuleOption * option)
5455```
5456**描述:**
5457
5458销毁相对容器中子组件的对齐规则信息。
5459
5460**起始版本:** 12
5461
5462**参数:**
5463
5464| 名称 | 描述 |
5465| -------- | -------- |
5466| option | 相对容器中子组件的对齐规则信息。  |
5467
5468
5469### OH_ArkUI_AlignmentRuleOption_GetBiasHorizontal()
5470
5471```
5472float OH_ArkUI_AlignmentRuleOption_GetBiasHorizontal (ArkUI_AlignmentRuleOption * option)
5473```
5474**描述:**
5475
5476获取水平方向上的bias值。
5477
5478**起始版本:** 12
5479
5480**参数:**
5481
5482| 名称 | 描述 |
5483| -------- | -------- |
5484| option | 相对容器中子组件的对齐规则信息。  |
5485
5486**返回:**
5487
5488水平方向上的bias值。
5489
5490
5491### OH_ArkUI_AlignmentRuleOption_GetBiasVertical()
5492
5493```
5494float OH_ArkUI_AlignmentRuleOption_GetBiasVertical (ArkUI_AlignmentRuleOption * option)
5495```
5496**描述:**
5497
5498获取垂直方向上的bias值。
5499
5500**起始版本:** 12
5501
5502**参数:**
5503
5504| 名称 | 描述 |
5505| -------- | -------- |
5506| option | 相对容器中子组件的对齐规则信息。  |
5507
5508**返回:**
5509
5510垂直方向上的bias值。
5511
5512
5513### OH_ArkUI_AlignmentRuleOption_GetBottomAlignment()
5514
5515```
5516ArkUI_VerticalAlignment OH_ArkUI_AlignmentRuleOption_GetBottomAlignment (ArkUI_AlignmentRuleOption * option)
5517```
5518**描述:**
5519
5520获取底部对齐的参数。
5521
5522**起始版本:** 12
5523
5524**参数:**
5525
5526| 名称 | 描述 |
5527| -------- | -------- |
5528| option | 相对容器中子组件的对齐规则信息。  |
5529
5530**返回:**
5531
5532底部对齐的参数的对齐方式。
5533
5534
5535### OH_ArkUI_AlignmentRuleOption_GetBottomId()
5536
5537```
5538const char* OH_ArkUI_AlignmentRuleOption_GetBottomId (ArkUI_AlignmentRuleOption * option)
5539```
5540**描述:**
5541
5542获取底部对齐的参数。
5543
5544**起始版本:** 12
5545
5546**参数:**
5547
5548| 名称 | 描述 |
5549| -------- | -------- |
5550| option | 相对容器中子组件的对齐规则信息。  |
5551
5552**返回:**
5553
5554底部对齐的参数的id。
5555
5556
5557### OH_ArkUI_AlignmentRuleOption_GetCenterAlignmentHorizontal()
5558
5559```
5560ArkUI_HorizontalAlignment OH_ArkUI_AlignmentRuleOption_GetCenterAlignmentHorizontal (ArkUI_AlignmentRuleOption * option)
5561```
5562**描述:**
5563
5564获取横向居中对齐方式的参数。
5565
5566**起始版本:** 12
5567
5568**参数:**
5569
5570| 名称 | 描述 |
5571| -------- | -------- |
5572| option | 相对容器中子组件的对齐规则信息。  |
5573
5574**返回:**
5575
5576横向居中对齐方式的参数的对齐方式。
5577
5578
5579### OH_ArkUI_AlignmentRuleOption_GetCenterAlignmentVertical()
5580
5581```
5582ArkUI_VerticalAlignment OH_ArkUI_AlignmentRuleOption_GetCenterAlignmentVertical (ArkUI_AlignmentRuleOption * option)
5583```
5584**描述:**
5585
5586获取纵向居中对齐方式的参数。
5587
5588**起始版本:** 12
5589
5590**参数:**
5591
5592| 名称 | 描述 |
5593| -------- | -------- |
5594| option | 相对容器中子组件的对齐规则信息。  |
5595
5596**返回:**
5597
5598纵向居中对齐方式的参数的对齐方式。
5599
5600
5601### OH_ArkUI_AlignmentRuleOption_GetCenterIdHorizontal()
5602
5603```
5604const char* OH_ArkUI_AlignmentRuleOption_GetCenterIdHorizontal (ArkUI_AlignmentRuleOption * option)
5605```
5606**描述:**
5607
5608获取横向居中对齐方式的参数。
5609
5610**起始版本:** 12
5611
5612**参数:**
5613
5614| 名称 | 描述 |
5615| -------- | -------- |
5616| option | 相对容器中子组件的对齐规则信息。  |
5617
5618**返回:**
5619
5620横向居中对齐方式的参数的id。
5621
5622
5623### OH_ArkUI_AlignmentRuleOption_GetCenterIdVertical()
5624
5625```
5626const char* OH_ArkUI_AlignmentRuleOption_GetCenterIdVertical (ArkUI_AlignmentRuleOption * option)
5627```
5628**描述:**
5629
5630获取纵向居中对齐方式的参数。
5631
5632**起始版本:** 12
5633
5634**参数:**
5635
5636| 名称 | 描述 |
5637| -------- | -------- |
5638| option | 相对容器中子组件的对齐规则信息。  |
5639
5640**返回:**
5641
5642纵向居中对齐方式的参数的id。
5643
5644
5645### OH_ArkUI_AlignmentRuleOption_GetEndAlignment()
5646
5647```
5648ArkUI_HorizontalAlignment OH_ArkUI_AlignmentRuleOption_GetEndAlignment (ArkUI_AlignmentRuleOption * option)
5649```
5650**描述:**
5651
5652获取右对齐参数。
5653
5654**起始版本:** 12
5655
5656**参数:**
5657
5658| 名称 | 描述 |
5659| -------- | -------- |
5660| option | 相对容器中子组件的对齐规则信息。  |
5661
5662**返回:**
5663
5664右对齐参数的对齐方式。
5665
5666
5667### OH_ArkUI_AlignmentRuleOption_GetEndId()
5668
5669```
5670const char* OH_ArkUI_AlignmentRuleOption_GetEndId (ArkUI_AlignmentRuleOption * option)
5671```
5672**描述:**
5673
5674获取右对齐参数。
5675
5676**起始版本:** 12
5677
5678**参数:**
5679
5680| 名称 | 描述 |
5681| -------- | -------- |
5682| option | 相对容器中子组件的对齐规则信息。  |
5683
5684**返回:**
5685
5686右对齐参数id。
5687
5688
5689### OH_ArkUI_AlignmentRuleOption_GetStartAlignment()
5690
5691```
5692ArkUI_HorizontalAlignment OH_ArkUI_AlignmentRuleOption_GetStartAlignment (ArkUI_AlignmentRuleOption * option)
5693```
5694**描述:**
5695
5696获取左对齐参数的对齐方式。
5697
5698**起始版本:** 12
5699
5700**参数:**
5701
5702| 名称 | 描述 |
5703| -------- | -------- |
5704| option | 相对容器中子组件的对齐规则信息。  |
5705
5706**返回:**
5707
5708参数的对齐方式。
5709
5710
5711### OH_ArkUI_AlignmentRuleOption_GetStartId()
5712
5713```
5714const char* OH_ArkUI_AlignmentRuleOption_GetStartId (ArkUI_AlignmentRuleOption * option)
5715```
5716**描述:**
5717
5718获取左对齐参数的Id。
5719
5720**起始版本:** 12
5721
5722**参数:**
5723
5724| 名称 | 描述 |
5725| -------- | -------- |
5726| option | 相对容器中子组件的对齐规则信息。  |
5727
5728**返回:**
5729
5730锚点的组件的id值。
5731
5732
5733### OH_ArkUI_AlignmentRuleOption_GetTopAlignment()
5734
5735```
5736ArkUI_VerticalAlignment OH_ArkUI_AlignmentRuleOption_GetTopAlignment (ArkUI_AlignmentRuleOption * option)
5737```
5738**描述:**
5739
5740获取顶部对齐的参数。
5741
5742**起始版本:** 12
5743
5744**参数:**
5745
5746| 名称 | 描述 |
5747| -------- | -------- |
5748| option | 相对容器中子组件的对齐规则信息。  |
5749
5750**返回:**
5751
5752顶部对齐的参数的对齐方式。
5753
5754
5755### OH_ArkUI_AlignmentRuleOption_GetTopId()
5756
5757```
5758const char* OH_ArkUI_AlignmentRuleOption_GetTopId (ArkUI_AlignmentRuleOption * option)
5759```
5760**描述:**
5761
5762获取顶部对齐的参数。
5763
5764**起始版本:** 12
5765
5766**参数:**
5767
5768| 名称 | 描述 |
5769| -------- | -------- |
5770| option | 相对容器中子组件的对齐规则信息。  |
5771
5772**返回:**
5773
5774顶部对齐的参数id。
5775
5776
5777### OH_ArkUI_AlignmentRuleOption_SetBiasHorizontal()
5778
5779```
5780void OH_ArkUI_AlignmentRuleOption_SetBiasHorizontal (ArkUI_AlignmentRuleOption * option, float horizontal )
5781```
5782**描述:**
5783
5784设置组件在锚点约束下的水平方向上偏移参数。
5785
5786**起始版本:** 12
5787
5788**参数:**
5789
5790| 名称 | 描述 |
5791| -------- | -------- |
5792| option | 相对容器中子组件的对齐规则信息。  |
5793| horizontal | 水平方向上的bias值。  |
5794
5795
5796### OH_ArkUI_AlignmentRuleOption_SetBiasVertical()
5797
5798```
5799void OH_ArkUI_AlignmentRuleOption_SetBiasVertical (ArkUI_AlignmentRuleOption * option, float vertical )
5800```
5801**描述:**
5802
5803设置组件在锚点约束下的垂直方向上偏移参数。
5804
5805**起始版本:** 12
5806
5807**参数:**
5808
5809| 名称 | 描述 |
5810| -------- | -------- |
5811| option | 相对容器中子组件的对齐规则信息。  |
5812| horizontal | 垂直方向上的bias值。  |
5813
5814
5815### OH_ArkUI_AlignmentRuleOption_SetBottom()
5816
5817```
5818void OH_ArkUI_AlignmentRuleOption_SetBottom (ArkUI_AlignmentRuleOption * option, const char * id, ArkUI_VerticalAlignment alignment )
5819```
5820**描述:**
5821
5822设置底部对齐的参数。
5823
5824**起始版本:** 12
5825
5826**参数:**
5827
5828| 名称 | 描述 |
5829| -------- | -------- |
5830| option | 相对容器中子组件的对齐规则信息。  |
5831| id | 锚点的组件的id值。  |
5832| value | 相对于锚点组件的对齐方式。  |
5833
5834
5835### OH_ArkUI_AlignmentRuleOption_SetCenterHorizontal()
5836
5837```
5838void OH_ArkUI_AlignmentRuleOption_SetCenterHorizontal (ArkUI_AlignmentRuleOption * option, const char * id, ArkUI_HorizontalAlignment alignment )
5839```
5840**描述:**
5841
5842设置横向居中对齐方式的参数。
5843
5844**起始版本:** 12
5845
5846**参数:**
5847
5848| 名称 | 描述 |
5849| -------- | -------- |
5850| option | 相对容器中子组件的对齐规则信息。  |
5851| id | 锚点的组件的id值。  |
5852| value | 相对于锚点组件的对齐方式  |
5853
5854
5855### OH_ArkUI_AlignmentRuleOption_SetCenterVertical()
5856
5857```
5858void OH_ArkUI_AlignmentRuleOption_SetCenterVertical (ArkUI_AlignmentRuleOption * option, const char * id, ArkUI_VerticalAlignment alignment )
5859```
5860**描述:**
5861
5862设置纵向居中对齐方式的参数。
5863
5864**起始版本:** 12
5865
5866**参数:**
5867
5868| 名称 | 描述 |
5869| -------- | -------- |
5870| option | 相对容器中子组件的对齐规则信息。  |
5871| id | 锚点的组件的id值。  |
5872| value | 相对于锚点组件的对齐方式。  |
5873
5874
5875### OH_ArkUI_AlignmentRuleOption_SetEnd()
5876
5877```
5878void OH_ArkUI_AlignmentRuleOption_SetEnd (ArkUI_AlignmentRuleOption * option, const char * id, ArkUI_HorizontalAlignment alignment )
5879```
5880**描述:**
5881
5882设置右对齐参数。
5883
5884**起始版本:** 12
5885
5886**参数:**
5887
5888| 名称 | 描述 |
5889| -------- | -------- |
5890| option | 相对容器中子组件的对齐规则信息。  |
5891| id | 锚点的组件的id值。  |
5892| value | 相对于锚点组件的对齐方式。  |
5893
5894
5895### OH_ArkUI_AlignmentRuleOption_SetStart()
5896
5897```
5898void OH_ArkUI_AlignmentRuleOption_SetStart (ArkUI_AlignmentRuleOption * option, const char * id, ArkUI_HorizontalAlignment alignment )
5899```
5900**描述:**
5901
5902设置左对齐参数。
5903
5904**起始版本:** 12
5905
5906**参数:**
5907
5908| 名称 | 描述 |
5909| -------- | -------- |
5910| option | 相对容器中子组件的对齐规则信息。  |
5911| id | 锚点的组件的id值。  |
5912| value | 相对于锚点组件的对齐方式。  |
5913
5914
5915### OH_ArkUI_AlignmentRuleOption_SetTop()
5916
5917```
5918void OH_ArkUI_AlignmentRuleOption_SetTop (ArkUI_AlignmentRuleOption * option, const char * id, ArkUI_VerticalAlignment alignment )
5919```
5920**描述:**
5921
5922设置顶部对齐的参数。
5923
5924**起始版本:** 12
5925
5926**参数:**
5927
5928| 名称 | 描述 |
5929| -------- | -------- |
5930| option | 相对容器中子组件的对齐规则信息。  |
5931| id | 锚点的组件的id值。  |
5932| value | 相对于锚点组件的对齐方式。  |
5933
5934
5935### OH_ArkUI_AllowNodeAllDropDataTypes()
5936
5937```
5938int32_t OH_ArkUI_AllowNodeAllDropDataTypes (ArkUI_NodeHandle node)
5939```
5940**描述:**
5941
5942配置组件允许接受任意数据类型,该接口会重置通过[OH_ArkUI_SetNodeAllowedDropDataTypes](#oh_arkui_setnodealloweddropdatatypes)配置的数据类型。
5943
5944**起始版本:** 12
5945
5946**参数:**
5947
5948| 名称 | 描述 |
5949| -------- | -------- |
5950| node | 组件节点指针。  |
5951
5952**返回:**
5953
5954ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
5955
5956
5957### OH_ArkUI_AnimateOption_Create()
5958
5959```
5960ArkUI_AnimateOption* OH_ArkUI_AnimateOption_Create ()
5961```
5962**描述:**
5963
5964创建动画效果参数。
5965
5966**起始版本:** 12
5967
5968**返回:**
5969
5970新的动画效果参数指针。
5971
5972
5973### OH_ArkUI_AnimateOption_Dispose()
5974
5975```
5976void OH_ArkUI_AnimateOption_Dispose (ArkUI_AnimateOption * option)
5977```
5978**描述:**
5979
5980销毁动画效果参数指针。
5981
5982**起始版本:** 12
5983
5984
5985### OH_ArkUI_AnimateOption_GetCurve()
5986
5987```
5988ArkUI_AnimationCurve OH_ArkUI_AnimateOption_GetCurve (ArkUI_AnimateOption * option)
5989```
5990**描述:**
5991
5992获取动画曲线。
5993
5994**起始版本:** 12
5995
5996**参数:**
5997
5998| 名称 | 描述 |
5999| -------- | -------- |
6000| option | 动画效果参数。  |
6001
6002**返回:**
6003
6004动画曲线。
6005
6006
6007### OH_ArkUI_AnimateOption_GetDelay()
6008
6009```
6010int32_t OH_ArkUI_AnimateOption_GetDelay (ArkUI_AnimateOption * option)
6011```
6012**描述:**
6013
6014获取动画延迟播放时间,单位为ms(毫秒)。
6015
6016**起始版本:** 12
6017
6018**参数:**
6019
6020| 名称 | 描述 |
6021| -------- | -------- |
6022| option | 动画效果参数。  |
6023
6024**返回:**
6025
6026动画延迟播放时间。
6027
6028
6029### OH_ArkUI_AnimateOption_GetDuration()
6030
6031```
6032int32_t OH_ArkUI_AnimateOption_GetDuration (ArkUI_AnimateOption * option)
6033```
6034**描述:**
6035
6036获取动画持续时间,单位为ms(毫秒)。
6037
6038**起始版本:** 12
6039
6040**参数:**
6041
6042| 名称 | 描述 |
6043| -------- | -------- |
6044| option | 动画效果参数。  |
6045
6046**返回:**
6047
6048持续时间。
6049
6050
6051### OH_ArkUI_AnimateOption_GetExpectedFrameRateRange()
6052
6053```
6054ArkUI_ExpectedFrameRateRange* OH_ArkUI_AnimateOption_GetExpectedFrameRateRange (ArkUI_AnimateOption * option)
6055```
6056**描述:**
6057
6058获取动画的期望帧率。
6059
6060**起始版本:** 12
6061
6062**参数:**
6063
6064| 名称 | 描述 |
6065| -------- | -------- |
6066| option | 动画效果参数。  |
6067
6068**返回:**
6069
6070动画的期望帧率。
6071
6072
6073### OH_ArkUI_AnimateOption_GetICurve()
6074
6075```
6076ArkUI_CurveHandle OH_ArkUI_AnimateOption_GetICurve (ArkUI_AnimateOption * option)
6077```
6078**描述:**
6079
6080获取动画的动画曲线。
6081
6082**起始版本:** 12
6083
6084**参数:**
6085
6086| 名称 | 描述 |
6087| -------- | -------- |
6088| option | animator动画参数。  |
6089
6090**返回:**
6091
6092动画的动画曲线。
6093
6094
6095### OH_ArkUI_AnimateOption_GetIterations()
6096
6097```
6098int32_t OH_ArkUI_AnimateOption_GetIterations (ArkUI_AnimateOption * option)
6099```
6100**描述:**
6101
6102获取动画播放次数。
6103
6104**起始版本:** 12
6105
6106**参数:**
6107
6108| 名称 | 描述 |
6109| -------- | -------- |
6110| option | 动画效果参数。  |
6111
6112**返回:**
6113
6114动画播放次数。
6115
6116### OH_ArkUI_AnimateOption_GetPlayMode()
6117
6118```
6119ArkUI_AnimationPlayMode OH_ArkUI_AnimateOption_GetPlayMode (ArkUI_AnimateOption * option)
6120```
6121**描述:**
6122
6123获取动画播放模式。
6124
6125**起始版本:** 12
6126
6127**参数:**
6128
6129| 名称 | 描述 |
6130| -------- | -------- |
6131| option | 动画效果参数。  |
6132
6133**返回:**
6134
6135动画播放模式。
6136
6137
6138### OH_ArkUI_AnimateOption_GetTempo()
6139
6140```
6141float OH_ArkUI_AnimateOption_GetTempo (ArkUI_AnimateOption * option)
6142```
6143**描述:**
6144
6145获取动画播放速度。
6146
6147**起始版本:** 12
6148
6149**参数:**
6150
6151| 名称 | 描述 |
6152| -------- | -------- |
6153| option | 动画效果参数。  |
6154
6155**返回:**
6156
6157动画播放速度。
6158
6159
6160### OH_ArkUI_AnimateOption_SetCurve()
6161
6162```
6163void OH_ArkUI_AnimateOption_SetCurve (ArkUI_AnimateOption * option, ArkUI_AnimationCurve value )
6164```
6165**描述:**
6166
6167设置动画曲线。
6168
6169**起始版本:** 12
6170
6171**参数:**
6172
6173| 名称 | 描述 |
6174| -------- | -------- |
6175| option | 动画效果参数。  |
6176| value | 动画曲线。默认值:ARKUI_CURVE_LINEAR。  |
6177
6178
6179### OH_ArkUI_AnimateOption_SetDelay()
6180
6181```
6182void OH_ArkUI_AnimateOption_SetDelay (ArkUI_AnimateOption * option, int32_t value )
6183```
6184**描述:**
6185
6186设置动画延迟播放时间。
6187
6188**起始版本:** 12
6189
6190**参数:**
6191
6192| 名称 | 描述 |
6193| -------- | -------- |
6194| option | 动画效果参数。  |
6195| value | 动画延迟播放时间。  |
6196
6197
6198### OH_ArkUI_AnimateOption_SetDuration()
6199
6200```
6201void OH_ArkUI_AnimateOption_SetDuration (ArkUI_AnimateOption * option, int32_t value )
6202```
6203**描述:**
6204
6205设置动画持续时间。
6206
6207**起始版本:** 12
6208
6209**参数:**
6210
6211| 名称 | 描述 |
6212| -------- | -------- |
6213| option | 动画效果参数。  |
6214| value | 持续时间,单位为ms(毫秒)。  |
6215
6216
6217### OH_ArkUI_AnimateOption_SetExpectedFrameRateRange()
6218
6219```
6220void OH_ArkUI_AnimateOption_SetExpectedFrameRateRange (ArkUI_AnimateOption * option, ArkUI_ExpectedFrameRateRange * value )
6221```
6222**描述:**
6223
6224设置动画的期望帧率。
6225
6226**起始版本:** 12
6227
6228**参数:**
6229
6230| 名称 | 描述 |
6231| -------- | -------- |
6232| option | 动画效果参数。  |
6233| value | 动画的期望帧率。  |
6234
6235
6236### OH_ArkUI_AnimateOption_SetICurve()
6237
6238```
6239void OH_ArkUI_AnimateOption_SetICurve (ArkUI_AnimateOption * option, ArkUI_CurveHandle value )
6240```
6241**描述:**
6242
6243设置动画的动画曲线。
6244
6245**起始版本:** 12
6246
6247**参数:**
6248
6249| 名称 | 描述 |
6250| -------- | -------- |
6251| option | animator动画参数。  |
6252| value | 动画曲线参数。  |
6253
6254**注解:**
6255
6256此方法优于OH_ArkUI_AnimateOption_SetCurve设置的值。
6257
6258
6259### OH_ArkUI_AnimateOption_SetIterations()
6260
6261```
6262void OH_ArkUI_AnimateOption_SetIterations (ArkUI_AnimateOption * option, int32_t value )
6263```
6264**描述:**
6265
6266设置动画播放次数。
6267
6268**起始版本:** 12
6269
6270**参数:**
6271
6272| 名称 | 描述 |
6273| -------- | -------- |
6274| option | 动画效果参数。  |
6275| value | 动画播放次数。  |
6276
6277
6278### OH_ArkUI_AnimateOption_SetPlayMode()
6279
6280```
6281void OH_ArkUI_AnimateOption_SetPlayMode (ArkUI_AnimateOption * option, ArkUI_AnimationPlayMode value )
6282```
6283**描述:**
6284
6285设置动画播放模式。
6286
6287**起始版本:** 12
6288
6289**参数:**
6290
6291| 名称 | 描述 |
6292| -------- | -------- |
6293| option | 动画效果参数。  |
6294| value | 动画播放模式。  |
6295
6296
6297### OH_ArkUI_AnimateOption_SetTempo()
6298
6299```
6300void OH_ArkUI_AnimateOption_SetTempo (ArkUI_AnimateOption * option, float value )
6301```
6302**描述:**
6303
6304设置动画播放速度。
6305
6306**起始版本:** 12
6307
6308**参数:**
6309
6310| 名称 | 描述 |
6311| -------- | -------- |
6312| option | 动画效果参数。  |
6313| value | 动画播放速度。  |
6314
6315
6316### OH_ArkUI_Animator_Cancel()
6317
6318```
6319int32_t OH_ArkUI_Animator_Cancel (ArkUI_AnimatorHandle animator)
6320```
6321**描述:**
6322
6323取消animator动画。
6324
6325**参数:**
6326
6327| 名称 | 描述 |
6328| -------- | -------- |
6329| animator | animator动画对象。  |
6330
6331**返回:**
6332
6333ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
6334
6335
6336### OH_ArkUI_Animator_Finish()
6337
6338```
6339int32_t OH_ArkUI_Animator_Finish (ArkUI_AnimatorHandle animator)
6340```
6341**描述:**
6342
6343结束animator动画。
6344
6345**参数:**
6346
6347| 名称 | 描述 |
6348| -------- | -------- |
6349| animator | animator动画对象。  |
6350
6351**返回:**
6352
6353ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
6354
6355
6356### OH_ArkUI_Animator_Pause()
6357
6358```
6359int32_t OH_ArkUI_Animator_Pause (ArkUI_AnimatorHandle animator)
6360```
6361**描述:**
6362
6363暂停animator动画。
6364
6365**参数:**
6366
6367| 名称 | 描述 |
6368| -------- | -------- |
6369| animator | animator动画对象。  |
6370
6371**返回:**
6372
6373ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
6374
6375
6376### OH_ArkUI_Animator_Play()
6377
6378```
6379int32_t OH_ArkUI_Animator_Play (ArkUI_AnimatorHandle animator)
6380```
6381**描述:**
6382
6383启动animator动画。
6384
6385**参数:**
6386
6387| 名称 | 描述 |
6388| -------- | -------- |
6389| animator | animator动画对象。  |
6390
6391**返回:**
6392
6393ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
6394
6395
6396### OH_ArkUI_Animator_ResetAnimatorOption()
6397
6398```
6399int32_t OH_ArkUI_Animator_ResetAnimatorOption (ArkUI_AnimatorHandle animator, ArkUI_AnimatorOption * option )
6400```
6401**描述:**
6402
6403更新animator动画。
6404
6405**参数:**
6406
6407| 名称 | 描述 |
6408| -------- | -------- |
6409| animator | animator动画对象。  |
6410| option | animator动画参数。  |
6411
6412**返回:**
6413
6414ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
6415
6416
6417### OH_ArkUI_Animator_Reverse()
6418
6419```
6420int32_t OH_ArkUI_Animator_Reverse (ArkUI_AnimatorHandle animator)
6421```
6422**描述:**
6423
6424以相反的顺序播放animator动画。
6425
6426**参数:**
6427
6428| 名称 | 描述 |
6429| -------- | -------- |
6430| animator | animator动画对象。  |
6431
6432**返回:**
6433
6434ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
6435
6436
6437### OH_ArkUI_AnimatorEvent_GetUserData()
6438
6439```
6440void* OH_ArkUI_AnimatorEvent_GetUserData (ArkUI_AnimatorEvent * event)
6441```
6442**描述:**
6443
6444获取动画事件对象中的用户自定义对象。
6445
6446**起始版本:** 12
6447
6448**参数:**
6449
6450| 名称 | 描述 |
6451| -------- | -------- |
6452| event | 动画事件对象。  |
6453
6454**返回:**
6455
6456用户自定义对象。
6457
6458
6459### OH_ArkUI_AnimatorOnFrameEvent_GetUserData()
6460
6461```
6462void* OH_ArkUI_AnimatorOnFrameEvent_GetUserData (ArkUI_AnimatorOnFrameEvent * event)
6463```
6464**描述:**
6465
6466获取动画事件对象中的用户自定义对象。
6467
6468**起始版本:** 12
6469
6470**参数:**
6471
6472| 名称 | 描述 |
6473| -------- | -------- |
6474| event | 动画事件对象。  |
6475
6476**返回:**
6477
6478用户自定义对象。
6479
6480
6481### OH_ArkUI_AnimatorOnFrameEvent_GetValue()
6482
6483```
6484float OH_ArkUI_AnimatorOnFrameEvent_GetValue (ArkUI_AnimatorOnFrameEvent * event)
6485```
6486**描述:**
6487
6488获取动画事件对象中的当前进度。
6489
6490**起始版本:** 12
6491
6492**参数:**
6493
6494| 名称 | 描述 |
6495| -------- | -------- |
6496| event | 动画事件对象。  |
6497
6498**返回:**
6499
6500动画进度。
6501
6502
6503### OH_ArkUI_AnimatorOption_Create()
6504
6505```
6506ArkUI_AnimatorOption* OH_ArkUI_AnimatorOption_Create (int32_t keyframeSize)
6507```
6508**描述:**
6509
6510创建animator动画对象参数。
6511
6512**起始版本:** 12
6513
6514**参数:**
6515
6516| 名称 | 描述 |
6517| -------- | -------- |
6518| keyframeSize | 关键帧个数。  |
6519
6520**注解:**
6521
6522keyframeSize大于0时,动画插值起点默认是0,动画插值终点模式值是1。不支持设置。
6523
6524**返回:**
6525
6526animator动画对象参数指针。
6527
6528
6529### OH_ArkUI_AnimatorOption_Dispose()
6530
6531```
6532void OH_ArkUI_AnimatorOption_Dispose (ArkUI_AnimatorOption * option)
6533```
6534**描述:**
6535
6536销毁animator动画对象参数。
6537
6538**起始版本:** 12
6539
6540
6541### OH_ArkUI_AnimatorOption_GetBegin()
6542
6543```
6544float OH_ArkUI_AnimatorOption_GetBegin (ArkUI_AnimatorOption * option)
6545```
6546**描述:**
6547
6548获取animator动画插值起点。
6549
6550**起始版本:** 12
6551
6552**参数:**
6553
6554| 名称 | 描述 |
6555| -------- | -------- |
6556| option | animator动画参数。  |
6557
6558**返回:**
6559
6560动画插值起点。
6561
6562
6563### OH_ArkUI_AnimatorOption_GetCurve()
6564
6565```
6566ArkUI_CurveHandle OH_ArkUI_AnimatorOption_GetCurve (ArkUI_AnimatorOption * option)
6567```
6568**描述:**
6569
6570获取animator动画插值曲线。
6571
6572**起始版本:** 12
6573
6574**参数:**
6575
6576| 名称 | 描述 |
6577| -------- | -------- |
6578| option | animator动画参数。  |
6579
6580**返回:**
6581
6582动画插值曲线。
6583
6584
6585### OH_ArkUI_AnimatorOption_GetDelay()
6586
6587```
6588int32_t OH_ArkUI_AnimatorOption_GetDelay (ArkUI_AnimatorOption * option)
6589```
6590**描述:**
6591
6592获取animator动画延时播放时长。
6593
6594**起始版本:** 12
6595
6596**参数:**
6597
6598| 名称 | 描述 |
6599| -------- | -------- |
6600| option | animator动画参数。  |
6601
6602**返回:**
6603
6604动画延时播放时长,单位毫秒。
6605
6606
6607### OH_ArkUI_AnimatorOption_GetDirection()
6608
6609```
6610ArkUI_AnimationDirection OH_ArkUI_AnimatorOption_GetDirection (ArkUI_AnimatorOption * option)
6611```
6612**描述:**
6613
6614获取animator动画播放方向。
6615
6616**起始版本:** 12
6617
6618**参数:**
6619
6620| 名称 | 描述 |
6621| -------- | -------- |
6622| option | animator动画参数。  |
6623
6624**返回:**
6625
6626动画播放方向。
6627
6628
6629### OH_ArkUI_AnimatorOption_GetDuration()
6630
6631```
6632int32_t OH_ArkUI_AnimatorOption_GetDuration (ArkUI_AnimatorOption * option)
6633```
6634**描述:**
6635
6636获取animator动画播放的时长。
6637
6638**起始版本:** 12
6639
6640**参数:**
6641
6642| 名称 | 描述 |
6643| -------- | -------- |
6644| option | animator动画参数。  |
6645
6646**返回:**
6647
6648动画播放的时长,单位毫秒。
6649
6650
6651### OH_ArkUI_AnimatorOption_GetEnd()
6652
6653```
6654float OH_ArkUI_AnimatorOption_GetEnd (ArkUI_AnimatorOption * option)
6655```
6656**描述:**
6657
6658获取animator动画插值终点。
6659
6660**起始版本:** 12
6661
6662**参数:**
6663
6664| 名称 | 描述 |
6665| -------- | -------- |
6666| option | animator动画参数。  |
6667
6668**返回:**
6669
6670动画插值终点。
6671
6672
6673### OH_ArkUI_AnimatorOption_GetExpectedFrameRateRange()
6674
6675```
6676ArkUI_ExpectedFrameRateRange* OH_ArkUI_AnimatorOption_GetExpectedFrameRateRange (ArkUI_AnimatorOption * option)
6677```
6678**描述:**
6679
6680获取animator动画期望的帧率范围。
6681
6682**起始版本:** 12
6683
6684**参数:**
6685
6686| 名称 | 描述 |
6687| -------- | -------- |
6688| option | animator动画参数。  |
6689
6690**返回:**
6691
6692期望的帧率范围对象指针。
6693
6694
6695### OH_ArkUI_AnimatorOption_GetFill()
6696
6697```
6698ArkUI_AnimationFillMode OH_ArkUI_AnimatorOption_GetFill (ArkUI_AnimatorOption * option)
6699```
6700**描述:**
6701
6702获取animator动画执行后是否恢复到初始状态。
6703
6704**起始版本:** 12
6705
6706**参数:**
6707
6708| 名称 | 描述 |
6709| -------- | -------- |
6710| option | animator动画参数。  |
6711
6712**返回:**
6713
6714执行后是否恢复到初始状态。
6715
6716
6717### OH_ArkUI_AnimatorOption_GetIterations()
6718
6719```
6720int32_t OH_ArkUI_AnimatorOption_GetIterations (ArkUI_AnimatorOption * option)
6721```
6722**描述:**
6723
6724获取animator动画播放次数。
6725
6726**起始版本:** 12
6727
6728**参数:**
6729
6730| 名称 | 描述 |
6731| -------- | -------- |
6732| option | animator动画动画参数。  |
6733
6734**返回:**
6735
6736动画播放次数。
6737
6738
6739### OH_ArkUI_AnimatorOption_GetKeyframeCurve()
6740
6741```
6742ArkUI_CurveHandle OH_ArkUI_AnimatorOption_GetKeyframeCurve (ArkUI_AnimatorOption * option, int32_t index )
6743```
6744**描述:**
6745
6746获取animator动画关键帧动画插值曲线。
6747
6748**起始版本:** 12
6749
6750**参数:**
6751
6752| 名称 | 描述 |
6753| -------- | -------- |
6754| option | animator动画对象参数。  |
6755| index | 关键帧的索引值。  |
6756
6757**返回:**
6758
6759动画插值曲线。
6760
6761
6762### OH_ArkUI_AnimatorOption_GetKeyframeTime()
6763
6764```
6765float OH_ArkUI_AnimatorOption_GetKeyframeTime (ArkUI_AnimatorOption * option, int32_t index )
6766```
6767**描述:**
6768
6769获取animator动画关键帧时间。
6770
6771**起始版本:** 12
6772
6773**参数:**
6774
6775| 名称 | 描述 |
6776| -------- | -------- |
6777| option | animator动画对象参数。  |
6778| index | 关键帧的索引值。  |
6779
6780**返回:**
6781
6782关键帧时间。
6783
6784
6785### OH_ArkUI_AnimatorOption_GetKeyframeValue()
6786
6787```
6788float OH_ArkUI_AnimatorOption_GetKeyframeValue (ArkUI_AnimatorOption * option, int32_t index )
6789```
6790**描述:**
6791
6792获取animator动画关键帧数值。
6793
6794**起始版本:** 12
6795
6796**参数:**
6797
6798| 名称 | 描述 |
6799| -------- | -------- |
6800| option | animator动画对象参数。  |
6801| index | 关键帧的索引值。  |
6802
6803**返回:**
6804
6805关键帧数值。
6806
6807
6808### OH_ArkUI_AnimatorOption_RegisterOnCancelCallback()
6809
6810```
6811int32_t OH_ArkUI_AnimatorOption_RegisterOnCancelCallback (ArkUI_AnimatorOption * option, void * userData, void(*)(ArkUI_AnimatorEvent *event) callback )
6812```
6813**描述:**
6814
6815设置animator动画被取消时回调。
6816
6817**参数:**
6818
6819| 名称 | 描述 |
6820| -------- | -------- |
6821| option | animator动画参数。  |
6822| userData | 用户自定义参数。  |
6823| callback | 回调函数。  |
6824
6825**返回:**
6826
6827ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
6828
6829
6830### OH_ArkUI_AnimatorOption_RegisterOnFinishCallback()
6831
6832```
6833int32_t OH_ArkUI_AnimatorOption_RegisterOnFinishCallback (ArkUI_AnimatorOption * option, void * userData, void(*)(ArkUI_AnimatorEvent *event) callback )
6834```
6835**描述:**
6836
6837设置animator动画完成时回调。
6838
6839**参数:**
6840
6841| 名称 | 描述 |
6842| -------- | -------- |
6843| option | animator动画参数。  |
6844| userData | 用户自定义参数。  |
6845| callback | 回调函数。  |
6846
6847**返回:**
6848
6849ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
6850
6851
6852### OH_ArkUI_AnimatorOption_RegisterOnFrameCallback()
6853
6854```
6855int32_t OH_ArkUI_AnimatorOption_RegisterOnFrameCallback (ArkUI_AnimatorOption * option, void * userData, void(*)(ArkUI_AnimatorOnFrameEvent *event) callback )
6856```
6857**描述:**
6858
6859设置animator动画接收到帧时回调。
6860
6861**参数:**
6862
6863| 名称 | 描述 |
6864| -------- | -------- |
6865| option | animator动画参数。  |
6866| userData | 用户自定义参数。  |
6867| callback | 回调函数。  |
6868
6869**返回:**
6870
6871ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
6872
6873
6874### OH_ArkUI_AnimatorOption_RegisterOnRepeatCallback()
6875
6876```
6877int32_t OH_ArkUI_AnimatorOption_RegisterOnRepeatCallback (ArkUI_AnimatorOption * option, void * userData, void(*)(ArkUI_AnimatorEvent *event) callback )
6878```
6879**描述:**
6880
6881设置animator动画重复时回调。
6882
6883**参数:**
6884
6885| 名称 | 描述 |
6886| -------- | -------- |
6887| option | animator动画参数。  |
6888| userData | 用户自定义参数。  |
6889| callback | 回调函数。  |
6890
6891**返回:**
6892
6893ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
6894
6895
6896### OH_ArkUI_AnimatorOption_SetBegin()
6897
6898```
6899int32_t OH_ArkUI_AnimatorOption_SetBegin (ArkUI_AnimatorOption * option, float value )
6900```
6901**描述:**
6902
6903设置animator动画插值起点。
6904
6905**参数:**
6906
6907| 名称 | 描述 |
6908| -------- | -------- |
6909| option | animator动画对象参数。  |
6910| value | 动画插值起点。  |
6911
6912**注解:**
6913
6914当Animator动画为keyframe动画时,此方法不生效。
6915
6916**返回:**
6917
6918ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
6919
6920
6921### OH_ArkUI_AnimatorOption_SetCurve()
6922
6923```
6924int32_t OH_ArkUI_AnimatorOption_SetCurve (ArkUI_AnimatorOption * option, ArkUI_CurveHandle value )
6925```
6926**描述:**
6927
6928设置animator动画插值曲线。
6929
6930**参数:**
6931
6932| 名称 | 描述 |
6933| -------- | -------- |
6934| option | animator动画对象参数。  |
6935| value | 动画插值曲线。默认值:ARKUI_CURVE_LINEAR。  |
6936
6937**注解:**
6938
6939不支持springCurve,springMotion,responsiveSpringMotion,interpolatingSpring customCurve动画曲线。
6940
6941**返回:**
6942
6943ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
6944
6945
6946### OH_ArkUI_AnimatorOption_SetDelay()
6947
6948```
6949int32_t OH_ArkUI_AnimatorOption_SetDelay (ArkUI_AnimatorOption * option, int32_t value )
6950```
6951**描述:**
6952
6953设置animator动画延时播放时长,单位毫秒。
6954
6955**参数:**
6956
6957| 名称 | 描述 |
6958| -------- | -------- |
6959| option | animator动画对象参数。  |
6960| value | 延时播放时长,单位毫秒。  |
6961
6962**返回:**
6963
6964ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
6965
6966
6967### OH_ArkUI_AnimatorOption_SetDirection()
6968
6969```
6970int32_t OH_ArkUI_AnimatorOption_SetDirection (ArkUI_AnimatorOption * option, ArkUI_AnimationDirection value )
6971```
6972**描述:**
6973
6974设置animator动画播放方向。
6975
6976**参数:**
6977
6978| 名称 | 描述 |
6979| -------- | -------- |
6980| option | animator动画对象参数。  |
6981| value | 动画播放方向。  |
6982
6983**返回:**
6984
6985ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
6986
6987
6988### OH_ArkUI_AnimatorOption_SetDuration()
6989
6990```
6991int32_t OH_ArkUI_AnimatorOption_SetDuration (ArkUI_AnimatorOption * option, int32_t value )
6992```
6993**描述:**
6994
6995设置animator动画播放的时长,单位毫秒。
6996
6997**参数:**
6998
6999| 名称 | 描述 |
7000| -------- | -------- |
7001| option | animator动画对象参数。  |
7002| value | 播放的时长,单位毫秒。  |
7003
7004**返回:**
7005
7006ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
7007
7008
7009### OH_ArkUI_AnimatorOption_SetEnd()
7010
7011```
7012int32_t OH_ArkUI_AnimatorOption_SetEnd (ArkUI_AnimatorOption * option, float value )
7013```
7014**描述:**
7015
7016设置animator动画插值终点。
7017
7018**参数:**
7019
7020| 名称 | 描述 |
7021| -------- | -------- |
7022| option | animator动画对象参数。  |
7023| value | 动画插值终点。  |
7024
7025**注解:**
7026
7027当Animator动画为keyframe动画时,此方法不生效。
7028
7029**返回:**
7030
7031ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
7032
7033
7034### OH_ArkUI_AnimatorOption_SetExpectedFrameRateRange()
7035
7036```
7037int32_t OH_ArkUI_AnimatorOption_SetExpectedFrameRateRange (ArkUI_AnimatorOption * option, ArkUI_ExpectedFrameRateRange * value )
7038```
7039**描述:**
7040
7041设置animator动画期望的帧率范围。
7042
7043**参数:**
7044
7045| 名称 | 描述 |
7046| -------- | -------- |
7047| option | animator动画对象参数。  |
7048| value | 期望的帧率范围对象。  |
7049
7050**返回:**
7051
7052ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
7053
7054
7055### OH_ArkUI_AnimatorOption_SetFill()
7056
7057```
7058int32_t OH_ArkUI_AnimatorOption_SetFill (ArkUI_AnimatorOption * option, ArkUI_AnimationFillMode value )
7059```
7060**描述:**
7061
7062设置animator动画执行后是否恢复到初始状态。
7063
7064**参数:**
7065
7066| 名称 | 描述 |
7067| -------- | -------- |
7068| option | animator动画对象参数。  |
7069| value | 动画执行后是否恢复到初始状态。  |
7070
7071**返回:**
7072
7073ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
7074
7075
7076### OH_ArkUI_AnimatorOption_SetIterations()
7077
7078```
7079int32_t OH_ArkUI_AnimatorOption_SetIterations (ArkUI_AnimatorOption * option, int32_t value )
7080```
7081**描述:**
7082
7083设置animator动画播放次数。设置为0时不播放,设置为-1时无限次播放。
7084
7085**参数:**
7086
7087| 名称 | 描述 |
7088| -------- | -------- |
7089| option | animator动画对象参数。  |
7090| value | 动画播放次数。  |
7091
7092**注解:**
7093
7094设置为除-1外其他负数视为无效取值,无效取值动画默认播放1次。
7095
7096**返回:**
7097
7098ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
7099
7100
7101### OH_ArkUI_AnimatorOption_SetKeyframe()
7102
7103```
7104int32_t OH_ArkUI_AnimatorOption_SetKeyframe (ArkUI_AnimatorOption * option, float time, float value, int32_t index )
7105```
7106**描述:**
7107
7108设置animator动画关键帧参数。
7109
7110**参数:**
7111
7112| 名称 | 描述 |
7113| -------- | -------- |
7114| option | animator动画对象参数。  |
7115| time | 关键帧时间。取值范围:[0, 1], 必须是递增。  |
7116| value | 关键帧数值。  |
7117| index | 关键帧的索引值。  |
7118
7119**返回:**
7120
7121ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
7122
7123
7124### OH_ArkUI_AnimatorOption_SetKeyframeCurve()
7125
7126```
7127int32_t OH_ArkUI_AnimatorOption_SetKeyframeCurve (ArkUI_AnimatorOption * option, ArkUI_CurveHandle value, int32_t index )
7128```
7129**描述:**
7130
7131设置animator动画关键帧曲线类型。
7132
7133**参数:**
7134
7135| 名称 | 描述 |
7136| -------- | -------- |
7137| option | animator动画对象参数。  |
7138| value | 动画插值曲线。  |
7139| index | 关键帧的索引值。  |
7140
7141**注解:**
7142
7143不支持springCurve,springMotion,responsiveSpringMotion,interpolatingSpring customCurve动画曲线
7144
7145**返回:**
7146
7147ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
7148
7149
7150### OH_ArkUI_BarrierOption_Create()
7151
7152```
7153ArkUI_BarrierOption* OH_ArkUI_BarrierOption_Create (int32_t size)
7154```
7155**描述:**
7156
7157创建RelativeContaine容器内的屏障信息。
7158
7159**起始版本:** 12
7160
7161**参数:**
7162
7163| 名称 | 描述 |
7164| -------- | -------- |
7165| size | 屏障数量。  |
7166
7167**返回:**
7168
7169屏障信息。
7170
7171
7172### OH_ArkUI_BarrierOption_Dispose()
7173
7174```
7175void OH_ArkUI_BarrierOption_Dispose (ArkUI_BarrierOption * barrierStyle)
7176```
7177**描述:**
7178
7179销毁屏障信息。
7180
7181**起始版本:** 12
7182
7183**参数:**
7184
7185| 名称 | 描述 |
7186| -------- | -------- |
7187| barrierStyle | 屏障信息。  |
7188
7189
7190### OH_ArkUI_BarrierOption_GetDirection()
7191
7192```
7193ArkUI_BarrierDirection OH_ArkUI_BarrierOption_GetDirection (ArkUI_BarrierOption * barrierStyle, int32_t index )
7194```
7195**描述:**
7196
7197获取屏障的方向。
7198
7199**起始版本:** 12
7200
7201**参数:**
7202
7203| 名称 | 描述 |
7204| -------- | -------- |
7205| barrierStyle | 辅助线信息。  |
7206| index | 辅助线索引值。  |
7207
7208**返回:**
7209
7210屏障的方向。
7211
7212
7213### OH_ArkUI_BarrierOption_GetId()
7214
7215```
7216const char* OH_ArkUI_BarrierOption_GetId (ArkUI_BarrierOption * barrierStyle, int32_t index )
7217```
7218**描述:**
7219
7220获取屏障的Id。
7221
7222**起始版本:** 12
7223
7224**参数:**
7225
7226| 名称 | 描述 |
7227| -------- | -------- |
7228| barrierStyle | 辅助线信息。  |
7229| index | 辅助线索引值。  |
7230
7231**返回:**
7232
7233屏障的Id。
7234
7235
7236### OH_ArkUI_BarrierOption_GetReferencedId()
7237
7238```
7239const char* OH_ArkUI_BarrierOption_GetReferencedId (ArkUI_BarrierOption * barrierStyle, int32_t index, int32_t referencedIndex )
7240```
7241**描述:**
7242
7243获取屏障的依赖的组件。
7244
7245**起始版本:** 12
7246
7247**参数:**
7248
7249| 名称 | 描述 |
7250| -------- | -------- |
7251| barrierStyle | 辅助线信息。  |
7252| index | 辅助线索引值。  |
7253| referencedIndex | 依赖的组件Id索引值。  |
7254
7255**返回:**
7256
7257屏障的依赖的组件。
7258
7259
7260### OH_ArkUI_BarrierOption_GetReferencedIdSize()
7261
7262```
7263int32_t OH_ArkUI_BarrierOption_GetReferencedIdSize (ArkUI_BarrierOption * barrierStyle, int32_t index )
7264```
7265**描述:**
7266
7267获取屏障的依赖的组件的个数。
7268
7269**起始版本:** 12
7270
7271**参数:**
7272
7273| 名称 | 描述 |
7274| -------- | -------- |
7275| barrierStyle | 辅助线信息。  |
7276| index | 辅助线索引值。  |
7277
7278**返回:**
7279
7280屏障的依赖的组件的个数。
7281
7282
7283### OH_ArkUI_BarrierOption_SetDirection()
7284
7285```
7286void OH_ArkUI_BarrierOption_SetDirection (ArkUI_BarrierOption * barrierStyle, ArkUI_BarrierDirection value, int32_t index )
7287```
7288**描述:**
7289
7290设置屏障的方向。
7291
7292**起始版本:** 12
7293
7294**参数:**
7295
7296| 名称 | 描述 |
7297| -------- | -------- |
7298| barrierStyle | 屏障信息。  |
7299| value | 方向。  |
7300| index | 屏障索引值。  |
7301
7302
7303### OH_ArkUI_BarrierOption_SetId()
7304
7305```
7306void OH_ArkUI_BarrierOption_SetId (ArkUI_BarrierOption * barrierStyle, const char * value, int32_t index )
7307```
7308**描述:**
7309
7310设置屏障的Id。
7311
7312**起始版本:** 12
7313
7314**参数:**
7315
7316| 名称 | 描述 |
7317| -------- | -------- |
7318| barrierStyle | 屏障信息。  |
7319| value | id,必须是唯一的并且不可与容器内组件重名。  |
7320| index | 屏障索引值。  |
7321
7322
7323### OH_ArkUI_BarrierOption_SetReferencedId()
7324
7325```
7326void OH_ArkUI_BarrierOption_SetReferencedId (ArkUI_BarrierOption * barrierStyle, const char * value, int32_t index )
7327```
7328**描述:**
7329
7330设置屏障的依赖的组件。
7331
7332**起始版本:** 12
7333
7334**参数:**
7335
7336| 名称 | 描述 |
7337| -------- | -------- |
7338| barrierStyle | 屏障信息。  |
7339| value | 依赖的组件的Id。  |
7340| index | 屏障索引值。  |
7341
7342
7343### OH_ArkUI_ConvertToHtml()
7344
7345```
7346const char* OH_ArkUI_ConvertToHtml (ArkUI_StyledString_Descriptor * descriptor)
7347```
7348**描述:**
7349
7350将属性字符串信息转化成html。
7351
7352**起始版本:** 14
7353
7354**参数:**
7355
7356| 名称 | 描述 |
7357| -------- | -------- |
7358| descriptor | 指向ArkUI_StyledString_Descriptor对象的指针。  |
7359
7360**返回:**
7361
7362html。该指针由内部管理,在OH_ArkUI_StyledString_Descriptor_Destroy()时释放。
7363
7364
7365### OH_ArkUI_CreateAsymmetricTransitionEffect()
7366
7367```
7368ArkUI_TransitionEffect* OH_ArkUI_CreateAsymmetricTransitionEffect (ArkUI_TransitionEffect * appear, ArkUI_TransitionEffect * disappear )
7369```
7370**描述:**
7371
7372创建非对称的转场效果对象。
7373
7374**起始版本:** 12
7375
7376**参数:**
7377
7378| 名称 | 描述 |
7379| -------- | -------- |
7380| appear | 出现的转场效果。  |
7381| disappear | 消失的转场效果。  |
7382
7383**注解:**
7384
7385如不通过asymmetric函数构造TransitionEffect,则表明该效果在组件出现和消失时均生效。
7386
7387**返回:**
7388
7389非对称的转场效果对象。如果参数异常返回NULL。
7390
7391
7392### OH_ArkUI_CreateDragActionWithContext()
7393
7394```
7395ArkUI_DragAction* OH_ArkUI_CreateDragActionWithContext (ArkUI_ContextHandle uiContext)
7396```
7397**描述:**
7398
7399创建一个拖拽操作对象,该对象需与一个UI实例相关联,可通过传入一个UI实例指针来关联。
7400
7401**起始版本:** 12
7402
7403**参数:**
7404
7405| 名称 | 描述 |
7406| -------- | -------- |
7407| uiContext | UI实例对象指针。  |
7408
7409**返回:**
7410
7411ArkUI_DragAction对象,如果创建失败,则返回空。
7412
7413
7414### OH_ArkUI_CreateDragActionWithNode()
7415
7416```
7417ArkUI_DragAction* OH_ArkUI_CreateDragActionWithNode (ArkUI_NodeHandle node)
7418```
7419**描述:**
7420
7421创建一个拖拽操作对象,该对象需与一个UI实例相关联,可通过传入一个当前UI实例的某个组件节点来指定。
7422
7423**起始版本:** 12
7424
7425**参数:**
7426
7427| 名称 | 描述 |
7428| -------- | -------- |
7429| node | 组件节点指针。  |
7430
7431**返回:**
7432
7433ArkUI_DragAction对象指针,如果创建失败,则返回空。
7434
7435
7436### OH_ArkUI_CreateDragPreviewOption()
7437
7438```
7439ArkUI_DragPreviewOption* OH_ArkUI_CreateDragPreviewOption (void )
7440```
7441**描述:**
7442
7443构建一个ArkUI_DragPreviewOption对象。
7444
7445**起始版本:** 12
7446
7447**返回:**
7448
7449ArkUI_DragPreviewOption对象。
7450
7451
7452### OH_ArkUI_CreateMovementTransitionEffect()
7453
7454```
7455ArkUI_TransitionEffect* OH_ArkUI_CreateMovementTransitionEffect (ArkUI_TransitionEdge move)
7456```
7457**描述:**
7458
7459创建组件平移效果对象。
7460
7461**起始版本:** 12
7462
7463**参数:**
7464
7465| 名称 | 描述 |
7466| -------- | -------- |
7467| move | 平移类型。  |
7468
7469**返回:**
7470
7471组件转场时的平移效果对象。如果参数异常返回NULL。
7472
7473
7474### OH_ArkUI_CreateOpacityTransitionEffect()
7475
7476```
7477ArkUI_TransitionEffect* OH_ArkUI_CreateOpacityTransitionEffect (float opacity)
7478```
7479**描述:**
7480
7481创建组件转场时的透明度效果对象。
7482
7483**起始版本:** 12
7484
7485**参数:**
7486
7487| 名称 | 描述 |
7488| -------- | -------- |
7489| opacity | 透明度,取值范围: [0, 1]。  |
7490
7491**注解:**
7492
7493设置小于0的非法值按0处理,大于1的非法值按1处理。
7494
7495**返回:**
7496
7497组件转场时的透明度效果对象。
7498
7499
7500### OH_ArkUI_CreateRotationTransitionEffect()
7501
7502```
7503ArkUI_TransitionEffect* OH_ArkUI_CreateRotationTransitionEffect (ArkUI_RotationOptions * rotate)
7504```
7505**描述:**
7506
7507创建组件转场时的旋转效果对象。
7508
7509**起始版本:** 12
7510
7511**参数:**
7512
7513| 名称 | 描述 |
7514| -------- | -------- |
7515| rotate | 组件转场时的旋转参数对象。  |
7516
7517**返回:**
7518
7519组件转场时的旋转效果对象。如果参数异常返回NULL。
7520
7521
7522### OH_ArkUI_CreateScaleTransitionEffect()
7523
7524```
7525ArkUI_TransitionEffect* OH_ArkUI_CreateScaleTransitionEffect (ArkUI_ScaleOptions * scale)
7526```
7527**描述:**
7528
7529创建组件转场时的缩放效果对象。
7530
7531**起始版本:** 12
7532
7533**参数:**
7534
7535| 名称 | 描述 |
7536| -------- | -------- |
7537| scale | 组件转场时的缩放参数对象。  |
7538
7539**返回:**
7540
7541组件转场时的缩放效果对象。如果参数异常返回NULL。
7542
7543
7544### OH_ArkUI_CreateTranslationTransitionEffect()
7545
7546```
7547ArkUI_TransitionEffect* OH_ArkUI_CreateTranslationTransitionEffect (ArkUI_TranslationOptions * translate)
7548```
7549**描述:**
7550
7551创建组件转场时的平移效果对象。
7552
7553**起始版本:** 12
7554
7555**参数:**
7556
7557| 名称 | 描述 |
7558| -------- | -------- |
7559| translate | 组件转场时的平移参数对象。  |
7560
7561**返回:**
7562
7563组件转场时的平移效果对象。如果参数异常返回NULL。
7564
7565### OH_ArkUI_Curve_CreateCubicBezierCurve()
7566
7567```
7568ArkUI_CurveHandle OH_ArkUI_Curve_CreateCubicBezierCurve (float x1, float y1, float x2, float y2 )
7569```
7570**描述:**
7571
7572构造三阶贝塞尔曲线对象。
7573
7574**参数:**
7575
7576| 名称 | 描述 |
7577| -------- | -------- |
7578| x1 | 确定贝塞尔曲线第一点横坐标,取值范围:[0, 1]。 设置的值小于0时,按0处理;设置的值大于1时,按1处理。  |
7579| y1 | 确定贝塞尔曲线第一点纵坐标。  |
7580| x2 | 确定贝塞尔曲线第二点横坐标,取值范围:[0, 1]。 设置的值小于0时,按0处理;设置的值大于1时,按1处理。  |
7581| y2 | 确定贝塞尔曲线第二点纵坐标。  |
7582
7583**返回:**
7584
7585曲线的插值对象指针。如果参数异常返回NULL。
7586
7587
7588### OH_ArkUI_Curve_CreateCurveByType()
7589
7590```
7591ArkUI_CurveHandle OH_ArkUI_Curve_CreateCurveByType (ArkUI_AnimationCurve curve)
7592```
7593**描述:**
7594
7595插值曲线的初始化函数,可以根据入参创建一个插值曲线对象。
7596
7597**参数:**
7598
7599| 名称 | 描述 |
7600| -------- | -------- |
7601| curve | 曲线类型。  |
7602
7603**返回:**
7604
7605曲线的插值对象指针。如果参数异常返回NULL。
7606
7607
7608### OH_ArkUI_Curve_CreateCustomCurve()
7609
7610```
7611ArkUI_CurveHandle OH_ArkUI_Curve_CreateCustomCurve (void * userData, float(*)(float fraction, void *userdata) interpolate )
7612```
7613**描述:**
7614
7615构造自定义曲线对象。
7616
7617**参数:**
7618
7619| 名称 | 描述 |
7620| -------- | -------- |
7621| userData | 用户自定义数据。  |
7622| interpolate | 用户自定义的插值回调函数。fraction为动画开始时的插值输入x值。取值范围:[0,1] 返回值为曲线的y值。取值范围:[0,1]。 fraction等于0时,返回值为0对应动画起点,返回不为0,动画在起点处有跳变效果。 fraction等于1时,返回值为1对应动画终点,返回值不为1将导致动画的终值不是状态变量的值, 出现大于或者小于状态变量值,再跳变到状态变量值的效果。  |
7623
7624**返回:**
7625
7626曲线的插值对象指针。如果参数异常返回NULL。
7627
7628
7629### OH_ArkUI_Curve_CreateInterpolatingSpring()
7630
7631```
7632ArkUI_CurveHandle OH_ArkUI_Curve_CreateInterpolatingSpring (float velocity, float mass, float stiffness, float damping )
7633```
7634**描述:**
7635
7636构造插值器弹簧曲线对象,生成一条从0到1的动画曲线,实际动画值根据曲线进行插值计算。
7637
7638**参数:**
7639
7640| 名称 | 描述 |
7641| -------- | -------- |
7642| velocity | 初始速度。外部因素对弹性动效产生的影响参数, 目的是保证对象从之前的运动状态平滑地过渡到弹性动效。该速度是归一化速度, 其值等于动画开始时的实际速度除以动画属性改变值。  |
7643| mass | 质量。弹性系统的受力对象,会对弹性系统产生惯性影响。 质量越大,震荡的幅度越大,恢复到平衡位置的速度越慢。  |
7644| stiffness | 刚度。表示物体抵抗施加的力而形变的程度。 刚度越大,抵抗变形的能力越强,恢复到平衡位置的速度越快。  |
7645| damping | 阻尼。用于描述系统在受到扰动后震荡及衰减的情形。 阻尼越大,弹性运动的震荡次数越少、震荡幅度越小。  |
7646
7647**注解:**
7648
7649动画时间由曲线参数决定,不受animation、animateTo中的duration参数控制。
7650
7651**返回:**
7652
7653曲线的插值对象指针。如果参数异常返回NULL。
7654
7655
7656### OH_ArkUI_Curve_CreateResponsiveSpringMotion()
7657
7658```
7659ArkUI_CurveHandle OH_ArkUI_Curve_CreateResponsiveSpringMotion (float response, float dampingFraction, float overlapDuration )
7660```
7661**描述:**
7662
7663构造弹性跟手动画曲线对象,是springMotion的一种特例,仅默认参数不同,可与springMotion混合使用。
7664
7665**参数:**
7666
7667| 名称 | 描述 |
7668| -------- | -------- |
7669| response | 弹簧自然振动周期,决定弹簧复位的速度。  |
7670| dampingFraction | 阻尼系数。 大于0小于1的值为欠阻尼,运动过程中会超出目标值; 等于1为临界阻尼; 大于1为过阻尼,运动过程中逐渐趋于目标值。  |
7671| overlapDuration | 弹性动画衔接时长。发生动画继承时,如果前后两个弹性动画response不一致, response参数会在overlapDuration时间内平滑过渡。  |
7672
7673**注解:**
7674
7675动画时间由曲线参数决定,不受animation、animateTo中的duration参数控制。
7676
7677**返回:**
7678
7679曲线的插值对象指针。如果参数异常返回NULL。
7680
7681
7682### OH_ArkUI_Curve_CreateSpringCurve()
7683
7684```
7685ArkUI_CurveHandle OH_ArkUI_Curve_CreateSpringCurve (float velocity, float mass, float stiffness, float damping )
7686```
7687**描述:**
7688
7689构造弹簧曲线对象,曲线形状由弹簧参数决定,动画时长受animation、animateTo中的duration参数控制。
7690
7691**参数:**
7692
7693| 名称 | 描述 |
7694| -------- | -------- |
7695| velocity | 初始速度。是由外部因素对弹性动效产生的影响参数, 其目的是保证对象从之前的运动状态平滑的过渡到弹性动效。该速度是归一化速度,其值等于动画开始时的实际速度除以动画属性改变值。  |
7696| mass | 质量。弹性系统的受力对象,会对弹性系统产生惯性影响。质量越大,震荡的幅度越大,恢复到平衡位置的速度越慢。  |
7697| stiffness | 刚度。是物体抵抗施加的力而形变的程度。在弹性系统中,刚度越大,抵抗变形的能力越强,恢复到平衡位置的速度就越快。  |
7698| damping | 阻尼。用于描述系统在受到扰动后震荡及衰减的情形。阻尼越大,弹性运动的震荡次数越少、震荡幅度越小。  |
7699
7700**返回:**
7701
7702曲线的插值对象指针。如果参数异常返回NULL。
7703
7704
7705### OH_ArkUI_Curve_CreateSpringMotion()
7706
7707```
7708ArkUI_CurveHandle OH_ArkUI_Curve_CreateSpringMotion (float response, float dampingFraction, float overlapDuration )
7709```
7710**描述:**
7711
7712构造弹性动画曲线对象。如果对同一对象的同一属性进行多个弹性动画,每个动画会替换掉前一个动画,并继承之前的速度。
7713
7714**参数:**
7715
7716| 名称 | 描述 |
7717| -------- | -------- |
7718| response | 弹簧自然振动周期,决定弹簧复位的速度。  |
7719| dampingFraction | 阻尼系数。 大于0小于1的值为欠阻尼,运动过程中会超出目标值; 等于1为临界阻尼; 大于1为过阻尼,运动过程中逐渐趋于目标值。  |
7720| overlapDuration | 弹性动画衔接时长。发生动画继承时,如果前后两个弹性动画response不一致, response参数会在overlapDuration时间内平滑过渡。  |
7721
7722**注解:**
7723
7724动画时间由曲线参数决定,不受animation、animateTo中的duration参数控制。
7725
7726**返回:**
7727
7728曲线的插值对象指针。如果参数异常返回NULL。
7729
7730
7731### OH_ArkUI_Curve_CreateStepsCurve()
7732
7733```
7734ArkUI_CurveHandle OH_ArkUI_Curve_CreateStepsCurve (int32_t count, bool end )
7735```
7736**描述:**
7737
7738构造阶梯曲线对象。
7739
7740**参数:**
7741
7742| 名称 | 描述 |
7743| -------- | -------- |
7744| count | 阶梯的数量,需要为正整数,取值范围:[1, +∞)。  |
7745| end | 在每个间隔的起点或是终点发生阶跃变化, true:在终点发生阶跃变化,false:在起点发生阶跃变化。  |
7746
7747**返回:**
7748
7749曲线的插值对象指针。如果参数异常返回NULL。
7750
7751
7752### OH_ArkUI_Curve_DisposeCurve()
7753
7754```
7755void OH_ArkUI_Curve_DisposeCurve (ArkUI_CurveHandle curveHandle)
7756```
7757**描述:**
7758
7759销毁自定义曲线对象。
7760
7761**参数:**
7762
7763| 名称 | 描述 |
7764| -------- | -------- |
7765| curve | 曲线的插值对象指针。  |
7766
7767
7768### OH_ArkUI_CustomProperty_Destroy()
7769
7770```
7771void OH_ArkUI_CustomProperty_Destroy (ArkUI_CustomProperty * handle)
7772```
7773**描述:**
7774
7775销毁CustomProperty实例。
7776
7777**起始版本:** 14
7778
7779**参数:**
7780
7781| 名称 | 描述 |
7782| -------- | -------- |
7783| handle | 要销毁的CustomProperty实例。  |
7784
7785
7786### OH_ArkUI_CustomProperty_GetStringValue()
7787
7788```
7789const char* OH_ArkUI_CustomProperty_GetStringValue (ArkUI_CustomProperty * handle)
7790```
7791**描述:**
7792
7793获取自定义属性value信息。
7794
7795**起始版本:** 14
7796
7797**参数:**
7798
7799| 名称 | 描述 |
7800| -------- | -------- |
7801| handle | 自定义属性对象指针。  |
7802
7803**返回:**
7804
7805自定义属性value信息。
7806
7807
7808### OH_ArkUI_CustomSpanDrawInfo_Create()
7809
7810```
7811ArkUI_CustomSpanDrawInfo* OH_ArkUI_CustomSpanDrawInfo_Create (void )
7812```
7813**描述:**
7814
7815创建自定义段落组件绘制信息。
7816
7817**起始版本:** 12
7818
7819**返回:**
7820
7821CustomSpanDrawInfo实例。 如果返回空指针,可能是因为内存不足。
7822
7823
7824### OH_ArkUI_CustomSpanDrawInfo_Dispose()
7825
7826```
7827void OH_ArkUI_CustomSpanDrawInfo_Dispose (ArkUI_CustomSpanDrawInfo * info)
7828```
7829**描述:**
7830
7831销毁自定义段落组件绘制信息。
7832
7833**起始版本:** 12
7834
7835**参数:**
7836
7837| 名称 | 描述 |
7838| -------- | -------- |
7839| info | 自定义段落组件绘制信息指针。  |
7840
7841
7842### OH_ArkUI_CustomSpanDrawInfo_GetBaseline()
7843
7844```
7845float OH_ArkUI_CustomSpanDrawInfo_GetBaseline (ArkUI_CustomSpanDrawInfo * info)
7846```
7847**描述:**
7848
7849获取自定义段落组件相对于挂载组件的基线偏移量。
7850
7851**起始版本:** 12
7852
7853**参数:**
7854
7855| 名称 | 描述 |
7856| -------- | -------- |
7857| info | 自定义段落组件绘制信息指针。  |
7858
7859**返回:**
7860
7861基线偏移量值。若函数参数异常,返回0.0f。 异常返回原因:传入参数验证失败,参数不能为空。
7862
7863### OH_ArkUI_NodeUtils_GetWindowInfo()
7864
7865```
7866int32_t OH_ArkUI_NodeUtils_GetWindowInfo(ArkUI_NodeHandle node, ArkUI_HostWindowInfo** info)
7867```
7868**描述:**
7869
7870获取节点所属的窗口信息。
7871
7872**起始版本:** 15
7873
7874**参数:**
7875
7876| 名称 | 描述 |
7877| -------- | -------- |
7878| node | 节点指针。 |
7879| info | 窗口结构体指针。 |
7880
7881**返回:**
7882
7883返回错误码。ARKUI_ERROR_CODE_NO_ERROR代表成功,ARKUI_ERROR_CODE_PARAM_INVALID代表函数参数异常,ARKUI_ERROR_CODE_NODE_NOT_ON_MAIN_TREE代表节点未挂载到节点树上。
7884
7885### OH_ArkUI_HostWindowInfo_GetName()
7886
7887```
7888const char* OH_ArkUI_HostWindowInfo_GetName(ArkUI_HostWindowInfo* info)
7889```
7890**描述:**
7891
7892获取HostWindowInfo对象中的窗口名称。
7893
7894**起始版本:** 15
7895
7896**参数:**
7897
7898| 名称 | 描述 |
7899| -------- | -------- |
7900| info | HostWindowInfo对象。 |
7901
7902**返回:**
7903
7904HostWindowInfo对象中的窗口名称。
7905
7906### OH_ArkUI_HostWindowInfo_Destroy()
7907
7908```
7909void OH_ArkUI_HostWindowInfo_Destroy(ArkUI_HostWindowInfo* info)
7910```
7911**描述:**
7912
7913销毁HostWindowInfo对象。
7914
7915**起始版本:** 15
7916
7917**参数:**
7918
7919| 名称 | 描述 |
7920| -------- | -------- |
7921| info | 要销毁的HostWindowInfo对象。 |
7922
7923### OH_ArkUI_NodeUtils_MoveTo()
7924
7925```
7926int32_t OH_ArkUI_NodeUtils_MoveTo(ArkUI_NodeHandle node, ArkUI_NodeHandle target_parent, int32_t index)
7927```
7928**描述:**
7929
7930将节点移动到目标父节点下,作为子节点。
7931
7932**起始版本:** 16
7933
7934**参数:**
7935
7936| 名称 | 描述 |
7937| -------- | -------- |
7938| node | 待移动的节点对象。 |
7939| target_parent | 目标父节点指针。 |
7940| index | 转移后的节点下标,如果下标值为非法值,则添加在目标父节点的最后一位。 |
7941
7942**返回:**
7943
7944返回错误码。ARKUI_ERROR_CODE_NO_ERROR代表成功,ARKUI_ERROR_CODE_PARAM_INVALID代表函数参数异常。
7945
7946### OH_ArkUI_NodeUtils_GetAttachedNodeHandleById()
7947
7948```
7949int32_t OH_ArkUI_NodeUtils_GetAttachedNodeHandleById(const char* id, ArkUI_NodeHandle* node)
7950```
7951**描述:**
7952
7953根据用户id获取目标节点。
7954
7955**起始版本:** 15
7956
7957**参数:**
7958
7959| 名称 | 描述 |
7960| -------- | -------- |
7961| id | 目标节点的id。 |
7962| node | 目标父节点指针。 |
7963
7964**返回:**
7965
7966返回错误码。ARKUI_ERROR_CODE_NO_ERROR代表成功,ARKUI_ERROR_CODE_PARAM_INVALID代表函数参数异常。
7967
7968### OH_ArkUI_NodeUtils_SetCrossLanguageOption()
7969
7970```
7971int32_t OH_ArkUI_NodeUtils_SetCrossLanguageOption(ArkUI_NodeHandle node, ArkUI_CrossLanguageOption* option)
7972```
7973**描述:**
7974
7975设置目标节点跨语言设置属性的能力。
7976
7977**起始版本:** 15
7978
7979**参数:**
7980
7981| 名称 | 描述 |
7982| -------- | -------- |
7983| node | 目标节点的指针。 |
7984| option | 跨语言配置类,类型请参考 {@link ArkUI_CrossLanguageOption}。 |
7985
7986**返回:**
7987
7988返回错误码。ARKUI_ERROR_CODE_NO_ERROR代表成功,ARKUI_ERROR_CODE_PARAM_INVALID代表函数参数异常。
7989
7990### OH_ArkUI_NodeUtils_GetCrossLanguageOption()
7991
7992```
7993int32_t OH_ArkUI_NodeUtils_GetCrossLanguageOption(ArkUI_NodeHandle node, ArkUI_CrossLanguageOption* option)
7994```
7995**描述:**
7996
7997获取目标节点跨语言设置属性的配置项。
7998
7999**起始版本:** 15
8000
8001**参数:**
8002
8003| 名称 | 描述 |
8004| -------- | -------- |
8005| node | 目标节点的指针。 |
8006| option | 跨语言配置类,类型请参考 {@link ArkUI_CrossLanguageOption}。 |
8007
8008**返回:**
8009
8010返回错误码。ARKUI_ERROR_CODE_NO_ERROR代表成功,ARKUI_ERROR_CODE_PARAM_INVALID代表函数参数异常。
8011
8012### OH_ArkUI_NodeUtils_GetFirstChildIndexWithoutExpand()
8013
8014```
8015int32_t OH_ArkUI_NodeUtils_GetFirstChildIndexWithoutExpand(ArkUI_NodeHandle node, uint32_t* index)
8016```
8017**描述:**
8018
8019获取目标节点在树上的第一个子节点的下标。
8020
8021**起始版本:** 15
8022
8023**参数:**
8024
8025| 名称 | 描述 |
8026| -------- | -------- |
8027| node | 目标节点的指针。 |
8028| index | 子节点的下标值。 |
8029
8030**返回:**
8031
8032返回错误码。ARKUI_ERROR_CODE_NO_ERROR代表成功,ARKUI_ERROR_CODE_PARAM_INVALID代表函数参数异常。
8033
8034### OH_ArkUI_NodeUtils_GetLastChildIndexWithoutExpand()
8035
8036```
8037int32_t OH_ArkUI_NodeUtils_GetLastChildIndexWithoutExpand(ArkUI_NodeHandle node, uint32_t* index)
8038```
8039**描述:**
8040
8041获取目标节点在树上的最后一个子节点的下标。
8042
8043**起始版本:** 15
8044
8045**参数:**
8046
8047| 名称 | 描述 |
8048| -------- | -------- |
8049| node | 目标节点的指针。 |
8050| index | 子节点的下标值。 |
8051
8052**返回:**
8053
8054返回错误码。ARKUI_ERROR_CODE_NO_ERROR代表成功,ARKUI_ERROR_CODE_PARAM_INVALID代表函数参数异常。
8055
8056### OH_ArkUI_NodeUtils_GetChildWithExpandMode()
8057
8058```
8059int32_t OH_ArkUI_NodeUtils_GetChildWithExpandMode(ArkUI_NodeHandle node, int32_t position,
8060    ArkUI_NodeHandle* subnode, uint32_t expandMode)
8061```
8062**描述:**
8063
8064用不同的展开模式获取对应下标的子节点。
8065
8066**起始版本:** 15
8067
8068**参数:**
8069
8070| 名称 | 描述 |
8071| -------- | -------- |
8072| node | 目标节点的指针。 |
8073| position | 对应子节点的下标。 |
8074| subnode | 获取子节点的指针。 |
8075| expandMode | 节点遍历展开方式,详情请参考[ArkUI_ExpandMode](#arkui_expandmode)。 |
8076
8077**返回:**
8078
8079返回错误码。ARKUI_ERROR_CODE_NO_ERROR代表成功,ARKUI_ERROR_CODE_PARAM_INVALID代表函数参数异常。
8080
8081### OH_ArkUI_CustomSpanDrawInfo_GetLineBottom()
8082
8083```
8084float OH_ArkUI_CustomSpanDrawInfo_GetLineBottom (ArkUI_CustomSpanDrawInfo * info)
8085```
8086**描述:**
8087
8088获取自定义段落组件相对于挂载组件的下边距。
8089
8090**起始版本:** 12
8091
8092**参数:**
8093
8094| 名称 | 描述 |
8095| -------- | -------- |
8096| info | 自定义段落组件绘制信息指针。  |
8097
8098**返回:**
8099
8100下边距值。若函数参数异常,返回0.0f。 异常返回原因:传入参数验证失败,参数不能为空。
8101
8102
8103### OH_ArkUI_CustomSpanDrawInfo_GetLineTop()
8104
8105```
8106float OH_ArkUI_CustomSpanDrawInfo_GetLineTop (ArkUI_CustomSpanDrawInfo * info)
8107```
8108**描述:**
8109
8110获取自定义段落组件相对于挂载组件的上边距。
8111
8112**起始版本:** 12
8113
8114**参数:**
8115
8116| 名称 | 描述 |
8117| -------- | -------- |
8118| info | 自定义段落组件绘制信息指针。  |
8119
8120**返回:**
8121
8122上边距值。若函数参数异常,返回0.0f。 异常返回原因:传入参数验证失败,参数不能为空。
8123
8124
8125### OH_ArkUI_CustomSpanDrawInfo_GetXOffset()
8126
8127```
8128float OH_ArkUI_CustomSpanDrawInfo_GetXOffset (ArkUI_CustomSpanDrawInfo * info)
8129```
8130**描述:**
8131
8132获取自定义段落组件相对于挂载组件的x轴偏移值。
8133
8134**起始版本:** 12
8135
8136**参数:**
8137
8138| 名称 | 描述 |
8139| -------- | -------- |
8140| info | 自定义段落组件绘制信息指针。  |
8141
8142**返回:**
8143
8144x轴偏移值。若函数参数异常,返回0.0f。 异常返回原因:传入参数验证失败,参数不能为空。
8145
8146
8147### OH_ArkUI_CustomSpanMeasureInfo_Create()
8148
8149```
8150ArkUI_CustomSpanMeasureInfo* OH_ArkUI_CustomSpanMeasureInfo_Create (void )
8151```
8152**描述:**
8153
8154创建自定义段落组件测量信息。
8155
8156**起始版本:** 12
8157
8158**返回:**
8159
8160CustomSpanMeasureInfo实例。 如果返回空指针,可能是因为内存不足。
8161
8162
8163### OH_ArkUI_CustomSpanMeasureInfo_Dispose()
8164
8165```
8166void OH_ArkUI_CustomSpanMeasureInfo_Dispose (ArkUI_CustomSpanMeasureInfo * info)
8167```
8168**描述:**
8169
8170销毁自定义段落组件测量信息。
8171
8172**起始版本:** 12
8173
8174**参数:**
8175
8176| 名称 | 描述 |
8177| -------- | -------- |
8178| info | 自定义段落组件测量信息指针。  |
8179
8180
8181### OH_ArkUI_CustomSpanMeasureInfo_GetFontSize()
8182
8183```
8184float OH_ArkUI_CustomSpanMeasureInfo_GetFontSize (ArkUI_CustomSpanMeasureInfo * info)
8185```
8186**描述:**
8187
8188获取自定义段落组件的父节点Text的字体大小。
8189
8190**起始版本:** 12
8191
8192**参数:**
8193
8194| 名称 | 描述 |
8195| -------- | -------- |
8196| info | 自定义段落组件测量信息指针。  |
8197
8198**返回:**
8199
8200父节点Text的字体大小。若函数参数异常,返回0.0f。 异常返回原因:传入参数验证失败,参数不能为空。
8201
8202
8203### OH_ArkUI_CustomSpanMetrics_Create()
8204
8205```
8206ArkUI_CustomSpanMetrics* OH_ArkUI_CustomSpanMetrics_Create (void )
8207```
8208**描述:**
8209
8210创建自定义段落组件度量信息。
8211
8212**起始版本:** 12
8213
8214**返回:**
8215
8216CustomSpanMetrics实例。 如果返回空指针,可能是因为内存不足。
8217
8218
8219### OH_ArkUI_CustomSpanMetrics_Dispose()
8220
8221```
8222void OH_ArkUI_CustomSpanMetrics_Dispose (ArkUI_CustomSpanMetrics * metrics)
8223```
8224**描述:**
8225
8226销毁自定义段落组件度量信息。
8227
8228**起始版本:** 12
8229
8230**参数:**
8231
8232| 名称 | 描述 |
8233| -------- | -------- |
8234| metrics | CustomSpanMetrics实例。  |
8235
8236
8237### OH_ArkUI_CustomSpanMetrics_SetHeight()
8238
8239```
8240int32_t OH_ArkUI_CustomSpanMetrics_SetHeight (ArkUI_CustomSpanMetrics * metrics, float height )
8241```
8242**描述:**
8243
8244设置自定义段落组件的高度。
8245
8246**起始版本:** 12
8247
8248**参数:**
8249
8250| 名称 | 描述 |
8251| -------- | -------- |
8252| metrics | CustomSpanMetrics实例。  |
8253| height | 高度大小,单位为vp。  |
8254
8255**返回:**
8256
8257ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 异常原因:传入参数验证失败,参数不能为空。
8258
8259
8260### OH_ArkUI_CustomSpanMetrics_SetWidth()
8261
8262```
8263int32_t OH_ArkUI_CustomSpanMetrics_SetWidth (ArkUI_CustomSpanMetrics * metrics, float width )
8264```
8265**描述:**
8266
8267设置自定义段落组件的宽度。
8268
8269**起始版本:** 12
8270
8271**参数:**
8272
8273| 名称 | 描述 |
8274| -------- | -------- |
8275| metrics | CustomSpanMetrics实例。  |
8276| width | 宽度大小,单位为vp。  |
8277
8278**返回:**
8279
8280ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 异常原因:传入参数验证失败,参数不能为空。
8281
8282
8283### OH_ArkUI_DialogDismissEvent_GetDismissReason()
8284
8285```
8286int32_t OH_ArkUI_DialogDismissEvent_GetDismissReason (ArkUI_DialogDismissEvent * event)
8287```
8288**描述:**
8289
8290获取交互式关闭事件指针中的关闭原因。
8291
8292**起始版本:** 12
8293
8294**参数:**
8295
8296| 名称 | 描述 |
8297| -------- | -------- |
8298| event | 弹窗关闭事件对象指针。 |
8299
8300**返回:**
8301
8302关闭原因,异常情况返回-1。 DIALOG_DISMISS_BACK_PRESS 对应点击三键back、左滑/右滑、键盘ESC关闭。 DIALOG_DISMISS_TOUCH_OUTSIDE 点击遮障层时。 DIALOG_DISMISS_CLOSE_BUTTON 点击关闭按钮。 DIALOG_DISMISS_SLIDE_DOWN 下拉关闭。
8303
8304### OH_ArkUI_DialogDismissEvent_GetUserData()
8305
8306```
8307void* OH_ArkUI_DialogDismissEvent_GetUserData (ArkUI_DialogDismissEvent * event)
8308```
8309**描述:**
8310
8311获取弹窗关闭事件对象中的用户自定义数据指针。
8312
8313**起始版本:** 12
8314
8315**参数:**
8316
8317| 名称 | 描述 |
8318| -------- | -------- |
8319| event | 弹窗关闭事件对象指针。 |
8320
8321**返回:**
8322
8323用户自定义数据指针。
8324
8325
8326### OH_ArkUI_DialogDismissEvent_SetShouldBlockDismiss()
8327
8328```
8329void OH_ArkUI_DialogDismissEvent_SetShouldBlockDismiss (ArkUI_DialogDismissEvent * event, bool shouldBlockDismiss )
8330```
8331**描述:**
8332
8333设置是否需要屏蔽系统关闭弹窗行为,true表示屏蔽系统行为不关闭弹窗,false表示不屏蔽。
8334
8335**起始版本:** 12
8336
8337**参数:**
8338
8339| 名称 | 描述 |
8340| -------- | -------- |
8341| event | 弹窗关闭事件对象指针。  |
8342| shouldBlockDismiss | 实现需要屏蔽系统关闭弹窗行为。  |
8343
8344
8345### OH_ArkUI_DisallowNodeAnyDropDataTypes()
8346
8347```
8348int32_t OH_ArkUI_DisallowNodeAnyDropDataTypes (ArkUI_NodeHandle node)
8349```
8350**描述:**
8351
8352配置组件不允许接受任何数据类型,该接口会重置通过[OH_ArkUI_SetNodeAllowedDropDataTypes](#oh_arkui_setnodealloweddropdatatypes)配置的数据类型。
8353
8354**起始版本:** 12
8355
8356**参数:**
8357
8358| 名称 | 描述 |
8359| -------- | -------- |
8360| node | 组件节点指针。  |
8361
8362**返回:**
8363
8364ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
8365
8366
8367### OH_ArkUI_DragAction_Dispose()
8368
8369```
8370void OH_ArkUI_DragAction_Dispose (ArkUI_DragAction * dragAction)
8371```
8372**描述:**
8373
8374销毁创建的 ArkUI_DragAction 对象。
8375
8376**起始版本:** 12
8377
8378**参数:**
8379
8380| 名称 | 描述 |
8381| -------- | -------- |
8382| dragAction | 拖拽行为对象。  |
8383
8384
8385### OH_ArkUI_DragAction_RegisterStatusListener()
8386
8387```
8388int32_t OH_ArkUI_DragAction_RegisterStatusListener (ArkUI_DragAction * dragAction, void * userData, void(*)(ArkUI_DragAndDropInfo *dragAndDropInfo, void *userData) listener )
8389```
8390**描述:**
8391
8392注册拖拽状态监听回调,该回调可感知到拖拽已经发起或用户松手结束的状态, 可通过该监听获取到落入方对数据的接收处理是否成功。
8393
8394**起始版本:** 12
8395
8396**参数:**
8397
8398| 名称 | 描述 |
8399| -------- | -------- |
8400| dragAction | 拖拽行为对象。  |
8401| userData | 应用自定义数据。  |
8402| listener | 状态监听回调,回调触发时,系统会返回一个拖拽状态对象指针,该指针会在回调之行完成后被销毁,应用不应再持有。  |
8403
8404**返回:**
8405
8406ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
8407
8408
8409### OH_ArkUI_DragAction_SetData()
8410
8411```
8412int32_t OH_ArkUI_DragAction_SetData (ArkUI_DragAction * dragAction, OH_UdmfData * data )
8413```
8414**描述:**
8415
8416设置拖拽数据。
8417
8418**起始版本:** 12
8419
8420**参数:**
8421
8422| 名称 | 描述 |
8423| -------- | -------- |
8424| dragAction | 拖拽行为对象。  |
8425| data | 拖拽数据。  |
8426
8427**返回:**
8428
8429ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
8430
8431
8432### OH_ArkUI_DragAction_SetDragPreviewOption()
8433
8434```
8435int32_t OH_ArkUI_DragAction_SetDragPreviewOption (ArkUI_DragAction * dragAction, ArkUI_DragPreviewOption * option )
8436```
8437**描述:**
8438
8439将构造的ArkUI_DragPreviewOption设置给ArkUI_DragAction。
8440
8441**起始版本:** 12
8442
8443**参数:**
8444
8445| 名称 | 描述 |
8446| -------- | -------- |
8447| dragAction | 拖拽行为对象。  |
8448| option | 自定义参数。  |
8449
8450**返回:**
8451
8452ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
8453
8454
8455### OH_ArkUI_DragAction_SetPixelMaps()
8456
8457```
8458int32_t OH_ArkUI_DragAction_SetPixelMaps (ArkUI_DragAction * dragAction, OH_PixelmapNative * pixelmapArray[], int32_t size )
8459```
8460**描述:**
8461
8462设置拖拽跟手图,只能使用 pixelmap 格式对象。
8463
8464**起始版本:** 12
8465
8466**参数:**
8467
8468| 名称 | 描述 |
8469| -------- | -------- |
8470| dragAction | 拖拽行为对象。  |
8471| pixelmapArray | 拖拽跟手图位图数组。  |
8472| size | 拖拽跟手图数量。  |
8473
8474**返回:**
8475
8476ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
8477
8478
8479### OH_ArkUI_DragAction_SetPointerId()
8480
8481```
8482int32_t OH_ArkUI_DragAction_SetPointerId (ArkUI_DragAction * dragAction, int32_t pointer )
8483```
8484**描述:**
8485
8486设置手指ID,当屏幕上仅有一只手指在操作时,pointer ID 为 0;一般情况下,配置 0 即可。
8487
8488**起始版本:** 12
8489
8490**参数:**
8491
8492| 名称 | 描述 |
8493| -------- | -------- |
8494| dragAction | 拖拽行为对象。  |
8495| pointer | 手指ID,范围 0~9。  |
8496
8497**返回:**
8498
8499ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
8500
8501
8502### OH_ArkUI_DragAction_SetTouchPointX()
8503
8504```
8505int32_t OH_ArkUI_DragAction_SetTouchPointX (ArkUI_DragAction * dragAction, float x )
8506```
8507**描述:**
8508
8509设置跟手点,相对于设置的第一个pixelmap的左上角。
8510
8511**起始版本:** 12
8512
8513**参数:**
8514
8515| 名称 | 描述 |
8516| -------- | -------- |
8517| dragAction | 拖拽行为对象。  |
8518| x | 跟手点坐标x值。  |
8519
8520**返回:**
8521
8522ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
8523
8524
8525### OH_ArkUI_DragAction_SetTouchPointY()
8526
8527```
8528int32_t OH_ArkUI_DragAction_SetTouchPointY (ArkUI_DragAction * dragAction, float y )
8529```
8530**描述:**
8531
8532设置跟手点,相对于设置的第一个pixelmap的左上角。
8533
8534**起始版本:** 12
8535
8536**参数:**
8537
8538| 名称 | 描述 |
8539| -------- | -------- |
8540| dragAction | 拖拽行为对象。  |
8541| y | 跟手点坐标y值。  |
8542
8543**返回:**
8544
8545ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
8546
8547
8548### OH_ArkUI_DragAction_UnregisterStatusListener()
8549
8550```
8551void OH_ArkUI_DragAction_UnregisterStatusListener (ArkUI_DragAction * dragAction)
8552```
8553**描述:**
8554
8555解注册拖拽状态监听回调。
8556
8557**起始版本:** 12
8558
8559**参数:**
8560
8561| 名称 | 描述 |
8562| -------- | -------- |
8563| dragAction | 拖拽行为对象。  |
8564
8565
8566### OH_ArkUI_DragAndDropInfo_GetDragEvent()
8567
8568```
8569ArkUI_DragEvent* OH_ArkUI_DragAndDropInfo_GetDragEvent (ArkUI_DragAndDropInfo * dragAndDropInfo)
8570```
8571**描述:**
8572
8573通过dragAndDropInfo获取到DragEvent,可通过DragEvent获取释放结果等。
8574
8575**起始版本:** 12
8576
8577**参数:**
8578
8579| 名称 | 描述 |
8580| -------- | -------- |
8581| dragAndDropInfo | 拖拽状态监听返回的拖拽相关信息。  |
8582
8583**返回:**
8584
8585ArkUI_DragEvent 拖拽事件,如果获取失败,则返回空。
8586
8587
8588### OH_ArkUI_DragAndDropInfo_GetDragStatus()
8589
8590```
8591ArkUI_DragStatus OH_ArkUI_DragAndDropInfo_GetDragStatus (ArkUI_DragAndDropInfo * dragAndDropInfo)
8592```
8593**描述:**
8594
8595获取dragaction发起拖拽的状态,获取异常时返回 ArkUI_DRAG_STATUS_UNKNOWN。
8596
8597**起始版本:** 12
8598
8599**参数:**
8600
8601| 名称 | 描述 |
8602| -------- | -------- |
8603| dragAndDropInfo | 拖拽状态监听返回的拖拽相关信息。  |
8604
8605**返回:**
8606
8607ArkUI_DragStatus 拖拽状态,如果获取失败,返回默认值 ArkUI_DRAG_STATUS_UNKNOWN。
8608
8609
8610### OH_ArkUI_DragEvent_DisableDefaultDropAnimation()
8611
8612```
8613int32_t OH_ArkUI_DragEvent_DisableDefaultDropAnimation (ArkUI_DragEvent * event, bool disable )
8614```
8615**描述:**
8616
8617设置是否禁用松手时的系统默认动效,默认不禁用,通常在应用需要自定义落位动效时配置。
8618
8619**起始版本:** 12
8620
8621**参数:**
8622
8623| 名称 | 描述 |
8624| -------- | -------- |
8625| event | ArkUI_DragEvent事件指针。  |
8626| disable | 是否禁用松手时的系统默认动效,true禁用,false不禁用。  |
8627
8628**返回:**
8629
8630ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
8631
8632
8633### OH_ArkUI_DragEvent_GetDataTypes()
8634
8635```
8636int32_t OH_ArkUI_DragEvent_GetDataTypes (ArkUI_DragEvent * event, char * eventTypeArray[], int32_t length, int32_t maxStrLen)
8637```
8638**描述:**
8639
8640从ArkUI_DragEvent中获取拖拽数据的类型列表。
8641
8642**起始版本:** 12
8643
8644**参数:**
8645
8646| 名称 | 描述 |
8647| -------- | -------- |
8648| event | ArkUI_DragEvent事件指针。  |
8649| char | eventTypeArray 返回拖拽数据的类型列表,需要先自行创建字符串数组。  |
8650| length | 数组总长度,不应少于使用[OH_ArkUI_DragEvent_GetDataTypeCount](#oh_arkui_dragevent_getdatatypecount)获取到的数量。  |
8651| maxStrLen | 拖拽数据类型的最大字符串长度。  |
8652
8653**返回:**
8654
8655ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR 缓冲区大小不足。
8656
8657
8658### OH_ArkUI_DragEvent_GetDataTypeCount()
8659
8660```
8661int32_t OH_ArkUI_DragEvent_GetDataTypeCount (ArkUI_DragEvent * event, int32_t * count )
8662```
8663**描述:**
8664
8665从ArkUI_DragEvent中获取所拖拽的数据类型种类个数。
8666
8667**起始版本:** 12
8668
8669**参数:**
8670
8671| 名称 | 描述 |
8672| -------- | -------- |
8673| event | ArkUI_DragEvent事件指针。  |
8674| count | 出参,返回所拖拽数据的类型的数量。  |
8675
8676**返回:**
8677
8678ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
8679
8680
8681### OH_ArkUI_DragEvent_GetDragResult()
8682
8683```
8684int32_t OH_ArkUI_DragEvent_GetDragResult (ArkUI_DragEvent * event, ArkUI_DragResult * result )
8685```
8686**描述:**
8687
8688从ArkUI_DragEvent中获取拖拽结果。
8689
8690**起始版本:** 12
8691
8692**参数:**
8693
8694| 名称 | 描述 |
8695| -------- | -------- |
8696| event | ArkUI_DragEvent事件指针。  |
8697| result | 出参,返回拖拽事件对应的拖拽结果。  |
8698
8699**返回:**
8700
8701ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
8702
8703
8704### OH_ArkUI_DragEvent_GetDropOperation()
8705
8706```
8707int32_t OH_ArkUI_DragEvent_GetDropOperation (ArkUI_DragEvent * event, ArkUI_DropOperation * operation)
8708```
8709**描述:**
8710
8711从ArkUI_DragEvent中获取数据处理方式。
8712
8713**起始版本:** 12
8714
8715**参数:**
8716
8717| 名称 | 描述 |
8718| -------- | -------- |
8719| event | ArkUI_DragEvent事件指针。  |
8720| operation | 出参,返回拖拽事件对应的数据处理方式。  |
8721
8722**返回:**
8723
8724ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
8725
8726
8727### OH_ArkUI_DragEvent_GetModifierKeyStates()
8728
8729```
8730int32_t OH_ArkUI_DragEvent_GetModifierKeyStates (ArkUI_DragEvent * event, uint64_t * keys )
8731```
8732**描述:**
8733
8734获取功能键按压状态。
8735
8736**起始版本:** 12
8737
8738**参数:**
8739
8740| 名称 | 描述 |
8741| -------- | -------- |
8742| event | ArkUI_DragEvent事件指针。  |
8743| keys | 返回当前处于按下状态的 modifier key组合,应用可通过位运算进行判断。  |
8744
8745**返回:**
8746
8747ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
8748
8749
8750### OH_ArkUI_DragEvent_GetPreviewRectHeight()
8751
8752```
8753float OH_ArkUI_DragEvent_GetPreviewRectHeight (ArkUI_DragEvent * event)
8754```
8755**描述:**
8756
8757从ArkUI_DragEvent中获取预览图的高。
8758
8759**起始版本:** 12
8760
8761**参数:**
8762
8763| 名称 | 描述 |
8764| -------- | -------- |
8765| event | ArkUI_DragEvent事件指针。  |
8766
8767**返回:**
8768
8769float 返回拖拽跟手图高度,单位为PX,传入参数无效时返回默认值 0。
8770
8771
8772### OH_ArkUI_DragEvent_GetPreviewRectWidth()
8773
8774```
8775float OH_ArkUI_DragEvent_GetPreviewRectWidth (ArkUI_DragEvent * event)
8776```
8777**描述:**
8778
8779从ArkUI_DragEvent中获取预览图的宽。
8780
8781**起始版本:** 12
8782
8783**参数:**
8784
8785| 名称 | 描述 |
8786| -------- | -------- |
8787| event | ArkUI_DragEvent事件指针。  |
8788
8789**返回:**
8790
8791float 返回拖拽跟手图宽度,单位为PX,传入参数无效时返回默认值 0。
8792
8793
8794### OH_ArkUI_DragEvent_GetPreviewTouchPointX()
8795
8796```
8797float OH_ArkUI_DragEvent_GetPreviewTouchPointX (ArkUI_DragEvent * event)
8798```
8799**描述:**
8800
8801从ArkUI_DragEvent中获取预览图跟手点的x轴坐标。
8802
8803**起始版本:** 12
8804
8805**参数:**
8806
8807| 名称 | 描述 |
8808| -------- | -------- |
8809| event | ArkUI_DragEvent事件指针。  |
8810
8811**返回:**
8812
8813float 返回拖拽跟手点的x轴坐标,单位为PX,传入参数无效时返回默认值 0。
8814
8815
8816### OH_ArkUI_DragEvent_GetPreviewTouchPointY()
8817
8818```
8819float OH_ArkUI_DragEvent_GetPreviewTouchPointY (ArkUI_DragEvent * event)
8820```
8821**描述:**
8822
8823从ArkUI_DragEvent中获取预览图跟手点的y轴坐标。
8824
8825**起始版本:** 12
8826
8827**参数:**
8828
8829| 名称 | 描述 |
8830| -------- | -------- |
8831| event | ArkUI_DragEvent事件指针。  |
8832
8833**返回:**
8834
8835float 返回拖拽跟手点的y轴坐标,单位为PX,传入参数无效时返回默认值 0。
8836
8837
8838### OH_ArkUI_DragEvent_GetTouchPointXToDisplay()
8839
8840```
8841float OH_ArkUI_DragEvent_GetTouchPointXToDisplay (ArkUI_DragEvent * event)
8842```
8843**描述:**
8844
8845从ArkUI_DragEvent中获取跟手点相对于当前Display的x轴坐标。
8846
8847**起始版本:** 12
8848
8849**参数:**
8850
8851| 名称 | 描述 |
8852| -------- | -------- |
8853| event | ArkUI_DragEvent事件指针。  |
8854
8855**返回:**
8856
8857float 返回拖拽跟手点相对于当前Display的x轴坐标,单位为PX,传入参数无效时返回默认值 0。
8858
8859
8860### OH_ArkUI_DragEvent_GetTouchPointXToWindow()
8861
8862```
8863float OH_ArkUI_DragEvent_GetTouchPointXToWindow (ArkUI_DragEvent * event)
8864```
8865**描述:**
8866
8867从ArkUI_DragEvent中获取跟手点相对于window的x轴坐标。
8868
8869**起始版本:** 12
8870
8871**参数:**
8872
8873| 名称 | 描述 |
8874| -------- | -------- |
8875| event | ArkUI_DragEvent事件指针。  |
8876
8877**返回:**
8878
8879float 返回跟手点相对于window的x轴坐标,单位为PX,传入参数无效时返回默认值 0。
8880
8881
8882### OH_ArkUI_DragEvent_GetTouchPointYToDisplay()
8883
8884```
8885float OH_ArkUI_DragEvent_GetTouchPointYToDisplay (ArkUI_DragEvent * event)
8886```
8887**描述:**
8888
8889从ArkUI_DragEvent中获取跟手点相对于当前Display的y轴坐标。
8890
8891**起始版本:** 12
8892
8893**参数:**
8894
8895| 名称 | 描述 |
8896| -------- | -------- |
8897| event | ArkUI_DragEvent事件指针。  |
8898
8899**返回:**
8900
8901float 返回拖拽跟手点相对于当前Display的y轴坐标,单位为PX,传入参数无效时返回默认值 0。
8902
8903
8904### OH_ArkUI_DragEvent_GetTouchPointYToWindow()
8905
8906```
8907float OH_ArkUI_DragEvent_GetTouchPointYToWindow (ArkUI_DragEvent * event)
8908```
8909**描述:**
8910
8911从ArkUI_DragEvent中获取跟手点相对于window的y轴坐标。
8912
8913**起始版本:** 12
8914
8915**参数:**
8916
8917| 名称 | 描述 |
8918| -------- | -------- |
8919| event | ArkUI_DragEvent事件指针。  |
8920
8921**返回:**
8922
8923float 返回跟手点相对于window的y轴坐标,单位为PX,传入参数无效时返回默认值 0。
8924
8925
8926### OH_ArkUI_DragEvent_GetUdmfData()
8927
8928```
8929int32_t OH_ArkUI_DragEvent_GetUdmfData (ArkUI_DragEvent * event, OH_UdmfData * data )
8930```
8931**描述:**
8932
8933从ArkUI_DragEvent中获取拖拽默认相关数据。
8934
8935**起始版本:** 12
8936
8937**参数:**
8938
8939| 名称 | 描述 |
8940| -------- | -------- |
8941| event | ArkUI_DragEvent事件指针。  |
8942| data | OH_UdmfData 拖拽的数据指针,应用在接收时需通过 **OH_UdmfData_Create** 方法创建一个用于接收数据的指针。  |
8943
8944**返回:**
8945
8946ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
8947
8948
8949### OH_ArkUI_DragEvent_GetVelocity()
8950
8951```
8952float OH_ArkUI_DragEvent_GetVelocity (ArkUI_DragEvent * event)
8953```
8954**描述:**
8955
8956获取当前拖拽的主方向拖动速度。
8957
8958**起始版本:** 12
8959
8960**参数:**
8961
8962| 名称 | 描述 |
8963| -------- | -------- |
8964| event | ArkUI_DragEvent事件指针。  |
8965
8966**返回:**
8967
8968float 返回当前拖拽移动速度,单位为PX/s,传入参数无效时返回默认值 0。
8969
8970
8971### OH_ArkUI_DragEvent_GetVelocityX()
8972
8973```
8974float OH_ArkUI_DragEvent_GetVelocityX (ArkUI_DragEvent * event)
8975```
8976**描述:**
8977
8978获取当前拖拽的x轴方向拖动速度。
8979
8980**起始版本:** 12
8981
8982**参数:**
8983
8984| 名称 | 描述 |
8985| -------- | -------- |
8986| event | ArkUI_DragEvent事件指针。  |
8987
8988**返回:**
8989
8990float 返回当前拖拽的x轴方向移动速度,单位为PX/s,传入参数无效时返回默认值 0。
8991
8992
8993### OH_ArkUI_DragEvent_GetVelocityY()
8994
8995```
8996float OH_ArkUI_DragEvent_GetVelocityY (ArkUI_DragEvent * event)
8997```
8998**描述:**
8999
9000获取当前拖拽的y轴方向拖动速度。
9001
9002**起始版本:** 12
9003
9004**参数:**
9005
9006| 名称 | 描述 |
9007| -------- | -------- |
9008| event | ArkUI_DragEvent事件指针。  |
9009
9010**返回:**
9011
9012float 返回当前拖拽的y轴方向移动速度,单位为PX/s,传入参数无效时返回默认值 0。
9013
9014
9015### OH_ArkUI_DragEvent_SetData()
9016
9017```
9018int32_t OH_ArkUI_DragEvent_SetData (ArkUI_DragEvent * event, OH_UdmfData * data )
9019```
9020**描述:**
9021
9022向ArkUI_DragEvent中设置拖拽数据。
9023
9024**起始版本:** 12
9025
9026**参数:**
9027
9028| 名称 | 描述 |
9029| -------- | -------- |
9030| event | ArkUI_DragEvent事件指针。  |
9031| data | 拖拽数据。  |
9032
9033**返回:**
9034
9035ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
9036
9037
9038### OH_ArkUI_DragEvent_SetDragResult()
9039
9040```
9041int32_t OH_ArkUI_DragEvent_SetDragResult (ArkUI_DragEvent * event, ArkUI_DragResult result )
9042```
9043**描述:**
9044
9045设置拖拽事件的结果。
9046
9047**起始版本:** 12
9048
9049**参数:**
9050
9051| 名称 | 描述 |
9052| -------- | -------- |
9053| event | ArkUI_DragEvent事件指针。  |
9054| result | 拖拽数据处理结果。  |
9055
9056**返回:**
9057
9058ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
9059
9060
9061### OH_ArkUI_DragEvent_SetSuggestedDropOperation()
9062
9063```
9064int32_t OH_ArkUI_DragEvent_SetSuggestedDropOperation (ArkUI_DragEvent * event, ArkUI_DropOperation dropOperation)
9065```
9066**描述:**
9067
9068设置数据处理方式
9069
9070**起始版本:** 12
9071
9072**参数:**
9073
9074| 名称 | 描述 |
9075| -------- | -------- |
9076| proposal | 设置建议的数据处理方式。  |
9077| proposal | 角标显示状态的类型。  |
9078
9079**返回:**
9080
9081ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
9082
9083
9084### OH_ArkUI_DragPreviewOption_Dispose()
9085
9086```
9087void OH_ArkUI_DragPreviewOption_Dispose (ArkUI_DragPreviewOption * option)
9088```
9089**描述:**
9090
9091销毁跟手图自定义参数对象实例。
9092
9093**起始版本:** 12
9094
9095**参数:**
9096
9097| 名称 | 描述 |
9098| -------- | -------- |
9099| option | 自定义参数。  |
9100
9101
9102### OH_ArkUI_DragPreviewOption_SetBadgeNumber()
9103
9104```
9105int32_t OH_ArkUI_DragPreviewOption_SetBadgeNumber (ArkUI_DragPreviewOption * option, uint32_t forcedNumber )
9106```
9107**描述:**
9108
9109强制显示角标的数量,覆盖SetDragPreviewNumberBadgeEnabled设置的值。
9110
9111**起始版本:** 12
9112
9113**参数:**
9114
9115| 名称 | 描述 |
9116| -------- | -------- |
9117| option | 自定义参数。  |
9118| forcedNumber | 角标的数量。  |
9119
9120**返回:**
9121
9122ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
9123
9124
9125### OH_ArkUI_DragPreviewOption_SetDefaultAnimationBeforeLiftingEnabled()
9126
9127```
9128int32_t OH_ArkUI_DragPreviewOption_SetDefaultAnimationBeforeLiftingEnabled (ArkUI_DragPreviewOption * option, bool enabled )
9129```
9130**描述:**
9131
9132配置是否开启点按时的默认动画。
9133
9134**起始版本:** 12
9135
9136**参数:**
9137
9138| 名称 | 描述 |
9139| -------- | -------- |
9140| option | 自定义参数。  |
9141| enabled | 是否开启默认点按效果。  |
9142
9143**返回:**
9144
9145ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
9146
9147
9148### OH_ArkUI_DragPreviewOption_SetDefaultRadiusEnabled()
9149
9150```
9151int32_t OH_ArkUI_DragPreviewOption_SetDefaultRadiusEnabled (ArkUI_DragPreviewOption * option, bool enabled )
9152```
9153**描述:**
9154
9155设置跟手图背板默认的圆角效果,默认不开启。
9156
9157**起始版本:** 12
9158
9159**参数:**
9160
9161| 名称 | 描述 |
9162| -------- | -------- |
9163| option | 自定义参数。  |
9164| enabled | 是否开启圆角效果显示。  |
9165
9166**返回:**
9167
9168ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
9169
9170
9171### OH_ArkUI_DragPreviewOption_SetDefaultShadowEnabled()
9172
9173```
9174int32_t OH_ArkUI_DragPreviewOption_SetDefaultShadowEnabled (ArkUI_DragPreviewOption * option, bool enabled )
9175```
9176**描述:**
9177
9178设置跟手图背板默认的投影效果,默认不开启。
9179
9180**起始版本:** 12
9181
9182**参数:**
9183
9184| 名称 | 描述 |
9185| -------- | -------- |
9186| option | 自定义参数。  |
9187| enabled | 是否使用默认投影效果。  |
9188
9189**返回:**
9190
9191ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
9192
9193
9194### OH_ArkUI_DragPreviewOption_SetNumberBadgeEnabled()
9195
9196```
9197int32_t OH_ArkUI_DragPreviewOption_SetNumberBadgeEnabled (ArkUI_DragPreviewOption * option, bool enabled )
9198```
9199**描述:**
9200
9201设置跟手图背板是否显示角标,开启后,系统会根据拖拽数量自动进行角标显示。
9202
9203**起始版本:** 12
9204
9205**参数:**
9206
9207| 名称 | 描述 |
9208| -------- | -------- |
9209| option | 自定义参数。  |
9210| enabled | 是否开启角标显示。  |
9211
9212**返回:**
9213
9214ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
9215
9216
9217### OH_ArkUI_DragPreviewOption_SetScaleMode()
9218
9219```
9220int32_t OH_ArkUI_DragPreviewOption_SetScaleMode (ArkUI_DragPreviewOption * option, ArkUI_DragPreviewScaleMode scaleMode )
9221```
9222**描述:**
9223
9224设置拖拽跟手图是否根据系统定义自动进行缩放。
9225
9226**起始版本:** 12
9227
9228**参数:**
9229
9230| 名称 | 描述 |
9231| -------- | -------- |
9232| option | 自定义参数。  |
9233| scaleMode | 设置组件拖拽过程中的跟手图缩放模式。  |
9234
9235**返回:**
9236
9237ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
9238
9239
9240### OH_ArkUI_DrawableDescriptor_CreateFromAnimatedPixelMap()
9241
9242```
9243ArkUI_DrawableDescriptor* OH_ArkUI_DrawableDescriptor_CreateFromAnimatedPixelMap (OH_PixelmapNativeHandle * array, int32_t size )
9244```
9245**描述:**
9246
9247使用 PixelMap 图片数组创建DrawableDescriptor 对象。
9248
9249**起始版本:** 12
9250
9251**参数:**
9252
9253| 名称 | 描述 |
9254| -------- | -------- |
9255| array | PixelMap 图片数组对象指针。  |
9256| size | PixelMap 图片数组大小。  |
9257
9258**返回:**
9259
9260返回 DrawableDescriptor 对象指针。
9261
9262
9263### OH_ArkUI_DrawableDescriptor_CreateFromPixelMap()
9264
9265```
9266ArkUI_DrawableDescriptor* OH_ArkUI_DrawableDescriptor_CreateFromPixelMap (OH_PixelmapNativeHandle pixelMap)
9267```
9268**描述:**
9269
9270使用 PixelMap 创建 DrawableDescriptor 对象。
9271
9272**起始版本:** 12
9273
9274**参数:**
9275
9276| 名称 | 描述 |
9277| -------- | -------- |
9278| pixelMap | PixelMap 对象指针。  |
9279
9280**返回:**
9281
9282返回 DrawableDescriptor 对象指针。
9283
9284
9285### OH_ArkUI_DrawableDescriptor_Dispose()
9286
9287```
9288void OH_ArkUI_DrawableDescriptor_Dispose (ArkUI_DrawableDescriptor * drawableDescriptor)
9289```
9290**描述:**
9291
9292销毁 DrawableDescriptor 对象指针。
9293
9294**起始版本:** 12
9295
9296**参数:**
9297
9298| 名称 | 描述 |
9299| -------- | -------- |
9300| drawableDescriptor | DrawableDescriptor 对象指针。  |
9301
9302
9303### OH_ArkUI_DrawableDescriptor_GetAnimatedPixelMapArray()
9304
9305```
9306OH_PixelmapNativeHandle* OH_ArkUI_DrawableDescriptor_GetAnimatedPixelMapArray (ArkUI_DrawableDescriptor * drawableDescriptor)
9307```
9308**描述:**
9309
9310获取用于播放动画的 PixelMap 图片数组数据。
9311
9312**起始版本:** 12
9313
9314**参数:**
9315
9316| 名称 | 描述 |
9317| -------- | -------- |
9318| drawableDescriptor | DrawableDescriptor 对象指针。  |
9319
9320**返回:**
9321
9322PixelMap 图片数组指针。
9323
9324
9325### OH_ArkUI_DrawableDescriptor_GetAnimatedPixelMapArraySize()
9326
9327```
9328int32_t OH_ArkUI_DrawableDescriptor_GetAnimatedPixelMapArraySize (ArkUI_DrawableDescriptor * drawableDescriptor)
9329```
9330**描述:**
9331
9332获取用于播放动画的 PixelMap 图片数组数据。
9333
9334**起始版本:** 12
9335
9336**参数:**
9337
9338| 名称 | 描述 |
9339| -------- | -------- |
9340| drawableDescriptor | DrawableDescriptor 对象指针。  |
9341
9342**返回:**
9343
9344PixelMap 图片数组大小。
9345
9346
9347### OH_ArkUI_DrawableDescriptor_GetAnimationDuration()
9348
9349```
9350int32_t OH_ArkUI_DrawableDescriptor_GetAnimationDuration (ArkUI_DrawableDescriptor * drawableDescriptor)
9351```
9352**描述:**
9353
9354获取 PixelMap 图片数组播放总时长。
9355
9356**起始版本:** 12
9357
9358**参数:**
9359
9360| 名称 | 描述 |
9361| -------- | -------- |
9362| drawableDescriptor | DrawableDescriptor 对象指针。  |
9363
9364**返回:**
9365
9366播放总时长,单位毫秒。
9367
9368
9369### OH_ArkUI_DrawableDescriptor_GetAnimationIteration()
9370
9371```
9372int32_t OH_ArkUI_DrawableDescriptor_GetAnimationIteration (ArkUI_DrawableDescriptor * drawableDescriptor)
9373```
9374**描述:**
9375
9376获取 PixelMap 图片数组播放次数。
9377
9378**起始版本:** 12
9379
9380**参数:**
9381
9382| 名称 | 描述 |
9383| -------- | -------- |
9384| drawableDescriptor | DrawableDescriptor 对象指针。  |
9385
9386**返回:**
9387
9388播放次数。
9389
9390
9391### OH_ArkUI_DrawableDescriptor_GetStaticPixelMap()
9392
9393```
9394OH_PixelmapNativeHandle OH_ArkUI_DrawableDescriptor_GetStaticPixelMap (ArkUI_DrawableDescriptor * drawableDescriptor)
9395```
9396**描述:**
9397
9398获取 PixelMap 图片对象指针。
9399
9400**起始版本:** 12
9401
9402**参数:**
9403
9404| 名称 | 描述 |
9405| -------- | -------- |
9406| drawableDescriptor | DrawableDescriptor 对象指针。  |
9407
9408**返回:**
9409
9410PixelMap 对象指针。
9411
9412
9413### OH_ArkUI_DrawableDescriptor_SetAnimationDuration()
9414
9415```
9416void OH_ArkUI_DrawableDescriptor_SetAnimationDuration (ArkUI_DrawableDescriptor * drawableDescriptor, int32_t duration )
9417```
9418**描述:**
9419
9420设置 PixelMap 图片数组播放总时长。
9421
9422**起始版本:** 12
9423
9424**参数:**
9425
9426| 名称 | 描述 |
9427| -------- | -------- |
9428| drawableDescriptor | DrawableDescriptor 对象指针。  |
9429| duration | 播放总时长,单位毫秒。  |
9430
9431
9432### OH_ArkUI_DrawableDescriptor_SetAnimationIteration()
9433
9434```
9435void OH_ArkUI_DrawableDescriptor_SetAnimationIteration (ArkUI_DrawableDescriptor * drawableDescriptor, int32_t iteration )
9436```
9437**描述:**
9438
9439设置 PixelMap 图片数组播放次数。
9440
9441**起始版本:** 12
9442
9443**参数:**
9444
9445| 名称 | 描述 |
9446| -------- | -------- |
9447| drawableDescriptor | DrawableDescriptor 对象指针。  |
9448| iterations | 播放次数。  |
9449
9450
9451### OH_ArkUI_DrawContext_GetCanvas()
9452
9453```
9454void* OH_ArkUI_DrawContext_GetCanvas (ArkUI_DrawContext * context)
9455```
9456**描述:**
9457
9458获取绘制canvas指针,可以转换为图形库的OH_Drawing_Canvas指针进行绘制。
9459
9460**起始版本:** 12
9461
9462**参数:**
9463
9464| 名称 | 描述 |
9465| -------- | -------- |
9466| context | 绘制上下文。  |
9467
9468**返回:**
9469
9470用于绘制的canvas指针。
9471
9472
9473### OH_ArkUI_DrawContext_GetSize()
9474
9475```
9476ArkUI_IntSize OH_ArkUI_DrawContext_GetSize (ArkUI_DrawContext * context)
9477```
9478**描述:**
9479
9480获取可绘制区域大小。
9481
9482**起始版本:** 12
9483
9484**参数:**
9485
9486| 名称 | 描述 |
9487| -------- | -------- |
9488| context | 绘制上下文。  |
9489
9490**返回:**
9491
9492可绘制区域大小。
9493
9494### OH_ArkUI_FocusActivate()
9495```
9496void OH_ArkUI_FocusActivate(ArkUI_ContextHandle uiContext, bool isActive, bool isAutoInactive);
9497```
9498**描述:**
9499
9500设置当前界面的焦点激活态,获焦节点显示焦点框。
9501
9502**起始版本:** 15
9503
9504**参数:**
9505
9506| 名称 | 描述 |
9507| -------- | -------- |
9508| uiContext | UI实例对象指针。 |
9509| isActive | 设置是否进入/退出焦点激活态。 |
9510| isAutoInactive | 当触摸事件或鼠标按下事件触发时,"true" 表示将状态设置为退出焦点激活态,"false" 表示在调用对应设置API前,保持当前状态。|
9511
9512### OH_ArkUI_FocusClear()
9513```
9514void OH_ArkUI_FocusClear(ArkUI_ContextHandle uiContext);
9515```
9516**描述:**
9517
9518将当前焦点清除到根容器节点。
9519
9520**起始版本:** 15
9521
9522**参数:**
9523
9524| 名称 | 描述 |
9525| -------- | -------- |
9526| uiContext | UI实例对象指针。 |
9527
9528### OH_ArkUI_FocusRequest()
9529```
9530ArkUI_ErrorCode OH_ArkUI_FocusRequest(ArkUI_NodeHandle node);
9531```
9532**描述:**
9533
9534请求焦点。
9535
9536**起始版本:** 15
9537
9538**参数:**
9539
9540| 名称 | 描述 |
9541| -------- | -------- |
9542| node | 组件节点指针。  |
9543
9544### OH_ArkUI_FocusSetAutoTransfer()
9545```
9546void OH_ArkUI_FocusSetAutoTransfer(ArkUI_ContextHandle uiContext, bool autoTransfer);
9547```
9548**描述:**
9549
9550 设置页面切换时,焦点转移行为。
9551
9552**起始版本:** 15
9553
9554**参数:**
9555
9556| 名称 | 描述 |
9557| -------- | -------- |
9558| uiContext | UI实例对象指针。 |
9559| autoTransfer | 页面切换时,是否转移焦点。 |
9560
9561### OH_ArkUI_FocusSetKeyProcessingMode()
9562```
9563void OH_ArkUI_FocusSetKeyProcessingMode(ArkUI_ContextHandle uiContext, ArkUI_KeyProcessingMode mode)
9564```
9565**描述:**
9566
9567设置按键事件处理的优先级。
9568
9569**起始版本:** 15
9570
9571**参数:**
9572
9573| 名称 | 描述 |
9574| -------- | -------- |
9575| uiContext | UI实例对象指针。 |
9576| mode | 按键处理模式。 |
9577
9578### OH_ArkUI_GestureEvent_GetActionType()
9579
9580```
9581ArkUI_GestureEventActionType OH_ArkUI_GestureEvent_GetActionType (const ArkUI_GestureEvent * event)
9582```
9583**描述:**
9584
9585返回手势事件类型。
9586
9587**起始版本:** 12
9588
9589**参数:**
9590
9591| 名称 | 描述 |
9592| -------- | -------- |
9593| event | 手势事件。  |
9594
9595**返回:**
9596
9597手势事件类型。
9598
9599
9600### OH_ArkUI_GestureEvent_GetNode()
9601
9602```
9603ArkUI_NodeHandle OH_ArkUI_GestureEvent_GetNode (const ArkUI_GestureEvent * event)
9604```
9605**描述:**
9606
9607获取被绑定手势的ARKUI组件。
9608
9609**起始版本:** 12
9610
9611**参数:**
9612
9613| 名称 | 描述 |
9614| -------- | -------- |
9615| event | 手势事件。  |
9616
9617**返回:**
9618
9619ARKUI组件。
9620
9621
9622### OH_ArkUI_GestureEvent_GetRawInputEvent()
9623
9624```
9625const ArkUI_UIInputEvent* OH_ArkUI_GestureEvent_GetRawInputEvent (const ArkUI_GestureEvent * event)
9626```
9627**描述:**
9628
9629返回手势输入。
9630
9631**起始版本:** 12
9632
9633**参数:**
9634
9635| 名称 | 描述 |
9636| -------- | -------- |
9637| event | 手势事件。  |
9638
9639**返回:**
9640
9641手势事件的原始输入事件。
9642
9643
9644### OH_ArkUI_GestureEventTargetInfo_IsScrollBegin()
9645
9646```
9647int32_t OH_ArkUI_GestureEventTargetInfo_IsScrollBegin (ArkUI_GestureEventTargetInfo * info, bool * ret )
9648```
9649**描述:**
9650
9651当前滚动类容器组件是否在顶部。
9652
9653**起始版本:** 12
9654
9655**参数:**
9656
9657| 名称 | 描述 |
9658| -------- | -------- |
9659| info | 手势事件目标信息。  |
9660| ret | 当前滚动类容器组件是否在顶部。  |
9661
9662**返回:**
9663
9664[ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md#arkui_errorcode) - 成功。 [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md#arkui_errorcode) - 参数错误。 [ARKUI_ERROR_CODE_NON_SCROLLABLE_CONTAINER](_ark_u_i___native_module.md#arkui_errorcode) - 非滚动类容器。
9665
9666
9667### OH_ArkUI_GestureEventTargetInfo_IsScrollEnd()
9668
9669```
9670int32_t OH_ArkUI_GestureEventTargetInfo_IsScrollEnd (ArkUI_GestureEventTargetInfo * info, bool * ret )
9671```
9672**描述:**
9673
9674当前滚动类容器组件是否在底部。
9675
9676**起始版本:** 12
9677
9678**参数:**
9679
9680| 名称 | 描述 |
9681| -------- | -------- |
9682| info | 手势事件目标信息。  |
9683| ret | 当前滚动类容器组件是否在底部。  |
9684
9685**返回:**
9686
9687[ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md#arkui_errorcode) - 成功。 [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md#arkui_errorcode) - 参数错误。 [ARKUI_ERROR_CODE_NON_SCROLLABLE_CONTAINER](_ark_u_i___native_module.md#arkui_errorcode) - 非滚动类容器。
9688
9689
9690### OH_ArkUI_GestureInterruptInfo_GetGestureEvent()
9691
9692```
9693ArkUI_GestureEvent* OH_ArkUI_GestureInterruptInfo_GetGestureEvent (const ArkUI_GestureInterruptInfo * event)
9694```
9695**描述:**
9696
9697返回打断的手势事件数据。
9698
9699**起始版本:** 12
9700
9701**参数:**
9702
9703| 名称 | 描述 |
9704| -------- | -------- |
9705| event | 打断回调事件。  |
9706
9707**返回:**
9708
9709打断的手势事件数据。
9710
9711### OH_ArkUI_GestureInterruptInfo_GetRecognizer()
9712
9713```
9714ArkUI_GestureRecognizer* OH_ArkUI_GestureInterruptInfo_GetRecognizer (const ArkUI_GestureInterruptInfo * event)
9715```
9716**描述:**
9717
9718返回被打断的手势指针。
9719
9720**起始版本:** 12
9721
9722**参数:**
9723
9724| 名称 | 描述 |
9725| -------- | -------- |
9726| event | 打断回调事件。  |
9727
9728**返回:**
9729
9730被打断的手势指针。
9731
9732
9733### OH_ArkUI_GestureInterruptInfo_GetSystemFlag()
9734
9735```
9736bool OH_ArkUI_GestureInterruptInfo_GetSystemFlag (const ArkUI_GestureInterruptInfo * event)
9737```
9738**描述:**
9739
9740判断是否组件内置手势。
9741
9742**起始版本:** 12
9743
9744**参数:**
9745
9746| 名称 | 描述 |
9747| -------- | -------- |
9748| event | 手势打断回调事件。  |
9749
9750**返回:**
9751
9752true: 系统内置手势; false: 非系统内置手势。
9753
9754
9755### OH_ArkUI_GestureInterruptInfo_GetSystemRecognizerType()
9756
9757```
9758int32_t OH_ArkUI_GestureInterruptInfo_GetSystemRecognizerType (const ArkUI_GestureInterruptInfo * event)
9759```
9760**描述:**
9761
9762当要触发的是系统内部手势时,使用该方法可返回该系统内部手势的类型。
9763
9764**起始版本:** 12
9765
9766**参数:**
9767
9768| 名称 | 描述 |
9769| -------- | -------- |
9770| event | 打断回调事件。  |
9771
9772**返回:**
9773
9774要触发的内部手势对应的手势类型,如果当前触发的手势不是系统内部手势,则返回 -1。
9775
9776
9777### OH_ArkUI_GestureInterruptInfo_GetTouchRecognizers()
9778
9779```
9780int32_t OH_ArkUI_GestureInterruptInfo_GetTouchRecognizers(const ArkUI_GestureInterruptInfo* info,
9781    ArkUI_TouchRecognizerHandleArray* recognizers, int32_t* size)
9782```
9783**描述:**
9784
9785使用该方法可返回与该手势相关的所有触摸识别器。
9786
9787**起始版本:** 15
9788
9789**参数:**
9790
9791| 名称 | 描述 |
9792| -------- | -------- |
9793| info | 打断回调事件。  |
9794| recognizers | 指向触摸识别器数组的指针。  |
9795| size | 触摸识别器数组的大小。  |
9796
9797**返回:**
9798
9799[ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md#arkui_errorcode) - 成功。 [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md#arkui_errorcode) - 参数错误。
9800
9801
9802### OH_ArkUI_TouchRecognizer_GetNodeHandle()
9803
9804```
9805ArkUI_NodeHandle OH_ArkUI_TouchRecognizer_GetNodeHandle(const ArkUI_TouchRecognizerHandle recognizer)
9806```
9807**描述:**
9808
9809使用该方法可返回与触摸识别器绑定的组件句柄。
9810
9811**起始版本:** 15
9812
9813**参数:**
9814
9815| 名称 | 描述 |
9816| -------- | -------- |
9817| recognizer | 触摸识别器。  |
9818
9819**返回:**
9820
9821与触摸识别器绑定的组件句柄。
9822
9823
9824### OH_ArkUI_TouchRecognizer_CancelTouch()
9825
9826```
9827int32_t OH_ArkUI_TouchRecognizer_CancelTouch(ArkUI_TouchRecognizerHandle recognizer, ArkUI_GestureInterruptInfo* info)
9828```
9829**描述:**
9830
9831使用该方法向对应触摸识别器分发Cancel事件拦截后续触摸事件。
9832
9833**起始版本:** 15
9834
9835**参数:**
9836
9837| 名称 | 描述 |
9838| -------- | -------- |
9839| recognizer | 触摸识别器。  |
9840| info | 打断回调事件。  |
9841
9842**返回:**
9843
9844[ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md#arkui_errorcode) - 成功。 [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md#arkui_errorcode) - 参数错误。
9845
9846
9847### OH_ArkUI_GetContextByNode()
9848
9849```
9850ArkUI_ContextHandle OH_ArkUI_GetContextByNode (ArkUI_NodeHandle node)
9851```
9852**描述:**
9853
9854获取当前节点所在页面的UI的上下文实例对象指针。
9855
9856**起始版本:** 12
9857
9858**参数:**
9859
9860| 名称 | 描述 |
9861| -------- | -------- |
9862| node | 指定的节点。  |
9863
9864**返回:**
9865
9866UI的上下文实例对象指针。
9867
9868
9869### OH_ArkUI_GetContextFromNapiValue()
9870
9871```
9872int32_t OH_ArkUI_GetContextFromNapiValue (napi_env env, napi_value value, ArkUI_ContextHandle * context )
9873```
9874**描述:**
9875
9876获取ArkTS侧创建的UIContext对象映射到native侧的ArkUI_ContextHandle。
9877
9878**起始版本:** 12
9879
9880**参数:**
9881
9882| 名称 | 描述 |
9883| -------- | -------- |
9884| env | napi的环境指针。  |
9885| value | ArkTS侧创建的context对象。  |
9886| context | ArkUI_ContextHandle指针。  |
9887
9888**返回:**
9889
9890ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
9891
9892
9893### OH_ArkUI_GetDrawableDescriptorFromNapiValue()
9894
9895```
9896int32_t OH_ArkUI_GetDrawableDescriptorFromNapiValue (napi_env env, napi_value value, ArkUI_DrawableDescriptor ** drawableDescriptor )
9897```
9898**描述:**
9899
9900将ArkTS侧创建的DrawableDescriptor对象映射到native侧的ArkUI_DrawableDescriptor。
9901
9902**起始版本:** 12
9903
9904**参数:**
9905
9906| 名称 | 描述 |
9907| -------- | -------- |
9908| env | napi的环境指针。  |
9909| value | ArkTS侧创建的DrawableDescriptor对象。  |
9910| drawableDescriptor | 接受ArkUI_DrawableDescriptor指针的对象。  |
9911
9912**返回:**
9913
9914ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
9915
9916
9917### OH_ArkUI_GetDrawableDescriptorFromResourceNapiValue()
9918
9919```
9920int32_t OH_ArkUI_GetDrawableDescriptorFromResourceNapiValue (napi_env env, napi_value value, ArkUI_DrawableDescriptor ** drawableDescriptor )
9921```
9922**描述:**
9923
9924将ArkTS侧创建的$r资源对象映射到native侧的ArkUI_DrawableDescriptor。
9925
9926**起始版本:** 12
9927
9928**参数:**
9929
9930| 名称 | 描述 |
9931| -------- | -------- |
9932| env | napi的环境指针。  |
9933| value | ArkTS侧创建的$r资源对象。  |
9934| drawableDescriptor | 接受ArkUI_DrawableDescriptor指针的对象。  |
9935
9936**返回:**
9937
9938ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
9939
9940
9941### OH_ArkUI_GetGestureBindNodeId()
9942
9943```
9944int32_t OH_ArkUI_GetGestureBindNodeId (ArkUI_GestureRecognizer * recognizer, char * nodeId, int32_t size, int32_t * result )
9945```
9946**描述:**
9947
9948获取手势识别器绑定的组件的ID。
9949
9950**起始版本:** 12
9951
9952**参数:**
9953
9954| 名称 | 描述 |
9955| -------- | -------- |
9956| recognizer | 手势识别器指针。  |
9957| nodeId | 组件的ID。  |
9958| size | 存储区大小。  |
9959| result | 拷贝的字符串长度。  |
9960
9961**返回:**
9962
9963[ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md#arkui_errorcode) - 成功。 [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md#arkui_errorcode) - 参数错误。 [ARKUI_ERROR_CODE_BUFFER_SIZE_NOT_ENOUGH](_ark_u_i___native_module.md#arkui_errorcode) - 存储区大小不足。
9964
9965
9966### OH_ArkUI_GetGestureEventTargetInfo()
9967
9968```
9969int32_t OH_ArkUI_GetGestureEventTargetInfo (ArkUI_GestureRecognizer * recognizer, ArkUI_GestureEventTargetInfo ** info )
9970```
9971**描述:**
9972
9973获取手势事件目标信息。
9974
9975**起始版本:** 12
9976
9977**参数:**
9978
9979| 名称 | 描述 |
9980| -------- | -------- |
9981| recognizer | 手势识别器指针。  |
9982| info | 手势事件目标信息。  |
9983
9984**返回:**
9985
9986[ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md#arkui_errorcode) - 成功。 [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md#arkui_errorcode) - 参数错误。
9987
9988
9989### OH_ArkUI_GetGestureRecognizerEnabled()
9990
9991```
9992bool OH_ArkUI_GetGestureRecognizerEnabled (ArkUI_GestureRecognizer * recognizer)
9993```
9994**描述:**
9995
9996获取手势识别器的使能状态。
9997
9998**起始版本:** 12
9999
10000**参数:**
10001
10002| 名称 | 描述 |
10003| -------- | -------- |
10004| recognizer | 手势识别器指针。  |
10005
10006**返回:**
10007
10008true - 使能。 false - 禁用。
10009
10010
10011### OH_ArkUI_GetGestureRecognizerState()
10012
10013```
10014int32_t OH_ArkUI_GetGestureRecognizerState (ArkUI_GestureRecognizer * recognizer, ArkUI_GestureRecognizerState * state )
10015```
10016**描述:**
10017
10018获取手势识别器的状态。
10019
10020**起始版本:** 12
10021
10022**参数:**
10023
10024| 名称 | 描述 |
10025| -------- | -------- |
10026| recognizer | 手势识别器指针。  |
10027| state | 手势识别器的状态。  |
10028
10029**返回:**
10030
10031[ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md#arkui_errorcode) - 成功。 [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md#arkui_errorcode) - 参数错误。
10032
10033
10034### OH_ArkUI_GetGestureTag()
10035
10036```
10037int32_t OH_ArkUI_GetGestureTag (ArkUI_GestureRecognizer * recognizer, char * buffer, int32_t bufferSize, int32_t * result )
10038```
10039**描述:**
10040
10041获取手势识别器的标记。
10042
10043**起始版本:** 12
10044
10045**参数:**
10046
10047| 名称 | 描述 |
10048| -------- | -------- |
10049| recognizer | 手势识别器指针。  |
10050| buffer | 存储区。  |
10051| bufferSize | 存储区大小。  |
10052| result | 拷贝的字符串长度。  |
10053
10054**返回:**
10055
10056[ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md#arkui_errorcode) - 成功。 [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md#arkui_errorcode) - 参数错误。 [ARKUI_ERROR_CODE_BUFFER_SIZE_NOT_ENOUGH](_ark_u_i___native_module.md#arkui_errorcode) - 存储区大小不足。
10057
10058
10059### OH_ArkUI_GetNavDestinationId()
10060
10061```
10062ArkUI_ErrorCode OH_ArkUI_GetNavDestinationId (ArkUI_NodeHandle node, char * buffer, int32_t bufferSize, int32_t * writeLength )
10063```
10064**描述:**
10065
10066获取当前节点所在的NavDestination组件的ID。
10067
10068**起始版本:** 12
10069
10070**参数:**
10071
10072| 名称 | 描述 |
10073| -------- | -------- |
10074| node | 指定的节点。  |
10075| buffer | 缓冲区,NavDestinationID写入该内存区域。  |
10076| bufferSize | 缓冲区大小。  |
10077| writeLength | 在返回ARKUI_ERROR_CODE_NO_ERROR时表示实际写入到缓冲区的字符串长度, 在返回ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR时表示可以容纳目标的最小缓冲区大小。  |
10078
10079**返回:**
10080
10081ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_GET_INFO_FAILED 查询信息失败,可能因为当前节点不在Navigation中。 ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR 给定的buffer size小于可以容纳目标的最小缓冲区大小。
10082
10083
10084### OH_ArkUI_GetNavDestinationIndex()
10085
10086```
10087ArkUI_ErrorCode OH_ArkUI_GetNavDestinationIndex (ArkUI_NodeHandle node, int32_t * index )
10088```
10089**描述:**
10090
10091获取当前节点所在的NavDestination组件在页面栈的索引。
10092
10093**起始版本:** 12
10094
10095**参数:**
10096
10097| 名称 | 描述 |
10098| -------- | -------- |
10099| node | 指定的节点。  |
10100| index | 索引值,从0开始计数。  |
10101
10102**返回:**
10103
10104ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_GET_INFO_FAILED 查询信息失败,可能因为当前节点不在Navigation中。
10105
10106
10107### OH_ArkUI_GetNavDestinationName()
10108
10109```
10110ArkUI_ErrorCode OH_ArkUI_GetNavDestinationName (ArkUI_NodeHandle node, char * buffer, int32_t bufferSize, int32_t * writeLength )
10111```
10112**描述:**
10113
10114获取当前节点所在的NavDestination组件的名称。
10115
10116**起始版本:** 12
10117
10118**参数:**
10119
10120| 名称 | 描述 |
10121| -------- | -------- |
10122| node | 指定的节点。  |
10123| buffer | 缓冲区,被查询的NavDestination名称写入该内存区域。  |
10124| bufferSize | 缓冲区大小。  |
10125| writeLength | 在返回ARKUI_ERROR_CODE_NO_ERROR时表示实际写入到缓冲区的字符串长度, 在返回ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR时表示可以容纳目标的最小缓冲区大小。  |
10126
10127**返回:**
10128
10129ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_GET_INFO_FAILED 查询信息失败,可能因为当前节点不在Navigation中。 ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR 给定的buffer size小于可以容纳目标的最小缓冲区大小。
10130
10131
10132### OH_ArkUI_GetNavDestinationNameByIndex()
10133
10134```
10135ArkUI_ErrorCode OH_ArkUI_GetNavDestinationNameByIndex (ArkUI_NodeHandle node, int32_t index, char * buffer, int32_t bufferSize, int32_t * writeLength )
10136```
10137**描述:**
10138
10139根据给定索引值,获取当前节点所在的Navigation栈中对应位置的页面名称。 索引值从0开始计数,0为栈底。
10140
10141**起始版本:** 12
10142
10143**参数:**
10144
10145| 名称 | 描述 |
10146| -------- | -------- |
10147| node | 指定的节点。  |
10148| index | 被查询NavDestination在栈中的索引。  |
10149| buffer | 缓冲区,被查询页面的名称写入该内存区域。  |
10150| bufferSize | 缓冲区大小。  |
10151| writeLength | 在返回ARKUI_ERROR_CODE_NO_ERROR时表示实际写入到缓冲区的字符串长度, 在返回ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR时表示可以容纳目标的最小缓冲区大小。  |
10152
10153**返回:**
10154
10155ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_NODE_INDEX_INVALID index为非法值。 ARKUI_ERROR_CODE_GET_INFO_FAILED 查询信息失败,可能因为当前节点不在Navigation中。 ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR 给定的buffer size小于可以容纳目标的最小缓冲区大小。
10156
10157
10158### OH_ArkUI_GetNavDestinationParam()
10159
10160```
10161napi_value OH_ArkUI_GetNavDestinationParam (ArkUI_NodeHandle node)
10162```
10163**描述:**
10164
10165获取当前节点所在的NavDestination组件的参数。
10166
10167**起始版本:** 12
10168
10169**参数:**
10170
10171| 名称 | 描述 |
10172| -------- | -------- |
10173| node | 指定的节点。  |
10174
10175**返回:**
10176
10177参数对象。
10178
10179
10180### OH_ArkUI_GetNavDestinationState()
10181
10182```
10183ArkUI_ErrorCode OH_ArkUI_GetNavDestinationState (ArkUI_NodeHandle node, ArkUI_NavDestinationState * state )
10184```
10185**描述:**
10186
10187获取当前节点所在的NavDestination组件的状态。
10188
10189**起始版本:** 12
10190
10191**参数:**
10192
10193| 名称 | 描述 |
10194| -------- | -------- |
10195| node | 指定的节点。  |
10196| state | NavDestination的状态值写回该参数中。  |
10197
10198**返回:**
10199
10200错误码 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_GET_INFO_FAILED 查询信息失败,可能因为当前节点不在Navigation中。
10201
10202
10203### OH_ArkUI_GetNavigationId()
10204
10205```
10206ArkUI_ErrorCode OH_ArkUI_GetNavigationId (ArkUI_NodeHandle node, char * buffer, int32_t bufferSize, int32_t * writeLength )
10207```
10208**描述:**
10209
10210获取当前节点所在的Navigation组件的ID。
10211
10212**起始版本:** 12
10213
10214**参数:**
10215
10216| 名称 | 描述 |
10217| -------- | -------- |
10218| node | 指定的节点。  |
10219| buffer | 缓冲区,NavigationID写入该内存区域。  |
10220| bufferSize | 缓冲区大小。  |
10221| writeLength | 在返回ARKUI_ERROR_CODE_NO_ERROR时表示实际写入到缓冲区的字符串长度, 在返回ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR时表示可以容纳目标的最小缓冲区大小。  |
10222
10223**返回:**
10224
10225ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_GET_INFO_FAILED 查询信息失败,可能因为当前节点不在Navigation中。 ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR 给定的buffer size小于可以容纳目标的最小缓冲区大小。
10226
10227
10228### OH_ArkUI_GetNavStackLength()
10229
10230```
10231ArkUI_ErrorCode OH_ArkUI_GetNavStackLength (ArkUI_NodeHandle node, int32_t * length )
10232```
10233**描述:**
10234
10235根据给定索引值,获取当前节点所在的Navigation栈的长度。
10236
10237**起始版本:** 12
10238
10239**参数:**
10240
10241| 名称 | 描述 |
10242| -------- | -------- |
10243| node | 指定的节点。  |
10244| length | 栈的长度。查询成功后将结果写回该参数。  |
10245
10246**返回:**
10247
10248ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_GET_INFO_FAILED 查询信息失败,可能因为当前节点不在Navigation中。
10249
10250
10251### OH_ArkUI_GetNodeContentFromNapiValue()
10252
10253```
10254int32_t OH_ArkUI_GetNodeContentFromNapiValue (napi_env env, napi_value value, ArkUI_NodeContentHandle * content )
10255```
10256**描述:**
10257
10258获取ArkTS侧创建的NodeContent对象映射到native侧的ArkUI_NodeContentHandle。
10259
10260**起始版本:** 12
10261
10262**参数:**
10263
10264| 名称 | 描述 |
10265| -------- | -------- |
10266| env | napi的环境指针。  |
10267| value | ArkTS侧创建的NodeContent对象。  |
10268| context | ArkUI_NodeContentHandle指针。  |
10269
10270**返回:**
10271
10272ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
10273
10274
10275### OH_ArkUI_GetNodeHandleFromNapiValue()
10276
10277```
10278int32_t OH_ArkUI_GetNodeHandleFromNapiValue (napi_env env, napi_value frameNode, ArkUI_NodeHandle * handle )
10279```
10280**描述:**
10281
10282获取ArkTS侧创建的FrameNode节点对象映射到native侧的ArkUI_NodeHandle。
10283
10284**起始版本:** 12
10285
10286**参数:**
10287
10288| 名称 | 描述 |
10289| -------- | -------- |
10290| env | napi的环境指针。  |
10291| frameNode | ArkTS侧创建的FrameNode对象。  |
10292| handle | ArkUI_NodeHandle指针。  |
10293
10294**返回:**
10295
10296ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
10297
10298
10299### OH_ArkUI_GetPanGestureDirectionMask()
10300
10301```
10302int32_t OH_ArkUI_GetPanGestureDirectionMask (ArkUI_GestureRecognizer * recognizer, ArkUI_GestureDirectionMask * directionMask )
10303```
10304**描述:**
10305
10306获取滑动手势的滑动方向。
10307
10308**起始版本:** 12
10309
10310**参数:**
10311
10312| 名称 | 描述 |
10313| -------- | -------- |
10314| recognizer | 手势识别器指针。  |
10315| directionMask | 滑动手势的滑动方向。  |
10316
10317**返回:**
10318
10319[ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md#arkui_errorcode) - 成功。 [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md#arkui_errorcode) - 参数错误。
10320
10321
10322### OH_ArkUI_GetResponseRecognizersFromInterruptInfo()
10323
10324```
10325int32_t OH_ArkUI_GetResponseRecognizersFromInterruptInfo (const ArkUI_GestureInterruptInfo * event, ArkUI_GestureRecognizerHandleArray * responseChain, int32_t * count )
10326```
10327**描述:**
10328
10329获取手势响应链的信息。
10330
10331**起始版本:** 12
10332
10333**参数:**
10334
10335| 名称 | 描述 |
10336| -------- | -------- |
10337| event | 手势打断回调事件。  |
10338| responseChain | 响应链组件上的手势识别器。  |
10339| count | 响应链组件上的手势识别器的数量。  |
10340
10341**返回:**
10342
10343[ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md#arkui_errorcode) - 成功。 [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md#arkui_errorcode) - 参数错误。
10344
10345
10346### OH_ArkUI_GetRouterPageId()
10347
10348```
10349ArkUI_ErrorCode OH_ArkUI_GetRouterPageId (ArkUI_NodeHandle node, char * buffer, int32_t bufferSize, int32_t * writeLength )
10350```
10351**描述:**
10352
10353获取当前节点所在页面的Page组件的ID。
10354
10355**起始版本:** 12
10356
10357**参数:**
10358
10359| 名称 | 描述 |
10360| -------- | -------- |
10361| node | 指定的节点。  |
10362| buffer | 缓冲区,Page Id写入该内存区域。  |
10363| bufferSize | 缓冲区大小。  |
10364| writeLength | 在返回ARKUI_ERROR_CODE_NO_ERROR时表示实际写入到缓冲区的字符串长度, 在返回ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR时表示可以容纳目标的最小缓冲区大小。  |
10365
10366**返回:**
10367
10368ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_GET_INFO_FAILED 查询信息失败。 ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR 给定的buffer size小于可以容纳目标的最小缓冲区大小。
10369
10370
10371### OH_ArkUI_GetRouterPageIndex()
10372
10373```
10374ArkUI_ErrorCode OH_ArkUI_GetRouterPageIndex (ArkUI_NodeHandle node, int32_t * index )
10375```
10376**描述:**
10377
10378获取当前节点所在页面在Router页面栈中的索引。
10379
10380**起始版本:** 12
10381
10382**参数:**
10383
10384| 名称 | 描述 |
10385| -------- | -------- |
10386| node | 指定的节点。  |
10387| index | 索引值,从1开始计数。  |
10388
10389**返回:**
10390
10391ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_GET_INFO_FAILED 查询信息失败,可能因为当前节点不在Navigation中。
10392
10393
10394### OH_ArkUI_GetRouterPageName()
10395
10396```
10397ArkUI_ErrorCode OH_ArkUI_GetRouterPageName (ArkUI_NodeHandle node, char * buffer, int32_t bufferSize, int32_t * writeLength )
10398```
10399**描述:**
10400
10401获取当前节点所在页面的名称。
10402
10403**起始版本:** 12
10404
10405**参数:**
10406
10407| 名称 | 描述 |
10408| -------- | -------- |
10409| node | 指定的节点。  |
10410| buffer | 缓冲区,页面名称写入该内存区域。  |
10411| bufferSize | 缓冲区大小。  |
10412| writeLength | 在返回ARKUI_ERROR_CODE_NO_ERROR时表示实际写入到缓冲区的字符串长度, 在返回ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR时表示可以容纳目标的最小缓冲区大小。  |
10413
10414**返回:**
10415
10416ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_GET_INFO_FAILED 查询信息失败。 ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR 给定的buffer size小于可以容纳目标的最小缓冲区大小。
10417
10418
10419### OH_ArkUI_GetRouterPagePath()
10420
10421```
10422ArkUI_ErrorCode OH_ArkUI_GetRouterPagePath (ArkUI_NodeHandle node, char * buffer, int32_t bufferSize, int32_t * writeLength )
10423```
10424**描述:**
10425
10426获取当前节点所在页面的Page组件的路径。
10427
10428**起始版本:** 12
10429
10430**参数:**
10431
10432| 名称 | 描述 |
10433| -------- | -------- |
10434| node | 指定的节点。  |
10435| buffer | 缓冲区,Page Path写入该内存区域。  |
10436| bufferSize | 缓冲区大小。  |
10437| writeLength | 在返回ARKUI_ERROR_CODE_NO_ERROR时表示实际写入到缓冲区的字符串长度, 在返回ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR时表示可以容纳目标的最小缓冲区大小。  |
10438
10439**返回:**
10440
10441ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_GET_INFO_FAILED 查询信息失败。 ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR 给定的buffer size小于可以容纳目标的最小缓冲区大小。
10442
10443
10444### OH_ArkUI_GetRouterPageState()
10445
10446```
10447ArkUI_ErrorCode OH_ArkUI_GetRouterPageState (ArkUI_NodeHandle node, ArkUI_RouterPageState * state )
10448```
10449**描述:**
10450
10451获取当前节点所在页面的Page组件的状态。
10452
10453**起始版本:** 12
10454
10455**参数:**
10456
10457| 名称 | 描述 |
10458| -------- | -------- |
10459| node | 指定的节点。  |
10460| state | Router Page的状态值写回该参数中。  |
10461
10462**返回:**
10463
10464错误码 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_GET_INFO_FAILED 查询信息失败。
10465
10466
10467### OH_ArkUI_GuidelineOption_Create()
10468
10469```
10470ArkUI_GuidelineOption* OH_ArkUI_GuidelineOption_Create (int32_t size)
10471```
10472**描述:**
10473
10474创建RelativeContaine容器内的辅助线信息。
10475
10476**起始版本:** 12
10477
10478**参数:**
10479
10480| 名称 | 描述 |
10481| -------- | -------- |
10482| size | 辅助线数量。  |
10483
10484**返回:**
10485
10486辅助线信息。
10487
10488
10489### OH_ArkUI_GuidelineOption_Dispose()
10490
10491```
10492void OH_ArkUI_GuidelineOption_Dispose (ArkUI_GuidelineOption * guideline)
10493```
10494**描述:**
10495
10496销毁辅助线信息。
10497
10498**起始版本:** 12
10499
10500**参数:**
10501
10502| 名称 | 描述 |
10503| -------- | -------- |
10504| guideline | 辅助线信息。  |
10505
10506
10507### OH_ArkUI_GuidelineOption_GetDirection()
10508
10509```
10510ArkUI_Axis OH_ArkUI_GuidelineOption_GetDirection (ArkUI_GuidelineOption * guideline, int32_t index )
10511```
10512**描述:**
10513
10514获取辅助线的方向。
10515
10516**起始版本:** 12
10517
10518**参数:**
10519
10520| 名称 | 描述 |
10521| -------- | -------- |
10522| guideline | 辅助线信息。  |
10523| index | 辅助线索引值。  |
10524
10525**返回:**
10526
10527方向。
10528
10529
10530### OH_ArkUI_GuidelineOption_GetId()
10531
10532```
10533const char* OH_ArkUI_GuidelineOption_GetId (ArkUI_GuidelineOption * guideline, int32_t index )
10534```
10535**描述:**
10536
10537获取辅助线的Id。
10538
10539**起始版本:** 12
10540
10541**参数:**
10542
10543| 名称 | 描述 |
10544| -------- | -------- |
10545| guideline | 辅助线信息。  |
10546| index | 辅助线索引值。  |
10547
10548**返回:**
10549
10550Id。
10551
10552
10553### OH_ArkUI_GuidelineOption_GetPositionEnd()
10554
10555```
10556float OH_ArkUI_GuidelineOption_GetPositionEnd (ArkUI_GuidelineOption * guideline, int32_t index )
10557```
10558**描述:**
10559
10560获取距离容器右侧或者底部的距离。
10561
10562**起始版本:** 12
10563
10564**参数:**
10565
10566| 名称 | 描述 |
10567| -------- | -------- |
10568| guideline | 辅助线信息。  |
10569| index | 辅助线索引值。  |
10570
10571**返回:**
10572
10573距离容器右侧或者底部的距离。
10574
10575
10576### OH_ArkUI_GuidelineOption_GetPositionStart()
10577
10578```
10579float OH_ArkUI_GuidelineOption_GetPositionStart (ArkUI_GuidelineOption * guideline, int32_t index )
10580```
10581**描述:**
10582
10583获取距离容器左侧或者顶部的距离。
10584
10585**起始版本:** 12
10586
10587**参数:**
10588
10589| 名称 | 描述 |
10590| -------- | -------- |
10591| guideline | 辅助线信息。  |
10592| index | 辅助线索引值。  |
10593
10594**返回:**
10595
10596距离容器左侧或者顶部的距离。
10597
10598
10599### OH_ArkUI_GuidelineOption_SetDirection()
10600
10601```
10602void OH_ArkUI_GuidelineOption_SetDirection (ArkUI_GuidelineOption * guideline, ArkUI_Axis value, int32_t index )
10603```
10604**描述:**
10605
10606设置辅助线的方向。
10607
10608**起始版本:** 12
10609
10610**参数:**
10611
10612| 名称 | 描述 |
10613| -------- | -------- |
10614| guideline | 辅助线信息。  |
10615| value | 方向。  |
10616| index | 辅助线索引值。  |
10617
10618
10619### OH_ArkUI_GuidelineOption_SetId()
10620
10621```
10622void OH_ArkUI_GuidelineOption_SetId (ArkUI_GuidelineOption * guideline, const char * value, int32_t index )
10623```
10624**描述:**
10625
10626设置辅助线的Id。
10627
10628**起始版本:** 12
10629
10630**参数:**
10631
10632| 名称 | 描述 |
10633| -------- | -------- |
10634| guideline | 辅助线信息。  |
10635| value | id,必须是唯一的并且不可与容器内组件重名。  |
10636| index | 辅助线索引值。  |
10637
10638
10639### OH_ArkUI_GuidelineOption_SetPositionEnd()
10640
10641```
10642void OH_ArkUI_GuidelineOption_SetPositionEnd (ArkUI_GuidelineOption * guideline, float value, int32_t index )
10643```
10644**描述:**
10645
10646设置距离容器右侧或者底部的距离。
10647
10648**起始版本:** 12
10649
10650**参数:**
10651
10652| 名称 | 描述 |
10653| -------- | -------- |
10654| guideline | 辅助线信息。  |
10655| value | 距离容器右侧或者底部的距离。  |
10656| index | 辅助线索引值。  |
10657
10658
10659### OH_ArkUI_GuidelineOption_SetPositionStart()
10660
10661```
10662void OH_ArkUI_GuidelineOption_SetPositionStart (ArkUI_GuidelineOption * guideline, float value, int32_t index )
10663```
10664**描述:**
10665
10666设置距离容器左侧或者顶部的距离。
10667
10668**起始版本:** 12
10669
10670**参数:**
10671
10672| 名称 | 描述 |
10673| -------- | -------- |
10674| guideline | 辅助线信息。  |
10675| value | 距离容器左侧或者顶部的距离。  |
10676| index | 辅助线索引值。  |
10677
10678
10679### OH_ArkUI_ImageAnimatorFrameInfo_CreateFromDrawableDescriptor()
10680
10681```
10682ArkUI_ImageAnimatorFrameInfo* OH_ArkUI_ImageAnimatorFrameInfo_CreateFromDrawableDescriptor (ArkUI_DrawableDescriptor * drawable)
10683```
10684**描述:**
10685
10686使用 DrawableDescriptor 对象创建帧图片信息,图片格式为Resource和PixelMap。
10687
10688**起始版本:** 12
10689
10690**参数:**
10691
10692| 名称 | 描述 |
10693| -------- | -------- |
10694| drawable | 使用Resource或PixelMap创建的ArkUI_DrawableDescriptor对象指针。  |
10695
10696**返回:**
10697
10698帧图片对象指针。
10699
10700
10701### OH_ArkUI_ImageAnimatorFrameInfo_CreateFromString()
10702
10703```
10704ArkUI_ImageAnimatorFrameInfo* OH_ArkUI_ImageAnimatorFrameInfo_CreateFromString (char * src)
10705```
10706**描述:**
10707
10708使用图片路径创建帧图片信息,图片格式为svg,png和jpg。
10709
10710**起始版本:** 12
10711
10712**参数:**
10713
10714| 名称 | 描述 |
10715| -------- | -------- |
10716| src | 图片路径。  |
10717
10718**返回:**
10719
10720帧图片对象指针。
10721
10722
10723### OH_ArkUI_ImageAnimatorFrameInfo_Dispose()
10724
10725```
10726void OH_ArkUI_ImageAnimatorFrameInfo_Dispose (ArkUI_ImageAnimatorFrameInfo * imageInfo)
10727```
10728**描述:**
10729
10730销毁帧图片对象指针。
10731
10732**起始版本:** 12
10733
10734**参数:**
10735
10736| 名称 | 描述 |
10737| -------- | -------- |
10738| imageInfo | 帧图片对象指针。  |
10739
10740
10741### OH_ArkUI_ImageAnimatorFrameInfo_GetDuration()
10742
10743```
10744int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetDuration (ArkUI_ImageAnimatorFrameInfo * imageInfo)
10745```
10746**描述:**
10747
10748获取图片的播放时长。
10749
10750**起始版本:** 12
10751
10752**参数:**
10753
10754| 名称 | 描述 |
10755| -------- | -------- |
10756| imageInfo | 帧图片对象指针。  |
10757
10758**返回:**
10759
10760图片的播放时长,单位为毫秒,imageInfo为空指针时返回0。
10761
10762
10763### OH_ArkUI_ImageAnimatorFrameInfo_GetHeight()
10764
10765```
10766int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetHeight (ArkUI_ImageAnimatorFrameInfo * imageInfo)
10767```
10768**描述:**
10769
10770获取图片高度。
10771
10772**起始版本:** 12
10773
10774**参数:**
10775
10776| 名称 | 描述 |
10777| -------- | -------- |
10778| imageInfo | 帧图片对象指针。  |
10779
10780**返回:**
10781
10782图片高度,单位为PX,imageInfo为空指针时返回0。
10783
10784
10785### OH_ArkUI_ImageAnimatorFrameInfo_GetLeft()
10786
10787```
10788int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetLeft (ArkUI_ImageAnimatorFrameInfo * imageInfo)
10789```
10790**描述:**
10791
10792获取图片相对于组件左上角的横向坐标。
10793
10794**起始版本:** 12
10795
10796**参数:**
10797
10798| 名称 | 描述 |
10799| -------- | -------- |
10800| imageInfo | 帧图片对象指针。  |
10801
10802**返回:**
10803
10804图片相对于组件左上角的横向坐标,单位为PX,imageInfo为空指针时返回0。
10805
10806
10807### OH_ArkUI_ImageAnimatorFrameInfo_GetTop()
10808
10809```
10810int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetTop (ArkUI_ImageAnimatorFrameInfo * imageInfo)
10811```
10812**描述:**
10813
10814获取图片相对于组件左上角的纵向坐标。
10815
10816**起始版本:** 12
10817
10818**参数:**
10819
10820| 名称 | 描述 |
10821| -------- | -------- |
10822| imageInfo | 帧图片对象指针。  |
10823
10824**返回:**
10825
10826图片相对于组件左上角的纵向坐标,单位为PX,imageInfo为空指针时返回0。
10827
10828
10829### OH_ArkUI_ImageAnimatorFrameInfo_GetWidth()
10830
10831```
10832int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetWidth (ArkUI_ImageAnimatorFrameInfo * imageInfo)
10833```
10834**描述:**
10835
10836获取图片宽度。
10837
10838**起始版本:** 12
10839
10840**参数:**
10841
10842| 名称 | 描述 |
10843| -------- | -------- |
10844| imageInfo | 帧图片对象指针。  |
10845
10846**返回:**
10847
10848图片宽度,单位为PX,imageInfo为空指针时返回0。
10849
10850
10851### OH_ArkUI_ImageAnimatorFrameInfo_SetDuration()
10852
10853```
10854void OH_ArkUI_ImageAnimatorFrameInfo_SetDuration (ArkUI_ImageAnimatorFrameInfo * imageInfo, int32_t duration )
10855```
10856**描述:**
10857
10858设置图片的播放时长。
10859
10860**起始版本:** 12
10861
10862**参数:**
10863
10864| 名称 | 描述 |
10865| -------- | -------- |
10866| imageInfo | 帧图片对象指针。  |
10867| duration | 图片的播放时长,单位为毫秒。  |
10868
10869
10870### OH_ArkUI_ImageAnimatorFrameInfo_SetHeight()
10871
10872```
10873void OH_ArkUI_ImageAnimatorFrameInfo_SetHeight (ArkUI_ImageAnimatorFrameInfo * imageInfo, int32_t height )
10874```
10875**描述:**
10876
10877设置图片高度。
10878
10879**起始版本:** 12
10880
10881**参数:**
10882
10883| 名称 | 描述 |
10884| -------- | -------- |
10885| imageInfo | 帧图片对象指针。  |
10886| height | 图片高度,单位为PX。  |
10887
10888
10889### OH_ArkUI_ImageAnimatorFrameInfo_SetLeft()
10890
10891```
10892void OH_ArkUI_ImageAnimatorFrameInfo_SetLeft (ArkUI_ImageAnimatorFrameInfo * imageInfo, int32_t left )
10893```
10894**描述:**
10895
10896设置图片相对于组件左上角的横向坐标。
10897
10898**起始版本:** 12
10899
10900**参数:**
10901
10902| 名称 | 描述 |
10903| -------- | -------- |
10904| imageInfo | 帧图片对象指针。  |
10905| left | 图片相对于组件左上角的横向坐标,单位为PX。  |
10906
10907
10908### OH_ArkUI_ImageAnimatorFrameInfo_SetTop()
10909
10910```
10911void OH_ArkUI_ImageAnimatorFrameInfo_SetTop (ArkUI_ImageAnimatorFrameInfo * imageInfo, int32_t top )
10912```
10913**描述:**
10914
10915设置图片相对于组件左上角的纵向坐标。
10916
10917**起始版本:** 12
10918
10919**参数:**
10920
10921| 名称 | 描述 |
10922| -------- | -------- |
10923| imageInfo | 帧图片对象指针。  |
10924| top | 图片相对于组件左上角的纵向坐标,单位为PX。  |
10925
10926
10927### OH_ArkUI_ImageAnimatorFrameInfo_SetWidth()
10928
10929```
10930void OH_ArkUI_ImageAnimatorFrameInfo_SetWidth (ArkUI_ImageAnimatorFrameInfo * imageInfo, int32_t width )
10931```
10932**描述:**
10933
10934设置图片宽度。
10935
10936**起始版本:** 12
10937
10938**参数:**
10939
10940| 名称 | 描述 |
10941| -------- | -------- |
10942| imageInfo | 帧图片对象指针。  |
10943| width | 图片宽度,单位为PX。  |
10944
10945
10946### OH_ArkUI_IsBuiltInGesture()
10947
10948```
10949bool OH_ArkUI_IsBuiltInGesture (ArkUI_GestureRecognizer * recognizer)
10950```
10951**描述:**
10952
10953当前手势是否为系统内置手势。
10954
10955**起始版本:** 12
10956
10957**参数:**
10958
10959| 名称 | 描述 |
10960| -------- | -------- |
10961| recognizer | 手势识别器指针。  |
10962
10963**返回:**
10964
10965true - 是系统内置手势。 false - 不是系统内置手势。
10966
10967
10968### OH_ArkUI_IsGestureRecognizerValid()
10969
10970```
10971bool OH_ArkUI_IsGestureRecognizerValid (ArkUI_GestureRecognizer * recognizer)
10972```
10973**描述:**
10974
10975当前手势识别器是否有效。
10976
10977**起始版本:** 12
10978
10979**参数:**
10980
10981| 名称 | 描述 |
10982| -------- | -------- |
10983| recognizer | 手势识别器指针。  |
10984
10985**返回:**
10986
10987true - 手势识别器有效。 false - 手势识别器无效。
10988
10989
10990### OH_ArkUI_KeyEvent_GetKeyCode()
10991
10992```
10993int32_t OH_ArkUI_KeyEvent_GetKeyCode (const ArkUI_UIInputEvent * event)
10994```
10995**描述:**
10996
10997获取按键的键码。
10998
10999**起始版本:** 14
11000
11001**参数:**
11002
11003| 名称 | 描述 |
11004| -------- | -------- |
11005| event | ArkUI_UIInputEvent事件指针。  |
11006
11007**返回:**
11008
11009按键的键码。
11010
11011
11012### OH_ArkUI_KeyEvent_GetKeyIntensionCode()
11013
11014```
11015ArkUI_KeyIntension OH_ArkUI_KeyEvent_GetKeyIntensionCode (const ArkUI_UIInputEvent * event)
11016```
11017**描述:**
11018
11019获取按键对应的意图。
11020
11021**起始版本:** 14
11022
11023**参数:**
11024
11025| 名称 | 描述 |
11026| -------- | -------- |
11027| event | ArkUI_UIInputEvent事件指针。  |
11028
11029**返回:**
11030
11031ArkUI_KeyIntension 按键对应的意图。
11032
11033
11034### OH_ArkUI_KeyEvent_GetKeySource()
11035
11036```
11037ArkUI_KeySourceType OH_ArkUI_KeyEvent_GetKeySource (const ArkUI_UIInputEvent * event)
11038```
11039**描述:**
11040
11041获取当前按键的输入设备类型。
11042
11043**起始版本:** 14
11044
11045**参数:**
11046
11047| 名称 | 描述 |
11048| -------- | -------- |
11049| event | ArkUI_UIInputEvent事件指针。  |
11050
11051**返回:**
11052
11053ArkUI_KeySourceType 当前按键的输入设备类型。
11054
11055
11056### OH_ArkUI_KeyEvent_GetKeyText()
11057
11058```
11059const char* OH_ArkUI_KeyEvent_GetKeyText (const ArkUI_UIInputEvent * event)
11060```
11061**描述:**
11062
11063获取按键的键值。
11064
11065**起始版本:** 14
11066
11067**参数:**
11068
11069| 名称 | 描述 |
11070| -------- | -------- |
11071| event | ArkUI_UIInputEvent事件指针。  |
11072
11073**返回:**
11074
11075按键的键值。
11076
11077
11078### OH_ArkUI_KeyEvent_GetType()
11079
11080```
11081ArkUI_KeyEventType OH_ArkUI_KeyEvent_GetType (const ArkUI_UIInputEvent * event)
11082```
11083**描述:**
11084
11085获取按键的类型。
11086
11087**起始版本:** 14
11088
11089**参数:**
11090
11091| 名称 | 描述 |
11092| -------- | -------- |
11093| event | ArkUI_UIInputEvent事件指针。  |
11094
11095**返回:**
11096
11097ArkUI_KeyEventType 按键的类型。
11098
11099
11100### OH_ArkUI_KeyEvent_GetUnicode()
11101
11102```
11103uint32_t OH_ArkUI_KeyEvent_GetUnicode (const ArkUI_UIInputEvent * event)
11104```
11105**描述:**
11106
11107获取按键的unicode码值。支持范围为非空格的基本拉丁字符:0x0021-0x007E,不支持字符为0。组合键场景下,返回当前keyEvent对应按键的unicode码值。
11108
11109**起始版本:** 14
11110
11111**参数:**
11112
11113| 名称 | 描述 |
11114| -------- | -------- |
11115| event | ArkUI_UIInputEvent事件指针。  |
11116
11117**返回:**
11118
11119unicode码值。
11120
11121
11122### OH_ArkUI_KeyEvent_SetConsumed()
11123
11124```
11125void OH_ArkUI_KeyEvent_SetConsumed (const ArkUI_UIInputEvent * event, bool isConsumed )
11126```
11127**描述:**
11128
11129在按键事件回调中,设置事件是否被该回调消费
11130
11131**起始版本:** 14
11132
11133**参数:**
11134
11135| 名称 | 描述 |
11136| -------- | -------- |
11137| event | ArkUI_UIInputEvent事件指针。  |
11138| isConsumed | 是否被消费。  |
11139
11140
11141### OH_ArkUI_KeyEvent_StopPropagation()
11142
11143```
11144void OH_ArkUI_KeyEvent_StopPropagation (const ArkUI_UIInputEvent * event, bool stopPropagation )
11145```
11146**描述:**
11147
11148阻塞事件冒泡传递。
11149
11150**起始版本:** 14
11151
11152**参数:**
11153
11154| 名称 | 描述 |
11155| -------- | -------- |
11156| event | ArkUI_UIInputEvent事件指针。  |
11157| stopPropagation | 表示是否阻止事件冒泡。  |
11158
11159
11160### OH_ArkUI_KeyEvent_Dispatch()
11161
11162```
11163void OH_ArkUI_KeyEvent_Dispatch(ArkUI_NodeHandle node, const ArkUI_UIInputEvent* event)
11164```
11165**描述:**
11166
11167将按键事件分发到特定组件节点。
11168
11169**起始版本:** 15
11170
11171**参数:**
11172
11173| 名称 | 描述 |
11174| -------- | -------- |
11175| node | 需要注册事件的节点对象。  |
11176| event | ArkUI_UIInputEvent事件指针。  |
11177
11178### OH_ArkUI_KeyframeAnimateOption_Create()
11179
11180```
11181ArkUI_KeyframeAnimateOption* OH_ArkUI_KeyframeAnimateOption_Create (int32_t size)
11182```
11183**描述:**
11184
11185获取关键帧动画参数。
11186
11187**起始版本:** 12
11188
11189**参数:**
11190
11191| 名称 | 描述 |
11192| -------- | -------- |
11193| size | 关键帧动画状态数。  |
11194
11195**返回:**
11196
11197关键帧动画参数对象。size小于0时返回NULL。
11198
11199
11200### OH_ArkUI_KeyframeAnimateOption_Dispose()
11201
11202```
11203void OH_ArkUI_KeyframeAnimateOption_Dispose (ArkUI_KeyframeAnimateOption * option)
11204```
11205**描述:**
11206
11207销毁关键帧动画参数。
11208
11209**起始版本:** 12
11210
11211**参数:**
11212
11213| 名称 | 描述 |
11214| -------- | -------- |
11215| option | 关键帧动画参数对象。  |
11216
11217
11218### OH_ArkUI_KeyframeAnimateOption_GetCurve()
11219
11220```
11221ArkUI_CurveHandle OH_ArkUI_KeyframeAnimateOption_GetCurve (ArkUI_KeyframeAnimateOption * option, int32_t index )
11222```
11223**描述:**
11224
11225获取关键帧动画某段状态动画曲线。
11226
11227**起始版本:** 12
11228
11229**参数:**
11230
11231| 名称 | 描述 |
11232| -------- | -------- |
11233| option | 关键帧动画参数。  |
11234| index | 状态索引值。  |
11235
11236**返回:**
11237
11238动画曲线。
11239
11240
11241### OH_ArkUI_KeyframeAnimateOption_GetDelay()
11242
11243```
11244int32_t OH_ArkUI_KeyframeAnimateOption_GetDelay (ArkUI_KeyframeAnimateOption * option)
11245```
11246**描述:**
11247
11248获取关键帧整体延时时间。
11249
11250**起始版本:** 12
11251
11252**参数:**
11253
11254| 名称 | 描述 |
11255| -------- | -------- |
11256| option | 关键帧动画参数。  |
11257
11258**返回:**
11259
11260整体延时时间。
11261
11262
11263### OH_ArkUI_KeyframeAnimateOption_GetDuration()
11264
11265```
11266int32_t OH_ArkUI_KeyframeAnimateOption_GetDuration (ArkUI_KeyframeAnimateOption * option, int32_t index )
11267```
11268**描述:**
11269
11270获取关键帧动画某段状态持续时间。
11271
11272**起始版本:** 12
11273
11274**参数:**
11275
11276| 名称 | 描述 |
11277| -------- | -------- |
11278| option | 关键帧动画参数。  |
11279| index | 状态索引值。  |
11280
11281**返回:**
11282
11283持续时间。单位为毫秒。
11284
11285
11286### OH_ArkUI_KeyframeAnimateOption_GetIterations()
11287
11288```
11289int32_t OH_ArkUI_KeyframeAnimateOption_GetIterations (ArkUI_KeyframeAnimateOption * option)
11290```
11291**描述:**
11292
11293获取关键帧动画播放次数。
11294
11295**起始版本:** 12
11296
11297**参数:**
11298
11299| 名称 | 描述 |
11300| -------- | -------- |
11301| option | 关键帧动画参数。  |
11302
11303**返回:**
11304
11305动画播放次数。
11306
11307### OH_ArkUI_KeyframeAnimateOption_GetExpectedFrameRate()
11308
11309```
11310ArkUI_ExpectedFrameRateRange* OH_ArkUI_KeyframeAnimateOption_GetExpectedFrameRate(ArkUI_KeyframeAnimateOption* option)
11311```
11312**描述:**
11313
11314获取关键帧动画参数的期望帧率。
11315
11316**起始版本:** 18
11317
11318**参数:**
11319
11320| 名称 | 描述 |
11321| -------- | -------- |
11322| option | 关键帧动画参数。  |
11323
11324**返回:**
11325
11326关键帧动画参数的期望帧率。
11327
11328
11329### OH_ArkUI_KeyframeAnimateOption_RegisterOnEventCallback()
11330
11331```
11332int32_t OH_ArkUI_KeyframeAnimateOption_RegisterOnEventCallback (ArkUI_KeyframeAnimateOption * option, void * userData, void(*)(void *userData) event, int32_t index )
11333```
11334**描述:**
11335
11336设置关键帧时刻状态的闭包函数,即在该关键帧时刻要达到的状态。
11337
11338**参数:**
11339
11340| 名称 | 描述 |
11341| -------- | -------- |
11342| option | 关键帧动画参数。  |
11343| event | 闭包函数。  |
11344| userData | 用户定义对象指针。  |
11345| index | 状态索引值。  |
11346
11347**返回:**
11348
11349ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
11350
11351
11352### OH_ArkUI_KeyframeAnimateOption_RegisterOnFinishCallback()
11353
11354```
11355int32_t OH_ArkUI_KeyframeAnimateOption_RegisterOnFinishCallback (ArkUI_KeyframeAnimateOption * option, void * userData, void(*)(void *userData) onFinish )
11356```
11357**描述:**
11358
11359设置关键帧动画播放完成回调。当keyframe动画所有次数播放完成后调用。
11360
11361**参数:**
11362
11363| 名称 | 描述 |
11364| -------- | -------- |
11365| option | 关键帧动画参数。  |
11366| userData | 用户自定义对象指针。  |
11367| onFinish | 回调方法。  |
11368
11369**返回:**
11370
11371ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
11372
11373
11374### OH_ArkUI_KeyframeAnimateOption_SetCurve()
11375
11376```
11377int32_t OH_ArkUI_KeyframeAnimateOption_SetCurve (ArkUI_KeyframeAnimateOption * option, ArkUI_CurveHandle value, int32_t index )
11378```
11379**描述:**
11380
11381设置关键帧动画某段关键帧使用的动画曲线。
11382
11383**参数:**
11384
11385| 名称 | 描述 |
11386| -------- | -------- |
11387| option | 关键帧动画参数。  |
11388| value | 该关键帧使用的动画曲线。默认值:EASE_IN_OUT。  |
11389| index | 状态索引值。  |
11390
11391**注解:**
11392
11393由于springMotion、responsiveSpringMotion、interpolatingSpring曲线时长不生效,故不支持这三种曲线。
11394
11395**返回:**
11396
11397ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
11398
11399
11400### OH_ArkUI_KeyframeAnimateOption_SetDelay()
11401
11402```
11403int32_t OH_ArkUI_KeyframeAnimateOption_SetDelay (ArkUI_KeyframeAnimateOption * option, int32_t value )
11404```
11405**描述:**
11406
11407设置关键帧动画的整体延时时间,单位为ms(毫秒),默认不延时播放。
11408
11409**参数:**
11410
11411| 名称 | 描述 |
11412| -------- | -------- |
11413| option | 关键帧动画参数。  |
11414| value | 延时时间, 单位为ms(毫秒)。  |
11415
11416**返回:**
11417
11418ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
11419
11420
11421### OH_ArkUI_KeyframeAnimateOption_SetDuration()
11422
11423```
11424int32_t OH_ArkUI_KeyframeAnimateOption_SetDuration (ArkUI_KeyframeAnimateOption * option, int32_t value, int32_t index )
11425```
11426**描述:**
11427
11428设置关键帧动画某段关键帧动画的持续时间,单位为毫秒。
11429
11430**参数:**
11431
11432| 名称 | 描述 |
11433| -------- | -------- |
11434| option | 关键帧动画参数。  |
11435| value | 持续时间。单位为毫秒。  |
11436| index | 状态索引值。  |
11437
11438**返回:**
11439
11440ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
11441
11442
11443### OH_ArkUI_KeyframeAnimateOption_SetIterations()
11444
11445```
11446int32_t OH_ArkUI_KeyframeAnimateOption_SetIterations (ArkUI_KeyframeAnimateOption * option, int32_t value )
11447```
11448**描述:**
11449
11450设置关键帧动画的动画播放次数。默认播放一次,设置为-1时表示无限次播放。设置为0时表示无动画效果。
11451
11452**参数:**
11453
11454| 名称 | 描述 |
11455| -------- | -------- |
11456| option | 关键帧动画参数。  |
11457| value | 动画播放次数。  |
11458
11459**返回:**
11460
11461ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
11462
11463### OH_ArkUI_KeyframeAnimateOption_SetExpectedFrameRate()
11464
11465```
11466int32_t OH_ArkUI_KeyframeAnimateOption_SetExpectedFrameRate(
11467    ArkUI_KeyframeAnimateOption* option, ArkUI_ExpectedFrameRateRange* frameRate)
11468```
11469**描述:**
11470
11471设置关键帧动画期望帧率。
11472
11473**起始版本:** 18
11474
11475**参数:**
11476
11477| 名称 | 描述 |
11478| -------- | -------- |
11479| option | 关键帧动画参数。  |
11480| frameRate | 关键帧动画的期望帧率。  |
11481
11482**返回:**
11483
11484ARKUI_ERROR_CODE_NO_ERROR 成功。
11485ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
11486
11487
11488### OH_ArkUI_LayoutConstraint_Copy()
11489
11490```
11491ArkUI_LayoutConstraint* OH_ArkUI_LayoutConstraint_Copy (const ArkUI_LayoutConstraint * Constraint)
11492```
11493**描述:**
11494
11495约束尺寸深拷贝。
11496
11497**起始版本:** 12
11498
11499**参数:**
11500
11501| 名称 | 描述 |
11502| -------- | -------- |
11503| Constraint | 约束尺寸。  |
11504
11505**返回:**
11506
11507新的约束尺寸指针。
11508
11509
11510### OH_ArkUI_LayoutConstraint_Create()
11511
11512```
11513ArkUI_LayoutConstraint* OH_ArkUI_LayoutConstraint_Create ()
11514```
11515**描述:**
11516
11517创建约束尺寸。
11518
11519**起始版本:** 12
11520
11521
11522### OH_ArkUI_LayoutConstraint_Dispose()
11523
11524```
11525void* OH_ArkUI_LayoutConstraint_Dispose (ArkUI_LayoutConstraint * Constraint)
11526```
11527**描述:**
11528
11529销毁约束尺寸指针。
11530
11531**起始版本:** 12
11532
11533**参数:**
11534
11535| 名称 | 描述 |
11536| -------- | -------- |
11537| Constraint | 约束尺寸。  |
11538
11539
11540### OH_ArkUI_LayoutConstraint_GetMaxHeight()
11541
11542```
11543int32_t OH_ArkUI_LayoutConstraint_GetMaxHeight (const ArkUI_LayoutConstraint * Constraint)
11544```
11545**描述:**
11546
11547通过约束尺寸获取最大高度,单位为px。
11548
11549**起始版本:** 12
11550
11551**参数:**
11552
11553| 名称 | 描述 |
11554| -------- | -------- |
11555| Constraint | 约束尺寸。  |
11556
11557**返回:**
11558
11559最大高度。
11560
11561
11562### OH_ArkUI_LayoutConstraint_GetMaxWidth()
11563
11564```
11565int32_t OH_ArkUI_LayoutConstraint_GetMaxWidth (const ArkUI_LayoutConstraint * Constraint)
11566```
11567**描述:**
11568
11569通过约束尺寸获取最大宽度,单位为px。
11570
11571**起始版本:** 12
11572
11573**参数:**
11574
11575| 名称 | 描述 |
11576| -------- | -------- |
11577| Constraint | 约束尺寸。  |
11578
11579**返回:**
11580
11581最大宽度。
11582
11583
11584### OH_ArkUI_LayoutConstraint_GetMinHeight()
11585
11586```
11587int32_t OH_ArkUI_LayoutConstraint_GetMinHeight (const ArkUI_LayoutConstraint * Constraint)
11588```
11589**描述:**
11590
11591通过约束尺寸获取最小高度,单位为px。
11592
11593**起始版本:** 12
11594
11595**参数:**
11596
11597| 名称 | 描述 |
11598| -------- | -------- |
11599| Constraint | 约束尺寸。  |
11600
11601**返回:**
11602
11603最小高度。
11604
11605
11606### OH_ArkUI_LayoutConstraint_GetMinWidth()
11607
11608```
11609int32_t OH_ArkUI_LayoutConstraint_GetMinWidth (const ArkUI_LayoutConstraint * Constraint)
11610```
11611**描述:**
11612
11613通过约束尺寸获取最小宽度,单位为px。
11614
11615**起始版本:** 12
11616
11617**参数:**
11618
11619| 名称 | 描述 |
11620| -------- | -------- |
11621| Constraint | 约束尺寸。  |
11622
11623**返回:**
11624
11625最小宽度。
11626
11627
11628### OH_ArkUI_LayoutConstraint_GetPercentReferenceHeight()
11629
11630```
11631int32_t OH_ArkUI_LayoutConstraint_GetPercentReferenceHeight (const ArkUI_LayoutConstraint * Constraint)
11632```
11633**描述:**
11634
11635通过约束尺寸获取高度百分比基准,单位为px。
11636
11637**起始版本:** 12
11638
11639**参数:**
11640
11641| 名称 | 描述 |
11642| -------- | -------- |
11643| Constraint | 约束尺寸。  |
11644
11645**返回:**
11646
11647高度百分比基准。
11648
11649
11650### OH_ArkUI_LayoutConstraint_GetPercentReferenceWidth()
11651
11652```
11653int32_t OH_ArkUI_LayoutConstraint_GetPercentReferenceWidth (const ArkUI_LayoutConstraint * Constraint)
11654```
11655**描述:**
11656
11657通过约束尺寸获取宽度百分比基准,单位为px。
11658
11659**起始版本:** 12
11660
11661**参数:**
11662
11663| 名称 | 描述 |
11664| -------- | -------- |
11665| Constraint | 约束尺寸。  |
11666
11667**返回:**
11668
11669宽度百分比基准。
11670
11671
11672### OH_ArkUI_LayoutConstraint_SetMaxHeight()
11673
11674```
11675void OH_ArkUI_LayoutConstraint_SetMaxHeight (ArkUI_LayoutConstraint * Constraint, int32_t value )
11676```
11677**描述:**
11678
11679设置最大高度。
11680
11681**起始版本:** 12
11682
11683**参数:**
11684
11685| 名称 | 描述 |
11686| -------- | -------- |
11687| Constraint | 约束尺寸。  |
11688| value | 最大高度,单位为px。  |
11689
11690
11691### OH_ArkUI_LayoutConstraint_SetMaxWidth()
11692
11693```
11694void OH_ArkUI_LayoutConstraint_SetMaxWidth (ArkUI_LayoutConstraint * Constraint, int32_t value )
11695```
11696**描述:**
11697
11698设置最大宽度。
11699
11700**起始版本:** 12
11701
11702**参数:**
11703
11704| 名称 | 描述 |
11705| -------- | -------- |
11706| Constraint | 约束尺寸。  |
11707| value | 最大宽度,单位为px。  |
11708
11709
11710### OH_ArkUI_LayoutConstraint_SetMinHeight()
11711
11712```
11713void OH_ArkUI_LayoutConstraint_SetMinHeight (ArkUI_LayoutConstraint * Constraint, int32_t value )
11714```
11715**描述:**
11716
11717设置最小高度。
11718
11719**起始版本:** 12
11720
11721**参数:**
11722
11723| 名称 | 描述 |
11724| -------- | -------- |
11725| Constraint | 约束尺寸。  |
11726| value | 最小高度,单位为px。  |
11727
11728
11729### OH_ArkUI_LayoutConstraint_SetMinWidth()
11730
11731```
11732void OH_ArkUI_LayoutConstraint_SetMinWidth (ArkUI_LayoutConstraint * Constraint, int32_t value )
11733```
11734**描述:**
11735
11736设置最小宽度。
11737
11738**起始版本:** 12
11739
11740**参数:**
11741
11742| 名称 | 描述 |
11743| -------- | -------- |
11744| Constraint | 约束尺寸。  |
11745| value | 最小宽度,单位为px。  |
11746
11747
11748### OH_ArkUI_LayoutConstraint_SetPercentReferenceHeight()
11749
11750```
11751void OH_ArkUI_LayoutConstraint_SetPercentReferenceHeight (ArkUI_LayoutConstraint * Constraint, int32_t value )
11752```
11753**描述:**
11754
11755设置高度百分比基准。
11756
11757**起始版本:** 12
11758
11759**参数:**
11760
11761| 名称 | 描述 |
11762| -------- | -------- |
11763| Constraint | 约束尺寸。  |
11764| value | 高度百分比基准,单位为px。  |
11765
11766
11767### OH_ArkUI_LayoutConstraint_SetPercentReferenceWidth()
11768
11769```
11770void OH_ArkUI_LayoutConstraint_SetPercentReferenceWidth (ArkUI_LayoutConstraint * Constraint, int32_t value )
11771```
11772**描述:**
11773
11774设置宽度百分比基准。
11775
11776**起始版本:** 12
11777
11778**参数:**
11779
11780| 名称 | 描述 |
11781| -------- | -------- |
11782| Constraint | 约束尺寸。  |
11783| value | 宽度百分比基准,单位为px。  |
11784
11785
11786### OH_ArkUI_List_CloseAllSwipeActions()
11787
11788```
11789int32_t OH_ArkUI_List_CloseAllSwipeActions (ArkUI_NodeHandle node, void * userData, void(*)(void *userData) onFinish )
11790```
11791**描述:**
11792
11793收起展开状态下的ListItem。
11794
11795**起始版本:** 12
11796
11797**参数:**
11798
11799| 名称 | 描述 |
11800| -------- | -------- |
11801| node | 需要注册事件的节点对象。  |
11802| userData | 自定义事件参数,当事件触发时在回调参数中携带回来。  |
11803| onFinish | 在收起动画完成后触发的回调。  |
11804
11805**返回:**
11806
11807ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_ATTRIBUTE_OR_EVENT_NOT_SUPPORTED 组件不支持该事件。
11808
11809
11810### OH_ArkUI_ListChildrenMainSizeOption_Create()
11811
11812```
11813ArkUI_ListChildrenMainSize* OH_ArkUI_ListChildrenMainSizeOption_Create ()
11814```
11815**描述:**
11816
11817创建ListChildrenMainSize接口设置的配置项。
11818
11819**起始版本:** 12
11820
11821**返回:**
11822
11823ListChildrenMainSize配置项实例。
11824
11825### OH_ArkUI_ListChildrenMainSizeOption_Dispose()
11826
11827```
11828void OH_ArkUI_ListChildrenMainSizeOption_Dispose (ArkUI_ListChildrenMainSize * option)
11829```
11830**描述:**
11831
11832销毁ListChildrenMainSize实例。
11833
11834**起始版本:** 12
11835
11836**参数:**
11837
11838| 名称 | 描述 |
11839| -------- | -------- |
11840| option | 要销毁的ListChildrenMainSize实例。  |
11841
11842
11843### OH_ArkUI_ListChildrenMainSizeOption_GetDefaultMainSize()
11844
11845```
11846float OH_ArkUI_ListChildrenMainSizeOption_GetDefaultMainSize (ArkUI_ListChildrenMainSize * option)
11847```
11848**描述:**
11849
11850获取List组件的ChildrenMainSizeOption默认大小。
11851
11852**起始版本:** 12
11853
11854**参数:**
11855
11856| 名称 | 描述 |
11857| -------- | -------- |
11858| option | ListChildrenMainSize实例。  |
11859
11860**返回:**
11861
11862List下的ListItem的默认大小,默认为0,单位为vp,option为空指针时返回-1。
11863
11864
11865### OH_ArkUI_ListChildrenMainSizeOption_GetMainSize()
11866
11867```
11868float OH_ArkUI_ListChildrenMainSizeOption_GetMainSize (ArkUI_ListChildrenMainSize * option, int32_t index )
11869```
11870**描述:**
11871
11872获取List组件的ChildrenMainSizeOption数组的值。
11873
11874**起始版本:** 12
11875
11876**参数:**
11877
11878| 名称 | 描述 |
11879| -------- | -------- |
11880| option | ListChildrenMainSize实例。  |
11881| index | 要获取的值的下标位置。  |
11882
11883**返回:**
11884
11885数组具体位置的值。若函数参数异常,返回-1。
11886
11887
11888### OH_ArkUI_ListChildrenMainSizeOption_Resize()
11889
11890```
11891void OH_ArkUI_ListChildrenMainSizeOption_Resize (ArkUI_ListChildrenMainSize * option, int32_t totalSize )
11892```
11893**描述:**
11894
11895重置List组件的ChildrenMainSizeOption的数组大小。
11896
11897**起始版本:** 12
11898
11899**参数:**
11900
11901| 名称 | 描述 |
11902| -------- | -------- |
11903| option | ListChildrenMainSize实例。  |
11904| totalSize | 数组大小。  |
11905
11906
11907### OH_ArkUI_ListChildrenMainSizeOption_SetDefaultMainSize()
11908
11909```
11910int32_t OH_ArkUI_ListChildrenMainSizeOption_SetDefaultMainSize (ArkUI_ListChildrenMainSize * option, float defaultMainSize )
11911```
11912**描述:**
11913
11914设置List组件的ChildrenMainSizeOption默认大小。
11915
11916**起始版本:** 12
11917
11918**参数:**
11919
11920| 名称 | 描述 |
11921| -------- | -------- |
11922| option | ListChildrenMainSize实例。  |
11923| defaultMainSize | List下的ListItem的默认大小,单位为vp。  |
11924
11925**返回:**
11926
11927ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
11928
11929
11930### OH_ArkUI_ListChildrenMainSizeOption_Splice()
11931
11932```
11933int32_t OH_ArkUI_ListChildrenMainSizeOption_Splice (ArkUI_ListChildrenMainSize * option, int32_t index, int32_t deleteCount, int32_t addCount )
11934```
11935**描述:**
11936
11937对List组件的ChildrenMainSizeOption数组操作大小调整。
11938
11939**起始版本:** 12
11940
11941**参数:**
11942
11943| 名称 | 描述 |
11944| -------- | -------- |
11945| option | ListChildrenMainSize实例。  |
11946| index | 要修改MainSize的数组起始位置。  |
11947| deleteCount | 要删除的MainSize数组从index开始的数量。  |
11948| addCount | 要添加的MainSize数组从index开始的数量。  |
11949
11950**返回:**
11951
11952ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
11953
11954
11955### OH_ArkUI_ListChildrenMainSizeOption_UpdateSize()
11956
11957```
11958int32_t OH_ArkUI_ListChildrenMainSizeOption_UpdateSize (ArkUI_ListChildrenMainSize * option, int32_t index, float mainSize )
11959```
11960**描述:**
11961
11962更新List组件的ChildrenMainSizeOption数组的值。
11963
11964**起始版本:** 12
11965
11966**参数:**
11967
11968| 名称 | 描述 |
11969| -------- | -------- |
11970| option | ListChildrenMainSize实例。  |
11971| index | 要修改MainSize的数组起始位置。  |
11972| mainSize | 实际修改的值。  |
11973
11974**返回:**
11975
11976ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
11977
11978
11979### OH_ArkUI_ListItemSwipeActionItem_Create()
11980
11981```
11982ArkUI_ListItemSwipeActionItem* OH_ArkUI_ListItemSwipeActionItem_Create ()
11983```
11984**描述:**
11985
11986创建ListItemSwipeActionItem接口设置的配置项。
11987
11988**起始版本:** 12
11989
11990**返回:**
11991
11992ListItemSwipeActionItem配置项实例。
11993
11994
11995### OH_ArkUI_ListItemSwipeActionItem_Dispose()
11996
11997```
11998void OH_ArkUI_ListItemSwipeActionItem_Dispose (ArkUI_ListItemSwipeActionItem * item)
11999```
12000**描述:**
12001
12002销毁ListItemSwipeActionItem实例。
12003
12004**起始版本:** 12
12005
12006**参数:**
12007
12008| 名称 | 描述 |
12009| -------- | -------- |
12010| item | 要销毁的ListItemSwipeActionItem实例。  |
12011
12012
12013### OH_ArkUI_ListItemSwipeActionItem_GetActionAreaDistance()
12014
12015```
12016float OH_ArkUI_ListItemSwipeActionItem_GetActionAreaDistance (ArkUI_ListItemSwipeActionItem * item)
12017```
12018**描述:**
12019
12020获取组件长距离滑动删除距离阈值。
12021
12022**起始版本:** 12
12023
12024**参数:**
12025
12026| 名称 | 描述 |
12027| -------- | -------- |
12028| item | ListItemSwipeActionItem实例。  |
12029
12030**返回:**
12031
12032组件长距离滑动删除距离阈值。异常时返回值:0。
12033
12034
12035### OH_ArkUI_ListItemSwipeActionItem_SetActionAreaDistance()
12036
12037```
12038void OH_ArkUI_ListItemSwipeActionItem_SetActionAreaDistance (ArkUI_ListItemSwipeActionItem * item, float distance )
12039```
12040**描述:**
12041
12042设置组件长距离滑动删除距离阈值。
12043
12044**起始版本:** 12
12045
12046**参数:**
12047
12048| 名称 | 描述 |
12049| -------- | -------- |
12050| item | ListItemSwipeActionItem实例。  |
12051| distance | 组件长距离滑动删除距离阈值。  |
12052
12053
12054### OH_ArkUI_ListItemSwipeActionItem_SetContent()
12055
12056```
12057void OH_ArkUI_ListItemSwipeActionItem_SetContent (ArkUI_ListItemSwipeActionItem * item, ArkUI_NodeHandle node )
12058```
12059**描述:**
12060
12061设置ListItemSwipeActionItem的布局内容。
12062
12063**起始版本:** 12
12064
12065**参数:**
12066
12067| 名称 | 描述 |
12068| -------- | -------- |
12069| item | ListItemSwipeActionItem实例。  |
12070| node | 布局信息。  |
12071
12072
12073### OH_ArkUI_ListItemSwipeActionItem_SetOnAction()
12074
12075```
12076void OH_ArkUI_ListItemSwipeActionItem_SetOnAction (ArkUI_ListItemSwipeActionItem * item, void(*)() callback )
12077```
12078**描述:**
12079
12080设置组件进入长距删除区后删除ListItem时调用的事件。
12081
12082**起始版本:** 12
12083
12084**参数:**
12085
12086| 名称 | 描述 |
12087| -------- | -------- |
12088| item | ListItemSwipeActionItem实例。  |
12089| callback | 回调事件  |
12090
12091
12092### OH_ArkUI_ListItemSwipeActionItem_SetOnActionWithUserData()
12093
12094```
12095void OH_ArkUI_ListItemSwipeActionItem_SetOnActionWithUserData (ArkUI_ListItemSwipeActionItem * item, void * userData, void(*)(void *userData) callback )
12096```
12097**描述:**
12098
12099设置组件进入长距删除区后删除ListItem时调用的事件。
12100
12101**起始版本:** 12
12102
12103**参数:**
12104
12105| 名称 | 描述 |
12106| -------- | -------- |
12107| item | ListItemSwipeActionItem实例。  |
12108| userData | 用户自定义数据。  |
12109| callback | 回调事件  |
12110
12111
12112### OH_ArkUI_ListItemSwipeActionItem_SetOnEnterActionArea()
12113
12114```
12115void OH_ArkUI_ListItemSwipeActionItem_SetOnEnterActionArea (ArkUI_ListItemSwipeActionItem * item, void(*)() callback )
12116```
12117**描述:**
12118
12119设置滑动条目进入删除区域时调用的事件。
12120
12121**起始版本:** 12
12122
12123**参数:**
12124
12125| 名称 | 描述 |
12126| -------- | -------- |
12127| item | ListItemSwipeActionItem实例。  |
12128| callback | 回调事件  |
12129
12130
12131### OH_ArkUI_ListItemSwipeActionItem_SetOnEnterActionAreaWithUserData()
12132
12133```
12134void OH_ArkUI_ListItemSwipeActionItem_SetOnEnterActionAreaWithUserData (ArkUI_ListItemSwipeActionItem * item, void * userData, void(*)(void *userData) callback )
12135```
12136**描述:**
12137
12138设置滑动条目进入删除区域时调用的事件。
12139
12140**起始版本:** 12
12141
12142**参数:**
12143
12144| 名称 | 描述 |
12145| -------- | -------- |
12146| item | ListItemSwipeActionItem实例。  |
12147| userData | 用户自定义数据。  |
12148| callback | 回调事件  |
12149
12150
12151### OH_ArkUI_ListItemSwipeActionItem_SetOnExitActionArea()
12152
12153```
12154void OH_ArkUI_ListItemSwipeActionItem_SetOnExitActionArea (ArkUI_ListItemSwipeActionItem * item, void(*)() callback )
12155```
12156**描述:**
12157
12158设置滑动条目退出删除区域时调用的事件。
12159
12160**起始版本:** 12
12161
12162**参数:**
12163
12164| 名称 | 描述 |
12165| -------- | -------- |
12166| item | ListItemSwipeActionItem实例。  |
12167| callback | 回调事件  |
12168
12169
12170### OH_ArkUI_ListItemSwipeActionItem_SetOnExitActionAreaWithUserData()
12171
12172```
12173void OH_ArkUI_ListItemSwipeActionItem_SetOnExitActionAreaWithUserData (ArkUI_ListItemSwipeActionItem * item, void * userData, void(*)(void *userData) callback )
12174```
12175**描述:**
12176
12177设置滑动条目退出删除区域时调用的事件。
12178
12179**起始版本:** 12
12180
12181**参数:**
12182
12183| 名称 | 描述 |
12184| -------- | -------- |
12185| item | ListItemSwipeActionItem实例。  |
12186| userData | 用户自定义数据。  |
12187| callback | 回调事件  |
12188
12189
12190### OH_ArkUI_ListItemSwipeActionItem_SetOnStateChange()
12191
12192```
12193void OH_ArkUI_ListItemSwipeActionItem_SetOnStateChange (ArkUI_ListItemSwipeActionItem * item, void(*)(ArkUI_ListItemSwipeActionState swipeActionState) callback )
12194```
12195**描述:**
12196
12197设置列表项滑动状态变化时候触发的事件。
12198
12199**起始版本:** 12
12200
12201**参数:**
12202
12203| 名称 | 描述 |
12204| -------- | -------- |
12205| item | ListItemSwipeActionItem实例。  |
12206| callback | 回调事件 swipeActionState 变化后的状态。  |
12207
12208
12209### OH_ArkUI_ListItemSwipeActionItem_SetOnStateChangeWithUserData()
12210
12211```
12212void OH_ArkUI_ListItemSwipeActionItem_SetOnStateChangeWithUserData (ArkUI_ListItemSwipeActionItem * item, void * userData, void(*)(ArkUI_ListItemSwipeActionState swipeActionState, void *userData) callback )
12213```
12214**描述:**
12215
12216设置列表项滑动状态变化时候触发的事件。
12217
12218**起始版本:** 12
12219
12220**参数:**
12221
12222| 名称 | 描述 |
12223| -------- | -------- |
12224| item | ListItemSwipeActionItem实例。  |
12225| userData | 用户自定义数据。  |
12226| callback | 回调事件 swipeActionState 变化后的状态。  |
12227
12228
12229### OH_ArkUI_ListItemSwipeActionOption_Create()
12230
12231```
12232ArkUI_ListItemSwipeActionOption* OH_ArkUI_ListItemSwipeActionOption_Create ()
12233```
12234**描述:**
12235
12236创建ListItemSwipeActionOption接口设置的配置项。
12237
12238**起始版本:** 12
12239
12240**返回:**
12241
12242ListItemSwipeActionOption配置项实例。
12243
12244
12245### OH_ArkUI_ListItemSwipeActionOption_Dispose()
12246
12247```
12248void OH_ArkUI_ListItemSwipeActionOption_Dispose (ArkUI_ListItemSwipeActionOption * option)
12249```
12250**描述:**
12251
12252销毁ListItemSwipeActionOption实例。
12253
12254**起始版本:** 12
12255
12256**参数:**
12257
12258| 名称 | 描述 |
12259| -------- | -------- |
12260| option | 要销毁的ListItemSwipeActionOption实例。  |
12261
12262
12263### OH_ArkUI_ListItemSwipeActionOption_GetEdgeEffect()
12264
12265```
12266int32_t OH_ArkUI_ListItemSwipeActionOption_GetEdgeEffect (ArkUI_ListItemSwipeActionOption * option)
12267```
12268**描述:**
12269
12270获取滑动效果。
12271
12272**起始版本:** 12
12273
12274**参数:**
12275
12276| 名称 | 描述 |
12277| -------- | -------- |
12278| option | ListItemSwipeActionItem实例。  |
12279
12280**返回:**
12281
12282滑动效果。默认返回值:ARKUI_LIST_ITEM_SWIPE_EDGE_EFFECT_SPRING。
12283
12284
12285### OH_ArkUI_ListItemSwipeActionOption_SetEdgeEffect()
12286
12287```
12288void OH_ArkUI_ListItemSwipeActionOption_SetEdgeEffect (ArkUI_ListItemSwipeActionOption * option, ArkUI_ListItemSwipeEdgeEffect edgeEffect )
12289```
12290**描述:**
12291
12292设置滑动效果。
12293
12294**起始版本:** 12
12295
12296**参数:**
12297
12298| 名称 | 描述 |
12299| -------- | -------- |
12300| option | ListItemSwipeActionItem实例。  |
12301| edgeEffect | 滑动效果。  |
12302
12303
12304### OH_ArkUI_ListItemSwipeActionOption_SetEnd()
12305
12306```
12307void OH_ArkUI_ListItemSwipeActionOption_SetEnd (ArkUI_ListItemSwipeActionOption * option, ArkUI_ListItemSwipeActionItem * item )
12308```
12309**描述:**
12310
12311设置ListItemSwipeActionItem的右侧(垂直布局)或下方(横向布局)布局内容。
12312
12313**起始版本:** 12
12314
12315**参数:**
12316
12317| 名称 | 描述 |
12318| -------- | -------- |
12319| option | ListItemSwipeActionItem实例。  |
12320| builder | 布局信息。  |
12321
12322
12323### OH_ArkUI_ListItemSwipeActionOption_SetOnOffsetChange()
12324
12325```
12326void OH_ArkUI_ListItemSwipeActionOption_SetOnOffsetChange (ArkUI_ListItemSwipeActionOption * option, void(*)(float offset) callback )
12327```
12328**描述:**
12329
12330滑动操作偏移量更改时调用的事件。
12331
12332**起始版本:** 12
12333
12334**参数:**
12335
12336| 名称 | 描述 |
12337| -------- | -------- |
12338| option | ListItemSwipeActionItem实例。  |
12339| callback | 回调事件 offset 滑动偏移量。  |
12340
12341
12342### OH_ArkUI_ListItemSwipeActionOption_SetOnOffsetChangeWithUserData()
12343
12344```
12345void OH_ArkUI_ListItemSwipeActionOption_SetOnOffsetChangeWithUserData (ArkUI_ListItemSwipeActionOption * option, void * userData, void(*)(float offset, void *userData) callback )
12346```
12347**描述:**
12348
12349滑动操作偏移量更改时调用的事件。
12350
12351**起始版本:** 12
12352
12353**参数:**
12354
12355| 名称 | 描述 |
12356| -------- | -------- |
12357| option | ListItemSwipeActionItem实例。  |
12358| userData | 用户自定义数据。  |
12359| callback | 回调事件 offset 滑动偏移量。  |
12360
12361
12362### OH_ArkUI_ListItemSwipeActionOption_SetStart()
12363
12364```
12365void OH_ArkUI_ListItemSwipeActionOption_SetStart (ArkUI_ListItemSwipeActionOption * option, ArkUI_ListItemSwipeActionItem * item )
12366```
12367**描述:**
12368
12369设置ListItemSwipeActionItem的左侧(垂直布局)或上方(横向布局)布局内容。
12370
12371**起始版本:** 12
12372
12373**参数:**
12374
12375| 名称 | 描述 |
12376| -------- | -------- |
12377| option | ListItemSwipeActionItem实例。  |
12378| builder | 布局信息。  |
12379
12380
12381### OH_ArkUI_LongPress_GetRepeatCount()
12382
12383```
12384int32_t OH_ArkUI_LongPress_GetRepeatCount (const ArkUI_GestureEvent * event)
12385```
12386**描述:**
12387
12388返回长按手势定时触发次数。
12389
12390**起始版本:** 12
12391
12392**参数:**
12393
12394| 名称 | 描述 |
12395| -------- | -------- |
12396| event | 手势事件。  |
12397
12398**返回:**
12399
12400长按手势定时触发次数。
12401
12402
12403### OH_ArkUI_MarshallStyledStringDescriptor()
12404
12405```
12406int32_t OH_ArkUI_MarshallStyledStringDescriptor (uint8_t * buffer, size_t bufferSize, ArkUI_StyledString_Descriptor * descriptor, size_t * resultSize )
12407```
12408**描述:**
12409
12410将属性字符串信息序列化为字节数组。
12411
12412**起始版本:** 14
12413
12414**参数:**
12415
12416| 名称 | 描述 |
12417| -------- | -------- |
12418| buffer | 字节数组,用于存储属性字符串序列化后的数据。  |
12419| bufferSize | 字节数组长度。  |
12420| descriptor | 指向ArkUI_StyledString_Descriptor对象的指针。  |
12421| resultSize | 属性字符串转换后的字节数组实际长度。  |
12422
12423**返回:**
12424
12425ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_INVALID_STYLED_STRING 无效的属性字符串。
12426
12427
12428### OH_ArkUI_NodeAdapter_Create()
12429
12430```
12431ArkUI_NodeAdapterHandle OH_ArkUI_NodeAdapter_Create ()
12432```
12433**描述:**
12434
12435创建组件适配器对象。
12436
12437**起始版本:** 12
12438
12439
12440### OH_ArkUI_NodeAdapter_Dispose()
12441
12442```
12443void OH_ArkUI_NodeAdapter_Dispose (ArkUI_NodeAdapterHandle handle)
12444```
12445**描述:**
12446
12447销毁组件适配器对象。
12448
12449**起始版本:** 12
12450
12451**参数:**
12452
12453| 名称 | 描述 |
12454| -------- | -------- |
12455| handle | 组件适配器对象。  |
12456
12457
12458### OH_ArkUI_NodeAdapter_GetAllItems()
12459
12460```
12461int32_t OH_ArkUI_NodeAdapter_GetAllItems (ArkUI_NodeAdapterHandle handle, ArkUI_NodeHandle ** items, uint32_t * size )
12462```
12463**描述:**
12464
12465获取存储在Adapter中的所有元素。
12466
12467接口调用会返回元素的数组对象指针,该指针指向的内存数据需要开发者手动释放。
12468
12469**起始版本:** 12
12470
12471**参数:**
12472
12473| 名称 | 描述 |
12474| -------- | -------- |
12475| handle | 组件适配器对象。  |
12476| items | 适配器内节点数组。  |
12477| size | 元素数量。  |
12478
12479**返回:**
12480
12481ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
12482
12483
12484### OH_ArkUI_NodeAdapter_GetTotalNodeCount()
12485
12486```
12487uint32_t OH_ArkUI_NodeAdapter_GetTotalNodeCount (ArkUI_NodeAdapterHandle handle)
12488```
12489**描述:**
12490
12491获取Adapter中的元素总数。
12492
12493**起始版本:** 12
12494
12495**参数:**
12496
12497| 名称 | 描述 |
12498| -------- | -------- |
12499| handle | 组件适配器对象。  |
12500
12501**返回:**
12502
12503Adapter中的元素总数。
12504
12505
12506### OH_ArkUI_NodeAdapter_InsertItem()
12507
12508```
12509int32_t OH_ArkUI_NodeAdapter_InsertItem (ArkUI_NodeAdapterHandle handle, uint32_t startPosition, uint32_t itemCount )
12510```
12511**描述:**
12512
12513通知Adapter进行局部元素插入。
12514
12515**起始版本:** 12
12516
12517**参数:**
12518
12519| 名称 | 描述 |
12520| -------- | -------- |
12521| handle | 组件适配器对象。  |
12522| startPosition | 元素插入起始位置。  |
12523| itemCount | 元素插入数量。  |
12524
12525**返回:**
12526
12527ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
12528
12529
12530### OH_ArkUI_NodeAdapter_MoveItem()
12531
12532```
12533int32_t OH_ArkUI_NodeAdapter_MoveItem (ArkUI_NodeAdapterHandle handle, uint32_t from, uint32_t to )
12534```
12535**描述:**
12536
12537通知Adapter进行局部元素移位。
12538
12539**起始版本:** 12
12540
12541**参数:**
12542
12543| 名称 | 描述 |
12544| -------- | -------- |
12545| handle | 组件适配器对象。  |
12546| from | 元素移位起始位置。  |
12547| to | 元素移位结束位置。  |
12548
12549**返回:**
12550
12551ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
12552
12553
12554### OH_ArkUI_NodeAdapter_RegisterEventReceiver()
12555
12556```
12557int32_t OH_ArkUI_NodeAdapter_RegisterEventReceiver (ArkUI_NodeAdapterHandle handle, void * userData, void(*)(ArkUI_NodeAdapterEvent *event) receiver )
12558```
12559**描述:**
12560
12561注册Adapter相关回调事件。
12562
12563**起始版本:** 12
12564
12565**参数:**
12566
12567| 名称 | 描述 |
12568| -------- | -------- |
12569| handle | 组件适配器对象。  |
12570| userData | 自定义数据。  |
12571| receiver | 事件接收回调。  |
12572
12573**返回:**
12574
12575ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
12576
12577
12578### OH_ArkUI_NodeAdapter_ReloadAllItems()
12579
12580```
12581int32_t OH_ArkUI_NodeAdapter_ReloadAllItems (ArkUI_NodeAdapterHandle handle)
12582```
12583**描述:**
12584
12585通知Adapter进行全量元素变化。
12586
12587**起始版本:** 12
12588
12589**参数:**
12590
12591| 名称 | 描述 |
12592| -------- | -------- |
12593| handle | 组件适配器对象。  |
12594
12595**返回:**
12596
12597ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
12598
12599
12600### OH_ArkUI_NodeAdapter_ReloadItem()
12601
12602```
12603int32_t OH_ArkUI_NodeAdapter_ReloadItem (ArkUI_NodeAdapterHandle handle, uint32_t startPosition, uint32_t itemCount )
12604```
12605**描述:**
12606
12607通知Adapter进行局部元素变化。
12608
12609**起始版本:** 12
12610
12611**参数:**
12612
12613| 名称 | 描述 |
12614| -------- | -------- |
12615| handle | 组件适配器对象。  |
12616| startPosition | 元素变化起始位置。  |
12617| itemCount | 元素变化数量。  |
12618
12619**返回:**
12620
12621ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
12622
12623
12624### OH_ArkUI_NodeAdapter_RemoveItem()
12625
12626```
12627int32_t OH_ArkUI_NodeAdapter_RemoveItem (ArkUI_NodeAdapterHandle handle, uint32_t startPosition, uint32_t itemCount )
12628```
12629**描述:**
12630
12631通知Adapter进行局部元素删除。
12632
12633**起始版本:** 12
12634
12635**参数:**
12636
12637| 名称 | 描述 |
12638| -------- | -------- |
12639| handle | 组件适配器对象。  |
12640| startPosition | 元素删除起始位置。  |
12641| itemCount | 元素删除数量。  |
12642
12643**返回:**
12644
12645ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
12646
12647
12648### OH_ArkUI_NodeAdapter_SetTotalNodeCount()
12649
12650```
12651int32_t OH_ArkUI_NodeAdapter_SetTotalNodeCount (ArkUI_NodeAdapterHandle handle, uint32_t size )
12652```
12653**描述:**
12654
12655设置Adapter中的元素总数。
12656
12657**起始版本:** 12
12658
12659**参数:**
12660
12661| 名称 | 描述 |
12662| -------- | -------- |
12663| handle | 组件适配器对象。  |
12664| size | 元素数量。  |
12665
12666**返回:**
12667
12668ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
12669
12670
12671### OH_ArkUI_NodeAdapter_UnregisterEventReceiver()
12672
12673```
12674void OH_ArkUI_NodeAdapter_UnregisterEventReceiver (ArkUI_NodeAdapterHandle handle)
12675```
12676**描述:**
12677
12678注销Adapter相关回调事件。
12679
12680**起始版本:** 12
12681
12682**参数:**
12683
12684| 名称 | 描述 |
12685| -------- | -------- |
12686| handle | 组件适配器对象。  |
12687
12688
12689### OH_ArkUI_NodeAdapterEvent_GetHostNode()
12690
12691```
12692ArkUI_NodeHandle OH_ArkUI_NodeAdapterEvent_GetHostNode (ArkUI_NodeAdapterEvent * event)
12693```
12694**描述:**
12695
12696获取使用该适配器的滚动类容器节点。
12697
12698**起始版本:** 12
12699
12700**参数:**
12701
12702| 名称 | 描述 |
12703| -------- | -------- |
12704| event | 适配器事件对象。  |
12705
12706**返回:**
12707
12708适配器的滚动类容器节点。
12709
12710
12711### OH_ArkUI_NodeAdapterEvent_GetItemIndex()
12712
12713```
12714uint32_t OH_ArkUI_NodeAdapterEvent_GetItemIndex (ArkUI_NodeAdapterEvent * event)
12715```
12716**描述:**
12717
12718获取适配器事件时需要操作的元素序号。
12719
12720**起始版本:** 12
12721
12722**参数:**
12723
12724| 名称 | 描述 |
12725| -------- | -------- |
12726| event | 适配器事件对象。  |
12727
12728**返回:**
12729
12730元素序号。
12731
12732
12733### OH_ArkUI_NodeAdapterEvent_GetRemovedNode()
12734
12735```
12736ArkUI_NodeHandle OH_ArkUI_NodeAdapterEvent_GetRemovedNode (ArkUI_NodeAdapterEvent * event)
12737```
12738**描述:**
12739
12740获取需要销毁的事件中待销毁的元素。
12741
12742**起始版本:** 12
12743
12744**参数:**
12745
12746| 名称 | 描述 |
12747| -------- | -------- |
12748| event | 适配器事件对象。  |
12749
12750**返回:**
12751
12752待销毁的元素。
12753
12754
12755### OH_ArkUI_NodeAdapterEvent_GetType()
12756
12757```
12758ArkUI_NodeAdapterEventType OH_ArkUI_NodeAdapterEvent_GetType (ArkUI_NodeAdapterEvent * event)
12759```
12760**描述:**
12761
12762获取事件类型。
12763
12764**起始版本:** 12
12765
12766**参数:**
12767
12768| 名称 | 描述 |
12769| -------- | -------- |
12770| event | 适配器事件对象。  |
12771
12772**返回:**
12773
12774事件类型。
12775
12776
12777### OH_ArkUI_NodeAdapterEvent_GetUserData()
12778
12779```
12780void* OH_ArkUI_NodeAdapterEvent_GetUserData (ArkUI_NodeAdapterEvent * event)
12781```
12782**描述:**
12783
12784获取注册事件时传入的自定义数据。
12785
12786**起始版本:** 12
12787
12788**参数:**
12789
12790| 名称 | 描述 |
12791| -------- | -------- |
12792| event | 适配器事件对象。  |
12793
12794
12795### OH_ArkUI_NodeAdapterEvent_SetItem()
12796
12797```
12798int32_t OH_ArkUI_NodeAdapterEvent_SetItem (ArkUI_NodeAdapterEvent * event, ArkUI_NodeHandle node )
12799```
12800**描述:**
12801
12802设置需要新增到Adapter中的组件。
12803
12804**起始版本:** 12
12805
12806**参数:**
12807
12808| 名称 | 描述 |
12809| -------- | -------- |
12810| event | 适配器事件对象。  |
12811| node | 待添加的组件。  |
12812
12813**返回:**
12814
12815ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
12816
12817
12818### OH_ArkUI_NodeAdapterEvent_SetNodeId()
12819
12820```
12821int32_t OH_ArkUI_NodeAdapterEvent_SetNodeId (ArkUI_NodeAdapterEvent * event, int32_t id )
12822```
12823**描述:**
12824
12825设置生成的组件标识。
12826
12827**起始版本:** 12
12828
12829**参数:**
12830
12831| 名称 | 描述 |
12832| -------- | -------- |
12833| event | 适配器事件对象。  |
12834| id | 设置返回的组件标识。  |
12835
12836**返回:**
12837
12838ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
12839
12840
12841### OH_ArkUI_NodeContent_AddNode()
12842
12843```
12844int32_t OH_ArkUI_NodeContent_AddNode (ArkUI_NodeContentHandle content, ArkUI_NodeHandle node )
12845```
12846**描述:**
12847
12848将一个ArkUI组件节点添加到对应的NodeContent对象下。
12849
12850**起始版本:** 12
12851
12852**参数:**
12853
12854| 名称 | 描述 |
12855| -------- | -------- |
12856| content | 需要被添加节点的NodeContent对象。  |
12857| node | 需要被添加的节点。  |
12858
12859**返回:**
12860
12861ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
12862
12863
12864### OH_ArkUI_NodeContent_GetUserData()
12865
12866```
12867void* OH_ArkUI_NodeContent_GetUserData (ArkUI_NodeContentHandle content)
12868```
12869**描述:**
12870
12871获取在NodeContent对象上保存的自定义数据。
12872
12873**起始版本:** 12
12874
12875**参数:**
12876
12877| 名称 | 描述 |
12878| -------- | -------- |
12879| content | 需要保存自定义数据的NodeContent对象。  |
12880
12881**返回:**
12882
12883自定义数据。
12884
12885
12886### OH_ArkUI_NodeContent_InsertNode()
12887
12888```
12889int32_t OH_ArkUI_NodeContent_InsertNode (ArkUI_NodeContentHandle content, ArkUI_NodeHandle node, int32_t position )
12890```
12891**描述:**
12892
12893将一个ArkUI组件节点插入到对应的NodeContent对象的特定位置下。
12894
12895**起始版本:** 12
12896
12897**参数:**
12898
12899| 名称 | 描述 |
12900| -------- | -------- |
12901| content | 需要被插入节点的NodeContent对象。  |
12902| node | 需要被插入的节点。  |
12903| position | 需要被插入的位置。  |
12904
12905**返回:**
12906
12907ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
12908
12909
12910### OH_ArkUI_NodeContent_RegisterCallback()
12911
12912```
12913int32_t OH_ArkUI_NodeContent_RegisterCallback (ArkUI_NodeContentHandle content, ArkUI_NodeContentCallback callback )
12914```
12915**描述:**
12916
12917注册NodeContent事件函数。
12918
12919**起始版本:** 12
12920
12921**参数:**
12922
12923| 名称 | 描述 |
12924| -------- | -------- |
12925| content | 需要注册事件的NodeContent对象。  |
12926| callback | 事件触发时需要执行的函数回调。  |
12927
12928**返回:**
12929
12930ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
12931
12932
12933### OH_ArkUI_NodeContent_RemoveNode()
12934
12935```
12936int32_t OH_ArkUI_NodeContent_RemoveNode (ArkUI_NodeContentHandle content, ArkUI_NodeHandle node )
12937```
12938**描述:**
12939
12940删除NodeContent对象下的一个ArkUI组件节点
12941
12942**起始版本:** 12
12943
12944**参数:**
12945
12946| 名称 | 描述 |
12947| -------- | -------- |
12948| content | 需要被删除节点的NodeContent对象。  |
12949| node | 需要被删除的节点。  |
12950
12951**返回:**
12952
12953ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
12954
12955
12956### OH_ArkUI_NodeContent_SetUserData()
12957
12958```
12959int32_t OH_ArkUI_NodeContent_SetUserData (ArkUI_NodeContentHandle content, void * userData )
12960```
12961**描述:**
12962
12963在NodeContent对象上保存自定义数据。
12964
12965**起始版本:** 12
12966
12967**参数:**
12968
12969| 名称 | 描述 |
12970| -------- | -------- |
12971| content | 需要保存自定义数据的NodeContent对象。  |
12972| userData | 要保存的自定义数据。  |
12973
12974**返回:**
12975
12976ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
12977
12978
12979### OH_ArkUI_NodeContentEvent_GetEventType()
12980
12981```
12982ArkUI_NodeContentEventType OH_ArkUI_NodeContentEvent_GetEventType (ArkUI_NodeContentEvent * event)
12983```
12984**描述:**
12985
12986获取触发NodeContent事件的事件类型。
12987
12988**起始版本:** 12
12989
12990**参数:**
12991
12992| 名称 | 描述 |
12993| -------- | -------- |
12994| event | NodeContent事件指针。  |
12995
12996**返回:**
12997
12998NodeContent事件类型。
12999
13000
13001### OH_ArkUI_NodeContentEvent_GetNodeContentHandle()
13002
13003```
13004ArkUI_NodeContentHandle OH_ArkUI_NodeContentEvent_GetNodeContentHandle (ArkUI_NodeContentEvent * event)
13005```
13006**描述:**
13007
13008获取触发事件的NodeContent对象。
13009
13010**起始版本:** 12
13011
13012**参数:**
13013
13014| 名称 | 描述 |
13015| -------- | -------- |
13016| event | NodeContent事件指针。  |
13017
13018**返回:**
13019
13020Returns 触发事件的NodeContent对象。
13021
13022
13023### OH_ArkUI_NodeCustomEvent_GetCustomSpanDrawInfo()
13024
13025```
13026int32_t OH_ArkUI_NodeCustomEvent_GetCustomSpanDrawInfo (ArkUI_NodeCustomEvent * event, ArkUI_CustomSpanDrawInfo * info )
13027```
13028**描述:**
13029
13030通过自定义组件事件获取自定义段落组件的绘制信息。
13031
13032**起始版本:** 12
13033
13034**参数:**
13035
13036| 名称 | 描述 |
13037| -------- | -------- |
13038| event | 自定义组件事件。  |
13039| info | 需要获取的绘制信息。  |
13040
13041**返回:**
13042
13043ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 异常原因:传入参数验证失败,参数不能为空。
13044
13045
13046### OH_ArkUI_NodeCustomEvent_GetCustomSpanMeasureInfo()
13047
13048```
13049int32_t OH_ArkUI_NodeCustomEvent_GetCustomSpanMeasureInfo (ArkUI_NodeCustomEvent * event, ArkUI_CustomSpanMeasureInfo * info )
13050```
13051**描述:**
13052
13053通过自定义组件事件获取自定义段落组件的测量信息。
13054
13055**起始版本:** 12
13056
13057**参数:**
13058
13059| 名称 | 描述 |
13060| -------- | -------- |
13061| event | 自定义组件事件。  |
13062| info | 需要获取的测量信息。  |
13063
13064**返回:**
13065
13066ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 异常原因:传入参数验证失败,参数不能为空。
13067
13068
13069### OH_ArkUI_NodeCustomEvent_GetDrawContextInDraw()
13070
13071```
13072ArkUI_DrawContext* OH_ArkUI_NodeCustomEvent_GetDrawContextInDraw (ArkUI_NodeCustomEvent * event)
13073```
13074**描述:**
13075
13076通过自定义组件事件获取绘制上下文。
13077
13078**起始版本:** 12
13079
13080**参数:**
13081
13082| 名称 | 描述 |
13083| -------- | -------- |
13084| event | 自定义组件事件。  |
13085
13086**返回:**
13087
13088绘制上下文。
13089
13090
13091### OH_ArkUI_NodeCustomEvent_GetEventTargetId()
13092
13093```
13094int32_t OH_ArkUI_NodeCustomEvent_GetEventTargetId (ArkUI_NodeCustomEvent * event)
13095```
13096**描述:**
13097
13098通过自定义组件事件获取自定义事件ID。
13099
13100**起始版本:** 12
13101
13102**参数:**
13103
13104| 名称 | 描述 |
13105| -------- | -------- |
13106| event | 自定义组件事件。  |
13107
13108**返回:**
13109
13110自定义事件ID。
13111
13112
13113### OH_ArkUI_NodeCustomEvent_GetEventType()
13114
13115```
13116ArkUI_NodeCustomEventType OH_ArkUI_NodeCustomEvent_GetEventType (ArkUI_NodeCustomEvent * event)
13117```
13118**描述:**
13119
13120通过自定义组件事件获取事件类型。
13121
13122**起始版本:** 12
13123
13124**参数:**
13125
13126| 名称 | 描述 |
13127| -------- | -------- |
13128| event | 自定义组件事件。  |
13129
13130**返回:**
13131
13132组件自定义事件类型。
13133
13134
13135### OH_ArkUI_NodeCustomEvent_GetLayoutConstraintInMeasure()
13136
13137```
13138ArkUI_LayoutConstraint* OH_ArkUI_NodeCustomEvent_GetLayoutConstraintInMeasure (ArkUI_NodeCustomEvent * event)
13139```
13140**描述:**
13141
13142通过自定义组件事件获取测算过程中的约束尺寸。
13143
13144**起始版本:** 12
13145
13146**参数:**
13147
13148| 名称 | 描述 |
13149| -------- | -------- |
13150| event | 自定义组件事件。  |
13151
13152**返回:**
13153
13154约束尺寸指针。
13155
13156
13157### OH_ArkUI_NodeCustomEvent_GetNodeHandle()
13158
13159```
13160ArkUI_NodeHandle OH_ArkUI_NodeCustomEvent_GetNodeHandle (ArkUI_NodeCustomEvent * event)
13161```
13162**描述:**
13163
13164通过自定义组件事件获取组件对象。
13165
13166**起始版本:** 12
13167
13168**参数:**
13169
13170| 名称 | 描述 |
13171| -------- | -------- |
13172| event | 自定义组件事件。  |
13173
13174**返回:**
13175
13176组件对象。
13177
13178
13179### OH_ArkUI_NodeCustomEvent_GetPositionInLayout()
13180
13181```
13182ArkUI_IntOffset OH_ArkUI_NodeCustomEvent_GetPositionInLayout (ArkUI_NodeCustomEvent * event)
13183```
13184**描述:**
13185
13186通过自定义组件事件获取在布局阶段期望自身相对父组件的位置。
13187
13188**起始版本:** 12
13189
13190**参数:**
13191
13192| 名称 | 描述 |
13193| -------- | -------- |
13194| event | 自定义组件事件。  |
13195
13196**返回:**
13197
13198期望自身相对父组件的位置。
13199
13200
13201### OH_ArkUI_NodeCustomEvent_GetUserData()
13202
13203```
13204void* OH_ArkUI_NodeCustomEvent_GetUserData (ArkUI_NodeCustomEvent * event)
13205```
13206**描述:**
13207
13208通过自定义组件事件获取自定义事件参数。
13209
13210**起始版本:** 12
13211
13212**参数:**
13213
13214| 名称 | 描述 |
13215| -------- | -------- |
13216| event | 自定义组件事件。  |
13217
13218**返回:**
13219
13220自定义事件参数。
13221
13222
13223### OH_ArkUI_NodeCustomEvent_SetCustomSpanMetrics()
13224
13225```
13226int32_t OH_ArkUI_NodeCustomEvent_SetCustomSpanMetrics (ArkUI_NodeCustomEvent * event, ArkUI_CustomSpanMetrics * metrics )
13227```
13228**描述:**
13229
13230通过自定义组件事件设置自定义段落的度量指标。
13231
13232**起始版本:** 12
13233
13234**参数:**
13235
13236| 名称 | 描述 |
13237| -------- | -------- |
13238| event | 自定义组件事件。  |
13239| metrics | 需要获取的度量指标信息。  |
13240
13241**返回:**
13242
13243ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 异常原因:传入参数验证失败,参数不能为空。
13244
13245
13246### OH_ArkUI_NodeEvent_GetDragEvent()
13247
13248```
13249ArkUI_DragEvent* OH_ArkUI_NodeEvent_GetDragEvent (ArkUI_NodeEvent * nodeEvent)
13250```
13251**描述:**
13252
13253从 NodeEvent 中获取DragEvent。
13254
13255**起始版本:** 12
13256
13257**参数:**
13258
13259| 名称 | 描述 |
13260| -------- | -------- |
13261| node | ArkUI_NodeEvent事件指针。  |
13262
13263**返回:**
13264
13265ArkUI_DragEvent 事件指针,当传入的 NodeEvent 无效或不是拖拽相关的事件时,则返回空。
13266
13267
13268### OH_ArkUI_NodeEvent_GetEventType()
13269
13270```
13271ArkUI_NodeEventType OH_ArkUI_NodeEvent_GetEventType (ArkUI_NodeEvent * event)
13272```
13273**描述:**
13274
13275获取组件事件类型。
13276
13277**起始版本:** 12
13278
13279**参数:**
13280
13281| 名称 | 描述 |
13282| -------- | -------- |
13283| event | 组件事件指针。  |
13284
13285**返回:**
13286
13287ArkUI_NodeEventType 组件事件类型。
13288
13289
13290### OH_ArkUI_NodeEvent_GetInputEvent()
13291
13292```
13293ArkUI_UIInputEvent* OH_ArkUI_NodeEvent_GetInputEvent (ArkUI_NodeEvent * event)
13294```
13295**描述:**
13296
13297获取组件事件中的输入事件(如触碰事件)数据。
13298
13299**起始版本:** 12
13300
13301**参数:**
13302
13303| 名称 | 描述 |
13304| -------- | -------- |
13305| event | 组件事件指针。  |
13306
13307**返回:**
13308
13309ArkUI_UIInputEvent\* 输入事件数据指针。
13310
13311
13312### OH_ArkUI_NodeEvent_GetNodeComponentEvent()
13313
13314```
13315ArkUI_NodeComponentEvent* OH_ArkUI_NodeEvent_GetNodeComponentEvent (ArkUI_NodeEvent * event)
13316```
13317**描述:**
13318
13319获取组件事件中的数字类型数据。
13320
13321**起始版本:** 12
13322
13323**参数:**
13324
13325| 名称 | 描述 |
13326| -------- | -------- |
13327| event | 组件事件指针。  |
13328
13329**返回:**
13330
13331ArkUI_NodeComponentEvent\* 数字类型数据指针。
13332
13333
13334### OH_ArkUI_NodeEvent_GetNodeHandle()
13335
13336```
13337ArkUI_NodeHandle OH_ArkUI_NodeEvent_GetNodeHandle (ArkUI_NodeEvent * event)
13338```
13339**描述:**
13340
13341获取触发该事件的组件对象。
13342
13343**起始版本:** 12
13344
13345**参数:**
13346
13347| 名称 | 描述 |
13348| -------- | -------- |
13349| event | 组件事件指针。  |
13350
13351**返回:**
13352
13353ArkUI_NodeHandle 触发该组件的组件对象。
13354
13355
13356### OH_ArkUI_NodeEvent_GetNumberValue()
13357
13358```
13359int32_t OH_ArkUI_NodeEvent_GetNumberValue (ArkUI_NodeEvent * event, int32_t index, ArkUI_NumberValue * value )
13360```
13361**描述:**
13362
13363获取组件回调事件的数字类型参数。
13364
13365**起始版本:** 12
13366
13367**参数:**
13368
13369| 名称 | 描述 |
13370| -------- | -------- |
13371| event | 组件事件指针。  |
13372| index | 返回值索引。  |
13373| value | 具体返回值。  |
13374
13375**返回:**
13376
13377ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_NODE_EVENT_PARAM_INDEX_OUT_OF_RANGE 组件事件中参数长度超限。 ARKUI_ERROR_CODE_NODE_EVENT_PARAM_INVALID 组件事件中不存在该数据。
13378
13379
13380### OH_ArkUI_NodeEvent_GetPreDragStatus()
13381
13382```
13383ArkUI_PreDragStatus OH_ArkUI_NodeEvent_GetPreDragStatus (ArkUI_NodeEvent * nodeEvent)
13384```
13385**描述:**
13386
13387获取预览拖拽事件状态。
13388
13389**起始版本:** 12
13390
13391**参数:**
13392
13393| 名称 | 描述 |
13394| -------- | -------- |
13395| node | ArkUI_NodeEvent节点对象。  |
13396
13397**返回:**
13398
13399ArkUI_PreDragStatus 拖拽发起前交互状态。
13400
13401
13402### OH_ArkUI_NodeEvent_GetStringAsyncEvent()
13403
13404```
13405ArkUI_StringAsyncEvent* OH_ArkUI_NodeEvent_GetStringAsyncEvent (ArkUI_NodeEvent * event)
13406```
13407**描述:**
13408
13409获取组件事件中的字符串数据。
13410
13411**起始版本:** 12
13412
13413**参数:**
13414
13415| 名称 | 描述 |
13416| -------- | -------- |
13417| event | 组件事件指针。  |
13418
13419**返回:**
13420
13421ArkUI_StringAsyncEvent\* 字符串数据指针。
13422
13423
13424### OH_ArkUI_NodeEvent_GetStringValue()
13425
13426```
13427int32_t OH_ArkUI_NodeEvent_GetStringValue (ArkUI_NodeEvent * event, int32_t index, char ** string, int32_t * stringSize )
13428```
13429**描述:**
13430
13431获取组件回调事件的字符串类型参数,字符串数据仅在事件回调过程中有效,需要在事件回调外使用建议进行额外拷贝处理。
13432
13433**起始版本:** 12
13434
13435**参数:**
13436
13437| 名称 | 描述 |
13438| -------- | -------- |
13439| event | 组件事件指针。  |
13440| index | 返回值索引。  |
13441| string | 字符串数组的指针。  |
13442| stringSize | 字符串数组的长度。  |
13443
13444**返回:**
13445
13446ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_NODE_EVENT_PARAM_INDEX_OUT_OF_RANGE 组件事件中参数长度超限。 ARKUI_ERROR_CODE_NODE_EVENT_PARAM_INVALID 组件事件中不存在该数据。
13447
13448
13449### OH_ArkUI_NodeEvent_GetTargetId()
13450
13451```
13452int32_t OH_ArkUI_NodeEvent_GetTargetId (ArkUI_NodeEvent * event)
13453```
13454**描述:**
13455
13456获取事件自定义标识ID。
13457
13458该事件id在调用**registerNodeEvent**函数时作为参数传递进来,可应用于同一事件入口函数**registerNodeEventReceiver**分发逻辑。
13459
13460**起始版本:** 12
13461
13462**参数:**
13463
13464| 名称 | 描述 |
13465| -------- | -------- |
13466| event | 组件事件指针。  |
13467
13468**返回:**
13469
13470int32_t 事件自定义标识ID。
13471
13472
13473### OH_ArkUI_NodeEvent_GetUserData()
13474
13475```
13476void* OH_ArkUI_NodeEvent_GetUserData (ArkUI_NodeEvent * event)
13477```
13478**描述:**
13479
13480获取组件事件中的用户自定义数据。
13481
13482该自定义参数在调用**registerNodeEvent**函数时作为参数传递进来,可应用于事件触发时的业务逻辑处理。
13483
13484**起始版本:** 12
13485
13486**参数:**
13487
13488| 名称 | 描述 |
13489| -------- | -------- |
13490| event | 组件事件指针。  |
13491
13492**返回:**
13493
13494void\* 用户自定义数据指针。
13495
13496
13497### OH_ArkUI_NodeEvent_SetReturnNumberValue()
13498
13499```
13500int32_t OH_ArkUI_NodeEvent_SetReturnNumberValue (ArkUI_NodeEvent * event, ArkUI_NumberValue * value, int32_t size )
13501```
13502**描述:**
13503
13504设置组件回调事件的返回值。
13505
13506**起始版本:** 12
13507
13508**参数:**
13509
13510| 名称 | 描述 |
13511| -------- | -------- |
13512| event | 组件事件指针。  |
13513| value | 事件数字类型数组。  |
13514| size | 数组长度。  |
13515
13516**返回:**
13517
13518ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_NODE_EVENT_NO_RETURN 组件事件不支持返回值。 ARKUI_ERROR_CODE_NODE_EVENT_PARAM_INVALID 组件事件中不存在该数据。
13519
13520
13521### OH_ArkUI_NodeUtils_AddCustomProperty()
13522
13523```
13524void OH_ArkUI_NodeUtils_AddCustomProperty (ArkUI_NodeHandle node, const char * name, const char * value )
13525```
13526**描述:**
13527
13528设置组件的自定义属性。该接口仅在主线程生效。
13529
13530**起始版本:** 13
13531
13532**参数:**
13533
13534| 名称 | 描述 |
13535| -------- | -------- |
13536| node | ArkUI_NodeHandle指针。  |
13537| name | 自定义属性的名称。不允许传入空指针。  |
13538| value | 对应key参数名称的自定义属性的值。不允许传入空指针。  |
13539
13540
13541### OH_ArkUI_NodeUtils_GetActiveChildrenInfo()
13542
13543```
13544int32_t OH_ArkUI_NodeUtils_GetActiveChildrenInfo (ArkUI_NodeHandle head, ArkUI_ActiveChildrenInfo ** handle )
13545```
13546**描述:**
13547
13548获取某个节点所有活跃的子节点。Span将不会被计入子结点的统计中。
13549
13550**起始版本:** 14
13551
13552**参数:**
13553
13554| 名称 | 描述 |
13555| -------- | -------- |
13556| head | 传入需要获取的节点。  |
13557| handle | 对应head节点子节点信息的结构体。  |
13558
13559**返回:**
13560
13561ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
13562
13563
13564### OH_ArkUI_NodeUtils_GetCurrentPageRootNode()
13565
13566```
13567ArkUI_NodeHandle OH_ArkUI_NodeUtils_GetCurrentPageRootNode (ArkUI_NodeHandle node)
13568```
13569**描述:**
13570
13571获取当前页面的根节点。
13572
13573**起始版本:** 14
13574
13575**参数:**
13576
13577| 名称 | 描述 |
13578| -------- | -------- |
13579| node | 目标节点对象。  |
13580
13581**返回:**
13582
13583根节点的指针,如果没有返回NULL。
13584
13585
13586### OH_ArkUI_NodeUtils_GetCustomProperty()
13587
13588```
13589int32_t OH_ArkUI_NodeUtils_GetCustomProperty (ArkUI_NodeHandle node, const char * name, ArkUI_CustomProperty ** handle )
13590```
13591**描述:**
13592
13593获取组件的自定义属性的值。
13594
13595**起始版本:** 14
13596
13597**参数:**
13598
13599| 名称 | 描述 |
13600| -------- | -------- |
13601| node | ArkUI_NodeHandle指针。  |
13602| name | 自定义属性的名称。  |
13603| handle | 获取的对应key参数名称的自定义属性的结构体。  |
13604
13605**返回:**
13606
13607ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
13608
13609
13610### OH_ArkUI_NodeUtils_GetLayoutPosition()
13611
13612```
13613int32_t OH_ArkUI_NodeUtils_GetLayoutPosition (ArkUI_NodeHandle node, ArkUI_IntOffset * localOffset )
13614```
13615**描述:**
13616
13617获取组件布局区域相对父组件的位置。 布局区域相对位置不包含图形变化属性,如平移。
13618
13619**起始版本:** 12
13620
13621**参数:**
13622
13623| 名称 | 描述 |
13624| -------- | -------- |
13625| node | ArkUI_NodeHandle指针。  |
13626| localOffset | 组件handle相对父组件的偏移值,单位:px。  |
13627
13628**返回:**
13629
13630ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
13631
13632
13633### OH_ArkUI_NodeUtils_GetLayoutPositionInScreen()
13634
13635```
13636int32_t OH_ArkUI_NodeUtils_GetLayoutPositionInScreen (ArkUI_NodeHandle node, ArkUI_IntOffset * screenOffset )
13637```
13638**描述:**
13639
13640获取组件布局区域相对屏幕的位置。 布局区域相对位置不包含图形变化属性,如平移。
13641
13642**起始版本:** 12
13643
13644**参数:**
13645
13646| 名称 | 描述 |
13647| -------- | -------- |
13648| node | ArkUI_NodeHandle指针。  |
13649| screenOffset | 组件handle相对屏幕的偏移值,单位:px。  |
13650
13651**返回:**
13652
13653ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
13654
13655
13656### OH_ArkUI_NodeUtils_GetLayoutPositionInWindow()
13657
13658```
13659int32_t OH_ArkUI_NodeUtils_GetLayoutPositionInWindow (ArkUI_NodeHandle node, ArkUI_IntOffset * globalOffset )
13660```
13661**描述:**
13662
13663获取组件布局区域相对窗口的位置。 布局区域相对位置不包含图形变化属性,如平移。
13664
13665**起始版本:** 12
13666
13667**参数:**
13668
13669| 名称 | 描述 |
13670| -------- | -------- |
13671| node | ArkUI_NodeHandle指针。  |
13672| globalOffset | 组件handle相对窗口的偏移值,单位:px。  |
13673
13674**返回:**
13675
13676ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
13677
13678
13679### OH_ArkUI_NodeUtils_GetLayoutSize()
13680
13681```
13682int32_t OH_ArkUI_NodeUtils_GetLayoutSize (ArkUI_NodeHandle node, ArkUI_IntSize * size )
13683```
13684**描述:**
13685
13686获取组件布局区域的大小。 布局区域大小不包含图形变化属性,如缩放。
13687
13688**起始版本:** 12
13689
13690**参数:**
13691
13692| 名称 | 描述 |
13693| -------- | -------- |
13694| node | ArkUI_NodeHandle指针。  |
13695| size | 组件handle的绘制区域尺寸,单位:px。  |
13696
13697**返回:**
13698
13699ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
13700
13701
13702### OH_ArkUI_NodeUtils_GetNodeType()
13703
13704```
13705int32_t OH_ArkUI_NodeUtils_GetNodeType (ArkUI_NodeHandle node)
13706```
13707**描述:**
13708
13709获取节点的类型。
13710
13711**起始版本:** 14
13712
13713**参数:**
13714
13715| 名称 | 描述 |
13716| -------- | -------- |
13717| node | 目标节点对象。  |
13718
13719**返回:**
13720
13721节点的类型,具体已开放类型参考[ArkUI_NodeType](#arkui_nodetype),未开放结点返回-1。
13722
13723
13724### OH_ArkUI_NodeUtils_GetParentInPageTree()
13725
13726```
13727ArkUI_NodeHandle OH_ArkUI_NodeUtils_GetParentInPageTree (ArkUI_NodeHandle node)
13728```
13729**描述:**
13730
13731获取父节点,可获取由ArkTs创建的组件节点。
13732
13733**起始版本:** 14
13734
13735**参数:**
13736
13737| 名称 | 描述 |
13738| -------- | -------- |
13739| node | 目标节点对象。  |
13740
13741**返回:**
13742
13743组件的指针,如果没有返回NULL
13744
13745
13746### OH_ArkUI_NodeUtils_GetPositionWithTranslateInScreen()
13747
13748```
13749int32_t OH_ArkUI_NodeUtils_GetPositionWithTranslateInScreen (ArkUI_NodeHandle node, ArkUI_IntOffset * translateOffset )
13750```
13751**描述:**
13752
13753获取组件在屏幕中的位置,包含了图形平移变化属性。
13754
13755**起始版本:** 12
13756
13757**参数:**
13758
13759| 名称 | 描述 |
13760| -------- | -------- |
13761| node | ArkUI_NodeHandle指针。  |
13762| translateOffset | 组件handle自身,父组件及祖先节点的偏移累计值,单位:px。  |
13763
13764**返回:**
13765
13766ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
13767
13768
13769### OH_ArkUI_NodeUtils_GetPositionWithTranslateInWindow()
13770
13771```
13772int32_t OH_ArkUI_NodeUtils_GetPositionWithTranslateInWindow (ArkUI_NodeHandle node, ArkUI_IntOffset * translateOffset )
13773```
13774**描述:**
13775
13776获取组件在窗口中的位置,包含了图形平移变化属性。
13777
13778**起始版本:** 12
13779
13780**参数:**
13781
13782| 名称 | 描述 |
13783| -------- | -------- |
13784| node | ArkUI_NodeHandle指针。  |
13785| translateOffset | 组件handle自身,父组件及祖先节点的偏移累计值,单位:px。  |
13786
13787**返回:**
13788
13789ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
13790
13791
13792### OH_ArkUI_NodeUtils_IsCreatedByNDK()
13793
13794```
13795bool OH_ArkUI_NodeUtils_IsCreatedByNDK (ArkUI_NodeHandle node)
13796```
13797**描述:**
13798
13799获取组件是否由C-API创建的标签。
13800
13801**起始版本:** 14
13802
13803**参数:**
13804
13805| 名称 | 描述 |
13806| -------- | -------- |
13807| node | 目标节点对象。  |
13808
13809**返回:**
13810
13811节点是否由C-API创建的Tag,true代表由C-API创建,false代表非C-API创建。
13812
13813
13814### OH_ArkUI_NodeUtils_RemoveCustomProperty()
13815
13816```
13817void OH_ArkUI_NodeUtils_RemoveCustomProperty (ArkUI_NodeHandle node, const char * name )
13818```
13819**描述:**
13820
13821移除组件已设置的自定义属性。
13822
13823**起始版本:** 13
13824
13825**参数:**
13826
13827| 名称 | 描述 |
13828| -------- | -------- |
13829| node | ArkUI_NodeHandle指针。  |
13830| name | 自定义属性的名称。  |
13831
13832
13833### OH_ArkUI_PanGesture_GetOffsetX()
13834
13835```
13836float OH_ArkUI_PanGesture_GetOffsetX (const ArkUI_GestureEvent * event)
13837```
13838**描述:**
13839
13840滑动手势返回当前手势事件x轴相对偏移量。
13841
13842**起始版本:** 12
13843
13844**参数:**
13845
13846| 名称 | 描述 |
13847| -------- | -------- |
13848| event | 手势事件。  |
13849
13850**返回:**
13851
13852当前手势事件x轴相对偏移量,单位为px。
13853
13854
13855### OH_ArkUI_PanGesture_GetOffsetY()
13856
13857```
13858float OH_ArkUI_PanGesture_GetOffsetY (const ArkUI_GestureEvent * event)
13859```
13860**描述:**
13861
13862滑动手势返回当前手势事件y轴相对偏移量。
13863
13864**起始版本:** 12
13865
13866**参数:**
13867
13868| 名称 | 描述 |
13869| -------- | -------- |
13870| event | 手势事件。  |
13871
13872**返回:**
13873
13874当前手势事件y轴相对偏移量,单位为px。
13875
13876
13877### OH_ArkUI_PanGesture_GetVelocity()
13878
13879```
13880float OH_ArkUI_PanGesture_GetVelocity (const ArkUI_GestureEvent * event)
13881```
13882**描述:**
13883
13884滑动手势返回手势主方向速度。
13885
13886**起始版本:** 12
13887
13888**参数:**
13889
13890| 名称 | 描述 |
13891| -------- | -------- |
13892| event | 手势事件。  |
13893
13894**返回:**
13895
13896当前手势主方向速度,为xy轴方向速度的平方和的算数平方根,单位px/秒。
13897
13898
13899### OH_ArkUI_PanGesture_GetVelocityX()
13900
13901```
13902float OH_ArkUI_PanGesture_GetVelocityX (const ArkUI_GestureEvent * event)
13903```
13904**描述:**
13905
13906滑动手势返回当前手势的x轴方向速度。
13907
13908**起始版本:** 12
13909
13910**参数:**
13911
13912| 名称 | 描述 |
13913| -------- | -------- |
13914| event | 手势事件。  |
13915
13916**返回:**
13917
13918当前手势的x轴方向速度,单位px/秒。
13919
13920
13921### OH_ArkUI_PanGesture_GetVelocityY()
13922
13923```
13924float OH_ArkUI_PanGesture_GetVelocityY (const ArkUI_GestureEvent * event)
13925```
13926**描述:**
13927
13928滑动手势返回当前手势的y轴方向速度。
13929
13930**起始版本:** 12
13931
13932**参数:**
13933
13934| 名称 | 描述 |
13935| -------- | -------- |
13936| event | 手势事件。  |
13937
13938**返回:**
13939
13940当前手势的y轴方向速度,单位px/秒。
13941
13942
13943### OH_ArkUI_ParallelInnerGestureEvent_GetConflictRecognizers()
13944
13945```
13946int32_t OH_ArkUI_ParallelInnerGestureEvent_GetConflictRecognizers (ArkUI_ParallelInnerGestureEvent * event, ArkUI_GestureRecognizerHandleArray * array, int32_t * size )
13947```
13948**描述:**
13949
13950获取并行内部手势事件中的冲突的手势识别器。
13951
13952**起始版本:** 12
13953
13954**参数:**
13955
13956| 名称 | 描述 |
13957| -------- | -------- |
13958| event | 并行内部手势事件。  |
13959| array | 冲突的手势识别器数组。  |
13960| size | 冲突的手势识别器数组的大小。  |
13961
13962**返回:**
13963
13964[ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md#arkui_errorcode) - 成功。 [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md#arkui_errorcode) - 参数错误。
13965
13966
13967### OH_ArkUI_ParallelInnerGestureEvent_GetCurrentRecognizer()
13968
13969```
13970ArkUI_GestureRecognizer* OH_ArkUI_ParallelInnerGestureEvent_GetCurrentRecognizer (ArkUI_ParallelInnerGestureEvent * event)
13971```
13972**描述:**
13973
13974获取并行内部手势事件中的当前手势识别器。
13975
13976**起始版本:** 12
13977
13978**参数:**
13979
13980| 名称 | 描述 |
13981| -------- | -------- |
13982| event | 并行内部手势事件。  |
13983
13984**返回:**
13985
13986当前手势识别器的指针。
13987
13988### OH_ArkUI_ParallelInnerGestureEvent_GetUserData()
13989
13990```
13991void* OH_ArkUI_ParallelInnerGestureEvent_GetUserData (ArkUI_ParallelInnerGestureEvent * event)
13992```
13993**描述:**
13994
13995获取并行内部手势事件中的用户自定义数据。
13996
13997**起始版本:** 12
13998
13999**参数:**
14000
14001| 名称 | 描述 |
14002| -------- | -------- |
14003| event | 并行内部手势事件。  |
14004
14005**返回:**
14006
14007用户自定义数据的指针。
14008
14009### OH_ArkUI_GestureInterrupter_GetUserData
14010
14011```
14012void* OH_ArkUI_GestureInterrupter_GetUserData(ArkUI_GestureInterruptInfo* event)
14013```
14014
14015**描述:**
14016
14017获取手势中断事件中的用户自定义数据。
14018
14019**起始版本:** 18
14020
14021**参数:**
14022
14023| 名称  | 描述                       |
14024| ----- | -------------------------- |
14025| event | 是指向手势中断信息的指针。 |
14026
14027**返回:**
14028
14029指向用户自定义数据的指针。
14030
14031
14032### OH_ArkUI_PinchGesture_GetCenterX()
14033
14034```
14035float OH_ArkUI_PinchGesture_GetCenterX (const ArkUI_GestureEvent * event)
14036```
14037**描述:**
14038
14039捏合手势中心点相对于当前组件元素左上角x轴坐标。
14040
14041**起始版本:** 12
14042
14043**参数:**
14044
14045| 名称 | 描述 |
14046| -------- | -------- |
14047| event | 手势事件。  |
14048
14049**返回:**
14050
14051捏合手势中心点相对于当前组件元素左上角x轴坐标,单位为px。
14052
14053
14054### OH_ArkUI_PinchGesture_GetCenterY()
14055
14056```
14057float OH_ArkUI_PinchGesture_GetCenterY (const ArkUI_GestureEvent * event)
14058```
14059**描述:**
14060
14061捏合手势中心点相对于当前组件元素左上角y轴坐标。
14062
14063**起始版本:** 12
14064
14065**参数:**
14066
14067| 名称 | 描述 |
14068| -------- | -------- |
14069| event | 手势事件。  |
14070
14071**返回:**
14072
14073捏合手势中心点相对于当前组件元素左上角y轴坐标,单位为px。
14074
14075
14076### OH_ArkUI_PinchGesture_GetScale()
14077
14078```
14079float OH_ArkUI_PinchGesture_GetScale (const ArkUI_GestureEvent * event)
14080```
14081**描述:**
14082
14083捏合手势返回当前手势事件缩放信息。
14084
14085**起始版本:** 12
14086
14087**参数:**
14088
14089| 名称 | 描述 |
14090| -------- | -------- |
14091| event | 手势事件。  |
14092
14093**返回:**
14094
14095缩放比例。
14096
14097
14098### OH_ArkUI_QueryModuleInterfaceByName()
14099
14100```
14101void* OH_ArkUI_QueryModuleInterfaceByName (ArkUI_NativeAPIVariantKind type, const char * structName )
14102```
14103**描述:**
14104
14105获取指定类型的Native模块接口集合。
14106
14107**起始版本:** 12
14108
14109**参数:**
14110
14111| 名称 | 描述 |
14112| -------- | -------- |
14113| type | ArkUI提供的Native接口集合大类,例如UI组件接口类:ARKUI_NATIVE_NODE, 手势类:ARKUI_NATIVE_GESTURE。  |
14114| sturctName | native接口结构体的名称,通过查询对应头文件内结构体定义,例如位于&lt;arkui/native_node.h&gt;中的"ArkUI_NativeNodeAPI_1"。  |
14115
14116**返回:**
14117
14118void\* 返回Native接口抽象指针,在转化为具体类型后进行使用。 \#include&lt;arkui/native_interface.h&gt; \#include&lt;arkui/native_node.h&gt; \#include&lt;arkui/native_gesture.h&gt; auto\* anyNativeAPI = [OH_ArkUI_QueryModuleInterfaceByName](#oh_arkui_querymoduleinterfacebyname)(ARKUI_NATIVE_NODE, "ArkUI_NativeNodeAPI_1"); if (anyNativeAPI) { auto nativeNodeApi = reinterpret_cast&lt;[ArkUI_NativeNodeAPI_1](_ark_u_i___native_node_a_p_i__1.md)\*&gt;(anyNativeAPI); } auto anyGestureAPI = OH_ArkUI_QueryModuleInterface(ARKUI_NATIVE_GESTURE, "ArkUI_NativeGestureAPI_1"); if (anyNativeAPI) { auto basicGestureApi = reinterpret_cast&lt;[ArkUI_NativeGestureAPI_1](_ark_u_i___native_gesture_a_p_i__1.md)\*&gt;(anyGestureAPI); }
14119
14120
14121### OH_ArkUI_RegisterSystemColorModeChangeEvent()
14122
14123```
14124int32_t OH_ArkUI_RegisterSystemColorModeChangeEvent (ArkUI_NodeHandle node, void * userData, void(*)(ArkUI_SystemColorMode colorMode, void *userData) onColorModeChange )
14125```
14126**描述:**
14127
14128注册系统深浅色变更事件。同一组件仅能注册一个系统深浅变更回调。
14129
14130**起始版本:** 12
14131
14132**参数:**
14133
14134| 名称 | 描述 |
14135| -------- | -------- |
14136| node | 指定的节点。  |
14137| userData | 自定义事件参数,当事件触发时在回调参数中携带回来。  |
14138| onColorModeChange | 事件触发后的回调。  |
14139
14140**返回:**
14141
14142ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_ATTRIBUTE_OR_EVENT_NOT_SUPPORTED 组件不支持该事件。
14143
14144
14145### OH_ArkUI_RegisterSystemFontStyleChangeEvent()
14146
14147```
14148int32_t OH_ArkUI_RegisterSystemFontStyleChangeEvent (ArkUI_NodeHandle node, void * userData, void(*)(ArkUI_SystemFontStyleEvent *event, void *userData) onFontStyleChange )
14149```
14150**描述:**
14151
14152注册系统字体变更事件。同一组件仅能注册一个系统字体变更回调。
14153
14154**起始版本:** 12
14155
14156**参数:**
14157
14158| 名称 | 描述 |
14159| -------- | -------- |
14160| node | 指定的节点。  |
14161| userData | 自定义事件参数,当事件触发时在回调参数中携带回来。  |
14162| onFontStyleChange | 事件触发后的回调。  |
14163
14164**返回:**
14165
14166ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_ATTRIBUTE_OR_EVENT_NOT_SUPPORTED 组件不支持该事件。
14167
14168
14169### OH_ArkUI_RotationGesture_GetAngle()
14170
14171```
14172float OH_ArkUI_RotationGesture_GetAngle (const ArkUI_GestureEvent * event)
14173```
14174**描述:**
14175
14176旋转手势返回当前手势事件角度信息。
14177
14178**起始版本:** 12
14179
14180**参数:**
14181
14182| 名称 | 描述 |
14183| -------- | -------- |
14184| event | 手势事件。  |
14185
14186**返回:**
14187
14188旋转角度。
14189
14190
14191### OH_ArkUI_SetArkUIGestureRecognizerDisposeNotify()
14192
14193```
14194int32_t OH_ArkUI_SetArkUIGestureRecognizerDisposeNotify (ArkUI_GestureRecognizer * recognizer, ArkUI_GestureRecognizerDisposeNotifyCallback callback, void * userData )
14195```
14196**描述:**
14197
14198设置手势识别器对象析构通知回调函数。
14199
14200**参数:**
14201
14202| 名称 | 描述 |
14203| -------- | -------- |
14204| recognizer | 手势识别器指针。  |
14205| callback | 手势识别器对象析构通知回调函数。  |
14206| userData | 用户自定义数据。  |
14207
14208**返回:**
14209
14210[ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md#arkui_errorcode) - 成功。 [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md#arkui_errorcode) - 参数错误。
14211
14212
14213### OH_ArkUI_SetDragEventStrictReportWithContext()
14214
14215```
14216int32_t OH_ArkUI_SetDragEventStrictReportWithContext (ArkUI_ContextHandle uiContext, bool enabled )
14217```
14218**描述:**
14219
14220控制是否使能严格dragEvent上报,建议开启;默认是不开启的; 当不开启时,从父组件拖移进子组件时,父组件并不会收到leave的通知;而开启之后,只要前后两个组件发生变化,上一个组件就会收到 leave,新的组件收到enter通知;该配置与具体的UI实例相关,可通过传入一个UI实例进行关联。
14221
14222**起始版本:** 12
14223
14224**参数:**
14225
14226| 名称 | 描述 |
14227| -------- | -------- |
14228| uiContext | UI实例指针。  |
14229| enabled | 是否开启严格上报。  |
14230
14231**返回:**
14232
14233ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
14234
14235
14236### OH_ArkUI_SetDragEventStrictReportWithNode()
14237
14238```
14239int32_t OH_ArkUI_SetDragEventStrictReportWithNode (ArkUI_NodeHandle node, bool enabled )
14240```
14241**描述:**
14242
14243控制是否使能严格dragEvent上报,建议开启;默认是不开启的; 当不开启时,从父组件拖移进子组件时,父组件并不会收到leave的通知;而开启之后,只要前后两个组件发生变化,上一个组件就会收到 leave,新的组件收到enter通知;该配置与具体的UI实例相关,需要通过传入一个当前UI实例上的一个具体的组件节点来关联。
14244
14245**起始版本:** 12
14246
14247**参数:**
14248
14249| 名称 | 描述 |
14250| -------- | -------- |
14251| node | 组件节点指针。  |
14252| enabled | 是否开启严格上报。  |
14253
14254**返回:**
14255
14256ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
14257
14258
14259### OH_ArkUI_SetGestureRecognizerEnabled()
14260
14261```
14262int32_t OH_ArkUI_SetGestureRecognizerEnabled (ArkUI_GestureRecognizer * recognizer, bool enabled )
14263```
14264**描述:**
14265
14266设置手势识别器的使能状态。
14267
14268**起始版本:** 12
14269
14270**参数:**
14271
14272| 名称 | 描述 |
14273| -------- | -------- |
14274| recognizer | 手势识别器指针。  |
14275| enabled | 使能状态。  |
14276
14277**返回:**
14278
14279[ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md#arkui_errorcode) - 成功。 [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md#arkui_errorcode) - 参数错误。
14280
14281### OH_ArkUI_SetGestureRecognizerLimitFingerCount
14282
14283```
14284int32_t OH_ArkUI_SetGestureRecognizerLimitFingerCount (ArkUI_GestureRecognizer * recognizer, bool limitFingerCount )
14285```
14286**描述:**
14287
14288设置是否检查触摸屏幕的手指数量。
14289
14290**参数:**
14291
14292| 名称 | 描述 |
14293| -------- | -------- |
14294| recognizer | 手势识别器指针。  |
14295| limitFingerCount | 是否检查触摸屏幕的手指数量。  |
14296
14297**返回:**
14298
14299[ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md#arkui_errorcode) - 成功。 [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md#arkui_errorcode) - 参数错误。
14300
14301
14302
14303
14304### OH_ArkUI_SetNodeAllowedDropDataTypes()
14305
14306```
14307int32_t OH_ArkUI_SetNodeAllowedDropDataTypes (ArkUI_NodeHandle node, const char * typesArray[], int32_t count )
14308```
14309**描述:**
14310
14311配置组件允许接受落入的数据类型,该接口会重置通过 [OH_ArkUI_DisallowNodeAnyDropDataTypes](#oh_arkui_disallownodeanydropdatatypes) 或 [OH_ArkUI_AllowNodeAllDropDataTypes](#oh_arkui_allownodealldropdatatypes)进行的配置。
14312
14313**起始版本:** 12
14314
14315**参数:**
14316
14317| 名称 | 描述 |
14318| -------- | -------- |
14319| node | 组件节点指针。  |
14320| typesArray | 允许落入的数据类型数组。  |
14321| count | 数组的长度。  |
14322
14323**返回:**
14324
14325ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
14326
14327
14328### OH_ArkUI_SetNodeDraggable()
14329
14330```
14331int32_t OH_ArkUI_SetNodeDraggable (ArkUI_NodeHandle node, bool enabled )
14332```
14333**描述:**
14334
14335设置该组件是否允许进行拖拽。
14336
14337**起始版本:** 12
14338
14339**参数:**
14340
14341| 名称 | 描述 |
14342| -------- | -------- |
14343| node | 组件节点指针。  |
14344| bool | 是否支持拖出。  |
14345
14346**返回:**
14347
14348ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
14349
14350
14351### OH_ArkUI_SetNodeDragPreview()
14352
14353```
14354int32_t OH_ArkUI_SetNodeDragPreview (ArkUI_NodeHandle node, OH_PixelmapNative * preview )
14355```
14356**描述:**
14357
14358设置组件在被拖拽时的自定义跟手图。
14359
14360**起始版本:** 12
14361
14362**参数:**
14363
14364| 名称 | 描述 |
14365| -------- | -------- |
14366| node | 目标组件节点指针。  |
14367| preview | 自定义跟手图,使用 pixelmap 格式。  |
14368
14369**返回:**
14370
14371ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
14372
14373
14374### OH_ArkUI_SetNodeDragPreviewOption()
14375
14376```
14377int32_t OH_ArkUI_SetNodeDragPreviewOption (ArkUI_NodeHandle node, ArkUI_DragPreviewOption * option )
14378```
14379**描述:**
14380
14381将构造的ArkUI_DragPreviewOption设置给组件。
14382
14383**起始版本:** 12
14384
14385**参数:**
14386
14387| 名称 | 描述 |
14388| -------- | -------- |
14389| node | 组件节点指针。  |
14390| option | 自定义参数。  |
14391
14392**返回:**
14393
14394ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
14395
14396
14397### OH_ArkUI_StartDrag()
14398
14399```
14400int32_t OH_ArkUI_StartDrag (ArkUI_DragAction * dragAction)
14401```
14402**描述:**
14403
14404通过构造的DragAction对象发起拖拽。
14405
14406**起始版本:** 12
14407
14408**参数:**
14409
14410| 名称 | 描述 |
14411| -------- | -------- |
14412| dragAction | 拖拽action对象。  |
14413
14414**返回:**
14415
14416ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
14417
14418
14419### OH_ArkUI_StyledString_AddPlaceholder()
14420
14421```
14422void OH_ArkUI_StyledString_AddPlaceholder (ArkUI_StyledString * handle, OH_Drawing_PlaceholderSpan * placeholder )
14423```
14424**描述:**
14425
14426设置占位符。
14427
14428**起始版本:** 12
14429
14430**参数:**
14431
14432| 名称 | 描述 |
14433| -------- | -------- |
14434| handle | 指向ArkUI_StyledString对象的指针。  |
14435| placeholder | 指向OH_Drawing_PlaceholderSpan对象的指针。  |
14436
14437
14438### OH_ArkUI_StyledString_AddText()
14439
14440```
14441void OH_ArkUI_StyledString_AddText (ArkUI_StyledString * handle, const char * content )
14442```
14443**描述:**
14444
14445基于当前格式化字符串样式设置对应的文本内容。
14446
14447**起始版本:** 12
14448
14449**参数:**
14450
14451| 名称 | 描述 |
14452| -------- | -------- |
14453| handle | 指向ArkUI_StyledString对象的指针。  |
14454| content | 指向文本内容的指针。  |
14455
14456
14457### OH_ArkUI_StyledString_Create()
14458
14459```
14460ArkUI_StyledString* OH_ArkUI_StyledString_Create (OH_Drawing_TypographyStyle * style, OH_Drawing_FontCollection * collection )
14461```
14462**描述:**
14463
14464创建指向ArkUI_StyledString对象的指针。
14465
14466**起始版本:** 12
14467
14468**参数:**
14469
14470| 名称 | 描述 |
14471| -------- | -------- |
14472| style | 指向OH_Drawing_TypographyStyle的指针,由**OH_Drawing_CreateTypographyStyle**获取。  |
14473| collection | 指向OH_Drawing_FontCollection的指针,由**OH_Drawing_CreateFontCollection**获取。  |
14474
14475**返回:**
14476
14477创建指向ArkUI_StyledString对象的指针。如果对象返回空指针,表示创建失败,失败的原因可能是英语地址空间满,或者是style,collection参数异常如空指针。
14478
14479
14480### OH_ArkUI_StyledString_CreateTypography()
14481
14482```
14483OH_Drawing_Typography* OH_ArkUI_StyledString_CreateTypography (ArkUI_StyledString * handle)
14484```
14485**描述:**
14486
14487基于格式字符串对象创建指向OH_Drawing_Typography对象的指针,用于提前进行文本测算排版。
14488
14489**起始版本:** 12
14490
14491**参数:**
14492
14493| 名称 | 描述 |
14494| -------- | -------- |
14495| handle | 指向ArkUI_StyledString对象的指针。  |
14496
14497**返回:**
14498
14499指向OH_Drawing_Typography对象的指针。如果对象返回空指针,表示创建失败,失败的原因可能是handle参数异常如空指针。
14500
14501
14502### OH_ArkUI_StyledString_Descriptor_Create()
14503
14504```
14505ArkUI_StyledString_Descriptor* OH_ArkUI_StyledString_Descriptor_Create (void )
14506```
14507**描述:**
14508
14509创建属性字符串数据对象。
14510
14511**起始版本:** 14
14512
14513**返回:**
14514
14515指向ArkUI_StyledString_Descriptor对象的指针。
14516
14517
14518### OH_ArkUI_StyledString_Descriptor_Destroy()
14519
14520```
14521void OH_ArkUI_StyledString_Descriptor_Destroy (ArkUI_StyledString_Descriptor * descriptor)
14522```
14523**描述:**
14524
14525释放被ArkUI_StyledString_Descriptor对象占据的内存。
14526
14527**起始版本:** 14
14528
14529**参数:**
14530
14531| 名称 | 描述 |
14532| -------- | -------- |
14533| descriptor | 指向ArkUI_StyledString_Descriptor对象的指针。  |
14534
14535
14536### OH_ArkUI_StyledString_Destroy()
14537
14538```
14539void OH_ArkUI_StyledString_Destroy (ArkUI_StyledString * handle)
14540```
14541**描述:**
14542
14543释放被ArkUI_StyledString对象占据的内存。
14544
14545**起始版本:** 12
14546
14547**参数:**
14548
14549| 名称 | 描述 |
14550| -------- | -------- |
14551| handle | 指向ArkUI_StyledString对象的指针。  |
14552
14553
14554### OH_ArkUI_StyledString_PopTextStyle()
14555
14556```
14557void OH_ArkUI_StyledString_PopTextStyle (ArkUI_StyledString * handle)
14558```
14559**描述:**
14560
14561将当前格式化字符串对象中栈顶样式出栈。
14562
14563**起始版本:** 12
14564
14565**参数:**
14566
14567| 名称 | 描述 |
14568| -------- | -------- |
14569| handle | 指向ArkUI_StyledString对象的指针。  |
14570
14571
14572### OH_ArkUI_StyledString_PushTextStyle()
14573
14574```
14575void OH_ArkUI_StyledString_PushTextStyle (ArkUI_StyledString * handle, OH_Drawing_TextStyle * style )
14576```
14577**描述:**
14578
14579将新的排版风格设置到当前格式化字符串样式栈顶。
14580
14581**起始版本:** 12
14582
14583**参数:**
14584
14585| 名称 | 描述 |
14586| -------- | -------- |
14587| handle | 指向ArkUI_StyledString对象的指针。  |
14588| style | 指向OH_Drawing_TextStyle对象的指针。  |
14589
14590
14591### OH_ArkUI_SwipeGesture_GetAngle()
14592
14593```
14594float OH_ArkUI_SwipeGesture_GetAngle (const ArkUI_GestureEvent * event)
14595```
14596**描述:**
14597
14598滑动手势返回当前手势事件角度信息。
14599
14600**起始版本:** 12
14601
14602**参数:**
14603
14604| 名称 | 描述 |
14605| -------- | -------- |
14606| event | 手势事件。  |
14607
14608**返回:**
14609
14610滑动手势的角度,即两根手指间的线段与水平方向的夹角变化的度数。
14611
14612
14613### OH_ArkUI_SwipeGesture_GetVelocity()
14614
14615```
14616float OH_ArkUI_SwipeGesture_GetVelocity (const ArkUI_GestureEvent * event)
14617```
14618**描述:**
14619
14620滑动手势场景中所有手指滑动平均速度。
14621
14622**起始版本:** 12
14623
14624**参数:**
14625
14626| 名称 | 描述 |
14627| -------- | -------- |
14628| event | 手势事件。  |
14629
14630**返回:**
14631
14632滑动手势速度,即所有手指滑动的平均速度,单位为px/秒。
14633
14634
14635### OH_ArkUI_SwiperIndicator_Create()
14636
14637```
14638ArkUI_SwiperIndicator* OH_ArkUI_SwiperIndicator_Create (ArkUI_SwiperIndicatorType type)
14639```
14640**描述:**
14641
14642创建 Swiper 组件的导航指示器。
14643
14644**起始版本:** 12
14645
14646**参数:**
14647
14648| 名称 | 描述 |
14649| -------- | -------- |
14650| type | 导航指示器的类型。  |
14651
14652**返回:**
14653
14654导航指示器对象指针。
14655
14656
14657### OH_ArkUI_SwiperIndicator_Dispose()
14658
14659```
14660void OH_ArkUI_SwiperIndicator_Dispose (ArkUI_SwiperIndicator * indicator)
14661```
14662**描述:**
14663
14664销毁Swiper组件的导航指示器指针。
14665
14666**起始版本:** 12
14667
14668**参数:**
14669
14670| 名称 | 描述 |
14671| -------- | -------- |
14672| indicator | 导航指示器对象指针。  |
14673
14674
14675### OH_ArkUI_SwiperIndicator_GetBottomPosition()
14676
14677```
14678float OH_ArkUI_SwiperIndicator_GetBottomPosition (ArkUI_SwiperIndicator * indicator)
14679```
14680**描述:**
14681
14682获取导航点距离 Swiper 组件底部的距离。
14683
14684**起始版本:** 12
14685
14686**参数:**
14687
14688| 名称 | 描述 |
14689| -------- | -------- |
14690| indicator | 导航指示器对象指针。  |
14691
14692**返回:**
14693
14694导航点距离Swiper组件底部的距离。
14695
14696
14697### OH_ArkUI_SwiperIndicator_GetColor()
14698
14699```
14700uint32_t OH_ArkUI_SwiperIndicator_GetColor (ArkUI_SwiperIndicator * indicator)
14701```
14702**描述:**
14703
14704获取 Swiper 组件圆点导航指示器的颜色。
14705
14706**起始版本:** 12
14707
14708**参数:**
14709
14710| 名称 | 描述 |
14711| -------- | -------- |
14712| indicator | 导航指示器对象指针。  |
14713
14714**返回:**
14715
14716颜色类型,0xargb格式,形如 0xFFFF0000 表示红色。
14717
14718
14719### OH_ArkUI_SwiperIndicator_GetEndPosition()
14720
14721```
14722float OH_ArkUI_SwiperIndicator_GetEndPosition (ArkUI_SwiperIndicator * indicator)
14723```
14724**描述:**
14725
14726获取导航点距离 Swiper 组件右边的距离。
14727
14728**起始版本:** 12
14729
14730**参数:**
14731
14732| 名称 | 描述 |
14733| -------- | -------- |
14734| indicator | 导航指示器对象指针。  |
14735
14736**返回:**
14737
14738导航点距离Swiper组件右边的距离。
14739
14740
14741### OH_ArkUI_SwiperIndicator_GetItemHeight()
14742
14743```
14744float OH_ArkUI_SwiperIndicator_GetItemHeight (ArkUI_SwiperIndicator * indicator)
14745```
14746**描述:**
14747
14748获取 Swiper 组件圆点导航指示器的高。
14749
14750**起始版本:** 12
14751
14752**参数:**
14753
14754| 名称 | 描述 |
14755| -------- | -------- |
14756| indicator | 导航指示器对象指针。  |
14757
14758**返回:**
14759
14760圆点导航指示器的高。
14761
14762
14763### OH_ArkUI_SwiperIndicator_GetItemWidth()
14764
14765```
14766float OH_ArkUI_SwiperIndicator_GetItemWidth (ArkUI_SwiperIndicator * indicator)
14767```
14768**描述:**
14769
14770获取 Swiper 组件圆点导航指示器的宽。
14771
14772**起始版本:** 12
14773
14774**参数:**
14775
14776| 名称 | 描述 |
14777| -------- | -------- |
14778| indicator | 导航指示器对象指针。  |
14779
14780**返回:**
14781
14782圆点导航指示器的宽。
14783
14784
14785### OH_ArkUI_SwiperIndicator_GetMask()
14786
14787```
14788int32_t OH_ArkUI_SwiperIndicator_GetMask (ArkUI_SwiperIndicator * indicator)
14789```
14790**描述:**
14791
14792获取是否显示 Swiper 组件圆点导航指示器的蒙版样式。
14793
14794**起始版本:** 12
14795
14796**参数:**
14797
14798| 名称 | 描述 |
14799| -------- | -------- |
14800| indicator | 导航指示器对象指针。  |
14801
14802**返回:**
14803
14804mask 1 表示显示圆点导航指示器的蒙版样式,0 表示不显示。
14805
14806
14807### OH_ArkUI_SwiperIndicator_GetMaxDisplayCount()
14808
14809```
14810int32_t OH_ArkUI_SwiperIndicator_GetMaxDisplayCount (ArkUI_SwiperIndicator * indicator)
14811```
14812**描述:**
14813
14814获取圆点导航点指示器样式下,导航点显示个数的最大值。
14815
14816**起始版本:** 12
14817
14818**参数:**
14819
14820| 名称 | 描述 |
14821| -------- | -------- |
14822| indicator | 导航指示器对象指针。  |
14823
14824**返回:**
14825
14826导航点显示个数最大值,有效取值范围6-9。
14827
14828
14829### OH_ArkUI_SwiperDigitIndicator_Create()
14830
14831```
14832ArkUI_SwiperDigitIndicator *OH_ArkUI_SwiperDigitIndicator_Create()
14833```
14834**描述:**
14835
14836创建 Swiper 组件的数字导航指示器。
14837
14838**起始版本:** 18
14839
14840**返回:**
14841
14842数字导航指示器对象指针。
14843
14844### OH_ArkUI_SwiperDigitIndicator_SetStartPosition()
14845
14846```
14847void OH_ArkUI_SwiperDigitIndicator_SetStartPosition(ArkUI_SwiperDigitIndicator* indicator, float value)
14848```
14849**描述:**
14850
14851设置数字导航指示器距离 Swiper 组件左边的距离,从右至左显示的语言模式下,设置其距离 Swiper 组件右边的距离。
14852
14853**起始版本:** 18
14854
14855**参数:**
14856
14857| 名称 | 描述 |
14858| -------- | -------- |
14859| indicator | 数字导航指示器对象指针。  |
14860| value | 数字导航指示器距离Swiper组件左边的距离,从右至左显示的语言模式下,为其距离 Swiper 组件右边的距离。  |
14861
14862### OH_ArkUI_SwiperDigitIndicator_GetStartPosition()
14863
14864```
14865float OH_ArkUI_SwiperDigitIndicator_GetStartPosition(ArkUI_SwiperDigitIndicator* indicator)
14866```
14867**描述:**
14868
14869获取数字导航指示器距离 Swiper 组件左边的距离,从右至左显示的语言模式下,获取其距离 Swiper 组件右边的距离。
14870
14871**起始版本:** 18
14872
14873**参数:**
14874
14875| 名称 | 描述 |
14876| -------- | -------- |
14877| indicator | 数字导航指示器对象指针。 |
14878
14879**返回:**
14880
14881数字导航指示器距离 Swiper 组件左边的距离,从右至左显示的语言模式下,为其距离 Swiper 组件右边的距离。
14882
14883### OH_ArkUI_SwiperDigitIndicator_SetTopPosition()
14884
14885```
14886void OH_ArkUI_SwiperDigitIndicator_SetTopPosition(ArkUI_SwiperDigitIndicator* indicator, float value)
14887```
14888**描述:**
14889
14890设置数字导航指示器距离 Swiper 组件顶部的距离。
14891
14892**起始版本:** 18
14893
14894**参数:**
14895
14896| 名称 | 描述 |
14897| -------- | -------- |
14898| indicator | 数字导航指示器对象指针。  |
14899| value | 数字导航指示器距离Swiper组件顶部的距离。  |
14900
14901### OH_ArkUI_SwiperDigitIndicator_GetTopPosition()
14902
14903```
14904float OH_ArkUI_SwiperDigitIndicator_GetTopPosition(ArkUI_SwiperDigitIndicator* indicator)
14905```
14906**描述:**
14907
14908获取数字导航指示器距离 Swiper 组件顶部的距离。
14909
14910**起始版本:** 18
14911
14912**参数:**
14913
14914| 名称 | 描述 |
14915| -------- | -------- |
14916| indicator | 数字导航指示器对象指针。 |
14917
14918**返回:**
14919
14920数字导航指示器距离Swiper组件顶部的距离。
14921
14922### OH_ArkUI_SwiperDigitIndicator_SetEndPosition()
14923
14924```
14925void OH_ArkUI_SwiperDigitIndicator_SetEndPosition(ArkUI_SwiperDigitIndicator* indicator, float value)
14926```
14927**描述:**
14928
14929设置数字导航指示器距离 Swiper 组件右边的距离,从右至左显示的语言模式下,设置其距离 Swiper 组件左边的距离。
14930
14931**起始版本:** 18
14932
14933**参数:**
14934
14935| 名称 | 描述 |
14936| -------- | -------- |
14937| indicator | 数字导航指示器对象指针。  |
14938| value | 数字导航指示器距离Swiper组件右边的距离,从右至左显示的语言模式下,其距离 Swiper 组件左边的距离。  |
14939
14940### OH_ArkUI_SwiperDigitIndicator_GetEndPosition()
14941
14942```
14943float OH_ArkUI_SwiperDigitIndicator_GetEndPosition(ArkUI_SwiperDigitIndicator* indicator)
14944```
14945**描述:**
14946
14947获取数字导航指示器距离 Swiper 组件右边的距离,从右至左显示的语言模式下,获取其距离 Swiper 组件左边的距离。
14948
14949**起始版本:** 18
14950
14951**参数:**
14952
14953| 名称 | 描述 |
14954| -------- | -------- |
14955| indicator | 数字导航指示器对象指针。 |
14956
14957**返回:**
14958
14959数字导航指示器距离Swiper组件右边的距离,从右至左显示的语言模式下,其距离 Swiper 组件左边的距离。
14960
14961### OH_ArkUI_SwiperDigitIndicator_SetBottomPosition()
14962
14963```
14964void OH_ArkUI_SwiperDigitIndicator_SetBottomPosition(ArkUI_SwiperDigitIndicator* indicator, float value)
14965```
14966**描述:**
14967
14968设置数字导航指示器距离 Swiper 组件底部的距离。
14969
14970**起始版本:** 18
14971
14972**参数:**
14973
14974| 名称 | 描述 |
14975| -------- | -------- |
14976| indicator | 数字导航指示器对象指针。  |
14977| value | 数字导航指示器距离Swiper组件底部的距离。  |
14978
14979### OH_ArkUI_SwiperDigitIndicator_GetBottomPosition()
14980
14981```
14982float OH_ArkUI_SwiperDigitIndicator_GetBottomPosition(ArkUI_SwiperDigitIndicator* indicator)
14983```
14984**描述:**
14985
14986获取数字导航指示器距离 Swiper 组件底部的距离。
14987
14988**起始版本:** 18
14989
14990**参数:**
14991
14992| 名称 | 描述 |
14993| -------- | -------- |
14994| indicator | 数字导航指示器对象指针。 |
14995
14996**返回:**
14997
14998数字导航指示器距离Swiper组件底部的距离。
14999
15000### OH_ArkUI_SwiperDigitIndicator_SetFontColor()
15001
15002```
15003void OH_ArkUI_SwiperDigitIndicator_SetFontColor(ArkUI_SwiperDigitIndicator* indicator, uint32_t color)
15004```
15005**描述:**
15006
15007设置 Swiper 组件数字导航指示器字体颜色。
15008
15009**起始版本:** 18
15010
15011**参数:**
15012
15013| 名称 | 描述 |
15014| -------- | -------- |
15015| indicator | 数字导航指示器对象指针。  |
15016| color | 颜色类型,0xargb格式,形如 0xFFFF0000 表示红色。  |
15017
15018### OH_ArkUI_SwiperDigitIndicator_GetFontColor()
15019
15020```
15021uint32_t OH_ArkUI_SwiperDigitIndicator_GetFontColor(ArkUI_SwiperDigitIndicator* indicator)
15022```
15023**描述:**
15024
15025获取 Swiper 组件数字导航指示器字体颜色。
15026
15027**起始版本:** 18
15028
15029**参数:**
15030
15031| 名称 | 描述 |
15032| -------- | -------- |
15033| indicator | 数字导航指示器对象指针。 |
15034
15035**返回:**
15036
15037颜色类型,0xargb格式,形如 0xFFFF0000 表示红色。
15038
15039### OH_ArkUI_SwiperDigitIndicator_SetSelectedFontColor()
15040
15041```
15042void OH_ArkUI_SwiperDigitIndicator_SetSelectedFontColor(ArkUI_SwiperDigitIndicator* indicator, uint32_t selectedColor)
15043```
15044**描述:**
15045
15046设置被选中 Swiper 组件数字导航指示器字体颜色。
15047
15048**起始版本:** 18
15049
15050**参数:**
15051
15052| 名称 | 描述 |
15053| -------- | -------- |
15054| indicator | 数字导航指示器对象指针。  |
15055| selectedColor | 颜色类型,0xargb格式,形如 0xFFFF0000 表示红色。  |
15056
15057### OH_ArkUI_SwiperDigitIndicator_GetSelectedFontColor()
15058
15059```
15060uint32_t OH_ArkUI_SwiperDigitIndicator_GetSelectedFontColor(ArkUI_SwiperDigitIndicator* indicator)
15061```
15062**描述:**
15063
15064获取被选中 Swiper 组件数字导航指示器字体颜色。
15065
15066**起始版本:** 18
15067
15068**参数:**
15069
15070| 名称 | 描述 |
15071| -------- | -------- |
15072| indicator | 数字导航指示器对象指针。 |
15073
15074**返回:**
15075
15076颜色类型,0xargb格式,形如 0xFFFF0000 表示红色。
15077
15078### OH_ArkUI_SwiperDigitIndicator_SetFontSize()
15079
15080```
15081void OH_ArkUI_SwiperDigitIndicator_SetFontSize(ArkUI_SwiperDigitIndicator* indicator, float size)
15082```
15083**描述:**
15084
15085设置 Swiper 组件数字导航指示器字体大小。
15086
15087**起始版本:** 18
15088
15089**参数:**
15090
15091| 名称 | 描述 |
15092| -------- | -------- |
15093| indicator | 数字导航指示器对象指针。  |
15094| size | 字体大小数值,单位为fp。  |
15095
15096### OH_ArkUI_SwiperDigitIndicator_GetFontSize()
15097
15098```
15099float OH_ArkUI_SwiperDigitIndicator_GetFontSize(ArkUI_SwiperDigitIndicator* indicator)
15100```
15101**描述:**
15102
15103获取 Swiper 组件数字导航指示器字体大小。
15104
15105**起始版本:** 18
15106
15107**参数:**
15108
15109| 名称 | 描述 |
15110| -------- | -------- |
15111| indicator | 数字导航指示器对象指针。 |
15112
15113**返回:**
15114
15115字体大小数值,单位为fp。
15116
15117### OH_ArkUI_SwiperDigitIndicator_SetSelectedFontSize()
15118
15119```
15120void OH_ArkUI_SwiperDigitIndicator_SetSelectedFontSize(ArkUI_SwiperDigitIndicator* indicator, float size)
15121```
15122**描述:**
15123
15124设置被选中 Swiper 组件数字导航指示器字体大小。
15125
15126**起始版本:** 18
15127
15128**参数:**
15129
15130| 名称 | 描述 |
15131| -------- | -------- |
15132| indicator | 数字导航指示器对象指针。  |
15133| size | 字体大小数值,单位为fp。  |
15134
15135### OH_ArkUI_SwiperDigitIndicator_GetSelectedFontSize()
15136
15137```
15138float OH_ArkUI_SwiperDigitIndicator_GetSelectedFontSize(ArkUI_SwiperDigitIndicator* indicator)
15139```
15140**描述:**
15141
15142获取被选中 Swiper 组件数字导航指示器字体大小。
15143
15144**起始版本:** 18
15145
15146**参数:**
15147
15148| 名称 | 描述 |
15149| -------- | -------- |
15150| indicator | 数字导航指示器对象指针。 |
15151
15152**返回:**
15153
15154字体大小数值,单位为fp。
15155
15156### OH_ArkUI_SwiperDigitIndicator_SetFontWeight()
15157
15158```
15159void OH_ArkUI_SwiperDigitIndicator_SetFontWeight(ArkUI_SwiperDigitIndicator* indicator, ArkUI_FontWeight fontWeight)
15160```
15161**描述:**
15162
15163设置 Swiper 组件数字导航指示器字体粗细属性。
15164
15165**起始版本:** 18
15166
15167**参数:**
15168
15169| 名称 | 描述 |
15170| -------- | -------- |
15171| indicator | 数字导航指示器对象指针。  |
15172| fontWeight | 字体粗细样式[ArkUI_FontWeight](#arkui_fontweight)。  |
15173
15174### OH_ArkUI_SwiperDigitIndicator_GetFontWeight()
15175
15176```
15177ArkUI_FontWeight OH_ArkUI_SwiperDigitIndicator_GetFontWeight(ArkUI_SwiperDigitIndicator* indicator)
15178```
15179**描述:**
15180
15181 获取 Swiper 组件数字导航指示器字体粗细属性。
15182
15183**起始版本:** 18
15184
15185**参数:**
15186
15187| 名称 | 描述 |
15188| -------- | -------- |
15189| indicator | 数字导航指示器对象指针。 |
15190
15191**返回:**
15192
15193字体粗细样式[ArkUI_FontWeight](#arkui_fontweight)
15194
15195### OH_ArkUI_SwiperDigitIndicator_SetSelectedFontWeight()
15196
15197```
15198void OH_ArkUI_SwiperDigitIndicator_SetSelectedFontWeight(ArkUI_SwiperDigitIndicator* indicator, ArkUI_FontWeight fontWeight)
15199```
15200**描述:**
15201
15202设置被选中 Swiper 组件数字导航指示器字体粗细属性。
15203
15204**起始版本:** 18
15205
15206**参数:**
15207
15208| 名称 | 描述 |
15209| -------- | -------- |
15210| indicator | 数字导航指示器对象指针。  |
15211| fontWeight | 字体粗细样式[ArkUI_FontWeight](#arkui_fontweight)。  |
15212
15213### OH_ArkUI_SwiperDigitIndicator_GetSelectedFontWeight()
15214
15215```
15216ArkUI_FontWeight OH_ArkUI_SwiperDigitIndicator_GetSelectedFontWeight(ArkUI_SwiperDigitIndicator* indicator)
15217```
15218**描述:**
15219
15220 获取被选中 Swiper 组件数字导航指示器字体粗细属性。
15221
15222**起始版本:** 18
15223
15224**参数:**
15225
15226| 名称 | 描述 |
15227| -------- | -------- |
15228| indicator | 数字导航指示器对象指针。 |
15229
15230**返回:**
15231
15232字体粗细样式[ArkUI_FontWeight](#arkui_fontweight)
15233
15234### OH_ArkUI_SwiperDigitIndicator_Dispose
15235
15236```
15237void OH_ArkUI_SwiperDigitIndicator_Dispose(ArkUI_SwiperDigitIndicator* indicator)
15238```
15239**描述:**
15240
15241销毁 Swiper 组件的数字导航指示器指针。
15242
15243**起始版本:** 18
15244
15245**参数:**
15246
15247| 名称 | 描述 |
15248| -------- | -------- |
15249| indicator | 数字导航指示器对象指针。  |
15250
15251### OH_ArkUI_SwiperArrowStyle_Create()
15252
15253```
15254ArkUI_SwiperArrowStyle *OH_ArkUI_SwiperArrowStyle_Create()
15255```
15256**描述:**
15257
15258创建 Swiper 组件的导航箭头。
15259
15260**起始版本:** 18
15261
15262**返回:**
15263
15264导航箭头对象指针。
15265
15266### OH_ArkUI_SwiperArrowStyle_SetShowBackground()
15267
15268```
15269void OH_ArkUI_SwiperArrowStyle_SetShowBackground(ArkUI_SwiperArrowStyle *arrowStyle, int32_t showBackground)
15270```
15271**描述:**
15272
15273设置 Swiper 组件导航箭头底板是否显示。
15274
15275**起始版本:** 18
15276
15277**参数:**
15278
15279| 名称 | 描述 |
15280| -------- | -------- |
15281| arrowStyle | 导航箭头对象指针。  |
15282| showBackground | 导航箭头底板是否显示,0:不显示,1:显示,默认值:0。  |
15283
15284### OH_ArkUI_SwiperArrowStyle_GetShowBackground()
15285
15286```
15287int32_t OH_ArkUI_SwiperArrowStyle_GetShowBackground(ArkUI_SwiperArrowStyle* arrowStyle)
15288```
15289**描述:**
15290
15291 获取 Swiper 组件导航箭头底板是否显示。
15292
15293**起始版本:** 18
15294
15295**参数:**
15296
15297| 名称 | 描述 |
15298| -------- | -------- |
15299| arrowStyle | 导航箭头对象指针。 |
15300
15301**返回:**
15302
15303导航箭头底板是否显示,0:不显示,1:显示。
15304
15305### OH_ArkUI_SwiperArrowStyle_SetShowSidebarMiddle()
15306
15307```
15308void OH_ArkUI_SwiperArrowStyle_SetShowSidebarMiddle(ArkUI_SwiperArrowStyle *arrowStyle, int32_t showSidebarMiddle)
15309```
15310**描述:**
15311
15312设置 Swiper 组件导航箭头显示位置。
15313
15314**起始版本:** 18
15315
15316**参数:**
15317
15318| 名称 | 描述 |
15319| -------- | -------- |
15320| arrowStyle | 导航箭头对象指针。  |
15321| showSidebarMiddle | 导航箭头显示位置,0:显示在导航指示器两侧,1:显示在Swiper组件两侧,默认值:0。  |
15322
15323### OH_ArkUI_SwiperArrowStyle_GetShowSidebarMiddle()
15324
15325```
15326int32_t OH_ArkUI_SwiperArrowStyle_GetShowSidebarMiddle(ArkUI_SwiperArrowStyle* arrowStyle)
15327```
15328**描述:**
15329
15330获取 Swiper 组件导航箭头显示位置。
15331
15332**起始版本:** 18
15333
15334**参数:**
15335
15336| 名称 | 描述 |
15337| -------- | -------- |
15338| arrowStyle | 导航箭头对象指针。 |
15339
15340**返回:**
15341
15342导航箭头显示位置,0:显示在导航指示器两侧,1:显示在Swiper组件两侧。
15343
15344### OH_ArkUI_SwiperArrowStyle_SetBackgroundSize()
15345
15346```
15347void OH_ArkUI_SwiperArrowStyle_SetBackgroundSize(ArkUI_SwiperArrowStyle* arrowStyle, float backgroundSize)
15348```
15349**描述:**
15350
15351设置 Swiper 组件导航箭头底板大小。
15352
15353**起始版本:** 18
15354
15355**参数:**
15356
15357| 名称 | 描述 |
15358| -------- | -------- |
15359| arrowStyle | 导航箭头对象指针。  |
15360| backgroundSize | 导航箭头底板大小,单位:vp。默认值:显示在导航指示器两侧24vp,显示在Swiper两侧32vp。  |
15361
15362### OH_ArkUI_SwiperArrowStyle_GetBackgroundSize()
15363
15364```
15365float OH_ArkUI_SwiperArrowStyle_GetBackgroundSize(ArkUI_SwiperArrowStyle* arrowStyle)
15366```
15367**描述:**
15368
15369获取 Swiper 组件导航箭头底板大小。
15370
15371**起始版本:** 18
15372
15373**参数:**
15374
15375| 名称 | 描述 |
15376| -------- | -------- |
15377| arrowStyle | 导航箭头对象指针。 |
15378
15379**返回:**
15380
15381导航箭头底板大小,单位:vp。
15382
15383### OH_ArkUI_SwiperArrowStyle_SetBackgroundColor()
15384
15385```
15386void OH_ArkUI_SwiperArrowStyle_SetBackgroundColor(ArkUI_SwiperArrowStyle* arrowStyle, uint32_t backgroundColor)
15387```
15388**描述:**
15389
15390设置 Swiper 组件导航箭头底板颜色。
15391
15392**起始版本:** 18
15393
15394**参数:**
15395
15396| 名称 | 描述 |
15397| -------- | -------- |
15398| arrowStyle | 导航箭头对象指针。  |
15399| backgroundColor | 导航箭头底板颜色,0xargb格式,形如 0xFFFF0000 表示红色。  |
15400
15401### OH_ArkUI_SwiperArrowStyle_GetBackgroundColor()
15402
15403```
15404uint32_t OH_ArkUI_SwiperArrowStyle_GetBackgroundColor(ArkUI_SwiperArrowStyle* arrowStyle)
15405```
15406**描述:**
15407
15408获取 Swiper 组件导航箭头底板颜色。
15409
15410**起始版本:** 18
15411
15412**参数:**
15413
15414| 名称 | 描述 |
15415| -------- | -------- |
15416| arrowStyle | 导航箭头对象指针。 |
15417
15418**返回:**
15419
15420导航箭头底板颜色,0xargb格式,形如 0xFFFF0000 表示红色。
15421
15422### OH_ArkUI_SwiperArrowStyle_SetArrowSize()
15423
15424```
15425void OH_ArkUI_SwiperArrowStyle_SetArrowSize(ArkUI_SwiperArrowStyle* arrowStyle, float arrowSize)
15426```
15427**描述:**
15428
15429设置 Swiper 组件导航箭头大小。
15430
15431**起始版本:** 18
15432
15433**参数:**
15434
15435| 名称 | 描述 |
15436| -------- | -------- |
15437| arrowStyle | 导航箭头对象指针。  |
15438| arrowSize |  导航箭头大小,单位:vp。默认值:显示在导航指示器两侧18vp,显示在Swiper两侧24vp。 显示导航箭头底板时,arrowSize固定为backgroundSize的3/4。 |
15439
15440### OH_ArkUI_SwiperArrowStyle_GetArrowSize()
15441
15442```
15443float OH_ArkUI_SwiperArrowStyle_GetArrowSize(ArkUI_SwiperArrowStyle* arrowStyle)
15444```
15445**描述:**
15446
15447获取 Swiper 组件导航箭头大小。
15448
15449**起始版本:** 18
15450
15451**参数:**
15452
15453| 名称 | 描述 |
15454| -------- | -------- |
15455| arrowStyle | 导航箭头对象指针。 |
15456
15457**返回:**
15458
15459导航箭头大小,单位:vp。
15460
15461### OH_ArkUI_SwiperArrowStyle_SetArrowColor()
15462
15463```
15464void OH_ArkUI_SwiperArrowStyle_SetArrowColor(ArkUI_SwiperArrowStyle* arrowStyle, uint32_t arrowColor)
15465```
15466**描述:**
15467
15468设置 Swiper 组件导航箭头大小。
15469
15470**起始版本:** 18
15471
15472**参数:**
15473
15474| 名称 | 描述 |
15475| -------- | -------- |
15476| arrowStyle | 导航箭头对象指针。  |
15477| arrowColor |  导航箭头颜色,0xargb格式,形如 0xFFFF0000 表示红色。 |
15478
15479### OH_ArkUI_SwiperArrowStyle_GetArrowColor()
15480
15481```
15482uint32_t OH_ArkUI_SwiperArrowStyle_GetArrowColor(ArkUI_SwiperArrowStyle* arrowStyle)
15483```
15484**描述:**
15485
15486获取 Swiper 组件导航箭头颜色。
15487
15488**起始版本:** 18
15489
15490**参数:**
15491
15492| 名称 | 描述 |
15493| -------- | -------- |
15494| arrowStyle | 导航箭头对象指针。 |
15495
15496**返回:**
15497
15498导航箭头颜色,0xargb格式,形如 0xFFFF0000 表示红色。
15499
15500### OH_ArkUI_SwiperArrowStyle_Dispose
15501
15502```
15503void OH_ArkUI_SwiperArrowStyle_Dispose(ArkUI_SwiperArrowStyle* arrowStyle)
15504```
15505**描述:**
15506
15507销毁 Swiper 组件的导航箭头指针。
15508
15509**起始版本:** 18
15510
15511**参数:**
15512
15513| 名称 | 描述 |
15514| -------- | -------- |
15515| arrowStyle | 导航箭头对象指针。  |
15516
15517### OH_ArkUI_SwiperIndicator_GetSelectedColor()
15518
15519```
15520uint32_t OH_ArkUI_SwiperIndicator_GetSelectedColor (ArkUI_SwiperIndicator * indicator)
15521```
15522**描述:**
15523
15524获取被选中 Swiper 组件圆点导航指示器的颜色。
15525
15526**起始版本:** 12
15527
15528**参数:**
15529
15530| 名称 | 描述 |
15531| -------- | -------- |
15532| indicator | 导航指示器对象指针。  |
15533
15534**返回:**
15535
15536颜色类型,0xargb格式,形如 0xFFFF0000 表示红色。
15537
15538
15539### OH_ArkUI_SwiperIndicator_GetSelectedItemHeight()
15540
15541```
15542float OH_ArkUI_SwiperIndicator_GetSelectedItemHeight (ArkUI_SwiperIndicator * indicator)
15543```
15544**描述:**
15545
15546获取被选中 Swiper 组件圆点导航指示器的高。
15547
15548**起始版本:** 12
15549
15550**参数:**
15551
15552| 名称 | 描述 |
15553| -------- | -------- |
15554| indicator | 导航指示器对象指针。  |
15555
15556**返回:**
15557
15558圆点导航指示器的高。
15559
15560
15561### OH_ArkUI_SwiperIndicator_GetSelectedItemWidth()
15562
15563```
15564float OH_ArkUI_SwiperIndicator_GetSelectedItemWidth (ArkUI_SwiperIndicator * indicator)
15565```
15566**描述:**
15567
15568获取被选中 Swiper 组件圆点导航指示器的宽。
15569
15570**起始版本:** 12
15571
15572**参数:**
15573
15574| 名称 | 描述 |
15575| -------- | -------- |
15576| indicator | 导航指示器对象指针。  |
15577
15578**返回:**
15579
15580圆点导航指示器的宽。
15581
15582
15583### OH_ArkUI_SwiperIndicator_GetStartPosition()
15584
15585```
15586float OH_ArkUI_SwiperIndicator_GetStartPosition (ArkUI_SwiperIndicator * indicator)
15587```
15588**描述:**
15589
15590获取导航点距离 Swiper 组件左边的距离。
15591
15592**起始版本:** 12
15593
15594**参数:**
15595
15596| 名称 | 描述 |
15597| -------- | -------- |
15598| indicator | 导航指示器对象指针。  |
15599
15600**返回:**
15601
15602导航点距离Swiper组件左边的距离。
15603
15604
15605### OH_ArkUI_SwiperIndicator_GetTopPosition()
15606
15607```
15608float OH_ArkUI_SwiperIndicator_GetTopPosition (ArkUI_SwiperIndicator * indicator)
15609```
15610**描述:**
15611
15612获取导航点距离 Swiper 组件顶部的距离。
15613
15614**起始版本:** 12
15615
15616**参数:**
15617
15618| 名称 | 描述 |
15619| -------- | -------- |
15620| indicator | 导航指示器对象指针。  |
15621
15622**返回:**
15623
15624导航点距离Swiper组件顶部的距离。
15625
15626
15627### OH_ArkUI_SwiperIndicator_SetBottomPosition()
15628
15629```
15630void OH_ArkUI_SwiperIndicator_SetBottomPosition (ArkUI_SwiperIndicator * indicator, float value )
15631```
15632**描述:**
15633
15634设置导航点距离 Swiper 组件底部的距离。
15635
15636**起始版本:** 12
15637
15638**参数:**
15639
15640| 名称 | 描述 |
15641| -------- | -------- |
15642| indicator | 导航指示器对象指针。  |
15643| value | 导航点距离Swiper组件底部的距离。  |
15644
15645
15646### OH_ArkUI_SwiperIndicator_SetColor()
15647
15648```
15649void OH_ArkUI_SwiperIndicator_SetColor (ArkUI_SwiperIndicator * indicator, uint32_t color )
15650```
15651**描述:**
15652
15653设置 Swiper 组件圆点导航指示器的颜色。
15654
15655**起始版本:** 12
15656
15657**参数:**
15658
15659| 名称 | 描述 |
15660| -------- | -------- |
15661| indicator | 导航指示器对象指针。  |
15662| color | 颜色类型,0xargb格式,形如 0xFFFF0000 表示红色。  |
15663
15664
15665### OH_ArkUI_SwiperIndicator_SetEndPosition()
15666
15667```
15668void OH_ArkUI_SwiperIndicator_SetEndPosition (ArkUI_SwiperIndicator * indicator, float value )
15669```
15670**描述:**
15671
15672设置导航点距离 Swiper 组件右边的距离。
15673
15674**起始版本:** 12
15675
15676**参数:**
15677
15678| 名称 | 描述 |
15679| -------- | -------- |
15680| indicator | 导航指示器对象指针。  |
15681| value | 导航点距离Swiper组件右边的距离。  |
15682
15683
15684### OH_ArkUI_SwiperIndicator_SetItemHeight()
15685
15686```
15687void OH_ArkUI_SwiperIndicator_SetItemHeight (ArkUI_SwiperIndicator * indicator, float value )
15688```
15689**描述:**
15690
15691设置 Swiper 组件圆点导航指示器的高。
15692
15693**起始版本:** 12
15694
15695**参数:**
15696
15697| 名称 | 描述 |
15698| -------- | -------- |
15699| indicator | 导航指示器对象指针。  |
15700| value | 圆点导航指示器的高。  |
15701
15702
15703### OH_ArkUI_SwiperIndicator_SetItemWidth()
15704
15705```
15706void OH_ArkUI_SwiperIndicator_SetItemWidth (ArkUI_SwiperIndicator * indicator, float value )
15707```
15708**描述:**
15709
15710设置 Swiper 组件圆点导航指示器的宽。
15711
15712**起始版本:** 12
15713
15714**参数:**
15715
15716| 名称 | 描述 |
15717| -------- | -------- |
15718| indicator | 导航指示器对象指针。  |
15719| value | 圆点导航指示器的宽。  |
15720
15721
15722### OH_ArkUI_SwiperIndicator_SetMask()
15723
15724```
15725void OH_ArkUI_SwiperIndicator_SetMask (ArkUI_SwiperIndicator * indicator, int32_t mask )
15726```
15727**描述:**
15728
15729设置是否显示 Swiper 组件圆点导航指示器的蒙版样式。
15730
15731**起始版本:** 12
15732
15733**参数:**
15734
15735| 名称 | 描述 |
15736| -------- | -------- |
15737| indicator | 导航指示器对象指针。  |
15738| mask | 是否显示蒙版样式,1 表示显示,0 表示不显示。  |
15739
15740
15741### OH_ArkUI_SwiperIndicator_SetMaxDisplayCount()
15742
15743```
15744int32_t OH_ArkUI_SwiperIndicator_SetMaxDisplayCount (ArkUI_SwiperIndicator * indicator, int32_t maxDisplayCount )
15745```
15746**描述:**
15747
15748设置圆点导航点指示器样式下,导航点显示个数的最大值。
15749
15750**起始版本:** 12
15751
15752**参数:**
15753
15754| 名称 | 描述 |
15755| -------- | -------- |
15756| indicator | 导航指示器对象指针。  |
15757| maxDisplayCount | 导航点显示个数最大值,有效取值范围6-9。  |
15758
15759**返回:**
15760
15761ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 如果maxDisplayCount设置范围错误, 返回错误码。
15762
15763
15764### OH_ArkUI_SwiperIndicator_SetSelectedColor()
15765
15766```
15767void OH_ArkUI_SwiperIndicator_SetSelectedColor (ArkUI_SwiperIndicator * indicator, uint32_t selectedColor )
15768```
15769**描述:**
15770
15771设置被选中 Swiper 组件圆点导航指示器的颜色。
15772
15773**起始版本:** 12
15774
15775**参数:**
15776
15777| 名称 | 描述 |
15778| -------- | -------- |
15779| indicator | 导航指示器对象指针。  |
15780| selectedColor | 颜色类型,0xargb格式,形如 0xFFFF0000 表示红色。  |
15781
15782
15783### OH_ArkUI_SwiperIndicator_SetSelectedItemHeight()
15784
15785```
15786void OH_ArkUI_SwiperIndicator_SetSelectedItemHeight (ArkUI_SwiperIndicator * indicator, float value )
15787```
15788**描述:**
15789
15790设置被选中的 Swiper 组件圆点导航指示器的高。
15791
15792**起始版本:** 12
15793
15794**参数:**
15795
15796| 名称 | 描述 |
15797| -------- | -------- |
15798| indicator | 导航指示器对象指针。  |
15799| value | 圆点导航指示器的高。  |
15800
15801
15802### OH_ArkUI_SwiperIndicator_SetSelectedItemWidth()
15803
15804```
15805void OH_ArkUI_SwiperIndicator_SetSelectedItemWidth (ArkUI_SwiperIndicator * indicator, float value )
15806```
15807**描述:**
15808
15809设置被选中的 Swiper 组件圆点导航指示器的宽。
15810
15811**起始版本:** 12
15812
15813**参数:**
15814
15815| 名称 | 描述 |
15816| -------- | -------- |
15817| indicator | 导航指示器对象指针。  |
15818| value | 圆点导航指示器的宽。  |
15819
15820
15821### OH_ArkUI_SwiperIndicator_SetStartPosition()
15822
15823```
15824void OH_ArkUI_SwiperIndicator_SetStartPosition (ArkUI_SwiperIndicator * indicator, float value )
15825```
15826**描述:**
15827
15828设置导航点距离 Swiper 组件左边的距离。
15829
15830**起始版本:** 12
15831
15832**参数:**
15833
15834| 名称 | 描述 |
15835| -------- | -------- |
15836| indicator | 导航指示器对象指针。  |
15837| value | 导航点距离Swiper组件左边的距离。  |
15838
15839
15840### OH_ArkUI_SwiperIndicator_SetTopPosition()
15841
15842```
15843void OH_ArkUI_SwiperIndicator_SetTopPosition (ArkUI_SwiperIndicator * indicator, float value )
15844```
15845**描述:**
15846
15847设置导航点距离 Swiper 组件顶部的距离。
15848
15849**起始版本:** 12
15850
15851**参数:**
15852
15853| 名称 | 描述 |
15854| -------- | -------- |
15855| indicator | 导航指示器对象指针。  |
15856| value | 导航点距离Swiper组件顶部的距离。  |
15857
15858
15859### OH_ArkUI_SystemFontStyleEvent_GetFontSizeScale()
15860
15861```
15862float OH_ArkUI_SystemFontStyleEvent_GetFontSizeScale (const ArkUI_SystemFontStyleEvent * event)
15863```
15864**描述:**
15865
15866获取系统字体变更事件的字体大小值。
15867
15868**起始版本:** 12
15869
15870**参数:**
15871
15872| 名称 | 描述 |
15873| -------- | -------- |
15874| event | 表示指向当前系统字体变更事件的指针。  |
15875
15876**返回:**
15877
15878更新后的系统字体大小缩放系数。默认值:1.0。
15879
15880
15881### OH_ArkUI_SystemFontStyleEvent_GetFontWeightScale()
15882
15883```
15884float OH_ArkUI_SystemFontStyleEvent_GetFontWeightScale (const ArkUI_SystemFontStyleEvent * event)
15885```
15886**描述:**
15887
15888获取系统字体变更事件的字体粗细值。
15889
15890**起始版本:** 12
15891
15892**参数:**
15893
15894| 名称 | 描述 |
15895| -------- | -------- |
15896| event | 表示指向当前系统字体变更事件的指针。  |
15897
15898**返回:**
15899
15900更新后的系统字体粗细缩放系数。默认值:1.0。
15901
15902
15903### OH_ArkUI_TransitionEffect_Combine()
15904
15905```
15906int32_t OH_ArkUI_TransitionEffect_Combine (ArkUI_TransitionEffect * option, ArkUI_TransitionEffect * combine )
15907```
15908**描述:**
15909
15910设置转场效果链式组合,以形成包含多种转场效果的TransitionEffect。
15911
15912**起始版本:** 12
15913
15914**参数:**
15915
15916| 名称 | 描述 |
15917| -------- | -------- |
15918| option | 转场效果。  |
15919| combine | 需要链式转场效果。  |
15920
15921**返回:**
15922
15923ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
15924
15925
15926### OH_ArkUI_TransitionEffect_Dispose()
15927
15928```
15929void OH_ArkUI_TransitionEffect_Dispose (ArkUI_TransitionEffect * option)
15930```
15931**描述:**
15932
15933销毁转场效果对象。
15934
15935**起始版本:** 12
15936
15937**参数:**
15938
15939| 名称 | 描述 |
15940| -------- | -------- |
15941| option | 转场效果对象。  |
15942
15943
15944### OH_ArkUI_TransitionEffect_SetAnimation()
15945
15946```
15947int32_t OH_ArkUI_TransitionEffect_SetAnimation (ArkUI_TransitionEffect * option, ArkUI_AnimateOption * animation )
15948```
15949**描述:**
15950
15951设置转场效果动画参数。
15952
15953**起始版本:** 12
15954
15955**参数:**
15956
15957| 名称 | 描述 |
15958| -------- | -------- |
15959| option | 转场效果。  |
15960| animation | 属性显示动画效果相关参数。  |
15961
15962**注解:**
15963
15964如果通过combine进行转场效果的组合,前一转场效果的动画参数也可用于后一转场效果。
15965
15966**返回:**
15967
15968ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
15969
15970
15971### OH_ArkUI_UnmarshallStyledStringDescriptor()
15972
15973```
15974int32_t OH_ArkUI_UnmarshallStyledStringDescriptor (uint8_t * buffer, size_t bufferSize, ArkUI_StyledString_Descriptor * descriptor)
15975```
15976**描述:**
15977
15978将包含属性字符串信息的字节数组反序列化为属性字符串。
15979
15980**起始版本:** 14
15981
15982**参数:**
15983
15984| 名称 | 描述 |
15985| -------- | -------- |
15986| buffer | 待反序列化的字节数组。  |
15987| bufferSize | 字节数组长度。  |
15988| descriptor | 指向ArkUI_StyledString_Descriptor对象的指针。  |
15989
15990**返回:**
15991
15992ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
15993
15994
15995### OH_ArkUI_UnregisterSystemColorModeChangeEvent()
15996
15997```
15998void OH_ArkUI_UnregisterSystemColorModeChangeEvent (ArkUI_NodeHandle node)
15999```
16000**描述:**
16001
16002注销系统深浅色变更事件。
16003
16004**起始版本:** 12
16005
16006**参数:**
16007
16008| 名称 | 描述 |
16009| -------- | -------- |
16010| node | 指定的节点。  |
16011
16012
16013### OH_ArkUI_UnregisterSystemFontStyleChangeEvent()
16014
16015```
16016void OH_ArkUI_UnregisterSystemFontStyleChangeEvent (ArkUI_NodeHandle node)
16017```
16018**描述:**
16019
16020注销系统字体变更事件。
16021
16022**起始版本:** 12
16023
16024**参数:**
16025
16026| 名称 | 描述 |
16027| -------- | -------- |
16028| node | 指定的节点。  |
16029
16030
16031### OH_ArkUI_WaterFlowSectionOption_Create()
16032
16033```
16034ArkUI_WaterFlowSectionOption* OH_ArkUI_WaterFlowSectionOption_Create ()
16035```
16036**描述:**
16037
16038创建FlowItem分组配置信息。
16039
16040**起始版本:** 12
16041
16042**返回:**
16043
16044FlowItem分组配置信息。
16045
16046
16047### OH_ArkUI_WaterFlowSectionOption_Dispose()
16048
16049```
16050void OH_ArkUI_WaterFlowSectionOption_Dispose (ArkUI_WaterFlowSectionOption * option)
16051```
16052**描述:**
16053
16054销毁FlowItem分组配置信息指针。
16055
16056**起始版本:** 12
16057
16058**参数:**
16059
16060| 名称 | 描述 |
16061| -------- | -------- |
16062| option | FlowItem分组配置信息。  |
16063
16064
16065### OH_ArkUI_WaterFlowSectionOption_GetColumnGap()
16066
16067```
16068float OH_ArkUI_WaterFlowSectionOption_GetColumnGap (ArkUI_WaterFlowSectionOption * option, int32_t index )
16069```
16070**描述:**
16071
16072通过FlowItem分组配置信息获取对应索引下的分组的列间距。
16073
16074**起始版本:** 12
16075
16076**参数:**
16077
16078| 名称 | 描述 |
16079| -------- | -------- |
16080| option | FlowItem分组配置信息。  |
16081| index | FlowItem索引值。  |
16082
16083**返回:**
16084
16085列间距。
16086
16087
16088### OH_ArkUI_WaterFlowSectionOption_GetCrossCount()
16089
16090```
16091int32_t OH_ArkUI_WaterFlowSectionOption_GetCrossCount (ArkUI_WaterFlowSectionOption * option, int32_t index )
16092```
16093**描述:**
16094
16095通过FlowItem分组配置信息获取对应索引下的布局栅格数。
16096
16097**起始版本:** 12
16098
16099**参数:**
16100
16101| 名称 | 描述 |
16102| -------- | -------- |
16103| option | FlowItem分组配置信息。  |
16104| index | FlowItem索引值。  |
16105
16106**返回:**
16107
16108布局栅格数量。
16109
16110
16111### OH_ArkUI_WaterFlowSectionOption_GetItemCount()
16112
16113```
16114int32_t OH_ArkUI_WaterFlowSectionOption_GetItemCount (ArkUI_WaterFlowSectionOption * option, int32_t index )
16115```
16116**描述:**
16117
16118通过FlowItem分组配置信息获取对应索引下的FlowItem数量。
16119
16120**起始版本:** 12
16121
16122**参数:**
16123
16124| 名称 | 描述 |
16125| -------- | -------- |
16126| option | FlowItem分组配置信息。  |
16127| index | FlowItem索引值。  |
16128
16129**返回:**
16130
16131分组中FlowItem数量。
16132
16133
16134### OH_ArkUI_WaterFlowSectionOption_GetMargin()
16135
16136```
16137ArkUI_Margin OH_ArkUI_WaterFlowSectionOption_GetMargin (ArkUI_WaterFlowSectionOption * option, int32_t index )
16138```
16139**描述:**
16140
16141通过FlowItem分组配置信息获取对应索引下的分组的外边距。
16142
16143**起始版本:** 12
16144
16145**参数:**
16146
16147| 名称 | 描述 |
16148| -------- | -------- |
16149| option | FlowItem分组配置信息。  |
16150| index | FlowItem索引值。  |
16151
16152**返回:**
16153
16154外边距。
16155
16156
16157### OH_ArkUI_WaterFlowSectionOption_GetRowGap()
16158
16159```
16160float OH_ArkUI_WaterFlowSectionOption_GetRowGap (ArkUI_WaterFlowSectionOption * option, int32_t index )
16161```
16162**描述:**
16163
16164通过FlowItem分组配置信息获取对应索引下的分组的行间距。
16165
16166**起始版本:** 12
16167
16168**参数:**
16169
16170| 名称 | 描述 |
16171| -------- | -------- |
16172| option | FlowItem分组配置信息。  |
16173| index | FlowItem索引值。  |
16174
16175**返回:**
16176
16177行间距。
16178
16179
16180### OH_ArkUI_WaterFlowSectionOption_GetSize()
16181
16182```
16183int32_t OH_ArkUI_WaterFlowSectionOption_GetSize (ArkUI_WaterFlowSectionOption * option)
16184```
16185**描述:**
16186
16187设置FlowItem分组配置信息数组长度。
16188
16189**起始版本:** 12
16190
16191**参数:**
16192
16193| 名称 | 描述 |
16194| -------- | -------- |
16195| option | FlowItem分组配置信息。  |
16196
16197**返回:**
16198
16199数组长度。如果返回-1,则返回失败。失败的原因可能是option参数异常,如空指针。
16200
16201
16202### OH_ArkUI_WaterFlowSectionOption_RegisterGetItemMainSizeCallbackByIndex()
16203
16204```
16205void OH_ArkUI_WaterFlowSectionOption_RegisterGetItemMainSizeCallbackByIndex (ArkUI_WaterFlowSectionOption * option, int32_t index, float(*)(int32_t itemIndex) callback )
16206```
16207**描述:**
16208
16209通过FlowItem分组配置信息根据flowItemIndex获取指定Item的主轴大小。
16210
16211**起始版本:** 12
16212
16213**参数:**
16214
16215| 名称 | 描述 |
16216| -------- | -------- |
16217| option | FlowItem分组配置信息。  |
16218| index | FlowItem索引值。  |
16219| callback | 根据index获取指定Item的主轴大小。  |
16220
16221
16222### OH_ArkUI_WaterFlowSectionOption_RegisterGetItemMainSizeCallbackByIndexWithUserData()
16223
16224```
16225void OH_ArkUI_WaterFlowSectionOption_RegisterGetItemMainSizeCallbackByIndexWithUserData (ArkUI_WaterFlowSectionOption * option, int32_t index, void * userData, float(*)(int32_t itemIndex, void *userData) callback )
16226```
16227**描述:**
16228
16229通过FlowItem分组配置信息根据flowItemIndex获取指定Item的主轴大小。
16230
16231**起始版本:** 12
16232
16233**参数:**
16234
16235| 名称 | 描述 |
16236| -------- | -------- |
16237| option | FlowItem分组配置信息。  |
16238| index | FlowItem索引值。  |
16239| userData | FlowItem自定义数据。  |
16240| callback | 根据index获取指定Item的主轴大小。  |
16241
16242
16243### OH_ArkUI_WaterFlowSectionOption_SetColumnGap()
16244
16245```
16246void OH_ArkUI_WaterFlowSectionOption_SetColumnGap (ArkUI_WaterFlowSectionOption * , int32_t index, float columnGap )
16247```
16248**描述:**
16249
16250设置分组的列间距。
16251
16252**起始版本:** 12
16253
16254**参数:**
16255
16256| 名称 | 描述 |
16257| -------- | -------- |
16258| option | FlowItem分组配置信息。  |
16259| index | FlowItem索引值。  |
16260| columnGap | 列间距。  |
16261
16262
16263### OH_ArkUI_WaterFlowSectionOption_SetCrossCount()
16264
16265```
16266void OH_ArkUI_WaterFlowSectionOption_SetCrossCount (ArkUI_WaterFlowSectionOption * option, int32_t index, int32_t crossCount )
16267```
16268**描述:**
16269
16270设置布局栅格,纵向布局时为列数,横向布局时为行数。
16271
16272**起始版本:** 12
16273
16274**参数:**
16275
16276| 名称 | 描述 |
16277| -------- | -------- |
16278| option | FlowItem分组配置信息。  |
16279| index | FlowItem索引值。  |
16280| crossCount | 布局栅格数量。  |
16281
16282
16283### OH_ArkUI_WaterFlowSectionOption_SetItemCount()
16284
16285```
16286void OH_ArkUI_WaterFlowSectionOption_SetItemCount (ArkUI_WaterFlowSectionOption * option, int32_t index, int32_t itemCount )
16287```
16288**描述:**
16289
16290设置分组中FlowItem数量。
16291
16292**起始版本:** 12
16293
16294**参数:**
16295
16296| 名称 | 描述 |
16297| -------- | -------- |
16298| option | FlowItem分组配置信息。  |
16299| index | FlowItem索引值。  |
16300| itemCount | 分组中FlowItem数量。  |
16301
16302
16303### OH_ArkUI_WaterFlowSectionOption_SetMargin()
16304
16305```
16306void OH_ArkUI_WaterFlowSectionOption_SetMargin (ArkUI_WaterFlowSectionOption * option, int32_t index, float marginTop, float marginRight, float marginBottom, float marginLeft )
16307```
16308**描述:**
16309
16310设置分组的外边距。
16311
16312**起始版本:** 12
16313
16314**参数:**
16315
16316| 名称 | 描述 |
16317| -------- | -------- |
16318| option | FlowItem分组配置信息。  |
16319| index | FlowItem索引值。  |
16320| marginTop | FlowItem上外边距。  |
16321| marginRight | FlowItem右外边距。  |
16322| marginBottom | FlowItem下外边距。  |
16323| marginLeft | FlowItem左外边距。  |
16324
16325
16326### OH_ArkUI_WaterFlowSectionOption_SetRowGap()
16327
16328```
16329void OH_ArkUI_WaterFlowSectionOption_SetRowGap (ArkUI_WaterFlowSectionOption * option, int32_t index, float rowGap )
16330```
16331**描述:**
16332
16333设置分组的行间距。
16334
16335**起始版本:** 12
16336
16337**参数:**
16338
16339| 名称 | 描述 |
16340| -------- | -------- |
16341| option | FlowItem分组配置信息。  |
16342| index | FlowItem索引值。  |
16343| rowGap | 行间距。  |
16344
16345
16346### OH_ArkUI_WaterFlowSectionOption_SetSize()
16347
16348```
16349void OH_ArkUI_WaterFlowSectionOption_SetSize (ArkUI_WaterFlowSectionOption * option, int32_t size )
16350```
16351**描述:**
16352
16353设置FlowItem分组配置信息数组长度。
16354
16355**起始版本:** 12
16356
16357**参数:**
16358
16359| 名称 | 描述 |
16360| -------- | -------- |
16361| option | FlowItem分组配置信息。  |
16362| size | 数组长度。  |
16363
16364
16365### OH_ArkUI_PostFrameCallback()
16366
16367```
16368int32_t OH_ArkUI_PostFrameCallback(ArkUI_ContextHandle uiContext, void* userData, void (*callback)(uint64_t nanoTimestamp, uint32_t frameCount, void* userData))
16369```
16370**描述:**
16371
16372注册一个回调函数,以便在下一帧渲染时执行。不允许在非UI线程调用,检查到非UI线程调用程序会主动abort。
16373
16374**起始版本:** 18
16375
16376**参数:**
16377
16378| 名称 | 描述 |
16379| -------- | -------- |
16380| uiContext | uiContext对象,用以绑定实例。|
16381| userData | 自定义事件参数,当事件触发时在回调参数中携带回来。|
16382| callback | 自定义回调函数,会在下一帧事件结束后回调。|
16383| nanoTimestamp | 帧信号的时间戳。|
16384| frameCount | 帧号。|
16385
16386**返回:**
16387
16388ARKUI_ERROR_CODE_NO_ERROR 成功。
16389ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化错误。
16390ARKUI_ERROR_CODE_UI_CONTEXT_INVALID uiContext对象无效。
16391ARKUI_ERROR_CODE_CALLBACK_INVALID 回调函数无效。
16392
16393
16394### OH_ArkUI_RegisterLayoutCallbackOnNodeHandle()
16395
16396```
16397int32_t OH_ArkUI_RegisterLayoutCallbackOnNodeHandle (ArkUI_NodeHandle node, void* userData, void (*onLayoutCompleted)(void* userData))
16398```
16399**描述:**
16400
16401注册组件布局完成回调方法。同一组件仅能注册一个布局完成回调方法。
16402
16403**起始版本:** 15
16404
16405**参数:**
16406
16407| 名称 | 描述 |
16408| -------- | -------- |
16409| node | 指定的节点。  |
16410| userData | 自定义事件参数,当事件触发时在回调参数中携带回来。  |
16411| onLayoutCompleted | 事件触发后的回调。  |
16412
16413**返回:**
16414
16415ARKUI_ERROR_CODE_NO_ERROR 成功。
16416ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
16417
16418
16419### OH_ArkUI_RegisterDrawCallbackOnNodeHandle()
16420
16421```
16422int32_t OH_ArkUI_RegisterDrawCallbackOnNodeHandle (ArkUI_NodeHandle node, void* userData, void (*onDrawCompleted)(void* userData))
16423```
16424**描述:**
16425
16426注册组件绘制完成回调方法。同一组件仅能注册一个绘制完成回调方法。
16427
16428**起始版本:** 15
16429
16430**参数:**
16431
16432| 名称 | 描述 |
16433| -------- | -------- |
16434| node | 指定的节点。  |
16435| userData | 自定义事件参数,当事件触发时在回调参数中携带回来。  |
16436| onDrawCompleted | 事件触发后的回调。  |
16437
16438**返回:**
16439
16440ARKUI_ERROR_CODE_NO_ERROR 成功。
16441ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
16442
16443
16444### OH_ArkUI_UnregisterLayoutCallbackOnNodeHandle()
16445
16446```
16447int32_t OH_ArkUI_UnregisterLayoutCallbackOnNodeHandle (ArkUI_NodeHandle node)
16448```
16449**描述:**
16450
16451取消注册组件布局完成回调方法。
16452
16453**起始版本:** 15
16454
16455**参数:**
16456
16457| 名称 | 描述 |
16458| -------- | -------- |
16459| node | 指定的节点。  |
16460
16461**返回:**
16462
16463ARKUI_ERROR_CODE_NO_ERROR 成功。
16464ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
16465
16466
16467### OH_ArkUI_UnregisterDrawCallbackOnNodeHandle()
16468
16469```
16470int32_t OH_ArkUI_UnregisterDrawCallbackOnNodeHandle (ArkUI_NodeHandle node)
16471```
16472**描述:**
16473
16474取消注册组件绘制完成回调方法。
16475
16476**起始版本:** 15
16477
16478**参数:**
16479
16480| 名称 | 描述 |
16481| -------- | -------- |
16482| node | 指定的节点。  |
16483
16484**返回:**
16485
16486ARKUI_ERROR_CODE_NO_ERROR 成功。
16487ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
16488
16489
16490### OH_ArkUI_ProgressLinearStyleOption_Create
16491
16492```
16493ArkUI_ProgressLinearStyleOption* OH_ArkUI_ProgressLinearStyleOption_Create(void)
16494```
16495**描述:**
16496
16497创建线性进度条样式信息。
16498
16499**起始版本:** 15
16500
16501**返回:**
16502
16503ProgressLinearStyleOption实例。
16504
16505
16506### OH_ArkUI_ProgressLinearStyleOption_Destroy
16507
16508```
16509void OH_ArkUI_ProgressLinearStyleOption_Destroy(ArkUI_ProgressLinearStyleOption* option)
16510```
16511**描述:**
16512
16513销毁线性进度条样式信息。
16514
16515**起始版本:** 15
16516
16517**参数:**
16518
16519| 名称 | 描述 |
16520| -------- | -------- |
16521| option | 要销毁的ProgressLinearStyleOption实例。  |
16522
16523
16524### OH_ArkUI_ProgressLinearStyleOption_SetScanEffectEnabled
16525
16526```
16527void OH_ArkUI_ProgressLinearStyleOption_SetSmoothEffectEnabled(ArkUI_ProgressLinearStyleOption* option, bool enabled)
16528```
16529**描述:**
16530
16531设置扫光效果的开关。
16532
16533**起始版本:** 15
16534
16535
16536**参数:**
16537
16538| 名称 | 描述 |
16539| -------- | -------- |
16540| option | ProgressLinearStyleOption实例。  |
16541| enabled | 扫光效果的开关。默认值:false。 |
16542
16543
16544### OH_ArkUI_ProgressLinearStyleOption_SetSmoothEffectEnabled
16545
16546```
16547void OH_ArkUI_ProgressLinearStyleOption_SetSmoothEffectEnabled(ArkUI_ProgressLinearStyleOption* option, bool enabled)
16548```
16549**描述:**
16550
16551设置进度平滑动效的开关。
16552
16553**起始版本:** 15
16554
16555
16556**参数:**
16557
16558| 名称 | 描述 |
16559| -------- | -------- |
16560| option | ProgressLinearStyleOption实例。  |
16561| enabled | 进度平滑动效的开关。开启平滑动效后设置进度,进度会从当前值渐变至设定值,否则进度从当前值突变至设定值。默认值:true。 |
16562
16563
16564### OH_ArkUI_ProgressLinearStyleOption_SetStrokeWidth
16565
16566```
16567void OH_ArkUI_ProgressLinearStyleOption_SetStrokeWidth(ArkUI_ProgressLinearStyleOption* option, float strokeWidth)
16568```
16569**描述:**
16570
16571设置线性进度条宽度。
16572
16573**起始版本:** 15
16574
16575
16576**参数:**
16577
16578| 名称 | 描述 |
16579| -------- | -------- |
16580| option | ProgressLinearStyleOption实例。  |
16581| strokeWidth | 进度条宽度值(不支持百分比设置),默认值:4.0vp。 |
16582
16583
16584### OH_ArkUI_ProgressLinearStyleOption_SetStrokeRadius
16585
16586```
16587void OH_ArkUI_ProgressLinearStyleOption_SetStrokeRadius(ArkUI_ProgressLinearStyleOption* option, float strokeRadius)
16588```
16589**描述:**
16590
16591设置线性进度条圆角半径。
16592
16593**起始版本:** 15
16594
16595
16596**参数:**
16597
16598| 名称 | 描述 |
16599| -------- | -------- |
16600| option | ProgressLinearStyleOption实例。  |
16601| strokeRadius | 进度条圆角半径值,取值范围[0, strokeWidth/2]。默认值:strokeWidth/2。 |
16602
16603
16604### OH_ArkUI_ProgressLinearStyleOption_GetScanEffectEnabled
16605
16606```
16607bool OH_ArkUI_ProgressLinearStyleOption_GetScanEffectEnabled(ArkUI_ProgressLinearStyleOption* option)
16608```
16609**描述:**
16610
16611获取线性进度条扫光效果的开关信息。
16612
16613**起始版本:** 15
16614
16615**参数:**
16616
16617| 名称 | 描述 |
16618| -------- | -------- |
16619| option | ProgressLinearStyleOption实例。  |
16620
16621**返回:**
16622
16623是否开启扫光效果。
16624
16625
16626### OH_ArkUI_ProgressLinearStyleOption_GetSmoothEffectEnabled
16627
16628```
16629bool OH_ArkUI_ProgressLinearStyleOption_GetSmoothEffectEnabled(ArkUI_ProgressLinearStyleOption* option)
16630```
16631**描述:**
16632
16633获取线性进度条进度平滑动效的开关信息。
16634
16635**起始版本:** 15
16636
16637**参数:**
16638
16639| 名称 | 描述 |
16640| -------- | -------- |
16641| option | ProgressLinearStyleOption实例。  |
16642
16643**返回:**
16644
16645是否开启平滑动效。
16646
16647
16648### OH_ArkUI_ProgressLinearStyleOption_GetStrokeWidth
16649
16650```
16651float OH_ArkUI_ProgressLinearStyleOption_GetStrokeWidth(ArkUI_ProgressLinearStyleOption* option)
16652```
16653**描述:**
16654
16655获取线性进度条宽度。
16656
16657**起始版本:** 15
16658
16659**参数:**
16660
16661| 名称 | 描述 |
16662| -------- | -------- |
16663| option | ProgressLinearStyleOption实例。  |
16664
16665**返回:**
16666
16667进度条宽度值。
16668
16669
16670### OH_ArkUI_ProgressLinearStyleOption_GetStrokeRadius
16671
16672```
16673float OH_ArkUI_ProgressLinearStyleOption_GetStrokeRadius(ArkUI_ProgressLinearStyleOption* option)
16674```
16675**描述:**
16676
16677获取线性进度条圆角半径值。
16678
16679**起始版本:** 15
16680
16681**参数:**
16682
16683| 名称 | 描述 |
16684| -------- | -------- |
16685| option | ProgressLinearStyleOption实例。  |
16686
16687**返回:**
16688
16689进度条圆角半径值。
16690
16691
16692### OH_ArkUI_DragEvent_StartDataLoading()
16693
16694```
16695int32_t OH_ArkUI_DragEvent_StartDataLoading (ArkUI_DragEvent* event, OH_UdmfGetDataParams* options, char* key, unsigned int keyLen)
16696```
16697**描述:**
16698
16699异步获取拖拽数据。
16700
16701**起始版本:** 15
16702
16703**参数:**
16704
16705| 名称 | 描述 |
16706| -------- | -------- |
16707| event | ArkUI_DragEvent事件指针。  |
16708| options | 从UDMF获取数据时的参数。  |
16709| key | 数据的唯一标识,当事件触发时在回调参数中携带回来。  |
16710| keyLen | key的长度,需要大于等于UDMF_KEY_BUFFER_LEN。  |
16711
16712**返回:**
16713
16714ARKUI_ERROR_CODE_NO_ERROR 成功。
16715ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
16716
16717
16718### OH_ArkUI_CancelDataLoading()
16719
16720```
16721int32_t OH_ArkUI_CancelDataLoading (ArkUI_ContextHandle uiContext, const char* key)
16722```
16723**描述:**
16724
16725取消异步获取拖拽数据。
16726
16727**起始版本:** 15
16728
16729**参数:**
16730
16731| 名称 | 描述 |
16732| -------- | -------- |
16733| uiContext | uiContext对象,用以绑定实例。|
16734| key | 数据的唯一标识。|
16735
16736**返回:**
16737
16738ARKUI_ERROR_CODE_NO_ERROR 成功。
16739ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
16740
16741
16742### OH_ArkUI_DisableDropDataPrefetchOnNode()
16743
16744```
16745int32_t OH_ArkUI_DisableDropDataPrefetchOnNode (ArkUI_NodeHandle node, bool disable)
16746```
16747**描述:**
16748
16749异步获取拖拽数据。
16750
16751**起始版本:** 15
16752
16753**参数:**
16754
16755| 名称 | 描述 |
16756| -------- | -------- |
16757| node | 指定的节点。  |
16758| disable | 设置拖拽是否提前获取数据。true为不提前获取数据,默认值为false。当使用OH_ArkUI_DragEvent_StartDataLoading获取数据时,需设置为true。 |
16759
16760
16761**返回:**
16762
16763ARKUI_ERROR_CODE_NO_ERROR 成功。
16764ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
16765
16766### OH_ArkUI_CrossLanguageOption_Create()
16767
16768```
16769ArkUI_CrossLanguageOption* OH_ArkUI_CrossLanguageOption_Create(void)
16770```
16771**描述:**
16772
16773创建跨语言配置项实例。
16774
16775**起始版本:** 15
16776
16777**返回:**
16778
16779返回跨语言实例。如果对象返回空指针,则表示创建失败,失败的原因可能是地址空间已满。
16780
16781
16782### OH_ArkUI_CrossLanguageOption_Destroy()
16783
16784```
16785void OH_ArkUI_CrossLanguageOption_Destroy(ArkUI_CrossLanguageOption* option)
16786```
16787**描述:**
16788
16789销毁跨语言配置项实例。
16790
16791**起始版本:** 15
16792
16793**参数:**
16794
16795| 名称 | 描述 |
16796| -------- | -------- |
16797| option | 要销毁的跨语言配置项实例。  |
16798
16799### OH_ArkUI_CrossLanguageOption_SetAttributeSettingStatus()
16800
16801```
16802void OH_ArkUI_CrossLanguageOption_SetAttributeSettingStatus(ArkUI_CrossLanguageOption* option, bool enabled)
16803```
16804**描述:**
16805
16806设置配置项中是否允许跨语言修改属性。
16807
16808**起始版本:** 15
16809
16810**参数:**
16811
16812| 名称 | 描述 |
16813| -------- | -------- |
16814| option | 跨语言配置项实例。  |
16815| enabled | 是否允许跨语言修改属性。默认值:false。  |
16816
16817### OH_ArkUI_CrossLanguageOption_GetAttributeSettingStatus()
16818
16819```
16820bool OH_ArkUI_CrossLanguageOption_GetAttributeSettingStatus(ArkUI_CrossLanguageOption* option)
16821```
16822**描述:**
16823
16824获取配置项中是否允许跨语言修改属性。
16825
16826**起始版本:** 15
16827
16828**参数:**
16829
16830| 名称 | 描述 |
16831| -------- | -------- |
16832| option | 跨语言配置项实例。  |
16833
16834**返回:**
16835
16836是否允许跨语言修改属性。
16837
16838### OH_ArkUI_VisibleAreaEventOptions_Create()
16839
16840```
16841ArkUI_VisibleAreaEventOptions* OH_ArkUI_VisibleAreaEventOptions_Create()
16842```
16843**描述:**
16844
16845创建可见区域变化监听的参数。
16846
16847**起始版本:** 17
16848
16849**返回:**
16850可见区域变化监听的参数。
16851
16852### OH_ArkUI_VisibleAreaEventOptions_Dispose()
16853
16854```
16855void OH_ArkUI_VisibleAreaEventOptions_Dispose(ArkUI_VisibleAreaEventOptions* option)
16856```
16857**描述:**
16858
16859销毁可见区域变化监听的参数。
16860
16861**起始版本:** 17
16862
16863**参数:**
16864
16865| 名称 | 描述 |
16866| -------- | -------- |
16867| option | 需要销毁的实例。  |
16868
16869### OH_ArkUI_VisibleAreaEventOptions_SetRatios()
16870
16871```
16872int32_t OH_ArkUI_VisibleAreaEventOptions_SetRatios(ArkUI_VisibleAreaEventOptions* option, float* value, int32_t size)
16873```
16874**描述:**
16875
16876设置阈值数组。
16877
16878**起始版本:** 17
16879
16880**参数:**
16881
16882| 名称 | 描述 |
16883| -------- | -------- |
16884| option | 可见区域变化监听的参数实例。|
16885| value | 阈值数组。|
16886| size | 阈值数组大小。|
16887
16888**返回:**
16889
16890ARKUI_ERROR_CODE_NO_ERROR 成功。
16891ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
16892
16893### OH_ArkUI_VisibleAreaEventOptions_SetExpectedUpdateInterval()
16894
16895```
16896int32_t OH_ArkUI_VisibleAreaEventOptions_SetExpectedUpdateInterval(
16897    ArkUI_VisibleAreaEventOptions *option, int32_t value)
16898```
16899**描述:**
16900
16901设置预期更新间隔,单位为ms。定义了开发者期望的更新间隔。
16902
16903**起始版本:** 17
16904
16905**参数:**
16906
16907| 名称 | 描述 |
16908| -------- | -------- |
16909| option | 可见区域变化监听的参数实例。|
16910| value | 预期更新间隔,单位为ms。定义了开发者期望的更新间隔。默认值:1000。|
16911
16912**返回:**
16913
16914ARKUI_ERROR_CODE_NO_ERROR 成功。
16915ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
16916
16917### OH_ArkUI_VisibleAreaEventOptions_GetRatios()
16918
16919```
16920int32_t OH_ArkUI_VisibleAreaEventOptions_GetRatios(ArkUI_VisibleAreaEventOptions* option, float* value, int32_t* size)
16921```
16922**描述:**
16923
16924 获取阈值数组。
16925
16926**起始版本:** 17
16927
16928**参数:**
16929
16930| 名称 | 描述 |
16931| -------- | -------- |
16932| option | 可见区域变化监听的参数实例。|
16933| value | 阈值数组。|
16934| size | 阈值数组大小。|
16935
16936**返回:**
16937
16938ARKUI_ERROR_CODE_NO_ERROR 成功。
16939ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
16940ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR 数组大小不够。
16941
16942### OH_ArkUI_VisibleAreaEventOptions_GetExpectedUpdateInterval()
16943
16944```
16945int32_t OH_ArkUI_VisibleAreaEventOptions_GetExpectedUpdateInterval(ArkUI_VisibleAreaEventOptions* option)
16946```
16947**描述:**
16948
16949 获取预期更新间隔。
16950
16951**起始版本:** 17
16952
16953**参数:**
16954
16955| 名称 | 描述 |
16956| -------- | -------- |
16957| option | 可见区域变化监听的参数实例。|
16958
16959**返回:**
16960预期更新间隔,单位为ms。定义了开发者期望的更新间隔。默认值:1000。
16961
16962### OH_ArkUI_NodeUtils_GetPositionToParent()
16963
16964```
16965int32_t OH_ArkUI_NodeUtils_GetPositionToParent (ArkUI_NodeHandle node, ArkUI_IntOffset* globalOffset )
16966```
16967**描述:**
16968
16969获取目标节点相对于父节点的偏移值。
16970
16971**起始版本:** 15
16972
16973**参数:**
16974
16975| 名称 | 描述 |
16976| -------- | -------- |
16977| node | ArkUI_NodeHandle指针。  |
16978| globalOffset | 组件handle相对父节点的偏移值,单位:px。  |
16979
16980**返回:**
16981
16982ARKUI_ERROR_CODE_NO_ERROR 成功。
16983ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
16984
16985### OH_ArkUI_GetGestureParam_DirectMask()
16986
16987```
16988int32_t OH_ArkUI_GetGestureParam_DirectMask(ArkUI_GestureRecognizer* recognizer, ArkUI_GestureDirectionMask* directMask)
16989```
16990**描述:**
16991
16992获取手势识别器的滑动方向。
16993
16994**起始版本:** 18
16995
16996**参数:**
16997
16998| 名称 | 描述 |
16999| -------- | -------- |
17000| recognizer | 手势识别器指针。  |
17001| directMask | 手势识别器的滑动方向。  |
17002
17003**返回:**
17004
17005ARKUI_ERROR_CODE_NO_ERROR 成功。
17006ARKUI_ERROR_CODE_PARAM_INVALID 参数错误。
17007
17008### OH_ArkUI_GetGestureParam_FingerCount()
17009
17010```
17011int32_t OH_ArkUI_GetGestureParam_FingerCount(ArkUI_GestureRecognizer* recognizer, int* finger)
17012```
17013**描述:**
17014
17015获取手势识别器的手指数。
17016
17017**起始版本:** 18
17018
17019**参数:**
17020
17021| 名称 | 描述 |
17022| -------- | -------- |
17023| recognizer | 手势识别器指针。  |
17024| finger | 手势识别器的手指数。  |
17025
17026**返回:**
17027
17028ARKUI_ERROR_CODE_NO_ERROR 成功。
17029ARKUI_ERROR_CODE_PARAM_INVALID 参数错误。
17030
17031### OH_ArkUI_GetGestureParam_limitFingerCount()
17032
17033```
17034int32_t OH_ArkUI_GetGestureParam_limitFingerCount(ArkUI_GestureRecognizer* recognizer, bool* isLimited)
17035```
17036**描述:**
17037
17038获取手势识别器是否有手指数限制。
17039
17040**起始版本:** 18
17041
17042**参数:**
17043
17044| 名称 | 描述 |
17045| -------- | -------- |
17046| recognizer | 手势识别器指针。  |
17047| isLimited | 手势识别器是否有手指数限制。  |
17048
17049**返回:**
17050
17051ARKUI_ERROR_CODE_NO_ERROR 成功。
17052ARKUI_ERROR_CODE_PARAM_INVALID 参数错误。
17053
17054### OH_ArkUI_GetGestureParam_repeat()
17055
17056```
17057int32_t OH_ArkUI_GetGestureParam_repeat(ArkUI_GestureRecognizer* recognizer, bool* isRepeat)
17058```
17059**描述:**
17060
17061获取手势识别器是否连续触发事件回调。
17062
17063**起始版本:** 18
17064
17065**参数:**
17066
17067| 名称 | 描述 |
17068| -------- | -------- |
17069| recognizer | 手势识别器指针。  |
17070| isRepeat | 手势识别器是否连续触发事件回调。  |
17071
17072**返回:**
17073
17074ARKUI_ERROR_CODE_NO_ERROR 成功。
17075ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED 不支持手势识别器类型。
17076
17077### OH_ArkUI_GetGestureParam_distance()
17078
17079```
17080int32_t OH_ArkUI_GetGestureParam_distance(ArkUI_GestureRecognizer* recognizer, double* distance)
17081```
17082**描述:**
17083
17084获取手势识别器的手指允许的移动距离范围。
17085
17086**起始版本:** 18
17087
17088**参数:**
17089
17090| 名称 | 描述 |
17091| -------- | -------- |
17092| recognizer | 手势识别器指针。  |
17093| distance | 手势识别器的手指允许的移动距离范围。  |
17094
17095**返回:**
17096
17097ARKUI_ERROR_CODE_NO_ERROR 成功。
17098ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED 不支持手势识别器类型。
17099
17100### OH_ArkUI_GetGestureParam_speed()
17101
17102```
17103int32_t OH_ArkUI_GetGestureParam_speed(ArkUI_GestureRecognizer* recognizer, double* speed)
17104```
17105**描述:**
17106
17107获取手势识别器的识别滑动的最小速度。
17108
17109**起始版本:** 18
17110
17111**参数:**
17112
17113| 名称 | 描述 |
17114| -------- | -------- |
17115| recognizer | 手势识别器指针。  |
17116| speed | 手势识别器的识别滑动的最小速度。  |
17117
17118**返回:**
17119
17120ARKUI_ERROR_CODE_NO_ERROR 成功。
17121ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED 不支持手势识别器类型。
17122
17123### OH_ArkUI_GetGestureParam_duration()
17124
17125```
17126int32_t OH_ArkUI_GetGestureParam_duration(ArkUI_GestureRecognizer* recognizer, int* duration)
17127```
17128**描述:**
17129
17130获取手势识别器的触发长按的最短时间。
17131
17132**起始版本:** 18
17133
17134**参数:**
17135
17136| 名称 | 描述 |
17137| -------- | -------- |
17138| recognizer | 手势识别器指针。  |
17139| duration | 手势识别器的触发长按的最短时间。  |
17140
17141**返回:**
17142
17143ARKUI_ERROR_CODE_NO_ERROR 成功。
17144ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED 不支持手势识别器类型。
17145
17146### OH_ArkUI_GetGestureParam_angle()
17147
17148```
17149int32_t OH_ArkUI_GetGestureParam_angle(ArkUI_GestureRecognizer* recognizer, double* angle)
17150```
17151**描述:**
17152
17153获取手势识别器的旋转手势的最小改变度数。
17154
17155**起始版本:** 18
17156
17157**参数:**
17158
17159| 名称 | 描述 |
17160| -------- | -------- |
17161| recognizer | 手势识别器指针。  |
17162| angle | 手势识别器的旋转手势的最小改变度数。  |
17163
17164**返回:**
17165
17166ARKUI_ERROR_CODE_NO_ERROR 成功。
17167ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED 不支持手势识别器类型。
17168
17169### OH_ArkUI_GetGestureParam_distanceThreshold()
17170
17171```
17172int32_t OH_ArkUI_GetGestureParam_distanceThreshold(ArkUI_GestureRecognizer* recognizer, double* distanceThreshold)
17173```
17174**描述:**
17175
17176获取手势识别器的手势移动阈值。
17177
17178**起始版本:** 18
17179
17180**参数:**
17181
17182| 名称 | 描述 |
17183| -------- | -------- |
17184| recognizer | 手势识别器指针。  |
17185| distanceThreshold | 手势识别器的手势移动阈值。单位:px。  |
17186
17187**返回:**
17188
17189ARKUI_ERROR_CODE_NO_ERROR 成功。
17190ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED 不支持手势识别器类型。
17191
17192### OH_ArkUI_GetNodeSnapshot()
17193
17194```
17195int32_t OH_ArkUI_GetNodeSnapshot(ArkUI_NodeHandle node, ArkUI_SnapshotOptions* snapshotOptions, OH_PixelmapNative** pixelMap)
17196```
17197
17198**描述**
17199
17200获取指定组件节点的截图,执行过程为同步,调用时应确保对应节点已被渲染(避免在把节点挂树时就立即执行截图,因为图形的渲染一般需要一帧时间生效)。
17201
17202**注意:**
17203
17204当返回的Pixelmap不再使用时,应通过 [OH_PixelmapNative_Release](../apis-image-kit/_image___native_module.md#oh_pixelmapnative_release) 释放它。
17205
17206**起始版本:** 15
17207
17208**参数:**
17209
17210| 名称          |  描述                                                     |
17211| --------------- | ------------------------------------------------------------ |
17212| node            | 截图的目标节点。                                             |
17213| snapshotOptions | 给定的截图配置,为空时表示默认配置。              |
17214| pixelmap        | 通过系统创建的pixelmap指针。 |
17215
17216**返回:**
17217
17218ARKUI_ERROR_CODE_NO_ERROR 成功。
17219ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
17220ARKUI_ERROR_CODE_INTERNAL_ERROR 截图失败,将返回空指针。
17221ARKUI_ERROR_CODE_COMPONENT_SNAPSHOT_TIMEOUT 截图超时。
17222
17223
17224### OH_ArkUI_CreateSnapshotOptions()
17225
17226```
17227ArkUI_SnapshotOptions* OH_ArkUI_CreateSnapshotOptions()
17228```
17229
17230**描述**
17231
17232创建一个截图选项,当返回值不再使用时必须通过`OH_ArkUI_SnapshotOptions_Dispose`释放。
17233
17234**起始版本:** 15
17235
17236**返回:**
17237
17238返回指向创建的截图选项对象的指针。
17239
17240
17241### OH_ArkUI_DestroySnapshotOptions()
17242
17243```
17244void OH_ArkUI_DestroySnapshotOptions(ArkUI_SnapshotOptions* snapshotOptions)
17245```
17246
17247**描述**
17248
17249销毁截图选项指针。
17250
17251**起始版本:** 15
17252
17253**参数:**
17254
17255| 名称         | 描述         |
17256| --------------- | ---- |
17257| snapshotOptions | 截图选项。 |
17258
17259### OH_ArkUI_SnapshotOptions_SetScale()
17260
17261```
17262int32_t OH_ArkUI_SnapshotOptions_SetScale(ArkUI_SnapshotOptions* snapshotOptions, float scale)
17263```
17264
17265**描述**
17266
17267配置截图选项中的缩放属性。
17268
17269**起始版本:** 15
17270
17271**参数:**
17272
17273| 名称 | 描述 |
17274| -------- | -------- |
17275| snapshotOptions | 截图选项。 |
17276| scale           | 缩放值。<br>取值范围:(0,+∞) |
17277
17278**返回:**
17279
17280ARKUI_ERROR_CODE_NO_ERROR 成功。
17281ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。
17282