1# ArkUI_NativeModule 2 3 4## Overview 5 6Provides drag and drop APIs of ArkUI on the native side. 7 8Provides the general key event APIs of ArkUI on the native side. 9 10Provides the APIs of ArkUI to register gesture callbacks on the native side. 11 12Provides animation callbacks of ArkUI on the native side. 13 14Provides UI capabilities of ArkUI on the native side, such as UI component creation and destruction, tree node operations, attribute setting, and event listening. 15 16**Since**: 12 17 18 19## Summary 20 21 22### Files 23 24| Name| Description| 25| -------- | -------- | 26| [drag_and_drop.h](drag__and__drop_8h.md) | Declares the APIs of **NativeDrag**. | 27| [drawable_descriptor.h](drawable__descriptor_8h.md) | Declares the APIs of **NativeDrawableDescriptor**. | 28| [native_animate.h](native__animate_8h.md) | Declares a set of animation APIs of ArkUI on the native side. | 29| [native_dialog.h](native__dialog_8h.md) | Declares a set of custom dialog box APIs of ArkUI on the native side. | 30| [native_gesture.h](native__gesture_8h.md) | Declares the APIs of **NativeGesture**. | 31| [native_interface.h](native__interface_8h.md) | Declares a unified entry for the native module APIs. | 32| [native_interface_focus.h](native__interface__focus_8h.md) | Declares the APIs of **NativeFocus**.| 33| [native_key_event.h](native__key_event_8h.md) | Declares the APIs of **NativeKeyEvent**. | 34| [native_node.h](native__node_8h.md) | Declares the APIs of **NativeNode**. | 35| [native_node_napi.h](native__node__napi_8h.md) | Declares the functions used to convert FrameNodes on the ArkTS side into NodeHandles. | 36| [native_type.h](native__type_8h.md) | Defines the common types for the native module. | 37| [styled_string.h](styled__string_8h.md) | Declares styled string APIs of ArkUI on the native side. | 38 39 40### Structs 41 42| Name| Description| 43| -------- | -------- | 44| struct [ArkUI_ExpectedFrameRateRange](_ark_u_i___expected_frame_rate_range.md) | Defines a struct for the expected frame rate range of the animation. | 45| struct [ArkUI_AnimateCompleteCallback](_ark_u_i___animate_complete_callback.md) | Defines a struct for the callback type for when the animation playback is complete. | 46| struct [ArkUI_NativeAnimateAPI_1](_ark_u_i___native_animate_a_p_i__1.md) | Defines a struct for the animation APIs of ArkUI on the native side. | 47| struct [ArkUI_NativeDialogAPI_1](_ark_u_i___native_dialog_a_p_i__1.md) | Defines a struct for the custom dialog box APIs on the native side. | 48| struct [ArkUI_NativeGestureAPI_1](_ark_u_i___native_gesture_a_p_i__1.md) | Defines a struct for the gesture APIs. | 49| struct [ArkUI_NativeGestureAPI_2](_ark_u_i___native_gesture_a_p_i__2.md) | Defines a new struct for the gesture APIs.| 50| struct [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) | Defines the general input parameter structure of the **setAttribute** function. | 51| struct [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) | Defines a struct for the parameter type of the component callback event. | 52| struct [ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md) | Defines the string type parameter used by the component callback event. | 53| struct [ArkUI_NativeNodeAPI_1](_ark_u_i___native_node_a_p_i__1.md) | Defines a struct for node APIs of ArkUI on the native side. | 54| struct [ArkUI_ContextCallback](_ark_u_i___context_callback.md) | Defines event callback. | 55| union [ArkUI_NumberValue](union_ark_u_i___number_value.md) | Provides the number types of ArkUI in the native code. | 56| struct [ARKUI_TextPickerRangeContent](_a_r_k_u_i___text_picker_range_content.md) | Defines the input structure of the single-column text picker with image resources. | 57| struct [ARKUI_TextPickerCascadeRangeContent](_a_r_k_u_i___text_picker_cascade_range_content.md) | Defines the input structure of the interconnected multi-column text picker. | 58| struct [ArkUI_ColorStop](_ark_u_i___color_stop.md) | Defines a gradient color stop. | 59| struct [ArkUI_Rect](_ark_u_i___rect.md) | Defines a mask area. | 60| struct [ArkUI_IntSize](_ark_u_i___int_size.md) | Describes the width and height of a component. | 61| struct [ArkUI_IntOffset](_ark_u_i___int_offset.md) | Describes the position of a component. | 62| struct [ArkUI_Margin](_ark_u_i___margin.md) | Describes the margins of a component. | 63| struct [ArkUI_TranslationOptions](_ark_u_i___translation_options.md) | Defines the translation options for component transition. | 64| struct [ArkUI_ScaleOptions](_ark_u_i___scale_options.md) | Defines the scaling options for component transition. | 65| struct [ArkUI_RotationOptions](_ark_u_i___rotation_options.md) | Defines the rotation options for component transition. | 66 67 68### Macros 69 70| Name| Description| 71| -------- | -------- | 72| [OH_ArkUI_GetModuleInterface](#oh_arkui_getmoduleinterface)(nativeAPIVariantKind, structType, structPtr) | Obtains the macro function corresponding to a struct pointer based on the struct type. | 73| **MAX_NODE_SCOPE_NUM** | 1000 | 74| **MAX_COMPONENT_EVENT_ARG_NUM** | 12 | 75| **UDMF_KEY_BUFFER_LEN** | 512 | 76 77 78### Types 79 80| Name| Description| 81| -------- | -------- | 82| typedef struct [ArkUI_NodeEvent](#arkui_nodeevent-12) [ArkUI_NodeEvent](#arkui_nodeevent-12) | Defines a struct for a component event. | 83| typedef struct [ArkUI_Context](#arkui_context) [ArkUI_Context](#arkui_context) | Defines a struct for a UI context object. | 84| typedef struct [ArkUI_Context](#arkui_context) \* [ArkUI_ContextHandle](#arkui_contexthandle-12) | Defines a struct for the handle to the ArkUI native UI context. | 85| typedef struct [ArkUI_DragEvent](#arkui_dragevent) [ArkUI_DragEvent](#arkui_dragevent) | Defines a struct for a drag event. | 86| typedef struct [ArkUI_DragPreviewOption](#arkui_dragpreviewoption) [ArkUI_DragPreviewOption](#arkui_dragpreviewoption) | Defines a struct for custom drag preview options. | 87| typedef struct [ArkUI_DragAction](#arkui_dragaction) [ArkUI_DragAction](#arkui_dragaction) | Defines a struct for a drag action. | 88| typedef struct [ArkUI_DragAndDropInfo](#arkui_draganddropinfo) [ArkUI_DragAndDropInfo](#arkui_draganddropinfo) | Defines a struct for drag and drop information returned through a drag status listener. | 89| typedef struct [OH_UdmfData](#oh_udmfdata) [OH_UdmfData](#oh_udmfdata) | Defines a struct for UDMF unified data. | 90| typedef struct [OH_PixelmapNative](#oh_pixelmapnative) [OH_PixelmapNative](#oh_pixelmapnative) | Defines the **Pixelmap** struct, which is used to perform operations related to a pixel map. | 91| typedef struct [ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) [ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) | Defines a struct for the **DrawableDescriptor** object. | 92| typedef struct [OH_PixelmapNative](#oh_pixelmapnative) \* [OH_PixelmapNativeHandle](#oh_pixelmapnativehandle) | Defines a struct for the pointer to an **OH_PixelmapNative** object. | 93| typedef struct [ArkUI_AnimateOption](#arkui_animateoption) [ArkUI_AnimateOption](#arkui_animateoption) | Defines a struct for the animation configuration. | 94| typedef struct ArkUI_Curve \* [ArkUI_CurveHandle](#arkui_curvehandle) | Defines a struct for the pointer to an interpolation curve. | 95| typedef struct [ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) [ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) | Defines a struct for the keyframe animation parameter object. | 96| typedef struct [ArkUI_AnimatorOption](#arkui_animatoroption) [ArkUI_AnimatorOption](#arkui_animatoroption) | Defines the animator parameter object. | 97| typedef struct ArkUI_Animator \* [ArkUI_AnimatorHandle](#arkui_animatorhandle) | Defines a struct for the pointer to an animator object. | 98| typedef struct [ArkUI_TransitionEffect](#arkui_transitioneffect) [ArkUI_TransitionEffect](#arkui_transitioneffect) | Defines a struct for the transition effect. | 99| typedef bool(\* [ArkUI_OnWillDismissEvent](#arkui_onwilldismissevent)) (int32_t reason) | Defines a pointer to the callback invoked when the dialog box is closed. | 100| typedef struct [ArkUI_DialogDismissEvent](#arkui_dialogdismissevent) [ArkUI_DialogDismissEvent](#arkui_dialogdismissevent) | Defines a struct for a dialog box dismiss event. | 101| typedef struct [ArkUI_CustomDialogOptions ](#arkui_customdialogoptions) [ArkUI_CustomDialogOptions ](#arkui_customdialogoptions) | Defines a struct for custom dialog box options. | 102| typedef uint32_t [ArkUI_GestureEventActionTypeMask](#arkui_gestureeventactiontypemask) | Defines a set of gesture event types. | 103| typedef uint32_t [ArkUI_GestureDirectionMask](#arkui_gesturedirectionmask) | Defines a set of gesture directions. | 104| typedef ArkUI_GestureRecognizer \* [ArkUI_GestureRecognizerHandle](#arkui_gesturerecognizerhandle) | Defines the gesture recognizer handle. | 105| typedef [ArkUI_GestureRecognizerHandle](#arkui_gesturerecognizerhandle) \* [ArkUI_GestureRecognizerHandleArray](#arkui_gesturerecognizerhandlearray) | Defines the gesture recognizer handle array. | 106| typedef ArkUI_TouchRecognizer \* [ArkUI_TouchRecognizerHandle](#arkui_touchrecognizerhandle) | Defines a gesture recognizer handle. | 107| typedef [ArkUI_TouchRecognizerHandle](#arkui_touchrecognizerhandle) \* [ArkUI_TouchRecognizerHandleArray](#arkui_touchrecognizerhandlearray) | Defines an array of gesture recognizer handles. | 108| typedef struct [ArkUI_GestureEventTargetInfo](#arkui_gestureeventtargetinfo) [ArkUI_GestureEventTargetInfo](#arkui_gestureeventtargetinfo) | Defines a struct for a **GestureEventTargetInfo** object that provides information about a gesture event target. | 109| typedef struct [ArkUI_ParallelInnerGestureEvent](#arkui_parallelinnergestureevent) [ArkUI_ParallelInnerGestureEvent](#arkui_parallelinnergestureevent) | Defines a parallel internal gesture event. | 110| typedef void(\* [ArkUI_GestureRecognizerDestructNotifyCallback](#arkui_gesturerecognizerdestructnotifycallback)) (ArkUI_GestureRecognizer \*recognizer, void \*userData) | Defines a callback function for notifying gesture recognizer destruction. | 111| typedef struct [ArkUI_NodeEvent](#arkui_nodeevent-12) [ArkUI_NodeEvent](#arkui_nodeevent-12) | Defines the common structure of a component event. | 112| typedef struct [ArkUI_NodeCustomEvent](#arkui_nodecustomevent) [ArkUI_NodeCustomEvent](#arkui_nodecustomevent) | Defines the common structure of a custom component event. | 113| typedef struct ArkUI_NodeAdapter \* [ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) | Defines the component adapter, which is used for lazy loading of elements of scrollable components. | 114| typedef struct [ArkUI_NodeAdapterEvent](#arkui_nodeadapterevent) [ArkUI_NodeAdapterEvent](#arkui_nodeadapterevent) | Defines the component adapter event. | 115| typedef struct [ArkUI_NodeContentEvent](#arkui_nodecontentevent) [ArkUI_NodeContentEvent](#arkui_nodecontentevent) | Defines the common structure type of a NodeContent event. | 116| typedef void(\* [ArkUI_NodeContentCallback](#arkui_nodecontentcallback)) ([ArkUI_NodeContentEvent](#arkui_nodecontentevent) \*event) | Defines the callback for the NodeContent event. | 117| typedef struct [ArkUI_LayoutConstraint](#arkui_layoutconstraint) [ArkUI_LayoutConstraint](#arkui_layoutconstraint) | Defines the size constraints of a component during component layout. | 118| typedef struct [ArkUI_DrawContext](#arkui_drawcontext) [ArkUI_DrawContext](#arkui_drawcontext) | Defines the component drawing context. | 119| typedef struct ArkUI_Node \* [ArkUI_NodeHandle](#arkui_nodehandle) | Defines the pointer to the ArkUI native component object. | 120| typedef struct ArkUI_NativeDialog \* [ArkUI_NativeDialogHandle](#arkui_nativedialoghandle) | Defines the handle to the custom dialog box controller of ArkUI on the native side. | 121| typedef struct [ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) [ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) | Defines the water flow section configuration. | 122| typedef struct [ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) [ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) | Defines the item configuration for **ListItemSwipeActionOption**. | 123| typedef struct [ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption) [ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption) | Defines the configuration for **ListItemSwipeActionOption**. | 124| typedef struct [ArkUI_Context](#arkui_context) \* [ArkUI_ContextHandle](#arkui_contexthandle-12) | Defines the handle to the ArkUI native UI context. | 125| typedef struct ArkUI_NodeContent \* [ArkUI_NodeContentHandle](#arkui_nodecontenthandle) | Defines the handle to the ArkUI NodeContent instance on the native side. | 126| typedef struct [ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) [ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) | Defines the alignment rule in the relative container. | 127| typedef struct [ArkUI_GuidelineOption](#arkui_guidelineoption) [ArkUI_GuidelineOption](#arkui_guidelineoption) | Defines the ID, direction, and position of a guideline. | 128| typedef struct [ArkUI_BarrierOption](#arkui_barrieroption) [ArkUI_BarrierOption](#arkui_barrieroption) | Defines the ID, direction, and referenced component of a barrier. | 129| typedef struct [ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) [ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) | Defines the image frame information. | 130| typedef struct [ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) [ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) | Defines the **ChildrenMainSize** information of the **List** component. | 131| typedef struct [ArkUI_AccessibilityState](#arkui_accessibilitystate) [ArkUI_AccessibilityState](#arkui_accessibilitystate) | Defines a struct for the component accessibility state. | 132| typedef struct [ArkUI_AccessibilityValue](#arkui_accessibilityvalue) [ArkUI_AccessibilityValue](#arkui_accessibilityvalue) | Defines a struct for the component accessibility value. | 133| typedef struct [ArkUI_SystemFontStyleEvent](#arkui_systemfontstyleevent) [ArkUI_SystemFontStyleEvent](#arkui_systemfontstyleevent) | Defines a struct for the system font style event. | 134| typedef struct [ArkUI_CustomSpanMeasureInfo](#arkui_customspanmeasureinfo) [ArkUI_CustomSpanMeasureInfo](#arkui_customspanmeasureinfo) | Defines a struct for the measurement information of a custom span. | 135| typedef struct [ArkUI_CustomSpanMetrics](#arkui_customspanmetrics) [ArkUI_CustomSpanMetrics](#arkui_customspanmetrics) | Defines a struct for the measurement metrics of a custom span. | 136| typedef struct [ArkUI_CustomSpanDrawInfo](#arkui_customspandrawinfo) [ArkUI_CustomSpanDrawInfo](#arkui_customspandrawinfo) | Defines a struct for the drawing information of a custom span. | 137| typedef struct [ArkUI_SwiperIndicator](#arkui_swiperindicator) [ArkUI_SwiperIndicator](#arkui_swiperindicator) | Defines the navigation indicator style of the **Swiper** component. | 138| typedef struct [ArkUI_StyledString_Descriptor](#arkui_styledstring_descriptor) [ArkUI_StyledString_Descriptor](#arkui_styledstring_descriptor) | Defines a struct for the styled string descriptor object supported by the text component. | 139| typedef struct [ArkUI_StyledString](#arkui_styledstring) [ArkUI_StyledString](#arkui_styledstring) | Defines a struct for the styled string object supported by the text component. | 140| typedef struct [OH_UdmfGetDataParams](#oh_udmfgetdataparams) [OH_UdmfGetDataParams](#oh_udmfgetdataparams) | Defines a struct for parameters used for obtaining data from UDMF. | 141| typedef struct [ArkUI_ProgressLinearStyleOption](#arkui_progresslinearstyleoption) [ArkUI_ProgressLinearStyleOption](#arkui_progresslinearstyleoption) | Defines the style object for a linear progress indicator.| 142| typedef struct [ArkUI_VisibleAreaEventOptions](#arkui_visibleareaeventoptions) [ArkUI_VisibleAreaEventOptions](#arkui_visibleareaeventoptions) | Defines a struct for visible area change event parameters. | 143 144 145### Enums 146 147| Name| Description| 148| -------- | -------- | 149| [ArkUI_DragResult](#arkui_dragresult) { ARKUI_DRAG_RESULT_SUCCESSFUL = 0, ARKUI_DRAG_RESULT_FAILED, ARKUI_DRAG_RESULT_CANCELED } | Defines an enum for drag results, which are set by the data receiver and transferred by the system to the drag source so that the drag source is aware of the data processing result of the receiver. | 150| [ArkUI_DropOperation](#arkui_dropoperation) { ARKUI_DROP_OPERATION_COPY = 0, ARKUI_DROP_OPERATION_MOVE } | Defines an enum for data processing modes used when data is dropped, which affects the display of the badge. | 151| [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>} | Defines an enum for interaction states prior to a drop and drop operation. | 152| [ArkUI_DragPreviewScaleMode](#arkui_dragpreviewscalemode) { ARKUI_DRAG_PREVIEW_SCALE_AUTO = 0, ARKUI_DRAG_PREVIEW_SCALE_DISABLED } | Defines an enum for drag preview scale modes. | 153| [ArkUI_DragStatus](#arkui_dragstatus) { ARKUI_DRAG_STATUS_UNKNOWN = -1, ARKUI_DRAG_STATUS_STARTED, ARKUI_DRAG_STATUS_ENDED } | Enumerates dragging states. | 154| [ArkUI_DismissReason](#arkui_dismissreason) { DIALOG_DISMISS_BACK_PRESS = 0, DIALOG_DISMISS_TOUCH_OUTSIDE, DIALOG_DISMISS_CLOSE_BUTTON, DIALOG_DISMISS_SLIDE_DOWN } | Enumerates the actions for triggering closure of the dialog box. | 155| [ArkUI_LevelMode](#arkui_levelmode) { ARKUI_LEVEL_MODE_OVERLAY = 0, ARKUI_LEVEL_MODE_EMBEDDED } | Enumerates the display levels of the dialog box. | 156| [ArkUI_ImmersiveMode](#arkui_immersivemode) { ARKUI_IMMERSIVE_MODE_DEFAULT = 0, ARKUI_IMMERSIVE_MODE_EXTEND } | Enumerates the display areas of the embedded dialog box overlay. | 157| [ArkUI_GestureEventActionType](#arkui_gestureeventactiontype) { GESTURE_EVENT_ACTION_ACCEPT = 0x01, GESTURE_EVENT_ACTION_UPDATE = 0x02, GESTURE_EVENT_ACTION_END = 0x04, GESTURE_EVENT_ACTION_CANCEL = 0x08 } | Enumerates gesture event types. | 158| [ArkUI_GesturePriority](#arkui_gesturepriority) { NORMAL = 0, PRIORITY = 1, PARALLEL = 2 } | Enumerates gesture event modes. | 159| [ArkUI_GroupGestureMode](#arkui_groupgesturemode) { SEQUENTIAL_GROUP = 0, PARALLEL_GROUP = 1, EXCLUSIVE_GROUP = 2 } | Enumerates gesture group modes. | 160| [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>} | Enumerates gesture directions. | 161| [ArkUI_GestureMask](#arkui_gesturemask) { NORMAL_GESTURE_MASK = 0, IGNORE_INTERNAL_GESTURE_MASK } | Enumerates gesture masking modes. | 162| [ArkUI_GestureRecognizerType](#arkui_gesturerecognizertype) {<br>TAP_GESTURE = 0, LONG_PRESS_GESTURE, PAN_GESTURE, PINCH_GESTURE,<br>ROTATION_GESTURE, SWIPE_GESTURE, GROUP_GESTURE<br>} | Enumerates gesture recognizer types. | 163| [ArkUI_GestureInterruptResult](#arkui_gestureinterruptresult) { GESTURE_INTERRUPT_RESULT_CONTINUE = 0, GESTURE_INTERRUPT_RESULT_REJECT } | Enumerates gesture interruption results. | 164| [ArkUI_GestureRecognizerState](#arkui_gesturerecognizerstate) {<br>ARKUI_GESTURE_RECOGNIZER_STATE_REDAY = 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>} | Enumerates the gesture recognizer states. | 165| [ArkUI_NativeAPIVariantKind](#arkui_nativeapivariantkind) { ARKUI_NATIVE_NODE, ARKUI_NATIVE_DIALOG, ARKUI_NATIVE_GESTURE, ARKUI_NATIVE_ANIMATE } | Defines the native API types. | 166| [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>} | Enumerates the key codes for key events. | 167| [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>} | Enumerates the types of key events. | 168| [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 } | Enumerates the types of input devices that trigger key events. | 169| [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>} | Enumerates the intentions corresponding to key events. | 170| [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>} | Enumerates ArkUI component types that can be created on the native side. | 171| [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_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_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_CALENDAR_PICKER_DISABLED_DATE_RANGE = 16006, NODE_CALENDAR_PICKER_MARK_TODAY = 16007,<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_CONTENT_START_OFFSET, 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,<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>} | Defines the ArkUI style attributes that can be set on the native side. | 172| [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_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_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>} | Enumerates the event types supported by the NativeNode component. | 173| [ArkUI_NodeDirtyFlag](#arkui_nodedirtyflag) { NODE_NEED_MEASURE = 1, NODE_NEED_LAYOUT, NODE_NEED_RENDER } | Enumerates the dirty area flags passed in the **::markDirty** API. | 174| [ArkUI_NodeCustomEventType](#arkui_nodecustomeventtype) {<br>ARKUI_NODE_CUSTOM_EVENT_ON_MEASURE = 1 << 0, ARKUI_NODE_CUSTOM_EVENT_ON_LAYOUT = 1 << 1, ARKUI_NODE_CUSTOM_EVENT_ON_DRAW = 1 << 2, ARKUI_NODE_CUSTOM_EVENT_ON_FOREGROUND_DRAW = 1 << 3,<br>ARKUI_NODE_CUSTOM_EVENT_ON_OVERLAY_DRAW = 1 << 4<br>} | Enumerates the custom component event types. | 175| [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>} | Enumerates node adapter events. | 176| [ArkUI_NodeContentEventType](#arkui_nodecontenteventtype) { NODE_CONTENT_EVENT_ON_ATTACH_TO_WINDOW = 0, NODE_CONTENT_EVENT_ON_DETACH_FROM_WINDOW = 1 } | Defines the NodeContent event type. | 177| [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>} | Enumerates the alignment modes. | 178| [ArkUI_ImageRepeat](#arkui_imagerepeat) { ARKUI_IMAGE_REPEAT_NONE = 0, ARKUI_IMAGE_REPEAT_X, ARKUI_IMAGE_REPEAT_Y, ARKUI_IMAGE_REPEAT_XY } | Enumerates the image repeat patterns. | 179| [ArkUI_FontStyle](#arkui_fontstyle) { ARKUI_FONT_STYLE_NORMAL = 0, ARKUI_FONT_STYLE_ITALIC } | Enumerates the font styles. | 180| [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>} | Enumerates the font weights. | 181| [ArkUI_TextAlignment](#arkui_textalignment) { ARKUI_TEXT_ALIGNMENT_START = 0, ARKUI_TEXT_ALIGNMENT_CENTER, ARKUI_TEXT_ALIGNMENT_END, ARKUI_TEXT_ALIGNMENT_JUSTIFY } | Enumerates the text alignment mode. | 182| [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>} | Enumerates the types of the Enter key for a single-line text box. | 183| [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>} | Enumerates the text input types. | 184| [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 } | Enumerates the text box types. | 185| [ArkUI_CancelButtonStyle](#arkui_cancelbuttonstyle) { ARKUI_CANCELBUTTON_STYLE_CONSTANT = 0, ARKUI_CANCELBUTTON_STYLE_INVISIBLE, ARKUI_CANCELBUTTON_STYLE_INPUT } | Enumerates the styles of the Cancel button. | 186| [ArkUI_XComponentType](#arkui_xcomponenttype) { ARKUI_XCOMPONENT_TYPE_SURFACE = 0, ARKUI_XCOMPONENT_TYPE_TEXTURE = 2 } | Defines the enumerated values of the XComponent type. | 187| [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>} | Enumerates the styles of the progress indicator. | 188| [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 } | Enumerates the text decoration types. | 189| [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>} | Enumerates the text decoration styles. | 190| [ArkUI_TextCase](#arkui_textcase) { ARKUI_TEXT_CASE_NORMAL = 0, ARKUI_TEXT_CASE_LOWER, ARKUI_TEXT_CASE_UPPER } | Defines the enumerated values of text case. | 191| [ArkUI_CopyOptions](#arkui_copyoptions) { ARKUI_COPY_OPTIONS_NONE = 0, ARKUI_COPY_OPTIONS_IN_APP, ARKUI_COPY_OPTIONS_LOCAL_DEVICE, ARKUI_COPY_OPTIONS_CROSS_DEVICE } | Enumerates the text copy and paste modes. | 192| [ArkUI_ShadowType](#arkui_shadowtype) { ARKUI_SHADOW_TYPE_COLOR = 0, ARKUI_SHADOW_TYPE_BLUR } | Defines the enumerated values of the shadow type. | 193| [ArkUI_TextPickerRangeType](#arkui_textpickerrangetype) { ARKUI_TEXTPICKER_RANGETYPE_SINGLE = 0, ARKUI_TEXTPICKER_RANGETYPE_MULTI, ARKUI_TEXTPICKER_RANGETYPE_RANGE_CONTENT, ARKUI_TEXTPICKER_RANGETYPE_CASCADE_RANGE_CONTENT } | Enumerates the types of the text picker. | 194| [ArkUI_AccessibilityCheckedState](#arkui_accessibilitycheckedstate) { ARKUI_ACCESSIBILITY_UNCHECKED = 0, ARKUI_ACCESSIBILITY_CHECKED } | Enumerates the accessibility check box states. | 195| [ArkUI_AccessibilityActionType](#arkui_accessibilityactiontype) {<br>ARKUI_ACCESSIBILITY_ACTION_CLICK = 1 << 0, ARKUI_ACCESSIBILITY_ACTION_LONG_CLICK = 1 << 1, ARKUI_ACCESSIBILITY_ACTION_CUT = 1 << 2, ARKUI_ACCESSIBILITY_ACTION_COPY = 1 << 3,<br>ARKUI_ACCESSIBILITY_ACTION_PASTE = 1 << 4<br>} | Defines an enum for the accessibility action types. | 196| [ArkUI_EdgeEffect](#arkui_edgeeffect) { ARKUI_EDGE_EFFECT_SPRING = 0, ARKUI_EDGE_EFFECT_FADE, ARKUI_EDGE_EFFECT_NONE } | Enumerates the effects used at the edges of the component when the boundary of the scrollable content is reached. | 197| [ArkUI_EffectEdge](#arkui_effectedge) { ARKUI_EFFECT_EDGE_START = 1, ARKUI_EFFECT_EDGE_END = 2 } | Enumerates the edges for which the effect takes effect when the boundary of the scrollable content is reached. | 198| [ArkUI_ScrollDirection](#arkui_scrolldirection) { ARKUI_SCROLL_DIRECTION_VERTICAL = 0, ARKUI_SCROLL_DIRECTION_HORIZONTAL, ARKUI_SCROLL_DIRECTION_NONE = 3 } | Enumerates the scroll directions of scrollable components. | 199| [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 } | Enumerates the alignment modes of list items when scrolling ends. | 200| [ArkUI_ScrollBarDisplayMode](#arkui_scrollbardisplaymode) { ARKUI_SCROLL_BAR_DISPLAY_MODE_OFF = 0, ARKUI_SCROLL_BAR_DISPLAY_MODE_AUTO, ARKUI_SCROLL_BAR_DISPLAY_MODE_ON } | Enumerates the scrollbar display modes. | 201| [ArkUI_Axis](#arkui_axis) { ARKUI_AXIS_VERTICAL = 0, ARKUI_AXIS_HORIZONTAL } | Enumerates the scroll directions. | 202| [ArkUI_StickyStyle](#arkui_stickystyle) { ARKUI_STICKY_STYLE_NONE = 0, ARKUI_STICKY_STYLE_HEADER = 1, ARKUI_STICKY_STYLE_FOOTER = 2, ARKUI_STICKY_STYLE_BOTH = 3 } | Enumerates the modes for pinning the header to the top or the footer to the bottom. | 203| [ArkUI_BorderStyle](#arkui_borderstyle) { ARKUI_BORDER_STYLE_SOLID = 0, ARKUI_BORDER_STYLE_DASHED, ARKUI_BORDER_STYLE_DOTTED } | Enumerates the border styles. | 204| [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 } | Enumerates the hit test modes. | 205| [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>} | Enumerated value of the shadow effect. | 206| [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>} | Enumerates the animation curves. | 207| [ArkUI_SwiperArrow](#arkui_swiperarrow) { ARKUI_SWIPER_ARROW_HIDE = 0, ARKUI_SWIPER_ARROW_SHOW, ARKUI_SWIPER_ARROW_SHOW_ON_HOVER } | Enumerates arrow styles of the navigation indicator. | 208| [ArkUI_SwiperNestedScrollMode](#arkui_swipernestedscrollmode) { ARKUI_SWIPER_NESTED_SRCOLL_SELF_ONLY = 0, ARKUI_SWIPER_NESTED_SRCOLL_SELF_FIRST } | Enumerates the nested scrolling mode of the **Swiper** component and its parent container. | 209| [ArkUI_PageFlipMode](#arkui_pageflipmode) { ARKUI_PAGE_FLIP_MODE_CONTINUOUS = 0, ARKUI_PAGE_FLIP_MODE_SINGLE } | Enumerates the page flipping modes using the mouse wheel for the <b>Swiper</b> component. | 210| [ArkUI_SwiperAnimationMode](#arkui_swiperanimationmode) { ARKUI_SWIPER_NO_ANIMATION = 0, ARKUI_SWIPER_DEFAULT_ANIMATION, ARKUI_SWIPER_FAST_ANIMATION } | Enumerates the animation modes for the **Swiper** component when jumping to the page with the specified index. | 211| [ArkUI_AccessibilityMode](#arkui_accessibilitymode) { ARKUI_ACCESSIBILITY_MODE_AUTO = 0, ARKUI_ACCESSIBILITY_MODE_ENABLED, ARKUI_ACCESSIBILITY_MODE_DISABLED, ARKUI_ACCESSIBILITY_MODE_DISABLED_FOR_DESCENDANTS } | Enumerates the accessibility modes. | 212| [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 } | Enumerates copy options, which define whether copy and paste is allowed for text content. | 213| [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 } | Defines how the adaptive height is determined for the text. | 214| [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 } | Enumerates nested scrolling options. | 215| [ArkUI_ScrollEdge](#arkui_scrolledge) { ARKUI_SCROLL_EDGE_TOP = 0, ARKUI_SCROLL_EDGE_BOTTOM, ARKUI_SCROLL_EDGE_START, ARKUI_SCROLL_EDGE_END } | Defines the edge to which the component scrolls. | 216| [ArkUI_ScrollAlignment](#arkui_scrollalignment) { ARKUI_SCROLL_ALIGNMENT_START = 0, ARKUI_SCROLL_ALIGNMENT_CENTER, ARKUI_SCROLL_ALIGNMENT_END, ARKUI_SCROLL_ALIGNMENT_AUTO } | Defines how the list item to scroll to is aligned with the container. | 217| [ArkUI_ScrollState](#arkui_scrollstate) { ARKUI_SCROLL_STATE_IDLE = 0, ARKUI_SCROLL_STATE_SCROLL, ARKUI_SCROLL_STATE_FLING } | Enumerates the scrolling states. | 218| [ArkUI_SliderBlockStyle](#arkui_sliderblockstyle) { ARKUI_SLIDER_BLOCK_STYLE_DEFAULT = 0, ARKUI_SLIDER_BLOCK_STYLE_IMAGE, ARKUI_SLIDER_BLOCK_STYLE_SHAPE } | Enumerates the styles of the slider in the block direction. | 219| [ArkUI_SliderDirection](#arkui_sliderdirection) { ARKUI_SLIDER_DIRECTION_VERTICAL = 0, ARKUI_SLIDER_DIRECTION_HORIZONTAL } | Enumerates the scroll directions of the slider. | 220| [ArkUI_SliderStyle](#arkui_sliderstyle) { ARKUI_SLIDER_STYLE_OUT_SET = 0, ARKUI_SLIDER_STYLE_IN_SET, ARKUI_SLIDER_STYLE_NONE } | Enumerates the slider styles. | 221| [ArkUI_CheckboxShape](#arkui_checkboxshape) { ArkUI_CHECKBOX_SHAPE_CIRCLE = 0, ArkUI_CHECKBOX_SHAPE_ROUNDED_SQUARE } | Enumerates the shapes of the check box. | 222| [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 } | Enumerates the animation playback modes. | 223| [ArkUI_ImageSize](#arkui_imagesize) { ARKUI_IMAGE_SIZE_AUTO = 0, ARKUI_IMAGE_SIZE_COVER, ARKUI_IMAGE_SIZE_CONTAIN } | Defines the image size. | 224| [ArkUI_AdaptiveColor](#arkui_adaptivecolor) { ARKUI_ADAPTIVE_COLOR_DEFAULT = 0, ARKUI_ADAPTIVE_COLOR_AVERAGE } | Enumerates the adaptive color modes. | 225| [ArkUI_ColorMode](#arkui_colormode) { ARKUI_COLOR_MODE_SYSTEM = 0, ARKUI_COLOR_MODE_LIGHT, ARKUI_COLOR_MODE_DARK } | Enumerates the color modes. | 226| [ArkUI_SystemColorMode](#arkui_systemcolormode) { ARKUI_SYSTEM_COLOR_MODE_LIGHT = 0, ARKUI_SYSTEM_COLOR_MODE_DARK } | Enumerates the system color modes. | 227| [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>} | Enumerates the blur styles. | 228| [ArkUI_VerticalAlignment](#arkui_verticalalignment) { ARKUI_VERTICAL_ALIGNMENT_TOP = 0, ARKUI_VERTICAL_ALIGNMENT_CENTER, ARKUI_VERTICAL_ALIGNMENT_BOTTOM } | Enumerates the vertical alignment modes. | 229| [ArkUI_HorizontalAlignment](#arkui_horizontalalignment) { ARKUI_HORIZONTAL_ALIGNMENT_START = 0, ARKUI_HORIZONTAL_ALIGNMENT_CENTER, ARKUI_HORIZONTAL_ALIGNMENT_END } | Enumerates the alignment mode in the horizontal direction. | 230| [ArkUI_TextOverflow](#arkui_textoverflow) { ARKUI_TEXT_OVERFLOW_NONE = 0, ARKUI_TEXT_OVERFLOW_CLIP, ARKUI_TEXT_OVERFLOW_ELLIPSIS, ARKUI_TEXT_OVERFLOW_MARQUEE } | Enumerates the display modes when the text is too long. | 231| [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 } | Enumerates the alignment mode of the image with the text. | 232| [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>} | Enumerates the image filling effects. ImageSpanAlignment | 233| [ArkUI_ImageInterpolation](#arkui_imageinterpolation) { ARKUI_IMAGE_INTERPOLATION_NONE = 0, ARKUI_IMAGE_INTERPOLATION_LOW, ARKUI_IMAGE_INTERPOLATION_MEDIUM, ARKUI_IMAGE_INTERPOLATION_HIGH } | Enumerates the image interpolation effects. | 234| [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>} | Enumerates the blend modes. | 235| [ArkUI_Direction](#arkui_direction) { ARKUI_DIRECTION_LTR = 0, ARKUI_DIRECTION_RTL, ARKUI_DIRECTION_AUTO = 3 } | Enumerates the modes in which components are laid out along the main axis of the container. | 236| [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>} | Enumerates the modes in which components are laid out along the cross axis of the container. | 237| [ArkUI_ColorStrategy](#arkui_colorstrategy) { ARKUI_COLOR_STRATEGY_INVERT = 0, ARKUI_COLOR_STRATEGY_AVERAGE, ARKUI_COLOR_STRATEGY_PRIMARY } | Enumerates the foreground colors. | 238| [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>} | Enumerates the vertical alignment modes. | 239| [ArkUI_FlexDirection](#arkui_flexdirection) { ARKUI_FLEX_DIRECTION_ROW = 0, ARKUI_FLEX_DIRECTION_COLUMN, ARKUI_FLEX_DIRECTION_ROW_REVERSE, ARKUI_FLEX_DIRECTION_COLUMN_REVERSE } | Enumerates the directions of the main axis in the flex container. | 240| [ArkUI_FlexWrap](#arkui_flexwrap) { ARKUI_FLEX_WRAP_NO_WRAP = 0, ARKUI_FLEX_WRAP_WRAP, ARKUI_FLEX_WRAP_WRAP_REVERSE } | Defines whether the flex container has a single line or multiple lines. | 241| [ArkUI_Visibility](#arkui_visibility) { ARKUI_VISIBILITY_VISIBLE = 0, ARKUI_VISIBILITY_HIDDEN, ARKUI_VISIBILITY_NONE } | Enumerates the visibility values. | 242| [ArkUI_CalendarAlignment](#arkui_calendaralignment) { ARKUI_CALENDAR_ALIGNMENT_START = 0, ARKUI_CALENDAR_ALIGNMENT_CENTER, ARKUI_CALENDAR_ALIGNMENT_END } | Enumerates the alignment modes between the calendar picker and the entry component. | 243| [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>} | Enumerates the mask types. | 244| [ArkUI_ClipType](#arkui_cliptype) { ARKUI_CLIP_TYPE_RECTANGLE = 0, ARKUI_CLIP_TYPE_CIRCLE, ARKUI_CLIP_TYPE_ELLIPSE, ARKUI_CLIP_TYPE_PATH } | Enumerates the clipping region types. | 245| [ArkUI_ShapeType](#arkui_shapetype) { ARKUI_SHAPE_TYPE_RECTANGLE = 0, ARKUI_SHAPE_TYPE_CIRCLE, ARKUI_SHAPE_TYPE_ELLIPSE, ARKUI_SHAPE_TYPE_PATH } | Enumerates custom shape types. | 246| [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>} | Enumerates the gradient directions. | 247| [ArkUI_WordBreak](#arkui_wordbreak) { ARKUI_WORD_BREAK_NORMAL = 0, ARKUI_WORD_BREAK_BREAK_ALL, ARKUI_WORD_BREAK_BREAK_WORD, ARKUI_WORD_BREAK_HYPHENATION } | Enumerates the word break rules. | 248| [ArkUI_EllipsisMode](#arkui_ellipsismode) { ARKUI_ELLIPSIS_MODE_START = 0, ARKUI_ELLIPSIS_MODE_CENTER, ARKUI_ELLIPSIS_MODE_END } | Enumerates the ellipsis positions. | 249| [ArkUI_ImageRenderMode](#arkui_imagerendermode) { ARKUI_IMAGE_RENDER_MODE_ORIGINAL = 0, ARKUI_IMAGE_RENDER_MODE_TEMPLATE } | Enumerates the image rendering modes. | 250| [ArkUI_TransitionEdge](#arkui_transitionedge) { ARKUI_TRANSITION_EDGE_TOP = 0, ARKUI_TRANSITION_EDGE_BOTTOM, ARKUI_TRANSITION_EDGE_START, ARKUI_TRANSITION_EDGE_END } | Enumerates the slide-in and slide-out positions of the component from the screen edge during transition. | 251| [ArkUI_FinishCallbackType](#arkui_finishcallbacktype) { ARKUI_FINISH_CALLBACK_REMOVED = 0, ARKUI_FINISH_CALLBACK_LOGICALLY } | Enumerates the animation **onFinish** callback types. | 252| [ArkUI_ListItemAlignment](#arkui_listitemalignment) { ARKUI_LIST_ITEM_ALIGNMENT_START = 0, ARKUI_LIST_ITEM_ALIGNMENT_CENTER, ARKUI_LIST_ITEM_ALIGNMENT_END } | Enumerates the alignment modes of items along the cross axis. | 253| [ArkUI_BlendApplyType](#arkui_blendapplytype) { BLEND_APPLY_TYPE_FAST = 0, BLEND_APPLY_TYPE_OFFSCREEN } | Defines how the specified blend mode is applied. | 254| [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 } | Enumerates the component units. | 255| [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>} | Enumerates the autofill types. | 256| [ArkUI_BarrierDirection](#arkui_barrierdirection) { ARKUI_BARRIER_DIRECTION_START = 0, ARKUI_BARRIER_DIRECTION_END, ARKUI_BARRIER_DIRECTION_TOP, ARKUI_BARRIER_DIRECTION_BOTTOM } | Enumerates the barrier directions. | 257| [ArkUI_RelativeLayoutChainStyle](#arkui_relativelayoutchainstyle) { ARKUI_RELATIVE_LAYOUT_CHAIN_STYLE_SPREAD = 0, ARKUI_RELATIVE_LAYOUT_CHAIN_STYLE_SPREAD_INSIDE, ARKUI_RELATIVE_LAYOUT_CHAIN_STYLE_PACKED } | Enumerates the chain styles. | 258| [ArkUI_TextInputStyle](#arkui_textinputstyle) { ARKUI_TEXTINPUT_STYLE_DEFAULT = 0, ARKUI_TEXTINPUT_STYLE_INLINE } | Enumerates the text input styles. | 259| [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 } | Enumerates the entity types of text recognition. | 260| [ArkUI_ButtonType](#arkui_buttontype) { ARKUI_BUTTON_TYPE_NORMAL = 0, ARKUI_BUTTON_TYPE_CAPSULE, ARKUI_BUTTON_TYPE_CIRCLE } | Enumerates the button types. | 261| [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>} | | 262| [ArkUI_ThemeColorMode](#arkui_themecolormode) { ARKUI_THEME_COLOR_MODE_SYSTEM = 0, ARKUI_THEME_COLOR_MODE_LIGHT, ARKUI_THEME_COLOR_MODE_DARK } | | 263| [ArkUI_SwiperIndicatorType](#arkui_swiperindicatortype) { ARKUI_SWIPER_INDICATOR_TYPE_DOT, ARKUI_SWIPER_INDICATOR_TYPE_DIGIT } | Enumerates the navigation indicator types of the **Swiper** component. | 264| [ArkUI_AnimationDirection](#arkui_animationdirection) { ARKUI_ANIMATION_DIRECTION_NORMAL = 0, ARKUI_ANIMATION_DIRECTION_REVERSE, ARKUI_ANIMATION_DIRECTION_ALTERNATE, ARKUI_ANIMATION_DIRECTION_ALTERNATE_REVERSE } | Enumerates the animation playback modes. | 265| [ArkUI_AnimationFill](#arkui_animationfill) { ARKUI_ANIMATION_FILL_NONE = 0, ARKUI_ANIMATION_FILL_FORWARDS, ARKUI_ANIMATION_FILL_BACKWARDS, ARKUI_ANIMATION_FILL_BOTH } | Enumerates the state of the animated target after the animation is executed. | 266| [ArkUI_SwiperDisplayModeType](#arkui_swiperdisplaymodetype) { ARKUI_SWIPER_DISPLAY_MODE_STRETCH, ARKUI_SWIPER_DISPLAY_MODE_AUTO_LINEAR } | Enumerates the modes in which elements are displayed along the main axis of the **Swiper** component. | 267| [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 } | Enumerates the swipe action item states of list items. | 268| [ArkUI_ListItemSwipeEdgeEffect](#arkui_listitemswipeedgeeffect) { ARKUI_LIST_ITEM_SWIPE_EDGE_EFFECT_SPRING = 0, ARKUI_LIST_ITEM_SWIPE_EDGE_EFFECT_NONE } | Enumerates the swipe action item edge effects of list items. | 269| [ArkUI_AnimationStatus](#arkui_animationstatus) { ARKUI_ANIMATION_STATUS_INITIAL, ARKUI_ANIMATION_STATUS_RUNNING, ARKUI_ANIMATION_STATUS_PAUSED, ARKUI_ANIMATION_STATUS_STOPPED } | Enumerates the playback states of the frame-by-frame animation. | 270| [ArkUI_AnimationFillMode](#arkui_animationfillmode) { ARKUI_ANIMATION_FILL_MODE_NONE, ARKUI_ANIMATION_FILL_MODE_FORWARDS, ARKUI_ANIMATION_FILL_MODE_BACKWARDS, ARKUI_ANIMATION_FILL_MODE_BOTH } | Enumerates the states before and after execution of the frame-by-frame animation. | 271| [ArkUI_ErrorCode](#arkui_errorcode) {<br>ARKUI_ERROR_CODE_NO_ERROR = 0, ARKUI_ERROR_CODE_PARAM_INVALID = 401,<br>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_ATTRIBUTE_OR_EVENT_NOT_SUPPORTED = 106102, ARKUI_ERROR_CODE_NOT_SUPPROTED_FOR_ARKTS_NODE = 106103,<br>ARKUI_ERROR_CODE_NODE_ADAPTER_NONE_HOST = 106104, ARKUI_ERROR_CODE_NODE_ADAPTER_EXIST_IN_HOST = 106105, ARKUI_ERROR_CODE_NODE_ADAPTER_CHILD_NODE_EXIST = 106106, ARKUI_ERROR_CODE_NODE_EVENT_PARAM_INDEX_OUT_OF_RANGE = 106107,<br>ARKUI_ERROR_CODE_NODE_EVENT_PARAM_INVALID = 106108, ARKUI_ERROR_CODE_NODE_EVENT_NO_RETURN = 106109, ARKUI_ERROR_CODE_NODE_INDEX_INVALID = 106200, ARKUI_ERROR_CODE_GET_INFO_FAILED = 106201,<br>ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR = 106202, ARKUI_ERROR_CODE_NODE_NOT_ON_MAIN_TREE = 106203, ARKUI_ERROR_CODE_NON_SCROLLABLE_CONTAINER = 180001, ARKUI_ERROR_CODE_BUFFER_SIZE_NOT_ENOUGH = 180002, ARKUI_ERROR_CODE_NOT_CLONED_POINTER_EVENT = 180003, 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<br>} | Defines an enum for the error codes. | 272| [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>} | Enumerates the scrolling sources. | 273| [ArkUI_SafeAreaType](#arkui_safeareatype) { ARKUI_SAFE_AREA_TYPE_SYSTEM = 1, ARKUI_SAFE_AREA_TYPE_CUTOUT = 1 << 1, ARKUI_SAFE_AREA_TYPE_KEYBOARD = 1 << 2 } | Enumerates the types of expanded safe areas. | 274| [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>} | Enumerates the component areas.| 275| [ArkUI_SafeAreaEdge](#arkui_safeareaedge) { ARKUI_SAFE_AREA_EDGE_TOP = 1, ARKUI_SAFE_AREA_EDGE_BOTTOM = 1 << 1, ARKUI_SAFE_AREA_EDGE_START = 1 << 2, ARKUI_SAFE_AREA_EDGE_END = 1 << 3 } | Enumerates the edges for expanding the safe area. | 276| [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>} | Defines an enum for the **NavDestination** component states. | 277| [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, } | Enumerates the focus movement directions. | 278| [ArkUI_RouterPageState](#arkui_routerpagestate) {<br>ARKUI_ROUTER_PAGE_STATE_ON_WILL_APPEAR = 0, ARKUI_ROUTER_PAGE_STATE_ON_WILL_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>} | Enumerates the states of a page during routing. | 279| [ArkUI_DatePickerMode](#arkui_datepickermode) {<br>ARKUI_DATEPICKER_MODE_DATE = 0, ARKUI_DATEPICKER_YEAR_AND_MONTH = 1, ARKUI_DATEPICKER_MONTH_AND_DAY = 2<br> } | Enumerates the column display modes of the date picker. | 280 281 282### Functions 283 284| Name| Description| 285| -------- | -------- | 286| [ArkUI_DragEvent](#arkui_dragevent) \* [OH_ArkUI_NodeEvent_GetDragEvent](#oh_arkui_nodeevent_getdragevent) ([ArkUI_NodeEvent](#arkui_nodeevent-12) \*nodeEvent) | Obtains a **DragEvent** object from the specified **NodeEvent** object. | 287| [ArkUI_PreDragStatus](#arkui_predragstatus) [OH_ArkUI_NodeEvent_GetPreDragStatus](#oh_arkui_nodeevent_getpredragstatus) ([ArkUI_NodeEvent](#arkui_nodeevent-12) \*nodeEvent) | Obtains the state prior to a drop and drop operation. | 288| int32_t [OH_ArkUI_DragEvent_DisableDefaultDropAnimation](#oh_arkui_dragevent_disabledefaultdropanimation) ([ArkUI_DragEvent](#arkui_dragevent) \*event, bool disable) | Sets whether to disable the default drop animation, which is enabled by default. Use this API to apply a custom drop animation. | 289| int32_t [OH_ArkUI_DragEvent_SetSuggestedDropOperation](#oh_arkui_dragevent_setsuggesteddropoperation) ([ArkUI_DragEvent](#arkui_dragevent) \*event, [ArkUI_DropOperation](#arkui_dropoperation) dropOperation) | Sets the data processing mode. | 290| int32_t [OH_ArkUI_DragEvent_SetDragResult](#oh_arkui_dragevent_setdragresult) ([ArkUI_DragEvent](#arkui_dragevent) \*event, [ArkUI_DragResult](#arkui_dragresult) result) | Sets the result for a drag event. | 291| int32_t [OH_ArkUI_DragEvent_SetData](#oh_arkui_dragevent_setdata) ([ArkUI_DragEvent](#arkui_dragevent) \*event, [OH_UdmfData](#oh_udmfdata) \*data) | Sets drag data for a drag event. | 292| int32_t [OH_ArkUI_DragEvent_GetUdmfData](#oh_arkui_dragevent_getudmfdata) ([ArkUI_DragEvent](#arkui_dragevent) \*event, [OH_UdmfData](#oh_udmfdata) \*data) | Obtains the default drag data from a drag event. | 293| int32_t [OH_ArkUI_DragEvent_GetDataTypeCount](#oh_arkui_dragevent_getdatatypecount) ([ArkUI_DragEvent](#arkui_dragevent) \*event, int32_t \*count) | Obtains the number of drag data types from a drag event. | 294| int32_t [OH_ArkUI_DragEvent_GetDataTypes](#oh_arkui_dragevent_getdatatypes) ([ArkUI_DragEvent](#arkui_dragevent) \*event, char \*\*result[], int32_t length) | Obtains the type list of drag data types from a drag event. | 295| int32_t [OH_ArkUI_DragEvent_GetDragResult](#oh_arkui_dragevent_getdragresult) ([ArkUI_DragEvent](#arkui_dragevent) \*event, [ArkUI_DragResult](#arkui_dragresult) \*result) | Obtains the drag and drop result from the drag event. | 296| int32_t [OH_ArkUI_DragEvent_GetDropOperation](#oh_arkui_dragevent_getdropoperation) ([ArkUI_DragEvent](#arkui_dragevent) \*event, [ArkUI_DropOperation](#arkui_dropoperation) \*operation) | Obtains the data handling method from the drag event. | 297| float [OH_ArkUI_DragEvent_GetPreviewTouchPointX](#oh_arkui_dragevent_getpreviewtouchpointx) ([ArkUI_DragEvent](#arkui_dragevent) \*event) | Obtains the X coordinate of the touch point for a drag preview from a drag event. | 298| float [OH_ArkUI_DragEvent_GetPreviewTouchPointY](#oh_arkui_dragevent_getpreviewtouchpointy) ([ArkUI_DragEvent](#arkui_dragevent) \*event) | Obtains the Y coordinate of the touch point for a drag preview from a drag event. | 299| float [OH_ArkUI_DragEvent_GetPreviewRectWidth](#oh_arkui_dragevent_getpreviewrectwidth) ([ArkUI_DragEvent](#arkui_dragevent) \*event) | Obtains the width of a drag preview from a drag event. | 300| float [OH_ArkUI_DragEvent_GetPreviewRectHeight](#oh_arkui_dragevent_getpreviewrectheight) ([ArkUI_DragEvent](#arkui_dragevent) \*event) | Obtains the height of a drag preview from a drag event. | 301| float [OH_ArkUI_DragEvent_GetTouchPointXToWindow](#oh_arkui_dragevent_gettouchpointxtowindow) ([ArkUI_DragEvent](#arkui_dragevent) \*event) | Obtains the X coordinate of the touch point relative to the window from a drag event. | 302| float [OH_ArkUI_DragEvent_GetTouchPointYToWindow](#oh_arkui_dragevent_gettouchpointytowindow) ([ArkUI_DragEvent](#arkui_dragevent) \*event) | Obtains the Y coordinate of the touch point relative to the window from a drag event. | 303| float [OH_ArkUI_DragEvent_GetTouchPointXToDisplay](#oh_arkui_dragevent_gettouchpointxtodisplay) ([ArkUI_DragEvent](#arkui_dragevent) \*event) | Obtains the X coordinate of the touch point relative to the display from a drag event. | 304| float [OH_ArkUI_DragEvent_GetTouchPointYToDisplay](#oh_arkui_dragevent_gettouchpointytodisplay) ([ArkUI_DragEvent](#arkui_dragevent) \*event) | Obtains the Y coordinate of the touch point relative to the display from a drag event. | 305| float [OH_ArkUI_DragEvent_GetVelocityX](#oh_arkui_dragevent_getvelocityx) ([ArkUI_DragEvent](#arkui_dragevent) \*event) | Obtains the dragging velocity along the x-axis. | 306| float [OH_ArkUI_DragEvent_GetVelocityY](#oh_arkui_dragevent_getvelocityy) ([ArkUI_DragEvent](#arkui_dragevent) \*event) | Obtains the dragging velocity along the y-axis. | 307| float [OH_ArkUI_DragEvent_GetVelocity](#oh_arkui_dragevent_getvelocity) ([ArkUI_DragEvent](#arkui_dragevent) \*event) | Obtains the dragging velocity along the main axis. | 308| int32_t [OH_ArkUI_DragEvent_GetModifierKeyStates](#oh_arkui_dragevent_getmodifierkeystates) ([ArkUI_DragEvent](#arkui_dragevent) \*event, uint64_t \*keys) | Obtains the pressed status of modifier keys from a drag event. | 309| int32_t [OH_ArkUI_SetDragEventStrictReportWithNode](#oh_arkui_setdrageventstrictreportwithnode) ([ArkUI_NodeHandle](#arkui_nodehandle) node, bool enabled) | Sets whether to enable strict reporting on drag events. This feature is disabled by default, and you are advised to enable it. If this feature is disabled, the parent component is not notified when an item in it is dragged over its child component. If this feature is enabled, the component is notified of the dragged item's leaving, and the child component to which the dragged item is dropped is notified of the item's entering. This configuration is related to a specific UI instance. You can pass in a specific component node on the current UI instance for association. | 310| int32_t [OH_ArkUI_SetDragEventStrictReportWithContext](#oh_arkui_setdrageventstrictreportwithcontext) ([ArkUI_ContextHandle](#arkui_contexthandle-12) uiContext, bool enabled) | Sets whether to enable strict reporting on drag events. This feature is disabled by default, and you are advised to enable it. If this feature is disabled, the parent component is not notified when an item in it is dragged over its child component. If this feature is enabled, the component is notified of the dragged item's leaving, and the child component to which the dragged item is dropped is notified of the item's entering. This configuration is related to a specific UI instance. You can pass in a specific UI instance for association. | 311| int32_t [OH_ArkUI_SetNodeAllowedDropDataTypes](#oh_arkui_setnodealloweddropdatatypes) ([ArkUI_NodeHandle](#arkui_nodehandle) node, const char \*typesArray[], int32_t count) | Sets the types of data that can be dropped to the specified component. This API resets the settings configured through [OH_ArkUI_DisallowNodeAnyDropDataTypes](#oh_arkui_disallownodeanydropdatatypes) or [OH_ArkUI_AllowNodeAllDropDataTypes](#oh_arkui_allownodealldropdatatypes). | 312| int32_t [OH_ArkUI_DisallowNodeAnyDropDataTypes](#oh_arkui_disallownodeanydropdatatypes) ([ArkUI_NodeHandle](#arkui_nodehandle) node) | Configures the specified component to disallow any data types. This API resets the settings configured through [OH_ArkUI_SetNodeAllowedDropDataTypes](#oh_arkui_setnodealloweddropdatatypes). | 313| int32_t [OH_ArkUI_AllowNodeAllDropDataTypes](#oh_arkui_allownodealldropdatatypes) ([ArkUI_NodeHandle](#arkui_nodehandle) node) | Configures the specified component to allow any data types. This API resets the settings configured through [OH_ArkUI_SetNodeAllowedDropDataTypes](#oh_arkui_setnodealloweddropdatatypes). | 314| int32_t [OH_ArkUI_SetNodeDraggable](#oh_arkui_setnodedraggable) ([ArkUI_NodeHandle](#arkui_nodehandle) node, bool enabled) | Sets whether the component is draggable. | 315| int32_t [OH_ArkUI_SetNodeDragPreview](#oh_arkui_setnodedragpreview) ([ArkUI_NodeHandle](#arkui_nodehandle) node, [OH_PixelmapNative](#oh_pixelmapnative) \*preview) | Sets a custom drag preview for the specified component. | 316| [ArkUI_DragPreviewOption](#arkui_dragpreviewoption) \* [OH_ArkUI_CreateDragPreviewOption](#oh_arkui_createdragpreviewoption) (void) | Creates an **ArkUI_DragPreviewOption** object. | 317| void [OH_ArkUI_DragPreviewOption_Dispose](#oh_arkui_dragpreviewoption_dispose) ([ArkUI_DragPreviewOption](#arkui_dragpreviewoption) \*option) | Disposes of an **ArkUI_DragPreviewOption** object. | 318| int32_t [OH_ArkUI_DragPreviewOption_SetScaleMode](#oh_arkui_dragpreviewoption_setscalemode) ([ArkUI_DragPreviewOption](#arkui_dragpreviewoption) \*option, [ArkUI_DragPreviewScaleMode](#arkui_dragpreviewscalemode) scaleMode) | Sets the scale mode for an **ArkUI_DragPreviewOption** object. | 319| int32_t [OH_ArkUI_DragPreviewOption_SetDefaultShadowEnabled](#oh_arkui_dragpreviewoption_setdefaultshadowenabled) ([ArkUI_DragPreviewOption](#arkui_dragpreviewoption) \*option, bool enabled) | Sets whether to enable the shadow effect for an **ArkUI_DragPreviewOption** object. The shadow effect is enabled by default. | 320| int32_t [OH_ArkUI_DragPreviewOption_SetDefaultRadiusEnabled](#oh_arkui_dragpreviewoption_setdefaultradiusenabled) ([ArkUI_DragPreviewOption](#arkui_dragpreviewoption) \*option, bool enabled) | Sets whether to enable the rounded corner effect for an **ArkUI_DragPreviewOption** object. The rounded corner effect is enabled by default. | 321| int32_t [OH_ArkUI_DragPreviewOption_SetNumberBadgeEnabled](#oh_arkui_dragpreviewoption_setnumberbadgeenabled) ([ArkUI_DragPreviewOption](#arkui_dragpreviewoption) \*option, bool enabled) | Sets whether to enable the badge for an **ArkUI_DragPreviewOption** object. If this feature is enabled, a badge that contains the number of dragged items is displayed. | 322| int32_t [OH_ArkUI_DragPreviewOption_SetBadgeNumber](#oh_arkui_dragpreviewoption_setbadgenumber) ([ArkUI_DragPreviewOption](#arkui_dragpreviewoption) \*option, uint32_t forcedNumber) | Sets the count on the badge. The settings will overwrite the value in the **SetDragPreviewNumberBadgeEnabled** API. | 323| int32_t [OH_ArkUI_DragPreviewOption_SetDefaultAnimationBeforeLiftingEnabled](#oh_arkui_dragpreviewoption_setdefaultanimationbeforeliftingenabled) ([ArkUI_DragPreviewOption](#arkui_dragpreviewoption) \*option, bool enabled) | Sets whether to enable the default animation on a click or touch. | 324| int32_t [OH_ArkUI_SetNodeDragPreviewOption](#oh_arkui_setnodedragpreviewoption) ([ArkUI_NodeHandle](#arkui_nodehandle) node, [ArkUI_DragPreviewOption](#arkui_dragpreviewoption) \*option) | Sets an **ArkUI_DragPreviewOption** object for the specified component. | 325| [ArkUI_DragAction](#arkui_dragaction) \* [OH_ArkUI_CreateDragActionWithNode](#oh_arkui_createdragactionwithnode) ([ArkUI_NodeHandle](#arkui_nodehandle) node) | Creates a drag action object. The object needs to be associated with a UI instance, which can be specified by passing in a component node of the current UI instance. | 326| [ArkUI_DragAction](#arkui_dragaction) \* [OH_ArkUI_CreateDragActionWithContext](#oh_arkui_createdragactionwithcontext) ([ArkUI_ContextHandle](#arkui_contexthandle-12) uiContext) | Creates a drag action object for the specified UI instance. | 327| void [OH_ArkUI_DragAction_Dispose](#oh_arkui_dragaction_dispose) ([ArkUI_DragAction](#arkui_dragaction) \*dragAction) | Disposes of an **ArkUI_DragAction** object. | 328| int32_t [OH_ArkUI_DragAction_SetPointerId](#oh_arkui_dragaction_setpointerid) ([ArkUI_DragAction](#arkui_dragaction) \*dragAction, int32_t pointer) | Sets the pointer ID. If only one finger is operating on the screen, the pointer ID is 0. In general cases, you can set the pointer ID to 0. | 329| int32_t [OH_ArkUI_DragAction_SetPixelMaps](#oh_arkui_dragaction_setpixelmaps) ([ArkUI_DragAction](#arkui_dragaction) \*dragAction, [OH_PixelmapNative](#oh_pixelmapnative) \*pixelmapArray[], int32_t size) | Sets the drag previews for a drag action. | 330| int32_t [OH_ArkUI_DragAction_SetTouchPointX](#oh_arkui_dragaction_settouchpointx) ([ArkUI_DragAction](#arkui_dragaction) \*dragAction, float x) | Sets the touch point relative to the upper left corner of the first drag preview (pixel map). | 331| int32_t [OH_ArkUI_DragAction_SetTouchPointY](#oh_arkui_dragaction_settouchpointy) ([ArkUI_DragAction](#arkui_dragaction) \*dragAction, float y) | Sets the touch point relative to the upper left corner of the first drag preview (pixel map). | 332| int32_t [OH_ArkUI_DragAction_SetData](#oh_arkui_dragaction_setdata) ([ArkUI_DragAction](#arkui_dragaction) \*dragAction, [OH_UdmfData](#oh_udmfdata) \*data) | Sets the drag data. | 333| int32_t [OH_ArkUI_DragAction_SetDragPreviewOption](#oh_arkui_dragaction_setdragpreviewoption) ([ArkUI_DragAction](#arkui_dragaction) \*dragAction, [ArkUI_DragPreviewOption](#arkui_dragpreviewoption) \*option) | Sets an **ArkUI_DragPreviewOption** object for the specified drag action object. | 334| 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)) | Registers a drag status listener. This listener can be used to check whether the data is successfully received and processed. | 335| void [OH_ArkUI_DragAction_UnregisterStatusListener](#oh_arkui_dragaction_unregisterstatuslistener) ([ArkUI_DragAction](#arkui_dragaction) \*dragAction) | Unregisters a drag status listener. | 336| [ArkUI_DragStatus](#arkui_dragstatus) [OH_ArkUI_DragAndDropInfo_GetDragStatus](#oh_arkui_draganddropinfo_getdragstatus) ([ArkUI_DragAndDropInfo](#arkui_draganddropinfo) \*dragAndDropInfo) | Obtains the drag status of a drag action. | 337| [ArkUI_DragEvent](#arkui_dragevent) \* [OH_ArkUI_DragAndDropInfo_GetDragEvent](#oh_arkui_draganddropinfo_getdragevent) ([ArkUI_DragAndDropInfo](#arkui_draganddropinfo) \*dragAndDropInfo) | Obtains a drag event based on the specified drag and drop information. The drag event can then be used to obtain the drag result. | 338| int32_t [OH_ArkUI_StartDrag](#oh_arkui_startdrag) ([ArkUI_DragAction](#arkui_dragaction) \*dragAction) | Initiates a drag action through the specified **DragAction** object. | 339| [ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) \* [OH_ArkUI_DrawableDescriptor_CreateFromPixelMap](#oh_arkui_drawabledescriptor_createfrompixelmap) ([OH_PixelmapNativeHandle](#oh_pixelmapnativehandle) pixelMap) | Creates a **DrawableDescriptor** object from a **PixelMap** object. | 340| [ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) \* [OH_ArkUI_DrawableDescriptor_CreateFromAnimatedPixelMap](#oh_arkui_drawabledescriptor_createfromanimatedpixelmap) ([OH_PixelmapNativeHandle](#oh_pixelmapnativehandle) \*array, int32_t size) | Creates a **DrawableDescriptor** object from an array of **PixelMap** objects. | 341| void [OH_ArkUI_DrawableDescriptor_Dispose](#oh_arkui_drawabledescriptor_dispose) ([ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) \*drawableDescriptor) | Disposes of the pointer to a **DrawableDescriptor** object. | 342| [OH_PixelmapNativeHandle](#oh_pixelmapnativehandle) [OH_ArkUI_DrawableDescriptor_GetStaticPixelMap](#oh_arkui_drawabledescriptor_getstaticpixelmap) ([ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) \*drawableDescriptor) | Obtains the pointer to a **PixelMap** object. | 343| [OH_PixelmapNativeHandle](#oh_pixelmapnativehandle) \* [OH_ArkUI_DrawableDescriptor_GetAnimatedPixelMapArray](#oh_arkui_drawabledescriptor_getanimatedpixelmaparray) ([ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) \*drawableDescriptor) | Obtains an array of **PixelMap** objects for playing an animation. | 344| int32_t [OH_ArkUI_DrawableDescriptor_GetAnimatedPixelMapArraySize](#oh_arkui_drawabledescriptor_getanimatedpixelmaparraysize) ([ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) \*drawableDescriptor) | Obtains an array of **PixelMap** objects for playing an animation. | 345| void [OH_ArkUI_DrawableDescriptor_SetAnimationDuration](#oh_arkui_drawabledescriptor_setanimationduration) ([ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) \*drawableDescriptor, int32_t duration) | Sets the total playback duration for a pixel map image array. | 346| int32_t [OH_ArkUI_DrawableDescriptor_GetAnimationDuration](#oh_arkui_drawabledescriptor_getanimationduration) ([ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) \*drawableDescriptor) | Obtains the total playback duration for a pixel map image array. | 347| void [OH_ArkUI_DrawableDescriptor_SetAnimationIteration](#oh_arkui_drawabledescriptor_setanimationiteration) ([ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) \*drawableDescriptor, int32_t iteration) | Sets the number of times that a pixel map image array is played. | 348| int32_t [OH_ArkUI_DrawableDescriptor_GetAnimationIteration](#oh_arkui_drawabledescriptor_getanimationiteration) ([ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) \*drawableDescriptor) | Obtains the number of times that a pixel map image array is played. | 349| [ArkUI_AnimateOption](#arkui_animateoption) \* [OH_ArkUI_AnimateOption_Create](#oh_arkui_animateoption_create) () | Creates an animation configuration. | 350| void [OH_ArkUI_AnimateOption_Dispose](#oh_arkui_animateoption_dispose) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | Destroys an animation configuration. | 351| int32_t [OH_ArkUI_AnimateOption_GetDuration](#oh_arkui_animateoption_getduration) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | Obtains the animation duration, in milliseconds. | 352| float [OH_ArkUI_AnimateOption_GetTempo](#oh_arkui_animateoption_gettempo) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | Obtains the playback speed of an animation. | 353| [ArkUI_AnimationCurve](#arkui_animationcurve) [OH_ArkUI_AnimateOption_GetCurve](#oh_arkui_animateoption_getcurve) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | Obtains an animation curve. | 354| int32_t [OH_ArkUI_AnimateOption_GetDelay](#oh_arkui_animateoption_getdelay) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | Obtains the animation delay, in milliseconds. | 355| int32_t [OH_ArkUI_AnimateOption_GetIterations](#oh_arkui_animateoption_getiterations) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | Obtains the number of times that an animation is played. | 356| [ArkUI_AnimationPlayMode](#arkui_animationplaymode) [OH_ArkUI_AnimateOption_GetPlayMode](#oh_arkui_animateoption_getplaymode) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | Obtains the playback mode of an animation. | 357| [ArkUI_ExpectedFrameRateRange](_ark_u_i___expected_frame_rate_range.md) \* [OH_ArkUI_AnimateOption_GetExpectedFrameRateRange](#oh_arkui_animateoption_getexpectedframeraterange) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | Obtains the expected frame rate range of an animation. | 358| void [OH_ArkUI_AnimateOption_SetDuration](#oh_arkui_animateoption_setduration) ([ArkUI_AnimateOption](#arkui_animateoption) \*option, int32_t value) | Sets the animation duration. | 359| void [OH_ArkUI_AnimateOption_SetTempo](#oh_arkui_animateoption_settempo) ([ArkUI_AnimateOption](#arkui_animateoption) \*option, float value) | Sets the playback speed of an animation. | 360| void [OH_ArkUI_AnimateOption_SetCurve](#oh_arkui_animateoption_setcurve) ([ArkUI_AnimateOption](#arkui_animateoption) \*option, [ArkUI_AnimationCurve](#arkui_animationcurve) value) | Animation curve. | 361| void [OH_ArkUI_AnimateOption_SetDelay](#oh_arkui_animateoption_setdelay) ([ArkUI_AnimateOption](#arkui_animateoption) \*option, int32_t value) | Sets the animation delay. | 362| void [OH_ArkUI_AnimateOption_SetIterations](#oh_arkui_animateoption_setiterations) ([ArkUI_AnimateOption](#arkui_animateoption) \*option, int32_t value) | Number of times that the frame animation is played. | 363| void [OH_ArkUI_AnimateOption_SetPlayMode](#oh_arkui_animateoption_setplaymode) ([ArkUI_AnimateOption](#arkui_animateoption) \*option, [ArkUI_AnimationPlayMode](#arkui_animationplaymode) value) | Sets the playback mode for an animation. | 364| 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) | Defines the expected frame rate range of the animation. | 365| void [OH_ArkUI_AnimateOption_SetICurve](#oh_arkui_animateoption_seticurve) ([ArkUI_AnimateOption](#arkui_animateoption) \*option, [ArkUI_CurveHandle](#arkui_curvehandle) value) | Sets the animation curve for an animation. | 366| [ArkUI_CurveHandle](#arkui_curvehandle) [OH_ArkUI_AnimateOption_GetICurve](#oh_arkui_animateoption_geticurve) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | Obtains the animation curve of an animation. | 367| [ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) \* [OH_ArkUI_KeyframeAnimateOption_Create](#oh_arkui_keyframeanimateoption_create) (int32_t size) | Obtains the keyframe animation parameters. | 368| void [OH_ArkUI_KeyframeAnimateOption_Dispose](#oh_arkui_keyframeanimateoption_dispose) ([ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) \*option) | Destroys a keyframe animation parameter object. | 369| int32_t [OH_ArkUI_KeyframeAnimateOption_SetDelay](#oh_arkui_keyframeanimateoption_setdelay) ([ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) \*option, int32_t value) | Sets the overall delay of a keyframe animation, in milliseconds. By default, the keyframe animation is played without delay. | 370| int32_t [OH_ArkUI_KeyframeAnimateOption_SetIterations](#oh_arkui_keyframeanimateoption_setiterations) ([ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) \*option, int32_t value) | Sets the number of times that the keyframe animation is played. By default, the animation is played once. The value **-1** indicates that the animation is played for an unlimited number of times. The value **0** indicates that there is no animation. | 371| int32_t [OH_ArkUI_KeyframeAnimateOption_RegisterOnFinishCallback](#oh_arkui_keyframeanimateoption_registeronfinishcallback) ([ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) \*option, void \*userData, void(\*onFinish)(void \*userData)) | Sets the callback invoked when the keyframe animation playback is complete. This API is called after the keyframe animation has played for the specified number of times. | 372| int32_t [OH_ArkUI_KeyframeAnimateOption_SetDuration](#oh_arkui_keyframeanimateoption_setduration) ([ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) \*option, int32_t value, int32_t index) | Sets the duration of a keyframe animation, in milliseconds. | 373| int32_t [OH_ArkUI_KeyframeAnimateOption_SetCurve](#oh_arkui_keyframeanimateoption_setcurve) ([ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) \*option, [ArkUI_CurveHandle](#arkui_curvehandle) value, int32_t index) | Sets the animation curve for a specific keyframe in a keyframe animation. | 374| int32_t [OH_ArkUI_KeyframeAnimateOption_RegisterOnEventCallback](#oh_arkui_keyframeanimateoption_registeroneventcallback) ([ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) \*option, void \*userData, void(\*event)(void \*userData), int32_t index) | Sets the closure function of the state at the time of the keyframe, that is, the state to be reached at the time of the keyframe. | 375| int32_t [OH_ArkUI_KeyframeAnimateOption_GetDelay](#oh_arkui_keyframeanimateoption_getdelay) ([ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) \*option) | Obtains the overall delay of a keyframe animation | 376| int32_t [OH_ArkUI_KeyframeAnimateOption_GetIterations](#oh_arkui_keyframeanimateoption_getiterations) ([ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) \*option) | Obtains the number of times that a keyframe animation is played. | 377| int32_t [OH_ArkUI_KeyframeAnimateOption_GetDuration](#oh_arkui_keyframeanimateoption_getduration) ([ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) \*option, int32_t index) | Obtains the duration of a specific state in a keyframe animation. | 378| [ArkUI_CurveHandle](#arkui_curvehandle) [OH_ArkUI_KeyframeAnimateOption_GetCurve](#oh_arkui_keyframeanimateoption_getcurve) ([ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) \*option, int32_t index) | Obtains the animation curve of a specific state in a keyframe animation. | 379| [ArkUI_AnimatorOption](#arkui_animatoroption) \* [OH_ArkUI_AnimatorOption_Create](#oh_arkui_animatoroption_create) (int32_t keyframeSize) | Creates an animator parameter object. | 380| void [OH_ArkUI_AnimatorOption_Dispose](#oh_arkui_animatoroption_dispose) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | Destroys an animator parameter object. | 381| int32_t [OH_ArkUI_AnimatorOption_SetDuration](#oh_arkui_animatoroption_setduration) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, int32_t value) | Sets the duration of an animation, in milliseconds. | 382| int32_t [OH_ArkUI_AnimatorOption_SetDelay](#oh_arkui_animatoroption_setdelay) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, int32_t value) | Sets the delay of animation playback, in milliseconds. | 383| int32_t [OH_ArkUI_AnimatorOption_SetIterations](#oh_arkui_animatoroption_setiterations) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, int32_t value) | Number of times that the frame animation is played. The value **0** means not to play the animation, and **-1** means to play the animation for an unlimited number of times. | 384| int32_t [OH_ArkUI_AnimatorOption_SetFill](#oh_arkui_animatoroption_setfill) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, [ArkUI_AnimationFill](#arkui_animationfill) value) | Sets whether the animator animation is restored to the initial state after being executed. | 385| int32_t [OH_ArkUI_AnimatorOption_SetDirection](#oh_arkui_animatoroption_setdirection) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, [ArkUI_AnimationDirection](#arkui_animationdirection) value) | Sets the playback direction. | 386| int32_t [OH_ArkUI_AnimatorOption_SetCurve](#oh_arkui_animatoroption_setcurve) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, [ArkUI_CurveHandle](#arkui_curvehandle) value) | Sets the interpolation curve for the animation of an animator. | 387| int32_t [OH_ArkUI_AnimatorOption_SetBegin](#oh_arkui_animatoroption_setbegin) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, float value) | Sets the interpolation start point for the animation of an animator. | 388| int32_t [OH_ArkUI_AnimatorOption_SetEnd](#oh_arkui_animatoroption_setend) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, float value) | Sets the interpolation end point for the animation of an animator. | 389| 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) | Sets the expected frame rate range of an animation. | 390| int32_t [OH_ArkUI_AnimatorOption_SetKeyframe](#oh_arkui_animatoroption_setkeyframe) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, float time, float value, int32_t index) | Sets the keyframe parameters of an animation. | 391| int32_t [OH_ArkUI_AnimatorOption_SetKeyframeCurve](#oh_arkui_animatoroption_setkeyframecurve) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, [ArkUI_CurveHandle](#arkui_curvehandle) value, int32_t index) | Sets the keyframe curve type for the animation of an animator. | 392| int32_t [OH_ArkUI_AnimatorOption_GetDuration](#oh_arkui_animatoroption_getduration) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | Obtains the duration for playing an animation. | 393| int32_t [OH_ArkUI_AnimatorOption_GetDelay](#oh_arkui_animatoroption_getdelay) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | Obtains the delay for playing an animation. | 394| int32_t [OH_ArkUI_AnimatorOption_GetIterations](#oh_arkui_animatoroption_getiterations) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | Obtains the number of times that an animation is played. | 395| [ArkUI_AnimationFill](#arkui_animationfill) [OH_ArkUI_AnimatorOption_GetFill](#oh_arkui_animatoroption_getfill) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | Obtains whether the animator animation is restored to the initial state after being executed. | 396| [ArkUI_AnimationDirection](#arkui_animationdirection) [OH_ArkUI_AnimatorOption_GetDirection](#oh_arkui_animatoroption_getdirection) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | Obtains the playback direction of an animation. | 397| [ArkUI_CurveHandle](#arkui_curvehandle) [OH_ArkUI_AnimatorOption_GetCurve](#oh_arkui_animatoroption_getcurve) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | Obtains the interpolation curve of the animation of an animator. | 398| float [OH_ArkUI_AnimatorOption_GetBegin](#oh_arkui_animatoroption_getbegin) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | Obtains the interpolation start point of an animation. | 399| float [OH_ArkUI_AnimatorOption_GetEnd](#oh_arkui_animatoroption_getend) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | Obtains the interpolation end point of an animation. | 400| [ArkUI_ExpectedFrameRateRange](_ark_u_i___expected_frame_rate_range.md) \* [OH_ArkUI_AnimatorOption_GetExpectedFrameRateRange](#oh_arkui_animatoroption_getexpectedframeraterange) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | Obtains the expected frame rate range of an animation. | 401| float [OH_ArkUI_AnimatorOption_GetKeyframeTime](#oh_arkui_animatoroption_getkeyframetime) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, int32_t index) | Obtains the keyframe time of an animation. | 402| float [OH_ArkUI_AnimatorOption_GetKeyframeValue](#oh_arkui_animatoroption_getkeyframevalue) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, int32_t index) | Obtains the keyframe value of an animation. | 403| [ArkUI_CurveHandle](#arkui_curvehandle) [OH_ArkUI_AnimatorOption_GetKeyframeCurve](#oh_arkui_animatoroption_getkeyframecurve) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, int32_t index) | Obtains the interpolation curve for a keyframe in the animation of an animator. | 404| void \* [OH_ArkUI_AnimatorEvent_GetUserData](#oh_arkui_animatorevent_getuserdata) (ArkUI_AnimatorEvent \*event) | Obtains the custom object in an animation event object. | 405| void \* [OH_ArkUI_AnimatorOnFrameEvent_GetUserData](#oh_arkui_animatoronframeevent_getuserdata) (ArkUI_AnimatorOnFrameEvent \*event) | Obtains the custom object in an animation event object. | 406| float [OH_ArkUI_AnimatorOnFrameEvent_GetValue](#oh_arkui_animatoronframeevent_getvalue) (ArkUI_AnimatorOnFrameEvent \*event) | Obtains the current progress in an animation event object. | 407| int32_t [OH_ArkUI_AnimatorOption_RegisterOnFrameCallback](#oh_arkui_animatoroption_registeronframecallback) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, void \*userData, void(\*callback)(ArkUI_AnimatorOnFrameEvent \*event)) | Sets the callback invoked when the animator receives a frame. | 408| int32_t [OH_ArkUI_AnimatorOption_RegisterOnFinishCallback](#oh_arkui_animatoroption_registeronfinishcallback) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, void \*userData, void(\*callback)(ArkUI_AnimatorEvent \*event)) | Sets the callback invoked when the animation playback is complete. | 409| int32_t [OH_ArkUI_AnimatorOption_RegisterOnCancelCallback](#oh_arkui_animatoroption_registeroncancelcallback) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, void \*userData, void(\*callback)(ArkUI_AnimatorEvent \*event)) | Sets the callback invoked when the animation playback is canceled. | 410| int32_t [OH_ArkUI_AnimatorOption_RegisterOnRepeatCallback](#oh_arkui_animatoroption_registeronrepeatcallback) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, void \*userData, void(\*callback)(ArkUI_AnimatorEvent \*event)) | Sets the callback invoked when the animation playback is repeated. | 411| int32_t [OH_ArkUI_Animator_ResetAnimatorOption](#oh_arkui_animator_resetanimatoroption) ([ArkUI_AnimatorHandle](#arkui_animatorhandle) animator, [ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | Resets an animator configuration. | 412| int32_t [OH_ArkUI_Animator_Play](#oh_arkui_animator_play) ([ArkUI_AnimatorHandle](#arkui_animatorhandle) animator) | Starts the animation of an animator. | 413| int32_t [OH_ArkUI_Animator_Finish](#oh_arkui_animator_finish) ([ArkUI_AnimatorHandle](#arkui_animatorhandle) animator) | Ends the animation of an animator. | 414| int32_t [OH_ArkUI_Animator_Pause](#oh_arkui_animator_pause) ([ArkUI_AnimatorHandle](#arkui_animatorhandle) animator) | Pauses the animation of an animator. | 415| int32_t [OH_ArkUI_Animator_Cancel](#oh_arkui_animator_cancel) ([ArkUI_AnimatorHandle](#arkui_animatorhandle) animator) | Cancels the animation of an animator. | 416| int32_t [OH_ArkUI_Animator_Reverse](#oh_arkui_animator_reverse) ([ArkUI_AnimatorHandle](#arkui_animatorhandle) animator) | Plays this animation in reverse order. | 417| [ArkUI_CurveHandle](#arkui_curvehandle) [OH_ArkUI_Curve_CreateCurveByType](#oh_arkui_curve_createcurvebytype) ([ArkUI_AnimationCurve](#arkui_animationcurve) curve) | Implements initialization for the interpolation curve, which is used to create an interpolation curve based on the input parameter. | 418| [ArkUI_CurveHandle](#arkui_curvehandle) [OH_ArkUI_Curve_CreateStepsCurve](#oh_arkui_curve_createstepscurve) (int32_t count, bool end) | Creates a step curve. | 419| [ArkUI_CurveHandle](#arkui_curvehandle) [OH_ArkUI_Curve_CreateCubicBezierCurve](#oh_arkui_curve_createcubicbeziercurve) (float x1, float y1, float x2, float y2) | Creates a cubic Bezier curve. | 420| [ArkUI_CurveHandle](#arkui_curvehandle) [OH_ArkUI_Curve_CreateSpringCurve](#oh_arkui_curve_createspringcurve) (float velocity, float mass, float stiffness, float damping) | Creates a spring curve. The curve shape is subject to the spring parameters, and the animation duration is subject to the **duration** parameter in **animation** and **animateTo**. | 421| [ArkUI_CurveHandle](#arkui_curvehandle) [OH_ArkUI_Curve_CreateSpringMotion](#oh_arkui_curve_createspringmotion) (float response, float dampingFraction, float overlapDuration) | Creates a spring animation curve. If multiple spring animations are applied to the same attribute of an object, each animation replaces their predecessor and inherits the velocity. | 422| [ArkUI_CurveHandle](#arkui_curvehandle) [OH_ArkUI_Curve_CreateResponsiveSpringMotion](#oh_arkui_curve_createresponsivespringmotion) (float response, float dampingFraction, float overlapDuration) | Creates a responsive spring animation curve. It is a special case of **springMotion**, with the only difference in the default values. It can be used together with **springMotion**. | 423| [ArkUI_CurveHandle](#arkui_curvehandle) [OH_ArkUI_Curve_CreateInterpolatingSpring](#oh_arkui_curve_createinterpolatingspring) (float velocity, float mass, float stiffness, float damping) | Creates an interpolating spring curve animated from 0 to 1. The actual animation value is calculated based on the curve. | 424| [ArkUI_CurveHandle](#arkui_curvehandle) [OH_ArkUI_Curve_CreateCustomCurve](#oh_arkui_curve_createcustomcurve) (void \*userData, float(\*interpolate)(float fraction, void \*userdata)) | Creates a custom curve. | 425| void [OH_ArkUI_Curve_DisposeCurve](#oh_arkui_curve_disposecurve) ([ArkUI_CurveHandle](#arkui_curvehandle) curveHandle) | Disposes of a custom curve. | 426| [ArkUI_TransitionEffect](#arkui_transitioneffect) \* [OH_ArkUI_CreateOpacityTransitionEffect](#oh_arkui_createopacitytransitioneffect) (float opacity) | Creates an opacity object for component transition. | 427| [ArkUI_TransitionEffect](#arkui_transitioneffect) \* [OH_ArkUI_CreateTranslationTransitionEffect](#oh_arkui_createtranslationtransitioneffect) ([ArkUI_TranslationOptions](_ark_u_i___translation_options.md) \*translate) | Creates a translation object for component transition. | 428| [ArkUI_TransitionEffect](#arkui_transitioneffect) \* [OH_ArkUI_CreateScaleTransitionEffect](#oh_arkui_createscaletransitioneffect) ([ArkUI_ScaleOptions](_ark_u_i___scale_options.md) \*scale) | Creates a scaling object for component transition. | 429| [ArkUI_TransitionEffect](#arkui_transitioneffect) \* [OH_ArkUI_CreateRotationTransitionEffect](#oh_arkui_createrotationtransitioneffect) ([ArkUI_RotationOptions](_ark_u_i___rotation_options.md) \*rotate) | Creates a rotation object for component transition. | 430| [ArkUI_TransitionEffect](#arkui_transitioneffect) \* [OH_ArkUI_CreateMovementTransitionEffect](#oh_arkui_createmovementtransitioneffect) ([ArkUI_TransitionEdge](#arkui_transitionedge) move) | Creates a movement object for component transition. | 431| [ArkUI_TransitionEffect](#arkui_transitioneffect) \* [OH_ArkUI_CreateAsymmetricTransitionEffect](#oh_arkui_createasymmetrictransitioneffect) ([ArkUI_TransitionEffect](#arkui_transitioneffect) \*appear, [ArkUI_TransitionEffect](#arkui_transitioneffect) \*disappear) | Creates an asymmetric transition effect. | 432| void [OH_ArkUI_TransitionEffect_Dispose](#oh_arkui_transitioneffect_dispose) ([ArkUI_TransitionEffect](#arkui_transitioneffect) \*option) | Disposes of a transition effect. | 433| int32_t [OH_ArkUI_TransitionEffect_Combine](#oh_arkui_transitioneffect_combine) ([ArkUI_TransitionEffect](#arkui_transitioneffect) \*option, [ArkUI_TransitionEffect](#arkui_transitioneffect) \*combine) | Sets a combination of transition effects. | 434| int32_t [OH_ArkUI_TransitionEffect_SetAnimation](#oh_arkui_transitioneffect_setanimation) ([ArkUI_TransitionEffect](#arkui_transitioneffect) \*option, [ArkUI_AnimateOption](#arkui_animateoption) \*animation) | Sets transition effect animation settings. | 435| void [OH_ArkUI_DialogDismissEvent_SetShouldBlockDismiss](#oh_arkui_dialogdismissevent_setshouldblockdismiss) ([ArkUI_DialogDismissEvent](#arkui_dialogdismissevent) \*event, bool shouldBlockDismiss) | Sets whether to block the system behavior of dismissing a dialog box. | 436| void \* [OH_ArkUI_DialogDismissEvent_GetUserData](#oh_arkui_dialogdismissevent_getuserdata) ([ArkUI_DialogDismissEvent](#arkui_dialogdismissevent) \*event) | Obtains the pointer to user data in a dialog box dismiss event object. | 437| int32_t [OH_ArkUI_DialogDismissEvent_GetDismissReason](#oh_arkui_dialogdismissevent_getdismissreason) ([ArkUI_DialogDismissEvent](#arkui_dialogdismissevent) \*event) | Obtains the dismissal reason from a dialog box dismiss event object. | 438| int32_t [OH_ArkUI_CustomDialog_OpenDialog](#oh_arkui_customdialog_opendialog) ([ArkUI_CustomDialogOptions](#arkui_customdialogoptions) \*options, void (\*callback)(int32_t dialogId)) | Displays a custom dialog box. | 439| int32_t [OH_ArkUI_CustomDialog_UpdateDialog](#oh_arkui_customdialog_updatedialog) ([ArkUI_CustomDialogOptions](#arkui_customdialogoptions) \*options, void (\*callback)(int32_t dialogId)) | Updates a custom dialog box. | 440| int32_t [OH_ArkUI_CustomDialog_CloseDialog](#oh_arkui_customdialog_closedialog) (int32_t dialogId) | Closes a custom dialog box. | 441| ArkUI_CustomDialogOptions\* [OH_ArkUI_CustomDialog_CreateOptions](#oh_arkui_customdialog_createoptions) ([ArkUI_NodeHandle](#arkui_nodehandle) content) | Creates options for a custom dialog. | 442| void [OH_ArkUI_CustomDialog_DisposeOptions](#oh_arkui_customdialog_disposeoptions) ([ArkUI_CustomDialogOptions](#arkui_customdialogoptions) \*options) | Destroys custom dialog box options. | 443| int32_t [OH_ArkUI_CustomDialog_SetLevelMode](#oh_arkui_customdialog_setlevelmode) ([ArkUI_CustomDialogOptions](#arkui_customdialogoptions) \*options, [ArkUI_LevelMode](#arkui_levelmode) levelMode) | Sets the display level of the dialog box. | 444| int32_t [OH_ArkUI_CustomDialog_SetLevelUniqueId](#oh_arkui_customdialog_setleveluniqueid) ([ArkUI_CustomDialogOptions](#arkui_customdialogoptions) \*options, int32_t uniqueId) | Sets the ID of the node under the dialog box's display level. | 445| int32_t [OH_ArkUI_CustomDialog_SetImmersiveMode](#oh_arkui_customdialog_setimmersivemode) ([ArkUI_CustomDialogOptions](#arkui_customdialogoptions) \*options, [ArkUI_ImmersiveMode](#arkui_immersivemode) immersiveMode) | Sets the display area of the embedded dialog box overlay. | 446| int32_t [OH_ArkUI_CustomDialog_SetBackgroundColor](#oh_arkui_customdialog_setbackgroundcolor) ([ArkUI_CustomDialogOptions](#arkui_customdialogoptions) \*options, uint32_t backgroundColor) | Sets the background color of a dialog box. | 447| int32_t [OH_ArkUI_CustomDialog_SetCornerRadius](#oh_arkui_customdialog_setcornerradius) ([ArkUI_CustomDialogOptions](#arkui_customdialogoptions) \*options, float topLeft, float topRight, float bottomLeft, float bottomRight) | Sets the corner radius for a custom dialog box. | 448| int32_t [OH_ArkUI_CustomDialog_SetBorderWidth](#oh_arkui_customdialog_setborderwidth) ([ArkUI_CustomDialogOptions](#arkui_customdialogoptions) \*options, float top, float right, float bottom, float left, [ArkUI_LengthMetricUnit](#arkui_lengthmetricunit) unit) | Sets the border width of a dialog box. | 449| int32_t [OH_ArkUI_CustomDialog_SetBorderColor](#oh_arkui_customdialog_setbordercolor) ([ArkUI_CustomDialogOptions](#arkui_customdialogoptions) \*options, uint32_t top, uint32_t right, uint32_t bottom, uint32_t left) | Sets the border color of the dialog box. | 450| int32_t [OH_ArkUI_CustomDialog_SetBorderStyle](#oh_arkui_customdialog_setborderstyle) ([ArkUI_CustomDialogOptions](#arkui_customdialogoptions) \*options, int32_t top, int32_t right, int32_t bottom, int32_t left) | Sets the border style of a dialog box. | 451| int32_t [OH_ArkUI_CustomDialog_SetWidth](#oh_arkui_customdialog_setwidth) ([ArkUI_CustomDialogOptions](#arkui_customdialogoptions) \*options, float width, [ArkUI_LengthMetricUnit](#arkui_lengthmetricunit) unit) | Sets the width of the dialog box background. | 452| int32_t [OH_ArkUI_CustomDialog_SetHeight](#oh_arkui_customdialog_setheight) ([ArkUI_CustomDialogOptions](#arkui_customdialogoptions) \*options, float height, [ArkUI_LengthMetricUnit](#arkui_lengthmetricunit) unit) | Sets the height of the dialog box background. | 453| int32_t [OH_ArkUI_CustomDialog_SetShadow](#oh_arkui_customdialog_setshadow) ([ArkUI_CustomDialogOptions](#arkui_customdialogoptions) \*options, [ArkUI_ShadowStyle](#arkui_shadowstyle) shadow) | Sets the shadow of the dialog box background. | 454| int32_t [OH_ArkUI_CustomDialog_SetCustomShadow](#oh_arkui_customdialog_setcustomshadow) ([ArkUI_CustomDialogOptions](#arkui_customdialogoptions) \*options, const [ArkUI_AttributeItem](_ark_u_i___attribute_item.md#arkui_attributeitem) \*customShadow) | Sets the custom shadow of the dialog box background. | 455| int32_t [OH_ArkUI_CustomDialog_SetBackgroundBlurStyle](#oh_arkui_customdialog_setbackgroundblurstyle) ([ArkUI_CustomDialogOptions](#arkui_customdialogoptions) \*options, [ArkUI_BlurStyle](#arkui_blurstyle) blurStyle) | Sets the background blur style of the dialog box. | 456| int32_t [OH_ArkUI_CustomDialog_SetAlignment](#oh_arkui_customdialog_setalignment) ([ArkUI_CustomDialogOptions](#arkui_customdialogoptions) \*options, int32_t alignment, float offsetX, float offsetY) | Sets the alignment mode of a dialog box. | 457| int32_t [OH_ArkUI_CustomDialog_SetModalMode](#oh_arkui_customdialog_setmodalmode) ([ArkUI_CustomDialogOptions](#arkui_customdialogoptions) \*options, bool isModal) | Sets the modal mode for a custom dialog box. | 458| int32_t [OH_ArkUI_CustomDialog_SetAutoCancel](#oh_arkui_customdialog_setautocancel) ([ArkUI_CustomDialogOptions](#arkui_customdialogoptions) \*options, bool autoCancel) | Specifies whether to allow users to touch the mask to dismiss the custom dialog box. | 459| int32_t [OH_ArkUI_CustomDialog_SetSubwindowMode](#oh_arkui_customdialog_setsubwindowmode) ([ArkUI_CustomDialogOptions](#arkui_customdialogoptions) \*options, bool showInSubwindow) | Sets whether to display the dialog box in a subwindow. | 460| int32_t [OH_ArkUI_CustomDialog_SetMask](#oh_arkui_customdialog_setmask) ([ArkUI_CustomDialogOptions](#arkui_customdialogoptions) \*options, uint32_t maskColor, const [ArkUI_Rect](_ark_u_i___rect.md#arkui_rect) \*maskRect) | Sets the mask for a custom dialog box. | 461| int32_t [OH_ArkUI_CustomDialog_SetKeyboardAvoidMode](#oh_arkui_customdialog_setkeyboardavoidmode) ([ArkUI_CustomDialogOptions](#arkui_customdialogoptions) \*options, [ArkUI_KeyboardAvoidMode](_ark_u_i___native_module.md#arkui_keyboardavoidmode) keyboardAvoidMode) | Sets the keyboard avoidance mode of a dialog box. | 462| int32_t [OH_ArkUI_CustomDialog_SetHoverModeEnabled](#oh_arkui_customdialog_sethovermodeenabled) ([ArkUI_CustomDialogOptions](#arkui_customdialogoptions) \*options, bool enabled) | Sets whether to enable the hover mode for a dialog box. | 463| int32_t [OH_ArkUI_CustomDialog_SetHoverModeArea](#oh_arkui_customdialog_sethovermodearea) ([ArkUI_CustomDialogOptions](#arkui_customdialogoptions) \*options, [ArkUI_HoverModeAreaType](#arkui_hovermodeareatype) hoverModeAreaType) | Sets the default display area of a dialog box in hover mode. | 464| int32_t [OH_ArkUI_CustomDialog_RegisterOnWillDismissCallback](#oh_arkui_customdialog_registeronwilldismisscallback) ([ArkUI_CustomDialogOptions](#arkui_customdialogoptions) \*options, void\* userData, void (\*callback)([ArkUI_DialogDismissEvent](#arkui_dialogdismissevent) \*event)) | Registers a callback for the dismissal event of a custom dialog box. | 465| int32_t [OH_ArkUI_CustomDialog_RegisterOnWillAppearCallback](#oh_arkui_customdialog_registeronwillappearcallback) ([ArkUI_CustomDialogOptions](#arkui_customdialogoptions) \*options, void\* userData, void (\*callback)(void\* userData)) | Registers a callback to be invoked when the specified custom dialog box is about to appear. | 466| int32_t [OH_ArkUI_CustomDialog_RegisterOnDidAppearCallback](#oh_arkui_customdialog_registerondidappearcallback) ([ArkUI_CustomDialogOptions](#arkui_customdialogoptions) \*options, void\* userData, void (\*callback)(void\* userData)) | Registers a callback to be invoked when the specifiedcustom dialog box appears. | 467| int32_t [OH_ArkUI_CustomDialog_RegisterOnWillDisappearCallback](#oh_arkui_customdialog_registeronwilldisappearcallback) ([ArkUI_CustomDialogOptions](#arkui_customdialogoptions) \*options, void\* userData, void (\*callback)(void\* userData)) | Registers a callback to be invoked when the specified custom dialog box is about to disappear. | 468| int32_t [OH_ArkUI_CustomDialog_RegisterOnDidDisappearCallback](#oh_arkui_customdialog_registerondiddisappearcallback) ([ArkUI_CustomDialogOptions](#arkui_customdialogoptions) \*options, void\* userData, void (\*callback)(void\* userData)) | Registers a callback to be invoked when the specified custom dialog box disappears. | 469| bool [OH_ArkUI_GestureInterruptInfo_GetSystemFlag](#oh_arkui_gestureinterruptinfo_getsystemflag) (const ArkUI_GestureInterruptInfo \*event) | Checks whether a gesture is a built-in gesture of the component. | 470| ArkUI_GestureRecognizer \* [OH_ArkUI_GestureInterruptInfo_GetRecognizer](#oh_arkui_gestureinterruptinfo_getrecognizer) (const ArkUI_GestureInterruptInfo \*event) | Obtains the pointer to interrupted gesture recognizer. | 471| ArkUI_GestureEvent \* [OH_ArkUI_GestureInterruptInfo_GetGestureEvent](#oh_arkui_gestureinterruptinfo_getgestureevent) (const ArkUI_GestureInterruptInfo \*event) | Obtains the pointer to the interrupted gesture event. | 472| int32_t [OH_ArkUI_GestureInterruptInfo_GetSystemRecognizerType](#oh_arkui_gestureinterruptinfo_getsystemrecognizertype) (const ArkUI_GestureInterruptInfo \*event) | Obtains the type of the system gesture to trigger. | 473| int32_t [OH_ArkUI_GestureInterruptInfo_GetTouchRecognizers](#oh_arkui_gestureinterruptinfo_gettouchrecognizers) (const ArkUI_GestureInterruptInfo \*info, ArkUI_TouchRecognizerHandleArray\* recognizers, int32_t\* size) | Obtains touch recognizers from gesture interruption information. | 474| int32_t [OH_ArkUI_TouchRecognizer_GetNodeHandle](#oh_arkui_touchrecognizer_getnodehandle) (const ArkUI_TouchRecognizerHandle recognizer) | Obtains the component handle corresponding to a touch recognizer. | 475| int32_t [OH_ArkUI_TouchRecognizer_CancelTouch](#oh_arkui_touchrecognizer_canceltouch) (ArkUI_TouchRecognizerHandle recognizer, ArkUI_GestureInterruptInfo\* info) | Sends a cancel touch event to a touch recognizer in a gesture interruption callback. | 476| [ArkUI_GestureEventActionType](#arkui_gestureeventactiontype) [OH_ArkUI_GestureEvent_GetActionType](#oh_arkui_gestureevent_getactiontype) (const ArkUI_GestureEvent \*event) | Obtains the gesture event type. | 477| [ArkUI_NodeHandle](#arkui_nodehandle) [OH_ArkUI_GestureEvent_GetResponseNode](#oh_arkui_gestureevent_getresponsenode) (ArkUI_GestureEvent \*event) | Obtains the node that responds to the gesture. | 478| const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \* [OH_ArkUI_GestureEvent_GetRawInputEvent](#oh_arkui_gestureevent_getrawinputevent) (const ArkUI_GestureEvent \*event) | Obtains gesture input. | 479| int32_t [OH_ArkUI_LongPress_GetRepeatCount](#oh_arkui_longpress_getrepeatcount) (const ArkUI_GestureEvent \*event) | Obtains the number of times that a long press gesture is triggered periodically. | 480| float [OH_ArkUI_PanGesture_GetVelocity](#oh_arkui_pangesture_getvelocity) (const ArkUI_GestureEvent \*event) | Obtains the velocity of a pan gesture along the main axis. | 481| float [OH_ArkUI_PanGesture_GetVelocityX](#oh_arkui_pangesture_getvelocityx) (const ArkUI_GestureEvent \*event) | Obtains the velocity of a pan gesture along the x-axis. | 482| float [OH_ArkUI_PanGesture_GetVelocityY](#oh_arkui_pangesture_getvelocityy) (const ArkUI_GestureEvent \*event) | Obtains the velocity of a pan gesture along the y-axis. | 483| float [OH_ArkUI_PanGesture_GetOffsetX](#oh_arkui_pangesture_getoffsetx) (const ArkUI_GestureEvent \*event) | Obtains the relative offset of a pan gesture along the x-axis. | 484| float [OH_ArkUI_PanGesture_GetOffsetY](#oh_arkui_pangesture_getoffsety) (const ArkUI_GestureEvent \*event) | Obtains the relative offset of a pan gesture along the y-axis. | 485| float [OH_ArkUI_SwipeGesture_GetAngle](#oh_arkui_swipegesture_getangle) (const ArkUI_GestureEvent \*event) | Obtains the angle information of the swipe gesture. | 486| float [OH_ArkUI_SwipeGesture_GetVelocity](#oh_arkui_swipegesture_getvelocity) (const ArkUI_GestureEvent \*event) | Obtains the average velocity of all fingers used in the swipe gesture. | 487| float [OH_ArkUI_RotationGesture_GetAngle](#oh_arkui_rotationgesture_getangle) (const ArkUI_GestureEvent \*event) | Obtains the angle information of a rotation gesture. | 488| float [OH_ArkUI_PinchGesture_GetScale](#oh_arkui_pinchgesture_getscale) (const ArkUI_GestureEvent \*event) | Obtains the scale ratio of a pinch gesture. | 489| float [OH_ArkUI_PinchGesture_GetCenterX](#oh_arkui_pinchgesture_getcenterx) (const ArkUI_GestureEvent \*event) | Obtains the X coordinate of the center of the pinch gesture, in vp, relative to the upper left corner of the current component. | 490| float [OH_ArkUI_PinchGesture_GetCenterY](#oh_arkui_pinchgesture_getcentery) (const ArkUI_GestureEvent \*event) | Obtains the Y coordinate of the center of the pinch gesture, in vp, relative to the upper left corner of the current component. | 491| [ArkUI_NodeHandle](#arkui_nodehandle) [OH_ArkUI_GestureEvent_GetNode](#oh_arkui_gestureevent_getnode) (const ArkUI_GestureEvent \*event) | Obtains the ArkUI component to which the gesture is bound. | 492| int32_t [OH_ArkUI_GetResponseRecognizersFromInterruptInfo](#oh_arkui_getresponserecognizersfrominterruptinfo) (const ArkUI_GestureInterruptInfo \*event, [ArkUI_GestureRecognizerHandleArray](#arkui_gesturerecognizerhandlearray) \*responseChain, int32_t \*count) | Obtains information about a gesture response chain. | 493| int32_t [OH_ArkUI_SetGestureRecognizerEnabled](#oh_arkui_setgesturerecognizerenabled) (ArkUI_GestureRecognizer \*recognizer, bool enabled) | Sets the enabled state of a gesture recognizer. | 494| int32_t(\* [OH_ArkUI_SetGestureRecognizerLimitFingerCount](#oh_arkui_setgesturerecognizerlimitfingercount) )(ArkUI_GestureRecognizer \*recognizer, bool limitFingerCount) | Sets whether to check the number of fingers touching the screen. | 495| bool [OH_ArkUI_GetGestureRecognizerEnabled](#oh_arkui_getgesturerecognizerenabled) (ArkUI_GestureRecognizer \*recognizer) | Obtains the enabled state of a gesture recognizer. | 496| int32_t [OH_ArkUI_GetGestureRecognizerState](#oh_arkui_getgesturerecognizerstate) (ArkUI_GestureRecognizer \*recognizer, [ArkUI_GestureRecognizerState](#arkui_gesturerecognizerstate) \*state) | Obtains the state of a gesture recognizer. | 497| int32_t [OH_ArkUI_GetGestureEventTargetInfo](#oh_arkui_getgestureeventtargetinfo) (ArkUI_GestureRecognizer \*recognizer, [ArkUI_GestureEventTargetInfo](#arkui_gestureeventtargetinfo) \*\*info) | Obtains the information about a gesture event target. | 498| int32_t [OH_ArkUI_GestureEventTargetInfo_IsScrollBegin](#oh_arkui_gestureeventtargetinfo_isscrollbegin) ([ArkUI_GestureEventTargetInfo](#arkui_gestureeventtargetinfo) \*info, bool \*ret) | Obtains whether this scroll container is scrolled to the top. | 499| int32_t [OH_ArkUI_GestureEventTargetInfo_IsScrollEnd](#oh_arkui_gestureeventtargetinfo_isscrollend) ([ArkUI_GestureEventTargetInfo](#arkui_gestureeventtargetinfo) \*info, bool \*ret) | Obtains whether this scroll container is scrolled to the bottom. | 500| int32_t [OH_ArkUI_GetPanGestureDirectionMask](#oh_arkui_getpangesturedirectionmask) (ArkUI_GestureRecognizer \*recognizer, [ArkUI_GestureDirectionMask](#arkui_gesturedirectionmask) \*directionMask) | Obtains the direction of a pan gesture. | 501| bool [OH_ArkUI_IsBuiltInGesture](#oh_arkui_isbuiltingesture) (ArkUI_GestureRecognizer \*recognizer) | Obtains whether a gesture is a built-in gesture. | 502| int32_t [OH_ArkUI_GetGestureTag](#oh_arkui_getgesturetag) (ArkUI_GestureRecognizer \*recognizer, char \*buffer, int32_t bufferSize, int32_t \*result) | Obtains the tag of a gesture recognizer. | 503| int32_t [OH_ArkUI_GetGestureBindNodeId](#oh_arkui_getgesturebindnodeid) (ArkUI_GestureRecognizer \*recognizer, char \*nodeId, int32_t size, int32_t \*result) | Obtains the ID of the component linked to a gesture recognizer. | 504| bool [OH_ArkUI_IsGestureRecognizerValid](#oh_arkui_isgesturerecognizervalid) (ArkUI_GestureRecognizer \*recognizer) | Obtains whether a gesture recognizer is valid. | 505| void \* [OH_ArkUI_ParallelInnerGestureEvent_GetUserData](#oh_arkui_parallelinnergestureevent_getuserdata) ([ArkUI_ParallelInnerGestureEvent](#arkui_parallelinnergestureevent) \*event) | Obtains custom data in the parallel internal gesture event. | 506| void* [OH_ArkUI_GestureInterrupter_GetUserData](#oh_arkui_gestureinterrupter_getuserdata) ([ArkUI_GestureInterruptInfo](#arkui_gestureinterruptinfo)* event) | Obtains the custom data from a gesture interruption event.| 507| ArkUI_GestureRecognizer \* [OH_ArkUI_ParallelInnerGestureEvent_GetCurrentRecognizer](#oh_arkui_parallelinnergestureevent_getcurrentrecognizer) ([ArkUI_ParallelInnerGestureEvent](#arkui_parallelinnergestureevent) \*event) | Obtains the current gesture recognizer in a parallel internal gesture event. | 508| int32_t [OH_ArkUI_ParallelInnerGestureEvent_GetConflictRecognizers](#oh_arkui_parallelinnergestureevent_getconflictrecognizers) ([ArkUI_ParallelInnerGestureEvent](#arkui_parallelinnergestureevent) \*event, [ArkUI_GestureRecognizerHandleArray](#arkui_gesturerecognizerhandlearray) \*array, int32_t \*size) | Obtains the conflicting gesture recognizers in a parallel internal gesture event. | 509| int32_t [OH_ArkUI_SetArkUIGestureRecognizerDisposeNotify](#oh_arkui_setarkuigesturerecognizerdisposenotify) (ArkUI_GestureRecognizer \*recognizer, [ArkUI_GestureRecognizerDestructNotifyCallback](#arkui_gesturerecognizerdestructnotifycallback) callback, void \*userData) | Sets a callback function for notifying gesture recognizer destruction. | 510| void \* [OH_ArkUI_QueryModuleInterfaceByName](#oh_arkui_querymoduleinterfacebyname) ([ArkUI_NativeAPIVariantKind](#arkui_nativeapivariantkind) type, const char \*structName) | Obtains the native API set of a specified type. | 511| [ArkUI_KeyEventType](#arkui_keyeventtype) [OH_ArkUI_KeyEvent_GetType](#oh_arkui_keyevent_gettype) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the type of a key event. | 512| int32_t [OH_ArkUI_KeyEvent_GetKeyCode](#oh_arkui_keyevent_getkeycode) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the key code from a key event. | 513| const char \* [OH_ArkUI_KeyEvent_GetKeyText](#oh_arkui_keyevent_getkeytext) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the key value from a key event. | 514| [ArkUI_KeySourceType](#arkui_keysourcetype) [OH_ArkUI_KeyEvent_GetKeySource](#oh_arkui_keyevent_getkeysource) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the type of input device that triggers a key event. | 515| void [OH_ArkUI_KeyEvent_StopPropagation](#oh_arkui_keyevent_stoppropagation) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, bool stopPropagation) | Stops a key event from bubbling upwards or downwards. | 516| 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) | Dispatches a key event to a specific node. | 517| [ArkUI_KeyIntension](#arkui_keyintension) [OH_ArkUI_KeyEvent_GetKeyIntensionCode](#oh_arkui_keyevent_getkeyintensioncode) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the intention code associated with a key event. | 518| uint32_t [OH_ArkUI_KeyEvent_GetUnicode](#oh_arkui_keyevent_getunicode) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event) | Obtains the Unicode value of a key event. Non-space basic Latin characters in the 0x0021-0x007E range are supported. Characters with a value of 0 are not supported. In the case of key combination, this API returns the Unicode value of the key corresponding to the key event. | 519| void [OH_ArkUI_KeyEvent_SetConsumed](#oh_arkui_keyevent_setconsumed) (const [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \*event, bool isConsumed) | Sets whether a key event is consumed in the key event callback. | 520| [ArkUI_NodeEventType](#arkui_nodeeventtype) [OH_ArkUI_NodeEvent_GetEventType](#oh_arkui_nodeevent_geteventtype) ([ArkUI_NodeEvent](#arkui_nodeevent-12) \*event) | Obtains the type of a component event. | 521| int32_t [OH_ArkUI_NodeEvent_GetTargetId](#oh_arkui_nodeevent_gettargetid) ([ArkUI_NodeEvent](#arkui_nodeevent-12) \*event) | Obtains the custom ID of a component event. | 522| [ArkUI_NodeHandle](#arkui_nodehandle) [OH_ArkUI_NodeEvent_GetNodeHandle](#oh_arkui_nodeevent_getnodehandle) ([ArkUI_NodeEvent](#arkui_nodeevent-12) \*event) | Obtains the component object that triggers an event. | 523| [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent) \* [OH_ArkUI_NodeEvent_GetInputEvent](#oh_arkui_nodeevent_getinputevent) ([ArkUI_NodeEvent](#arkui_nodeevent-12) \*event) | Obtains input event (for example, touch event) data for a component event. | 524| [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) \* [OH_ArkUI_NodeEvent_GetNodeComponentEvent](#oh_arkui_nodeevent_getnodecomponentevent) ([ArkUI_NodeEvent](#arkui_nodeevent-12) \*event) | Obtains the numerical data in a component event. | 525| [ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md) \* [OH_ArkUI_NodeEvent_GetStringAsyncEvent](#oh_arkui_nodeevent_getstringasyncevent) ([ArkUI_NodeEvent](#arkui_nodeevent-12) \*event) | Obtains the string data in a component event. | 526| void \* [OH_ArkUI_NodeEvent_GetUserData](#oh_arkui_nodeevent_getuserdata) ([ArkUI_NodeEvent](#arkui_nodeevent-12) \*event) | Obtains the custom data in a component event. | 527| 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) | Obtains the numeric-type parameter of a component event. | 528| int32_t [OH_ArkUI_NodeEvent_GetStringValue](#oh_arkui_nodeevent_getstringvalue) ([ArkUI_NodeEvent](#arkui_nodeevent-12) \*event, int32_t index, char \*\*string, int32_t \*stringSize) | Obtains the string-type parameter of a component event. The string data is valid only during an event callback. To use it outside an event callback, you are advised to copy the string data. | 529| 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) | Sets the return value for a component event. | 530| [ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) [OH_ArkUI_NodeAdapter_Create](#oh_arkui_nodeadapter_create) () | Creates a component adapter. | 531| void [OH_ArkUI_NodeAdapter_Dispose](#oh_arkui_nodeadapter_dispose) ([ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) handle) | Destroys a component adapter. | 532| int32_t [OH_ArkUI_NodeAdapter_SetTotalNodeCount](#oh_arkui_nodeadapter_settotalnodecount) ([ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) handle, uint32_t size) | Sets the total number of elements in the specified adapter. | 533| uint32_t [OH_ArkUI_NodeAdapter_GetTotalNodeCount](#oh_arkui_nodeadapter_gettotalnodecount) ([ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) handle) | Obtains the total number of elements in the specified adapter. | 534| int32_t [OH_ArkUI_NodeAdapter_RegisterEventReceiver](#oh_arkui_nodeadapter_registereventreceiver) ([ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) handle, void \*userData, void(\*receiver)([ArkUI_NodeAdapterEvent](#arkui_nodeadapterevent) \*event)) | Registers an event callback for the specified adapter. | 535| void [OH_ArkUI_NodeAdapter_UnregisterEventReceiver](#oh_arkui_nodeadapter_unregistereventreceiver) ([ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) handle) | Unregisters an event callback for the specified adapter. | 536| int32_t [OH_ArkUI_NodeAdapter_ReloadAllItems](#oh_arkui_nodeadapter_reloadallitems) ([ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) handle) | Instructs the specified adapter to reload all elements. | 537| int32_t [OH_ArkUI_NodeAdapter_ReloadItem](#oh_arkui_nodeadapter_reloaditem) ([ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) handle, uint32_t startPosition, uint32_t itemCount) | Instructs the specified adapter to reload certain elements. | 538| int32_t [OH_ArkUI_NodeAdapter_RemoveItem](#oh_arkui_nodeadapter_removeitem) ([ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) handle, uint32_t startPosition, uint32_t itemCount) | Instructs the specified adapter to remove certain elements. | 539| int32_t [OH_ArkUI_NodeAdapter_InsertItem](#oh_arkui_nodeadapter_insertitem) ([ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) handle, uint32_t startPosition, uint32_t itemCount) | Instructs the specified adapter to insert certain elements. | 540| int32_t [OH_ArkUI_NodeAdapter_MoveItem](#oh_arkui_nodeadapter_moveitem) ([ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) handle, uint32_t from, uint32_t to) | Instructs the specified adapter to move certain elements. | 541| int32_t [OH_ArkUI_NodeAdapter_GetAllItems](#oh_arkui_nodeadapter_getallitems) ([ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) handle, [ArkUI_NodeHandle](#arkui_nodehandle) \*\*items, uint32_t \*size) | Obtains all elements stored in the specified adapter. | 542| void \* [OH_ArkUI_NodeAdapterEvent_GetUserData](#oh_arkui_nodeadapterevent_getuserdata) ([ArkUI_NodeAdapterEvent](#arkui_nodeadapterevent) \*event) | Obtains the custom data passed in during registration of the specified event. | 543| [ArkUI_NodeAdapterEventType](#arkui_nodeadaptereventtype) [OH_ArkUI_NodeAdapterEvent_GetType](#oh_arkui_nodeadapterevent_gettype) ([ArkUI_NodeAdapterEvent](#arkui_nodeadapterevent) \*event) | Obtains the event type. | 544| [ArkUI_NodeHandle](#arkui_nodehandle) [OH_ArkUI_NodeAdapterEvent_GetRemovedNode](#oh_arkui_nodeadapterevent_getremovednode) ([ArkUI_NodeAdapterEvent](#arkui_nodeadapterevent) \*event) | Obtains the element to be removed for the event to be destroyed. | 545| uint32_t [OH_ArkUI_NodeAdapterEvent_GetItemIndex](#oh_arkui_nodeadapterevent_getitemindex) ([ArkUI_NodeAdapterEvent](#arkui_nodeadapterevent) \*event) | Obtains the index of the element to be operated for the specified adapter event. | 546| [ArkUI_NodeHandle](#arkui_nodehandle) [OH_ArkUI_NodeAdapterEvent_GetHostNode](#oh_arkui_nodeadapterevent_gethostnode) ([ArkUI_NodeAdapterEvent](#arkui_nodeadapterevent) \*event) | Obtains the scrollable container node that uses the specified adapter. | 547| int32_t [OH_ArkUI_NodeAdapterEvent_SetItem](#oh_arkui_nodeadapterevent_setitem) ([ArkUI_NodeAdapterEvent](#arkui_nodeadapterevent) \*event, [ArkUI_NodeHandle](#arkui_nodehandle) node) | Sets the component to be added to the specified adapter. | 548| int32_t [OH_ArkUI_NodeAdapterEvent_SetNodeId](#oh_arkui_nodeadapterevent_setnodeid) ([ArkUI_NodeAdapterEvent](#arkui_nodeadapterevent) \*event, int32_t id) | Sets the component ID to be generated. | 549| [ArkUI_LayoutConstraint](#arkui_layoutconstraint) \* [OH_ArkUI_NodeCustomEvent_GetLayoutConstraintInMeasure](#oh_arkui_nodecustomevent_getlayoutconstraintinmeasure) ([ArkUI_NodeCustomEvent](#arkui_nodecustomevent) \*event) | Obtains the size constraint for measurement through a custom component event. | 550| [ArkUI_IntOffset](_ark_u_i___int_offset.md) [OH_ArkUI_NodeCustomEvent_GetPositionInLayout](#oh_arkui_nodecustomevent_getpositioninlayout) ([ArkUI_NodeCustomEvent](#arkui_nodecustomevent) \*event) | Obtains the expected position of a component relative to its parent component in the layout phase through a custom component event. | 551| [ArkUI_DrawContext](#arkui_drawcontext) \* [OH_ArkUI_NodeCustomEvent_GetDrawContextInDraw](#oh_arkui_nodecustomevent_getdrawcontextindraw) ([ArkUI_NodeCustomEvent](#arkui_nodecustomevent) \*event) | Obtains the drawing context through a custom component event. | 552| int32_t [OH_ArkUI_NodeCustomEvent_GetEventTargetId](#oh_arkui_nodecustomevent_geteventtargetid) ([ArkUI_NodeCustomEvent](#arkui_nodecustomevent) \*event) | Obtains the ID of a custom component event. | 553| void \* [OH_ArkUI_NodeCustomEvent_GetUserData](#oh_arkui_nodecustomevent_getuserdata) ([ArkUI_NodeCustomEvent](#arkui_nodecustomevent) \*event) | Obtains custom event parameters through a custom component event. | 554| [ArkUI_NodeHandle](#arkui_nodehandle) [OH_ArkUI_NodeCustomEvent_GetNodeHandle](#oh_arkui_nodecustomevent_getnodehandle) ([ArkUI_NodeCustomEvent](#arkui_nodecustomevent) \*event) | Obtains a component object through a custom component event. | 555| [ArkUI_NodeCustomEventType](#arkui_nodecustomeventtype) [OH_ArkUI_NodeCustomEvent_GetEventType](#oh_arkui_nodecustomevent_geteventtype) ([ArkUI_NodeCustomEvent](#arkui_nodecustomevent) \*event) | Obtains the event type through a custom component event. | 556| int32_t [OH_ArkUI_NodeCustomEvent_GetCustomSpanMeasureInfo](#oh_arkui_nodecustomevent_getcustomspanmeasureinfo) ([ArkUI_NodeCustomEvent](#arkui_nodecustomevent) \*event, [ArkUI_CustomSpanMeasureInfo](#arkui_customspanmeasureinfo) \*info) | Obtains the measurement information of a custom span through a custom component event. | 557| int32_t [OH_ArkUI_NodeCustomEvent_SetCustomSpanMetrics](#oh_arkui_nodecustomevent_setcustomspanmetrics) ([ArkUI_NodeCustomEvent](#arkui_nodecustomevent) \*event, [ArkUI_CustomSpanMetrics](#arkui_customspanmetrics) \*metrics) | Sets the measurement metrics of a custom span through a custom component event. | 558| int32_t [OH_ArkUI_NodeCustomEvent_GetCustomSpanDrawInfo](#oh_arkui_nodecustomevent_getcustomspandrawinfo) ([ArkUI_NodeCustomEvent](#arkui_nodecustomevent) \*event, [ArkUI_CustomSpanDrawInfo](#arkui_customspandrawinfo) \*info) | Obtains the drawing information of a custom span through a custom component event. | 559| int32_t [OH_ArkUI_NodeContent_RegisterCallback](#oh_arkui_nodecontent_registercallback) ([ArkUI_NodeContentHandle](#arkui_nodecontenthandle) content, [ArkUI_NodeContentCallback](#arkui_nodecontentcallback) callback) | Registers the callback for the NodeContent event. | 560| [ArkUI_NodeContentEventType](#arkui_nodecontenteventtype) [OH_ArkUI_NodeContentEvent_GetEventType](#oh_arkui_nodecontentevent_geteventtype) ([ArkUI_NodeContentEvent](#arkui_nodecontentevent) \*event) | Obtains the type of the specified NodeContent event. | 561| [ArkUI_NodeContentHandle](#arkui_nodecontenthandle) [OH_ArkUI_NodeContentEvent_GetNodeContentHandle](#oh_arkui_nodecontentevent_getnodecontenthandle) ([ArkUI_NodeContentEvent](#arkui_nodecontentevent) \*event) | Obtains the object that triggers the specified NodeContent event. | 562| int32_t [OH_ArkUI_NodeContent_SetUserData](#oh_arkui_nodecontent_setuserdata) ([ArkUI_NodeContentHandle](#arkui_nodecontenthandle) content, void \*userData) | Saves custom data to the specified NodeContent object. | 563| void \* [OH_ArkUI_NodeContent_GetUserData](#oh_arkui_nodecontent_getuserdata) ([ArkUI_NodeContentHandle](#arkui_nodecontenthandle) content) | Obtains the custom data saved on the specified NodeContent object. | 564| int32_t [OH_ArkUI_NodeContent_AddNode](#oh_arkui_nodecontent_addnode) ([ArkUI_NodeContentHandle](#arkui_nodecontenthandle) content, [ArkUI_NodeHandle](#arkui_nodehandle) node) | Adds an ArkUI component node to the specified NodeContent object. | 565| int32_t [OH_ArkUI_NodeContent_RemoveNode](#oh_arkui_nodecontent_removenode) ([ArkUI_NodeContentHandle](#arkui_nodecontenthandle) content, [ArkUI_NodeHandle](#arkui_nodehandle) node) | Removes an ArkUI component node from the specified NodeContent object. | 566| int32_t [OH_ArkUI_NodeContent_InsertNode](#oh_arkui_nodecontent_insertnode) ([ArkUI_NodeContentHandle](#arkui_nodecontenthandle) content, [ArkUI_NodeHandle](#arkui_nodehandle) node, int32_t position) | Inserts an ArkUI component node into a specific position of the specified NodeContent object. | 567| int32_t [OH_ArkUI_NodeUtils_GetLayoutSize](#oh_arkui_nodeutils_getlayoutsize) ([ArkUI_NodeHandle](#arkui_nodehandle) node, [ArkUI_IntSize](_ark_u_i___int_size.md) \*size) | Obtains the layout area size of a component. The size does not count in transformation attributes, such as scale. | 568| int32_t [OH_ArkUI_NodeUtils_GetLayoutPosition](#oh_arkui_nodeutils_getlayoutposition) ([ArkUI_NodeHandle](#arkui_nodehandle) node, [ArkUI_IntOffset](_ark_u_i___int_offset.md) \*localOffset) | Obtains the position of the component's layout area relative to its parent component. The relative position does not count in transformation attributes, such as translate. | 569| int32_t [OH_ArkUI_NodeUtils_GetLayoutPositionInWindow](#oh_arkui_nodeutils_getlayoutpositioninwindow) ([ArkUI_NodeHandle](#arkui_nodehandle) node, [ArkUI_IntOffset](_ark_u_i___int_offset.md) \*globalOffset) | Obtains the position of the component's layout area relative to the window. The relative position does not count in transformation attributes, such as translate. | 570| int32_t [OH_ArkUI_NodeUtils_GetLayoutPositionInScreen](#oh_arkui_nodeutils_getlayoutpositioninscreen) ([ArkUI_NodeHandle](#arkui_nodehandle) node, [ArkUI_IntOffset](_ark_u_i___int_offset.md) \*screenOffset) | Obtains the position of the component's layout area relative to the screen. The relative position does not count in transformation attributes, such as translate. | 571| int32_t [OH_ArkUI_NodeUtils_GetPositionWithTranslateInWindow](#oh_arkui_nodeutils_getpositionwithtranslateinwindow) ([ArkUI_NodeHandle](#arkui_nodehandle) node, [ArkUI_IntOffset](_ark_u_i___int_offset.md) \*translateOffset) | Obtains the position of the component in the window, including the translate attribute. | 572| int32_t [OH_ArkUI_NodeUtils_GetPositionWithTranslateInScreen](#oh_arkui_nodeutils_getpositionwithtranslateinscreen) ([ArkUI_NodeHandle](#arkui_nodehandle) node, [ArkUI_IntOffset](_ark_u_i___int_offset.md) \*translateOffset) | Obtains the position of the component on the screen, including the translate attribute. | 573| void [OH_ArkUI_NodeUtils_AddCustomProperty](#oh_arkui_nodeutils_addcustomproperty) ([ArkUI_NodeHandle](#arkui_nodehandle) node, const char \*name, const char \*value) | Sets a custom property for this component. This API takes effect only in the main thread. | 574| void [OH_ArkUI_NodeUtils_RemoveCustomProperty](#oh_arkui_nodeutils_removecustomproperty) ([ArkUI_NodeHandle](#arkui_nodehandle) node, const char \*name) | Removes a custom property that has been set for the specified component. | 575| int32_t [OH_ArkUI_NodeUtils_GetCustomProperty](#oh_arkui_nodeutils_getcustomproperty) ([ArkUI_NodeHandle](#arkui_nodehandle) node, const char \*name, ArkUI_CustomProperty \*\*handle) | Obtains the value of a custom property of the specified component. | 576| [ArkUI_NodeHandle](#arkui_nodehandle) [OH_ArkUI_NodeUtils_GetParentInPageTree](#oh_arkui_nodeutils_getparentinpagetree) ([ArkUI_NodeHandle](#arkui_nodehandle) node) | Obtains the parent node, which can be a component node created with ArkTS. | 577| int32_t [OH_ArkUI_NodeUtils_GetActiveChildrenInfo](#oh_arkui_nodeutils_getactivechildreninfo) ([ArkUI_NodeHandle](#arkui_nodehandle) head, ArkUI_ActiveChildrenInfo \*\*handle) | Obtains all active child nodes of the specified node. Spans are not counted as child nodes. | 578| [ArkUI_NodeHandle](#arkui_nodehandle) [OH_ArkUI_NodeUtils_GetCurrentPageRootNode](#oh_arkui_nodeutils_getcurrentpagerootnode) ([ArkUI_NodeHandle](#arkui_nodehandle) node) | Obtains the root node of the current page. | 579| bool [OH_ArkUI_NodeUtils_IsCreatedByNDK](#oh_arkui_nodeutils_iscreatedbyndk) ([ArkUI_NodeHandle](#arkui_nodehandle) node) | Checks whether the specified component is created with the C API. | 580| int32_t [OH_ArkUI_NodeUtils_GetNodeType](#oh_arkui_nodeutils_getnodetype) ([ArkUI_NodeHandle](#arkui_nodehandle) node) | Obtains the type of the specified node. | 581| int32_t [OH_ArkUI_List_CloseAllSwipeActions](#oh_arkui_list_closeallswipeactions) ([ArkUI_NodeHandle](#arkui_nodehandle) node, void \*userData, void(\*onFinish)(void \*userData)) | Collapses the list items in the expanded state. | 582| [ArkUI_ContextHandle](#arkui_contexthandle-12) [OH_ArkUI_GetContextByNode](#oh_arkui_getcontextbynode) ([ArkUI_NodeHandle](#arkui_nodehandle) node) | Obtains the pointer to the UI context object of the specified node. | 583| int32_t [OH_ArkUI_RegisterSystemColorModeChangeEvent](#oh_arkui_registersystemcolormodechangeevent) ([ArkUI_NodeHandle](#arkui_nodehandle) node, void \*userData, void(\*onColorModeChange)([ArkUI_SystemColorMode](#arkui_systemcolormode) colorMode, void \*userData)) | Registers an event listener for system color mode changes. A single component can only register one callback for system color mode changes. | 584| void [OH_ArkUI_UnregisterSystemColorModeChangeEvent](#oh_arkui_unregistersystemcolormodechangeevent) ([ArkUI_NodeHandle](#arkui_nodehandle) node) | Unregisters the event listener for system color mode changes. | 585| int32_t [OH_ArkUI_RegisterSystemFontStyleChangeEvent](#oh_arkui_registersystemfontstylechangeevent) ([ArkUI_NodeHandle](#arkui_nodehandle) node, void \*userData, void(\*onFontStyleChange)([ArkUI_SystemFontStyleEvent](#arkui_systemfontstyleevent) \*event, void \*userData)) | Registers an event listener for system font style changes. A single component can only register one callback for system font style changes. | 586| void [OH_ArkUI_UnregisterSystemFontStyleChangeEvent](#oh_arkui_unregistersystemfontstylechangeevent) ([ArkUI_NodeHandle](#arkui_nodehandle) node) | Unregisters the event listener for system font style changes. | 587| float [OH_ArkUI_SystemFontStyleEvent_GetFontSizeScale](#oh_arkui_systemfontstyleevent_getfontsizescale) (const [ArkUI_SystemFontStyleEvent](#arkui_systemfontstyleevent) \*event) | Obtains the font size from the system font style change event. | 588| float [OH_ArkUI_SystemFontStyleEvent_GetFontWeightScale](#oh_arkui_systemfontstyleevent_getfontweightscale) (const [ArkUI_SystemFontStyleEvent](#arkui_systemfontstyleevent) \*event) | Obtains the font weight from the system font style change event. | 589| int32_t [OH_ArkUI_GetNodeHandleFromNapiValue](#oh_arkui_getnodehandlefromnapivalue) (napi_env env, napi_value frameNode, [ArkUI_NodeHandle](#arkui_nodehandle) \*handle) | Obtains a **FrameNode** object on the ArkTS side and maps it to an **ArkUI_NodeHandle** object on the native side. | 590| int32_t [OH_ArkUI_GetContextFromNapiValue](#oh_arkui_getcontextfromnapivalue) (napi_env env, napi_value value, [ArkUI_ContextHandle](#arkui_contexthandle-12) \*context) | Obtains a **UIContext** object on the ArkTS side and maps it to an **ArkUI_ContextHandle** object on the native side. | 591| int32_t [OH_ArkUI_GetNodeContentFromNapiValue](#oh_arkui_getnodecontentfromnapivalue) (napi_env env, napi_value value, [ArkUI_NodeContentHandle](#arkui_nodecontenthandle) \*content) | Obtains a **NodeContent** object on the ArkTS side and maps it to an **ArkUI_NodeContentHandle** object on the native side. | 592| int32_t [OH_ArkUI_GetDrawableDescriptorFromNapiValue](#oh_arkui_getdrawabledescriptorfromnapivalue) (napi_env env, napi_value value, [ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) \*\*drawableDescriptor) | Maps a **DrawableDescriptor** object on the ArkTS side to an **ArkUI_DrawableDescriptor** object on the native side. | 593| int32_t [OH_ArkUI_GetDrawableDescriptorFromResourceNapiValue](#oh_arkui_getdrawabledescriptorfromresourcenapivalue) (napi_env env, napi_value value, [ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) \*\*drawableDescriptor) | Maps an $r resource object on the ArkTS side to an **ArkUI_DrawableDescriptor** object on the native side. | 594| [ArkUI_ErrorCode](#arkui_errorcode) [OH_ArkUI_GetNavigationId](#oh_arkui_getnavigationid) ([ArkUI_NodeHandle](#arkui_nodehandle) node, char \*buffer, int32_t bufferSize, int32_t \*writeLength) | Obtains the ID of the **Navigation** component where the specified node is located. | 595| [ArkUI_ErrorCode](#arkui_errorcode) [OH_ArkUI_GetNavDestinationName](#oh_arkui_getnavdestinationname) ([ArkUI_NodeHandle](#arkui_nodehandle) node, char \*buffer, int32_t bufferSize, int32_t \*writeLength) | Obtains the name of the **NavDestination** component where the specified node is located. | 596| [ArkUI_ErrorCode](#arkui_errorcode) [OH_ArkUI_GetNavStackLength](#oh_arkui_getnavstacklength) ([ArkUI_NodeHandle](#arkui_nodehandle) node, int32_t \*length) | Obtains the length of the navigation stack where the specified node is located. | 597| [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) | Obtains the page name that matches the specified index in the navigation stack where the specified node is located. The index starts from 0, which indicates the bottom of the stack. | 598| [ArkUI_ErrorCode](#arkui_errorcode) [OH_ArkUI_GetNavDestinationId](#oh_arkui_getnavdestinationid) ([ArkUI_NodeHandle](#arkui_nodehandle) node, char \*buffer, int32_t bufferSize, int32_t \*writeLength) | Obtains the ID of the **NavDestination** component where the specified node is located. | 599| [ArkUI_ErrorCode](#arkui_errorcode) [OH_ArkUI_GetNavDestinationState](#oh_arkui_getnavdestinationstate) ([ArkUI_NodeHandle](#arkui_nodehandle) node, [ArkUI_NavDestinationState](#arkui_navdestinationstate) \*state) | Obtains the state of the **NavDestination** component where the specified node is located. | 600| [ArkUI_ErrorCode](#arkui_errorcode) [OH_ArkUI_GetNavDestinationIndex](#oh_arkui_getnavdestinationindex) ([ArkUI_NodeHandle](#arkui_nodehandle) node, int32_t \*index) | Obtains the index of the **NavDestination** component where the specified node is located in the navigation stack. | 601| napi_value [OH_ArkUI_GetNavDestinationParam](#oh_arkui_getnavdestinationparam) ([ArkUI_NodeHandle](#arkui_nodehandle) node) | Obtains the parameters of the **NavDestination** component where the specified node is located. | 602| [ArkUI_ErrorCode](#arkui_errorcode) [OH_ArkUI_GetRouterPageIndex](#oh_arkui_getrouterpageindex) ([ArkUI_NodeHandle](#arkui_nodehandle) node, int32_t \*index) | Obtains the index of the page where the specified node is located in the page stack for routing. | 603| [ArkUI_ErrorCode](#arkui_errorcode) [OH_ArkUI_GetRouterPageName](#oh_arkui_getrouterpagename) ([ArkUI_NodeHandle](#arkui_nodehandle) node, char \*buffer, int32_t bufferSize, int32_t \*writeLength) | Obtains the name of the page where the specified node is located. | 604| [ArkUI_ErrorCode](#arkui_errorcode) [OH_ArkUI_GetRouterPagePath](#oh_arkui_getrouterpagepath) ([ArkUI_NodeHandle](#arkui_nodehandle) node, char \*buffer, int32_t bufferSize, int32_t \*writeLength) | Obtains the path to the page where the specified node is located. | 605| [ArkUI_ErrorCode](#arkui_errorcode) [OH_ArkUI_GetRouterPageState](#oh_arkui_getrouterpagestate) ([ArkUI_NodeHandle](#arkui_nodehandle) node, [ArkUI_RouterPageState](#arkui_routerpagestate) \*state) | Obtains the state of the page where the specified node is located. | 606| [ArkUI_ErrorCode](#arkui_errorcode) [OH_ArkUI_GetRouterPageId](#oh_arkui_getrouterpageid) ([ArkUI_NodeHandle](#arkui_nodehandle) node, char \*buffer, int32_t bufferSize, int32_t \*writeLength) | Obtains the ID of the page where the specified node is located. | 607| [ArkUI_LayoutConstraint](#arkui_layoutconstraint) \* [OH_ArkUI_LayoutConstraint_Create](#oh_arkui_layoutconstraint_create) () | Creates a size constraint. | 608| [ArkUI_LayoutConstraint](#arkui_layoutconstraint) \* [OH_ArkUI_LayoutConstraint_Copy](#oh_arkui_layoutconstraint_copy) (const [ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint) | Performs a deep copy of a size constraint. | 609| void \* [OH_ArkUI_LayoutConstraint_Dispose](#oh_arkui_layoutconstraint_dispose) ([ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint) | Disposes of the pointer to a size constraint. | 610| int32_t [OH_ArkUI_LayoutConstraint_GetMaxWidth](#oh_arkui_layoutconstraint_getmaxwidth) (const [ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint) | Obtains the maximum width for a size constraint, in px. | 611| int32_t [OH_ArkUI_LayoutConstraint_GetMinWidth](#oh_arkui_layoutconstraint_getminwidth) (const [ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint) | Obtains the minimum width for a size constraint, in px. | 612| int32_t [OH_ArkUI_LayoutConstraint_GetMaxHeight](#oh_arkui_layoutconstraint_getmaxheight) (const [ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint) | Obtains the maximum height for a size constraint, in px. | 613| int32_t [OH_ArkUI_LayoutConstraint_GetMinHeight](#oh_arkui_layoutconstraint_getminheight) (const [ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint) | Obtains the minimum height for a size constraint, in px. | 614| int32_t [OH_ArkUI_LayoutConstraint_GetPercentReferenceWidth](#oh_arkui_layoutconstraint_getpercentreferencewidth) (const [ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint) | Obtains the width percentage reference for a size constraint, in px. | 615| int32_t [OH_ArkUI_LayoutConstraint_GetPercentReferenceHeight](#oh_arkui_layoutconstraint_getpercentreferenceheight) (const [ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint) | Obtains the height percentage reference for a size constraint, in px. | 616| void [OH_ArkUI_LayoutConstraint_SetMaxWidth](#oh_arkui_layoutconstraint_setmaxwidth) ([ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint, int32_t value) | Sets the maximum width. | 617| void [OH_ArkUI_LayoutConstraint_SetMinWidth](#oh_arkui_layoutconstraint_setminwidth) ([ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint, int32_t value) | Sets the minimum width. | 618| void [OH_ArkUI_LayoutConstraint_SetMaxHeight](#oh_arkui_layoutconstraint_setmaxheight) ([ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint, int32_t value) | Sets the maximum height. | 619| void [OH_ArkUI_LayoutConstraint_SetMinHeight](#oh_arkui_layoutconstraint_setminheight) ([ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint, int32_t value) | Sets the minimum height. | 620| void [OH_ArkUI_LayoutConstraint_SetPercentReferenceWidth](#oh_arkui_layoutconstraint_setpercentreferencewidth) ([ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint, int32_t value) | Sets the width percentage reference. | 621| void [OH_ArkUI_LayoutConstraint_SetPercentReferenceHeight](#oh_arkui_layoutconstraint_setpercentreferenceheight) ([ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint, int32_t value) | Sets the height percentage reference. | 622| void \* [OH_ArkUI_DrawContext_GetCanvas](#oh_arkui_drawcontext_getcanvas) ([ArkUI_DrawContext](#arkui_drawcontext) \*context) | Obtains the pointer to a canvas for drawing, which can be converted into the **OH_Drawing_Canvas** in the **Drawing** module. | 623| [ArkUI_IntSize](_ark_u_i___int_size.md) [OH_ArkUI_DrawContext_GetSize](#oh_arkui_drawcontext_getsize) ([ArkUI_DrawContext](#arkui_drawcontext) \*context) | Obtains the size of a drawing area. | 624| [ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \* [OH_ArkUI_WaterFlowSectionOption_Create](#oh_arkui_waterflowsectionoption_create) () | Creates a water flow section configuration. | 625| void [OH_ArkUI_WaterFlowSectionOption_Dispose](#oh_arkui_waterflowsectionoption_dispose) ([ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \*option) | Disposes of the pointer to a water flow section configuration. | 626| void [OH_ArkUI_WaterFlowSectionOption_SetSize](#oh_arkui_waterflowsectionoption_setsize) ([ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \*option, int32_t size) | Sets the array length for a water flow section configuration. | 627| int32_t [OH_ArkUI_WaterFlowSectionOption_GetSize](#oh_arkui_waterflowsectionoption_getsize) ([ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \*option) | Sets the array length for a water flow section configuration. | 628| void [OH_ArkUI_WaterFlowSectionOption_SetItemCount](#oh_arkui_waterflowsectionoption_setitemcount) ([ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \*option, int32_t index, int32_t itemCount) | Sets the number of items in a water flow section. | 629| int32_t [OH_ArkUI_WaterFlowSectionOption_GetItemCount](#oh_arkui_waterflowsectionoption_getitemcount) ([ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \*option, int32_t index) | Obtains the number of items in the water flow section that matches the specified index. | 630| void [OH_ArkUI_WaterFlowSectionOption_SetCrossCount](#oh_arkui_waterflowsectionoption_setcrosscount) ([ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \*option, int32_t index, int32_t crossCount) | Sets the number of columns (in a vertical layout) or rows (in a horizontal layout) of a water flow. | 631| int32_t [OH_ArkUI_WaterFlowSectionOption_GetCrossCount](#oh_arkui_waterflowsectionoption_getcrosscount) ([ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \*option, int32_t index) | Obtains the number of columns (in a vertical layout) or rows (in a horizontal layout) of a water flow. | 632| void [OH_ArkUI_WaterFlowSectionOption_SetColumnGap](#oh_arkui_waterflowsectionoption_setcolumngap) ([ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \*, int32_t index, float columnGap) | Sets the gap between columns in the specified water flow section. | 633| float [OH_ArkUI_WaterFlowSectionOption_GetColumnGap](#oh_arkui_waterflowsectionoption_getcolumngap) ([ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \*option, int32_t index) | Obtains the gap between columns in the water flow section that matches the specified index. | 634| void [OH_ArkUI_WaterFlowSectionOption_SetRowGap](#oh_arkui_waterflowsectionoption_setrowgap) ([ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \*option, int32_t index, float rowGap) | Sets the gap between rows in the specified water flow section. | 635| float [OH_ArkUI_WaterFlowSectionOption_GetRowGap](#oh_arkui_waterflowsectionoption_getrowgap) ([ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \*option, int32_t index) | Obtains the gap between rows in the water flow section that matches the specified index. | 636| 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) | Sets the margins for the specified water flow section. | 637| [ArkUI_Margin](_ark_u_i___margin.md) [OH_ArkUI_WaterFlowSectionOption_GetMargin](#oh_arkui_waterflowsectionoption_getmargin) ([ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \*option, int32_t index) | Obtains the margins of the water flow section that matches the specified index. | 638| void [OH_ArkUI_WaterFlowSectionOption_RegisterGetItemMainSizeCallbackByIndex](#oh_arkui_waterflowsectionoption_registergetitemmainsizecallbackbyindex) ([ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \*option, int32_t index, float(\*callback)(int32_t itemIndex)) | Obtains the main axis size of a specified item based on **flowItemIndex** through a water flow section configuration. | 639| 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)) | Obtains the main axis size of a specified item based on **flowItemIndex** through a water flow section configuration. | 640| [ArkUI_GuidelineOption](#arkui_guidelineoption) \* [OH_ArkUI_GuidelineOption_Create](#oh_arkui_guidelineoption_create) (int32_t size) | Creates a guideline configuration for this **RelativeContainer** component. | 641| void [OH_ArkUI_GuidelineOption_Dispose](#oh_arkui_guidelineoption_dispose) ([ArkUI_GuidelineOption](#arkui_guidelineoption) \*guideline) | Disposes of a guideline configuration. | 642| void [OH_ArkUI_GuidelineOption_SetId](#oh_arkui_guidelineoption_setid) ([ArkUI_GuidelineOption](#arkui_guidelineoption) \*guideline, const char \*value, int32_t index) | Sets the ID of a guideline. | 643| void [OH_ArkUI_GuidelineOption_SetDirection](#oh_arkui_guidelineoption_setdirection) ([ArkUI_GuidelineOption](#arkui_guidelineoption) \*guideline, [ArkUI_Axis](#arkui_axis) value, int32_t index) | Sets the direction of a guideline. | 644| void [OH_ArkUI_GuidelineOption_SetPositionStart](#oh_arkui_guidelineoption_setpositionstart) ([ArkUI_GuidelineOption](#arkui_guidelineoption) \*guideline, float value, int32_t index) | Sets the distance between a guideline and the left or top of the container. | 645| void [OH_ArkUI_GuidelineOption_SetPositionEnd](#oh_arkui_guidelineoption_setpositionend) ([ArkUI_GuidelineOption](#arkui_guidelineoption) \*guideline, float value, int32_t index) | Sets the distance between a guideline and the right or bottom of the container. | 646| const char \* [OH_ArkUI_GuidelineOption_GetId](#oh_arkui_guidelineoption_getid) ([ArkUI_GuidelineOption](#arkui_guidelineoption) \*guideline, int32_t index) | Obtains the ID of a guideline. | 647| [ArkUI_Axis](#arkui_axis) [OH_ArkUI_GuidelineOption_GetDirection](#oh_arkui_guidelineoption_getdirection) ([ArkUI_GuidelineOption](#arkui_guidelineoption) \*guideline, int32_t index) | Obtains the direction of a guideline. | 648| float [OH_ArkUI_GuidelineOption_GetPositionStart](#oh_arkui_guidelineoption_getpositionstart) ([ArkUI_GuidelineOption](#arkui_guidelineoption) \*guideline, int32_t index) | Obtains the distance between a guideline and the left or top of the container. | 649| float [OH_ArkUI_GuidelineOption_GetPositionEnd](#oh_arkui_guidelineoption_getpositionend) ([ArkUI_GuidelineOption](#arkui_guidelineoption) \*guideline, int32_t index) | Obtains the distance between a guideline and the right or bottom of the container. | 650| [ArkUI_BarrierOption](#arkui_barrieroption) \* [OH_ArkUI_BarrierOption_Create](#oh_arkui_barrieroption_create) (int32_t size) | Creates a barrier configuration for this **RelativeContainer** component. | 651| void [OH_ArkUI_BarrierOption_Dispose](#oh_arkui_barrieroption_dispose) ([ArkUI_BarrierOption](#arkui_barrieroption) \*barrierStyle) | Disposes of a barrier configuration. | 652| void [OH_ArkUI_BarrierOption_SetId](#oh_arkui_barrieroption_setid) ([ArkUI_BarrierOption](#arkui_barrieroption) \*barrierStyle, const char \*value, int32_t index) | Sets the ID of a barrier. | 653| void [OH_ArkUI_BarrierOption_SetDirection](#oh_arkui_barrieroption_setdirection) ([ArkUI_BarrierOption](#arkui_barrieroption) \*barrierStyle, [ArkUI_BarrierDirection](#arkui_barrierdirection) value, int32_t index) | Sets the direction of a barrier. | 654| void [OH_ArkUI_BarrierOption_SetReferencedId](#oh_arkui_barrieroption_setreferencedid) ([ArkUI_BarrierOption](#arkui_barrieroption) \*barrierStyle, const char \*value, int32_t index) | Sets the referenced components of a barrier. | 655| const char \* [OH_ArkUI_BarrierOption_GetId](#oh_arkui_barrieroption_getid) ([ArkUI_BarrierOption](#arkui_barrieroption) \*barrierStyle, int32_t index) | Obtains the ID of a barrier. | 656| [ArkUI_BarrierDirection](#arkui_barrierdirection) [OH_ArkUI_BarrierOption_GetDirection](#oh_arkui_barrieroption_getdirection) ([ArkUI_BarrierOption](#arkui_barrieroption) \*barrierStyle, int32_t index) | Obtains the direction of a barrier. | 657| const char \* [OH_ArkUI_BarrierOption_GetReferencedId](#oh_arkui_barrieroption_getreferencedid) ([ArkUI_BarrierOption](#arkui_barrieroption) \*barrierStyle, int32_t index, int32_t referencedIndex) | Obtains the referenced components of a barrier. | 658| int32_t [OH_ArkUI_BarrierOption_GetReferencedIdSize](#oh_arkui_barrieroption_getreferencedidsize) ([ArkUI_BarrierOption](#arkui_barrieroption) \*barrierStyle, int32_t index) | Obtains the number of referenced components of a barrier. | 659| [ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \* [OH_ArkUI_AlignmentRuleOption_Create](#oh_arkui_alignmentruleoption_create) () | Creates an alignment rule configuration for this **RelativeContainer** component. | 660| void [OH_ArkUI_AlignmentRuleOption_Dispose](#oh_arkui_alignmentruleoption_dispose) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Disposes of an alignment rule configuration of this **RelativeContainer** component. | 661| void [OH_ArkUI_AlignmentRuleOption_SetStart](#oh_arkui_alignmentruleoption_setstart) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option, const char \*id, [ArkUI_HorizontalAlignment](#arkui_horizontalalignment) alignment) | Sets the left alignment parameters. | 662| void [OH_ArkUI_AlignmentRuleOption_SetEnd](#oh_arkui_alignmentruleoption_setend) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option, const char \*id, [ArkUI_HorizontalAlignment](#arkui_horizontalalignment) alignment) | Sets the right alignment parameters. | 663| void [OH_ArkUI_AlignmentRuleOption_SetCenterHorizontal](#oh_arkui_alignmentruleoption_setcenterhorizontal) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option, const char \*id, [ArkUI_HorizontalAlignment](#arkui_horizontalalignment) alignment) | Sets the horizontal center alignment parameters. | 664| void [OH_ArkUI_AlignmentRuleOption_SetTop](#oh_arkui_alignmentruleoption_settop) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option, const char \*id, [ArkUI_VerticalAlignment](#arkui_verticalalignment) alignment) | Sets the top alignment parameters. | 665| void [OH_ArkUI_AlignmentRuleOption_SetBottom](#oh_arkui_alignmentruleoption_setbottom) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option, const char \*id, [ArkUI_VerticalAlignment](#arkui_verticalalignment) alignment) | Sets the bottom alignment parameters. | 666| void [OH_ArkUI_AlignmentRuleOption_SetCenterVertical](#oh_arkui_alignmentruleoption_setcentervertical) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option, const char \*id, [ArkUI_VerticalAlignment](#arkui_verticalalignment) alignment) | Sets the vertical center alignment parameters. | 667| void [OH_ArkUI_AlignmentRuleOption_SetBiasHorizontal](#oh_arkui_alignmentruleoption_setbiashorizontal) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option, float horizontal) | Sets the bias value of the component in the horizontal direction under the anchor constraints. | 668| void [OH_ArkUI_AlignmentRuleOption_SetBiasVertical](#oh_arkui_alignmentruleoption_setbiasvertical) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option, float vertical) | Sets the bias value of the component in the vertical direction under the anchor constraints. | 669| const char \* [OH_ArkUI_AlignmentRuleOption_GetStartId](#oh_arkui_alignmentruleoption_getstartid) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the ID in the left alignment parameters. | 670| [ArkUI_HorizontalAlignment](#arkui_horizontalalignment) [OH_ArkUI_AlignmentRuleOption_GetStartAlignment](#oh_arkui_alignmentruleoption_getstartalignment) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the alignment mode in left alignment parameters. | 671| const char \* [OH_ArkUI_AlignmentRuleOption_GetEndId](#oh_arkui_alignmentruleoption_getendid) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the ID in the right alignment parameters. | 672| [ArkUI_HorizontalAlignment](#arkui_horizontalalignment) [OH_ArkUI_AlignmentRuleOption_GetEndAlignment](#oh_arkui_alignmentruleoption_getendalignment) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the ID in the right alignment parameters. | 673| const char \* [OH_ArkUI_AlignmentRuleOption_GetCenterIdHorizontal](#oh_arkui_alignmentruleoption_getcenteridhorizontal) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the ID in horizontal center alignment parameters. | 674| [ArkUI_HorizontalAlignment](#arkui_horizontalalignment) [OH_ArkUI_AlignmentRuleOption_GetCenterAlignmentHorizontal](#oh_arkui_alignmentruleoption_getcenteralignmenthorizontal) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the ID in horizontal center alignment parameters. | 675| const char \* [OH_ArkUI_AlignmentRuleOption_GetTopId](#oh_arkui_alignmentruleoption_gettopid) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the ID in top alignment parameters. | 676| [ArkUI_VerticalAlignment](#arkui_verticalalignment) [OH_ArkUI_AlignmentRuleOption_GetTopAlignment](#oh_arkui_alignmentruleoption_gettopalignment) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the ID in top alignment parameters. | 677| const char \* [OH_ArkUI_AlignmentRuleOption_GetBottomId](#oh_arkui_alignmentruleoption_getbottomid) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the ID in bottom alignment parameters. | 678| [ArkUI_VerticalAlignment](#arkui_verticalalignment) [OH_ArkUI_AlignmentRuleOption_GetBottomAlignment](#oh_arkui_alignmentruleoption_getbottomalignment) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the ID in bottom alignment parameters. | 679| const char \* [OH_ArkUI_AlignmentRuleOption_GetCenterIdVertical](#oh_arkui_alignmentruleoption_getcenteridvertical) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the ID in vertical center alignment parameters. | 680| [ArkUI_VerticalAlignment](#arkui_verticalalignment) [OH_ArkUI_AlignmentRuleOption_GetCenterAlignmentVertical](#oh_arkui_alignmentruleoption_getcenteralignmentvertical) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the ID in vertical center alignment parameters. | 681| float [OH_ArkUI_AlignmentRuleOption_GetBiasHorizontal](#oh_arkui_alignmentruleoption_getbiashorizontal) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the bias value in the horizontal direction. | 682| float [OH_ArkUI_AlignmentRuleOption_GetBiasVertical](#oh_arkui_alignmentruleoption_getbiasvertical) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the bias value in the vertical direction. | 683| [ArkUI_SwiperIndicator](#arkui_swiperindicator) \* [OH_ArkUI_SwiperIndicator_Create](#oh_arkui_swiperindicator_create) ([ArkUI_SwiperIndicatorType](#arkui_swiperindicatortype) type) | Creates a navigation indicator for this **Swiper** component. | 684| void [OH_ArkUI_SwiperIndicator_Dispose](#oh_arkui_swiperindicator_dispose) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | Disposes of the navigation indicator of this **Swiper** component. | 685| void [OH_ArkUI_SwiperIndicator_SetStartPosition](#oh_arkui_swiperindicator_setstartposition) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, float value) | Sets the distance between the navigation indicator and the left edge of the **Swiper** component. | 686| float [OH_ArkUI_SwiperIndicator_GetStartPosition](#oh_arkui_swiperindicator_getstartposition) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | Obtains the distance between a navigation indicator and the left edge of the **Swiper** component. | 687| void [OH_ArkUI_SwiperIndicator_SetTopPosition](#oh_arkui_swiperindicator_settopposition) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, float value) | Sets the distance between the navigation indicator and the top edge of the **Swiper** component. | 688| float [OH_ArkUI_SwiperIndicator_GetTopPosition](#oh_arkui_swiperindicator_gettopposition) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | Obtains the distance between the navigation indicator and the top edge of the **Swiper** component. | 689| void [OH_ArkUI_SwiperIndicator_SetEndPosition](#oh_arkui_swiperindicator_setendposition) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, float value) | Sets the distance between the navigation indicator and the right edge of the **Swiper** component. | 690| float [OH_ArkUI_SwiperIndicator_GetEndPosition](#oh_arkui_swiperindicator_getendposition) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | Obtains the distance between the navigation indicator and the right edge of the **Swiper** component. | 691| void [OH_ArkUI_SwiperIndicator_SetBottomPosition](#oh_arkui_swiperindicator_setbottomposition) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, float value) | Sets the distance between the navigation indicator and the bottom edge of the **Swiper** component. | 692| float [OH_ArkUI_SwiperIndicator_GetBottomPosition](#oh_arkui_swiperindicator_getbottomposition) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | Obtains the distance between the navigation indicator and the bottom edge of the **Swiper** component. | 693| void [OH_ArkUI_SwiperIndicator_SetItemWidth](#oh_arkui_swiperindicator_setitemwidth) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, float value) | Sets the width of a dot-style navigation indicator for the **Swiper** component. | 694| float [OH_ArkUI_SwiperIndicator_GetItemWidth](#oh_arkui_swiperindicator_getitemwidth) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | Obtains the width of a dot-style navigation indicator of the **Swiper** component. | 695| void [OH_ArkUI_SwiperIndicator_SetItemHeight](#oh_arkui_swiperindicator_setitemheight) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, float value) | Sets the height of a dot-style navigation indicator for the **Swiper** component. | 696| float [OH_ArkUI_SwiperIndicator_GetItemHeight](#oh_arkui_swiperindicator_getitemheight) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | Obtains the height of a dot-style navigation indicator of the **Swiper** component. | 697| void [OH_ArkUI_SwiperIndicator_SetSelectedItemWidth](#oh_arkui_swiperindicator_setselecteditemwidth) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, float value) | Sets the width of the selected dot-style navigation indicator for the **Swiper** component. | 698| float [OH_ArkUI_SwiperIndicator_GetSelectedItemWidth](#oh_arkui_swiperindicator_getselecteditemwidth) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | Obtains the width of the selected dot-style navigation indicator of the **Swiper** component. | 699| void [OH_ArkUI_SwiperIndicator_SetSelectedItemHeight](#oh_arkui_swiperindicator_setselecteditemheight) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, float value) | Sets the height of the selected dot-style navigation indicator for the **Swiper** component. | 700| float [OH_ArkUI_SwiperIndicator_GetSelectedItemHeight](#oh_arkui_swiperindicator_getselecteditemheight) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | Obtains the height of the selected dot-style navigation indicator of the **Swiper** component. | 701| void [OH_ArkUI_SwiperIndicator_SetMask](#oh_arkui_swiperindicator_setmask) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, int32_t mask) | Sets whether to enable the mask for a dot-style navigation indicator for the **Swiper** component. | 702| int32_t [OH_ArkUI_SwiperIndicator_GetMask](#oh_arkui_swiperindicator_getmask) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | Obtains whether the mask is enabled for a dot-style navigation indicator of the **Swiper** component. | 703| void [OH_ArkUI_SwiperIndicator_SetColor](#oh_arkui_swiperindicator_setcolor) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, uint32_t color) | Sets the color of a dot-style navigation indicator for the **Swiper** component. | 704| uint32_t [OH_ArkUI_SwiperIndicator_GetColor](#oh_arkui_swiperindicator_getcolor) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | Obtains the color of a dot-style navigation indicator of the **Swiper** component. | 705| void [OH_ArkUI_SwiperIndicator_SetSelectedColor](#oh_arkui_swiperindicator_setselectedcolor) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, uint32_t selectedColor) | Sets the color of the selected dot-style navigation indicator for the **Swiper** component. | 706| uint32_t [OH_ArkUI_SwiperIndicator_GetSelectedColor](#oh_arkui_swiperindicator_getselectedcolor) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | Obtains the color of the selected dot-style navigation indicator of the **Swiper** component. | 707| int32_t [OH_ArkUI_SwiperIndicator_SetMaxDisplayCount](#oh_arkui_swiperindicator_setmaxdisplaycount) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, int32_t maxDisplayCount) | Sets the maximum number of dots for the dot-style navigation indicator. | 708| int32_t [OH_ArkUI_SwiperIndicator_GetMaxDisplayCount](#oh_arkui_swiperindicator_getmaxdisplaycount) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | Obtains the maximum number of points for the navigation indicator. | 709| [ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* [OH_ArkUI_SwiperDigitIndicator_Create](#oh_arkui_swiperdigitindicator_create)() | Creates a digit-style navigation indicator for this **Swiper** component. | 710| void [OH_ArkUI_SwiperDigitIndicator_SetStartPosition](#oh_arkui_swiperdigitindicator_setstartposition)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator, float value) | Sets the start position of the digit-style navigation indicator for the **Swiper** component. This determines the distance from the left edge of the **Swiper** component. For right-to-left scripts, this determines the distance from the right edge. | 711| float [OH_ArkUI_SwiperDigitIndicator_GetStartPosition](#oh_arkui_swiperdigitindicator_getstartposition)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator) | Obtains the start position of the digit-style navigation indicator for the **Swiper** component. This indicates the distance from the left edge of the **Swiper** component. For right-to-left scripts, this indicates the distance from the right edge. | 712| void [OH_ArkUI_SwiperDigitIndicator_SetTopPosition](#oh_arkui_swiperdigitindicator_settopposition)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator, float value) | Sets the distance from the digit-style navigation indicator to the top of the **Swiper** component.| 713| float [OH_ArkUI_SwiperDigitIndicator_GetTopPosition](#oh_arkui_swiperdigitindicator_gettopposition)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator) | Obtains the distance from the digit-style navigation indicator to the top of the **Swiper** component. | 714| void [OH_ArkUI_SwiperDigitIndicator_SetEndPosition](#oh_arkui_swiperdigitindicator_setendposition)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator, float value) | Sets the end position of the digit-style navigation indicator for the **Swiper** component. This determines the distance from the right edge of the **Swiper** component. For right-to-left scripts, this determines the distance from the left edge.| 715| float [OH_ArkUI_SwiperDigitIndicator_GetEndPosition](#oh_arkui_swiperdigitindicator_getendposition)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator) | Obtains the end position of the digit-style navigation indicator for the **Swiper** component. This indicates the distance from the right edge of the **Swiper** component. For right-to-left scripts, this indicates the distance from the left edge. | 716| void [OH_ArkUI_SwiperDigitIndicator_SetBottomPosition](#oh_arkui_swiperdigitindicator_setbottomposition)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator, float value) | Sets the distance from the digit-style navigation indicator to the bottom of the **Swiper** component.| 717| float [OH_ArkUI_SwiperDigitIndicator_GetBottomPosition](#oh_arkui_swiperdigitindicator_getbottomposition)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator) | Obtains the distance from the digit-style navigation indicator to the bottom of the **Swiper** component. | 718| void [OH_ArkUI_SwiperDigitIndicator_SetFontColor](#oh_arkui_swiperdigitindicator_setfontcolor)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator, uint32_t color) | Sets the font color of the digit-style navigation indicator for the **Swiper** component.| 719| uint32_t [OH_ArkUI_SwiperDigitIndicator_GetFontColor](#oh_arkui_swiperdigitindicator_getfontcolor)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator) | Obtains the font color of the digit-style navigation indicator for the **Swiper** component. | 720| void [OH_ArkUI_SwiperDigitIndicator_SetSelectedFontColor](#oh_arkui_swiperdigitindicator_setselectedfontcolor)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator, uint32_t selectedColor) | Sets the font color of the selected digit-style navigation indicator for the **Swiper** component.| 721| uint32_t [OH_ArkUI_SwiperDigitIndicator_GetSelectedFontColor](#oh_arkui_swiperdigitindicator_getselectedfontcolor)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator) | Obtains the font color of the selected digit-style navigation indicator for the **Swiper** component. | 722| void [OH_ArkUI_SwiperDigitIndicator_SetFontSize](#oh_arkui_swiperdigitindicator_setfontsize)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator, float size) | Sets the font size of the digit-style navigation indicator for the **Swiper** component.| 723| float [OH_ArkUI_SwiperDigitIndicator_GetFontSize](#oh_arkui_swiperdigitindicator_getfontsize)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator) | Obtains the font size of the digit-style navigation indicator for the **Swiper** component. | 724| void [OH_ArkUI_SwiperDigitIndicator_SetSelectedFontSize](#oh_arkui_swiperdigitindicator_setselectedfontsize)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator, float size) | Sets the font size of the selected digit-style navigation indicator for the **Swiper** component.| 725| float [OH_ArkUI_SwiperDigitIndicator_GetSelectedFontSize](#oh_arkui_swiperdigitindicator_getselectedfontsize)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator) | Obtains the font size of the selected digit-style navigation indicator for the **Swiper** component. | 726| void [OH_ArkUI_SwiperDigitIndicator_SetFontWeight](#oh_arkui_swiperdigitindicator_setfontweight)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator, [ArkUI_FontWeight](#arkui_fontweight) fontWeight) | Sets the font weight of the digit-style navigation indicator for the **Swiper** component.| 727| [ArkUI_FontWeight](#arkui_fontweight) [OH_ArkUI_SwiperDigitIndicator_GetFontWeight](#oh_arkui_swiperdigitindicator_getfontweight)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator) | Obtains the font weight of the digit-style navigation indicator for the **Swiper** component. | 728| void [OH_ArkUI_SwiperDigitIndicator_SetSelectedFontWeight](#oh_arkui_swiperdigitindicator_setselectedfontweight)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator, [ArkUI_FontWeight](#arkui_fontweight) selectedFontWeight) | Sets the font weight of the selected digit-style navigation indicator for the **Swiper** component.| 729| [ArkUI_FontWeight](#arkui_fontweight) [OH_ArkUI_SwiperDigitIndicator_GetSelectedFontWeight](#oh_arkui_swiperdigitindicator_getselectedfontweight)([ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator)* indicator) | Obtains the font weight of the selected digit-style navigation indicator for the **Swiper** component. | 730|void [OH_ArkUI_SwiperDigitIndicator_Dispose](#oh_arkui_swiperdigitindicator_dispose)() | Disposes of the digit-style navigation indicator of this **Swiper** component. | 731| [ArkUI_SwiperArrowStyle](#arkui_swiperarrowstyle)* [OH_ArkUI_SwiperArrowStyle_Create](#oh_arkui_swiperarrowstyle_create)() | Creates an arrow style for the **Swiper** component. | 732| void [OH_ArkUI_SwiperArrowStyle_SetShowBackground](#oh_arkui_swiperarrowstyle_setshowbackground)([ArkUI_SwiperArrowStyle](#arkui_swiperarrowstyle)* indicator, int32_t showBackground) | Sets whether to display the background of the arrow for the **Swiper** component.| 733| int32_t [OH_ArkUI_SwiperArrowStyle_GetShowBackground](#oh_arkui_swiperarrowstyle_getshowbackground)([ArkUI_SwiperArrowStyle](#arkui_swiperarrowstyle)* indicator) | Checks whether the background of the arrow is displayed for the **Swiper** component. | 734| void [OH_ArkUI_SwiperArrowStyle_SetShowSidebarMiddle](#oh_arkui_swiperarrowstyle_setshowsidebarmiddle)([ArkUI_SwiperArrowStyle](#arkui_swiperarrowstyle)* indicator, int32_t showSidebarMiddle) | Sets the position of the arrow for the **Swiper** component.| 735| int32_t [OH_ArkUI_SwiperArrowStyle_GetShowSidebarMiddle](#oh_arkui_swiperarrowstyle_getshowsidebarmiddle)([ArkUI_SwiperArrowStyle](#arkui_swiperarrowstyle)* indicator) | Obtains the position of the arrow for the **Swiper** component. | 736| void [OH_ArkUI_SwiperArrowStyle_SetBackgroundSize](#oh_arkui_swiperarrowstyle_setbackgroundsize)([ArkUI_SwiperArrowStyle](#arkui_swiperarrowstyle)* indicator, float backgroundSize) | Sets the background size for the arrow of the **Swiper** component.| 737| float [OH_ArkUI_SwiperArrowStyle_GetBackgroundSize](#oh_arkui_swiperarrowstyle_getbackgroundsize)([ArkUI_SwiperArrowStyle](#arkui_swiperarrowstyle)* indicator) | Obtains the background size for the arrow of the **Swiper** component. | 738| void [OH_ArkUI_SwiperArrowStyle_SetBackgroundColor](#oh_arkui_swiperarrowstyle_setbackgroundcolor)([ArkUI_SwiperArrowStyle](#arkui_swiperarrowstyle)* indicator, uint32_t backgroundColor) | Sets the background color for the arrow of the **Swiper** component.| 739| uint32_t [OH_ArkUI_SwiperArrowStyle_GetBackgroundColor](#oh_arkui_swiperarrowstyle_getbackgroundcolor)([ArkUI_SwiperArrowStyle](#arkui_swiperarrowstyle)* indicator) | Obtains the background color for the arrow of the **Swiper** component. | 740| void [OH_ArkUI_SwiperArrowStyle_SetArrowSize](#oh_arkui_swiperarrowstyle_setarrowsize)([ArkUI_SwiperArrowStyle](#arkui_swiperarrowstyle)* indicator, float arrowSize) | Sets the size for the arrow of the **Swiper** component.| 741| float [OH_ArkUI_SwiperArrowStyle_GetArrowSize](#oh_arkui_swiperarrowstyle_getarrowsize)([ArkUI_SwiperArrowStyle](#arkui_swiperarrowstyle)* indicator) | Obtains the size of the arrow of the **Swiper** component. | 742| void [OH_ArkUI_SwiperArrowStyle_SetArrowColor](#oh_arkui_swiperarrowstyle_setarrowcolor)([ArkUI_SwiperArrowStyle](#arkui_swiperarrowstyle)* indicator, uint32_t arrowColor) | Sets the color for the arrow of the **Swiper** component.| 743| uint32_t [OH_ArkUI_SwiperArrowStyle_GetArrowColor](#oh_arkui_swiperarrowstyle_getarrowcolor)([ArkUI_SwiperArrowStyle](#arkui_swiperarrowstyle)* indicator) | Obtains the color of the arrow of the **Swiper** component. | 744|void [OH_ArkUI_SwiperArrowStyle_Dispose](#oh_arkui_swiperarrowstyle_dispose)() | Disposes of the arrow style of the **Swiper** component. | 745| [ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \* [OH_ArkUI_ListItemSwipeActionItem_Create](#oh_arkui_listitemswipeactionitem_create) () | Creates a **ListItemSwipeActionItem** instance. | 746| void [OH_ArkUI_ListItemSwipeActionItem_Dispose](#oh_arkui_listitemswipeactionitem_dispose) ([ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item) | Disposes of a **ListItemSwipeActionItem** instance. | 747| void [OH_ArkUI_ListItemSwipeActionItem_SetContent](#oh_arkui_listitemswipeactionitem_setcontent) ([ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item, [ArkUI_NodeHandle](#arkui_nodehandle) node) | Sets the layout content for a **ListItemSwipeActionItem** instance. | 748| void [OH_ArkUI_ListItemSwipeActionItem_SetActionAreaDistance](#oh_arkui_listitemswipeactionitem_setactionareadistance) ([ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item, float distance) | Sets the swipe distance threshold for deleting the list item. | 749| float [OH_ArkUI_ListItemSwipeActionItem_GetActionAreaDistance](#oh_arkui_listitemswipeactionitem_getactionareadistance) ([ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item) | Obtains the swipe distance threshold for deleting the list item. | 750| void [OH_ArkUI_ListItemSwipeActionItem_SetOnEnterActionArea](#oh_arkui_listitemswipeactionitem_setonenteractionarea) ([ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item, void(\*callback)()) | Sets the callback invoked each time the list item enters the delete area. | 751| void [OH_ArkUI_ListItemSwipeActionItem_SetOnEnterActionAreaWithUserData](#oh_arkui_listitemswipeactionitem_setonenteractionareawithuserdata) ([ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item, void \*userData, void(\*callback)(void \*userData)) | Sets the callback invoked each time the list item enters the delete area. | 752| void [OH_ArkUI_ListItemSwipeActionItem_SetOnAction](#oh_arkui_listitemswipeactionitem_setonaction) ([ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item, void(\*callback)()) | Sets the callback invoked when the list item is deleted while in the delete area. | 753| void [OH_ArkUI_ListItemSwipeActionItem_SetOnActionWithUserData](#oh_arkui_listitemswipeactionitem_setonactionwithuserdata) ([ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item, void \*userData, void(\*callback)(void \*userData)) | Sets the callback invoked when the list item is deleted while in the delete area. | 754| void [OH_ArkUI_ListItemSwipeActionItem_SetOnExitActionArea](#oh_arkui_listitemswipeactionitem_setonexitactionarea) ([ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item, void(\*callback)()) | Sets the callback invoked each time the list item exits the delete area. | 755| void [OH_ArkUI_ListItemSwipeActionItem_SetOnExitActionAreaWithUserData](#oh_arkui_listitemswipeactionitem_setonexitactionareawithuserdata) ([ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item, void \*userData, void(\*callback)(void \*userData)) | Sets the callback invoked each time the list item exits the delete area. | 756| void [OH_ArkUI_ListItemSwipeActionItem_SetOnStateChange](#oh_arkui_listitemswipeactionitem_setonstatechange) ([ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item, void(\*callback)([ArkUI_ListItemSwipeActionState](#arkui_listitemswipeactionstate) swipeActionState)) | Sets the callback invoked when the swipe state of the list item changes. | 757| 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)) | Sets the callback invoked when the swipe state of the list item changes. | 758| [ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption) \* [OH_ArkUI_ListItemSwipeActionOption_Create](#oh_arkui_listitemswipeactionoption_create) () | Creates a **ListItemSwipeActionOption** instance. | 759| void [OH_ArkUI_ListItemSwipeActionOption_Dispose](#oh_arkui_listitemswipeactionoption_dispose) ([ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption) \*option) | Disposes of a **ListItemSwipeActionOption** instance. | 760| void [OH_ArkUI_ListItemSwipeActionOption_SetStart](#oh_arkui_listitemswipeactionoption_setstart) ([ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption) \*option, [ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item) | Sets the layout content for the left edge (for a vertical layout) or top edge (for a horizontal layout) of a **ListItemSwipeActionOption** instance. | 761| void [OH_ArkUI_ListItemSwipeActionOption_SetEnd](#oh_arkui_listitemswipeactionoption_setend) ([ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption) \*option, [ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item) | Sets the layout content for the right edge (for a vertical layout) or bottom edge (for a horizontal layout) of a **ListItemSwipeActionItem** instance. | 762| void [OH_ArkUI_ListItemSwipeActionOption_SetEdgeEffect](#oh_arkui_listitemswipeactionoption_setedgeeffect) ([ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption) \*option, [ArkUI_ListItemSwipeEdgeEffect](#arkui_listitemswipeedgeeffect) edgeEffect) | Sets the edge effect used when the boundary of the scrolling area is reached. | 763| int32_t [OH_ArkUI_ListItemSwipeActionOption_GetEdgeEffect](#oh_arkui_listitemswipeactionoption_getedgeeffect) ([ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption) \*option) | Obtains the edge effect used when the boundary of the scrolling area is reached. | 764| void [OH_ArkUI_ListItemSwipeActionOption_SetOnOffsetChange](#oh_arkui_listitemswipeactionoption_setonoffsetchange) ([ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption) \*option, void(\*callback)(float offset)) | Sets the callback invoked when the scroll offset changes. | 765| void [OH_ArkUI_ListItemSwipeActionOption_SetOnOffsetChangeWithUserData](#oh_arkui_listitemswipeactionoption_setonoffsetchangewithuserdata) ([ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption) \*option, void \*userData, void(\*callback)(float offset, void \*userData)) | Sets the callback invoked when the scroll offset changes. | 766| [ArkUI_AccessibilityState](#arkui_accessibilitystate) \* [OH_ArkUI_AccessibilityState_Create](#oh_arkui_accessibilitystate_create) (void) | Creates an accessibility state. | 767| void [OH_ArkUI_AccessibilityState_Dispose](#oh_arkui_accessibilitystate_dispose) ([ArkUI_AccessibilityState](#arkui_accessibilitystate) \*state) | Disposes of the pointer to an accessibility state. | 768| void [OH_ArkUI_AccessibilityState_SetDisabled](#oh_arkui_accessibilitystate_setdisabled) ([ArkUI_AccessibilityState](#arkui_accessibilitystate) \*state, int32_t isDisabled) | Sets whether an accessibility state is disabled. | 769| int32_t [OH_ArkUI_AccessibilityState_IsDisabled](#oh_arkui_accessibilitystate_isdisabled) ([ArkUI_AccessibilityState](#arkui_accessibilitystate) \*state) | Obtains whether an accessibility state is disabled. | 770| void [OH_ArkUI_AccessibilityState_SetSelected](#oh_arkui_accessibilitystate_setselected) ([ArkUI_AccessibilityState](#arkui_accessibilitystate) \*state, int32_t isSelected) | Sets whether an accessibility state is selected. | 771| int32_t [OH_ArkUI_AccessibilityState_IsSelected](#oh_arkui_accessibilitystate_isselected) ([ArkUI_AccessibilityState](#arkui_accessibilitystate) \*state) | Obtains whether an accessibility state is selected. | 772| void [OH_ArkUI_AccessibilityState_SetCheckedState](#oh_arkui_accessibilitystate_setcheckedstate) ([ArkUI_AccessibilityState](#arkui_accessibilitystate) \*state, int32_t checkedState) | Sets the check box state of an accessibility state. | 773| int32_t [OH_ArkUI_AccessibilityState_GetCheckedState](#oh_arkui_accessibilitystate_getcheckedstate) ([ArkUI_AccessibilityState](#arkui_accessibilitystate) \*state) | Obtains the check box state of an accessibility state. | 774| [ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \* [OH_ArkUI_AccessibilityValue_Create](#oh_arkui_accessibilityvalue_create) (void) | Creates an **AccessibilityValue** instance. | 775| void [OH_ArkUI_AccessibilityValue_Dispose](#oh_arkui_accessibilityvalue_dispose) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value) | Disposes of the pointer to an **AccessibilityValue** instance. | 776| void [OH_ArkUI_AccessibilityValue_SetMin](#oh_arkui_accessibilityvalue_setmin) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value, int32_t min) | Sets the minimum accessibility value. | 777| int32_t [OH_ArkUI_AccessibilityValue_GetMin](#oh_arkui_accessibilityvalue_getmin) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value) | Obtains the minimum accessibility value. | 778| void [OH_ArkUI_AccessibilityValue_SetMax](#oh_arkui_accessibilityvalue_setmax) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value, int32_t max) | Sets the maximum accessibility value. | 779| int32_t [OH_ArkUI_AccessibilityValue_GetMax](#oh_arkui_accessibilityvalue_getmax) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value) | Obtains the maximum accessibility value. | 780| void [OH_ArkUI_AccessibilityValue_SetCurrent](#oh_arkui_accessibilityvalue_setcurrent) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value, int32_t current) | Sets the current accessibility value. | 781| int32_t [OH_ArkUI_AccessibilityValue_GetCurrent](#oh_arkui_accessibilityvalue_getcurrent) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value) | Obtains the current accessibility value. | 782| void [OH_ArkUI_AccessibilityValue_SetText](#oh_arkui_accessibilityvalue_settext) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value, const char \*text) | Sets the text description of an **AccessibilityValue** instance. | 783| const char \* [OH_ArkUI_AccessibilityValue_GetText](#oh_arkui_accessibilityvalue_gettext) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value) | Obtains the text description of an **AccessibilityValue** instance. | 784| [ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \* [OH_ArkUI_ImageAnimatorFrameInfo_CreateFromString](#oh_arkui_imageanimatorframeinfo_createfromstring) (char \*src) | Creates an image frame information object based on an image path, with the image format being SVG, PNG, or JPG. | 785| [ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \* [OH_ArkUI_ImageAnimatorFrameInfo_CreateFromDrawableDescriptor](#oh_arkui_imageanimatorframeinfo_createfromdrawabledescriptor) ([ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) \*drawable) | Creates an image frame information object based on a **DrawableDescriptor** object, with the image format being Resource or PixelMap. | 786| void [OH_ArkUI_ImageAnimatorFrameInfo_Dispose](#oh_arkui_imageanimatorframeinfo_dispose) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo) | Disposes of the pointer to an image frame information object. | 787| void [OH_ArkUI_ImageAnimatorFrameInfo_SetWidth](#oh_arkui_imageanimatorframeinfo_setwidth) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo, int32_t width) | Sets the image width. | 788| int32_t [OH_ArkUI_ImageAnimatorFrameInfo_GetWidth](#oh_arkui_imageanimatorframeinfo_getwidth) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo) | Obtains the image width. | 789| void [OH_ArkUI_ImageAnimatorFrameInfo_SetHeight](#oh_arkui_imageanimatorframeinfo_setheight) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo, int32_t height) | Sets the image height. | 790| int32_t [OH_ArkUI_ImageAnimatorFrameInfo_GetHeight](#oh_arkui_imageanimatorframeinfo_getheight) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo) | Obtains the image height. | 791| void [OH_ArkUI_ImageAnimatorFrameInfo_SetTop](#oh_arkui_imageanimatorframeinfo_settop) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo, int32_t top) | Sets the vertical coordinate of an image relative to the upper left corner of the component. | 792| int32_t [OH_ArkUI_ImageAnimatorFrameInfo_GetTop](#oh_arkui_imageanimatorframeinfo_gettop) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo) | Obtains the vertical coordinate of an image relative to the upper left corner of the component. | 793| void [OH_ArkUI_ImageAnimatorFrameInfo_SetLeft](#oh_arkui_imageanimatorframeinfo_setleft) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo, int32_t left) | Sets the horizontal coordinate of an image relative to the upper left corner of the component. | 794| int32_t [OH_ArkUI_ImageAnimatorFrameInfo_GetLeft](#oh_arkui_imageanimatorframeinfo_getleft) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo) | Obtains the horizontal coordinate of an image relative to the upper left corner of the component. | 795| void [OH_ArkUI_ImageAnimatorFrameInfo_SetDuration](#oh_arkui_imageanimatorframeinfo_setduration) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo, int32_t duration) | Sets the playback duration of an image. | 796| int32_t [OH_ArkUI_ImageAnimatorFrameInfo_GetDuration](#oh_arkui_imageanimatorframeinfo_getduration) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo) | Obtains the playback duration of an image. | 797| [ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) \* [OH_ArkUI_ListChildrenMainSizeOption_Create](#oh_arkui_listchildrenmainsizeoption_create) () | Creates a **ListChildrenMainSize** instance. | 798| void [OH_ArkUI_ListChildrenMainSizeOption_Dispose](#oh_arkui_listchildrenmainsizeoption_dispose) ([ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) \*option) | Disposes of a **ListChildrenMainSize** instance. | 799| int32_t [OH_ArkUI_ListChildrenMainSizeOption_SetDefaultMainSize](#oh_arkui_listchildrenmainsizeoption_setdefaultmainsize) ([ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) \*option, float defaultMainSize) | Sets the default size in a **ListChildrenMainSize** instance. | 800| float [OH_ArkUI_ListChildrenMainSizeOption_GetDefaultMainSize](#oh_arkui_listchildrenmainsizeoption_getdefaultmainsize) ([ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) \*option) | Obtains the default size in a **ListChildrenMainSize** instance. | 801| void [OH_ArkUI_ListChildrenMainSizeOption_Resize](#oh_arkui_listchildrenmainsizeoption_resize) ([ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) \*option, int32_t totalSize) | Resets the array size in a **ListChildrenMainSize** instance. | 802| int32_t [OH_ArkUI_ListChildrenMainSizeOption_Splice](#oh_arkui_listchildrenmainsizeoption_splice) ([ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) \*option, int32_t index, int32_t deleteCount, int32_t addCount) | Changes the content of a **ChildrenMainSizeOption** array. | 803| int32_t [OH_ArkUI_ListChildrenMainSizeOption_UpdateSize](#oh_arkui_listchildrenmainsizeoption_updatesize) ([ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) \*option, int32_t index, float mainSize) | Updates the values of a **ChildrenMainSizeOption** array. | 804| float [OH_ArkUI_ListChildrenMainSizeOption_GetMainSize](#oh_arkui_listchildrenmainsizeoption_getmainsize) ([ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) \*option, int32_t index) | Obtains the values of a **ChildrenMainSizeOption** array. | 805| [ArkUI_CustomSpanMeasureInfo](#arkui_customspanmeasureinfo) \* [OH_ArkUI_CustomSpanMeasureInfo_Create](#oh_arkui_customspanmeasureinfo_create) (void) | Creates measurement information for this custom span. | 806| void [OH_ArkUI_CustomSpanMeasureInfo_Dispose](#oh_arkui_customspanmeasureinfo_dispose) ([ArkUI_CustomSpanMeasureInfo](#arkui_customspanmeasureinfo) \*info) | Disposes of measurement information of a custom span. | 807| float [OH_ArkUI_CustomSpanMeasureInfo_GetFontSize](#oh_arkui_customspanmeasureinfo_getfontsize) ([ArkUI_CustomSpanMeasureInfo](#arkui_customspanmeasureinfo) \*info) | Obtains the font size of the parent text node of a custom span. | 808| [ArkUI_CustomSpanMetrics](#arkui_customspanmetrics) \* [OH_ArkUI_CustomSpanMetrics_Create](#oh_arkui_customspanmetrics_create) (void) | Creates measurement metrics for this custom span. | 809| void [OH_ArkUI_CustomSpanMetrics_Dispose](#oh_arkui_customspanmetrics_dispose) ([ArkUI_CustomSpanMetrics](#arkui_customspanmetrics) \*metrics) | Disposes of measurement metrics of this custom span. | 810| int32_t [OH_ArkUI_CustomSpanMetrics_SetWidth](#oh_arkui_customspanmetrics_setwidth) ([ArkUI_CustomSpanMetrics](#arkui_customspanmetrics) \*metrics, float width) | Sets the width for a custom span. | 811| int32_t [OH_ArkUI_CustomSpanMetrics_SetHeight](#oh_arkui_customspanmetrics_setheight) ([ArkUI_CustomSpanMetrics](#arkui_customspanmetrics) \*metrics, float height) | Sets the height for a custom span. | 812| [ArkUI_CustomSpanDrawInfo](#arkui_customspandrawinfo) \* [OH_ArkUI_CustomSpanDrawInfo_Create](#oh_arkui_customspandrawinfo_create) (void) | Creates drawing information for this custom span. | 813| void [OH_ArkUI_CustomSpanDrawInfo_Dispose](#oh_arkui_customspandrawinfo_dispose) ([ArkUI_CustomSpanDrawInfo](#arkui_customspandrawinfo) \*info) | Disposes of drawing information for this custom span. | 814| float [OH_ArkUI_CustomSpanDrawInfo_GetXOffset](#oh_arkui_customspandrawinfo_getxoffset) ([ArkUI_CustomSpanDrawInfo](#arkui_customspandrawinfo) \*info) | Obtains the x-axis offset of the custom span relative to the mounted component. | 815| float [OH_ArkUI_CustomSpanDrawInfo_GetLineTop](#oh_arkui_customspandrawinfo_getlinetop) ([ArkUI_CustomSpanDrawInfo](#arkui_customspandrawinfo) \*info) | Obtains the top margin of the custom span relative to the mounted component. | 816| float [OH_ArkUI_CustomSpanDrawInfo_GetLineBottom](#oh_arkui_customspandrawinfo_getlinebottom) ([ArkUI_CustomSpanDrawInfo](#arkui_customspandrawinfo) \*info) | Obtains the bottom margin of the custom span relative to the mounted component. | 817| float [OH_ArkUI_CustomSpanDrawInfo_GetBaseline](#oh_arkui_customspandrawinfo_getbaseline) ([ArkUI_CustomSpanDrawInfo](#arkui_customspandrawinfo) \*info) | Obtains the baseline offset of the custom span relative to the mounted component. | 818| void [OH_ArkUI_CustomProperty_Destroy](#oh_arkui_customproperty_destroy) (ArkUI_CustomProperty \*handle) | Destroys a **CustomProperty** instance. | 819| const char \* [OH_ArkUI_CustomProperty_GetStringValue](#oh_arkui_customproperty_getstringvalue) (ArkUI_CustomProperty \*handle) | Obtains the value of a custom property. | 820| void [OH_ArkUI_ActiveChildrenInfo_Destroy](#oh_arkui_activechildreninfo_destroy) (ArkUI_ActiveChildrenInfo \*handle) | Destroys an **ActiveChildrenInfo** instance. | 821| [ArkUI_NodeHandle](#arkui_nodehandle) [OH_ArkUI_ActiveChildrenInfo_GetNodeByIndex](#oh_arkui_activechildreninfo_getnodebyindex) (ArkUI_ActiveChildrenInfo \*handle, int32_t index) | Obtains the child node at the specified index in the specified **ActiveChildrenInfo** instance. | 822| int32_t [OH_ArkUI_ActiveChildrenInfo_GetCount](#oh_arkui_activechildreninfo_getcount) (ArkUI_ActiveChildrenInfo \*handle) | Obtains the number of nodes in the specified **ActiveChildrenInfo** instance. | 823| [ArkUI_StyledString](#arkui_styledstring) \* [OH_ArkUI_StyledString_Create](#oh_arkui_styledstring_create) (OH_Drawing_TypographyStyle \*style, OH_Drawing_FontCollection \*collection) | Creates an **OH_Drawing_TextStyle** object. | 824| void [OH_ArkUI_StyledString_Destroy](#oh_arkui_styledstring_destroy) ([ArkUI_StyledString](#arkui_styledstring) \*handle) | Destroys an **OH_Drawing_FontCollection** object and reclaims the memory occupied by the object. | 825| void [OH_ArkUI_StyledString_PushTextStyle](#oh_arkui_styledstring_pushtextstyle) ([ArkUI_StyledString](#arkui_styledstring) \*handle, OH_Drawing_TextStyle \*style) | Pushes a text style to the top of the style stack of a styled string. | 826| void [OH_ArkUI_StyledString_AddText](#oh_arkui_styledstring_addtext) ([ArkUI_StyledString](#arkui_styledstring) \*handle, const char \*content) | Adds text for a styled string. | 827| void [OH_ArkUI_StyledString_PopTextStyle](#oh_arkui_styledstring_poptextstyle) ([ArkUI_StyledString](#arkui_styledstring) \*handle) | Pops the style at the top of the style stack of a styled string. | 828| OH_Drawing_Typography \* [OH_ArkUI_StyledString_CreateTypography](#oh_arkui_styledstring_createtypography) ([ArkUI_StyledString](#arkui_styledstring) \*handle) | Creates an **OH_Drawing_Typography** object based on an **ArkUI_StyledString** object. | 829| void [OH_ArkUI_StyledString_AddPlaceholder](#oh_arkui_styledstring_addplaceholder) ([ArkUI_StyledString](#arkui_styledstring) \*handle, OH_Drawing_PlaceholderSpan \*placeholder) | Adds a placeholder. | 830| [ArkUI_StyledString_Descriptor](#arkui_styledstring_descriptor) \* [OH_ArkUI_StyledString_Descriptor_Create](#oh_arkui_styledstring_descriptor_create) (void) | Creates an **ArkUI_StyledString_Descriptor** object. | 831| void [OH_ArkUI_StyledString_Descriptor_Destroy](#oh_arkui_styledstring_descriptor_destroy) ([ArkUI_StyledString_Descriptor](#arkui_styledstring_descriptor) \*descriptor) | Destroys an **ArkUI_StyledString_Descriptor** object and reclaims the memory occupied by the object. | 832| int32_t [OH_ArkUI_UnmarshallStyledStringDescriptor](#oh_arkui_unmarshallstyledstringdescriptor) (uint8_t \*buffer, size_t bufferSize, [ArkUI_StyledString_Descriptor](#arkui_styledstring_descriptor) \*descriptor, size_t \*resultSize) | Deserializes a byte array containing styled string information into a styled string. | 833| int32_t [OH_ArkUI_MarshallStyledStringDescriptor](#oh_arkui_marshallstyledstringdescriptor) (uint8_t \*buffer, size_t bufferSize, [ArkUI_StyledString_Descriptor](#arkui_styledstring_descriptor) \*descriptor) | Serializes the styled string information into a byte array. | 834| const char \* [OH_ArkUI_ConvertToHtml](#oh_arkui_converttohtml) ([ArkUI_StyledString_Descriptor](#arkui_styledstring_descriptor) \*descriptor) | Converts styled string information into HTML. | 835| 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))| Registers a callback to be executed after the next frame is rendered. This callback must not be called from a non-UI thread. The application will abort if a non-UI thread call is detected.| 836| int32_t [OH_ArkUI_RegisterLayoutCallbackOnNodeHandle](#oh_arkui_registerlayoutcallbackonnodehandle)([ArkUI_NodeHandle](#arkui_nodehandle) node, void\* userData, void (\*onLayoutCompleted)(void\* userData))| Registers a layout completion callback function for a specific component. Only one layout completion callback can be registered per component. | 837| int32_t [OH_ArkUI_RegisterDrawCallbackOnNodeHandle](#oh_arkui_registerdrawcallbackonnodehandle)([ArkUI_NodeHandle](#arkui_nodehandle) node, void\* userData, void (\*onDrawCompleted)(void\* userData))| Registers a drawing completion callback function for a specific component. Only one drawing completion callback can be registered per component. | 838| int32_t [OH_ArkUI_UnregisterLayoutCallbackOnNodeHandle](#oh_arkui_unregisterlayoutcallbackonnodehandle)([ArkUI_NodeHandle](#arkui_nodehandle) node)| Unregisters the layout completion callback function for a specific component. | 839| int32_t [OH_ArkUI_UnregisterDrawCallbackOnNodeHandle](#oh_arkui_unregisterdrawcallbackonnodehandle)([ArkUI_NodeHandle](#arkui_nodehandle) node)| Unregisters the drawing completion callback function for a specific component. | 840| [ArkUI_TextChangeEvent](_ark_u_i___text_change_event.md) [OH_ArkUI_NodeEvent_GetTextChangeEvent](#oh_arkui_nodeevent_gettextchangeevent)([ArkUI_NodeEvent](#arkui_nodeevent-12) \*event) | Obtains the data related to a text change (including preview text content change) event in the text box. | 841|[ArkUI_ErrorCode](_ark_u_i___native_module.md#arkui_errorcode) OH_ArkUI_FocusRequest([ArkUI_NodeHandle](_ark_u_i___native_module.md#arkui_nodehandle) node); | Requests focus for a specific node.| 842| void OH_ArkUI_FocusClear([ArkUI_ContextHandle](_ark_u_i___native_module.md#arkui_contexthandle-12) uiContext); | Clears the focus to the root container node.| 843| void OH_ArkUI_FocusActivate([ArkUI_ContextHandle](_ark_u_i___native_module.md#arkui_contexthandle-12) uiContext, bool isActive, bool isAutoInactive); | Sets the focus activation state for the current page. When activated, the focused node displays a focus box.| 844| void OH_ArkUI_FocusSetAutoTransfer([ArkUI_ContextHandle](_ark_u_i___native_module.md#arkui_contexthandle-12) uiContext, bool autoTransfer); | Configures the focus transfer behavior when pages are switched.| 845| void OH_ArkUI_FocusSetKeyProcessingMode([ArkUI_ContextHandle](_ark_u_i___native_module.md#arkui_contexthandle-12) uiContext, ArkUI_KeyProcessingMode mode); | Sets the mode for processing key events.| 846| 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); | Sets whether to enable data prefetching for drag and drop operations on a specified node.| 847| void OH_ArkUI_[CancelDataLoading](#oh_arkui_canceldataloading)([ArkUI_Context](_ark_u_i___native_module.md#arkui_context) uiContext, const char\* key); | Cancels the asynchronous obtaining of drag data.| 848| void OH_ArkUI_[DisableDropDataPrefetchOnNode](#oh_arkui_disabledropdataprefetchonnode)([ArkUI_NodeHandle](_ark_u_i___native_module.md#arkui_nodehandle) node, bool disable); | Sets whether to enable data prefetching for drag and drop operations on a specified node. The value **true** means to disable data prefetching, and **false** means to enable data prefetching. The default value is **false**.| 849| [ArkUI_ProgressLinearStyleOption](#arkui_progresslinearstyleoption)\* [OH_ArkUI_ProgressLinearStyleOption_Create](#oh_arkui_progresslinearstyleoption_create)(void) | Creates a **ProgressLinearStyleOption** instance.| 850| void [OH_ArkUI_ProgressLinearStyleOption_Destroy](#oh_arkui_progresslinearstyleoption_destroy)([ArkUI_ProgressLinearStyleOption](#arkui_progresslinearstyleoption)* option) | Destroys a **ProgressLinearStyleOption** instance.| 851| void [OH_ArkUI_ProgressLinearStyleOption_SetScanEffectEnabled](#oh_arkui_progresslinearstyleoption_setscaneffectenabled)([ArkUI_ProgressLinearStyleOption](#arkui_progresslinearstyleoption)\* option, bool enabled) | Sets whether to enable the smooth progress effect for the linear progress indicator.| 852| void [OH_ArkUI_ProgressLinearStyleOption_SetSmoothEffectEnabled](#oh_arkui_progresslinearstyleoption_setsmootheffectenabled)([ArkUI_ProgressLinearStyleOption](#arkui_progresslinearstyleoption)\* option, bool enabled) | Sets whether to enable the scan effect for the linear progress indicator.| 853| void [OH_ArkUI_ProgressLinearStyleOption_SetStrokeWidth](#oh_arkui_progresslinearstyleoption_setstrokewidth)([ArkUI_ProgressLinearStyleOption](#arkui_progresslinearstyleoption)\* option, float strokeWidth) | Sets the stroke width of the linear progress indicator.| 854| void [OH_ArkUI_ProgressLinearStyleOption_SetStrokeRadius](#oh_arkui_progresslinearstyleoption_setstrokeradius)([ArkUI_ProgressLinearStyleOption](#arkui_progresslinearstyleoption)\* option, float strokeRadius) | Sets the corner radius of the linear progress indicator.| 855| bool [OH_ArkUI_ProgressLinearStyleOption_GetScanEffectEnabled](#oh_arkui_progresslinearstyleoption_getscaneffectenabled)([ArkUI_ProgressLinearStyleOption](#arkui_progresslinearstyleoption)\* option) | Obtains the enabled status of the smooth progress effect for the linear progress indicator.| 856| bool [OH_ArkUI_ProgressLinearStyleOption_GetSmoothEffectEnabled](#oh_arkui_progresslinearstyleoption_getsmootheffectenabled)([ArkUI_ProgressLinearStyleOption](#arkui_progresslinearstyleoption)\* option) | Obtains the enabled status of the scan effect for the linear progress indicator.| 857| float [OH_ArkUI_ProgressLinearStyleOption_GetStrokeWidth](#oh_arkui_progresslinearstyleoption_getstrokewidth)([ArkUI_ProgressLinearStyleOption](#arkui_progresslinearstyleoption)\* option) | Obtains the stroke width of the linear progress indicator.| 858| float [OH_ArkUI_ProgressLinearStyleOption_GetStrokeRadius](#oh_arkui_progresslinearstyleoption_getstrokeradius)([ArkUI_ProgressLinearStyleOption](#arkui_progresslinearstyleoption)\* option) | Obtains the corner radius of the linear progress indicator.| 859| int32_t [OH_ArkUI_NodeUtils_GetPositionToParent](#oh_arkui_nodeutils_getpositiontoparent) ([ArkUI_NodeHandle](#arkui_nodehandle) node, [ArkUI_IntOffset](_ark_u_i___int_offset.md)\* globalOffset) | Obtains the offset of a specific node relative to its parent node. | 860| int32_t [OH_ArkUI_GetGestureParam_DirectMask](#oh_arkui_getgestureparam_directmask) (ArkUI_GestureRecognizer \*recognizer, [ArkUI_GestureDirectionMask](#arkui_gesturedirectionmask)\* directMask) | Obtains the swipe direction of a gesture recognizer.| 861| int32_t [OH_ArkUI_GetGestureParam_FingerCount](#oh_arkui_getgestureparam_fingercount) (ArkUI_GestureRecognizer \*recognizer, int\* finger) | Obtains the number of fingers used by a gesture recognizer.| 862| int32_t [OH_ArkUI_GetGestureParam_limitFingerCount](#oh_arkui_getgestureparam_limitfingercount) (ArkUI_GestureRecognizer \*recognizer, bool\* isLimited) | Checks whether a gesture recognizer has a finger count limit. | 863| int32_t [OH_ArkUI_GetGestureParam_repeat](#oh_arkui_getgestureparam_repeat) (ArkUI_GestureRecognizer \*recognizer, bool\* isRepeat) | Checks whether a gesture recognizer supports repeated event callbacks.| 864| int32_t [OH_ArkUI_GetGestureParam_distance](#oh_arkui_getgestureparam_distance) (ArkUI_GestureRecognizer \*recognizer, double\* distance) | Obtains the allowed movement distance range for a gesture recognizer.| 865| int32_t [OH_ArkUI_GetGestureParam_speed](#oh_arkui_getgestureparam_speed) (ArkUI_GestureRecognizer \*recognizer, double\* speed) | Obtains the minimum swipe speed recognized by a gesture recognizer.| 866| int32_t [OH_ArkUI_GetGestureParam_duration](#oh_arkui_getgestureparam_duration) (ArkUI_GestureRecognizer \*recognizer, int\* duration) | Obtains the minimum duration required to trigger a long press by a gesture recognizer.| 867| int32_t [OH_ArkUI_GetGestureParam_angle](#oh_arkui_getgestureparam_angle) (ArkUI_GestureRecognizer \*recognizer, double\* angle) | Obtains the minimum angle change required for a rotation gesture to be recognized by a gesture recognizer.| 868| int32_t [OH_ArkUI_GetGestureParam_distanceThreshold](#oh_arkui_getgestureparam_distancethreshold) (ArkUI_GestureRecognizer \*recognizer, double\* distanceThreshold) | Obtains the movement threshold for gestures to be recognized by a gesture recognizer.| 869 870 871## Macro Description 872 873 874### OH_ArkUI_GetModuleInterface 875 876``` 877#define OH_ArkUI_GetModuleInterface( nativeAPIVariantKind, structType, structPtr ) 878``` 879**Value:** 880``` 881 do { \ 882 void* anyNativeAPI = OH_ArkUI_QueryModuleInterfaceByName(nativeAPIVariantKind, #structType); \ 883 if (anyNativeAPI) { \ 884 structPtr = (structType*)(anyNativeAPI); \ 885 } \ 886 } while (0) 887#include<arkui/native_interface.h> 888#include<arkui/native_node.h> 889 890ArkUI_NativeNodeAPI_1* nativeNodeApi = nullptr; 891OH_ArkUI_GetModuleInterface(ARKUI_NATIVE_NODE, ArkUI_NativeNodeAPI_1, nativeNodeApi); 892``` 893**Description** 894 895Obtains the macro function corresponding to a struct pointer based on the struct type. 896 897**Since**: 12 898 899 900## Type Description 901 902 903### ArkUI_AccessibilityState 904 905``` 906typedef struct ArkUI_AccessibilityState ArkUI_AccessibilityState 907``` 908**Description** 909 910Defines a struct for the component accessibility state. 911 912**Since**: 12 913 914 915### ArkUI_AccessibilityValue 916 917``` 918typedef struct ArkUI_AccessibilityValue ArkUI_AccessibilityValue 919``` 920**Description** 921 922Defines a struct for the component accessibility value. 923 924**Since**: 12 925 926 927### ArkUI_AlignmentRuleOption 928 929``` 930typedef struct ArkUI_AlignmentRuleOption ArkUI_AlignmentRuleOption 931``` 932**Description** 933 934Defines the alignment rule in the relative container. 935 936**Since**: 12 937 938 939### ArkUI_AnimateOption 940 941``` 942typedef struct ArkUI_AnimateOption ArkUI_AnimateOption 943``` 944**Description** 945 946Defines a struct for the animation configuration. 947 948**Since**: 12 949 950 951### ArkUI_AnimatorHandle 952 953``` 954typedef struct ArkUI_Animator* ArkUI_AnimatorHandle 955``` 956**Description** 957 958Defines a struct for the pointer to an animator object. 959 960**Since**: 12 961 962 963### ArkUI_AnimatorOption 964 965``` 966typedef struct ArkUI_AnimatorOption ArkUI_AnimatorOption 967``` 968**Description** 969 970Defines the animator parameter object. 971 972**Since**: 12 973 974 975### ArkUI_BarrierOption 976 977``` 978typedef struct ArkUI_BarrierOption ArkUI_BarrierOption 979``` 980**Description** 981 982Defines the ID, direction, and referenced component of a barrier. 983 984**Since**: 12 985 986 987### ArkUI_Context 988 989``` 990typedef struct ArkUI_Context ArkUI_Context 991``` 992**Description** 993 994Defines a struct for a UI context object. 995 996**Since**: 12 997 998 999### ArkUI_ContextHandle [1/2] 1000 1001``` 1002typedef struct ArkUI_Context* ArkUI_ContextHandle 1003``` 1004**Description** 1005 1006Defines a struct for the handle to the ArkUI native UI context. 1007 1008**Since**: 12 1009 1010 1011### ArkUI_ContextHandle [2/2] 1012 1013``` 1014typedef struct ArkUI_Context* ArkUI_ContextHandle 1015``` 1016**Description** 1017 1018Defines the handle to the ArkUI native UI context. 1019 1020**Since**: 12 1021 1022 1023### ArkUI_CurveHandle 1024 1025``` 1026typedef struct ArkUI_Curve* ArkUI_CurveHandle 1027``` 1028**Description** 1029 1030Defines a struct for the pointer to an interpolation curve. 1031 1032**Since**: 12 1033 1034 1035### ArkUI_CustomSpanDrawInfo 1036 1037``` 1038typedef struct ArkUI_CustomSpanDrawInfo ArkUI_CustomSpanDrawInfo 1039``` 1040**Description** 1041 1042Defines a struct for the drawing information of a custom span. 1043 1044**Since**: 12 1045 1046 1047### ArkUI_CustomSpanMeasureInfo 1048 1049``` 1050typedef struct ArkUI_CustomSpanMeasureInfo ArkUI_CustomSpanMeasureInfo 1051``` 1052**Description** 1053 1054Defines a struct for the measurement information of a custom span. 1055 1056**Since**: 12 1057 1058 1059### ArkUI_CustomSpanMetrics 1060 1061``` 1062typedef struct ArkUI_CustomSpanMetrics ArkUI_CustomSpanMetrics 1063``` 1064**Description** 1065 1066Defines a struct for the measurement metrics of a custom span. 1067 1068**Since**: 12 1069 1070 1071### ArkUI_DialogDismissEvent 1072 1073``` 1074typedef struct ArkUI_DialogDismissEvent ArkUI_DialogDismissEvent 1075``` 1076**Description** 1077 1078Defines a struct for a dialog box dismiss event. 1079 1080**Since**: 12 1081 1082### ArkUI_CustomDialogOptions 1083 1084``` 1085typedef struct ArkUI_CustomDialogOptions ArkUI_CustomDialogOptions 1086``` 1087**Description** 1088 1089Defines a struct for custom dialog box options. 1090 1091**Since**: 16 1092 1093 1094### ArkUI_DragAction 1095 1096``` 1097typedef struct ArkUI_DragAction ArkUI_DragAction 1098``` 1099**Description** 1100 1101Defines a struct for a drag action. 1102 1103**Since**: 12 1104 1105 1106### ArkUI_DragAndDropInfo 1107 1108``` 1109typedef struct ArkUI_DragAndDropInfo ArkUI_DragAndDropInfo 1110``` 1111**Description** 1112 1113Defines a struct for drag and drop information returned through a drag status listener. 1114 1115**Since**: 12 1116 1117### ArkUI_DragEvent 1118 1119``` 1120typedef struct ArkUI_DragEvent ArkUI_DragEvent 1121``` 1122**Description** 1123 1124Defines a struct for a drag event. 1125 1126**Since**: 12 1127 1128 1129### ArkUI_DragPreviewOption 1130 1131``` 1132typedef struct ArkUI_DragPreviewOption ArkUI_DragPreviewOption 1133``` 1134**Description** 1135 1136Defines a struct for custom drag preview options. 1137 1138**Since**: 12 1139 1140 1141### ArkUI_DrawableDescriptor 1142 1143``` 1144typedef struct ArkUI_DrawableDescriptor ArkUI_DrawableDescriptor 1145``` 1146**Description** 1147 1148Defines a struct for the **DrawableDescriptor** object. 1149 1150**Since**: 12 1151 1152 1153### ArkUI_DrawContext 1154 1155``` 1156typedef struct ArkUI_DrawContext ArkUI_DrawContext 1157``` 1158**Description** 1159 1160Defines the component drawing context. 1161 1162**Since**: 12 1163 1164 1165### ArkUI_GestureDirectionMask 1166 1167``` 1168typedef uint32_t ArkUI_GestureDirectionMask 1169``` 1170**Description** 1171 1172Defines a set of gesture directions. 1173 1174**Since**: 12 1175 1176 1177### ArkUI_GestureEventActionTypeMask 1178 1179``` 1180typedef uint32_t ArkUI_GestureEventActionTypeMask 1181``` 1182**Description** 1183 1184Defines a set of gesture event types. 1185 1186Example: **ArkUI_GestureEventActionTypeMask actions = GESTURE_EVENT_ACTION_ACCEPT | GESTURE_EVENT_ACTION_UPDATE** 1187 1188**Since**: 12 1189 1190 1191### ArkUI_GestureEventTargetInfo 1192 1193``` 1194typedef struct ArkUI_GestureEventTargetInfo ArkUI_GestureEventTargetInfo 1195``` 1196**Description** 1197 1198Defines a struct for a **GestureEventTargetInfo** object that provides information about a gesture event target. 1199 1200**Since**: 12 1201 1202 1203### ArkUI_GestureRecognizerDestructNotifyCallback 1204 1205``` 1206typedef void(* ArkUI_GestureRecognizerDestructNotifyCallback) (ArkUI_GestureRecognizer *recognizer, void *userData) 1207``` 1208**Description** 1209 1210Defines a callback function for notifying gesture recognizer destruction. 1211 1212**Since**: 12 1213 1214 1215### ArkUI_GestureRecognizerHandle 1216 1217``` 1218typedef ArkUI_GestureRecognizer* ArkUI_GestureRecognizerHandle 1219``` 1220**Description** 1221 1222Defines the gesture recognizer handle. 1223 1224**Since**: 12 1225 1226 1227### ArkUI_GestureRecognizerHandleArray 1228 1229``` 1230typedef ArkUI_GestureRecognizerHandle* ArkUI_GestureRecognizerHandleArray 1231``` 1232**Description** 1233 1234Defines the gesture recognizer handle array. 1235 1236**Since**: 12 1237 1238 1239### ArkUI_TouchRecognizerHandle 1240 1241``` 1242typedef ArkUI_TouchRecognizer* ArkUI_TouchRecognizerHandle 1243``` 1244**Description** 1245 1246Defines the gesture recognizer handle. 1247 1248**Since**: 15 1249 1250 1251### ArkUI_TouchRecognizerHandleArray 1252 1253``` 1254typedef ArkUI_TouchRecognizerHandle* ArkUI_TouchRecognizerHandleArray 1255``` 1256**Description** 1257 1258Defines an array of gesture recognizer handles. 1259 1260**Since**: 15 1261 1262### ArkUI_GuidelineOption 1263 1264``` 1265typedef struct ArkUI_GuidelineOption ArkUI_GuidelineOption 1266``` 1267**Description** 1268 1269Defines the ID, direction, and position of a guideline. 1270 1271**Since**: 12 1272 1273 1274### ArkUI_ImageAnimatorFrameInfo 1275 1276``` 1277typedef struct ArkUI_ImageAnimatorFrameInfo ArkUI_ImageAnimatorFrameInfo 1278``` 1279**Description** 1280 1281Defines the image frame information. 1282 1283**Since**: 12 1284 1285 1286### ArkUI_KeyframeAnimateOption 1287 1288``` 1289typedef struct ArkUI_KeyframeAnimateOption ArkUI_KeyframeAnimateOption 1290``` 1291**Description** 1292 1293Defines a struct for the keyframe animation parameter object. 1294 1295**Since**: 12 1296 1297 1298### ArkUI_LayoutConstraint 1299 1300``` 1301typedef struct ArkUI_LayoutConstraint ArkUI_LayoutConstraint 1302``` 1303**Description** 1304 1305Defines the size constraints of a component during component layout. 1306 1307**Since**: 12 1308 1309 1310### ArkUI_ListChildrenMainSize 1311 1312``` 1313typedef struct ArkUI_ListChildrenMainSize ArkUI_ListChildrenMainSize 1314``` 1315**Description** 1316 1317Defines the **ChildrenMainSize** information of the **List** component. 1318 1319**Since**: 12 1320 1321 1322### ArkUI_ListItemSwipeActionItem 1323 1324``` 1325typedef struct ArkUI_ListItemSwipeActionItem ArkUI_ListItemSwipeActionItem 1326``` 1327**Description** 1328 1329Defines the item configuration for **ListItemSwipeActionOption**. 1330 1331**Since**: 12 1332 1333 1334### ArkUI_ListItemSwipeActionOption 1335 1336``` 1337typedef struct ArkUI_ListItemSwipeActionOption ArkUI_ListItemSwipeActionOption 1338``` 1339**Description** 1340 1341Defines the configuration for **ListItemSwipeActionOption**. 1342 1343**Since**: 12 1344 1345 1346### ArkUI_NativeDialogHandle 1347 1348``` 1349typedef struct ArkUI_NativeDialog* ArkUI_NativeDialogHandle 1350``` 1351**Description** 1352 1353Defines the handle to the custom dialog box controller of ArkUI on the native side. 1354 1355**Since**: 12 1356 1357 1358### ArkUI_NodeAdapterEvent 1359 1360``` 1361typedef struct ArkUI_NodeAdapterEvent ArkUI_NodeAdapterEvent 1362``` 1363**Description** 1364 1365Defines the component adapter event. 1366 1367**Since**: 12 1368 1369 1370### ArkUI_NodeAdapterHandle 1371 1372``` 1373typedef struct ArkUI_NodeAdapter* ArkUI_NodeAdapterHandle 1374``` 1375**Description** 1376 1377Defines the component adapter, which is used for lazy loading of elements of scrollable components. 1378 1379**Since**: 12 1380 1381 1382### ArkUI_NodeContentCallback 1383 1384``` 1385typedef void(* ArkUI_NodeContentCallback) (ArkUI_NodeContentEvent *event) 1386``` 1387**Description** 1388 1389Defines the callback for the NodeContent event. 1390 1391**Since**: 12 1392 1393 1394### ArkUI_NodeContentEvent 1395 1396``` 1397typedef struct ArkUI_NodeContentEvent ArkUI_NodeContentEvent 1398``` 1399**Description** 1400 1401Defines the common structure type of a NodeContent event. 1402 1403**Since**: 12 1404 1405 1406### ArkUI_NodeContentHandle 1407 1408``` 1409typedef struct ArkUI_NodeContent* ArkUI_NodeContentHandle 1410``` 1411**Description** 1412 1413Defines the handle to the ArkUI NodeContent instance on the native side. 1414 1415**Since**: 12 1416 1417 1418### ArkUI_NodeCustomEvent 1419 1420``` 1421typedef struct ArkUI_NodeCustomEvent ArkUI_NodeCustomEvent 1422``` 1423**Description** 1424 1425Defines the common structure of a custom component event. 1426 1427**Since**: 12 1428 1429 1430### ArkUI_NodeEvent [1/2] 1431 1432``` 1433typedef struct ArkUI_NodeEvent ArkUI_NodeEvent 1434``` 1435**Description** 1436 1437Defines a struct for a component event. 1438 1439**Since**: 12 1440 1441 1442### ArkUI_NodeEvent [2/2] 1443 1444``` 1445typedef struct ArkUI_NodeEventArkUI_NodeEvent 1446``` 1447**Description** 1448 1449Defines the common structure of a component event. 1450 1451**Since**: 12 1452 1453 1454### ArkUI_NodeHandle 1455 1456``` 1457typedef struct ArkUI_Node* ArkUI_NodeHandle 1458``` 1459**Description** 1460 1461Defines the pointer to the ArkUI native component object. 1462 1463**Since**: 12 1464 1465 1466### ArkUI_OnWillDismissEvent 1467 1468``` 1469typedef bool(* ArkUI_OnWillDismissEvent) (int32_t reason) 1470``` 1471**Description** 1472 1473Defines a pointer to the callback invoked when the dialog box is closed. 1474 1475**Since**: 12 1476 1477 1478### ArkUI_ParallelInnerGestureEvent 1479 1480``` 1481typedef struct ArkUI_ParallelInnerGestureEvent ArkUI_ParallelInnerGestureEvent 1482``` 1483**Description** 1484 1485Defines a parallel internal gesture event. 1486 1487**Since**: 12 1488 1489 1490### ArkUI_GestureInterruptInfo 1491 1492``` 1493typedef struct ArkUI_GestureInterruptInfo ArkUI_GestureInterruptInfo 1494``` 1495 1496**Description** 1497 1498Defines the gesture interruption information. 1499 1500**Since**: 12 1501 1502 1503### ArkUI_StyledString 1504 1505``` 1506typedef struct ArkUI_StyledString ArkUI_StyledString 1507``` 1508**Description** 1509 1510Defines a struct for the styled string object supported by the text component. 1511 1512**Since**: 12 1513 1514 1515### ArkUI_StyledString_Descriptor 1516 1517``` 1518typedef struct ArkUI_StyledString_Descriptor ArkUI_StyledString_Descriptor 1519``` 1520**Description** 1521 1522Defines a struct for the styled string descriptor object supported by the text component. 1523 1524**Since**: 14 1525 1526 1527### ArkUI_SwiperIndicator 1528 1529``` 1530typedef struct ArkUI_SwiperIndicator ArkUI_SwiperIndicator 1531``` 1532**Description** 1533 1534Defines the navigation indicator style of the **Swiper** component. 1535 1536**Since**: 12 1537 1538 1539### ArkUI_SystemFontStyleEvent 1540 1541``` 1542typedef struct ArkUI_SystemFontStyleEvent ArkUI_SystemFontStyleEvent 1543``` 1544**Description** 1545 1546Defines a struct for the system font style event. 1547 1548**Since**: 12 1549 1550### ArkUI_SwiperDigitIndicator 1551 1552``` 1553typedef struct ArkUI_SwiperDigitIndicator ArkUI_SwiperDigitIndicator 1554``` 1555**Description** 1556 1557Defines the digit-style navigation indicator of the **Swiper** component. 1558 1559**Since**: 18 1560 1561### ArkUI_SwiperArrowStyle 1562 1563``` 1564typedef struct ArkUI_SwiperArrowStyle ArkUI_SwiperArrowStyle 1565``` 1566**Description** 1567 1568Defines the arrow style for the **Swiper** component. 1569 1570**Since**: 18 1571 1572### ArkUI_TransitionEffect 1573 1574``` 1575typedef struct ArkUI_TransitionEffect ArkUI_TransitionEffect 1576``` 1577**Description** 1578 1579Defines a struct for the transition effect. 1580 1581**Since**: 12 1582 1583 1584### ArkUI_WaterFlowSectionOption 1585 1586``` 1587typedef struct ArkUI_WaterFlowSectionOption ArkUI_WaterFlowSectionOption 1588``` 1589**Description** 1590 1591Defines the water flow section configuration. 1592 1593**Since**: 12 1594 1595 1596### OH_PixelmapNative 1597 1598``` 1599typedef struct OH_PixelmapNative OH_PixelmapNative 1600``` 1601**Description** 1602 1603Defines the **Pixelmap** struct, which is used to perform operations related to a pixel map. 1604 1605**Since**: 12 1606 1607 1608### OH_PixelmapNativeHandle 1609 1610``` 1611typedef struct OH_PixelmapNative* OH_PixelmapNativeHandle 1612``` 1613**Description** 1614 1615Defines a struct for the pointer to an **OH_PixelmapNative** object. 1616 1617**Since**: 12 1618 1619 1620### OH_UdmfData 1621 1622``` 1623typedef struct OH_UdmfData OH_UdmfData 1624``` 1625**Description** 1626 1627Defines a struct for UDMF unified data. 1628 1629**Since**: 12 1630 1631 1632### ArkUI_ProgressLinearStyleOption 1633 1634``` 1635typedef struct ArkUI_ProgressLinearStyleOption ArkUI_ProgressLinearStyleOption 1636``` 1637**Description** 1638 1639Defines the style information for a linear progress indicator in the **Progress** component. 1640 1641**Since**: 15 1642 1643### OH_HostWindowInfo 1644 1645``` 1646typedef struct ArkUI_HostWindowInfo ArkUI_HostWindowInfo 1647``` 1648**Description** 1649 1650Defines a struct for the host window information. 1651 1652**Since**: 15 1653 1654 1655### OH_UdmfGetDataParams 1656 1657``` 1658typedef struct OH_UdmfGetDataParams OH_UdmfGetDataParams 1659``` 1660**Description** 1661 1662Defines the parameters used for obtaining data from UDMF. 1663 1664**Since**: 15 1665 1666### ArkUI_VisibleAreaEventOptions 1667 1668``` 1669typedef struct ArkUI_VisibleAreaEventOptions ArkUI_VisibleAreaEventOptions 1670``` 1671**Description** 1672 1673Defines the parameters for visible area change events. 1674 1675**Since**: 18 1676 1677 1678### ArkUI_TextPickerRangeContentArray 1679``` 1680typedef struct ArkUI_TextPickerRangeContentArray ArkUI_TextPickerRangeContentArray 1681``` 1682**Description** 1683 1684Defines the data selection list for the text picker. 1685 1686**Since**: 18 1687 1688### ArkUI_TextCascadePickerRangeContentArray 1689 1690``` 1691typedef struct ArkUI_TextCascadePickerRangeContentArray ArkUI_TextCascadePickerRangeContentArray 1692``` 1693**Description** 1694 1695Defines the content array for a multi-column cascading data picker. 1696 1697**Since**: 18 1698 1699## Enum Description 1700 1701 1702### ArkUI_AccessibilityActionType 1703 1704``` 1705enum ArkUI_AccessibilityActionType 1706``` 1707**Description** 1708 1709Defines an enum for the accessibility action types. 1710 1711**Since**: 12 1712 1713| Enum| Description| 1714| -------- | -------- | 1715| ARKUI_ACCESSIBILITY_ACTION_CLICK | Tapping | 1716| ARKUI_ACCESSIBILITY_ACTION_LONG_CLICK | Long press | 1717| ARKUI_ACCESSIBILITY_ACTION_CUT | Cut. | 1718| ARKUI_ACCESSIBILITY_ACTION_COPY | | 1719| ARKUI_ACCESSIBILITY_ACTION_PASTE | Paste. | 1720 1721 1722### ArkUI_AccessibilityCheckedState 1723 1724``` 1725enum ArkUI_AccessibilityCheckedState 1726``` 1727**Description** 1728 1729Enumerates the accessibility check box states. 1730 1731**Since**: 12 1732 1733| Enum| Description| 1734| -------- | -------- | 1735| ARKUI_ACCESSIBILITY_UNCHECKED | The check box is not selected. | 1736| ARKUI_ACCESSIBILITY_CHECKED | The check box is selected. | 1737 1738 1739### ArkUI_AccessibilityMode 1740 1741``` 1742enum ArkUI_AccessibilityMode 1743``` 1744**Description** 1745 1746Enumerates the accessibility modes. 1747 1748**Since**: 12 1749 1750| Enum| Description| 1751| -------- | -------- | 1752| ARKUI_ACCESSIBILITY_MODE_AUTO | The mode is automatically set to enabled or disabled based on the component. | 1753| ARKUI_ACCESSIBILITY_MODE_ENABLED | The component can be identified by the accessibility service. | 1754| ARKUI_ACCESSIBILITY_MODE_DISABLED | The component cannot be identified by the accessibility service. | 1755| ARKUI_ACCESSIBILITY_MODE_DISABLED_FOR_DESCENDANTS | The component and all its child components cannot be identified by the accessibility service. | 1756 1757 1758### ArkUI_AdaptiveColor 1759 1760``` 1761enum ArkUI_AdaptiveColor 1762``` 1763**Description** 1764 1765Enumerates the adaptive color modes. 1766 1767**Since**: 12 1768 1769| Enum| Description| 1770| -------- | -------- | 1771| ARKUI_ADAPTIVE_COLOR_DEFAULT | Adaptive color mode is not used. | 1772| ARKUI_ADAPTIVE_COLOR_AVERAGE | Adaptive color mode is used. | 1773 1774 1775### ArkUI_Alignment 1776 1777``` 1778enum ArkUI_Alignment 1779``` 1780**Description** 1781 1782Enumerates the alignment modes. 1783 1784**Since**: 12 1785 1786| Enum| Description| 1787| -------- | -------- | 1788| ARKUI_ALIGNMENT_TOP_START | Top start. | 1789| ARKUI_ALIGNMENT_TOP | Top center. | 1790| ARKUI_ALIGNMENT_TOP_END | Top end. | 1791| ARKUI_ALIGNMENT_START | Vertically centered start. | 1792| ARKUI_ALIGNMENT_CENTER | Horizontally and vertically centered. | 1793| ARKUI_ALIGNMENT_END | Vertically centered end. | 1794| ARKUI_ALIGNMENT_BOTTOM_START | Bottom start. | 1795| ARKUI_ALIGNMENT_BOTTOM | Horizontally centered on the bottom. | 1796| ARKUI_ALIGNMENT_BOTTOM_END | Bottom end. | 1797 1798 1799### ArkUI_AnimationCurve 1800 1801``` 1802enum ArkUI_AnimationCurve 1803``` 1804**Description** 1805 1806Enumerates the animation curves. 1807 1808**Since**: 12 1809 1810| Enum| Description| 1811| -------- | -------- | 1812| ARKUI_CURVE_LINEAR | The animation speed keeps unchanged. | 1813| ARKUI_CURVE_EASE | The animation starts slowly, accelerates, and then slows down towards the end. | 1814| ARKUI_CURVE_EASE_IN | The animation starts at a low speed and then picks up speed until the end. | 1815| ARKUI_CURVE_EASE_OUT | The animation ends at a low speed. | 1816| ARKUI_CURVE_EASE_IN_OUT | The animation starts and ends at a low speed. | 1817| ARKUI_CURVE_FAST_OUT_SLOW_IN | The animation uses the standard curve | 1818| ARKUI_CURVE_LINEAR_OUT_SLOW_IN | The animation uses the deceleration curve. | 1819| ARKUI_CURVE_FAST_OUT_LINEAR_IN | The animation uses the acceleration curve. | 1820| ARKUI_CURVE_EXTREME_DECELERATION | The animation uses the extreme deceleration curve. | 1821| ARKUI_CURVE_SHARP | The animation uses the sharp curve. | 1822| ARKUI_CURVE_RHYTHM | The animation uses the rhythm curve. | 1823| ARKUI_CURVE_SMOOTH | The animation uses the smooth curve. | 1824| ARKUI_CURVE_FRICTION | The animation uses the friction curve | 1825 1826 1827### ArkUI_AnimationDirection 1828 1829``` 1830enum ArkUI_AnimationDirection 1831``` 1832**Description** 1833 1834Enumerates the animation playback modes. 1835 1836**Since**: 12 1837 1838| Enum| Description| 1839| -------- | -------- | 1840| ARKUI_ANIMATION_DIRECTION_NORMAL | The animation plays in forward loop mode. | 1841| ARKUI_ANIMATION_DIRECTION_REVERSE | The animation plays in reverse loop mode. | 1842| ARKUI_ANIMATION_DIRECTION_ALTERNATE | The animation plays in alternating loop mode. When the animation is played for an odd number of times, the playback is in forward direction. When the animation is played for an even number of times, the playback is in reverse direction. | 1843| ARKUI_ANIMATION_DIRECTION_ALTERNATE_REVERSE | The animation plays in reverse alternating loop mode. When the animation is played for an odd number of times, the playback is in reverse direction. When the animation is played for an even number of times, the playback is in forward direction. | 1844 1845 1846### ArkUI_AnimationFill 1847 1848``` 1849enum ArkUI_AnimationFill 1850``` 1851**Description** 1852 1853Enumerates the state of the animated target after the animation is executed. 1854 1855**Since**: 12 1856 1857| Enum| Description| 1858| -------- | -------- | 1859| ARKUI_ANIMATION_FILL_NONE | No style is applied to the target before or after the animation is executed. | 1860| ARKUI_ANIMATION_FILL_FORWARDS | The target keeps the state at the end of the animation (defined in the last key frame) after the animation is executed. | 1861| ARKUI_ANIMATION_FILL_BACKWARDS | The animation uses the value defined in the first key frame during the duration defined by **animation-delay**. | 1862| ARKUI_ANIMATION_FILL_BOTH | The animation follows the **forwards** and **backwards** rules. | 1863 1864 1865### ArkUI_AnimationFillMode 1866 1867``` 1868enum ArkUI_AnimationFillMode 1869``` 1870**Description** 1871 1872Enumerates the states before and after execution of the frame-by-frame animation. 1873 1874**Since**: 12 1875 1876| Enum| Description| 1877| -------- | -------- | 1878| ARKUI_ANIMATION_FILL_MODE_NONE | Before execution, the animation does not apply any styles to the target component. After execution, the animation restores the target component to its default state. | 1879| ARKUI_ANIMATION_FILL_MODE_FORWARDS | The target component retains the state set by the last keyframe encountered during execution of the animation. | 1880| ARKUI_ANIMATION_FILL_MODE_BACKWARDS | The animation applies the values defined in the first relevant keyframe once it is applied to the target component, and retains the values during the period set by **delay**. | 1881| ARKUI_ANIMATION_FILL_MODE_BOTH | The animation follows the rules for both **Forwards** and **Backwards**, extending the animation attributes in both directions. | 1882 1883 1884### ArkUI_AnimationPlayMode 1885 1886``` 1887enum ArkUI_AnimationPlayMode 1888``` 1889**Description** 1890 1891Enumerates the animation playback modes. 1892 1893**Since**: 12 1894 1895| Enum| Description| 1896| -------- | -------- | 1897| ARKUI_ANIMATION_PLAY_MODE_NORMAL | The animation is played forwards. | 1898| ARKUI_ANIMATION_PLAY_MODE_REVERSE | The animation is played backwards. | 1899| ARKUI_ANIMATION_PLAY_MODE_ALTERNATE | The animation is played forwards for an odd number of times (1, 3, 5...) and backwards for an even number of times (2, 4, 6...). | 1900| ARKUI_ANIMATION_PLAY_MODE_ALTERNATE_REVERSE | The animation is played backwards for an odd number of times (1, 3, 5...) and forwards for an even number of times (2, 4, 6...). | 1901 1902 1903### ArkUI_AnimationStatus 1904 1905``` 1906enum ArkUI_AnimationStatus 1907``` 1908**Description** 1909 1910Enumerates the playback states of the frame-by-frame animation. 1911 1912**Since**: 12 1913 1914| Enum| Description| 1915| -------- | -------- | 1916| ARKUI_ANIMATION_STATUS_INITIAL | The animation is in the initial state. | 1917| ARKUI_ANIMATION_STATUS_RUNNING | The animation is being played. | 1918| ARKUI_ANIMATION_STATUS_PAUSED | The animation is paused. | 1919| ARKUI_ANIMATION_STATUS_STOPPED | The animation is stopped. | 1920 1921 1922### ArkUI_Axis 1923 1924``` 1925enum ArkUI_Axis 1926``` 1927**Description** 1928 1929Enumerates the scroll directions. 1930 1931**Since**: 12 1932 1933| Enum| Description| 1934| -------- | -------- | 1935| ARKUI_AXIS_VERTICAL | Only vertical scrolling is supported. | 1936| ARKUI_AXIS_HORIZONTAL | Only horizontal scrolling is supported. | 1937 1938 1939### ArkUI_BarrierDirection 1940 1941``` 1942enum ArkUI_BarrierDirection 1943``` 1944**Description** 1945 1946Enumerates the barrier directions. 1947 1948**Since**: 12 1949 1950| Enum| Description| 1951| -------- | -------- | 1952| ARKUI_BARRIER_DIRECTION_START | The barrier is on the left side of all the referenced components specified by referencedId. | 1953| ARKUI_BARRIER_DIRECTION_END | The barrier is on the right side of all the referenced components specified by referencedId. | 1954| ARKUI_BARRIER_DIRECTION_TOP | The barrier is at the top of all the referenced components specified by referencedId. | 1955| ARKUI_BARRIER_DIRECTION_BOTTOM | The barrier is at the bottom of all the referenced components specified by referencedId. | 1956 1957 1958### ArkUI_BlendApplyType 1959 1960``` 1961enum ArkUI_BlendApplyType 1962``` 1963**Description** 1964 1965Defines how the specified blend mode is applied. 1966 1967**Since**: 12 1968 1969| Enum| Description| 1970| -------- | -------- | 1971| BLEND_APPLY_TYPE_FAST | The content of the view is blended in sequence on the target image. | 1972| BLEND_APPLY_TYPE_OFFSCREEN | The content of the component and its child components are drawn on the offscreen canvas, and then blended with the existing content on the canvas.| 1973 1974 1975### ArkUI_BlendMode 1976 1977``` 1978enum ArkUI_BlendMode 1979``` 1980**Description** 1981 1982Enumerates the blend modes. 1983 1984**Since**: 12 1985 1986| Enum| Description| 1987| -------- | -------- | 1988| ARKUI_BLEND_MODE_NONE | The top image is superimposed on the bottom image without any blending. | 1989| ARKUI_BLEND_MODE_CLEAR | The target pixels covered by the source pixels are erased by being turned to completely transparent. | 1990| ARKUI_BLEND_MODE_SRC | r = s: Only the source pixels are displayed. | 1991| ARKUI_BLEND_MODE_DST | r = d: Only the target pixels are displayed. | 1992| ARKUI_BLEND_MODE_SRC_OVER | r = s + (1 - sa) \d: The source pixels are blended based on opacity and cover the target pixels. | 1993| ARKUI_BLEND_MODE_DST_OVER | r = d + (1 - da) *\ s: The target pixels are blended based on opacity and cover on the source pixels. | 1994| ARKUI_BLEND_MODE_SRC_IN | r = s \* da: Only the part of the source pixels that overlap with the target pixels is displayed. | 1995| ARKUI_BLEND_MODE_DST_IN | r = d \* sa: Only the part of the target pixels that overlap with the source pixels is displayed. | 1996| ARKUI_BLEND_MODE_SRC_OUT | r = s \* (1 - da): Only the part of the source pixels that do not overlap with the target pixels is displayed. | 1997| ARKUI_BLEND_MODE_DST_OUT | r = d \* (1 - sa): Only the part of the target pixels that do not overlap with the source pixels is displayed. | 1998| ARKUI_BLEND_MODE_SRC_ATOP | r = s \da + d \(1 - sa): The part of the source pixels that overlap with the target pixels is displayed and the part of the target pixels that do not overlap with the source pixels are displayed. | 1999| ARKUI_BLEND_MODE_DST_ATOP | r = d \sa + s \(1 - da): The part of the target pixels that overlap with the source pixels and the part of the source pixels that do not overlap with the target pixels are displayed. | 2000| ARKUI_BLEND_MODE_XOR | r = s \* (1 - da) + d \* (1 - sa): Only the non-overlapping part between the source pixels and the target pixels is displayed. | 2001| ARKUI_BLEND_MODE_PLUS | r = min(s + d, 1): New pixels resulting from adding the source pixels to the target pixels are displayed. | 2002| ARKUI_BLEND_MODE_MODULATE | r = s \* d: New pixels resulting from multiplying the source pixels with the target pixels are displayed. | 2003| ARKUI_BLEND_MODE_SCREEN | r = s + d - s \* d: Pixels are blended by adding the source pixels to the target pixels and subtracting the product of their multiplication. | 2004| ARKUI_BLEND_MODE_OVERLAY | The MULTIPLY or SCREEN mode is used based on the target pixels. | 2005| ARKUI_BLEND_MODE_DARKEN | rc = s + d - max(s \da, d \sa), ra = kSrcOver: When two colors overlap, whichever is darker is used. | 2006| ARKUI_BLEND_MODE_LIGHTEN | rc = s + d - min(s \da, d \sa), ra = kSrcOver: The darker of the pixels (source and target) is used. | 2007| ARKUI_BLEND_MODE_COLOR_DODGE | The colors of the target pixels are lightened to reflect the source pixels. | 2008| ARKUI_BLEND_MODE_COLOR_BURN | The colors of the target pixels are darkened to reflect the source pixels. | 2009| ARKUI_BLEND_MODE_HARD_LIGHT | The MULTIPLY or SCREEN mode is used, depending on the source pixels. | 2010| ARKUI_BLEND_MODE_SOFT_LIGHT | The LIGHTEN or DARKEN mode is used, depending on the source pixels. | 2011| ARKUI_BLEND_MODE_DIFFERENCE | rc = s + d - 2 \* (min(s \* da, d \vsa)), ra = kSrcOver: The final pixel is the result of subtracting the darker of the two pixels (source and target) from the lighter one. | 2012| ARKUI_BLEND_MODE_EXCLUSION | rc = s + d - two(s \* d), ra = kSrcOver: The final pixel is similar to **DIFFERENCE**, but with less contrast. | 2013| ARKUI_BLEND_MODE_MULTIPLY | r = s \* (1 - da) + d \* (1 - sa) + s \* d: The final pixel is the result of multiplying the source pixel by the target pixel.| 2014| ARKUI_BLEND_MODE_HUE | The resultant image is created with the luminance and saturation of the source image and the hue of the target image. | 2015| ARKUI_BLEND_MODE_SATURATION | The resultant image is created with the luminance and hue of the target image and the saturation of the source image. | 2016| ARKUI_BLEND_MODE_COLOR | The resultant image is created with the saturation and hue of the source image and the luminance of the target image. | 2017| ARKUI_BLEND_MODE_LUMINOSITY | The resultant image is created with the saturation and hue of the target image and the luminance of the source image. | 2018 2019 2020### ArkUI_BlurStyle 2021 2022``` 2023enum ArkUI_BlurStyle 2024``` 2025**Description** 2026 2027Enumerates the blur styles. 2028 2029**Since**: 12 2030 2031| Enum| Description| 2032| -------- | -------- | 2033| ARKUI_BLUR_STYLE_THIN | Thin material. | 2034| ARKUI_BLUR_STYLE_REGULAR | Regular material. | 2035| ARKUI_BLUR_STYLE_THICK | Thick material. | 2036| ARKUI_BLUR_STYLE_BACKGROUND_THIN | Material that creates the minimum depth of field effect. | 2037| ARKUI_BLUR_STYLE_BACKGROUND_REGULAR | Material that creates a medium shallow depth of field effect. | 2038| ARKUI_BLUR_STYLE_BACKGROUND_THICK | Material that creates a high shallow depth of field effect. | 2039| ARKUI_BLUR_STYLE_BACKGROUND_ULTRA_THICK | Material that creates the maximum depth of field effect. | 2040| ARKUI_BLUR_STYLE_NONE | No blur. | 2041| ARKUI_BLUR_STYLE_COMPONENT_ULTRA_THIN | Component ultra-thin material. | 2042| ARKUI_BLUR_STYLE_COMPONENT_THIN | Component thin material. | 2043| ARKUI_BLUR_STYLE_COMPONENT_REGULAR | Component regular material. | 2044| ARKUI_BLUR_STYLE_COMPONENT_THICK | Component thick material. | 2045| ARKUI_BLUR_STYLE_COMPONENT_ULTRA_THICK | Component ultra-thick material. | 2046 2047 2048### ArkUI_BorderStyle 2049 2050``` 2051enum ArkUI_BorderStyle 2052``` 2053**Description** 2054 2055Enumerates the border styles. 2056 2057**Since**: 12 2058 2059| Enum| Description| 2060| -------- | -------- | 2061| ARKUI_BORDER_STYLE_SOLID | Solid border. | 2062| ARKUI_BORDER_STYLE_DASHED | Dashed border. | 2063| ARKUI_BORDER_STYLE_DOTTED | Dotted border. | 2064 2065 2066### ArkUI_ButtonType 2067 2068``` 2069enum ArkUI_ButtonType 2070``` 2071**Description** 2072 2073Enumerates the button types. 2074 2075**Since**: 12 2076 2077| Enum| Description| 2078| -------- | -------- | 2079| ARKUI_BUTTON_TYPE_NORMAL | Normal button (without rounded corners by default). | 2080| ARKUI_BUTTON_TYPE_CAPSULE | Capsule-type button (the round corner is half of the height by default). | 2081| ARKUI_BUTTON_TYPE_CIRCLE | Circle button. | 2082 2083 2084### ArkUI_CalendarAlignment 2085 2086``` 2087enum ArkUI_CalendarAlignment 2088``` 2089**Description** 2090 2091Enumerates the alignment modes between the calendar picker and the entry component. 2092 2093**Since**: 12 2094 2095| Enum| Description| 2096| -------- | -------- | 2097| ARKUI_CALENDAR_ALIGNMENT_START | Left aligned. | 2098| ARKUI_CALENDAR_ALIGNMENT_CENTER | Center aligned. | 2099| ARKUI_CALENDAR_ALIGNMENT_END | Right aligned. | 2100 2101 2102### ArkUI_CancelButtonStyle 2103 2104``` 2105enum ArkUI_CancelButtonStyle 2106``` 2107**Description** 2108 2109Enumerates the styles of the Cancel button. 2110 2111**Since**: 12 2112 2113| Enum| Description| 2114| -------- | -------- | 2115| ARKUI_CANCELBUTTON_STYLE_CONSTANT | The Cancel button is always displayed. | 2116| ARKUI_CANCELBUTTON_STYLE_INVISIBLE | The Cancel button is always hidden. | 2117| ARKUI_CANCELBUTTON_STYLE_INPUT | The Cancel button is displayed when there is text input. | 2118 2119 2120### ArkUI_CheckboxShape 2121 2122``` 2123enum ArkUI_CheckboxShape 2124``` 2125**Description** 2126 2127Enumerates the shapes of the check box. 2128 2129**Since**: 12 2130 2131| Enum| Description| 2132| -------- | -------- | 2133| ArkUI_CHECKBOX_SHAPE_CIRCLE | Circle. | 2134| ArkUI_CHECKBOX_SHAPE_ROUNDED_SQUARE | Rounded square. | 2135 2136 2137### ArkUI_ClipType 2138 2139``` 2140enum ArkUI_ClipType 2141``` 2142**Description** 2143 2144Enumerates the clipping region types. 2145 2146**Since**: 12 2147 2148| Enum| Description| 2149| -------- | -------- | 2150| ARKUI_CLIP_TYPE_RECTANGLE | Rectangle. | 2151| ARKUI_CLIP_TYPE_CIRCLE | **(circle)** | 2152| ARKUI_CLIP_TYPE_ELLIPSE | Ellipse. | 2153| ARKUI_CLIP_TYPE_PATH | Path Type | 2154 2155 2156### ArkUI_ColorMode 2157 2158``` 2159enum ArkUI_ColorMode 2160``` 2161**Description** 2162 2163Enumerates the color modes. 2164 2165**Since**: 12 2166 2167| Enum| Description| 2168| -------- | -------- | 2169| ARKUI_COLOR_MODE_SYSTEM | Following the system color mode. | 2170| ARKUI_COLOR_MODE_LIGHT | Light color mode. | 2171| ARKUI_COLOR_MODE_DARK | Dark color mode. | 2172 2173 2174### ArkUI_ColorStrategy 2175 2176``` 2177enum ArkUI_ColorStrategy 2178``` 2179**Description** 2180 2181Enumerates the foreground colors. 2182 2183**Since**: 12 2184 2185| Enum| Description| 2186| -------- | -------- | 2187| ARKUI_COLOR_STRATEGY_INVERT | The foreground colors are the inverse of the component background colors. | 2188| ARKUI_COLOR_STRATEGY_AVERAGE | The shadow colors of the component are the average color obtained from the component background shadow area. | 2189| ARKUI_COLOR_STRATEGY_PRIMARY | The shadow colors of the component are the primary color obtained from the component background shadow area. | 2190 2191 2192### ArkUI_CopyOptions 2193 2194``` 2195enum ArkUI_CopyOptions 2196``` 2197**Description** 2198 2199Enumerates the text copy and paste modes. 2200 2201**Since**: 12 2202 2203| Enum| Description| 2204| -------- | -------- | 2205| ARKUI_COPY_OPTIONS_NONE | Copy is not allowed. | 2206| ARKUI_COPY_OPTIONS_IN_APP | Intra-application copy is allowed. | 2207| ARKUI_COPY_OPTIONS_LOCAL_DEVICE | Intra-device copy is allowed. | 2208| ARKUI_COPY_OPTIONS_CROSS_DEVICE | Cross-device copy is allowed. | 2209 2210 2211### ArkUI_Direction 2212 2213``` 2214enum ArkUI_Direction 2215``` 2216**Description** 2217 2218Enumerates the modes in which components are laid out along the main axis of the container. 2219 2220**Since**: 12 2221 2222| Enum| Description| 2223| -------- | -------- | 2224| ARKUI_DIRECTION_LTR | Components are arranged from left to right. | 2225| ARKUI_DIRECTION_RTL | Components are arranged from right to left. | 2226| ARKUI_DIRECTION_AUTO | The default layout direction is used. | 2227 2228 2229### ArkUI_DismissReason 2230 2231``` 2232enum ArkUI_DismissReason 2233``` 2234**Description** 2235 2236Enumerates the actions for triggering closure of the dialog box. 2237 2238**Since**: 12 2239 2240| Enum| Description| 2241| -------- | -------- | 2242| DIALOG_DISMISS_BACK_PRESS | Touching the system-defined Back button or pressing the Esc key. | 2243| DIALOG_DISMISS_TOUCH_OUTSIDE | Touching the mask. | 2244| DIALOG_DISMISS_CLOSE_BUTTON | Touching the Close button. | 2245| DIALOG_DISMISS_SLIDE_DOWN | Sliding down. | 2246 2247 2248### ArkUI_LevelMode 2249 2250``` 2251enum ArkUI_LevelMode 2252``` 2253**Description** 2254 2255Enumerates the display level modes of the dialog box. 2256 2257**Since**: 15 2258 2259| Enum| Description| 2260| -------- | -------- | 2261| ARKUI_LEVEL_MODE_OVERLAY | The dialog box is displayed on top of all other application content. | 2262| ARKUI_LEVEL_MODE_EMBEDDED | The dialog box is embedded within the application's page content. | 2263 2264### ArkUI_ImmersiveMode 2265 2266``` 2267enum ArkUI_ImmersiveMode 2268``` 2269**Description** 2270 2271Enumerates the display areas of the embedded dialog box overlay. 2272 2273**Since**: 15 2274 2275| Enum| Description| 2276| -------- | -------- | 2277| ARKUI_IMMERSIVE_MODE_DEFAULT | The dialog box overlay follows the layout constraints of its parent node. | 2278| ARKUI_IMMERSIVE_MODE_EXTEND | The dialog box overlay can extend to cover the status bar and navigation bar for a more immersive look. | 2279 2280### ArkUI_DragPreviewScaleMode 2281 2282``` 2283enum ArkUI_DragPreviewScaleMode 2284``` 2285**Description** 2286 2287Defines an enum for drag preview scale modes. 2288 2289**Since**: 12 2290 2291| Enum| Description| 2292| -------- | -------- | 2293| ARKUI_DRAG_PREVIEW_SCALE_AUTO | The system automatically changes the position of the dragged point based on the scenario and scales the drag preview based on set rules. | 2294| ARKUI_DRAG_PREVIEW_SCALE_DISABLED | The system does not scale the drag preview. | 2295 2296 2297### ArkUI_DragResult 2298 2299``` 2300enum ArkUI_DragResult 2301``` 2302**Description** 2303 2304Defines an enum for drag results, which are set by the data receiver and transferred by the system to the drag source so that the drag source is aware of the data processing result of the receiver. 2305 2306**Since**: 12 2307 2308| Enum| Description| 2309| -------- | -------- | 2310| ARKUI_DRAG_RESULT_SUCCESSFUL | The drag and drop operation succeeded. | 2311| ARKUI_DRAG_RESULT_FAILED | The drag and drop operation failed. | 2312| ARKUI_DRAG_RESULT_CANCELED | The drag and drop operation was canceled. | 2313 2314 2315### ArkUI_DragStatus 2316 2317``` 2318enum ArkUI_DragStatus 2319``` 2320**Description** 2321 2322Enumerates dragging states. 2323 2324**Since**: 12 2325 2326| Enum| Description| 2327| -------- | -------- | 2328| ArkUI_DRAG_STATUS_UNKNOWN | Unknown. | 2329| ArkUI_DRAG_STATUS_STARTED | Started. | 2330| ArkUI_DRAG_STATUS_ENDED | Ended. | 2331 2332 2333### ArkUI_DropOperation 2334 2335``` 2336enum ArkUI_DropOperation 2337``` 2338**Description** 2339 2340Defines an enum for data processing modes used when data is dropped, which affects the display of the badge. 2341 2342**Since**: 12 2343 2344| Enum| Description| 2345| -------- | -------- | 2346| ARKUI_DROP_OPERATION_COPY | Copy. | 2347| ARKUI_DROP_OPERATION_MOVE | Cut. | 2348 2349 2350### ArkUI_EdgeEffect 2351 2352``` 2353enum ArkUI_EdgeEffect 2354``` 2355**Description** 2356 2357Enumerates the effects used at the edges of the component when the boundary of the scrollable content is reached. 2358 2359**Since**: 12 2360 2361| Enum| Description| 2362| -------- | -------- | 2363| ARKUI_EDGE_EFFECT_SPRING | Spring effect. When at one of the edges, the component can move beyond the bounds through touches, and produces a bounce effect when the user releases their finger. | 2364| ARKUI_EDGE_EFFECT_FADE | Fade effect. When at one of the edges, the component produces a fade effect. | 2365| ARKUI_EDGE_EFFECT_NONE | No effect when the component is at one of the edges. | 2366 2367 2368### ArkUI_EffectEdge 2369 2370``` 2371enum ArkUI_EffectEdge 2372``` 2373**Description** 2374 2375Enumerates the edges for which the effect takes effect when the boundary of the scrollable content is reached. 2376 2377**Since**: 17 2378 2379| Enum| Description| 2380| -------- | -------- | 2381| ARKUI_EFFECT_EDGE_START | Start edge. | 2382| ARKUI_EFFECT_EDGE_END | End edge. | 2383 2384 2385### ArkUI_EllipsisMode 2386 2387``` 2388enum ArkUI_EllipsisMode 2389``` 2390**Description** 2391 2392Enumerates the ellipsis positions. 2393 2394**Since**: 12 2395 2396| Enum| Description| 2397| -------- | -------- | 2398| ARKUI_ELLIPSIS_MODE_START | An ellipsis is used at the start of the line of text. | 2399| ARKUI_ELLIPSIS_MODE_CENTER | An ellipsis is used at the center of the line of text. | 2400| ARKUI_ELLIPSIS_MODE_END | An ellipsis is used at the end of the line of text. | 2401 2402 2403### ArkUI_EnterKeyType 2404 2405``` 2406enum ArkUI_EnterKeyType 2407``` 2408**Description** 2409 2410Enumerates the types of the Enter key for a single-line text box. 2411 2412**Since**: 12 2413 2414| Enum| Description| 2415| -------- | -------- | 2416| ARKUI_ENTER_KEY_TYPE_GO | The Enter key is labeled "Go." | 2417| ARKUI_ENTER_KEY_TYPE_SEARCH | The Enter key is labeled "Search." | 2418| ARKUI_ENTER_KEY_TYPE_SEND | The Enter key is labeled "Send." | 2419| ARKUI_ENTER_KEY_TYPE_NEXT | The Enter key is labeled "Next." | 2420| ARKUI_ENTER_KEY_TYPE_DONE | The Enter key is labeled "Done." | 2421| ARKUI_ENTER_KEY_TYPE_PREVIOUS | The Enter key is labeled "Previous." | 2422| ARKUI_ENTER_KEY_TYPE_NEW_LINE | The Enter key is labeled "Return." | 2423 2424 2425### ArkUI_ErrorCode 2426 2427``` 2428enum ArkUI_ErrorCode 2429``` 2430**Description** 2431 2432Defines an enum for the error codes. 2433 2434**Since**: 12 2435 2436| Enum| Description| 2437| -------- | -------- | 2438| ARKUI_ERROR_CODE_NO_ERROR | No error. | 2439| ARKUI_ERROR_CODE_PARAM_INVALID | Parameter error. | 2440| ARKUI_ERROR_CODE_ATTRIBUTE_OR_EVENT_NOT_SUPPORTED | The component does not support specific attributes or events. | 2441| ARKUI_ERROR_CODE_NOT_SUPPROTED_FOR_ARKTS_NODE | The specific operation is not allowed on the node created by ArkTS. | 2442| ARKUI_ERROR_CODE_NODE_ADAPTER_NONE_HOST | The adapter for lazy loading is not bound to the component. | 2443| ARKUI_ERROR_CODE_NODE_ADAPTER_EXIST_IN_HOST | The adapter already exists. | 2444| ARKUI_ERROR_CODE_NODE_ADAPTER_CHILD_NODE_EXIST | Failed to add the adapter because the corresponding node already has a subnode. | 2445| ARKUI_ERROR_CODE_NODE_EVENT_PARAM_INDEX_OUT_OF_RANGE | The parameter length in the parameter event exceeds the limit. | 2446| ARKUI_ERROR_CODE_NODE_EVENT_PARAM_INVALID | The data does not exist in the component event. | 2447| ARKUI_ERROR_CODE_NODE_EVENT_NO_RETURN | The component event does not support return values. | 2448| ARKUI_ERROR_CODE_NODE_INDEX_INVALID | Invalid index. | 2449| ARKUI_ERROR_CODE_GET_INFO_FAILED | Failed to obtain the route navigation information. | 2450| ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR | Buffer size error. | 2451| ARKUI_ERROR_CODE_FOCUS_NON_FOCUSABLE | The current node is not focusable.| 2452| ARKUI_ERROR_CODE_FOCUS_NON_FOCUSABLE_ANCESTOR | An ancestor of the current node is not focusable.| 2453| ARKUI_ERROR_CODE_FOCUS_NON_EXISTENT | The current node does not exist.| 2454| ARKUI_ERROR_CODE_NON_SCROLLABLE_CONTAINER | The component is not a scrollable container. | 2455| ARKUI_ERROR_CODE_BUFFER_SIZE_NOT_ENOUGH | The buffer is not large enough. | 2456| ARKUI_ERROR_CODE_INVALID_STYLED_STRING | Invalid styled string. | 2457| ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED | The gesture recognizer type is not supported. | 2458 2459 2460### ArkUI_FinishCallbackType 2461 2462``` 2463enum ArkUI_FinishCallbackType 2464``` 2465**Description** 2466 2467Enumerates the animation **onFinish** callback types. 2468 2469**Since**: 12 2470 2471| Enum| Description| 2472| -------- | -------- | 2473| ARKUI_FINISH_CALLBACK_REMOVED | The callback is invoked when the entire animation is removed once it has finished. | 2474| ARKUI_FINISH_CALLBACK_LOGICALLY | The callback is invoked when the animation logically enters the falling state, though it may still be in its long tail state. | 2475 2476 2477### ArkUI_FlexAlignment 2478 2479``` 2480enum ArkUI_FlexAlignment 2481``` 2482**Description** 2483 2484Enumerates the vertical alignment modes. 2485 2486**Since**: 12 2487 2488| Enum| Description| 2489| -------- | -------- | 2490| ARKUI_FLEX_ALIGNMENT_START | The child components are aligned with the start edge of the main axis. | 2491| ARKUI_FLEX_ALIGNMENT_CENTER | The child components are aligned in the center of the main axis. | 2492| ARKUI_FLEX_ALIGNMENT_END | The child components are aligned with the end edge of the main axis. | 2493| ARKUI_FLEX_ALIGNMENT_SPACE_BETWEEN | The child components are evenly distributed along the main axis. The space between any two adjacent components is the same. The first component is aligned with the main-start, and the last component is aligned with the main-end. | 2494| ARKUI_FLEX_ALIGNMENT_SPACE_AROUND | The child components are evenly distributed along the main axis. The space between any two adjacent components is the same. The space between the first component and main-start, and that between the last component and cross-main are both half the size of the space between two adjacent components. | 2495| ARKUI_FLEX_ALIGNMENT_SPACE_EVENLY | The child components are evenly distributed along the main axis. The space between the first component and main-start, the space between the last component and main-end, and the space between any two adjacent components are the same. | 2496 2497 2498### ArkUI_FlexDirection 2499 2500``` 2501enum ArkUI_FlexDirection 2502``` 2503**Description** 2504 2505Enumerates the directions of the main axis in the flex container. 2506 2507**Since**: 12 2508 2509| Enum| Description| 2510| -------- | -------- | 2511| ARKUI_FLEX_DIRECTION_ROW | The child components are arranged in the same direction as the main axis runs along the rows. | 2512| ARKUI_FLEX_DIRECTION_COLUMN | The child components are arranged in the same direction as the main axis runs down the columns. | 2513| ARKUI_FLEX_DIRECTION_ROW_REVERSE | The child components are arranged opposite to the **ROW** direction. | 2514| ARKUI_FLEX_DIRECTION_COLUMN_REVERSE | The child components are arranged opposite to the **COLUMN** direction. | 2515 2516 2517### ArkUI_FlexWrap 2518 2519``` 2520enum ArkUI_FlexWrap 2521``` 2522**Description** 2523 2524Defines whether the flex container has a single line or multiple lines. 2525 2526**Since**: 12 2527 2528| Enum| Description| 2529| -------- | -------- | 2530| ARKUI_FLEX_WRAP_NO_WRAP | The child components in the flex container are arranged in a single line, and they cannot overflow. | 2531| ARKUI_FLEX_WRAP_WRAP | The child components in the flex container are arranged in multiple lines, and they may overflow. | 2532| ARKUI_FLEX_WRAP_WRAP_REVERSE | The child components in the flex container are reversely arranged in multiple lines, and they may overflow. | 2533 2534 2535### ArkUI_FontStyle 2536 2537``` 2538enum ArkUI_FontStyle 2539``` 2540**Description** 2541 2542Enumerates the font styles. 2543 2544**Since**: 12 2545 2546| Enum| Description| 2547| -------- | -------- | 2548| ARKUI_FONT_STYLE_NORMAL | Standard font style. | 2549| ARKUI_FONT_STYLE_ITALIC | Italic font style. | 2550 2551 2552### ArkUI_FontWeight 2553 2554``` 2555enum ArkUI_FontWeight 2556``` 2557**Description** 2558 2559Enumerates the font weights. 2560 2561**Since**: 12 2562 2563| Enum| Description| 2564| -------- | -------- | 2565| ARKUI_FONT_WEIGHT_W100 | 100 | 2566| ARKUI_FONT_WEIGHT_W200 | 200 | 2567| ARKUI_FONT_WEIGHT_W300 | 300 | 2568| ARKUI_FONT_WEIGHT_W400 | 400 | 2569| ARKUI_FONT_WEIGHT_W500 | 500 | 2570| ARKUI_FONT_WEIGHT_W600 | 600 | 2571| ARKUI_FONT_WEIGHT_W700 | 700 | 2572| ARKUI_FONT_WEIGHT_W800 | 800 | 2573| ARKUI_FONT_WEIGHT_W900 | 900 | 2574| ARKUI_FONT_WEIGHT_BOLD | The font weight is bold. | 2575| ARKUI_FONT_WEIGHT_NORMAL | The font weight is normal. | 2576| ARKUI_FONT_WEIGHT_BOLDER | The font weight is bolder. | 2577| ARKUI_FONT_WEIGHT_LIGHTER | The font weight is lighter. | 2578| ARKUI_FONT_WEIGHT_MEDIUM | The font weight is medium. | 2579| ARKUI_FONT_WEIGHT_REGULAR | The font weight is normal. | 2580 2581 2582### ArkUI_GestureDirection 2583 2584``` 2585enum ArkUI_GestureDirection 2586``` 2587**Description** 2588 2589Enumerates gesture directions. 2590 2591**Since**: 12 2592 2593| Enum| Description| 2594| -------- | -------- | 2595| GESTURE_DIRECTION_ALL | All directions. | 2596| GESTURE_DIRECTION_HORIZONTAL | Horizontal direction. | 2597| GESTURE_DIRECTION_VERTICAL | Vertical direction. | 2598| GESTURE_DIRECTION_LEFT | Leftward. | 2599| GESTURE_DIRECTION_RIGHT | Rightward. | 2600| GESTURE_DIRECTION_UP | Upward. | 2601| GESTURE_DIRECTION_DOWN | Downward. | 2602| GESTURE_DIRECTION_NONE | None. | 2603 2604 2605### ArkUI_GestureEventActionType 2606 2607``` 2608enum ArkUI_GestureEventActionType 2609``` 2610**Description** 2611 2612Enumerates gesture event types. 2613 2614**Since**: 12 2615 2616| Enum| Description| 2617| -------- | -------- | 2618| GESTURE_EVENT_ACTION_ACCEPT | Triggered. | 2619| GESTURE_EVENT_ACTION_UPDATE | Updated. | 2620| GESTURE_EVENT_ACTION_END | Ended. | 2621| GESTURE_EVENT_ACTION_CANCEL | Canceled. | 2622 2623 2624### ArkUI_GestureInterruptResult 2625 2626``` 2627enum ArkUI_GestureInterruptResult 2628``` 2629**Description** 2630 2631Enumerates gesture interruption results. 2632 2633**Since**: 12 2634 2635| Enum| Description| 2636| -------- | -------- | 2637| GESTURE_INTERRUPT_RESULT_CONTINUE | The gesture recognition process continues. | 2638| GESTURE_INTERRUPT_RESULT_REJECT | The gesture recognition process is paused. | 2639 2640 2641### ArkUI_GestureMask 2642 2643``` 2644enum ArkUI_GestureMask 2645``` 2646**Description** 2647 2648Enumerates gesture masking modes. 2649 2650**Since**: 12 2651 2652| Enum| Description| 2653| -------- | -------- | 2654| NORMAL_GESTURE_MASK | The gestures of child components are enabled and recognized based on the default gesture recognition sequence. | 2655| IGNORE_INTERNAL_GESTURE_MASK | The gestures of child components are disabled, including the built-in gestures. | 2656 2657 2658### ArkUI_GesturePriority 2659 2660``` 2661enum ArkUI_GesturePriority 2662``` 2663**Description** 2664 2665Enumerates gesture event modes. 2666 2667**Since**: 12 2668 2669| Enum| Description| 2670| -------- | -------- | 2671| NORMAL | Normal. | 2672| PRIORITY | High-priority. | 2673| PARALLEL | Parallel. | 2674 2675 2676### ArkUI_GestureRecognizerState 2677 2678``` 2679enum ArkUI_GestureRecognizerState 2680``` 2681**Description** 2682 2683Enumerates the gesture recognizer states. 2684 2685**Since**: 12 2686 2687| Enum| Description| 2688| -------- | -------- | 2689| ARKUI_GESTURE_RECOGNIZER_STATE_REDAY | Prepared. | 2690| ARKUI_GESTURE_RECOGNIZER_STATE_DETECTING | Check status. | 2691| ARKUI_GESTURE_RECOGNIZER_STATE_PENDING | Waiting | 2692| ARKUI_GESTURE_RECOGNIZER_STATE_BLOCKED | Blocked. | 2693| ARKUI_GESTURE_RECOGNIZER_STATE_SUCCESSFUL | (Success status) | 2694| ARKUI_GESTURE_RECOGNIZER_STATE_FAILED | Failed. | 2695 2696 2697### ArkUI_GestureRecognizerType 2698 2699``` 2700enum ArkUI_GestureRecognizerType 2701``` 2702**Description** 2703 2704Enumerates gesture recognizer types. 2705 2706**Since**: 12 2707 2708| Enum| Description| 2709| -------- | -------- | 2710| TAP_GESTURE | Tap. | 2711| LONG_PRESS_GESTURE | Long press gesture. | 2712| PAN_GESTURE | Pan gesture. | 2713| PINCH_GESTURE | Pinch gesture. | 2714| ROTATION_GESTURE | Rotation gesture. | 2715| SWIPE_GESTURE | Swipe gesture. | 2716| GROUP_GESTURE | A group of gestures. | 2717 2718 2719### ArkUI_GroupGestureMode 2720 2721``` 2722enum ArkUI_GroupGestureMode 2723``` 2724**Description** 2725 2726Enumerates gesture group modes. 2727 2728**Since**: 12 2729 2730| Enum| Description| 2731| -------- | -------- | 2732| SEQUENTIAL_GROUP | Sequential recognition. Gestures are recognized in the registration sequence until all gestures are recognized successfully. Once one gesture fails to be recognized, all subsequent gestures fail to be recognized. Only the last gesture in the gesture group can respond to the end event. | 2733| PARALLEL_GROUP | Parallel recognition. Registered gestures are recognized concurrently until all gestures are recognized. The recognition result of each gesture does not affect each other. | 2734| EXCLUSIVE_GROUP | Exclusive recognition. Registered gestures are identified concurrently. If one gesture is successfully recognized, gesture recognition ends. | 2735 2736 2737### ArkUI_HitTestMode 2738 2739``` 2740enum ArkUI_HitTestMode 2741``` 2742**Description** 2743 2744Enumerates the hit test modes. 2745 2746**Since**: 12 2747 2748| Enum| Description| 2749| -------- | -------- | 2750| ARKUI_HIT_TEST_MODE_DEFAULT | Both the node and its child node respond to the hit test of a touch event, but its sibling node is blocked from the hit test. | 2751| ARKUI_HIT_TEST_MODE_BLOCK | The node responds to the hit test of a touch event, but its child node and sibling node are blocked from the hit test. | 2752| ARKUI_HIT_TEST_MODE_TRANSPARENT | Both the node and its child node respond to the hit test of a touch event, and its sibling node is also considered during the hit test. | 2753| ARKUI_HIT_TEST_MODE_NONE | The node does not respond to the hit test of a touch event. | 2754 2755 2756### ArkUI_HorizontalAlignment 2757 2758``` 2759enum ArkUI_HorizontalAlignment 2760``` 2761**Description** 2762 2763Enumerates the alignment mode in the horizontal direction. 2764 2765**Since**: 12 2766 2767| Enum| Description| 2768| -------- | -------- | 2769| ARKUI_HORIZONTAL_ALIGNMENT_START | Aligned with the start edge in the same direction as the language in use. | 2770| ARKUI_HORIZONTAL_ALIGNMENT_CENTER | Aligned with the center. This is the default alignment mode. | 2771| ARKUI_HORIZONTAL_ALIGNMENT_END | Aligned with the end edge in the same direction as the language in use. | 2772 2773 2774### ArkUI_ImageInterpolation 2775 2776``` 2777enum ArkUI_ImageInterpolation 2778``` 2779**Description** 2780 2781Enumerates the image interpolation effects. 2782 2783**Since**: 12 2784 2785| Enum| Description| 2786| -------- | -------- | 2787| ARKUI_IMAGE_INTERPOLATION_NONE | No image interpolation. | 2788| ARKUI_IMAGE_INTERPOLATION_LOW | Low quality interpolation. | 2789| ARKUI_IMAGE_INTERPOLATION_MEDIUM | Medium quality interpolation. | 2790| ARKUI_IMAGE_INTERPOLATION_HIGH | High quality interpolation. This mode produces scaled images of the highest possible quality. | 2791 2792 2793### ArkUI_ImageRenderMode 2794 2795``` 2796enum ArkUI_ImageRenderMode 2797``` 2798**Description** 2799 2800Enumerates the image rendering modes. 2801 2802**Since**: 12 2803 2804| Enum| Description| 2805| -------- | -------- | 2806| ARKUI_IMAGE_RENDER_MODE_ORIGINAL | Render image pixels as they are in the original source image. | 2807| ARKUI_IMAGE_RENDER_MODE_TEMPLATE | Render image pixels to create a monochrome template image. | 2808 2809 2810### ArkUI_ImageRepeat 2811 2812``` 2813enum ArkUI_ImageRepeat 2814``` 2815**Description** 2816 2817Enumerates the image repeat patterns. 2818 2819**Since**: 12 2820 2821| Enum| Description| 2822| -------- | -------- | 2823| ARKUI_IMAGE_REPEAT_NONE | The image is not repeatedly drawn. | 2824| ARKUI_IMAGE_REPEAT_X | The image is repeatedly drawn only along the x-axis. | 2825| ARKUI_IMAGE_REPEAT_Y | The image is repeatedly drawn only along the y-axis. | 2826| ARKUI_IMAGE_REPEAT_XY | The image is repeatedly drawn along both axes. | 2827 2828 2829### ArkUI_ImageSize 2830 2831``` 2832enum ArkUI_ImageSize 2833``` 2834**Description** 2835 2836Defines the image size. 2837 2838**Since**: 12 2839 2840| Enum| Description| 2841| -------- | -------- | 2842| ARKUI_IMAGE_SIZE_AUTO | The original image aspect ratio is retained. | 2843| ARKUI_IMAGE_SIZE_COVER | Default value. The image is scaled with its aspect ratio retained for both sides to be greater than or equal to the display boundaries. | 2844| ARKUI_IMAGE_SIZE_CONTAIN | The image is scaled with its aspect ratio retained for the content to be completely displayed within the display boundaries. | 2845 2846 2847### ArkUI_ImageSpanAlignment 2848 2849``` 2850enum ArkUI_ImageSpanAlignment 2851``` 2852**Description** 2853 2854Enumerates the alignment mode of the image with the text. 2855 2856**Since**: 12 2857 2858| Enum| Description| 2859| -------- | -------- | 2860| ARKUI_IMAGE_SPAN_ALIGNMENT_BASELINE | The image is bottom aligned with the text baseline. | 2861| ARKUI_IMAGE_SPAN_ALIGNMENT_BOTTOM | The image is bottom aligned with the text. | 2862| ARKUI_IMAGE_SPAN_ALIGNMENT_CENTER | The image is centered aligned with the text. | 2863| ARKUI_IMAGE_SPAN_ALIGNMENT_TOP | The image is top aligned with the text. | 2864 2865 2866### ArkUI_ItemAlignment 2867 2868``` 2869enum ArkUI_ItemAlignment 2870``` 2871**Description** 2872 2873Enumerates the modes in which components are laid out along the cross axis of the container. 2874 2875**Since**: 12 2876 2877| Enum| Description| 2878| -------- | -------- | 2879| ARKUI_ITEM_ALIGNMENT_AUTO | The default configuration of the flex container is used. | 2880| ARKUI_ITEM_ALIGNMENT_START | The items in the flex container are aligned with the cross-start edge. | 2881| ARKUI_ITEM_ALIGNMENT_CENTER | The items in the flex container are centered along the cross axis. | 2882| ARKUI_ITEM_ALIGNMENT_END | The items in the flex container are aligned with the cross-end edge. | 2883| ARKUI_ITEM_ALIGNMENT_STRETCH | The items in the flex container are stretched and padded along the cross axis. | 2884| ARKUI_ITEM_ALIGNMENT_BASELINE | The items in the flex container are aligned in such a manner that their text baselines are aligned along the cross axis. | 2885 2886 2887### ArkUI_KeyCode 2888 2889``` 2890enum ArkUI_KeyCode 2891``` 2892**Description** 2893 2894Enumerates the key codes for key events. 2895 2896**Since**: 14 2897 2898| Enum| Description| 2899| -------- | -------- | 2900| ARKUI_KEYCODE_UNKNOWN | Unknown key. | 2901| ARKUI_KEYCODE_FN | Function (Fn) key. | 2902| ARKUI_KEYCODE_VOLUME_UP | Volume Up key. | 2903| ARKUI_KEYCODE_VOLUME_DOWN | Volume Down key. | 2904| ARKUI_KEYCODE_POWER | Power key. | 2905| ARKUI_KEYCODE_CAMERA | Camera key. | 2906| ARKUI_KEYCODE_VOLUME_MUTE | Speaker Mute key. | 2907| ARKUI_KEYCODE_MUTE | Mute key. | 2908| ARKUI_KEYCODE_BRIGHTNESS_UP | Brightness Up key. | 2909| ARKUI_KEYCODE_BRIGHTNESS_DOWN | Brightness Down key. | 2910| ARKUI_KEYCODE_0 | Key 0. | 2911| ARKUI_KEYCODE_1 | Key 1. | 2912| ARKUI_KEYCODE_2 | Key 2. | 2913| ARKUI_KEYCODE_3 | Key 3. | 2914| ARKUI_KEYCODE_4 | Key 4. | 2915| ARKUI_KEYCODE_5 | Key 5. | 2916| ARKUI_KEYCODE_6 | Key 6. | 2917| ARKUI_KEYCODE_7 | Key 7. | 2918| ARKUI_KEYCODE_8 | Key 8. | 2919| ARKUI_KEYCODE_9 | Key 9. | 2920| ARKUI_KEYCODE_STAR | Key *. | 2921| ARKUI_KEYCODE_POUND | Key #. | 2922| ARKUI_KEYCODE_DPAD_UP | Up key on D-pad. | 2923| ARKUI_KEYCODE_DPAD_DOWN | Down key on D-pad. | 2924| ARKUI_KEYCODE_DPAD_LEFT | Left key on D-pad. | 2925| ARKUI_KEYCODE_DPAD_RIGHT | Right key on D-pad. | 2926| ARKUI_KEYCODE_DPAD_CENTER | Center key on D-pad. | 2927| ARKUI_KEYCODE_A | Key A. | 2928| ARKUI_KEYCODE_B | Key B. | 2929| ARKUI_KEYCODE_C | Key C. | 2930| ARKUI_KEYCODE_D | Key D. | 2931| ARKUI_KEYCODE_E | Key E. | 2932| ARKUI_KEYCODE_F | Key F. | 2933| ARKUI_KEYCODE_G | Key G. | 2934| ARKUI_KEYCODE_H | Key H. | 2935| ARKUI_KEYCODE_I | Key I. | 2936| ARKUI_KEYCODE_J | Key J. | 2937| ARKUI_KEYCODE_K | Key K. | 2938| ARKUI_KEYCODE_L | Key L. | 2939| ARKUI_KEYCODE_M | Key M. | 2940| ARKUI_KEYCODE_N | Key N. | 2941| ARKUI_KEYCODE_O | Key O. | 2942| ARKUI_KEYCODE_P | Key P. | 2943| ARKUI_KEYCODE_Q | Key R. | 2944| ARKUI_KEYCODE_R | Key R. | 2945| ARKUI_KEYCODE_S | Key S. | 2946| ARKUI_KEYCODE_T | Key T. | 2947| ARKUI_KEYCODE_U | Key U. | 2948| ARKUI_KEYCODE_V | Key V. | 2949| ARKUI_KEYCODE_W | Key W. | 2950| ARKUI_KEYCODE_X | Key X. | 2951| ARKUI_KEYCODE_Y | Key Y. | 2952| ARKUI_KEYCODE_Z | Key Z. | 2953| ARKUI_KEYCODE_COMMA | Key ,. | 2954| ARKUI_KEYCODE_PERIOD | Key .. | 2955| ARKUI_KEYCODE_ALT_LEFT | Left Alt key. | 2956| ARKUI_KEYCODE_ALT_RIGHT | Right Alt key. | 2957| ARKUI_KEYCODE_SHIFT_LEFT | Left Shift key. | 2958| ARKUI_KEYCODE_SHIFT_RIGHT | Right Shift key. | 2959| ARKUI_KEYCODE_TAB | Tab key. | 2960| ARKUI_KEYCODE_SPACE | Space key. | 2961| ARKUI_KEYCODE_SYM | Symbol key. | 2962| ARKUI_KEYCODE_EXPLORER | Explorer key, which is used to start the explorer application. | 2963| ARKUI_KEYCODE_ENVELOPE | Email key, which is used to start the email application. | 2964| ARKUI_KEYCODE_ENTER | Enter key. | 2965| ARKUI_KEYCODE_DEL | Delete key. | 2966| ARKUI_KEYCODE_GRAVE | Key `. | 2967| ARKUI_KEYCODE_MINUS | Key -. | 2968| ARKUI_KEYCODE_EQUALS | Key =. | 2969| ARKUI_KEYCODE_LEFT_BRACKET | Key [. | 2970| ARKUI_KEYCODE_RIGHT_BRACKET | Key ]. | 2971| ARKUI_KEYCODE_BACKSLASH | Key \. | 2972| ARKUI_KEYCODE_SEMICOLON | Key ;. | 2973| ARKUI_KEYCODE_APOSTROPHE | Key '. | 2974| ARKUI_KEYCODE_SLASH | Key /. | 2975| ARKUI_KEYCODE_AT | Key @. | 2976| ARKUI_KEYCODE_PLUS | Key +. | 2977| ARKUI_KEYCODE_MENU | Menu key. | 2978| ARKUI_KEYCODE_PAGE_UP | Page Up key. | 2979| ARKUI_KEYCODE_PAGE_DOWN | Page Down key. | 2980| ARKUI_KEYCODE_ESCAPE | ESC key. | 2981| ARKUI_KEYCODE_FORWARD_DEL | Forward Delete key. | 2982| ARKUI_KEYCODE_CTRL_LEFT | Left Ctrl key. | 2983| ARKUI_KEYCODE_CTRL_RIGHT | Right Ctrl key. | 2984| ARKUI_KEYCODE_CAPS_LOCK | Caps Lock key. | 2985| ARKUI_KEYCODE_SCROLL_LOCK | Scroll Lock key. | 2986| ARKUI_KEYCODE_META_LEFT | Left Meta key. | 2987| ARKUI_KEYCODE_META_RIGHT | Right Meta key. | 2988| ARKUI_KEYCODE_FUNCTION | Function key. | 2989| ARKUI_KEYCODE_SYSRQ | System Request/Print Screen key. | 2990| ARKUI_KEYCODE_BREAK | Break/Pause key. | 2991| ARKUI_KEYCODE_MOVE_HOME | Move to Home key. | 2992| ARKUI_KEYCODE_MOVE_END | Move to End key. | 2993| ARKUI_KEYCODE_INSERT | Insert key. | 2994| ARKUI_KEYCODE_FORWARD | Forward key. | 2995| ARKUI_KEYCODE_MEDIA_PLAY | Play key. | 2996| ARKUI_KEYCODE_MEDIA_PAUSE | Pause key. | 2997| ARKUI_KEYCODE_MEDIA_CLOSE | Close key. | 2998| ARKUI_KEYCODE_MEDIA_EJECT | Eject key. | 2999| ARKUI_KEYCODE_MEDIA_RECORD | Record key. | 3000| ARKUI_KEYCODE_F1 | F1 key. | 3001| ARKUI_KEYCODE_F2 | F2 key. | 3002| ARKUI_KEYCODE_F3 | F3 key. | 3003| ARKUI_KEYCODE_F4 | F4 key. | 3004| ARKUI_KEYCODE_F5 | F5 key. | 3005| ARKUI_KEYCODE_F6 | F6 key. | 3006| ARKUI_KEYCODE_F7 | F7 key. | 3007| ARKUI_KEYCODE_F8 | F8 key. | 3008| ARKUI_KEYCODE_F9 | F9 key. | 3009| ARKUI_KEYCODE_F10 | F10 key. | 3010| ARKUI_KEYCODE_F11 | F11 key. | 3011| ARKUI_KEYCODE_F12 | F12 key. | 3012| ARKUI_KEYCODE_NUM_LOCK | Number Lock key. | 3013| ARKUI_KEYCODE_NUMPAD_0 | Key 0 on numeric keypad. | 3014| ARKUI_KEYCODE_NUMPAD_1 | Key 1 on numeric keypad. | 3015| ARKUI_KEYCODE_NUMPAD_2 | Key 2 on numeric keypad. | 3016| ARKUI_KEYCODE_NUMPAD_3 | Key 3 on numeric keypad. | 3017| ARKUI_KEYCODE_NUMPAD_4 | Key 4 on numeric keypad. | 3018| ARKUI_KEYCODE_NUMPAD_5 | Key 5 on numeric keypad. | 3019| ARKUI_KEYCODE_NUMPAD_6 | Key 6 on numeric keypad. | 3020| ARKUI_KEYCODE_NUMPAD_7 | Key 7 on numeric keypad. | 3021| ARKUI_KEYCODE_NUMPAD_8 | Key 8 on numeric keypad. | 3022| ARKUI_KEYCODE_NUMPAD_9 | Key 9 on numeric keypad. | 3023| ARKUI_KEYCODE_NUMPAD_DIVIDE | Key / on numeric keypad. | 3024| ARKUI_KEYCODE_NUMPAD_MULTIPLY | Key * on numeric keypad. | 3025| ARKUI_KEYCODE_NUMPAD_SUBTRACT | Key - on numeric keypad. | 3026| ARKUI_KEYCODE_NUMPAD_ADD | Key + on numeric keypad. | 3027| ARKUI_KEYCODE_NUMPAD_DOT | Key . on numeric keypad. | 3028| ARKUI_KEYCODE_NUMPAD_COMMA | Key , on numeric keypad. | 3029| ARKUI_KEYCODE_NUMPAD_ENTER | Enter key on numeric keypad. | 3030| ARKUI_KEYCODE_NUMPAD_EQUALS | Key = on numeric keypad. | 3031| ARKUI_KEYCODE_NUMPAD_LEFT_PAREN | Key ( on numeric keypad. | 3032| ARKUI_KEYCODE_NUMPAD_RIGHT_PAREN | Key ) on numeric keypad. | 3033 3034 3035### ArkUI_KeyEventType 3036 3037``` 3038enum ArkUI_KeyEventType 3039``` 3040**Description** 3041 3042Type of a key. 3043 3044**Since**: 14 3045 3046| Enum| Description| 3047| -------- | -------- | 3048| ARKUI_KEY_EVENT_UNKNOWN | Unknown. | 3049| ARKUI_KEY_EVENT_DOWN | Pressing of a key. | 3050| ARKUI_KEY_EVENT_UP | Release of a key. | 3051| ARKUI_KEY_EVENT_LONG_PRESS | Long press of a key. | 3052| ARKUI_KEY_EVENT_CLICK | Click of a key. | 3053 3054 3055### ArkUI_KeyIntension 3056 3057``` 3058enum ArkUI_KeyIntension 3059``` 3060**Description** 3061 3062Enumerates the key intentions. 3063 3064**Since**: 14 3065 3066| Enum| Description| 3067| -------- | -------- | 3068| ARKUI_KEY_INTENSION_UNKNOWN | Unknown intention. | 3069| ARKUI_KEY_INTENSION_UP | Upward. | 3070| ARKUI_KEY_INTENSION_DOWN | Downward. | 3071| ARKUI_KEY_INTENSION_LEFT | Leftward. | 3072| ARKUI_KEY_INTENSION_RIGHT | Rightward. | 3073| ARKUI_KEY_INTENSION_SELECT | Select. | 3074| ARKUI_KEY_INTENSION_ESCAPE | | 3075| ARKUI_KEY_INTENSION_BACK | Back. | 3076| ARKUI_KEY_INTENSION_FORWARD | Forward. | 3077| ARKUI_KEY_INTENSION_MENU | Menu. | 3078| ARKUI_KEY_INTENSION_HOME | Home. | 3079| ARKUI_KEY_INTENSION_PAGE_UP | Page up. | 3080| ARKUI_KEY_INTENSION_PAGE_DOWN | Page down. | 3081| ARKUI_KEY_INTENSION_ZOOM_OUT | Zoom out. | 3082| ARKUI_KEY_INTENSION_ZOOM_IN | Zoom in. | 3083| ARKUI_KEY_INTENTION_MEDIA_PLAY_PAUSE | Play. | 3084| ARKUI_KEY_INTENTION_MEDIA_FAST_FORWARD | Fast-forward. | 3085| ARKUI_KEY_INTENTION_MEDIA_FAST_PLAYBACK | Fast playback. | 3086| ARKUI_KEY_INTENTION_MEDIA_NEXT | Play next. | 3087| ARKUI_KEY_INTENTION_MEDIA_PREVIOUS | Play previous. | 3088| ARKUI_KEY_INTENTION_MEDIA_MUTE | Mute. | 3089| ARKUI_KEY_INTENTION_VOLUME_UP | Volume up. | 3090| ARKUI_KEY_INTENTION_VOLUME_DOWN | Volume down. | 3091| ARKUI_KEY_INTENTION_CALL | Answer a call. | 3092| ARKUI_KEY_INTENTION_CAMERA | Camera. | 3093 3094 3095### ArkUI_KeySourceType 3096 3097``` 3098enum ArkUI_KeySourceType 3099``` 3100**Description** 3101 3102Enumerates the types of input devices that trigger key events. 3103 3104**Since**: 14 3105 3106| Enum| Description| 3107| -------- | -------- | 3108| ARKUI_KEY_SOURCE_UNKNOWN | Unknown type. | 3109| ARKUI_KEY_SOURCE_TYPE_MOUSE | Mouse. | 3110| ARKUI_KEY_SOURCE_TYPE_KEYBOARD | Keyboard. | 3111| ARKUI_KEY_SOURCE_TYPE_JOYSTICK | Joystick. | 3112 3113 3114### ArkUI_LengthMetricUnit 3115 3116``` 3117enum ArkUI_LengthMetricUnit 3118``` 3119**Description** 3120 3121Enumerates the component units. 3122 3123**Since**: 12 3124 3125| Enum| Description| 3126| -------- | -------- | 3127| ARKUI_LENGTH_METRIC_UNIT_DEFAULT | Default, which is fp for fonts and vp for non-fonts. | 3128| ARKUI_LENGTH_METRIC_UNIT_PX | px. | 3129| ARKUI_LENGTH_METRIC_UNIT_VP | vp. | 3130| ARKUI_LENGTH_METRIC_UNIT_FP | fp. | 3131 3132 3133### ArkUI_LinearGradientDirection 3134 3135``` 3136enum ArkUI_LinearGradientDirection 3137``` 3138**Description** 3139 3140Enumerates the gradient directions. 3141 3142**Since**: 12 3143 3144| Enum| Description| 3145| -------- | -------- | 3146| ARKUI_LINEAR_GRADIENT_DIRECTION_LEFT | From right to left. | 3147| ARKUI_LINEAR_GRADIENT_DIRECTION_TOP | From bottom to top. | 3148| ARKUI_LINEAR_GRADIENT_DIRECTION_RIGHT | From left to right. | 3149| ARKUI_LINEAR_GRADIENT_DIRECTION_BOTTOM | From top to bottom. | 3150| ARKUI_LINEAR_GRADIENT_DIRECTION_LEFT_TOP | From lower right to upper left. | 3151| ARKUI_LINEAR_GRADIENT_DIRECTION_LEFT_BOTTOM | From upper right to lower left. | 3152| ARKUI_LINEAR_GRADIENT_DIRECTION_RIGHT_TOP | From lower left to upper right. | 3153| ARKUI_LINEAR_GRADIENT_DIRECTION_RIGHT_BOTTOM | From upper left to lower right. | 3154| ARKUI_LINEAR_GRADIENT_DIRECTION_NONE | No gradient. | 3155| ARKUI_LINEAR_GRADIENT_DIRECTION_CUSTOM | Custom direction. | 3156 3157 3158### ArkUI_ListItemAlignment 3159 3160``` 3161enum ArkUI_ListItemAlignment 3162``` 3163**Description** 3164 3165Enumerates the alignment modes of items along the cross axis. 3166 3167**Since**: 12 3168 3169| Enum| Description| 3170| -------- | -------- | 3171| ARKUI_LIST_ITEM_ALIGNMENT_START | The list items are packed toward the start edge of the **List** component along the cross axis. | 3172| ARKUI_LIST_ITEM_ALIGNMENT_CENTER | The list items are centered in the **List** component along the cross axis. | 3173| ARKUI_LIST_ITEM_ALIGNMENT_END | The list items are packed toward the end edge of the **List** component along the cross axis. | 3174 3175 3176### ArkUI_ListItemSwipeActionState 3177 3178``` 3179enum ArkUI_ListItemSwipeActionState 3180``` 3181**Description** 3182 3183Enumerates the swipe action item states of list items. 3184 3185**Since**: 12 3186 3187| Enum| Description| 3188| -------- | -------- | 3189| ARKUI_LIST_ITEM_SWIPE_ACTION_STATE_COLLAPSED | Collapsed state. When the list item is swiped in the opposite direction of the main axis, the swipe action item is hidden. | 3190| ARKUI_LIST_ITEM_SWIPE_ACTION_STATE_EXPANDED | Expanded state. When the list item is swiped in the opposite direction of the main axis, the swipe action item is shown. | 3191| ARKUI_LIST_ITEM_SWIPE_ACTION_STATE_ACTIONING | In-action state. The list item is in this state when it enters the delete area. | 3192 3193 3194### ArkUI_ListItemSwipeEdgeEffect 3195 3196``` 3197enum ArkUI_ListItemSwipeEdgeEffect 3198``` 3199**Description** 3200 3201Enumerates the swipe action item edge effects of list items. 3202 3203**Since**: 12 3204 3205| Enum| Description| 3206| -------- | -------- | 3207| ARKUI_LIST_ITEM_SWIPE_EDGE_EFFECT_SPRING | When the list item scrolls to the edge of the list, it can continue to scroll for a distance. | 3208| ARKUI_LIST_ITEM_SWIPE_EDGE_EFFECT_NONE | The list item cannot scroll beyond the edge of the list. | 3209 3210 3211### ArkUI_MaskType 3212 3213``` 3214enum ArkUI_MaskType 3215``` 3216**Description** 3217 3218Enumerates the mask types. 3219 3220**Since**: 12 3221 3222| Enum| Description| 3223| -------- | -------- | 3224| ARKUI_MASK_TYPE_RECTANGLE | Rectangle. | 3225| ARKUI_MASK_TYPE_CIRCLE | **(circle)** | 3226| ARKUI_MASK_TYPE_ELLIPSE | Ellipse. | 3227| ARKUI_MASK_TYPE_PATH | Path Type | 3228| ARKUI_MASK_TYPE_PROGRESS | Progress indicator. | 3229 3230 3231### ArkUI_NativeAPIVariantKind 3232 3233``` 3234enum ArkUI_NativeAPIVariantKind 3235``` 3236**Description** 3237 3238Defines the native API types. 3239 3240**Since**: 12 3241 3242| Enum| Description| 3243| -------- | -------- | 3244| ARKUI_NATIVE_NODE | API related to UI components. For details, see the struct definition in <arkui/native_node.h>. | 3245| ARKUI_NATIVE_DIALOG | API related to dialog boxes. For details, see the struct definition in <arkui/native_dialog.h>. | 3246| ARKUI_NATIVE_GESTURE | API related to gestures. For details, see the struct definition in <arkui/native_gesture.h>. | 3247| ARKUI_NATIVE_ANIMATE | API related to animations. For details, see the struct definition in <arkui/native_animate.h>. | 3248 3249 3250### ArkUI_NavDestinationState 3251 3252``` 3253enum ArkUI_NavDestinationState 3254``` 3255**Description** 3256 3257Defines an enum for the **NavDestination** component states. 3258 3259**Since**: 12 3260 3261| Enum| Description| 3262| -------- | -------- | 3263| ARKUI_NAV_DESTINATION_STATE_ON_SHOW | The **NavDestination** component is displayed. | 3264| ARKUI_NAV_DESTINATION_STATE_ON_HIDE | The **NavDestination** component is hidden. | 3265| ARKUI_NAV_DESTINATION_STATE_ON_APPEAR | The **NavDestination** component is mounted to the component tree. | 3266| ARKUI_NAV_DESTINATION_STATE_ON_DISAPPEAR | The **NavDestination** component is unmounted from the component tree. | 3267| ARKUI_NAV_DESTINATION_STATE_ON_WILL_SHOW | The **NavDestination** is about to be displayed. | 3268| ARKUI_NAV_DESTINATION_STATE_ON_WILL_HIDE | The **NavDestination** is about to be hidden. | 3269| ARKUI_NAV_DESTINATION_STATE_ON_WILL_APPEAR | The **NavDestination** is about to be mounted to the component tree. | 3270| ARKUI_NAV_DESTINATION_STATE_ON_WILL_DISAPPEAR | The **NavDestination** component is about to be unmounted from the component tree. | 3271| ARKUI_NAV_DESTINATION_STATE_ON_BACK_PRESS | The back button is pressed for the **NavDestination** component. | 3272 3273 3274### ArkUI_NodeAdapterEventType 3275 3276``` 3277enum ArkUI_NodeAdapterEventType 3278``` 3279**Description** 3280 3281Enumerates node adapter events. 3282 3283**Since**: 12 3284 3285| Enum| Description| 3286| -------- | -------- | 3287| NODE_ADAPTER_EVENT_WILL_ATTACH_TO_NODE | This event occurs when the component is attached to the adapter. | 3288| NODE_ADAPTER_EVENT_WILL_DETACH_FROM_NODE | This event occurs when the component is detached from the adapter. | 3289| NODE_ADAPTER_EVENT_ON_GET_NODE_ID | This event occurs when the adapter obtains the unique ID of the new element to add. | 3290| NODE_ADAPTER_EVENT_ON_ADD_NODE_TO_ADAPTER | This event occurs when the adapter obtains the content of the new element to add. | 3291| NODE_ADAPTER_EVENT_ON_REMOVE_NODE_FROM_ADAPTER | This event occurs when the adapter removes an element. | 3292 3293### ArkUI_NodeAttributeType 3294 3295``` 3296enum ArkUI_NodeAttributeType 3297``` 3298**Description** 3299 3300Defines the ArkUI style attributes that can be set on the native side. 3301 3302**Since**: 12 3303 3304 3305| Enum| Description| 3306| -------- | -------- | 3307| NODE_WIDTH | Defines the width attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: width, in vp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: width, in vp.| 3308| NODE_HEIGHT | Defines the height attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: height, in vp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: height, in vp.| 3309| NODE_BACKGROUND_COLOR | Defines the background color attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].u32: background color, in 0xARGB format. For example, 0xFFFF0000 indicates red.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: background color, in 0xARGB format. For example, 0xFFFF0000 indicates red.| 3310| NODE_BACKGROUND_IMAGE | Defines the background image attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: image address, which can be an online URL, a local path, a Base64-encoded string, or a PixelMap object. Note that SVG images are not supported.<br>.value[0]?.i32: whether to repeat the image. Optional. The parameter type is [ArkUI_ImageRepeat](#arkui_imagerepeat). The default value is **ARKUI_IMAGE_REPEAT_NONE**.<br>.object: **PixelMap** object. The parameter type is [ArkUI_DrawableDescriptor](#arkui_drawabledescriptor).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: image address, which can be an online URL, a local path, a Base64-encoded string, or a PixelMap object. Note that SVG images are not supported.<br>.value[0].i32: whether to repeat the image. The parameter type is [ArkUI_ImageRepeat](#arkui_imagerepeat).<br>.object: **PixelMap** object. The parameter type is [ArkUI_DrawableDescriptor](#arkui_drawabledescriptor). Either **.object** or **.string** must be set.| 3311| NODE_PADDING | Defines the padding attribute, which can be set, reset, and obtained as required through APIs.<br>There are two formats of [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) for setting the attribute value:<br>1: Specify the same padding for the four directions.<br>.value[0].f32: padding, in vp.<br>2: Specify different paddings for different directions.<br>.value[0].f32: top padding, in vp.<br>.value[1].f32: right padding, in vp.<br>.value[2].f32: bottom padding, in vp.<br>.value[3].f32: left padding, in vp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: top padding, in vp.<br>.value[1].f32: right padding, in vp.<br>.value[2].f32: bottom padding, in vp.<br>.value[3].f32: left padding, in vp.| 3312| NODE_ID | Defines the component ID attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: component ID.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: component ID.| 3313| NODE_ENABLED | Defines the interactivity attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: The value **true** means that the component can interact with users, and **false** means the opposite.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: The value **1** means that the component can interact with users, and **0** means the opposite. | 3314| NODE_MARGIN | Defines the margin attribute, which can be set, reset, and obtained as required through APIs.<br>There are two formats of [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) for setting the attribute value:<br>1: Specify the same margin for the four directions.<br>.value[0].f32: margin, in vp.<br>2: Specify different margins for different directions.<br>.value[0].f32: top margin, in vp.<br>.value[1].f32: right margin, in vp.<br>.value[2].f32: bottom margin, in vp.<br>.value[3].f32: left margin, in vp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: top margin, in vp.<br>.value[1].f32: right margin, in vp.<br>.value[2].f32: bottom margin, in vp.<br>.value[3].f32: left margin, in vp.| 3315| NODE_TRANSLATE | Defines the translate attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: distance to translate along the x-axis, in vp. The default value is **0**.<br>.value[1].f32: distance to translate along the y-axis, in vp. The default value is **0**.<br>.value[2].f32: distance to translate along the z-axis, in vp. The default value is **0**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: distance to translate along the x-axis, in vp.<br>.value[1].f32: distance to translate along the y-axis, in vp.<br>.value[2].f32: distance to translate along the z-axis, in vp.<br>**NOTE**<br>If more than three parameters are set, the setting does not take effect and no error code is returned.| 3316| NODE_SCALE | Defines the scale attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: scale factor along the x-axis. The default value is **1**.<br>.value[1].f32: scale factor along the y-axis. The default value is **1**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: scale factor along the x-axis.<br>.value[1].f32: scale factor along the y-axis.| 3317| NODE_ROTATE | Defines the rotate attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: X-coordinate of the rotation axis vector. The default value is **0**.<br>.value[1].f32: Y-coordinate of the rotation axis vector. The default value is **0**.<br>.value[2].f32: Z-coordinate of the rotation axis vector. The default value is **0**.<br>.value[3].f32: rotation angle. The default value is **0**.<br>.value[4].f32: line of sight, that is, the distance from the viewpoint to the z=0 plane, in vp. The default value is **0**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: X-coordinate of the rotation axis vector.<br>.value[1].f32: Y-coordinate of the rotation axis vector.<br>.value[2].f32: Z-coordinate of the rotation axis vector.<br>.value[3].f32: rotation angle.<br>.value[4].f32: line of sight, that is, the distance from the viewpoint to the z=0 plane, in vp.| 3318| NODE_BRIGHTNESS | Sets the brightness attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: brightness value. The default value is **1.0**, and the recommended value range is [0, 2].<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: brightness value.| 3319| NODE_SATURATION | Sets the saturation attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: saturation value. The default value is **1.0**, and the recommended value range is [0, 50).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: saturation value.| 3320| NODE_BLUR | Sets the blur attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: blur radius. A larger value indicates a higher blur degree. If the value is **0**, the component is not blurred. If the value is less than 0, it is treated as **0** and no error code is returned. The unit is px. The default value is **0.0**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: blur radius. The larger the fuzzy radius, the more blurred the image. If the value is **0**, the image is not blurred. The unit is px.| 3321| NODE_LINEAR_GRADIENT | Sets the gradient attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: start angle of the linear gradient. This attribute takes effect only when [ArkUI_LinearGradientDirection](#arkui_lineargradientdirection) is set to **ARKUI_LINEAR_GRADIENT_DIRECTION_CUSTOM**. A positive value indicates a clockwise rotation from the origin, (0, 0). The default value is **180**.<br>.value[1].i32: direction of the linear gradient. When it is set to any value other than **ARKUI_LINEAR_GRADIENT_DIRECTION_CUSTOM**, the **angle** setting becomes ineffective. The data type is [ArkUI_LinearGradientDirection](#arkui_lineargradientdirection)<br>.value[2].i32: whether the colors are repeated. The default value is **false**.<br>.object: The parameter type is [ArkUI_ColorStop](_ark_u_i___color_stop.md). - **colors**: array of color stops, each of which consists of a color and its stop position. Invalid colors are automatically skipped.<br>**colors**: colors of the color stops.<br>**stops**: stop positions of the color stops.<br>**size**: number of colors.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: start angle of the linear gradient. The set value is used only when **ArkUI_LinearGradientDirection** is set to **ARKUI_LINEAR_GRADIENT_DIRECTION_CUSTOM**. In other cases, the default value is used.<br>.value[1].i32: direction of the linear gradient.<br>.value[2].i32: whether the colors are repeated.<br>.object: - **colors**: array of color stops, each of which consists of a color and its stop position. Invalid colors are automatically skipped.<br>**colors**: colors of the color stops.<br>**stops**: stop positions of the color stops.<br>**size**: number of colors.| 3322| NODE_ALIGNMENT | Sets the alignment attribute, which can be set, reset, and obtained as required through APIs.<br>In the **Stack** component, this attribute has the same effect as **NODE_STACK_ALIGN_CONTENT**, which means that it sets the alignment mode of child components in the container.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: alignment mode. The parameter type is [ArkUI_Alignment](#arkui_alignment). The default value is **ARKUI_ALIGNMENT_CENTER**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: alignment mode. The parameter type is [ArkUI_Alignment](#arkui_alignment).| 3323| NODE_OPACITY | Defines the opacity attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: opacity value. The value ranges from 0 to 1.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: opacity value. The value ranges from 0 to 1.| 3324| NODE_BORDER_WIDTH | Defines the border width attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>1: .value[0].f32: width of the four borders.<br>2: .value[0].f32: width of the top border.<br>.value[1].f32: width of the right border.<br>.value[2].f32: width of the bottom border.<br>.value[3].f32: width of the left border.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: width of the top border.<br>.value[1].f32: width of the right border.<br>.value[2].f32: width of the bottom border.<br>.value[3].f32: width of the left border.| 3325| NODE_BORDER_RADIUS | Defines the border corner radius attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>1: .value[0].f32: radius of the four corners.<br>2: .value[0].f32: radius of the upper left corner.<br>.value[1].f32: radius of the upper right corner.<br>.value[2].f32: radius of the lower left corner.<br>.value[3].f32: radius of the lower right corner.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: radius of the upper left corner.<br>.value[1].f32: radius of the upper right corner.<br>.value[2].f32: radius of the lower left corner.<br>.value[3].f32: radius of the lower right corner.| 3326| NODE_BORDER_COLOR | Defines the border color attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>1: .value[0].u32: color of the four borders, in 0xARGB format, for example, **0xFFFF11FF**.<br>2: .value[0].u32: color of the top border, in 0xARGB format, for example, **0xFFFF11FF**.<br>.value[1].u32: color of the right border, in 0xARGB format, for example, **0xFFFF11FF**.<br>.value[2].u32: color of the lower border, in 0xARGB format, for example, **0xFFFF11FF**.<br>.value[3].u32: color of the left border, in 0xARGB format, for example, **0xFFFF11FF**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: color of the top border, in 0xARGB format, for example, **0xFFFF11FF**.<br>.value[1].u32: color of the right border, in 0xARGB format, for example, **0xFFFF11FF**.<br>.value[2].u32: color of the lower border, in 0xARGB format, for example, **0xFFFF11FF**.<br>.value[3].u32: color of the left border, in 0xARGB format, for example, **0xFFFF11FF**.| 3327| NODE_BORDER_STYLE | Defines the border line style attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>1: .value[0].i32: line style of the four borders. The parameter type is [ArkUI_BorderStyle](#arkui_borderstyle). The default value is **ARKUI_BORDER_STYLE_SOLID**.<br>2: .value[0].i32: line style of the top border. The parameter type is **ArkUI_BorderStyle**. The default value is **ARKUI_BORDER_STYLE_SOLID**.<br>.value[1].i32: line style of the right border. The parameter type is [ArkUI_BorderStyle](#arkui_borderstyle). The default value is **ARKUI_BORDER_STYLE_SOLID**.<br>.value[2].i32: line style of the bottom border. The parameter type is [ArkUI_BorderStyle](#arkui_borderstyle). The default value is **ARKUI_BORDER_STYLE_SOLID**.<br>.value[3].i32: line style of the left border. The parameter type is [ArkUI_BorderStyle](#arkui_borderstyle). The default value is **ARKUI_BORDER_STYLE_SOLID**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: line style of the top border.<br>.value[1].i32: line style of the right border.<br>.value[2].i32: line style of the bottom border.<br>.value[3].i32: line style of the left border.| 3328| NODE_Z_INDEX | Defines the z-index attribute for the stack sequence. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: z-index value.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: z-index value.| 3329| NODE_VISIBILITY | Defines the visibility attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to show or hide the component. The parameter type is [ArkUI_Visibility](#arkui_visibility). The default value is **ARKUI_VISIBILITY_VISIBLE**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to show or hide the component. The parameter type is [ArkUI_Visibility](#arkui_visibility). The default value is **ARKUI_VISIBILITY_VISIBLE**.| 3330| NODE_CLIP | Defines the clip attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to clip the component based on the parent container bounds. The value **0** means to clip the component, and **1** means the opposite.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to clip the component based on the parent container bounds. The value **0** means to clip the component, and **1** means the opposite.| 3331| NODE_CLIP_SHAPE | Defines the clipping region on the component. This attribute can be set and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute, which supports five types of shapes:<br>1. Rectangle:<br>.value[0].i32: type of shape. The parameter type is [ArkUI_ClipType](#arkui_cliptype). The value is **ARKUI_CLIP_TYPE_RECTANGLE** for the rectangle shape.<br>.value[1].f32: width of the rectangle.<br>.value[2].f32: height of the rectangle.<br>.value[3].f32: width of the rounded corner of the rectangle.<br>.value[4].f32: height of the rounded corner of the rectangle.<br>.value[5]?.f32: radius of the upper left corner of the rectangle. <br>.value[6]?.f32: radius of the lower left corner of the rectangle. <br>.value[7]?.f32: radius of the upper right corner of the rectangle. <br>.value[8]?.f32: radius of the lower right corner of the rectangle. <br>2. Circle:<br>.value[0].i32: type of shape. The parameter type is [ArkUI_ClipType](#arkui_cliptype). The value is **ARKUI_CLIP_TYPE_CIRCLE** for the circle shape.<br>.value[1].f32: width of the circle.<br>.value[2].f32: height of the circle.<br>3. Ellipse:<br>.value[0].i32: type of shape. The parameter type is [ArkUI_ClipType](#arkui_cliptype). The value is **ARKUI_CLIP_TYPE_ELLIPSE** for the ellipse shape.<br>.value[1].f32: width of the ellipse.<br>.value[2].f32: height of the ellipse.<br>4. Path:<br>.value[0].i32: type of shape. The parameter type is [ArkUI_ClipType](#arkui_cliptype). The value is **ARKUI_CLIP_TYPE_PATH** for the path shape.<br>.value[1].f32: width of the path.<br>.value[2].f32: height of the path.<br>.string: command for drawing the path.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md), which supports five types of shapes:<br>1. Rectangle:<br>.value[0].i32: type of shape. The parameter type is [ArkUI_ClipType](#arkui_cliptype). The value is **ARKUI_CLIP_TYPE_RECTANGLE** for the rectangle shape.<br>.value[1].f32: width of the rectangle.<br>.value[2].f32: height of the rectangle.<br>.value[3].f32: width of the rounded corner of the rectangle.<br>.value[4].f32: height of the rounded corner of the rectangle.<br>.value[5]?.f32: radius of the upper left corner of the rectangle. <br>.value[6]?.f32: radius of the lower left corner of the rectangle. <br>.value[7]?.f32: radius of the upper right corner of the rectangle. <br>.value[8]?.f32: radius of the lower right corner of the rectangle. <br>2. Circle:<br>.value[0].i32: type of shape. The parameter type is [ArkUI_ClipType](#arkui_cliptype). The value is **ARKUI_CLIP_TYPE_CIRCLE** for the circle shape.<br>.value[1].f32: width of the circle.<br>.value[2].f32: height of the circle.<br>3. Ellipse:<br>.value[0].i32: type of shape. The parameter type is [ArkUI_ClipType](#arkui_cliptype). The value is **ARKUI_CLIP_TYPE_ELLIPSE** for the ellipse shape.<br>.value[1].f32: width of the ellipse.<br>.value[2].f32: height of the ellipse.<br>4. Path:<br>.value[0].i32: type of shape. The parameter type is [ArkUI_ClipType](#arkui_cliptype). The value is **ARKUI_CLIP_TYPE_PATH** for the path shape.<br>.value[1].f32: width of the path.<br>.value[2].f32: height of the path.<br>.string: command for drawing the path.| 3332| NODE_TRANSFORM | Defines the transform attribute, which can be used to translate, rotate, and scale images. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0...15].f32: 16 floating-point numbers.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0...15].f32: 16 floating-point numbers.| 3333| NODE_HIT_TEST_BEHAVIOR | Defines the hit test behavior attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: hit test mode. The parameter type is [ArkUI_HitTestMode](#arkui_hittestmode). The default value is **ARKUI_HIT_TEST_MODE_DEFAULT**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: hit test mode. The parameter type is **ArkKUI_HitTestMode**. The default value is **ARKUI_HIT_TEST_MODE_DEFAULT**.| 3334| NODE_POSITION | Defines the offset attribute, which specifies the offset of the component's upper left corner relative to the parent container's. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: X coordinate.<br>.value[1].f32: Y coordinate.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: X coordinate.<br>.value[1].f32: Y coordinate.| 3335| NODE_SHADOW | Defines the shadow attribute. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: shadow effect. The parameter type is [ArkUI_ShadowStyle](#arkui_shadowstyle).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: shadow effect. The parameter type is [ArkUI_ShadowStyle](#arkui_shadowstyle).| 3336| NODE_CUSTOM_SHADOW | Defines the custom shadow effect. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0]?.f32: blur radius of the shadow, in vp.<br>.value[1]?.i32: whether to enable the coloring strategy. The value **1** means to enable the coloring strategy, and **0** (default value) means the opposite.<br>.value[2]?.f32: offset of the shadow along the x-axis, in px.<br>.value[3]?.f32: offset of the shadow along the y-axis, in px.<br>.value[4]?.i32: shadow type [ArkUI_ShadowType](#arkui_shadowtype). The default value is **ARKUI_SHADOW_TYPE_COLOR**.<br>.value[5]?.u32: shadow color, in 0xARGB format. For example, 0xFFFF0000 indicates red.<br>.value[6]?.u32: whether to fill the shadow. The value 1 means to fill the shadow, and 0 means the opposite.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: blur radius of the shadow, in vp.<br>.value[1].i32: whether to enable the coloring strategy. <br>.value[2].f32: offset of the shadow along the x-axis, in px.<br>.value[3].f32: offset of the shadow along the y-axis, in px.<br>.value[4].i32: shadow type [ArkUI_ShadowType](#arkui_shadowtype). The default value is **ARKUI_SHADOW_TYPE_COLOR**.<br>.value[5].u32: shadow color, in 0xARGB format. For example, 0xFFFF0000 indicates red.<br>.value[6].u32: whether to fill the shadow. The value **1** means to fill the shadow, and **0** means the opposite.| 3337| NODE_BACKGROUND_IMAGE_SIZE | Defines the background image width and height. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: width of the image. The value range is [0, +∞), and the unit is vp.<br>.value[1].f32: height of the image. The value range is [0, +∞), and the unit is vp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: width of the image, in vp.<br>.value[1].f32: height of the image, in vp.| 3338| NODE_BACKGROUND_IMAGE_SIZE_WITH_STYLE | Defines the background image size. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: size of the background image. The value is an enumerated value of [ArkUI_ImageSize](#arkui_imagesize).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: size of the background image. The value is an enumerated value of [ArkUI_ImageSize](#arkui_imagesize).| 3339| NODE_BACKGROUND_BLUR_STYLE | Defines the background blur attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: blur type. The value is an enumerated value of [ArkUI_BlurStyle](#arkui_blurstyle).<br>.value[1]?.i32: color mode. The value is an enumerated value of [ArkUI_ColorMode](#arkui_colormode).<br>.value[2]?.i32: adaptive color mode. The value is an enumerated value of [ArkUI_AdaptiveColor](#arkui_adaptivecolor).<br>.value[3]?.f32: blur degree. The value range is [0.0, 1.0].<br>.value[4]?.f32: start boundary of grayscale blur.<br>.value[5]?.f32: end boundary of grayscale blur.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: blur type. The value is an enumerated value of [ArkUI_BlurStyle](#arkui_blurstyle).<br>.value[1].i32: color mode. The value is an enumerated value of [ArkUI_ColorMode](#arkui_colormode).<br>.value[2].i32: adaptive color mode. The value is an enumerated value of [ArkUI_AdaptiveColor](#arkui_adaptivecolor).<br>.value[3].f32: blur degree. The value range is [0.0, 1.0].<br>.value[4].f32: start boundary of grayscale blur.<br>.value[5].f32: end boundary of grayscale blur.| 3340| NODE_TRANSFORM_CENTER | Defines the transform center attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0]?.f32: X coordinate of the center point, in vp.<br>.value[1]?.f32: Y coordinate of the center point, in vp.<br>.value[2]?.f32: Z coordinate of the center point, in vp.<br>.value[3]?.f32 : X coordinate of the center point, expressed in a number that represents a percentage. For example, 0.2 indicates 20%. This attribute overwrites value[0].f32. The default value is **0.5f**.<br>.value[4]?.f32 : Y coordinate of the center point, expressed in a number that represents a percentage. For example, 0.2 indicates 20%. This attribute overwrites value[1].f32. The default value is **0.5f**.<br>.value[5]?.f32 : Z coordinate of the center point, expressed in a number that represents a percentage. For example, 0.2 indicates 20%. This attribute overwrites value[2].f32. The default value is **0.0f**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: X coordinate of the center point, in vp. <br>.value[1].f32: Y coordinate of the center point, in vp. <br>.value[2].f32: Z coordinate of the center point, in vp. <br>Note: If the coordinate is expressed in a number that represents a percentage, the attribute obtaining API returns the calculated value in vp.| 3341| NODE_OPACITY_TRANSITION | Defines the transition opacity attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: opacity values of the start and end points.<br>.value[1].i32: animation duration, in milliseconds.<br>.value[2].i32: animation curve type. The value is an enumerated value of [ArkUI_AnimationCurve](#arkui_animationcurve).<br>.value[3]?.i32: animation delay duration, in milliseconds.<br>.value[4]?.i32: number of times that the animation is played.<br>.value[5]?.i32: animation playback mode. The value is an enumerated value of [ArkUI_AnimationPlayMode](#arkui_animationplaymode).<br>.value[6]?.f32: animation playback speed.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: opacity values of the start and end points.<br>.value[1].i32: animation duration, in milliseconds.<br>.value[2].i32: animation curve type. The value is an enumerated value of [ArkUI_AnimationCurve](#arkui_animationcurve).<br>.value[3].i32: animation delay duration, in milliseconds.<br>.value[4].i32: number of times that the animation is played.<br>.value[5].i32: animation playback mode. The value is an enumerated value of [ArkUI_AnimationPlayMode](#arkui_animationplaymode).<br>.value[6].f32: animation playback speed.| 3342| NODE_ROTATE_TRANSITION | Defines the transition rotation attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: X-component of the rotation vector.<br>.value[1].f32: Y-component of the rotation vector.<br>.value[2].f32: Z-component of the rotation vector<br>.value[3].f32: angle.<br>.value[4].f32: line of sight. The default value is **0.0f**.<br>.value[5].i32: animation duration, in milliseconds.<br>.value[6].i32: animation curve type. The value is an enumerated value of [ArkUI_AnimationCurve](#arkui_animationcurve).<br>.value[7]?.i32: animation delay duration, in milliseconds.<br>.value[8]?.i32: number of times that the animation is played.<br>.value[9]?.i32: animation playback mode. The value is an enumerated value of [ArkUI_AnimationPlayMode](#arkui_animationplaymode).<br>.value[10]?.f32: animation playback speed.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: X-component of the rotation vector.<br>.value[1].f32: Y-component of the rotation vector.<br>.value[2].f32: Z-component of the rotation vector<br>.value[3].f32: angle.<br>.value[4].f32: line of sight.<br>.value[5].i32: animation duration, in milliseconds.<br>.value[6].i32: animation curve type. The value is an enumerated value of [ArkUI_AnimationCurve](#arkui_animationcurve).<br>.value[7].i32: animation delay duration, in milliseconds.<br>.value[8].i32: number of times that the animation is played.<br>.value[9].i32: animation playback mode. The value is an enumerated value of [ArkUI_AnimationPlayMode](#arkui_animationplaymode).<br>.value[10].f32: animation playback speed.| 3343| NODE_SCALE_TRANSITION | Defines the transition scaling attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: scale factor along the x-axis.<br>.value[1].f32: scale factor along the y-axis.<br>.value[2].f32: scale factor along the z-axis.<br>value[3].i32: animation duration, in milliseconds.<br>.value[4].i32: animation curve type. The value is an enumerated value of [ArkUI_AnimationCurve](#arkui_animationcurve).<br>.value[5]?.i32: animation delay duration, in milliseconds.<br>.value[6]?.i32: number of times that the animation is played.<br>.value[7]?.i32: animation playback mode. The value is an enumerated value of [ArkUI_AnimationPlayMode](#arkui_animationplaymode).<br>value[8]?.f32: animation playback speed.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: scale factor along the x-axis.<br>.value[1].f32: scale factor along the y-axis.<br>.value[2].f32: scale factor along the z-axis.<br>value[3].i32: animation duration, in milliseconds.<br>.value[4].i32: animation curve type. The value is an enumerated value of [ArkUI_AnimationCurve](#arkui_animationcurve).<br>value[5].i32: animation delay duration, in milliseconds.<br>value[6].i32: number of times that the animation is played.<br>.value[7].i32: animation playback mode. The value is an enumerated value of [ArkUI_AnimationPlayMode](#arkui_animationplaymode).<br>value[8].f32: animation playback speed.| 3344| NODE_TRANSLATE_TRANSITION | Defines the transition translation attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>value[0].f32: translation distance along the x-axis, in vp.<br>value[1].f32: translation distance along the y-axis, in vp.<br>value[2].f32: translation distance along the z-axis, in vp.<br>value[3].i32: animation duration, in milliseconds.<br>value[4].i32: animation curve type. The value is an enumerated value of [ArkUI_AnimationCurve](#arkui_animationcurve).<br>value[5]?.i32: animation delay duration, in milliseconds.<br>value[6]?.i32: number of times that the animation is played.<br>value[7]?.i32: animation playback mode. The value is an enumerated value of [ArkUI_AnimationPlayMode](#arkui_animationplaymode).<br>value[8]?.f32: animation playback speed.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>value[0].f32: translation distance along the x-axis, in vp.<br>value[1].f32: translation distance along the y-axis, in vp.<br>value[2].f32: translation distance along the z-axis, in vp.<br>value[3].i32: animation duration, in milliseconds.<br>value[4].i32: animation curve type. The value is an enumerated value of [ArkUI_AnimationCurve](#arkui_animationcurve).<br>value[5].i32: animation delay duration, in milliseconds.<br>value[6].i32: number of times that the animation is played.<br>value[7].i32: animation playback mode. The value is an enumerated value of [ArkUI_AnimationPlayMode](#arkui_animationplaymode).<br>value[8].f32: animation playback speed.| 3345| NODE_MOVE_TRANSITION | Defines the slide-in and slide-out of the component from the screen edge during transition. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: [ArkUI_TransitionEdge](#arkui_transitionedge) type.<br>.value[1].i32: animation duration, in milliseconds.<br>.value[2].i32: animation curve type. The value is an enumerated value of [ArkUI_AnimationCurve](#arkui_animationcurve).<br>.value[3]?.i32: animation delay duration, in milliseconds.<br>.value[4]?.i32: number of times that the animation is played.<br>.value[5]?.i32: animation playback mode. The value is an enumerated value of [ArkUI_AnimationPlayMode](#arkui_animationplaymode).<br>.value[6]?.f32: animation playback speed.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: [ArkUI_TransitionEdge](#arkui_transitionedge) type.<br>.value[1].i32: animation duration, in milliseconds.<br>.value[2].i32: animation curve type. The value is an enumerated value of [ArkUI_AnimationCurve](#arkui_animationcurve).<br>.value[3].i32: animation delay duration, in milliseconds.<br>.value[4].i32: number of times that the animation is played.<br>.value[5].i32: animation playback mode. The value is an enumerated value of [ArkUI_AnimationPlayMode](#arkui_animationplaymode).<br>.value[6].f32: animation playback speed.| 3346| NODE_FOCUSABLE | Defines the focus attribute, which can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: The parameter type is 1 or 0.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: The parameter type is 1 or 0.| 3347| NODE_DEFAULT_FOCUS | Defines the default focus attribute, which can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>value[0].i32: The parameter type is 1 or 0.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>value[0].i32: The parameter type is 1 or 0.| 3348| NODE_RESPONSE_REGION | Defines the touch target attribute, which can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.data[0].f32: X coordinate of the touch point relative to the upper left corner of the component, in vp.<br>.data[1].f32: Y coordinate of the touch point relative to the upper left corner of the component, in vp.<br>.data[2].f32: width of the touch target, in percentage.<br>.data[3].f32: height of the touch target, in percentage.<br>.data[4...].f32: Multiple touch targets can be set. The sequence of the parameters is the same as the preceding.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.data[0].f32: X coordinate of the touch point relative to the upper left corner of the component, in vp.<br>.data[1].f32: Y coordinate of the touch point relative to the upper left corner of the component, in vp.<br>.data[2].f32: width of the touch target, in percentage.<br>.data[3].f32: height of the touch target, in percentage.<br>.data[4...].f32: Multiple touch targets can be set. The sequence of the parameters is the same as the preceding.| 3349| NODE_OVERLAY | Defines the overlay attribute, which can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: mask text.<br>.value[0]?.i32: position of the overlay relative to the component. Optional. The parameter type is [ArkUI_Alignment](#arkui_alignment). The default value is **ARKUI_ALIGNMENT_TOP_START**.<br>.value[1]?.f32: offset of the overlay relative to the upper left corner of itself on the x-axis, in vp. Optional.<br>.value[2]?.f32: offset of the overlay relative to the upper left corner of itself on the y-axis, in vp. Optional.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: mask text.<br>.value[0].i32: position of the overlay relative to the component. The parameter type is [ArkUI_Alignment](#arkui_alignment). The default value is **ARKUI_ALIGNMENT_TOP_START**.<br>.value[1].f32: offset of the overlay relative to the upper left corner of itself on the x-axis, in vp.<br>.value[2].f32: offset of the overlay relative to the upper left corner of itself on the y-axis, in vp.| 3350| NODE_SWEEP_GRADIENT | Defines the sweep gradient effect. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0]?.f32: X coordinate of the sweep gradient center relative to the upper left corner of the component.<br>.value[1]?.f32: Y coordinate of the sweep gradient center relative to the upper left corner of the component.<br>.value[2]?.f32: start point of the sweep gradient. The default value is **0**.<br>.value[3]?.f32: end point of the sweep gradient. The default value is **0**.<br>.value[4]?.f32: rotation angle of the sweep gradient. The default value is **0**.<br>.value[5]?.i32: whether the colors are repeated. The value **1** means that the colors are repeated, and **0** means the opposite.<br>.object: The parameter type is [ArkUI_ColorStop](_ark_u_i___color_stop.md). - **colors**: array of color stops, each of which consists of a color and its stop position. Invalid colors are automatically skipped.<br>**colors**: colors of the color stops.<br>**stops**: stop positions of the color stops.<br>**size**: number of colors.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: X coordinate of the sweep gradient center relative to the upper left corner of the component. <br>.value[1].f32: Y coordinate of the sweep gradient center relative to the upper left corner of the component. <br>.value[2].f32: start point of the sweep gradient. The default value is **0**.<br>.value[3].f32: end point of the sweep gradient. The default value is **0**.<br>.value[4].f32: rotation angle of the sweep gradient. The default value is **0**.<br>.value[5].i32: whether the colors are repeated. The value **1** means that the colors are repeated, and **0** means the opposite. <br>.object: The parameter type is [ArkUI_ColorStop](_ark_u_i___color_stop.md). - **colors**: array of color stops, each of which consists of a color and its stop position. Invalid colors are automatically skipped.<br>**colors**: colors of the color stops.<br>**stops**: stop positions of the color stops.<br>**size**: number of colors.| 3351| NODE_RADIAL_GRADIENT | Defines the radial gradient effect. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0]?.f32: X coordinate of the radial gradient center relative to the upper left corner of the component.<br>.value[1]?.f32: Y coordinate of the radial gradient center relative to the upper left corner of the component.<br>.value[2]?.f32: radius of the radial gradient. The default value is **0**.<br>.value[3]?.i32: whether the colors are repeated. The value **1** means that the colors are repeated, and **0** means the opposite.<br>.object: The parameter type is [ArkUI_ColorStop](_ark_u_i___color_stop.md). - **colors**: array of color stops, each of which consists of a color and its stop position. Invalid colors are automatically skipped.<br>**colors**: colors of the color stops.<br>**stops**: stop positions of the color stops.<br>**size**: number of colors.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: X coordinate of the radial gradient center relative to the upper left corner of the component. <br>.value[1].f32: Y coordinate of the radial gradient center relative to the upper left corner of the component. <br>.value[2].f32: radius of the radial gradient. The default value is **0**.<br>.value[3].i32: whether the colors are repeated. The value **1** means that the colors are repeated, and **0** means the opposite. <br>.object: The parameter type is [ArkUI_ColorStop](_ark_u_i___color_stop.md). - **colors**: array of color stops, each of which consists of a color and its stop position. Invalid colors are automatically skipped.<br>**colors**: colors of the color stops.<br>**stops**: stop positions of the color stops.<br>**size**: number of colors.| 3352| NODE_MASK | Adds a mask of the specified shape to the component. APIs are provided for setting and obtaining the attribute value.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute, which supports five types of shapes:<br>1. Rectangle:<br>.value[0].u32 fill color, in 0xARGB format.<br>.value[1].u32: stroke color, in 0xARGB format.<br>.value[2].f32: stroke width, in vp.<br>.value[3].i32: mask type. The parameter type is [ArkUI_MaskType](#arkui_masktype). The value is **ARKUI_MASK_TYPE_RECTANGLE** for the rectangle shape.<br>.value[4].f32: width of the rectangle.<br>.value[5].f32: height of the rectangle.<br>.value[6].f32: width of the rounded corner of the rectangle.<br>.value[7].f32: height of the rounded corner of the rectangle.<br>.value[8]?.f32: radius of the upper left corner of the rectangle. <br>.value[9]?.f32: radius of the lower left corner of the rectangle. <br>.value[10]?.f32: radius of the upper right corner of the rectangle. <br>.value[11]?.f32: radius of the lower right corner of the rectangle. <br>2. Circle:<br>.value[0].u32 fill color, in 0xARGB format.<br>.value[1].u32: stroke color, in 0xARGB format.<br>.value[2].f32: stroke width, in vp.<br>.value[3].i32: mask type. The parameter type is [ArkUI_MaskType](#arkui_masktype). The value is **ARKUI_MASK_TYPE_CIRCLE** for the circle shape.<br>.value[4].f32: width of the circle.<br>.value[5].f32: height of the circle.<br>3. Ellipse:<br>.value[0].u32 fill color, in 0xARGB format.<br>.value[1].u32: stroke color, in 0xARGB format.<br>.value[2].f32: stroke width, in vp.<br>.value[3].i32: mask type. The parameter type is [ArkUI_MaskType](#arkui_masktype). The value is **ARKUI_MASK_TYPE_ELLIPSE** for the ellipse shape.<br>.value[4].f32: width of the ellipse.<br>.value[5].f32: height of the ellipse.<br>4. Path:<br>.value[0].u32 fill color, in 0xARGB format.<br>.value[1].u32: stroke color, in 0xARGB format.<br>.value[2].f32: stroke width, in vp.<br>.value[3].i32: mask type. The parameter type is [ArkUI_MaskType](#arkui_masktype). The value is **ARKUI_MASK_TYPE_PATH** for the path shape.<br>.value[4].f32: width of the path.<br>.value[5].f32: height of the path.<br>.string: command for drawing the path.<br>5. Progress:<br>.value[0].i32: mask type. The parameter type is [ArkUI_MaskType](#arkui_masktype). The value is **ARKUI_MASK_TYPE_PROGRESS** for the progress shape.<br>.value[1].f32: current value of the progress indicator.<br>.value[2].f32: maximum value of the progress indicator.<br>.value[3].u32: color of the progress indicator.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md), which supports five types of shapes:<br>1. Rectangle:<br>.value[0].u32 fill color, in 0xARGB format.<br>.value[1].u32: stroke color, in 0xARGB format.<br>.value[2].f32: stroke width, in vp.<br>.value[3].i32: mask type.<br>.value[4].f32: width of the rectangle.<br>.value[5].f32: height of the rectangle.<br>.value[6].f32: width of the rounded corner of the rectangle.<br>.value[7].f32: height of the rounded corner of the rectangle.<br>.value[8]?.f32: radius of the upper left corner of the rectangle. <br>.value[9]?.f32: radius of the lower left corner of the rectangle. <br>.value[10]?.f32: radius of the upper right corner of the rectangle. <br>.value[11]?.f32: radius of the lower right corner of the rectangle. <br>2. Circle:<br>.value[0].u32 fill color, in 0xARGB format.<br>.value[1].u32: stroke color, in 0xARGB format.<br>.value[2].f32: stroke width, in vp.<br>.value[3].i32: mask type.<br>.value[4].f32: width of the circle.<br>.value[5].f32: height of the circle.<br>3. Ellipse:<br>.value[0].u32 fill color, in 0xARGB format.<br>.value[1].u32: stroke color, in 0xARGB format.<br>.value[2].f32: stroke width, in vp.<br>.value[3].i32: mask type.<br>.value[4].f32: width of the ellipse.<br>.value[5].f32: height of the ellipse.<br>4. Path:<br>.value[0].u32 fill color, in 0xARGB format.<br>.value[1].u32: stroke color, in 0xARGB format.<br>.value[2].f32: stroke width, in vp.<br>.value[3].i32: mask type.<br>.value[4].f32: width of the path.<br>.value[5].f32: height of the path.<br>.string: command for drawing the path.<br>5. Progress:<br>.value[0].i32: mask type.<br>.value[1].f32: current value of the progress indicator.<br>.value[2].f32: maximum value of the progress indicator.<br>.value[3].u32: color of the progress indicator.| 3353| NODE_BLEND_MODE | Blends the component's background with the content of the component's child node. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: blend mode. The parameter type is [ArkUI_BlendMode](#arkui_blendmode). The default value is **ARKUI_BLEND_MODE_NONE**.<br>.value[1].?i32: how the specified blend mode is applied. The parameter type is [ArkUI_BlendApplyType](#arkui_blendapplytype). The default value is **BLEND_APPLY_TYPE_FAST**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: blend mode. The parameter type is [ArkUI_BlendMode](#arkui_blendmode). The default value is **ARKUI_BLEND_MODE_NONE**.<br>.value[1].i32: how the specified blend mode is applied. The parameter type is [ArkUI_BlendApplyType](#arkui_blendapplytype). The default value is **BLEND_APPLY_TYPE_FAST**.| 3354| NODE_DIRECTION | Sets the direction of the main axis. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: direction of the main axis.<br>The parameter type is [ArkUI_Direction](#arkui_direction). The default value is **ARKUI_DIRECTION_AUTO**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: direction of the main axis.<br>The parameter type is [ArkUI_Direction](#arkui_direction). The default value is **ARKUI_DIRECTION_AUTO**.| 3355| NODE_CONSTRAINT_SIZE | Defines the size constraints. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: minimum width, in vp.<br>.value[1].f32: maximum width, in vp.<br>.value[2].f32: minimum height, in vp.<br>.value[3].f32: maximum height, in vp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: minimum width, in vp.<br>.value[1].f32: maximum width, in vp.<br>.value[2].f32: minimum height, in vp.<br>.value[3].f32: maximum height, in vp.| 3356| NODE_GRAY_SCALE | Defines the grayscale effect. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: grayscale conversion ratio. The value ranges from 0 to 1. For example, 0.5 indicates a 50% grayscale conversion ratio.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: grayscale conversion ratio. The value ranges from 0 to 1.| 3357| NODE_INVERT | Inverts the image. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: image inversion ratio. The value ranges from 0 to 1. For example, 0.5 indicates a 50% image inversion ratio.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: image inversion ratio. The value ranges from 0 to 1.| 3358| NODE_SEPIA | Defines the sepia conversion ratio. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: sepia conversion ratio. The value ranges from 0 to 1. For example, 0.5 indicates that a 50% sepia conversion ratio.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: sepia conversion ratio. The value ranges from 0 to 1.| 3359| NODE_CONTRAST | Defines the contrast attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: contrast. If the value is **1**, the source image is displayed. A larger value indicates a higher contrast. Value range: [0, 10).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: contrast. Value range: [0, 10).| 3360| NODE_FOREGROUND_COLOR | Sets the foreground color attribute. This attribute can be set and reset as required through APIs. However, the reset API has no effect on this attribute.<br>There are two parameter formats of [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) for setting the attribute:\n<br>1: .value[0].u32: color value, in 0xARGB format. For example, 0xFFFF0000 indicates red.<br>2: .value[0].i32: color enum **ArkUI_ColoringStrategy**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: color value, in 0xARGB format.| 3361| NODE_OFFSET | Defines the offset of the component's child relative to the component. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32 : offset along the x-axis, in vp.<br>.value[1].f32 : offset along the y-axis, in vp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32 : offset along the x-axis, in vp.<br>.value[1].f32 : offset along the y-axis, in vp.| 3362| NODE_MARK_ANCHOR | Sets the anchor for locating the component's child. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: X coordinate of the anchor, in vp.<br>.value[1].f32: Y coordinate of the anchor, in vp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: X coordinate of the anchor, in vp.<br>.value[1].f32: Y coordinate of the anchor, in vp.| 3363| NODE_BACKGROUND_IMAGE_POSITION | Defines the position of the background image in the component, that is, the coordinates relative to the upper left corner of the component. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: position along the x-axis, in px.<br>.value[1].f32: position along the y-axis, in px.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: position along the x-axis, in px.<br>.value[1].f32: position along the y-axis, in px.| 3364| NODE_ALIGN_RULES | Sets the alignment rules in the relative container. This attribute can be set, reset, and obtained as required through APIs.<br>.object: [ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) object that defines the alignment rules.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.object: [ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) object that defines the alignment rules.| 3365| NODE_ALIGN_SELF | Sets the alignment mode of the child components along the cross axis of the parent container. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: alignment mode of the child components along the cross axis of the parent container. <br>The parameter type is [ArkUI_ItemAlignment](#arkui_itemalignment). The default value is **ARKUI_ITEM_ALIGNMENT_AUTO**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: alignment mode of the child components along the cross axis of the parent container. <br>The parameter type is [ArkUI_ItemAlignment](#arkui_itemalignment). The default value is **ARKUI_ITEM_ALIGNMENT_AUTO**.| 3366| NODE_FLEX_GROW | Sets the percentage of the parent container's remaining space that is allocated to the component. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: percentage of the parent container's remaining space that is allocated to the component.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: percentage of the parent container's remaining space that is allocated to the component.| 3367| NODE_FLEX_SHRINK | Sets the percentage of the parent container's shrink size that is allocated to the component. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: percentage of the parent container's shrink size that is allocated to the component.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: percentage of the parent container's shrink size that is allocated to the component.| 3368| NODE_FLEX_BASIS | Sets the base size of the component. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: base size of the component on the main axis of the parent container.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: base size of the component on the main axis of the parent container.| 3369| NODE_ACCESSIBILITY_GROUP | Sets the accessibility group. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: If the value is **1**, the component and all its child components form an entire selectable component, and the accessibility service will no longer available for the content of its child components. The value is **1** or **0**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: If the value is **1**, the component and all its child components form an entire selectable component, and the accessibility service will no longer available for the content of its child components. The value is **1** or **0**.| 3370| NODE_ACCESSIBILITY_TEXT | Sets the accessibility text. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: accessibility text.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: accessibility text.| 3371| NODE_ACCESSIBILITY_MODE | Defines the accessibility mode. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: auxiliary service mode. The parameter type is [ArkUI_AccessibilityMode](#arkui_accessibilitymode).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: auxiliary service mode. The parameter type is [ArkUI_AccessibilityMode](#arkui_accessibilitymode).| 3372| NODE_ACCESSIBILITY_DESCRIPTION | Sets the accessibility description. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: accessibility description.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: accessibility description.| 3373| NODE_FOCUS_STATUS | This interface is used to obtain focus attributes. Attributes can be set and obtained.<br>**NOTE**<br>Setting the parameter to **0** shifts focus from the currently focused component on the current level of the page to the root container.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: The parameter type is 1 or 0.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>value[0].i32: The parameter type is 1 or 0.| 3374| NODE_ASPECT_RATIO | Defines the aspect ratio attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: aspect ratio of the component, in width/height format.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: aspect ratio of the component, in width/height format.| 3375| NODE_LAYOUT_WEIGHT | Defines the weight of the component within its row, column, or flex container for proportional distribution of available space within the container. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].u32: weight of the component along the main axis.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: weight of the component along the main axis.| 3376| NODE_DISPLAY_PRIORITY | Sets the display priority for the component in the row, column, or flex (single-line) container. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].u32: display priority of the component in the container.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: display priority of the component in the container.| 3377| NODE_OUTLINE_WIDTH | Sets the thickness of an element's outline.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: thickness of the left outline.<br>.value[1].f32: thickness of the top outline.<br>.value[2].f32: thickness of the right outline.<br>.value[3].f32: thickness of the bottom outline.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: thickness of the left outline.<br>.value[1].f32: thickness of the top outline.<br>.value[2].f32: thickness of the right outline.<br>.value[3].f32: thickness of the bottom outline.| 3378| NODE_WIDTH_PERCENT | Defines the width attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: width, in percentage. <br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: width, in percentage. | 3379| NODE_HEIGHT_PERCENT | Defines the height attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: height, in percentage. <br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: height, in percentage. | 3380| NODE_PADDING_PERCENT | Defines the padding attribute, which can be set, reset, and obtained as required through APIs.<br>There are two formats of [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) for setting the attribute value:<br>1: Specify the same padding for the four directions.<br>.value[0].f32: padding, in percentage. <br>2: Specify different paddings for different directions.<br>.value[0].f32: top padding, in percentage. <br>.value[1].f32: right padding, in percentage. <br>.value[2].f32: bottom padding, in percentage. <br>.value[3].f32: left padding, in percentage. <br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: top padding, in percentage. <br>.value[1].f32: right padding, in percentage. <br>.value[2].f32: bottom padding, in percentage. <br>.value[3].f32: left padding, in percentage. | 3381| NODE_MARGIN_PERCENT | Defines the margin attribute, which can be set, reset, and obtained as required through APIs.<br>There are two formats of [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) for setting the attribute value:<br>1: Specify the same margin for the four directions.<br>.value[0].f32: margin, in percentage. <br>2: Specify different margins for different directions.<br>.value[0].f32: top margin, in percentage. <br>.value[1].f32: right margin, in percentage. <br>.value[2].f32: bottom margin, in percentage. <br>.value[3].f32: left margin, in percentage. <br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: top margin, in percentage. <br>.value[1].f32: right margin, in percentage. <br>.value[2].f32: bottom margin, in percentage. <br>.value[3].f32: left margin, in percentage. | 3382| NODE_GEOMETRY_TRANSITION | Implements an implicit shared element transition. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: two components bound to the shared element. The parameter type is 1 or 0. By default, the out component does not continue to participate in the shared element animation when not yet deleted, which means that it stays in its original position.<br>.string: ID used to set up a binding relationship. If this attribute is set to an empty string **""**, the binding relationship is cleared. The value can be dynamically changed to refresh the binding relationship. One ID can be bound to only two components, which function as in and out components.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: two components bound to the shared element. The parameter type is 1 or 0. By default, the out component does not continue to participate in the shared element animation when not yet deleted, which means that it stays in its original position.<br>.string: ID used to set up a binding relationship. If this attribute is set to an empty string **""**, the binding relationship is cleared. The value can be dynamically changed to refresh the binding relationship. One ID can be bound to only two components, which function as in and out components.| 3383| NODE_RELATIVE_LAYOUT_CHAIN_MODE | Specifies the parameters of the chain formed by the component as the chain head. The attribute setting, attribute resetting, and attribute obtaining interfaces are supported.<br>This attribute has effect only when the parent container is **RelativeContainer**.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: direction of the chain. Enumeration [ArkUI_Axis](#arkui_axis).<br>.value[1].i32: style of the chain. Enumeration [ArkUI_RelativeLayoutChainStyle](#arkui_relativelayoutchainstyle).<br>.value[0].i32: direction of the chain. Enumeration [ArkUI_Axis](#arkui_axis).<br>.value[1].i32: style of the chain. Enumeration [ArkUI_RelativeLayoutChainStyle](#arkui_relativelayoutchainstyle).| 3384| NODE_RENDER_FIT | Sets how the final state of the component's content is rendered during its width and height animation process. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32 Content filling mode. The enumerated values of [ArkUI_RenderFit](#arkui_renderfit) are used.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32 Content filling mode. The enumerated values of [ArkUI_RenderFit](#arkui_renderfit) are used.| 3385| NODE_OUTLINE_COLOR | Defines the border color attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>1: .value[0].u32: color of the four borders, in 0xARGB format, for example, **0xFFFF11FF**.<br>2: .value[0].u32: color of the top border, in 0xARGB format, for example, **0xFFFF11FF**.<br>.value[1].u32: color of the right border, in 0xARGB format, for example, **0xFFFF11FF**.<br>.value[2].u32: color of the lower border, in 0xARGB format, for example, **0xFFFF11FF**.<br>.value[3].u32: color of the left border, in 0xARGB format, for example, **0xFFFF11FF**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: color of the top border, in 0xARGB format, for example, **0xFFFF11FF**.<br>.value[1].u32: color of the right border, in 0xARGB format, for example, **0xFFFF11FF**.<br>.value[2].u32: color of the lower border, in 0xARGB format, for example, **0xFFFF11FF**.<br>.value[3].u32: color of the left border, in 0xARGB format, for example, **0xFFFF11FF**.| 3386| NODE_SIZE | Sets the size. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: width, in vp.<br>.value[1].f32: height, in vp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: width, in vp.<br>.value[1].f32: height, in vp.| 3387| NODE_RENDER_GROUP | Sets whether the component and its child components are rendered off the screen and then drawn together with its parent. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: The parameter type is 1 or 0.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>value[0].i32: The parameter type is 1 or 0.| 3388| NODE_COLOR_BLEND | The color overlay effect is added to the component. The attribute setting, attribute resetting, and attribute obtaining interfaces are supported.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].u32: color to blend with the component, in 0xARGB format, for example, **0xFFFF11FF**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: color to blend with the component, in 0xARGB format, for example, **0xFFFF11FF**.| 3389| NODE_FOREGROUND_BLUR_STYLE | Applies a foreground blur style to the component. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: foreground blur style. The value is an enum of [ArkUI_BlurStyle](#arkui_blurstyle).<br>.value[1]?.i32: color mode used for the foreground blur. The value is an enum of [ArkUI_ColorMode](#arkui_colormode).<br>.value[2]?.i32: adaptive color mode used for the foreground blur. The value is an enum of [ArkUI_AdaptiveColor](#arkui_adaptivecolor).<br>.value[3]?.f32: blur degree. The value range is [0.0, 1.0].<br>.value[4]?.i32: brightness of black in the grayscale blur. The value range is [0, 127].<br>.value[5]?.i32: degree of darkening the white color in the grayscale blur. The value range is [0, 127].<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: foreground blur style. The value is an enum of [ArkUI_BlurStyle](#arkui_blurstyle).<br>.value[1].i32: color mode used for the foreground blur. The value is an enum of [ArkUI_ColorMode](#arkui_colormode).<br>.value[2].i32: adaptive color mode used for the foreground blur. The value is an enum of [ArkUI_AdaptiveColor](#arkui_adaptivecolor).<br>.value[3].f32: blur degree. The value range is [0.0, 1.0].<br>.value[4].i32: brightness of black in the grayscale blur. The value range is [0, 127].<br>.value[5].i32: degree of darkening the white color in the grayscale blur. The value range is [0, 127].| 3390| NODE_LAYOUT_RECT | Defines the component size and position for layout. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: X coordinate of the component, in px. <br>.value[1].i32: Y coordinate of the component, in px. <br>.value[2].i32: width of the component, in px. <br>.value[3].i32: height of the component, in px. <br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: X coordinate of the component, in px. <br>.value[1].i32: Y coordinate of the component, in px. <br>.value[2].i32: width of the component, in px. <br>.value[3].i32: height of the component, in px. | 3391| NODE_FOCUS_ON_TOUCH | Sets whether the component is focusable on touch. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: The parameter type is 1 or 0.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>value[0].i32: The parameter type is 1 or 0.| 3392| NODE_BORDER_WIDTH_PERCENT | Defines the border width attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>1: .value[0].f32: width of the four borders, in percentage.<br>2: .value[0].f32: width of the top border, in percentage.<br>.value[1].f32: width of the right border, in percentage.<br>.value[2].f32: width of the bottom border, in percentage.<br>.value[3].f32: width of the left border, in percentage.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: width of the top border, in percentage.<br>.value[1].f32: width of the right border, in percentage.<br>.value[2].f32: width of the bottom border, in percentage.<br>.value[3].f32: width of the left border, in percentage.| 3393| NODE_BORDER_RADIUS_PERCENT | Defines the border corner radius attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>1: .value[0].f32: radius of the four corners, in percentage.<br>2: .value[0].f32: radius of the upper left corner, in percentage.<br>.value[1].f32: radius of the upper right corner, in percentage.<br>.value[2].f32: radius of the lower left corner, in percentage.<br>.value[3].f32: radius of the lower right corner, in percentage.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: radius of the upper left corner, in percentage.<br>.value[1].f32: radius of the upper right corner, in percentage.<br>.value[2].f32: radius of the lower left corner, in percentage.<br>.value[3].f32: radius of the lower right corner, in percentage.| 3394| NODE_ACCESSIBILITY_ID | Sets the custom accessibility ID. This attribute can be obtained.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: custom accessibility ID.| 3395| NODE_ACCESSIBILITY_ACTIONS | Sets the accessibility action type. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: accessibility operation type. The parameter type is [ArkUI_AccessibilityActionType](#arkui_accessibilityactiontype).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: accessibility operation type. The parameter type is [ArkUI_AccessibilityActionType](#arkui_accessibilityactiontype).| 3396| NODE_ACCESSIBILITY_ROLE | Defines supported accessibility component types. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: Accessibility component type. The parameter type is [ArkUI_NodeType](#arkui_nodetype).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: Accessibility component type. The parameter type is [ArkUI_NodeType](#arkui_nodetype).| 3397| NODE_ACCESSIBILITY_STATE | Sets the accessibility state. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.object: accessibility state. The parameter type is [ArkUI_AccessibilityState](#arkui_accessibilitystate).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.object: accessibility state. The parameter type is [ArkUI_AccessibilityState](#arkui_accessibilitystate).| 3398| NODE_ACCESSIBILITY_VALUE | Sets the accessibility value. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.object: accessibility value. The parameter type is [ArkUI_AccessibilityValue](#arkui_accessibilityvalue).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.object: accessibility value. The parameter type is [ArkUI_AccessibilityValue](#arkui_accessibilityvalue).| 3399| NODE_EXPAND_SAFE_AREA | Sets the safe area to be expanded to. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0]?.u32: types of the expanded safe area, which are enumerated values of [ArkUI_SafeAreaType](#arkui_safeareatype). Example: ARKUI_SAFE_AREA_TYPE_SYSTEM \| ARKUI_SAFE_AREA_TYPE_CUTOUT.<br>.value[1]?.u32: edges for expanding the safe area, which are enumerated values of [ArkUI_SafeAreaEdge](#arkui_safeareaedge).<br>Example: ARKUI_SAFE_AREA_EDGE_TOP \| ARKUI_SAFE_AREA_EDGE_BOTTOM.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: expanded safe area.<br>.<br>.value[1].u32: edges for expanding the safe area.<br> | 3400| NODE_VISIBLE_AREA_CHANGE_RATIO | Defines the visible area ratio (visible area/total area of the component) threshold for invoking the visible area change event of the component.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[...].f32: threshold array. The value ranges from 0 to 1.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[...].f32: threshold array.<br> | 3401| NODE_TRANSITION | Sets the transition effect when the component is inserted or deleted. This attribute can be set and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.object: transition effect. The parameter type is [ArkUI_TransitionEffect](#arkui_transitioneffect).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.object: transition effect. The parameter type is [ArkUI_TransitionEffect](#arkui_transitioneffect).| 3402| NODE_UNIQUE_ID | Defines the component ID. This attribute can be obtained through APIs.<br>**NOTE**<br>The component ID is read-only and unique in a process.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: component ID.| 3403| NODE_FOCUS_BOX | Sets the style of the system focus box for this component.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: distance between the focus box and the edge of the component A positive number indicates the outside, and a negative number indicates the inside. The value cannot be in percentage.<br>.value[1].f32: width of the focus box. Negative numbers and percentages are not supported.<br>.value[2].u32: color of the focus box.| 3404| NODE_CLICK_DISTANCE | Defines the moving distance limit for the component-bound tap gesture. This attribute can be set as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: allowed moving distance of a finger, in vp.| 3405| NODE_TAB_STOP | Sets whether the focus can be placed on this component. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: The parameter type is 1 or 0.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: The parameter type is 1 or 0.| 3406| NODE_BACKGROUND_IMAGE_RESIZABLE_WITH_SLICE | Sets the resizable attribute of a background image when it is stretched. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: pixel value of the image that remains unchanged when the left side of the image is stretched, in vp.<br>.value[1].f32: pixel value of the image that remains unchanged when the top side of the image is stretched, in vp.<br>.value[2].f32: pixel value of the image that remains unchanged when the right side of the image is stretched, in vp.<br>.value[3].f32: pixel value of the image that remains unchanged when the bottom side of the image is stretched, in vp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: pixel value of the image that remains unchanged when the left side of the image is stretched, in vp.<br>.value[1].f32: pixel value of the image that remains unchanged when the top side of the image is stretched, in vp.<br>.value[2].f32: pixel value of the image that remains unchanged when the right side of the image is stretched, in vp.<br>.value[3].f32: pixel value of the image that remains unchanged when the bottom side of the image is stretched, in vp.<br>**Since**<br>18 | 3407| NODE_VISIBLE_AREA_APPROXIMATE_CHANGE_RATIO | Sets the threshold ratio for triggering a visible area change event.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.object: parameter for visible area change events. The parameter type is **ArkUI_VisibleAreaEventOptions**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>object: parameter for visible area change events. The parameter type is **ArkUI_VisibleAreaEventOptions**.<br>**Since**<br>18 | 3408| NODE_TEXT_CONTENT | Defines the text content attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: text content.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: text content.| 3409| NODE_FONT_COLOR | Defines the font color attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].u32: font color, in 0xARGB format. For example, 0xFFFF0000 indicates red.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: font color value, in 0xARGB format.| 3410| NODE_FONT_SIZE | Defines the font size attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: font size, in fp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: font size, in fp.| 3411| NODE_FONT_STYLE | Defines the font style attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: font style [ArkUI_FontStyle](#arkui_fontstyle). The default value is **ARKUI_FONT_STYLE_NORMAL**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: font style [ArkUI_FontStyle](#arkui_fontstyle).| 3412| NODE_FONT_WEIGHT | Defines the font weight attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: font weight [ArkUI_FontWeight](#arkui_fontweight). The default value is **ARKUI_FONT_WEIGHT_NORMAL**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: font weight [ArkUI_FontWeight](#arkui_fontweight).| 3413| NODE_TEXT_LINE_HEIGHT | Defines the text line height attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: line height, in fp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: line height, in fp.| 3414| NODE_TEXT_DECORATION | Defines the text decoration style and color. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: text decoration type [ArkUI_TextDecorationType](#arkui_textdecorationtype). The default value is **ARKUI_TEXT_DECORATION_TYPE_NONE**.<br>.value[1]?.u32: text decoration color, in 0xARGB format. For example, 0xFFFF0000 indicates red. Optional. <br>.value[2]?.i32: text decoration style [ArkUI_TextDecorationStyle](#arkui_textdecorationstyle).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: text decoration type [ArkUI_TextDecorationType](#arkui_textdecorationtype).<br>.value[1].u32: text decoration color, in 0xARGB format.<br>.value[2].i32: text decoration style [ArkUI_TextDecorationStyle](#arkui_textdecorationstyle).| 3415| NODE_TEXT_CASE | Defines the text case attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: text case.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: text case.| 3416| NODE_TEXT_LETTER_SPACING | Defines the letter spacing attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: letter spacing, in fp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: letter spacing, in fp.| 3417| NODE_TEXT_MAX_LINES | Sets the maximum number of lines in the text. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: maximum number of lines in the text.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: maximum number of lines in the text.| 3418| NODE_TEXT_ALIGN | Horizontal alignment mode of the text. The interfaces for setting, resetting, and obtaining attributes are supported.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: horizontal alignment mode of the text. The value is an enum of [ArkUI_TextAlignment](#arkui_textalignment).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: horizontal alignment mode of the text. The value is an enum of [ArkUI_TextAlignment](#arkui_textalignment).| 3419| NODE_TEXT_OVERFLOW | Defines the text overflow attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: display mode when the text is too long.{\@ArkUI_TextOverflow}<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: display mode when the text is too long.{\@ArkUI_TextOverflow} | 3420| NODE_FONT_FAMILY | Defines the font family attribute, which can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: fonts, separated by commas (,).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: fonts, separated by commas (,).| 3421| NODE_TEXT_COPY_OPTION | Defines the copy option attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: copy option [ArkUI_CopyOptions](#arkui_copyoptions). The default value is **ARKUI_COPY_OPTIONS_NONE**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: copy option [ArkUI_CopyOptions](#arkui_copyoptions).| 3422| NODE_TEXT_BASELINE_OFFSET | Defines the text baseline offset attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: baseline offset, in fp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: baseline offset, in fp.| 3423| NODE_TEXT_TEXT_SHADOW | Defines the shadow attribute. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: blur radius of the shadow, in vp.<br>.value[1].i32: shadow type [ArkUI_ShadowType](#arkui_shadowtype). The default value is **ARKUI_SHADOW_TYPE_COLOR**.<br>.value[2].u32: shadow color, in 0xARGB format. For example, 0xFFFF0000 indicates red.<br>.value[3].f32: offset of the shadow along the x-axis, in vp.<br>.value[4].f32: offset of the shadow along the y-axis, in vp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: blur radius of the shadow, in vp.<br>.value[1].i32: shadow type [ArkUI_ShadowType](#arkui_shadowtype).<br>.value[2].u32: shadow color, in 0xARGB format.<br>.value[3].f32: offset of the shadow along the x-axis, in vp.<br>.value[4].f32: offset of the shadow along the y-axis, in vp.| 3424| NODE_TEXT_MIN_FONT_SIZE | Defines the minimum font size attribute, which can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: minimum font size, in fp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: minimum font size, in fp.| 3425| NODE_TEXT_MAX_FONT_SIZE | Defines the maximum font size attribute, which can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: maximum font size, in fp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: maximum font size, in fp.| 3426| NODE_TEXT_FONT | Defines the text style attribute, which can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string?: font family. Optional. Use commas (,) to separate multiple fonts.<br>.value[0].f32: font size, in fp.<br>.value[1]? .i32: font weight. Optional. The parameter type is [ArkUI_FontWeight](#arkui_fontweight). The default value is **ARKUI_FONT_WEIGHT_NORMAL**.<br>.value[2]?.i32: font style. Optional. The parameter type is [ArkUI_FontStyle](#arkui_fontstyle). The default value is **ARKUI_FONT_STYLE_NORMAL**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: font family. Use commas (,) to separate multiple fonts.<br>.value[0].f32: font size, in fp.<br>.value[1].i32: font weight. The parameter type is [ArkUI_FontWeight](#arkui_fontweight). The default value is **ARKUI_FONT_WEIGHT_NORMAL**.<br>.value[2].i32: font style. The parameter type is [ArkUI_FontStyle](#arkui_fontstyle). The default value is **ARKUI_FONT_STYLE_NORMAL**.| 3427| NODE_TEXT_HEIGHT_ADAPTIVE_POLICY | Defines how the adaptive height is determined for the text. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: how the adaptive height is determined for the text. The parameter type is [ArkUI_TextHeightAdaptivePolicy](#arkui_textheightadaptivepolicy).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: how the adaptive height is determined for the text. The parameter type is [ArkUI_TextHeightAdaptivePolicy](#arkui_textheightadaptivepolicy).| 3428| NODE_TEXT_INDENT | Defines the indentation of the first line. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: indentation of the first line.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: indentation of the first line.| 3429| NODE_TEXT_WORD_BREAK | Defines the line break rule. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: line break rule. The parameter type is [ArkUI_WordBreak](#arkui_wordbreak).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: line break rule. The parameter type is [ArkUI_WordBreak](#arkui_wordbreak).| 3430| NODE_TEXT_ELLIPSIS_MODE | Defines the ellipsis position. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: ellipsis position. The parameter type is [ArkUI_EllipsisMode](#arkui_ellipsismode).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: ellipsis position. The parameter type is [ArkUI_EllipsisMode](#arkui_ellipsismode).| 3431| NODE_TEXT_LINE_SPACING | Defines the line spacing attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: line spacing, in fp. <br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: line spacing, in fp. | 3432| NODE_FONT_FEATURE | Sets the font feature. **NODE_FONT_FEATURE** provides advanced typographic features in OpenType fonts.<br>These features such as hyphenation and monospace are generally used in custom fonts and require support from the respective fonts. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: string that complies with the text feature format. The format is normal\.| <feature-tag-value>,<br>Syntax for <feature-tag-value>: <string> [ <integer> \| on \| off ],<br>There can be multiple **feature-tag-value** values, separated by commas (,). For example, for the monospace feature, you can pass in **ss01 on**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: font feature. Multiple font features are separated by commas (,).| 3433| NODE_TEXT_ENABLE_DATA_DETECTOR | Sets whether to enable text recognition.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to enable text recognition. The default value is **false**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to enable text recognition.| 3434| NODE_TEXT_ENABLE_DATA_DETECTOR_CONFIG | Configures text recognition settings.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0...].i32: entity type array. The parameter type is [ArkUI_TextDataDetectorType](#arkui_textdatadetectortype).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0...].i32: entity type array. The parameter type is [ArkUI_TextDataDetectorType](#arkui_textdatadetectortype).| 3435| NODE_TEXT_SELECTED_BACKGROUND_COLOR | Defines the background color of the selected text. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].u32: color value, in 0xARGB format. For example, 0xFFFF0000 indicates red.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: color value, in 0xARGB format.| 3436| NODE_TEXT_CONTENT_WITH_STYLED_STRING | Sets the string to use in the styled string. This attribute can be set and obtained as required through APIs. When a custom **OH_Drawing_Typography** object is configured for a **Text** component, the layout measurement phase of the **Text** component is skipped. Below are some tips to handle this issue:<br>1. Ensure that the lifecycle of the **OH_ArkUI_StyledString** object and the **OH_Drawing_Typography** object follows that of the **Text** component. Reset the **OH_ArkUI_StyledString** object when the **Text** component is destroyed; otherwise, a null pointer crash may occur in the application.<br>2. Ensure that the **OH_Drawing_TypographyLayout** API is called before the layout measurement of the **Text** component.<br>3. When releasing the **OH_ArkUI_StyledString** object and the **OH_Drawing_Typography** object, call the **reset** API of the **Text** component. Otherwise, a null pointer crash may occur in the application<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.object: string to use in the styled string. The parameter type is [ArkUI_StyledString](#arkui_styledstring).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.object: string to use in the styled string. The parameter type is [ArkUI_StyledString](#arkui_styledstring).| 3437| NODE_TEXT_HALF_LEADING | Sets whether to center text vertically in the **Text** component.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to center text vertically. The default value is **false**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to center text vertically.| 3438| NODE_IMMUTABLE_FONT_WEIGHT | Defines the font weight attribute, which can be set, reset, and obtained as required through APIs. The font weight specified by this API is not affected by any changes in the system font weight settings.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: font weight [ArkUI_FontWeight](#arkui_fontweight). The default value is **ARKUI_FONT_WEIGHT_NORMAL**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: font weight [ArkUI_FontWeight](#arkui_fontweight).| 3439| NODE_SPAN_CONTENT | Defines the text content attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: content of the text span.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: content of the text span.| 3440| NODE_SPAN_TEXT_BACKGROUND_STYLE | Defines the text background style. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].u32: color of the text background, in 0xARGB format, for example, **0xFFFF0000** indicating red.<br>The second parameter is used to set the rounded corner of the text background. The options are as follows:<br>1: .value[1].f32: The radiuses of rounded corners in the four directions are set in a unified manner. The unit is vp.<br>2: .value[1].f32: radius of the upper left corner, in vp.<br>.value[2].f32: radius of the upper right corner, in vp.<br>.value[3].f32: radius of the lower left corner, in vp.<br>.value[4].f32: radius of the lower right corner, in vp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: color of the text background, in 0xARGB format.<br>.value[1].f32: radius of the upper left corner, in vp.<br>.value[2].f32: radius of the upper right corner, in vp.<br>.value[3].f32: radius of the lower left corner, in vp.<br>.value[4].f32: radius of the lower right corner, in vp.| 3441| NODE_SPAN_BASELINE_OFFSET | Defines the text baseline offset attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: baseline offset, in fp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: baseline offset, in fp.| 3442| NODE_IMAGE_SPAN_SRC | Defines the image source for an image span. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: image address of the image span.<br>.object: **PixelMap** object. The parameter type is [ArkUI_DrawableDescriptor](#arkui_drawabledescriptor).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: image address of the image span.<br>.object: **PixelMap** object. The parameter type is [ArkUI_DrawableDescriptor](#arkui_drawabledescriptor). Either **.object** or **.string** must be set.| 3443| NODE_IMAGE_SPAN_VERTICAL_ALIGNMENT | Defines the alignment mode of the image with the text. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32 indicates the text-based image alignment mode. The enumerated values of [ArkUI_ImageSpanAlignment](#arkui_imagespanalignment) are used.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32 indicates the text-based image alignment mode. The enumerated values of [ArkUI_ImageSpanAlignment](#arkui_imagespanalignment) are used.| 3444| NODE_IMAGE_SPAN_ALT | Defines the image source for an image span. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: placeholder image address for the image span. GIF images are not supported.<br>.object: **PixelMap** object. The parameter type is [ArkUI_DrawableDescriptor](#arkui_drawabledescriptor). Either **.object** or **.string** must be set.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: image source for the image span.<br>.object: **PixelMap** object. The parameter type is [ArkUI_DrawableDescriptor](#arkui_drawabledescriptor).| 3445| NODE_IMAGE_SPAN_BASELINE_OFFSET | Defines the baseline offset attribute of the **ImageSpan** component. This attribute can be set, reset, and obtained as required through APIs. A positive value means an upward offset, while a negative value means a downward offset. The default value is **0**, and the unit is fp.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: baseline offset, in fp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: baseline offset, in fp.| 3446| NODE_IMAGE_SRC | Defines the image source of the **Image** component. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: image source.<br>.object: **PixelMap** object. The parameter type is [ArkUI_DrawableDescriptor](#arkui_drawabledescriptor). Either **.object** or **.string** must be set.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: image source.<br>.object: **PixelMap** object. The parameter type is [ArkUI_DrawableDescriptor](#arkui_drawabledescriptor).| 3447| NODE_IMAGE_OBJECT_FIT | Defines how the image is resized to fit its container. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32 indicates the image filling effect. The enumerated values of [ArkUI_ObjectFit](#arkui_objectfit) are used.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32 indicates the image filling effect. The enumerated values of [ArkUI_ObjectFit](#arkui_objectfit) are used.| 3448| NODE_IMAGE_INTERPOLATION | Defines the interpolation effect of the image. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32 indicates the interpolation effect. The enumerated values of [ArkUI_ImageInterpolation](#arkui_imageinterpolation) are used.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32 indicates the interpolation effect. The enumerated values of [ArkUI_ImageInterpolation](#arkui_imageinterpolation) are used.| 3449| NODE_IMAGE_OBJECT_REPEAT | Defines how the image is repeated. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32 indicates the image repetition style. The enumerated values of [ArkUI_ImageRepeat](#arkui_imagerepeat) are used.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32 indicates the image repetition style. The enumerated values of [ArkUI_ImageRepeat](#arkui_imagerepeat) are used.| 3450| NODE_IMAGE_COLOR_FILTER | Defines the color filter of the image. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32 to .value[19].f32: filter matrix array.<br>.size: 5 x 4 filter array size.<br>.object: pointer to the color filter. The parameter type is **OH_Drawing_ColorFilter**. Either .object or .size can be set.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32 to .value[19].f32: filter matrix array.<br>.size: 5 x 4 filter array size.<br>.object: pointer to the color filter. The parameter type is **OH_Drawing_ColorFilter**.| 3451| NODE_IMAGE_AUTO_RESIZE | Defines the auto resize attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32 : whether to resize the image source.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32 : whether to resize the image source.| 3452| NODE_IMAGE_ALT | Defines the placeholder image source. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: image source for the image span.<br>.object: **PixelMap** object. The parameter type is [ArkUI_DrawableDescriptor](#arkui_drawabledescriptor). Either **.object** or **.string** must be set.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: image source for the image span.<br>.object: **PixelMap** object. The parameter type is [ArkUI_DrawableDescriptor](#arkui_drawabledescriptor).| 3453| NODE_IMAGE_DRAGGABLE | Defines whether the image is draggable. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether the image is draggable. The value **true** means that the image is draggable.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether the image is draggable.| 3454| NODE_IMAGE_RENDER_MODE | Defines the image rendering mode. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: The parameter type is [ArkUI_ImageRenderMode](#arkui_imagerendermode).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: The parameter type is [ArkUI_ImageRenderMode](#arkui_imagerendermode).| 3455| NODE_IMAGE_FIT_ORIGINAL_SIZE | Sets whether to fit the component to the size of the image source when the component size is not set. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: indicates whether the display size of an image follows the size of the image source. The value 1 indicates that the display size follows the size of the image source, and the value 0 indicates that the display size does not follow the size of the image source. The default value is 0.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: The value **1** means to fit the component to the size of the image source, and **0** means the opposite.| 3456| NODE_IMAGE_FILL_COLOR | Sets the fill color to be superimposed on the image. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].u32: fill color. The value is in 0xARGB format. For example, 0xFFFF0000 indicates red.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: fill color. The value is in 0xARGB format.| 3457| NODE_IMAGE_RESIZABLE | Sets the resizable image options.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: width of the left edge. The unit is vp.<br>.value[1].f32: width of the top edge. The unit is vp.<br>.value[2].f32: width of the right edge. The unit is vp.<br>.value[3].f32: width of the bottom edge. The unit is vp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: width of the left edge. The unit is vp.<br>.value[1].f32: width of the top edge. The unit is vp.<br>.value[2].f32: width of the right edge. The unit is vp.<br>.value[3].f32: width of the bottom edge. The unit is vp.| 3458| NODE_TOGGLE_SELECTED_COLOR | Defines the color of the component when it is selected. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].u32: background color, in 0xARGB format. For example, 0xFFFF0000 indicates red.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: background color, in 0xARGB format.| 3459| NODE_TOGGLE_SWITCH_POINT_COLOR | Defines the color of the circular slider for the component of the switch type. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].u32: color of the circular slider, in 0xARGB format. For example, 0xFFFF0000 indicates red.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: color of the circular slider, in 0xARGB format.| 3460| NODE_TOGGLE_VALUE | Defines the toggle switch value. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to enable the toggle. The value **true** means to enable the toggle.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to enable the toggle.| 3461| NODE_TOGGLE_UNSELECTED_COLOR | Defines the color of the component when it is deselected. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].u32: background color, in 0xARGB format. For example, 0xFFFF0000 indicates red.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: background color, in 0xARGB format.| 3462| NODE_LOADING_PROGRESS_COLOR | Defines the foreground color of the loading progress bar. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].u32: foreground color, in 0xARGB format. For example, 0xFFFF0000 indicates red.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: foreground color, in 0xARGB format.| 3463| NODE_LOADING_PROGRESS_ENABLE_LOADING | Defines whether to show the loading animation for the **LoadingProgress** component. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to show the loading animation. The value **true** means to show the loading animation, and **false** means the opposite.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to show the loading animation. The value **true** means to show the loading animation, and **false** means the opposite.| 3464| NODE_TEXT_INPUT_PLACEHOLDER | Defines the default placeholder text of the single-line text box. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: default placeholder text.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: default placeholder text.| 3465| NODE_TEXT_INPUT_TEXT | Defines the default text content of the single-line text box. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: default text content.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: default text content.| 3466| NODE_TEXT_INPUT_CARET_COLOR | Defines the border color attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].u32: caret color, in 0xARGB format. For example, 0xFFFF0000 indicates red.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: caret color, in 0xARGB format. | 3467| NODE_TEXT_INPUT_CARET_STYLE | Defines the caret style attribute. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: caret width, in vp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: caret width, in vp.| 3468| NODE_TEXT_INPUT_SHOW_UNDERLINE | Defines the underline attribute of the single-line text box. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to show an underline. The value **true** means to show an underline, and **false** means the opposite.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: The value **1** means to show an underline, and **0** means the opposite.| 3469| NODE_TEXT_INPUT_MAX_LENGTH | Defines the maximum number of characters in the text input. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: maximum number of characters in the text input, without a unit.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: maximum number of characters in the text input.| 3470| NODE_TEXT_INPUT_ENTER_KEY_TYPE | Defines the type of the Enter key. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: Enter key type enumeration [ArkUI_EnterKeyType](#arkui_enterkeytype). The default value is ARKUI_ENTER_KEY_TYPE_DONE.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: type of the Enter key. The value is an enum of [ArkUI_EnterKeyType](#arkui_enterkeytype).| 3471| NODE_TEXT_INPUT_PLACEHOLDER_COLOR | Defines the placeholder text color. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].u32: color value, in 0xARGB format. For example, 0xFFFF0000 indicates red.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: color value, in 0xARGB format.| 3472| NODE_TEXT_INPUT_PLACEHOLDER_FONT | Defines the placeholder text font. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0]?.f32: font size, in fp. Optional. The default value is **16.0**.<br>.value[1]?.i32: font style [ArkUI_FontStyle](#arkui_fontstyle). Optional. The default value is **ARKUI_FONT_STYLE_NORMAL**.<br>.value[2]?.i32: font weight [ArkUI_FontWeight](#arkui_fontweight). Optional. The default value is **ARKUI_FONT_WEIGHT_NORMAL**.<br>?.string: font family. Multiple font families are separated by commas (,). For example, "font weight; font family 1, font family 2".<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: font size, in fp.<br>.value[1].i32: font style [ArkUI_FontStyle](#arkui_fontstyle).<br>.value[2].i32: font weight [ArkUI_FontWeight](#arkui_fontweight).<br>.string: font family. Multiple font families are separated by commas (,).| 3473| NODE_TEXT_INPUT_ENABLE_KEYBOARD_ON_FOCUS | Defines whether to enable the input method when the component obtains focus. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to enable the input method when the component obtains focus. The value **true** means to enable the input method, and **false** means the opposite.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to enable the input method when the component obtains focus. The value **1** means to enable the input method when the component obtains focus, and **0** means the opposite.| 3474| NODE_TEXT_INPUT_TYPE | Defines the text box type. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: input box type enumeration [ArkUI_TextInputType](#arkui_textinputtype). The default value is ARKUI_TEXTINPUT_TYPE_NORMAL.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: input box type enumeration [ArkUI_TextInputType](#arkui_textinputtype).| 3475| NODE_TEXT_INPUT_SELECTED_BACKGROUND_COLOR | Defines the background color of the selected text. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].u32: color value, in 0xARGB format. For example, 0xFFFF0000 indicates red.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: color value, in 0xARGB format.| 3476| NODE_TEXT_INPUT_SHOW_PASSWORD_ICON | Defines whether to display the password icon at the end of the password text box. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to display the password icon at the end of the password text box. The value **true** means to display the password icon, and **false** means the opposite.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: The value **1** means to display the password icon at the end of the password text box, and **0** means the opposite.| 3477| NODE_TEXT_INPUT_EDITING | Defines the editable state for the single-line text box. This attribute can be set as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to remain in the editable state. The value **true** means to remain in the editable state, and **false** means to exit the editable state.<br>The format of the attribute obtaining method parameter [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) is as follows:<br>.value[0].i32: whether to remain in the editable state. The value **true** means to remain in the editable state, and **false** means to exit the editable state.| 3478| NODE_TEXT_INPUT_CANCEL_BUTTON | Defines the style of the cancel button on the right of the single-line text box. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: button style [ArkUI_CancelButtonStyle](#arkui_cancelbuttonstyle). The default value is ARKUI_CANCELBUTTON_STYLE_INPUT.<br>.value[1]?.f32: button icon size, in vp.<br>.value[2]?.u32: button icon color, in 0xARGB format. For example, 0xFFFF0000 indicates red.<br>?.string: button icon image source. The value is the local address of the image, for example, /pages/icon.png.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: button style [ArkUI_CancelButtonStyle](#arkui_cancelbuttonstyle).<br>.value[1].f32: icon size, in vp.<br>.value[2].u32: button icon color, in 0xARGB format.<br>.string: button icon image source.| 3479| NODE_TEXT_INPUT_TEXT_SELECTION | Sets the text selection area, which will be highlighted. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: start position of the text selection. <br>.value[1].i32: end position of the text selection. <br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: start position of the text selection. <br>.value[1].i32: end position of the text selection. | 3480| NODE_TEXT_INPUT_UNDERLINE_COLOR | Sets the color of the underline when it is shown.<br>The default underline color configured for the theme is **'0x33182431'**.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].u32: color of the underline applied to the text being typed in. The value is in 0xARGB format. <br>.value[1].u32: color of the underline applied to the text in the normal state. The value is in 0xARGB format. <br>.value[2].u32: color of the underline applied to the text when an error is detected. The value is in 0xARGB format. <br>.value[3].u32: color of the underline applied to the text when it is disabled. The value is in 0xARGB format. <br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: color of the underline applied to the text being typed in. The value is in 0xARGB format. <br>.value[1].u32: color of the underline applied to the text in the normal state. The value is in 0xARGB format. <br>.value[2].u32: color of the underline applied to the text when an error is detected. The value is in 0xARGB format. <br>.value[3].u32: color of the underline applied to the text when it is disabled. The value is in 0xARGB format. | 3481| NODE_TEXT_INPUT_ENABLE_AUTO_FILL | Sets whether to enable autofill.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to enable autofill. The default value is **true**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to enable autofill.| 3482| NODE_TEXT_INPUT_CONTENT_TYPE | Sets the autofill type.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: autofill type. The parameter type is [ArkUI_TextInputContentType](#arkui_textinputcontenttype).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: autofill type. The parameter type is [ArkUI_TextInputContentType](#arkui_textinputcontenttype).| 3483| NODE_TEXT_INPUT_PASSWORD_RULES | Defines the rules for generating passwords. When autofill is used, these rules are transparently transmitted to Password Vault for generating a new password.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: rules for generating passwords.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: rules for generating passwords.| 3484| NODE_TEXT_INPUT_SELECT_ALL | Sets whether to select all text in the initial state. This attribute is not available for the inline input style.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to select all text in the initial state. The default value is b>false</b>.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to select all text in the initial state.| 3485| NODE_TEXT_INPUT_INPUT_FILTER | Sets the regular expression for input filtering. Only inputs that comply with the regular expression can be displayed. Other inputs are filtered out. The specified regular expression can match single characters, but not strings.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: regular expression.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: regular expression.| 3486| NODE_TEXT_INPUT_STYLE | Sets the text box to the default style or inline input style.<br>For the inline input style, only **InputType.Normal** is supported.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: text input style. The parameter type is [ArkUI_TextInputStyle](#arkui_textinputstyle).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: text input style. The parameter type is [ArkUI_TextInputStyle](#arkui_textinputstyle).| 3487| NODE_TEXT_INPUT_CARET_OFFSET | Sets or obtains the caret position.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>Sets the position of the caret. .value[0].i32: length from the start of the string to the position where the input cursor is located.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>Returns the position information of the caret. If this API is called when the cursor position is updated in the current frame, value[0].i32 (index value of the cursor position) does not take effect.<br>value[1].f32: X coordinate of the cursor relative to the text box.<br>value[2].f32: Y coordinate of the cursor relative to the text box.| 3488| NODE_TEXT_INPUT_CONTENT_RECT | Position of the edited text area relative to the component and its size.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>value[0].f32: horizontal coordinate.<br>value[1].f32: vertical coordinate.<br>value[2].f32: content width.<br>value[3].f32: content height.| 3489| NODE_TEXT_INPUT_CONTENT_LINE_COUNT | Obtains the number of lines of the edited text.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>value[0].i32: number of lines in the edited text.| 3490| NODE_TEXT_INPUT_SELECTION_MENU_HIDDEN | Sets whether to hide the text selection menu when the text box is long-pressed, double-click, or right-clicked. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to hide the text selection menu when the text box is long-pressed, double-click, or right-clicked. The default value is **false**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to hide the text selection menu when the text box is long-pressed, double-click, or right-clicked.| 3491| NODE_TEXT_INPUT_BLUR_ON_SUBMIT | Sets whether the text box loses focus after the Enter key is pressed to submit information.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether the text box loses focus.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether the text box loses focus.| 3492| NODE_TEXT_INPUT_CUSTOM_KEYBOARD | Sets a custom keyboard.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.object: custom keyboard. The parameter type is **ArkUI_NodeHandle**.<br>.value[0]?.i32: whether the custom keyboard supports avoidance. The default value is **false**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.object: custom keyboard. The parameter type is **ArkUI_NodeHandle**.<br>.value[0].i32: whether the custom keyboard supports avoidance.| 3493| NODE_TEXT_INPUT_WORD_BREAK | Defines the line break rule. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: line break rule. The parameter type is [ArkUI_WordBreak](#arkui_wordbreak).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: line break rule. The parameter type is [ArkUI_WordBreak](#arkui_wordbreak).| 3494| NODE_TEXT_INPUT_NUMBER_OF_LINES | Sets the number of lines in **TextInput** component, which can be used to work out the height of the component.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: number of lines.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: number of lines.| 3495| NODE_TEXT_INPUT_SHOW_KEYBOARD_ON_FOCUS | Sets whether to show the keyboard when the text box obtains focus. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to show the keyboard when the text box obtains focus.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to show the keyboard when the text box obtains focus.| 3496| NODE_TEXT_INPUT_LETTER_SPACING | Sets the letter spacing attribute. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: letter spacing. The default unit is fp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: letter spacing. The default unit is fp.| 3497| NODE_TEXT_INPUT_ENABLE_PREVIEW_TEXT | Sets whether to enable preview text for the text box. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to enable preview tex.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to enable preview tex.| 3498| NODE_TEXT_INPUT_KEYBOARD_APPEARANCE | Sets the appearance of the keyboard when the text box is focused.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: appearance of the keyboard, specified by an enumeration value of [ArkUI_KeyboardAppearance](#arkui_keyboardappearance).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: appearance of the keyboard, specified by an enumeration value of [ArkUI_KeyboardAppearance](#arkui_keyboardappearance).<br>**Since**<br>15 | 3499| NODE_TEXT_AREA_PLACEHOLDER | Defines the default placeholder text of the single-line text box. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: default placeholder text.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: default placeholder text.| 3500| NODE_TEXT_AREA_TEXT | Defines the default text content for the multi-line text box. The attribute setting, attribute resetting, and attribute obtaining interfaces are supported.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: default text content.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: default text content.| 3501| NODE_TEXT_AREA_MAX_LENGTH | Defines the maximum number of characters in the text input. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: maximum number of characters in the text input.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: maximum number of characters in the text input.| 3502| NODE_TEXT_AREA_PLACEHOLDER_COLOR | Defines the placeholder text color. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].u32: color value, in 0xARGB format. For example, 0xFFFF0000 indicates red.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: color value, in 0xARGB format.| 3503| NODE_TEXT_AREA_PLACEHOLDER_FONT | Defines the placeholder text font. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0]?.f32: font size, in fp. Optional. The default value is **16.0**.<br>.value[1]?.i32: font style [ArkUI_FontStyle](#arkui_fontstyle). Optional. The default value is **ARKUI_FONT_STYLE_NORMAL**.<br>.value[2]?.i32: font weight [ArkUI_FontWeight](#arkui_fontweight). Optional. The default value is **ARKUI_FONT_WEIGHT_NORMAL**.<br>?.string: font family. Multiple font families are separated by commas (,). For example, "font weight; font family 1, font family 2".<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: font size, in fp.<br>.value[1].i32: font style [ArkUI_FontStyle](#arkui_fontstyle).<br>.value[2].i32: font weight [ArkUI_FontWeight](#arkui_fontweight).<br>.string: font family. Multiple font families are separated by commas (,).| 3504| NODE_TEXT_AREA_CARET_COLOR | Defines the border color attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].u32: background color, in 0xARGB format. For example, 0xFFFF0000 indicates red.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: background color, in 0xARGB format.| 3505| NODE_TEXT_AREA_EDITING | Defines the editable state for the multi-line text box. This attribute can be set as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to remain in the editable state. The value **true** means to remain in the editable state, and **false** means to exit the editable state.<br>The format of the attribute obtaining method parameter [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) is as follows:<br>.value[0].i32: whether to remain in the editable state. The value **true** means to remain in the editable state, and **false** means to exit the editable state.| 3506| NODE_TEXT_AREA_TYPE | Defines the text box type. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: input box type enumeration [ArkUI_TextAreaType](#arkui_textareatype). The default value is ARKUI_TEXTAREA_TYPE_NORMAL.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: input box type enumeration [ArkUI_TextAreaType](#arkui_textareatype).| 3507| NODE_TEXT_AREA_SHOW_COUNTER | Defines the counter settings. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to show a character counter. The value **true** means to show a character counter.<br>.value[1]?.f32: threshold percentage for displaying the character counter. The character counter is displayed when the number of characters that have been entered is greater than the maximum number of characters multiplied by the threshold percentage value. The value range is 1 to 100. If the value is a decimal, it is rounded down.<br>.value[2]?.i32: whether to highlight the border when the number of entered characters reaches the maximum.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to show a character counter.<br>.value[1].f32: threshold percentage for displaying the character counter. The character counter is displayed when the number of characters that have been entered is greater than the maximum number of characters multiplied by the threshold percentage value. The value range is 1 to 100.<br>.value[2].i32: whether to highlight the border when the number of entered characters reaches the maximum. The default value is **true**.| 3508| NODE_TEXT_AREA_SELECTION_MENU_HIDDEN | Sets whether to hide the text selection menu when the text box is long-pressed, double-click, or right-clicked. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to hide the text selection menu when the text box is long-pressed, double-click, or right-clicked. The default value is **false**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to hide the text selection menu when the text box is long-pressed, double-click, or right-clicked.| 3509| NODE_TEXT_AREA_BLUR_ON_SUBMIT | Sets whether the multi-line text box loses focus after the Enter key is pressed to submit information.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether the text box loses focus.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether the text box loses focus.| 3510| NODE_TEXT_AREA_INPUT_FILTER | Sets the regular expression for input filtering. Only inputs that comply with the regular expression can be displayed. Other inputs are filtered out. The specified regular expression can match single characters, but not strings.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: regular expression.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: regular expression.| 3511| NODE_TEXT_AREA_SELECTED_BACKGROUND_COLOR | Sets the background color of the selected text. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].u32: color value, in 0xARGB format. For example, 0xFFFF0000 indicates red.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: color value, in 0xARGB format.| 3512| NODE_TEXT_AREA_ENTER_KEY_TYPE | Defines the type of the Enter key. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: Enter key type enumeration [ArkUI_EnterKeyType](#arkui_enterkeytype). The default value is ARKUI_ENTER_KEY_TYPE_DONE.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: type of the Enter key. The value is an enum of [ArkUI_EnterKeyType](#arkui_enterkeytype).| 3513| NODE_TEXT_AREA_ENABLE_KEYBOARD_ON_FOCUS | Sets whether to enable the input method when the multi-line text box obtains focus in a way other than clicking. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to enable the input method when the multi-line text box obtains focus in a way other than clicking. The value **true** means to enable the input method, and **false** means the opposite. The default value is **false**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to enable the input method when the component obtains focus. The value **1** means to enable the input method when the component obtains focus, and **0** means the opposite.| 3514| NODE_TEXT_AREA_CARET_OFFSET | Sets or obtains the caret position.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>Sets the position of the caret. .value[0].i32: length from the start of the string to the position where the input cursor is located.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>Returns the position information of the caret. If this API is called when the cursor position is updated in the current frame, value[0].i32 (index value of the cursor position) does not take effect.<br>value[1].f32: X coordinate of the cursor relative to the text box.<br>value[2].f32: Y coordinate of the cursor relative to the text box.| 3515| NODE_TEXT_AREA_CONTENT_RECT | Position of the edited text area relative to the component and its size.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>value[0].f32: horizontal coordinate.<br>value[1].f32: vertical coordinate.<br>value[2].f32: content width.<br>value[3].f32: content height.| 3516| NODE_TEXT_AREA_CONTENT_LINE_COUNT | Obtains the number of lines of the edited text.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>value[0].i32: number of lines in the edited text.| 3517| NODE_TEXT_AREA_TEXT_SELECTION | Sets the text selection range and highlights the selected text when the component is focused. This API works only when the value of **selectionStart** is less than that of **selectionEnd**.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: start position of the text selection. <br>.value[1].i32: end position of the text selection. <br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: start position of the text selection. <br>.value[1].i32: end position of the text selection. | 3518| NODE_TEXT_AREA_ENABLE_AUTO_FILL | Sets whether to enable autofill.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to enable autofill. The default value is **true**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to enable autofill.| 3519| NODE_TEXT_AREA_CONTENT_TYPE | Enumerates the content types for autofill.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: autofill type. The parameter type is [ArkUI_TextInputContentType](#arkui_textinputcontenttype).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: autofill type. The parameter type is [ArkUI_TextInputContentType](#arkui_textinputcontenttype).| 3520| NODE_TEXT_AREA_NUMBER_OF_LINES | Sets the number of lines in **TextArea** component, which can be used to work out the height of the component.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: number of lines.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: number of lines.| 3521| NODE_TEXT_AREA_SHOW_KEYBOARD_ON_FOCUS | Sets whether to show the keyboard when the text box obtains focus. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to show the keyboard when the text box obtains focus.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to show the keyboard when the text box obtains focus.| 3522| NODE_TEXT_AREA_LETTER_SPACING | Sets the letter spacing attribute. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: letter spacing. The default unit is fp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: letter spacing. The default unit is fp.| 3523| NODE_TEXT_AREA_ENABLE_PREVIEW_TEXT | Sets whether to enable preview text for the text box. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to enable preview tex.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to enable preview tex.| 3524| NODE_TEXT_AREA_KEYBOARD_APPEARANCE | Sets the appearance of the keyboard when the text box is focused.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: appearance of the keyboard, specified by an enumeration value of [ArkUI_KeyboardAppearance](#arkui_keyboardappearance).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: appearance of the keyboard, specified by an enumeration value of [ArkUI_KeyboardAppearance](#arkui_keyboardappearance).<br>**Since**<br>15 | 3525| NODE_BUTTON_LABEL | Defines the button text content. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: default text content.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: default text content.| 3526| NODE_BUTTON_TYPE | Sets the button type. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: style of the button. The parameter type is [ArkUI_ButtonType](#arkui_buttontype). The default value is **ARKUI_BUTTON_ROUNDED_RECTANGLE**. API version 18 and later versions: **ButtonType.ROUNDED_RECTANGLE**<br> Versions earlier than API version 18: **ButtonType.Capsule**<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: Obtains the style of the button. The parameter type is [ArkUI_ButtonType](#arkui_buttontype). The default value is ARKUI_BUTTON_TYPE_CAPSULE.| 3527| NODE_BUTTON_MIN_FONT_SCALE<sup>18+</sup> | Sets the minimum font scale factor for the button. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>* .value[0].f32: minimum font scale factor. The default unit is fp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: minimum font scale factor. The default unit is fp.| 3528| NODE_BUTTON_MAX_FONT_SCALE<sup>18+</sup> | Sets the maximum font scale factor for the button. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>* .value[0].f32: maximum font scale factor. The default unit is fp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: maximum font scale factor. The default unit is fp.| 3529| NODE_PROGRESS_VALUE | Defines the current value of the progress indicator. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: current value of the progress indicator.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: current value of the progress indicator.| 3530| NODE_PROGRESS_TOTAL | Defines the total value of the progress indicator. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: total value of the progress indicator.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: total value of the progress indicator.| 3531| NODE_PROGRESS_COLOR | Defines the color for the progress value on the progress indicator. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].u32: color value, in 0xARGB format. For example, 0xFFFF0000 indicates red.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: color value, in 0xARGB format.| 3532| NODE_PROGRESS_TYPE | Defines the type of the progress indicator. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: progress bar type. The enumerated value is [ArkUI_ProgressType](#arkui_progresstype). The default value is ARKUI_PROGRESS_TYPE_LINEAR.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: progress bar type enumeration value [ArkUI_ProgressType](#arkui_progresstype).| 3533| NODE_PROGRESS_LINEAR_STYLE | Defines the linear progress indicator style. This attribute can be set, reset, and obtained as required through APIs. Note that the settings are effective only if the progress indicator type is linear.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.object: [ArkUI_ProgressLinearStyleOption](#arkui_progresslinearstyleoption) object that defines the linear progress indicator style.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.object: [ArkUI_ProgressLinearStyleOption](#arkui_progresslinearstyleoption) object that defines the linear progress indicator style.| 3534| NODE_CHECKBOX_SELECT | Defines whether the check box is selected. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether the check box is selected. The value **1** means that the check box is selected, and **0** means the opposite.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether the check box is selected. The value **1** means that the check box is selected, and **0** means the opposite.| 3535| NODE_CHECKBOX_SELECT_COLOR | Defines the color of the check box when it is selected. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: color of the check box when it is selected, in 0xARGB format, for example, **0xFF1122FF**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: color of the check box when it is selected, in 0xARGB format, for example, **0xFF1122FF**.| 3536| NODE_CHECKBOX_UNSELECT_COLOR | Defines the border color of the check box when it is not selected. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: border color, in 0xARGB format, for example, **0xFF1122FF**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: border color, in 0xARGB format, for example, **0xFF1122FF**.| 3537| NODE_CHECKBOX_MARK | Defines the internal icon style of the check box. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: border color, in 0xARGB format, for example, **0xFF1122FF**.<br>.value[1]?.f32: size of the internal mark, in vp. Optional.<br>.value[2]?.f32: stroke width of the internal mark, in vp. Optional. The default value is **2**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: border color, in 0xARGB format, for example, **0xFF1122FF**.<br>.value[1].f32: size of the internal mark, in vp. <br>.value[2].f32: stroke width of the internal mark, in vp. The default value is **2**.| 3538| NODE_CHECKBOX_SHAPE | Defines the shape of the check box. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: component shape. The parameter type is [ArkUI_CheckboxShape](#arkui_checkboxshape).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: component shape. The parameter type is [ArkUI_CheckboxShape](#arkui_checkboxshape).| 3539| NODE_CHECKBOX_NAME | Sets the name of the check box. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: name of the check box.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: name of the check box.| 3540| NODE_CHECKBOX_GROUP | Sets the name of the check box group to which the check box belongs. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: name of the check box group.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: name of the check box group.| 3541| NODE_XCOMPONENT_ID | Defines the ID of the **XComponent** component. This attribute can be set and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: component ID.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: component ID.| 3542| NODE_XCOMPONENT_TYPE | Defines the type of the **XComponent** component. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: type. The parameter type is [ArkUI_XComponentType](#arkui_xcomponenttype). The default value is **ARKUI_XCOMPONENT_TYPE_SURFACE**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: type. The parameter type is [ArkUI_XComponentType](#arkui_xcomponenttype).| 3543| NODE_XCOMPONENT_SURFACE_SIZE | Defines the width and height of the **XComponent** component. This attribute can be set and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].u32: width, in px. <br>.value[1].u32: height, in px. <br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: width, in px. <br>.value[1].u32: height, in px. | 3544| NODE_XCOMPONENT_SURFACE_RECT | Sets the rectangle for the surface held by the **XComponent**. This API works only when type of the **XComponent** is set to **SURFACE("surface")** or **TEXTURE**.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: X coordinate of the surface display area relative to the upper left corner of the **XComponent** component, in px.<br>.value[1].i32: Y coordinate of the surface display area relative to the upper left corner of the **XComponent** component, in px.<br>.value[2].i32: width of the surface display area, in px.<br>.value[3].i32: height of the surface display area, in px.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: X coordinate of the surface display area relative to the upper left corner of the **XComponent** component, in px.<br>.value[1].i32: Y coordinate of the surface display area relative to the upper left corner of the **XComponent** component, in px.<br>.value[2].i32: width of the surface display area, in px.<br>.value[3].i32: height of the surface display area, in px.| 3545| NODE_XCOMPONENT_ENABLE_ANALYZER | Sets whether to enable the AI analyzer, which supports subject recognition, text recognition, and object lookup. For the settings to take effect, this API must be used together with **StartImageAnalyzer** and StopImageAnalyzer of **XComponentController**. This feature cannot be used together with the **overlay** attribute. If both are set, the **CustomBuilder** property in **overlay** has no effect. This feature also depends on device capabilities.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to enable the AI image analyzer.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to enable the AI image analyzer. 3546| NODE_DATE_PICKER_LUNAR | Defines whether to display the lunar calendar in the date picker. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to display the lunar calendar in the date picker. The default value is **false**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to display the lunar calendar in the date picker.| 3547| NODE_DATE_PICKER_START | Defines the start date of the date picker. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: date. The default value is **"1970-1-1"**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: date.| 3548| NODE_DATE_PICKER_END | Defines the end date of the date picker. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: date. The default value is **"2100-12-31"**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: date.| 3549| NODE_DATE_PICKER_SELECTED | Defines the selected date of the date picker. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: date. The default value is **"2024-01-22"**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: date.| 3550| NODE_DATE_PICKER_DISAPPEAR_TEXT_STYLE | Defines the font color, font size, and font weight for the top and bottom items in the date picker. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: array of five parameters of the string type, separated by semicolons (;).<br>Parameter 1: font color, in ::argb format.<br>Parameter 2: font size, in fp. The value is a number.<br>Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").<br>Parameter 4: fonts, separated by commas (,).<br>Parameter 5: font style. Available options are ("normal", "italic").<br>Example: **"\#ff182431;14;normal;Arial,HarmonyOS Sans;normal"**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: array of five parameters of the string type, separated by semicolons (;).<br>Parameter 1: font color, in ::argb format.<br>Parameter 2: font size, in fp. The value is a number.<br>Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").<br>Parameter 4: fonts, separated by commas (,).<br>Parameter 5: font style. Available options are ("normal", "italic").<br>Example: **"\#ff182431;14;normal;Arial,HarmonyOS Sans;normal"**.| 3551| NODE_DATE_PICKER_TEXT_STYLE | Defines the font color, font size, and font weight of all items except the top, bottom, and selected items in the date picker. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: array of five parameters of the string type, separated by semicolons (;).<br>Parameter 1: font color, in ::argb format.<br>Parameter 2: font size, in fp. The value is a number.<br>Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").<br>Parameter 4: fonts, separated by commas (,).<br>Parameter 5: font style. Available options are ("normal", "italic").<br>Example: **"\#ff182431;14;normal;Arial,HarmonyOS Sans;normal"**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: array of five parameters of the string type, separated by semicolons (;).<br>Parameter 1: font color, in ::argb format.<br>Parameter 2: font size, in fp. The value is a number.<br>Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").<br>Parameter 4: fonts, separated by commas (,).<br>Parameter 5: font style. Available options are ("normal", "italic").<br>Example: **"\#ff182431;14;normal;Arial,HarmonyOS Sans;normal"**.| 3552| NODE_DATE_PICKER_SELECTED_TEXT_STYLE | Defines the font color, font size, and font weight of the selected item in the date picker. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: array of five parameters of the string type, separated by semicolons (;).<br>Parameter 1: font color, in ::argb format.<br>Parameter 2: font size, in fp. The value is a number.<br>Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").<br>Parameter 4: fonts, separated by commas (,).<br>Parameter 5: font style. Available options are ("normal", "italic").<br>Example: **"\#ff182431;14;normal;Arial,HarmonyOS Sans;normal"**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: array of five parameters of the string type, separated by semicolons (;).<br>Parameter 1: font color, in ::argb format.<br>Parameter 2: font size, in fp. The value is a number.<br>Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").<br>Parameter 4: fonts, separated by commas (,).<br>Parameter 5: font style. Available options are ("normal", "italic").<br>Example: **"\#ff182431;14;normal;Arial,HarmonyOS Sans;normal"**.| 3553| NODE_DATE_PICKER_MODE | Sets the date columns to be displayed. This attribute can be set, reset, and obtained as required through APIs. **DatePicker** displays different styles of date columns.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: type of date column to be displayed. The parameter type is [ArkUI_DatePickerMode](#arkui_datepickermode).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: type of date column to be displayed. The parameter type is [ArkUI_DatePickerMode](#arkui_datepickermode).| 3554| NODE_DATE_PICKER_ENABLE_HAPTIC_FEEDBACK | Specifies whether to enable haptic feedback. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to enable haptic feedback. The default value is **true**. The value **true** means to enable haptic feedback, and **false** means the opposite.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to enable haptic feedback. 3555| NODE_TIME_PICKER_SELECTED | Defines the time of the selected item. in the timer picker. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: time. The default value is the current system time.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: time.| 3556| NODE_TIME_PICKER_USE_MILITARY_TIME | Defines whether the display time is in 24-hour format. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether the display time is in 24-hour format. The default value is **false**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether the display time is in 24-hour format.| 3557| NODE_TIME_PICKER_DISAPPEAR_TEXT_STYLE | Defines the font color, font size, and font weight for the top and bottom items in the time picker. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: array of five parameters of the string type, separated by semicolons (;).<br>Parameter 1: font color, in ::argb format.<br>Parameter 2: font size, in fp. The value is a number.<br>Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").<br>Parameter 4: fonts, separated by commas (,).<br>Parameter 5: font style. Available options are ("normal", "italic").<br>Example: **"\#ff182431;14;normal;Arial,HarmonyOS Sans;normal"**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: array of five parameters of the string type, separated by semicolons (;).<br>Parameter 1: font color, in ::argb format.<br>Parameter 2: font size, in fp. The value is a number.<br>Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").<br>Parameter 4: fonts, separated by commas (,).<br>Parameter 5: font style. Available options are ("normal", "italic").<br>Example: **"\#ff182431;14;normal;Arial,HarmonyOS Sans;normal"**.| 3558| NODE_TIME_PICKER_TEXT_STYLE | Defines the font color, font size, and font weight of all items except the top, bottom, and selected items in the time picker. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: array of five parameters of the string type, separated by semicolons (;).<br>Parameter 1: font color, in ::argb format.<br>Parameter 2: font size, in fp. The value is a number.<br>Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").<br>Parameter 4: fonts, separated by commas (,).<br>Parameter 5: font style. Available options are ("normal", "italic").<br>Example: **"\#ff182431;14;normal;Arial,HarmonyOS Sans;normal"**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: array of five parameters of the string type, separated by semicolons (;).<br>Parameter 1: font color, in ::argb format.<br>Parameter 2: font size, in fp. The value is a number.<br>Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").<br>Parameter 4: fonts, separated by commas (,).<br>Parameter 5: font style. Available options are ("normal", "italic").<br>Example: **"\#ff182431;14;normal;Arial,HarmonyOS Sans;normal"**.| 3559| NODE_TIME_PICKER_SELECTED_TEXT_STYLE | Defines the font color, font size, and font weight of the selected item in the time picker. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: array of five parameters of the string type, separated by semicolons (;).<br>Parameter 1: font color, in ::argb format.<br>Parameter 2: font size, in fp. The value is a number.<br>Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").<br>Parameter 4: fonts, separated by commas (,).<br>Parameter 5: font style. Available options are ("normal", "italic").<br>Example: **"\#ff182431;14;normal;Arial,HarmonyOS Sans;normal"**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: array of five parameters of the string type, separated by semicolons (;).<br>Parameter 1: font color, in ::argb format.<br>Parameter 2: font size, in fp. The value is a number.<br>Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").<br>Parameter 4: fonts, separated by commas (,).<br>Parameter 5: font style. Available options are ("normal", "italic").<br>Example: **"\#ff182431;14;normal;Arial,HarmonyOS Sans;normal"**.| 3560| NODE_TIME_PICKER_START | Sets the start time for the timer picker. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: time. The default value is **"1970-01-01 00:00:00"**. Only the hour and minute parts of the time are effective.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: time. The default value is **"1970-01-01 00:00:00"**.| 3561| NODE_TIME_PICKER_END | Sets the end time for the timer picker. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: time. The default value is **"1970-01-01 23:59:59"**. Only the hour and minute parts of the time are effective.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: time. The default value is **"1970-01-01 23:59:59"**.| 3562| NODE_TIME_PICKER_ENABLE_CASCADE | Sets whether the AM/PM indicator automatically switches based on the hour in 12-hour format.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether the AM/PM indicator automatically switches based on the hour in 12-hour format. The default value is **false**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether the AM/PM indicator automatically switches based on the hour in 12-hour format.| 3563| NODE_TEXT_PICKER_OPTION_RANGE | Defines the data selection range of the text picker. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: type of the used selector [ArkUI_TextPickerRangeType](#arkui_textpickerrangetype). The default value is ARKUI_TEXTPICKER_RANGETYPE_SINGLE.<br>?.string: string input, whose format varies by picker type.<br>1: single-column picker. The input format is a group of strings separated by semicolons (;).<br>2: multi-column picker. Multiple pairs of plain text strings are supported. The pairs are separated by semicolons (;), and strings within each pair are separated by commas (,).<br>?.object: Object input, whose format varies by picker type.<br>1: A single column supports the image selector. The input structure is [ARKUI_TextPickerRangeContent](_a_r_k_u_i___text_picker_range_content.md).<br>2: multi-column linkage selector. The input structure is [ARKUI_TextPickerCascadeRangeContent](_a_r_k_u_i___text_picker_cascade_range_content.md).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: type of the text picker [ArkUI_TextPickerRangeType](#arkui_textpickerrangetype).<br>?.string: string output, whose format varies by picker type.<br>1: single-column picker. The output format is a group of strings separated by semicolons (;).<br>2: multi-column picker. Multiple pairs of plain text strings are supported. The pairs are separated by semicolons (;), and strings within each pair are separated by commas (,).<br>?.string: Object output, whose format varies by picker type.<br>1: A single column supports the image selector. The output structure is [ARKUI_TextPickerRangeContent](_a_r_k_u_i___text_picker_range_content.md).<br>2: multi-column linkage selector. The output structure is [ARKUI_TextPickerCascadeRangeContent](_a_r_k_u_i___text_picker_cascade_range_content.md).| 3564| NODE_TEXT_PICKER_OPTION_SELECTED | Defines the index of the default selected item in the data selection range of the text picker. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].u32: index. If there are multiple index values, add them one by one.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: index. If there are multiple index values, add them one by one.| 3565| NODE_TEXT_PICKER_OPTION_VALUE | Defines the value of the default selected item in the text picker. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: value of the selected item. If there are multiple values, add them one by one and separate them with semicolons (;).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: value of the selected item. If there are multiple values, add them one by one and separate them with semicolons (;).| 3566| NODE_TEXT_PICKER_DISAPPEAR_TEXT_STYLE | Defines the font color, font size, and font weight for the top and bottom items in the text picker. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: array of five parameters of the string type, separated by semicolons (;).<br>Parameter 1: font color, in ::argb format.<br>Parameter 2: font size, in fp. The value is a number.<br>Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").<br>Parameter 4: fonts, separated by commas (,).<br>Parameter 5: font style. Available options are ("normal", "italic").<br>Example: **"\#ff182431;14;normal;Arial,HarmonyOS Sans;normal"**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: array of five parameters of the string type, separated by semicolons (;).<br>Parameter 1: font color, in ::argb format.<br>Parameter 2: font size, in fp. The value is a number.<br>Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").<br>Parameter 4: fonts, separated by commas (,).<br>Parameter 5: font style. Available options are ("normal", "italic").<br>Example: **"\#ff182431;14;normal;Arial,HarmonyOS Sans;normal"**.| 3567| NODE_TEXT_PICKER_TEXT_STYLE | Defines the font color, font size, and font weight for all items except the top, bottom, and selected items in the text picker. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: array of five parameters of the string type, separated by semicolons (;).<br>Parameter 1: font color, in ::argb format.<br>Parameter 2: font size, in fp. The value is a number.<br>Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").<br>Parameter 4: fonts, separated by commas (,).<br>Parameter 5: font style. Available options are ("normal", "italic").<br>Example: **"\#ff182431;14;normal;Arial,HarmonyOS Sans;normal"**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: array of five parameters of the string type, separated by semicolons (;).<br>Parameter 1: font color, in ::argb format.<br>Parameter 2: font size, in fp. The value is a number.<br>Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").<br>Parameter 4: fonts, separated by commas (,).<br>Parameter 5: font style. Available options are ("normal", "italic").<br>Example: **"\#ff182431;14;normal;Arial,HarmonyOS Sans;normal"**.| 3568| NODE_TEXT_PICKER_SELECTED_TEXT_STYLE | Defines the font color, font size, and font weight of the selected item in the text picker. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: array of five parameters of the string type, separated by semicolons (;).<br>Input parameter 1: text color. The value is of the argb type.<br>Input parameter 2: text size, in fp. The value is a number.<br>Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").<br>Parameter 4: fonts, separated by commas (,).<br>Parameter 5: font style. Available options are ("normal", "italic").<br>Example: **"\#ff182431;14;normal;Arial,HarmonyOS Sans;normal"**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: array of five parameters of the string type, separated by semicolons (;).<br>Parameter 1: text color. The value is of the argb type.<br>Parameter 2: text size. The value is a number, and the unit is fp.<br>Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").<br>Parameter 4: text font list, which is separated by commas (,).<br>Parameter 5: text style, string enumeration ("normal", "italic")<br>Example: **"\#ff182431;14;normal;Arial,HarmonyOS Sans;normal"**.| 3569| NODE_TEXT_PICKER_SELECTED_INDEX | Defines the index of the default selected item in the data selection range of the text picker. This attribute can be set, reset, and obtained as required through APIs.<br>[ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter type. The options are as follows:<br>.value[0...].i32: index of the default item in the data selection range.| 3570| NODE_TEXT_PICKER_CAN_LOOP | Defines whether to support scroll looping for the text picker. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to support scroll looping. The value **true** means to support scroll looping, and **false** means the opposite.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>value[0].i32: The value **1** means to support scroll looping, and **0** means the opposite.| 3571| NODE_TEXT_PICKER_DEFAULT_PICKER_ITEM_HEIGHT | Defines the height of each item in the picker. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>value[0].f32: item height, in vp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>value[0].f32: item height, in vp.| 3572| NODE_TEXT_PICKER_ENABLE_HAPTIC_FEEDBACK | Specifies whether to enable haptic feedback. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to enable haptic feedback. The value **true** means to enable haptic feedback, and **false** means the opposite. The default value is **true**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to enable haptic feedback.| 3573| NODE_CALENDAR_PICKER_HINT_RADIUS | Defines the style of the background in the selected state of the calendar picker. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: radius of the rounded corner of the bottom plate when the calendar is selected. The value range is [0, +∞). The value 0 indicates that the bottom plate style is a right-angle rectangle. The value range is (0, 16), indicating that the bottom plate style is a rounded rectangle. If the value range is [16, +∞), the bottom plate style is round.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: radius of the rounded corner of the bottom plate when the calendar is selected. The value range is [0, +∞). The value 0 indicates that the bottom plate style is a right-angle rectangle. The value range is (0, 16), indicating that the bottom plate style is a rounded rectangle. If the value range is [16, +∞), the bottom plate style is round.| 3574| NODE_CALENDAR_PICKER_SELECTED_DATE | Defines the date of the selected item in the calendar picker. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].u32: year of the selected date.<br>.value[1].u32: month of the selected date.<br>.value[2].u32: day of the selected date.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: year of the selected date.<br>.value[1].u32: month of the selected date.<br>.value[2].u32: day of the selected date.| 3575| NODE_CALENDAR_PICKER_EDGE_ALIGNMENT | Defines how the calendar picker is aligned with the entry component. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: alignment mode type. The parameter type is [ArkUI_CalendarAlignment](#arkui_calendaralignment).<br>.value[1].f32: offset of the picker relative to the entry component along the x-axis after alignment based on the specified alignment mode.<br>.value[2].f32: offset of the picker relative to the entry component along the y-axis after alignment based on the specified alignment mode.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: alignment mode type. The parameter type is [ArkUI_CalendarAlignment](#arkui_calendaralignment).<br>.value[1].f32: offset of the picker relative to the entry component along the x-axis after alignment based on the specified alignment mode.<br>.value[2].f32: offset of the picker relative to the entry component along the y-axis after alignment based on the specified alignment mode.| 3576| NODE_CALENDAR_PICKER_TEXT_STYLE | Defines the font color, font size, and font weight in the entry area of the calendar picker.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0]?.u32: font color of the entry area.<br>.value[1]?.f32: font size of the entry area, in fp.<br>.value[2]?.i32: font weight of the text in the entry area. The parameter type is [ArkUI_FontWeight](#arkui_fontweight).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: font color of the entry area.<br>.value[1].f32: font size of the entry area, in fp.<br>.value[2].i32: font weight of the text in the entry area. The parameter type is [ArkUI_FontWeight](#arkui_fontweight).| 3577| NODE_CALENDAR_PICKER_START<sup>18+</sup> | Sets the start date for the calendar picker.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].u32: year.<br>.value[1].u32: month.<br>.value[2].u32: day.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: year.<br>.value[1].u32: month.<br>.value[2].u32: day. 3578| NODE_CALENDAR_PICKER_END<sup>18+</sup> | Sets the end date for the calendar picker.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].u32: year.<br>.value[1].u32: month.<br>.value[2].u32: day.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: year.<br>.value[1].u32: month.<br>.value[2].u32: day. 3579| NODE_CALENDAR_PICKER_DISABLED_DATE_RANGE<sup>16+</sup> | Sets the disabled date ranges for the calendar picker. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.string: string representing the disabled date ranges. The format is "start_date,end_date" for each range, with multiple ranges separated by commas (,).<br>Example: "1910-01-01,1910-12-31,2020-01-01,2020-12-31".<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: string representing the disabled date ranges.| 3580| NODE_CALENDAR_PICKER_MARK_TODAY<sup>16+</sup> | Sets whether to highlight the current system date. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: true indicates that the calendar selector is highlighted when the current date is displayed. and **false** means the opposite. The default value is **false**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to highlight the current system date in the calendar picker. The value **1** means to highlight the current system date, and **0** means the opposite.| 3581| NODE_SLIDER_BLOCK_COLOR | Defines the color of the slider. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: color of the slider, in 0xARGB format, for example, **0xFF1122FF**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: color of the slider, in 0xARGB format, for example, **0xFF1122FF**.| 3582| NODE_SLIDER_TRACK_COLOR | Defines the background color of the slider. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: background color, in 0xARGB format, for example, **0xFF1122FF**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: background color, in 0xARGB format, for example, **0xFF1122FF**.| 3583| NODE_SLIDER_SELECTED_COLOR | Defines the color of the selected part of the slider track. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: color of the selected part of the slider track, in 0xARGB format, for example, **0xFF1122FF**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: color of the selected part of the slider track, in 0xARGB format, for example, **0xFF1122FF**.| 3584| NODE_SLIDER_SHOW_STEPS | Sets whether to display the step scale value. Attributes can be set, reset, and obtained.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to display the stepping value. The value **1** means to display the stepping value, and **0** (default value) means the opposite.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to display the stepping value. The value **1** means to display the stepping value, and **0** (default value) means the opposite.| 3585| NODE_SLIDER_BLOCK_STYLE | Defines the slider shape, which can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: shape. The parameter type is [ArkUI_SliderBlockStyle](#arkui_sliderblockstyle).<br>.string? depending on the shape. Optional.<br>ARKUI_SLIDER_BLOCK_STYLE_IMAGE: image resource of the slider. Example: /pages/common/icon.png.<br>ARKUI_SLIDER_BLOCK_STYLE_SHAPE: custom shape of the slider.<br>There are five types:<br>1. Rectangle:<br>.value[1].i32: cropping type. The parameter type is [ArkUI_ShapeType](#arkui_shapetype), ARKUI_SHAPE_TYPE_RECTANGLE.<br>.value[2].f32: height of the rectangle.<br>.value[3].f32: height of the rectangle.<br>.value[4].f32: height of the rounded corner of the rectangle.<br>.value[5].f32: height of the rounded corner of the rectangle.<br>2. Circle:<br>.value[1].i32: cropping type. The parameter type is [ArkUI_ShapeType](#arkui_shapetype), ARKUI_SHAPE_TYPE_CIRCLE.<br>.value[2].f32: height of the circle.<br>.value[3].f32: height of the circle.<br>3. Ellipse:<br>.value[1].i32: cropping type. The parameter type is [ArkUI_ShapeType](#arkui_shapetype), ARKUI_SHAPE_TYPE_ELLIPSE.<br>.value[2].f32: height of the ellipse.<br>.value[3].f32: height of the ellipse.<br>4. Path:<br>.value[1].i32: cropping type. The parameter type is [ArkUI_ShapeType](#arkui_shapetype), ARKUI_SHAPE_TYPE_PATH.<br>.value[2].f32: width of the path.<br>.value[3].f32: height of the path.<br>.string: command for drawing the path.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: shape. The parameter type is [ArkUI_SliderBlockStyle](#arkui_sliderblockstyle).<br>.string? depending on the shape. Optional.<br>ARKUI_SLIDER_BLOCK_STYLE_IMAGE: image resource of the slider. Example: /pages/common/icon.png.<br>ARKUI_SLIDER_BLOCK_STYLE_SHAPE: custom shape of the slider.<br>There are five types:<br>1. Rectangle:<br>.value[1].i32: cropping type. The parameter type is [ArkUI_ShapeType](#arkui_shapetype), ARKUI_SHAPE_TYPE_RECTANGLE.<br>.value[2].f32: height of the rectangle.<br>.value[3].f32: height of the rectangle.<br>.value[4].f32: height of the rounded corner of the rectangle.<br>.value[5].f32: height of the rounded corner of the rectangle.<br>2. Circle:<br>.value[1].i32: cropping type. The parameter type is [ArkUI_ShapeType](#arkui_shapetype), ARKUI_SHAPE_TYPE_CIRCLE.<br>.value[2].f32: height of the circle.<br>.value[3].f32: height of the circle.<br>3. Ellipse:<br>.value[1].i32: cropping type. The parameter type is [ArkUI_ShapeType](#arkui_shapetype), ARKUI_SHAPE_TYPE_ELLIPSE.<br>.value[2].f32: height of the ellipse.<br>.value[3].f32: height of the ellipse.<br>4. Path:<br>.value[1].i32: cropping type. The parameter type is [ArkUI_ShapeType](#arkui_shapetype), ARKUI_SHAPE_TYPE_PATH.<br>.value[2].f32: width of the path.<br>.value[3].f32: height of the path.<br>.string: command for drawing the path.| 3586| NODE_SLIDER_VALUE | Defines the current value of the slider. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: current value.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: current value.| 3587| NODE_SLIDER_MIN_VALUE | Defines the minimum value of the slider. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: minimum value.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: minimum value.| 3588| NODE_SLIDER_MAX_VALUE | Defines the maximum value of the slider. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: maximum value.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: maximum value.| 3589| NODE_SLIDER_STEP | Defines the step of the slider. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: step. The value range is [0.01, 100].<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: step. The value range is [0.01, 100].| 3590| NODE_SLIDER_DIRECTION | Defines whether the slider moves horizontally or vertically. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: display style. The parameter type is [ArkUI_SliderDirection](#arkui_sliderdirection).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: display style. The parameter type is [ArkUI_SliderDirection](#arkui_sliderdirection).| 3591| NODE_SLIDER_REVERSE | Defines whether the slider values are reversed. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether the slider values are reversed. The value **1** means that the slider values are reversed, and **0** means the opposite.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether the slider values are reversed. The value **1** means that the slider values are reversed, and **0** means the opposite.| 3592| NODE_SLIDER_STYLE | Defines the style of the slider thumb and track. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: display style. The parameter type is [ArkUI_SliderStyle](#arkui_sliderstyle).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: display style. The parameter type is [ArkUI_SliderStyle](#arkui_sliderstyle).| 3593| NODE_SLIDER_TRACK_THICKNESS | Sets the track thickness of the slider. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: track thickness of the slider, in vp. The default value is 4.0 vp when **NODE_SLIDER_STYLE** is set to **ARKUI_SLIDER_STYLE_OUT_SET** and 20.0 vp when **NODE_SLIDER_STYLE** is set to **ARKUI_SLIDER_STYLE_IN_SET**. <br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: track thickness of the slider, in vp. | 3594| NODE_SLIDER_ENABLE_HAPTIC_FEEDBACK | Specifies whether to enable haptic feedback. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to enable haptic feedback. The value **true** means to enable haptic feedback, and **false** means the opposite. The default value is **true**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to enable haptic feedback.| 3595| NODE_RADIO_CHECKED | Sets whether the radio button is selected. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether the radio button is selected. The default value is **false**. Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether the radio button is selected.| 3596| NODE_RADIO_STYLE | Sets the style of the radio button in selected or deselected state. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0]?.u32: color of the background when the radio button is selected, in 0xARGB format. The default value is **0xFF007DFF**.<br>.value[1]?.u32: color of the border when the radio button is deselected, in 0xARGB format. The default value is **0xFF182431**.<br>.value[2]?.u32: color of the indicator when the radio button is selected, in 0xARGB format. The default value is **0xFFFFFFFF**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: color of the background when the radio button is selected, in 0xARGB format. The default value is **0xFF007DFF**.<br>.value[1].u32: color of the border when the radio button is deselected, in 0xARGB format. The default value is **0xFF182431**.<br>.value[2].u32: color of the indicator when the radio button is selected, in 0xARGB format. The default value is **0xFFFFFFF**.| 3597| NODE_RADIO_VALUE | Sets the current value of the radio button. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: value of the option button.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: value of the option button.| 3598| NODE_RADIO_GROUP | Sets the name of the group to which the radio button belongs. Only one radio button in a given group can be selected at a time. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: name of the group to which the radio button belongs. <br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: name of the group to which the radio button belongs. | 3599| NODE_CHECKBOX_GROUP_NAME | Sets the name of the check box group. This attribute can be set, reset, and obtained as required through APIs. If there are multiple check box groups with the same group name, only the first check box group takes effect.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: name of the check box group.<br> Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: name of the check box group.| 3600| NODE_CHECKBOX_GROUP_SELECT_ALL | Sets whether to select all check boxes in the check box group. This attribute can be set, reset, and obtained as required through APIs. If the **select** attribute is set for a check box in the group, the setting of the check box has a higher priority.<br>Default value: **false**<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether all check boxes are selected in the check box group. The value **1** means all check boxes are selected in the check box group, and **0** means the opposite.<br> Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether all check boxes are selected in the check box group. The value **1** means all check boxes are selected in the check box group, and **0** means the opposite.| 3601| NODE_CHECKBOX_GROUP_SELECTED_COLOR | Sets the color for the selected state of the check box group. This attribute can be set, reset, and obtained as required through APIs.<br>Default value: **false**<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: color of the selected state in 0xARGB format, for example, **0xFF1122FF**.<br> Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: color of the selected state in 0xARGB format, for example, **0xFF1122FF**.| 3602| NODE_CHECKBOX_GROUP_UNSELECTED_COLOR | Sets the color for the unselected state of the check box group. This attribute can be set, reset, and obtained as required through APIs.<br>Default value: **false**<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: border color, in 0xARGB format, for example, **0xFF1122FF**.<br> Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: border color, in 0xARGB format, for example, **0xFF1122FF**.| 3603| NODE_CHECKBOX_GROUP_MARK | Sets the check mark style of the check box group. This attribute can be set, reset, and obtained as required through APIs.<br>Default value: **false**<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: border color, in 0xARGB format, for example, **0xFF1122FF**.<br>.value[1]?.f32: size of the check mark, in vp. Optional.<br>.value[2]?.f32: stroke width of the internal mark, in vp. Optional. The default value is **2**.<br> Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: border color, in 0xARGB format, for example, **0xFF1122FF**.<br>.value[1]?.f32: size of the check mark, in vp. Optional.<br>.value[2]?.f32: stroke width of the internal mark, in vp. Optional. The default value is **2**.| 3604| NODE_CHECKBOX_GROUP_SHAPE | Sets the shape of the check box group. This attribute can be set, reset, and obtained as required through APIs.<br>Default value: **false**<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: component shape. The parameter type is [ArkUI_CheckboxShape](#arkui_checkboxshape).<br> Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: component shape. The parameter type is [ArkUI_CheckboxShape](#arkui_checkboxshape).| 3605| NODE_STACK_ALIGN_CONTENT | Defines the alignment mode of the child components in the container. This attribute can be set, reset, and obtained as required through APIs.<br>If this attribute and the universal attribute **NODE_ALIGNMENT** are both set, whichever is set later takes effect.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: alignment mode. The parameter type is [ArkUI_Alignment](#arkui_alignment). The default value is **ARKUI_ALIGNMENT_CENTER**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: alignment mode. The parameter type is [ArkUI_Alignment](#arkui_alignment).| 3606| NODE_SCROLL_BAR_DISPLAY_MODE | Defines the scrollbar status. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: scroll bar status. The data type is [ArkUI_ScrollBarDisplayMode](#arkui_scrollbardisplaymode), and the default value is ARKUI_SCROLL_BAR_DISPLAY_MODE_AUTO.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: scroll bar status. The data type is [ArkUI_ScrollBarDisplayMode](#arkui_scrollbardisplaymode).| 3607| NODE_SCROLL_BAR_WIDTH | Defines the width of the scrollbar. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: width of the scrollbar, in vp. The default value is **4**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: width of the scrollbar, in vp.| 3608| NODE_SCROLL_BAR_COLOR | Defines the color of the scrollbar. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.data[0].u32: color of the scrollbar, in 0xARGB format.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.data[0].u32: color of the scrollbar, in 0xARGB format.| 3609| NODE_SCROLL_SCROLL_DIRECTION | Defines the scroll direction. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: scrolling direction. The data type is [ArkUI_ScrollDirection](#arkui_scrolldirection), and the default value is ARKUI_SCROLL_DIRECTION_VERTICAL.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: scrolling direction. The data type is [ArkUI_ScrollDirection](#arkui_scrolldirection).| 3610| NODE_SCROLL_EDGE_EFFECT | Defines the effect used at the edges of the component when the boundary of the scrollable content is reached. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: edge sliding effect. The parameter type is [ArkUI_EdgeEffect](#arkui_edgeeffect). The default value is ARKUI_EDGE_EFFECT_NONE.<br>.value[1]?.i32: whether to enable the scroll effect when the component content size is smaller than the component itself. Optional. The value **1** means to enable the scroll effect, and **0** means the opposite. The default value is **1**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: edge sliding effect. The parameter type is [ArkUI_EdgeEffect](#arkui_edgeeffect).<br>.value[1].i32: whether to enable the scroll effect when the component content size is smaller than the component itself. The value **1** means to enable the scroll effect, and **0** means the opposite.<br>Sets the effect used at the edges of the component when the boundary of the scrollable content is reached. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: edge sliding effect. The parameter type is [ArkUI_EdgeEffect](#arkui_edgeeffect). The default value is ARKUI_EDGE_EFFECT_NONE.<br>.value[1]?.i32: whether to enable the scroll effect when the component content size is smaller than the component itself. Optional. The value **1** means to enable the scroll effect, and **0** means the opposite. The default value is **1**.<br>.value[2]?.i32: direction in which the effect takes effect. The parameter type is [ArkUI_EffectEdge](#arkui_effectedge). The default value is ARKUI_EFFECT_EDGE_START \| ARKUI_EFFECT_EDGE_END.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: edge sliding effect. The parameter type is [ArkUI_EdgeEffect](#arkui_edgeeffect).<br>.value[1].i32: whether to enable the scroll effect when the component content size is smaller than the component itself. The value **1** means to enable the scroll effect, and **0** means the opposite.<br>.value[2].i32: direction in which the effect takes effect. The parameter type is [ArkUI_EffectEdge](#arkui_effectedge).<br>**Since**<br>17 | 3611| NODE_SCROLL_ENABLE_SCROLL_INTERACTION | Sets whether to support scroll gestures. When this attribute is set to **false**, scrolling by finger or mouse is not supported, but the scroll controller API is not affected.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to support scroll gestures. The default value is **true**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to support scroll gestures.| 3612| NODE_SCROLL_FRICTION | Sets the friction coefficient. It applies only to gestures in the scrolling area, and it affects only indirectly the scroll chaining during the inertial scrolling process.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: friction coefficient. The default value is **0.6** for non-wearable devices and **0.9** for wearable devices.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: friction coefficient.| 3613| NODE_SCROLL_SNAP | Defines the scroll snapping mode. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: limit scrolling mode of the scroll component. The data type is [ArkUI_ScrollSnapAlign](#arkui_scrollsnapalign), and the default value is ARKUI_SCROLL_SNAP_ALIGN_NONE.<br>.value[1].i32: whether to enable the snap to start feature. When scroll snapping is defined for the **Scroll** component, setting this attribute to **false** enables the component to scroll between the start edge and the first snap point. The default value is **true**. It is valid only when there are multiple snap points.<br>.value[2].i32: Whether to enable the snap to end feature. When scroll snapping is defined for the **Scroll** component, setting this attribute to **false** enables the component to scroll between the end edge and the last snap point. The default value is **true**. It is valid only when there are multiple snap points.<br>.value[3...].f32: snap points for the **Scroll** component. Each snap point defines the offset from an edge to which the **Scroll** component can scroll. The value can be one or more.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: alignment mode for the scroll snap position. The parameter type is [ArkUI_ScrollSnapAlign](#arkui_scrollsnapalign).<br>.value[1].i32: whether to enable the snap to start feature. When scroll snapping is defined for the **Scroll** component, setting this attribute to **false** enables the component to scroll between the start edge and the first snap point.<br>.value[2].i32: Whether to enable the snap to end feature. When scroll snapping is defined for the **Scroll** component, setting this attribute to **false** enables the component to scroll between the end edge and the last snap point.<br>.value[3...].f32: snap points for the **Scroll** component. Each snap point defines the offset from an edge to which the **Scroll** component can scroll.| 3614| NODE_SCROLL_NESTED_SCROLL | Defines the nested scrolling options. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: nested scrolling when the scrollable component scrolls to the end. The parameter type is [ArkUI_ScrollNestedMode](#arkui_scrollnestedmode).<br>.value[1].i32: nested scrolling when the scrollable component scrolls to the start end. The parameter type is [ArkUI_ScrollNestedMode](#arkui_scrollnestedmode).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: nested scrolling when the scrollable component scrolls to the end. The parameter type is [ArkUI_ScrollNestedMode](#arkui_scrollnestedmode).<br>.value[1].i32: nested scrolling when the scrollable component scrolls to the start end. The parameter type is [ArkUI_ScrollNestedMode](#arkui_scrollnestedmode).| 3615| NODE_SCROLL_OFFSET | Defines the specified position to scroll to. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: horizontal scrolling offset, in vp.<br>.value[1].f32: vertical scrolling offset, in vp.<br>.value[2]?.i32: scrolling duration, in milliseconds. Optional.<br>.value[3]?.i32: (optional) scrolling curve. The parameter type is [ArkUI_AnimationCurve](#arkui_animationcurve). The default value is **ARKUI_CURVE_EASE**.<br>.value[4]?.i32: whether to enable the default spring animation. Optional. The default value **0** means not to enable the default spring animation.<br>.value[5]?.i32: whether to enable overscroll. Optional.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: horizontal scrolling offset, in vp.<br>.value[1].f32: vertical scrolling offset, in vp.| 3616| NODE_SCROLL_EDGE | Defines the edge position to scroll to. This attribute can be set and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: container edge. The parameter type is [ArkUI_ScrollEdge](#arkui_scrolledge).<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: indicates whether the container is on the edge. The value -1 indicates that the container is not on the edge. If the container is on the edge, the status parameter type is [ArkUI_ScrollEdge](#arkui_scrolledge).| 3617| NODE_SCROLL_ENABLE_PAGING | Defines whether to enable the swipe-to-turn-pages feature. This attribute can be set, reset, and obtained as required through APIs.<br>If both **enablePaging** and **scrollSnap** are set, **scrollSnap** takes effect, but **enablePaging** does not.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to enable the swipe-to-turn-pages feature. The default value is **false**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to enable the swipe-to-turn-pages feature.| 3618| NODE_SCROLL_PAGE | Scrolls to the next or previous page.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to scroll to the next page. The value **0** means to scroll to the next page, and **1** means to scroll to the previous page.<br>.value[1]?.i32: whether to enable the page turning animation. The value **1** means to enable the page turning animation, and **0** means the opposite. Default value: 0.| 3619| NODE_SCROLL_BY | Scrolls by the specified amount.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: amount to scroll by in the horizontal direction, in vp by default. <br>.value[1].f32: amount to scroll by in the vertical direction, in vp by default.| 3620| NODE_SCROLL_FLING | Performs inertial scrolling based on the initial velocity passed in.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: initial velocity of inertial scrolling. The default unit is vp/s. If the value specified is 0, it is considered as invalid, and the scrolling for this instance will not take effect. If the value is positive, the scroll will move downward; if the value is negative, the scroll will move upward.| 3621| NODE_SCROLL_FADING_EDGE | Sets the edge fade effect for the scrollable component.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to enable the edge fade effect. The value **0** means to disable edge fade effect, and **1** means the opposite.<br>.value[1]?.f32: length of the edge fade effect, in vp. The default value is **32**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to enable the edge fade effect. The value **0** means to disable edge fade effect, and **1** means the opposite.<br>.value[1].f32: length of the edge fade effect, in vp.<br>**Since**<br>14 | 3622| NODE_SCROLL_SIZE | Obtains the total size of all child components when fully expanded in the scrollable component.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: total width of all child components when fully expanded in the scrollable component. The default unit is vp.<br>.value[1].f32: total height of all child components when fully expanded in the scrollable component. The default unit is vp.<br>When **NODE_PADDING**, **NODE_MARGIN**, **NODE_BORDER_WIDTH** is set, the values are rounded to the nearest pixel when being converted from vp to px. The return values are calculated based on these rounded pixel values.<br>**Since**<br>14 | 3623| NODE_SCROLL_CONTENT_START_OFFSET | Sets the offset from the start of the list content to the boundary of the list display area. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: offset from the start of the list content. The default value is **0**, and the unit is vp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: offset from the start of the list content, in vp.| 3624| NODE_SCROLL_CONTENT_END_OFFSET | Sets the offset from the end of the list content to the boundary of the list display area. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: offset from the end of the list content. The default value is **0**, and the unit is vp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: offset from the end of the list content, in vp.| 3625| NODE_LIST_DIRECTION | Defines the direction in which the list items are arranged. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: direction in which the list items are arranged. The parameter type is [ArkUI_Axis](#arkui_axis). The default value is **ARKUI_AXIS_VERTICAL**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: direction in which the list items are arranged. The parameter type is [ArkUI_Axis](#arkui_axis).| 3626| NODE_LIST_STICKY | Defines whether to pin the header to the top or the footer to the bottom in the **ListItemGroup** component. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to pin the header to the top or the footer to the bottom in the **ListItemGroup** component. It is used together with the **ListItemGroup** component. Data type [ArkUI_StickyStyle](#arkui_stickystyle). The default value is **ARKUI_STICKY_STYLE_NONE**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to pin the header to the top or the footer to the bottom in the **ListItemGroup** component. It is used together with the **ListItemGroup** component. The parameter type is [ArkUI_StickyStyle](#arkui_stickystyle).| 3627| NODE_LIST_SPACE | Defines the spacing between list items. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: spacing between list items along the main axis. The default value is **0**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: spacing between list items along the main axis.| 3628| NODE_LIST_NODE_ADAPTER | Defines the list adapter. The attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.object: **ArkUI_NodeAdapter** object as the adapter.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.object: **ArkUI_NodeAdapter** object.| 3629| NODE_LIST_CACHED_COUNT | Sets the number of cached items in the list adapter. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: number of cached items in the list adapter.<br>.value[1].i32: whether to show cached items. The value **0** means to hide cached items, and **1** means to show cached items. Default value: 0.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: number of cached items in the list adapter.<br>.value[1].i32: whether to show cached items. The value **0** means to hide cached items, and **1** means to show cached items. Default value: 0.| 3630| NODE_LIST_SCROLL_TO_INDEX | Slide to the specified index.<br>When **smooth** is set to **true**, all passed items are loaded and counted in layout calculation. This may result in performance issues if a large number of items are involved.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: index of the item to be scrolled to in the container.<br>.value[1]?.i32: whether to enable the smooth animation for scrolling to the item with the specified index. The value **1** means to enable the animation, and **0** means the opposite. Default value: 0.<br>.value[2]?.i32: how the item to scroll to is aligned with the container. The parameter type is [ArkUI_ScrollAlignment](#arkui_scrollalignment). The default value is **ARKUI_SCROLL_ALIGNMENT_START**.<br>.value[3]?.f32: Options for scrolling to a specified index, for example, an extra offset for the scroll. The unit is vp.| 3631| NODE_LIST_ALIGN_LIST_ITEM | Sets the alignment mode of list items along the cross axis when the cross-axis width of the list is greater than the cross-axis width of list items multiplied by the value of lanes. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: alignment mode of list items along the cross axis. The parameter type is **ArkUI_ListItemAlign**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: alignment mode of list items along the cross axis. The parameter type is **ArkUI_ListItemAlign**.| 3632| NODE_LIST_CHILDREN_MAIN_SIZE | Sets the default main axis size of the child components in this list.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>object: **ArkUI_ListChildrenMainSize** object.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.object: The parameter format is **ArkUI_ListChildrenMainSize**.| 3633| NODE_LIST_INITIAL_INDEX | Sets the item displayed at the beginning of the viewport when the current list is loaded for the first time, that is, the first item to be displayed. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: index value the item displayed at the beginning of the viewport when the current list is loaded for the first time. The default value is **0**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: index value the item displayed at the beginning of the viewport when the current list is loaded for the first time. The default value is **0**.| 3634| NODE_LIST_DIVIDER | Defines the style of the divider for the list items. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].u32: color of the divider, in 0xARGB format. <br>.value[1].f32: stroke width of the divider.<br>.value[2].f32: distance between the divider and the start of the list, in vp.<br>.value[3].f32: distance between the divider and the end of the list, in vp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: color of the divider, in 0xARGB format. <br>.value[1].f32: stroke width of the divider.<br>.value[2].f32: distance between the divider and the start of the list, in vp.<br>.value[3].f32: distance between the divider and the end of the list, in vp.| 3635| NODE_LIST_SCROLL_TO_INDEX_IN_GROUP | Scrolls to the specified list item in the specified list item group.<br>When **smooth** is set to **true**, all passed items are loaded and counted in layout calculation. This may result in performance issues if a large number of items are involved.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: index of the list item group in the current container that contains the target list item.<br>.value[1].i32: index of the target list item in the list item group.<br>.value[2]?.i32: whether to enable the smooth animation for scrolling to the item with the specified index. The value **1** means to enable the animation, and **0** means the opposite. Default value: 0.<br>.value[3]?.i32: how the target item to scroll to is aligned with the container. The parameter type is [ArkUI_ScrollAlignment](#arkui_scrollalignment). The default value is **ARKUI_SCROLL_ALIGNMENT_START**.| 3636| NODE_LIST_LANES | Sets the number of lanes (columns or rows) in the list. This attribute can be set, reset, and obtained as required through APIs.<br>Observe the following when using this API:<br>If the value is set to a number, the column width is calculated by dividing the cross-axis width of the **List** component by the specified number.<br>If the value is set to {minLength, maxLength}, the number of columns is adjusted adaptively based on the width of the **List** component, ensuring that the width respects the {minLength, maxLength} constraints during adaptation. The **minLength** constraint is prioritized to ensure that the cross-axis size of the list item meets the minimum requirement. If the cross-axis width constraint of the parent component is infinite, the parent component is arranged by column, and the column width is calculated based on the largest list item in the display area. Each list item group occupies one row in multi-column mode. Its child list items are arranged based on the **lanes** attribute of the list. The number of columns is calculated based on the cross-axis width of the list item group. If the cross-axis width of the list item group is different from that of the list, the number of columns in the list item group may be different from that in the list.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].u32: number of lanes (rows or columns) in the list. The default value is **0**.<br>.value[1]?.f32: minimum length of the list item. The default value is **1**, and the unit is vp.<br>.value[2]?.f32: maximum length of the list item. The default value is **1**, and the unit is vp.<br>.value[3]?.f32: column spacing of the list item. This parameter is effective when the number of columns is greater than 1. The default value is **1**. The unit is vp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: number of lanes (rows or columns) in the list. If {minLength, maxLength} is set, the return value is **1**.<br>.value[1].f32: minimum length of the list item, in vp.<br>.value[2].f32: maximum length of the list item, in vp.<br>.value[3].f32: column spacing of the list item, in vp.| 3637| NODE_LIST_SCROLL_SNAP_ALIGN | Sets the scroll snap alignment effect for list items. This effect aligns list items to the nearest snap point when scrolling ends. This attribute is effective only when all list items have the same height. It does not take effect when scrolling ends using a touchpad or mouse device. During the alignment animation, the scroll operation source type reported by the **onWillScroll** event is **ScrollSource.FLING**. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: alignment mode of the scroll snap position. Data type: [ArkUI_ScrollSnapAlign] (#arkui_scrollsnapalign). The default value is ARKUI_SCROLL_SNAP_ALIGN_NONE.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: alignment mode of the scroll snap position. The parameter type is [ArkUI_ScrollSnapAlign](#arkui_scrollsnapalign).| 3638| NODE_LIST_MAINTAIN_VISIBLE_CONTENT_POSITION | Sets whether to maintain the visible content's position when data is inserted or deleted outside the display area of the component.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to maintain the visible content's position when data is inserted or deleted outside the display area of the component. The value **0** means not to maintain the visible content's position, and **1** means the opposite. The default value is **0**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to maintain the visible content's position when data is inserted or deleted outside the display area of the component. The value **0** means not to maintain the visible content's position, and **1** means the opposite.| 3639| NODE_LIST_STACK_FROM_END | Sets whether the **List** component starts layout from the end.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether the **List** component starts layout from the end. The value **0** means layout starts from the top, and **1** means layout starts from the end. The default value is **0**.<br> Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether the **List** component starts layout from the end. The value **0** means layout starts from the top, and **1** means layout starts from the end.| 3640| NODE_SWIPER_LOOP | Defines whether to enable loop playback for the swiper. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to enable loop playback. The value **1** means to enable loop playback, and **0** means the opposite. The default value is **1**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to enable loop playback. The value **1** means to enable loop playback, and **0** means the opposite. The default value is **1**.| 3641| NODE_SWIPER_AUTO_PLAY | Defines whether to enable automatic playback for child component switching in the swiper. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to enable automatic playback for child component switching. The value **1** means to enable automatic playback, and **0** means the opposite. The default value is **0**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to enable automatic playback for child component switching. The value **1** means to enable automatic playback, and **0** means the opposite. The default value is **0**.| 3642| NODE_SWIPER_SHOW_INDICATOR | Defines whether to enable the navigation indicator for the swiper. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to enable the navigation indicator. The value **1** means to enable the navigation indicator, and **0** means the opposite. The default value is **1**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to enable the navigation indicator. The value **1** means to enable the navigation indicator, and **0** means the opposite. The default value is **1**.| 3643| NODE_SWIPER_INTERVAL | Defines the interval for automatic playback. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: interval for automatic playback, in milliseconds.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: interval for automatic playback, in milliseconds.| 3644| NODE_SWIPER_VERTICAL | Defines whether vertical swiping is used for the swiper. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether vertical swiping is used. The value **1** means that vertical swiping is used, and **0** means the opposite. The default value is **0**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether vertical swiping is used. The value **1** means that vertical swiping is used, and **0** means the opposite. The default value is **0**.| 3645| NODE_SWIPER_DURATION | Defines the duration of the animation for switching child components. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: duration of the animation for switching child components, in milliseconds. The default value is **400**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: duration of the animation for switching child components, in milliseconds. The default value is **400**.| 3646| NODE_SWIPER_CURVE | Defines the animation curve for the swiper. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: Sets the animation curve parameter. The parameter type is [ArkUI_AnimationCurve](#arkui_animationcurve). The default value is ARKUI_CURVE_LINEAR.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: Sets the animation curve parameter. The parameter type is [ArkUI_AnimationCurve](#arkui_animationcurve). The default value is ARKUI_CURVE_LINEAR.| 3647| NODE_SWIPER_ITEM_SPACE | Defines the spacing between child components in the swiper. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: spacing between child components.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: spacing between child components.| 3648| NODE_SWIPER_INDEX | Defines the index of the child component currently displayed in the swiper. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: number of elements to display per page.<br>.value[1]?.i32: switching animation mode. The parameter type is [ArkUI_SwiperAnimationMode] (#arkui_swiperanimationmode). The setting is only effective for the current call.<br>This parameter is supported since API version 15.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: number of elements to display per page.| 3649| NODE_SWIPER_DISPLAY_COUNT | Defines the number of elements to display per page. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: number of elements to display within the viewport.<br>.value[1]?.i32: whether to paginate by group. The value **0** means to paginate by individual child elements, and **1** means to paginate by groups of child elements displayed within the viewport. The default value is **0**.<br>.string?: This parameter can only be set to **"auto"**. When the value is set to **"auto"**, the **value[]** parameter is ignored.<br>**Since**: 18<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: number of elements to display within the viewport.<br> .value[1].i32: whether to paginate by group.<br>**Since**: 18| 3650| NODE_SWIPER_DISABLE_SWIPE | This interface is used to disable the sliding switching function of the Swiper component. The attribute setting, attribute resetting, and attribute obtaining interfaces are supported.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to disable the swipe feature. The value **1** means to disable the swipe feature, and **0** means the opposite. The default value is **0**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to disable the swipe feature. The value **1** means to disable the swipe feature, and **0** means the opposite. The default value is **0**.| 3651| NODE_SWIPER_SHOW_DISPLAY_ARROW | Defines whether to show the arrow when the mouse pointer hovers over the navigation indicator. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether to show the arrow when the mouse pointer hovers over the navigation indicator. The parameter type is [ArkUI_SwiperArrow](#arkui_swiperarrow).<br>The default value is **ARKUI_SWIPER_ARROW_HIDE**.<br> .?object: style of the arrow displayed when the mouse pointer hovers over the navigation indicator. The parameter type is [ArkUI_SwiperArrowStyle](#arkui_swiperarrowstyle).<br>**Since**<br>18 <br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: indicates whether to display the navigation arrow. The parameter type is [ArkUI_SwiperArrow](#arkui_swiperarrow).<br>The default value is **ARKUI_SWIPER_ARROW_HIDE**.<br> .object: style of the arrow displayed when the mouse pointer hovers over the navigation indicator. The parameter type is [ArkUI_SwiperArrowStyle](#arkui_swiperarrowstyle).<br>**Since**<br>18 | 3652| NODE_SWIPER_EDGE_EFFECT_MODE | Defines the effect used at the edges of the swiper when the boundary of the scrollable content is reached. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: effect used at the edges of the swiper when the boundary of the scrollable content is reached. The parameter type is [ArkUI_EdgeEffect](#arkui_edgeeffect).<br>The default value is **ARKUI_EDGE_EFFECT_SPRING**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: effect used at the edges of the swiper when the boundary of the scrollable content is reached. The parameter type is [ArkUI_EdgeEffect](#arkui_edgeeffect).| 3653| NODE_SWIPER_NODE_ADAPTER | Defines the swiper adapter. The attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.object: **ArkUI_NodeAdapter** object as the adapter.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.object: The format of the return value is ArkUI_NodeAdapter.| 3654| NODE_SWIPER_CACHED_COUNT | Sets the number of cached items in the swiper adapter. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: number of cached items in the swiper adapter. <br>.value[1]?.i32: whether to show cached items. The value **0** means to hide cached items, and **1** means to show cached items. The default value is **0**.<br>**Since**<br>18<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: number of cached items in the list adapter.<br>.value[1].i32: whether to show cached items. The value **0** means to hide cached items, and **1** means to show cached items.<br>**Since**<br>18 | 3655| NODE_SWIPER_PREV_MARGIN | Sets the previous margin of the swiper. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: previous margin, in vp. The default value is **0**.<br>.value[1].i32: whether to ignore blank areas. The value **1** means to ignore blank areas, and **0** means the opposite.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: previous margin, in vp. .value[1].i32: whether to ignore blank areas. The value **1** means to ignore blank areas, and **0** means the opposite.| 3656| NODE_SWIPER_NEXT_MARGIN | Sets the next margin of the swiper. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: next margin, in vp. The default value is **0**.<br>.value[1].i32: whether to ignore blank areas. The value **1** means to ignore blank areas, and **0** means the opposite.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: next margin, in vp. .value[1].i32: whether to ignore blank areas. The value **1** means to ignore blank areas, and **0** means the opposite.| 3657| NODE_SWIPER_INDICATOR | Sets the navigation indicator type of the Swiper component. The attribute setting, attribute resetting, and attribute obtaining interfaces are supported.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: navigation indicator type. The parameter type is [ArkUI_SwiperIndicatorType](#arkui_swiperindicatortype).<br>.object: additional configuration for the navigation indicator, depending on the type. For [ArkUI_SwiperIndicator](#arkui_swiperindicator), the parameter type is [ArkUI_SwiperIndicator](#arkui_swiperindicator).<br> For **ARKUI_SWIPER_INDICATOR_TYPE_DIGIT**, the parameter type is [ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator).<br> <br>**Since**<br>18 <br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: navigation indicator type. The parameter type is [ArkUI_SwiperIndicatorType](#arkui_swiperindicatortype).<br>.object: additional configuration for the navigation indicator, depending on the type. For [ArkUI_SwiperIndicator](#arkui_swiperindicator), the parameter type is [ArkUI_SwiperIndicator](#arkui_swiperindicator).<br> For **ARKUI_SWIPER_INDICATOR_TYPE_DIGIT**, the parameter type is [ArkUI_SwiperDigitIndicator](#arkui_swiperdigitindicator).<br> <br>**Since**<br>18 | 3658| NODE_SWIPER_NESTED_SCROLL | Sets the nested scrolling mode of the **Swiper** component and its parent container.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: nested scrolling mode of the Swiper component and parent component. The parameter type is [ArkUI_SwiperNestedScrollMode](#arkui_swipernestedscrollmode).<br>The default value is **ARKUI_SWIPER_NESTED_SCROLL_SELF_ONLY**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: nested scrolling mode of the Swiper component and parent component. The parameter type is [ArkUI_SwiperNestedScrollMode](#arkui_swipernestedscrollmode).| 3659| NODE_SWIPER_SWIPE_TO_INDEX | Sets the swiper to switch to the specified page.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: index of the target page in the swiper.<br>.value[1]?.i32: whether to use an animation for when the target page is reached. The value 1 indicates that the dynamic effect is enabled, and the value 0 indicates that the dynamic effect is disabled. The default value is 0.| 3660| NODE_SWIPER_INDICATOR_INTERACTIVE | Sets whether the navigation indicator is interactive.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether the navigation indicator is interactive. The default value **true** means that the navigation indicator is interactive.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether the navigation indicator is interactive.| 3661| NODE_SWIPER_PAGE_FLIP_MODE | Sets the page flipping mode using the mouse wheel.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: page flipping mode using the mouse wheel. The parameter type is [ArkUI_PageFlipMode](#arkui_pageflipmode).<br>Format of the return value [ArkUI_PageFlipMode](#arkui_pageflipmode)):<br>.value[0].i32: page flipping mode using the mouse wheel.<br>**Since**<br>14 | 3662| NODE_SWIPER_AUTO_FILL | Configures the **Swiper** component to automatically adjust the number of elements displayed per page based on the minimum width of the elements. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: minimum width of the elements to be displayed, in vp.<br> .value[1]?.i32: whether to paginate by group. The value **0** means to paginate by individual child elements, and **1** means to paginate by groups of child elements displayed within the viewport. The default value is **0**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: minimum width of the elements to be displayed, in vp.<br> .value[1].i32: whether to paginate by group.<br>**Since**<br>18 | 3663| NODE_LIST_ITEM_SWIPE_ACTION | Sets the swipe action item displayed when the list item is swiped out from the screen edge. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.object: [ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption) object.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.object: [ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption) object.| 3664| NODE_LIST_ITEM_GROUP_SET_HEADER | Defines the header of the list item group. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.object: Use the [ArkUI_NodeHandle](#arkui_nodehandle) object as the ListItemGroup header component.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.object: Use the [ArkUI_NodeHandle](#arkui_nodehandle) object as the ListItemGroup header component.| 3665| NODE_LIST_ITEM_GROUP_SET_FOOTER | Defines the footer of the list item group. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.object: [ArkUI_NodeHandle](#arkui_nodehandle) object to be used as the footer of the list item group.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.object: [ArkUI_NodeHandle](#arkui_nodehandle) object to be used as the footer of the list item group.| 3666| NODE_LIST_ITEM_GROUP_SET_DIVIDER | Defines the style of the divider for the list items. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].u32: color of the divider, in 0xARGB format.<br>.value[1].f32: stroke width of the divider, in vp.<br>.value[2].f32: distance between the divider and the start of the list, in vp.<br>.value[3].f32: distance between the divider and the end of the list, in vp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].u32: color of the divider, in 0xARGB format.<br>.value[1].f32: stroke width of the divider, in vp.<br>.value[2].f32: distance between the divider and the start of the list, in vp.<br>.value[3].f32: distance between the divider and the end of the list, in vp.| 3667| NODE_LIST_ITEM_GROUP_CHILDREN_MAIN_SIZE | Sets the default spindle size of the ListItemGroup child component.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>object: **ArkUI_ListChildrenMainSize** object.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.object: The parameter format is **ArkUI_ListChildrenMainSize**.| 3668| NODE_LIST_ITEM_GROUP_NODE_ADAPTER | Defines the list item group adapter. The attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.object: **ArkUI_NodeAdapter** object as the adapter.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.object: **ArkUI_NodeAdapter** object. | 3669| NODE_COLUMN_ALIGN_ITEMS | Defines the horizontal alignment mode of child components in the column. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: horizontal alignment format of a child component. The data type is [ArkUI_HorizontalAlignment](#arkui_horizontalalignment).<br>Default value: **ARKUI_HORIZONTAL_ALIGNMENT_CENTER**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: horizontal alignment format of a child component. The data type is [ArkUI_HorizontalAlignment](#arkui_horizontalalignment).| 3670| NODE_COLUMN_JUSTIFY_CONTENT | Defines the vertical alignment mode of child components in the column. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: vertical alignment format of the child component. The data type is [ArkUI_FlexAlignment](#arkui_flexalignment).<br>Default value: **ARKUI_FLEX_ALIGNMENT_START**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: vertical alignment format of a child component. The data type is [ArkUI_FlexAlignment](#arkui_flexalignment).| 3671| NODE_ROW_ALIGN_ITEMS | Defines the vertical alignment mode of child components in the row. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: vertical alignment format of a child component. The data type is [ArkUI_VerticalAlignment](#arkui_verticalalignment).<br>Default value: **ARKUI_VERTICAL_ALIGNMENT_CENTER**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: vertical alignment format of a child component. The data type is [ArkUI_VerticalAlignment](#arkui_verticalalignment).| 3672| NODE_ROW_JUSTIFY_CONTENT | Defines the horizontal alignment mode of child components in the row. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: horizontal alignment format of a child component. The data type is [ArkUI_FlexAlignment](#arkui_flexalignment).<br>Default value: **ARKUI_FLEX_ALIGNMENT_START**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: horizontal alignment format of a child component. The data type is [ArkUI_FlexAlignment](#arkui_flexalignment).| 3673| NODE_FLEX_OPTION | Defines the opacity attribute, which can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0]?.i32: arrangement direction of child components on the Flex container [ArkUI_FlexDirection](#arkui_flexdirection). The default value is ARKUI_FLEX_DIRECTION_ROW.<br>.value[1]?.i32: arrangement rule [ArkUI_FlexWrap](#arkui_flexwrap). The default value is ARKUI_FLEX_WRAP_NO_WRAP.<br>.value[2]?.i32: alignment format on the principal axis [ArkUI_FlexAlignment](#arkui_flexalignment). The default value is ARKUI_FLEX_ALIGNMENT_START.<br>.value[3]?.i32: alignment format on the cross axis [ArkUI_ItemAlignment](#arkui_itemalignment). The default value is ARKUI_ITEM_ALIGNMENT_START.<br>.value[4]?.i32: alignment mode of multiple lines when there is extra space in the cross axis [ArkUI_FlexAlignment](#arkui_flexalignment). The default value is ARKUI_FLEX_ALIGNMENT_START.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: direction in which flex items are arranged. <br>.value[1].i32: how the flex items are wrapped. <br>.value[2].i32: alignment mode along the main axis. <br>.value[3].i32: alignment mode along the cross axis. <br>.value[4].i32: alignment mode along the cross axis for multi-line content.| 3674| NODE_REFRESH_REFRESHING | Sets whether a component is being refreshed. Attributes can be set and obtained.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: The parameter type is 1 or 0.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>value[0].i32: The parameter type is 1 or 0.| 3675| NODE_REFRESH_CONTENT | Sets the custom content in the pull-down area. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.object: The parameter type is **ArkUI_NodeHandle**.| 3676| NODE_REFRESH_PULL_DOWN_RATIO | Sets the pull-down and hand coefficients. The interfaces for setting, resetting, and obtaining attributes are supported.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: pull-down ratio. The value is in the range from 0 to 1.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: pull-down ratio. The value is in the range from 0 to 1.| 3677| NODE_REFRESH_OFFSET | Sets the pull-down offset that initiates a refresh. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: pull-down offset, in vp. The default value is 64 vp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: pull-down offset, in vp. The default value is 64 vp.| 3678| NODE_REFRESH_PULL_TO_REFRESH | Sets whether to initiate a refresh when the pull-down distance exceeds the value of **refreshOffset**. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to initiate a refresh. The value **true** means to initiate a refresh, and **false** means the opposite.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether to initiate a refresh. The value **1** means to initiate a refresh, and **0** means the opposite.| 3679| NODE_WATER_FLOW_LAYOUT_DIRECTION | Defines the main axis direction of the waterfall component layout. Attributes can be set, reset, and obtained.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: main axis direction. The parameter type is **ArkUI_FlexDirection**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: main axis direction. The parameter type is **ArkUI_FlexDirection**.| 3680| NODE_WATER_FLOW_COLUMN_TEMPLATE | Sets the number of columns in the water flow layout. If this parameter is not set, one column is used by default. This attribute can be set, reset, and obtained as required through APIs. For example, **'1fr 1fr 2fr'** indicates three columns, with the first column taking up 1/4 of the parent component's full width, the second column 1/4, and the third column 2/4. You can use **columnsTemplate('repeat(auto-fill,track-size)')** to automatically calculate the number of rows based on the specified row height **track-size**. **repeat** and **auto-fill** are keywords. The units for **track-size** can be px, vp (default), %, or a valid number.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: number of layout columns.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: number of layout columns.| 3681| NODE_WATER_FLOW_ROW_TEMPLATE | Sets the number of rows in the water flow layout. If this parameter is not set, one row is used by default. This attribute can be set, reset, and obtained as required through APIs. For example, **'1fr 1fr 2fr'** indicates three rows, with the first row taking up 1/4 of the parent component's full height, the second row 1/4, and the third row 2/4. You can use **rowsTemplate('repeat(auto-fill,track-size)')** to automatically calculate the number of rows based on the specified row height **track-size**. **repeat** and **auto-fill** are keywords. The units for **track-size** can be px, vp (default), %, or a valid number.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: number of layout rows.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: number of layout rows.| 3682| NODE_WATER_FLOW_COLUMN_GAP | Sets the gap between columns. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: gap between columns, in vp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: gap between columns, in vp.| 3683| NODE_WATER_FLOW_ROW_GAP | Sets the gap between rows. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: gap between lines, in vp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: gap between lines, in vp.| 3684| NODE_WATER_FLOW_SECTION_OPTION | Defines the water flow section configuration. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: zero-based index of the water flow item section to update. The value is converted to an integer. <br>.object: **ArkUI_WaterFlowSectionOption** object.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.object: **ArkUI_WaterFlowSectionOption** object.| 3685| NODE_WATER_FLOW_NODE_ADAPTER | Defines the water flow adapter. The attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.object: **ArkUI_NodeAdapter** object as the adapter.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.object: **ArkUI_NodeAdapter** object.| 3686| NODE_WATER_FLOW_CACHED_COUNT | Sets the number of cached items in the water flow adapter. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: number of cached items in the water flow adapter. <br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: number of cached items in the list adapter.| 3687| NODE_WATER_FLOW_FOOTER | Sets the custom footer for the water flow container.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.object: custom footer. The parameter type is [ArkUI_NodeHandle](#arkui_nodehandle).| 3688| NODE_WATER_FLOW_SCROLL_TO_INDEX | Scrolls to the item with the specified index.<br>When **smooth** is set to **true**, all passed items are loaded and counted in layout calculation. This may result in performance issues if a large number of items are involved.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: index of the item to be scrolled to in the container.<br>.value[1]?.i32: whether to enable the smooth animation for scrolling to the item with the specified index. The value **1** means to enable the animation, and **0** means the opposite. The default value is **0**.<br>.value[2]?.i32: how the item to scroll to is aligned with the container. The parameter type is [ArkUI_ScrollAlignment](#arkui_scrollalignment). The default value is **ARKUI_SCROLL_ALIGNMENT_START**.| 3689| NODE_WATER_FLOW_ITEM_CONSTRAINT_SIZE | Defines the size constraints to apply to water flow items. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: minimum width. The value **-1** indicates that the minimum width is not set. <br>.value[1].f32: maximum width. The value **-1** indicates that the maximum width is not set. <br>.value[2].f32: minimum height. The value **-1** indicates that the minimum height is not set. <br>.value[3].f32: maximum height. The value **-1** indicates that the maximum height is not set. <br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: minimum width. The value **-1** indicates that the minimum width is not set. <br>.value[1].f32: maximum width. The value **-1** indicates that the maximum width is not set. <br>.value[2].f32: minimum height. The value **-1** indicates that the minimum height is not set. <br>.value[3].f32: maximum height. The value **-1** indicates that the maximum height is not set. | 3690| NODE_RELATIVE_CONTAINER_GUIDE_LINE | Sets the guideline in the **RelativeContainer**. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.object: guideline in the **RelativeContainer**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.object: guideline in the **RelativeContainer**.| 3691| NODE_RELATIVE_CONTAINER_BARRIER | Sets the barrier in the **RelativeContainer**. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.object: guideline in the **RelativeContainer**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.object: barrier in the **RelativeContainer** component.| 3692| NODE_GRID_COLUMN_TEMPLATE | Sets the number of columns in the water flow layout. If this parameter is not set, one column is used by default. This attribute can be set, reset, and obtained as required through APIs. For example, **'1fr 1fr 2fr'** indicates three columns, with the first column taking up 1/4 of the parent component's full width, the second column 1/4, and the third column 2/4. You can use **columnsTemplate('repeat(auto-fill,track-size)')** to automatically calculate the number of rows based on the specified row height **track-size**. **repeat** and **auto-fill** are keywords. The units for **track-size** can be px, vp (default), %, or a valid number.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: number of layout columns.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: number of layout columns.| 3693| NODE_GRID_ROW_TEMPLATE | Sets the number of rows or the minimum row height in the grid layout. If this parameter is not set, one row is used by default. This attribute can be set, reset, and obtained as required through APIs. For example, **'1fr 1fr 2fr'** indicates three rows, with the first row taking up 1/4 of the parent component's full height, the second row 1/4, and the third row 2/4. You can use **rowsTemplate('repeat(auto-fill,track-size)')** to automatically calculate the number of rows based on the specified row height **track-size**. **repeat** and **auto-fill** are keywords. The units for **track-size** can be px, vp (default), %, or a valid number.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: number of layout rows.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.string: number of layout rows.| 3694| NODE_GRID_COLUMN_GAP | Sets the gap between columns. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: gap between columns, in vp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: gap between columns, in vp.| 3695| NODE_GRID_ROW_GAP | Sets the gap between rows. This attribute can be set, reset, and obtained as required through APIs.<br>Parameter format of the attribute setting method [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: gap between lines, in vp.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: gap between lines, in vp.| 3696| NODE_GRID_NODE_ADAPTER | Defines the grid adapter. The attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.object: **ArkUI_NodeAdapter** object as the adapter.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.object: The format of the return value is ArkUI_NodeAdapter.| 3697| NODE_GRID_CACHED_COUNT | Sets the number of cached items in the grid adapter. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: number of cached items in the water flow adapter. | 3698| NODE_TEXT_PICKER_COLUMN_WIDTHS<sup>18+</sup> | Sets the width of columns in the picker.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: width of the first column, specified as a percentage of the total width. By default, all columns have equal widths.<br>.value[1]?.f32: width of the second column, specified as a percentage of the total width. By default, all columns have equal widths.<br>.value[2]?.f32: width of the third column, specified as a percentage of the total width. By default, all columns have equal widths.<br>...<br>.value[n]?.f32: width of the (n+1)-th column, specified as a percentage of the total width. By default, all columns have equal widths.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: width of the first column as a percentage of the total width.<br>.value[1].f32: width of the second column as a percentage of the total width.<br>.value[2].f32: width of the third column as a percentage of the total width.<br>...<br>.value[n].f32: width of the (n+1)-th column as a percentage of the total width.| 3699| NODE_IMAGE_ANIMATOR_IMAGES | Sets the image frame information set of the frame animation component. Dynamic update is not supported. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.size: number of image frames;<br>.object: image frame array. The parameter type is **ArkUI_ImageAnimatorFrameInfo**. <br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.size: number of image frames;<br>.object: image frame array. The parameter type is **ArkUI_ImageAnimatorFrameInfo**. | 3700| NODE_IMAGE_ANIMATOR_STATE | Sets the playback status of the frame-by-frame animation. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: controls the playing status of the animation. The parameter type is [ArkUI_AnimationStatus](#arkui_animationstatus). The default value is the initial status.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: controls the playing status of the animation. The parameter type is [ArkUI_AnimationStatus](#arkui_animationstatus).| 3701| NODE_IMAGE_ANIMATOR_DURATION | Sets the playback duration of the frame-by-frame animation. This attribute does not take effect when a separate duration is set for any of the image frames. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: playback duration, in milliseconds. The default value is **1000**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: playback duration, in milliseconds. The default value is **1000**.| 3702| NODE_IMAGE_ANIMATOR_REVERSE | Sets the playback direction of the frame-by-frame animation. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: playback direction. The value **0** indicates that images are played from the first one to the last one, and **1** indicates that images are played from the last one to the first one. The default value is **0**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: playback direction. The value **0** indicates that images are played from the first one to the last one, and **1** indicates that images are played from the last one to the first one.| 3703| NODE_IMAGE_ANIMATOR_FIXED_SIZE | Whether the image size is fixed at the component size.<br> This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether the image size is the fixed at the component size. The value **1** indicates that the image size is fixed at the component size. The value **0** indicates that the width, height, top, and left attributes of each image must be set separately. The default value is **1**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether the image size is the fixed at the component size. The value **1** indicates that the image size is fixed at the component size. The value **0** indicates that the width, height, top, and left attributes of each image must be set separately.| 3704| NODE_IMAGE_ANIMATOR_FILL_MODE | Sets the status before and after execution of the frame-by-frame animation in the current playback direction. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: status before and after execution of the frame-by-frame animation in the current playback direction. The parameter type is **ArkUI_AnimationFillMode**. The default value is **FORWARDS**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: status before and after execution of the frame-by-frame animation in the current playback direction. The parameter type is **ArkUI_AnimationFillMode**.| 3705| NODE_IMAGE_ANIMATOR_ITERATION | Sets the number of times that the frame-by-frame animation is played. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: number of times that the animation is played.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: number of times that the animation is played.| 3706| NODE_BACKDROP_BLUR | Sets the background blur effect. This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].f32: background blur radius. The value range is [0, +∞). The unit is px. The default value is **0.0**.<br>.value[1]?.f32: brightness of black in the grayscale blur. The value range is [0, 127].<br>.value[2]?.f32: degree of darkening the white color in the grayscale blur. The value range is [0, 127].<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].f32: background blur radius. The value range is [0, +∞). The unit is px.<br>.value[1].f32: brightness of black in the grayscale blur. The value range is [0, 127].<br>.value[2].f32: degree of darkening the white color in the grayscale blur. The value range is [0, 127].<br>**Since**: 15| 3707 3708 3709### ArkUI_DatePickerMode 3710 3711``` 3712enum ArkUI_DatePickerMode 3713``` 3714**Description** 3715 3716Enumerates the column display modes of the date picker. 3717 3718**Since**: 18 3719 3720| Enum| Description| 3721| -------- | -------- | 3722| ARKUI_DATEPICKER_MODE_DATE | Default value. The date displays three columns: year, month, and day.| 3723| ARKUI_DATEPICKER_YEAR_AND_MONTH | The date displays two columns: year and month.| 3724| ARKUI_DATEPICKER_MONTH_AND_DAY | The date displays two columns: month and day.<br>In this mode, if the month changes from December to January, the year does not increment by one; if the month changes from January to December, the year does not decrement by one. The year remains fixed at the currently set value.| 3725 3726### ArkUI_NodeContentEventType 3727 3728``` 3729enum ArkUI_NodeContentEventType 3730``` 3731**Description** 3732 3733Defines the NodeContent event type. 3734 3735**Since**: 12 3736 3737| Enum| Description| 3738| -------- | -------- | 3739| NODE_CONTENT_EVENT_ON_ATTACH_TO_WINDOW | Attach event. | 3740| NODE_CONTENT_EVENT_ON_DETACH_FROM_WINDOW | Detach event. | 3741 3742 3743### ArkUI_NodeCustomEventType 3744 3745``` 3746enum ArkUI_NodeCustomEventType 3747``` 3748**Description** 3749 3750Enumerates the custom component event types. 3751 3752**Since**: 12 3753 3754| Enum| Description| 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**Description** 3768 3769Enumerates the dirty area flags passed in the **::markDirty** API. 3770 3771**Since**: 12 3772 3773| Enum| Description| 3774| -------- | -------- | 3775| NODE_NEED_MEASURE | Remeasure.<br>When this type of flag is specified, re-layout is triggered by default.| 3776| NODE_NEED_LAYOUT | Re-layout. | 3777| NODE_NEED_RENDER | Re-rendering. | 3778 3779 3780### ArkUI_NodeEventType 3781 3782``` 3783enum ArkUI_NodeEventType 3784``` 3785**Description** 3786 3787Enumerates the event types supported by the NativeNode component. 3788 3789**Since**: 12 3790 3791| Enum| Description| 3792| -------- | -------- | 3793| NODE_TOUCH_EVENT | Gesture event.<br>When the event callback occurs, the union type in the event parameter [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent).| 3794| NODE_EVENT_ON_APPEAR | Mount event.<br>This event is triggered when the component is mounted to the component tree and displayed.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) does not contain parameters.| 3795| NODE_EVENT_ON_DISAPPEAR | Unmount event.<br>This event is triggered when the component is unmounted from the component tree and disappears.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) does not contain parameters.| 3796| NODE_EVENT_ON_AREA_CHANGE | Component area change event.<br>This event is triggered when the component's size, position, or any other attribute that may affect its display area changes.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].f32: original width of the target element, in vp. The value is a number.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].f32: original height of the target element, in vp. The value is a number.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[2].f32: X coordinate of the upper left corner of the target element relative to the upper left corner of the parent element. The value type is number and the unit is vp.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[3].f32: Y-axis coordinate of the upper left corner of the target element relative to the upper left corner of the parent element. The value type is number, and the unit is vp.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[4].f32: X coordinate of the upper left corner of the target element relative to the upper left corner of the page. The value type is number, and the unit is vp.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[5].f32: Y coordinate of the upper left corner of the target element relative to the upper left corner of the page. The value type is number, and the unit is vp.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[6].f32: new width of the target element, in vp. The value is a number.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].f32: original height of the target element, in vp. The value is a number.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[8].f32: X coordinate of the upper left corner of the latest target element relative to the upper left corner of the parent element. The value type is number and the unit is vp.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[9].f32: Y coordinate of the upper left corner of the latest target element relative to the upper left corner of the parent element. The value type is number, and the unit is vp.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[10].f32: X coordinate of the upper left corner of the latest target element relative to the upper left corner of the page. The value type is number, and the unit is vp.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[11].f32: Y coordinate of the upper left corner of the latest target element relative to the upper left corner of the page. The value type is number, and the unit is vp.| 3797| NODE_ON_FOCUS | Event of obtaining the focus.<br>This event is triggered when the component obtains the focus.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) does not contain parameters.| 3798| NODE_ON_BLUR | Event of losing the focus.<br>This event is triggered when the component loses the focus.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) does not contain parameters.| 3799| NODE_ON_CLICK | Click event.<br>This event is triggered when the component is clicked.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].f32**: X coordinate of the click relative to the upper left corner of the clicked component's original area, in px.<br>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].f32**: Y coordinate of the click relative to the upper left corner of the clicked component's original area, in px.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[2].f32: event timestamp. It is the interval between the time when the event is triggered and the time when the system starts, in microseconds.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[3].i32: event input device. The value 1 indicates the mouse, 2 indicates the touchscreen, and 4 indicates the key.<br>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[4].f32**: X coordinate of the click relative to the upper left corner of the application window, in px.<br>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[5].f32**: Y coordinate of the click relative to the upper left corner of the application window, in px.<br>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[6].f32**: X coordinate of the click relative to the upper left corner of the application screen, in px.<br>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[7].f32**: Y coordinate of the click relative to the upper left corner of the application screen, in px.| 3800| NODE_ON_CLICK_EVENT | Click event.<br>This event is triggered when the component is clicked.<br>When the event callback occurs, the union type in the event parameter [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent).| 3801| NODE_ON_TOUCH_INTERCEPT | Custom component event interception.<br>This event is triggered when the component is clicked.<br>When the event callback occurs, the union type in the event parameter [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent).| 3802| NODE_EVENT_ON_VISIBLE_AREA_CHANGE | Visible area change event.<br>This event is triggered when the ratio of the component's visible area to its total area is greater than or less than the threshold. Before registering the event, you need to use **NODE_VISIBLE_AREA_CHANGE_RATIO** to configure the threshold.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32: whether the component's visible area has increased or decreased relative to its total area since the last update. The value **1** indicates that the visible area has increased, and **0** indicates that the visible area has decreased.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].f32: ratio of the component's visible area to its total area at the time the callback is triggered.| 3803| NODE_ON_HOVER | Called when the mouse pointer is moved over or away from the component.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32: indicates whether the mouse pointer is hovered over the component. The value 1 indicates that the mouse pointer is hovered over the component, and the value 0 indicates that the mouse pointer is hovered over the component.| 3804| NODE_ON_HOVER_EVENT | Called when the mouse pointer is moved over or away from the component.<br>When the event callback occurs, the union type in the event parameter [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent).| 3805| NODE_ON_MOUSE | Mouse event.<br>This event is triggered when the component is clicked by a mouse device button or when the mouse pointer moves within the component.<br>When the event callback occurs, the union type in the event parameter [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent).| 3806| NODE_EVENT_ON_ATTACH | Attach event.<br>This event is triggered when the component is attached to the component tree.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) does not contain parameters.| 3807| NODE_EVENT_ON_DETACH | Detach event.<br>This event is triggered when the component is detached from the component tree.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) does not contain parameters.| 3808| NODE_ON_ACCESSIBILITY_ACTIONS | Accessibility action.<br>This event is triggered when an accessibility action is performed after the corresponding accessibility action type is set.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].u32:: operation type for triggering callback. The parameter type is [ArkUI_AccessibilityActionType](#arkui_accessibilityactiontype).| 3809| NODE_ON_PRE_DRAG | Notifies the listener of the interaction state prior to a drop and drop operation.<br>This event is triggered when a component is draggable and when a long press, lift, or drag initiation occurs.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32: corresponds to [ArkUI_PreDragStatus](#arkui_predragstatus).| 3810| NODE_ON_DRAG_START | Called when the user starts to drag an item.<br>A drag operation is recognized only when the dragged item is moved far enough.<br>When the event callback occurs, you can obtain [ArkUI_DragEvent](#arkui_dragevent) from the [ArkUI_NodeEvent](#arkui_nodeevent-12) object.| 3811| NODE_ON_DRAG_ENTER | Called when a dragged item enters the boundaries of the current component.<br>The current component refers to the component that listens for this event.<br>When the event callback occurs, you can obtain [ArkUI_DragEvent](#arkui_dragevent) from the [ArkUI_NodeEvent](#arkui_nodeevent-12) object.| 3812| NODE_ON_DRAG_MOVE | Called when a dragged item moves in the current component.<br>The current component refers to the component that listens for this event.<br>When the event callback occurs, you can obtain [ArkUI_DragEvent](#arkui_dragevent) from the [ArkUI_NodeEvent](#arkui_nodeevent-12) object.| 3813| NODE_ON_DRAG_LEAVE | Called when a dragged item leaves the boundaries of the current component.<br>The current component refers to the component that listens for this event.<br>When the event callback occurs, you can obtain [ArkUI_DragEvent](#arkui_dragevent) from the [ArkUI_NodeEvent](#arkui_nodeevent-12) object.| 3814| NODE_ON_DROP | Called when a dragged item is dropped on the current component. The component can obtain the drag data for processing through the callback.<br>The current component refers to the component that listens for this event.<br>When the event callback occurs, you can obtain [ArkUI_DragEvent](#arkui_dragevent) from the [ArkUI_NodeEvent](#arkui_nodeevent-12) object.| 3815| NODE_ON_DRAG_END | Called when a drag operation ends. The drag source can obtain the drag result by registering this callback.<br>A drag operation ends when the dragged item is released. When the event callback occurs, the [ArkUI_DragEvent](#arkui_dragevent) object can be obtained from the [ArkUI_NodeEvent](#arkui_nodeevent-12) object.| 3816| NODE_ON_KEY_EVENT | Triggered when a key event occurs.<br>The callback can be triggered during interactions with a focused window using an external keyboard or other input device.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>**Since**<br>14 | 3817| NODE_ON_KEY_PRE_IME | Defines the event triggered before the input method responds to the key action.<br>If the return value of this callback is **true**, the key event is considered consumed, and subsequent event callbacks (**keyboardShortcut**, input method events, **onKeyEvent**) will be intercepted and no longer triggered. The callback can be triggered during interactions with a focused window using an external keyboard or other input device.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>**Since**<br>14 | 3818| NODE_ON_AXIS | Defines the event triggered when the bound component receives an axis event.<br>Defines the event triggered when the bound component receives an axis event.<br>When an event occurs, the union type in the [ArkUI_NodeEvent] (#arkui_nodeevent-12) object is [ArkUI_UIInputEvent](_ark_u_i___event_module.md#arkui_uiinputevent).<br>**Since**<br>18| 3819| NODE_DISPATCH_KEY_EVENT | Defines the component key event re-dispatch event. When a component node receives a key event, this callback is triggered instead of dispatching the event to its child nodes.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>**Since**<br>15 | 3820| NODE_VISIBLE_AREA_APPROXIMATE_CHANGE_EVENT | Visible area change event.<br>This event is triggered when the ratio of the component's visible area to its total area is greater than or less than the threshold. Before registering the event, you need to use **NODE_VISIBLE_AREA_APPROXIMATE_CHANGE_RATIO** to configure the threshold.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32: whether the component's visible area has increased or decreased relative to its total area since the last update. The value **1** indicates that the visible area has increased, and **0** indicates that the visible area has decreased.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].f32: ratio of the component's visible area to its total area at the time the callback is triggered.<br>**Since**<br>18 | 3821| NODE_TEXT_ON_DETECT_RESULT_UPDATE | Called when text recognition with the configured **TextDataDetectorConfig** settings succeeds.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md).<br>[ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md) contains the following parameters:<br>[ArkUI_StringAsyncEvent.pStr](_ark_u_i___string_async_event.md#pstr): text recognition result in JSON format.| 3822| NODE_IMAGE_ON_COMPLETE | Image loading success event.<br>This event is triggered when an image is successfully loaded or decoded.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32: loading status. The value **0** indicates that the image is loaded successfully, and the value **1** indicates that the image is decoded successfully.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].f32: width of the image, in px.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[2].f32: height of the image, in px.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[3].f32: width of the component, in px.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[4].f32: height of the component, in px.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[5].f32: offset of the rendered content relative to the component on the x-axis, in px.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[6].f32: offset of the rendered content relative to the component on the y-axis, in px.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[7].f32: actual rendered width of the image, in px.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[8].f32:actual rendered height of the image, in px.| 3823| NODE_IMAGE_ON_ERROR | Image loading failure event.<br>This event is triggered when an error occurs during image loading.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32 error code information:<br>401: The image could not be obtained because the image path is invalid.<br>103101: The image format is not supported.| 3824| NODE_IMAGE_ON_SVG_PLAY_FINISH | Defines the SVG animation playback completion event.<br>This event is triggered when the animation playback in the loaded SVG image is complete.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) does not contain parameters.| 3825| NODE_IMAGE_ON_DOWNLOAD_PROGRESS | Called during image download.<br>Condition for triggering this event: This event is triggered when the page component downloads a web page image.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>Number of bytes that have been downloaded by the [ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].u32: so far.<br>Total number of bytes of images to be downloaded by the [ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].u32:.| 3826| NODE_TOGGLE_ON_CHANGE | Called when the toggle status changes.<br>This event is triggered when the switch status changes.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32: current switch status. The value 1 indicates that the switch is turned on, and the value 0 indicates that the switch is turned off.| 3827| NODE_TEXT_INPUT_ON_CHANGE | Called when the text input content changes.<br>Condition for triggering the event: The input content changes.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md).<br>[ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md) contains the following parameters:<br>[ArkUI_StringAsyncEvent.pStr](_ark_u_i___string_async_event.md#pstr): input text content.| 3828| NODE_TEXT_INPUT_ON_SUBMIT | This event is triggered when the Enter key of the textInput input method is pressed.<br>This event is triggered when the Enter key of the input method is pressed.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32: type of the Enter key.| 3829| NODE_TEXT_INPUT_ON_CUT | Called when the cut button on the pasteboard, which displays when the text box is long pressed, is clicked.<br>Condition for triggering this event: Touch and hold the internal area of the text box to display the clipboard, and touch the clipboard cut button.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md).<br>[ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md) contains the following parameters:<br>[ArkUI_StringAsyncEvent.pStr](_ark_u_i___string_async_event.md#pstr): cut text content.| 3830| NODE_TEXT_INPUT_ON_PASTE | Called when the paste button on the pasteboard, which displays when the text box is long pressed, is clicked.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md).<br>[ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md) contains the following parameters:<br>[ArkUI_StringAsyncEvent.pStr](_ark_u_i___string_async_event.md#pstr): text pasted.| 3831| NODE_TEXT_INPUT_ON_TEXT_SELECTION_CHANGE | Called when the text selection position changes.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32: indicates the start position of the selected text.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32: indicates the end position of the selected text.| 3832| NODE_TEXT_INPUT_ON_EDIT_CHANGE | Called when the input status changes.<br>Condition for triggering this event: The input status changes.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32: **true** indicates that text input is in progress.| 3833| NODE_TEXT_INPUT_ON_INPUT_FILTER_ERROR | Called when matching with the regular expression specified by **NODE_TEXT_INPUT_INPUT_FILTER** fails.<br>Condition for triggering the event: The regular expression fails to be matched.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md).<br>[ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md) contains the following parameters:<br>[ArkUI_StringAsyncEvent.pStr](_ark_u_i___string_async_event.md#pstr): content that is filtered out when regular expression matching fails.| 3834| NODE_TEXT_INPUT_ON_CONTENT_SCROLL | Called when the text content is scrolled.<br>Condition for triggering this event: The text content is scrolled.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32: horizontal coordinate offset of the text in the content area.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32: offset in the Y coordinate of the text in the content area.| 3835| NODE_TEXT_INPUT_ON_CONTENT_SIZE_CHANGE | Called when the text input content changes.<br>Condition for triggering the event: The input content changes.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].f32: indicates the width of the text.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].f32: height of the text.| 3836| NODE_TEXT_INPUT_ON_WILL_INSERT | Called when text is about to be entered.<br>The event parameter is [ArkUI_NodeEvent](#arkui_nodeevent-12).<br>value.f32: position of the text, with the index of **0**; obtained using **OH_ArkUI_NodeEvent_GetNumberValue**.<br>buffer: string value of the text, with the index of **0**; obtained using **OH_ArkUI_NodeEvent_GetStringValue**.<br> <br>It returns **true** if the text is inserted; returns **false** otherwise. You can set the return value using **OH_ArkUI_NodeEvent_SetReturnNumberValue**.| 3837| NODE_TEXT_INPUT_ON_DID_INSERT | Called when text is entered.<br>The event parameter is [ArkUI_NodeEvent](#arkui_nodeevent-12).<br>value.f32: position of the text, with the index of **0**; obtained using **OH_ArkUI_NodeEvent_GetNumberValue**.<br>buffer: string value of the text, with the index of **0**; obtained using **OH_ArkUI_NodeEvent_GetStringValue**.| 3838| NODE_TEXT_INPUT_ON_WILL_DELETE | Called when text is about to be deleted.<br>The event parameter is [ArkUI_NodeEvent](#arkui_nodeevent-12).<br>value.f32: position of the text deleted, with the index of **0**; obtained using **OH_ArkUI_NodeEvent_GetNumberValue**.<br>value.i32: direction for deleting the text, with the index of **1**; obtained using **OH_ArkUI_NodeEvent_GetNumberValue**. The value **0** indicates backward-delete, and **1** indicates forward-delete.<br>buffer: string value of the text, with the index of **0**; obtained using **OH_ArkUI_NodeEvent_GetStringValue**.<br> <br>It returns **true** if the text is inserted; returns **false** otherwise.<br>You can set the return value using **OH_ArkUI_NodeEvent_SetReturnNumberValue**.| 3839| NODE_TEXT_INPUT_ON_DID_DELETE | Called when text is deleted.<br>The event parameter is [ArkUI_NodeEvent](#arkui_nodeevent-12).<br>value.f32: position of the text deleted, with the index of **0**; obtained using **OH_ArkUI_NodeEvent_GetNumberValue**.<br>value.i32: direction for deleting the text, with the index of **1**; obtained using **OH_ArkUI_NodeEvent_GetNumberValue**. The value **0** indicates backward-delete, and **1** indicates forward-delete.<br>buffer: string value of the text, with the index of **0**; obtained using **OH_ArkUI_NodeEvent_GetStringValue**.| 3840| NODE_TEXT_INPUT_ON_CHANGE_WITH_PREVIEW_TEXT | Defines the event triggered when content (including preview text) changes in the component.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_TextChangeEvent](_ark_u_i___text_change_event.md).<br>[ArkUI_TextChangeEvent](_ark_u_i___text_change_event.md) contains the following parameters:<br>**[ArkUI_TextChangeEvent.pStr](_ark_u_i___text_change_event.md#pstr)**: text content.<br>**[ArkUI_TextChangeEvent.pExtendStr](_ark_u_i___text_change_event.md#pextendstr)**: preview text content.<br>**[ArkUI_TextChangeEvent.number](_ark_u_i___text_change_event.md#number)**: position where the preview text is inserted.| 3841| NODE_TEXT_AREA_ON_CHANGE | Called when the input in the text box changes.<br> <br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md).<br>[ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md) contains the following parameters:<br>[ArkUI_StringAsyncEvent.pStr](_ark_u_i___string_async_event.md#pstr): text entered.| 3842| NODE_TEXT_AREA_ON_PASTE | Called when the paste button on the pasteboard, which displays when the text box is long pressed, is clicked.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md).<br>[ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md) contains the following parameters:<br>[ArkUI_StringAsyncEvent.pStr](_ark_u_i___string_async_event.md#pstr): text pasted.| 3843| NODE_TEXT_AREA_ON_TEXT_SELECTION_CHANGE | Called when the text selection position changes.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32: indicates the start position of the selected text.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32: end position of the text selection area.| 3844| NODE_TEXT_AREA_ON_EDIT_CHANGE | Called when the input status changes.<br>Condition for triggering this event: The input status changes.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32: **true** indicates that text input is in progress.| 3845| NODE_TEXT_AREA_ON_SUBMIT | Called when the Enter key on the keyboard is pressed for the multi-line text box.<br>This event is not triggered when **keyType** is **ARKUI_ENTER_KEY_TYPE_NEW_LINE**.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32: type of the Enter key.| 3846| NODE_TEXT_AREA_ON_INPUT_FILTER_ERROR | Called when matching with the regular expression specified by **NODE_TEXT_AREA_INPUT_FILTER** fails.<br> <br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md).<br>[ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md) contains the following parameters:<br>[ArkUI_StringAsyncEvent.pStr](_ark_u_i___string_async_event.md#pstr): content that is filtered out when regular expression matching fails.| 3847| NODE_TEXT_AREA_ON_CONTENT_SCROLL | Called when the text content is scrolled.<br>Condition for triggering this event: The text content is scrolled.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32: horizontal coordinate offset of the text in the content area.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32: offset in the Y coordinate of the text in the content area.| 3848| NODE_TEXT_AREA_ON_CONTENT_SIZE_CHANGE | Called when the text input content changes in the **TextArea**. component.<br> <br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].f32: indicates the width of the text.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].f32: height of the text.| 3849| NODE_TEXT_AREA_ON_WILL_INSERT | Called when text is about to be entered.<br>The event parameter is [ArkUI_NodeEvent](#arkui_nodeevent-12).<br>value.f32: position of the text, with the index of **0**; obtained using **OH_ArkUI_NodeEvent_GetNumberValue**.<br>buffer: string value of the text, with the index of **0**; obtained using **OH_ArkUI_NodeEvent_GetStringValue**.<br> <br>It returns **true** if the text is inserted; returns **false** otherwise. You can set the return value using **OH_ArkUI_NodeEvent_SetReturnNumberValue**.| 3850| NODE_TEXT_AREA_ON_DID_INSERT | Called when text is entered.<br>The event parameter is [ArkUI_NodeEvent](#arkui_nodeevent-12).<br>value.f32: position of the text, with the index of **0**; obtained using **OH_ArkUI_NodeEvent_GetNumberValue**.<br>buffer: string value of the text, with the index of **0**; obtained using **OH_ArkUI_NodeEvent_GetStringValue**.| 3851| NODE_TEXT_AREA_ON_WILL_DELETE | Called when text is about to be deleted.<br>The event parameter is [ArkUI_NodeEvent](#arkui_nodeevent-12).<br>value.f32: position of the text deleted, with the index of **0**; obtained using **OH_ArkUI_NodeEvent_GetNumberValue**.<br>value.i32: direction for deleting the text, with the index of **1**; obtained using **OH_ArkUI_NodeEvent_GetNumberValue**. The value **0** indicates backward-delete, and **1** indicates forward-delete.<br>buffer: string value of the text, with the index of **0**; obtained using **OH_ArkUI_NodeEvent_GetStringValue**.<br> <br>It returns **true** if the text is inserted; returns **false** otherwise.<br>You can set the return value using **OH_ArkUI_NodeEvent_SetReturnNumberValue**.| 3852| NODE_TEXT_AREA_ON_DID_DELETE | Called when text is deleted.<br>The event parameter is [ArkUI_NodeEvent](#arkui_nodeevent-12).<br>value.f32: position of the text deleted, with the index of **0**; obtained using **OH_ArkUI_NodeEvent_GetNumberValue**.<br>value.i32: direction for deleting the text, with the index of **1**; obtained using **OH_ArkUI_NodeEvent_GetNumberValue**. The value **0** indicates backward-delete, and **1** indicates forward-delete.<br>buffer: string value of the text, with the index of **0**; obtained using **OH_ArkUI_NodeEvent_GetStringValue**.| 3853| NODE_TEXT_AREA_ON_CHANGE_WITH_PREVIEW_TEXT | Defines the event triggered when content (including preview text) changes in the component.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_TextChangeEvent](_ark_u_i___text_change_event.md).<br>[ArkUI_TextChangeEvent](_ark_u_i___text_change_event.md) contains the following parameters:<br>**[ArkUI_TextChangeEvent.pStr](_ark_u_i___text_change_event.md#pstr)**: text content.<br>**[ArkUI_TextChangeEvent.pExtendStr](_ark_u_i___text_change_event.md#pextendstr)**: preview text content.<br>**[ArkUI_TextChangeEvent.number](_ark_u_i___text_change_event.md#number)**: position where the preview text is inserted.| 3854| NODE_CHECKBOX_EVENT_ON_CHANGE | Called when the selected status of the **ARKUI_NODE_CHECKBOX** component changes.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32: **1**: selected; **0**: not selected| 3855| NODE_DATE_PICKER_EVENT_ON_DATE_CHANGE | Called when a date is selected in the **ARKUI_NODE_DATE_PICKER** component.<br> <br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32: year of the selected date.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32: month of the selected date. Value range: 0–11.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[2].i32: day of the selected date.| 3856| NODE_TIME_PICKER_EVENT_ON_CHANGE | Called when a time is selected in the **ARKUI_NODE_TIME_PICKER** component.<br> <br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32: hour of the selected time. Value range: 0-23.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32: minute of the selected time. Value range: 0-59.| 3857| NODE_TEXT_PICKER_EVENT_ON_CHANGE | Called when an item is selected in the **ARKUI_NODE_TEXT_PICKER** component.<br> <br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0...11].i32: value of the selected item.| 3858| NODE_CALENDAR_PICKER_EVENT_ON_CHANGE | Called when a date is selected in the **NODE_CALENDAR_PICKER**.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>**ArkUI_NodeComponent.data[0].u32**: year of the selected date.<br>**ArkUI_NodeComponent.data[1].u32**: month of the selected date.<br>**ArkUI_NodeComponent.data[2].u32**: day of the selected date.| 3859| NODE_SLIDER_EVENT_ON_CHANGE | Called when the **ARKUI_NODE_SLIDER** component is dragged or clicked.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].f32: current slider value.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32: state triggered by the event.| 3860| NODE_RADIO_EVENT_ON_CHANGE | Called when the **ARKUI_NODE_RADIO** component is dragged or clicked.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32: status of the radio button.| 3861| NODE_CHECKBOX_GROUP_EVENT_ON_CHANGE | Defines the event triggered when the selection state of **ARKUI_NODE_CHECKBOX_GROUP** or any check box in the group changes.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md).<br>[ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md) contains the following parameters:<br>**[ArkUI_StringAsyncEvent.pStr](_ark_u_i___string_async_event.md#pstr)**:<br>Name: name of the selected check box.<br>Status: **0**: All check boxes in the group are selected. **1**: Some check boxes in the group are selected. **2**: No check box in the group is selected.| 3862| NODE_IMAGE_ANIMATOR_EVENT_ON_START | Called when the frame-by-frame animation starts to play.<br> <br> <br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) does not contain parameters.| 3863| NODE_IMAGE_ANIMATOR_EVENT_ON_PAUSE | Called when the frame-by-frame animation playback is paused.<br> <br> <br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) does not contain parameters.| 3864| NODE_IMAGE_ANIMATOR_EVENT_ON_REPEAT | Called when the frame-by-frame animation playback is repeated.<br> <br> <br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) does not contain parameters.| 3865| NODE_IMAGE_ANIMATOR_EVENT_ON_CANCEL | Called when the frame-by-frame animation playback returns to the initial state.<br> <br> <br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) does not contain parameters.| 3866| NODE_IMAGE_ANIMATOR_EVENT_ON_FINISH | Called when the frame-by-frame animation playback is complete or stopped.<br> <br> <br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) does not contain parameters.| 3867| NODE_SWIPER_EVENT_ON_CHANGE | Called when the index of the currently displayed element of this **ARKUI_NODE_SWIPER** instance changes.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32: index of the currently displayed element.| 3868| NODE_SWIPER_EVENT_ON_ANIMATION_START | Called when the switching animation of this **ARKUI_NODE_SWIPER** instance starts.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32: index of the currently displayed element.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32: index of the target element to switch to.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[2].f32: offset of the currently displayed element relative to the start position of the swiper along the main axis.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[3].f32: offset of the target element relative to the start position of the swiper along the main axis.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[4].f32: hands-off velocity.| 3869| NODE_SWIPER_EVENT_ON_ANIMATION_END | Called when the switching animation of this **ARKUI_NODE_SWIPER** instance ends.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32: index of the currently displayed element.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].f32: offset of the currently displayed element relative to the start position of the swiper along the main axis.| 3870| NODE_SWIPER_EVENT_ON_GESTURE_SWIPE | Triggered on a frame-by-frame basis when the page is turned by a swipe.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32: index of the currently displayed element.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].f32: offset of the currently displayed element relative to the start position of the swiper along the main axis.| 3871| NODE_SWIPER_EVENT_ON_CONTENT_DID_SCROLL | Called when content in the **ARKUI_NODE_SWIPER** component scrolls. Instructions:<br>1. When [ArkUI_SwiperDisplayModeType](#arkui_swiperdisplaymodetype) is set to ARKUI_SWIPER_DISPLAY_MODE_AUTO_LINEAR, this API does not take effect.<br>2. This API does not work when **prevMargin** and **nextMargin** are set in such a way that the **Swiper** frontend and backend display the same page during loop playback.<br>3. During page scrolling, the </b>ContentDidScrollCallback</b> callback is invoked for all pages in the viewport on a frame-by-frame basis.<br>For example, when there are two pages whose subscripts are 0 and 1 in the viewport, two callbacks whose indexes are 0 and 1 are invoked in each frame.<br>4. When the swipeByGroup parameter of the displayCount attribute is set to true and at least one page in the same group is in the window:<br>Callback is triggered for all pages in the same group.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32: index of the Swiper component, which is the same as the index value in the onChange event.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32: index of a page in the window.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[2].f32: moving ratio of the page relative to the start position of the Swiper major axis (the start position of the page corresponding to selectedIndex).<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[3].f32: page length in the principal axis direction.| 3872| NODE_SWIPER_EVENT_ON_SELECTED<sup>18+</sup> | Defines the event triggered when the selection changes in the **ARKUI_NODE_SWIPER**.<br>**NOTE**<br>1. When the page switching animation starts after the user lifts their finger after swiping and the swipe meets the threshold for page turning.<br>2. When the page is changed programmatically using either **NODE_SWIPER_INDEX** or **NODE_SWIPER_SWIPE_TO_INDEX**.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32**: index of the currently selected element.| 3873| NODE_SWIPER_EVENT_ON_UNSELECTED<sup>16+</sup> | Defines the event triggered when the selection changes in the **ARKUI_NODE_SWIPER**.<br>**NOTE**<br>1. When the page switching animation starts after the user lifts their finger after swiping and the swipe meets the threshold for page turning.<br>2. When the page is changed programmatically using either **NODE_SWIPER_INDEX** or **NODE_SWIPER_SWIPE_TO_INDEX**.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32: index of the item that is about to be hidden.| 3874| NODE_SWIPER_EVENT_ON_CONTENT_WILL_SCROLL<sup>15+</sup> | Defines the event for intercepting swipe behavior in the **Swiper** component. Instructions:<br>1. This event is only triggered by gesture operations, including finger swipes, scrolling the mouse wheel, and moving focus using keyboard arrow keys.<br>2. During finger swipes, the event is triggered for each frame. The system uses the return value of the event to determine whether to respond to the swipe for each frame.<br>3. For scrolling the mouse wheel and moving focus using keyboard arrow keys, the event is triggered once per page turning. The system uses the return value to decide whether to allow the page turning.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32: index of the current page. During a finger swipe, this value remains constant as long as the finger is on the screen, even if the page has completely moved out of view.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32: index of the page that will be displayed in the direction of the swipe.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[2].f32: translation of the swipe, with a sign indicating the direction. A positive value indicates a swipe from index=1 to index=0, while a negative value indicates a swipe from index=0 to index=1.<br>This value represents the offset for each frame during a finger swipe and the distance for page turning when the mouse wheel or keyboard navigation is used.<br>The [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) parameter contains the following return value:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32: whether to allow the swipe. The **Swiper** component will use this return value to decide whether to respond to the swipe.| 3875| NODE_SCROLL_EVENT_ON_SCROLL | Defines the scrolling event enumeration values of the scrolling container component.<br>**NOTE**<br>1. This event is triggered when scrolling is started by the **Scroll** component or other input settings, such as keyboard and mouse operations.<br>2. This event is triggered when the controller API is called.<br>3. This event supports the out-of-bounds bounce effect.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].f32: horizontal scrolling offset.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].f32: vertical scrolling offset.| 3876| NODE_SCROLL_EVENT_ON_SCROLL_FRAME_BEGIN | Called when the container starts scrolling.<br>**NOTE**<br>1. This event is triggered when scrolling is started by the **Scroll** component or other input settings, such as keyboard and mouse operations.<br>2. This event is not triggered when the controller API is called.<br>3. This event does not support the out-of-bounds bounce effect.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].f32: indicates the upcoming scrolling amount.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32: current scroll state.<br>The [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) parameter contains the following return value:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].f32: The event handler can work out the amount by which the component needs to scroll based on the real-world situation and return the result in this parameter.| 3877| NODE_SCROLL_EVENT_ON_WILL_SCROLL | Called when the container is about to scroll.<br>**NOTE**<br>1. This event is triggered when scrolling is started by the **Scroll** component or other input settings, such as keyboard and mouse operations.<br>2. This event is triggered when the controller API is called.<br>3. This event supports the out-of-bounds bounce effect.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].f32:: scrolling offset of each frame. The offset is positive when the content scrolls leftwards and negative when the content scrolls rightwards. The unit is vp.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].f32: Scrolling offset of each frame. The offset is positive when the content scrolls up and negative when the content scrolls down. The unit is vp.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[2].i32: current scroll state. The parameter type is [ArkUI_ScrollState](#arkui_scrollstate).<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[3].i32: scroll source. The parameter type is [ArkUI_ScrollSource](#arkui_scrollsource).<br>**Returns**<br>Returns one or no number to indicate the actual amount by which the scroll component scrolls.| 3878| NODE_SCROLL_EVENT_ON_DID_SCROLL | Called when the container scrolls.<br>**NOTE**<br>1. This event is triggered when scrolling is started by the **Scroll** component or other input settings, such as keyboard and mouse operations.<br>2. This event is triggered when the controller API is called.<br>3. This event supports the out-of-bounds bounce effect.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].f32:: scrolling offset of each frame. The offset is positive when the content scrolls leftwards and negative when the content scrolls rightwards. The unit is vp.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].f32: Scrolling offset of each frame. The offset is positive when the content scrolls up and negative when the content scrolls down. The unit is vp.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[2].i32: current scroll state. The parameter type is [ArkUI_ScrollState](#arkui_scrollstate).| 3879| NODE_SCROLL_EVENT_ON_SCROLL_START | Called when the container starts scrolling.<br>**NOTE**<br>1. This event is triggered when scrolling is started by the **Scroll** component or other input settings, such as keyboard and mouse operations.<br>2. This event is triggered when the controller API is called, accompanied by a transition animation.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) does not contain parameters.| 3880| NODE_SCROLL_EVENT_ON_SCROLL_STOP | Called when the container stops scrolling.<br>**NOTE**<br>1. This event is triggered when scrolling is stopped by the **Scroll** component or other input settings, such as keyboard and mouse operations.<br>2. This event is triggered when the controller API is called, accompanied by a transition animation.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) does not contain parameters.| 3881| NODE_SCROLL_EVENT_ON_SCROLL_EDGE | Defines the scrolling edge event enumeration values of the scrolling container component.<br>**NOTE**<br>1. This event is triggered when scrolling reaches the edge after being started by the **Scroll** component or other input settings, such as keyboard and mouse operations.<br>2. This event is triggered when the controller API is called.<br>3. This event supports the out-of-bounds bounce effect.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32 indicates the top, bottom, left, and right edges that are touched.| 3882| NODE_SCROLL_EVENT_ON_REACH_START | Called when the container reaches the start edge.<br>**NOTE**<br>This event is triggered when scrolling hits the start edge.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) does not contain parameters.| 3883| NODE_SCROLL_EVENT_ON_REACH_END | Called when the container reaches the end edge.<br>**NOTE**<br>This event is triggered when scrolling hits the end edge.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) does not contain parameters.| 3884| NODE_LIST_ON_SCROLL_INDEX | Called when a child component enters or leaves the list display area.<br>**NOTE**<br>This event is triggered once when the list is initialized and when the index of the first child component or the next child component in the list display area changes.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32: index of the first child component in the list display area.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32: index of the last child component in the list display area.<br>**[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[2].i32**: index of the center child component in the list display area.| 3885| NODE_LIST_ON_WILL_SCROLL | Called when the list is about to scroll.<br>**NOTE**<br>1. This event is triggered when scrolling is started by the **Scroll** component or other input settings, such as keyboard and mouse operations.<br>2. This event is triggered when the controller API is called.<br>3. This event supports the out-of-bounds bounce effect.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].f32: Scrolling offset of each frame. When the list content scrolls up, the offset is positive. When the list content scrolls down, the offset is negative.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32: current scroll state. The parameter type is [ArkUI_ScrollState](#arkui_scrollstate).<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[2].i32: scroll source. The parameter type is [ArkUI_ScrollSource](#arkui_scrollsource).<br>**Returns**<br>Returns one or no number to indicate the actual amount by which the scroll component scrolls.| 3886| NODE_LIST_ON_DID_SCROLL | Called when the list scrolls.<br>**NOTE**<br>1. This event is triggered when scrolling is started by the **Scroll** component or other input settings, such as keyboard and mouse operations.<br>2. This event is triggered when the controller API is called.<br>3. This event supports the out-of-bounds bounce effect.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].f32: scroll offset of each frame. The offset is positive when the list is scrolled up and negative when the list is scrolled down.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32: current scroll state.| 3887| NODE_LIST_ON_SCROLL_VISIBLE_CONTENT_CHANGE | Called when a child component enters or leaves the list display area. During index calculation, the list item, header of the list item group, and footer of the list item group each are counted as a child component. When the list edge scrolling effect is the spring effect, the **NODE_LIST_ON_SCROLL_VISIBLE_CONTENT_CHANGE** event is not triggered when the user scrolls the list to the edge or releases the list to rebound.<br>**NOTE**<br> This event is triggered once when the list is initialized and when the index of the first child component or the next child component in the list display area changes.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32: index of the first child component in the list display area.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32: area in the list item group where the list display area starts. The parameter type is [ArkUI_ListItemGroupArea](#arkui_listitemgrouparea).<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[2].i32: index of the list item at the start of the list display area in the list item group. If the start of the list display area is not on a list item, the value is **1**.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[3].i32: index of the last child component in the list display area.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[4].i32: area in the list item group where the list display area ends. The parameter type is [ArkUI_ListItemGroupArea](#arkui_listitemgrouparea).<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[5].i32: index of the list item at the end of the list display area in the list item group. If the end of the list display area is not on a list item, the value is **1**.| 3888| NODE_REFRESH_STATE_CHANGE | Called when the refresh state of the **ARKUI_NODE_REFRESH** object changes.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32: refresh state.| 3889| NODE_REFRESH_ON_REFRESH | Called when the **ARKUI_NODE_REFRESH** object enters the refresh state.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) does not contain parameters.| 3890| NODE_REFRESH_ON_OFFSET_CHANGE | Called when the pull-down distance of the **ARKUI_NODE_REFRESH** object changes.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].f32: pull-down distance.| 3891| NODE_ON_WILL_SCROLL | Called when the water flow container is about to scroll.<br>**NOTE**<br>1. This event is triggered when scrolling is started by the **Scroll** component or other input settings, such as keyboard and mouse operations.<br>2. This event is triggered when the controller API is called.<br>3. This event supports the out-of-bounds bounce effect.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].f32: scroll offset of each frame. The offset is positive when the component is scrolled up and negative when the component is scrolled down.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32: current scroll state. The parameter type is [ArkUI_ScrollState](#arkui_scrollstate).<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[2].i32: scroll source. The parameter type is [ArkUI_ScrollSource](#arkui_scrollsource).<br>**Returns**<br>Returns one or no number to indicate the actual amount by which the scroll component scrolls.| 3892| NODE_WATER_FLOW_ON_DID_SCROLL | Called when the water flow container scrolls.<br>**NOTE**<br>1. This event is triggered when scrolling is started by the **Scroll** component or other input settings, such as keyboard and mouse operations.<br>2. This event is triggered when the controller API is called.<br>3. This event supports the out-of-bounds bounce effect.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].f32: Offset of scrolling each frame. The offset is positive when the content scrolls up and negative when the content scrolls down.<br>Current sliding status of the [ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32:.| 3893| NODE_WATER_FLOW_ON_SCROLL_INDEX | Called when the first or last item displayed in the water flow container changes.<br>**NOTE**<br>This event is triggered when either of the preceding indexes changes.<br>When the event callback occurs, the union type in the [ArkUI_NodeEvent](#arkui_nodeevent-12) object is [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md).<br>[ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) contains the following parameters:<br>Index of the start position of the water flow displayed on the [ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[0].i32:.<br>Index of the end position of the waterfall currently displayed on the [ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].i32:.| 3894 3895 3896### ArkUI_NodeType 3897 3898``` 3899enum ArkUI_NodeType 3900``` 3901**Description** 3902 3903Enumerates ArkUI component types that can be created on the native side. 3904 3905**Since**: 12 3906 3907| Enum| Description| 3908| -------- | -------- | 3909| ARKUI_NODE_CUSTOM | *Custom nodes* | 3910| ARKUI_NODE_TEXT | Text to insert. | 3911| ARKUI_NODE_SPAN | Text span. | 3912| ARKUI_NODE_IMAGE_SPAN | Image span. | 3913| ARKUI_NODE_IMAGE | Image. | 3914| ARKUI_NODE_TOGGLE | Toggle. | 3915| ARKUI_NODE_LOADING_PROGRESS | Loading icon. | 3916| ARKUI_NODE_TEXT_INPUT | Single-line text input. | 3917| ARKUI_NODE_TEXT_AREA | Multi-line text input. | 3918| ARKUI_NODE_BUTTON | Icon | 3919| ARKUI_NODE_PROGRESS | Progress indicator. | 3920| ARKUI_NODE_CHECKBOX | Check box. | 3921| ARKUI_NODE_XCOMPONENT | XComponent of the SURFACE type. | 3922| ARKUI_NODE_DATE_PICKER | Date picker. | 3923| ARKUI_NODE_TIME_PICKER | Time picker. | 3924| ARKUI_NODE_TEXT_PICKER | Text picker. | 3925| ARKUI_NODE_CALENDAR_PICKER | Calendar picker. | 3926| ARKUI_NODE_SLIDER | Slider. | 3927| ARKUI_NODE_RADIO | Radio button. | 3928| ARKUI_NODE_IMAGE_ANIMATOR | Frame animation component. | 3929| ARKUI_NODE_XCOMPONENT_TEXTURE | XComponent of the TEXTURE type. | 3930| ARKUI_NODE_CHECKBOX_GROUP | Check box group.| 3931| ARKUI_NODE_STACK | Stack container. | 3932| ARKUI_NODE_SWIPER | Swiper. | 3933| ARKUI_NODE_SCROLL | Scrolling container. | 3934| ARKUI_NODE_LIST | List. | 3935| ARKUI_NODE_LIST_ITEM | List item. | 3936| ARKUI_NODE_LIST_ITEM_GROUP | List item group. | 3937| ARKUI_NODE_COLUMN | Column container. | 3938| ARKUI_NODE_ROW | Row container. | 3939| ARKUI_NODE_FLEX | Flex container. | 3940| ARKUI_NODE_REFRESH | Refresh component. | 3941| ARKUI_NODE_WATER_FLOW | Water flow container. | 3942| ARKUI_NODE_FLOW_ITEM | Water flow item. | 3943| ARKUI_NODE_RELATIVE_CONTAINER | Relative layout component. | 3944| ARKUI_NODE_GRID | Grid. | 3945| ARKUI_NODE_GRID_ITEM | Grid item. | 3946| ARKUI_NODE_CUSTOM_SPAN | Custom span. | 3947 3948 3949### ArkUI_ObjectFit 3950 3951``` 3952enum ArkUI_ObjectFit 3953``` 3954**Description** 3955 3956Enumerates the image filling effects. ImageSpanAlignment 3957 3958**Since**: 12 3959 3960| Enum| Description| 3961| -------- | -------- | 3962| ARKUI_OBJECT_FIT_CONTAIN | The image is scaled with its aspect ratio retained for the content to be completely displayed within the display boundaries. | 3963| ARKUI_OBJECT_FIT_COVER | The image is scaled with its aspect ratio retained for both sides to be greater than or equal to the display boundaries. | 3964| ARKUI_OBJECT_FIT_AUTO | The image is scaled automatically to fit the display area. | 3965| ARKUI_OBJECT_FIT_FILL | The image is scaled to fill the display area, and its aspect ratio is not retained. | 3966| ARKUI_OBJECT_FIT_SCALE_DOWN | The image is displayed with its aspect ratio retained, in a size smaller than or equal to the original size. | 3967| ARKUI_OBJECT_FIT_NONE | The original size is retained. | 3968| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_TOP_START | Not resized, the image is aligned with the start edge of the top of the container. | 3969| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_TOP | Not resized, the image is horizontally centered at the top of the container. | 3970| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_TOP_END | Not resized, the image is aligned with the end edge at the top of the container. | 3971| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_START | Not resized, the image is vertically centered on the start edge of the container. | 3972| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_CENTER | Not resized, the image is horizontally and vertically centered in the container. | 3973| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_END | Not resized, the image is vertically centered on the end edge of the container. | 3974| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_BOTTOM_START | Not resized, the image is aligned with the start edge at the bottom of the container. | 3975| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_BOTTOM | Not resized, the image is horizontally centered at the bottom of the container. | 3976| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_BOTTOM_END | Not resized, the image is aligned with the end edge at the bottom of the container. | 3977 3978 3979### ArkUI_PageFlipMode 3980 3981``` 3982enum ArkUI_PageFlipMode 3983``` 3984**Description** 3985 3986Enumerates the page flipping modes using the mouse wheel for the <b>Swiper</b> component. 3987 3988**Since**: 14 3989 3990| Enum| Description| 3991| -------- | -------- | 3992| ARKUI_PAGE_FLIP_MODE_CONTINUOUS | When the mouse wheel is scrolled continuously, multiple pages are flipped, which is determined by the number of times that mouse events are reported. | 3993| ARKUI_PAGE_FLIP_MODE_SINGLE | The system does not respond to other mouse wheel events until the page flipping animation ends. | 3994 3995 3996### ArkUI_SwiperAnimationMode 3997 3998``` 3999enum ArkUI_SwiperAnimationMode 4000``` 4001**Description** 4002 4003Enumerates the animation modes for the **Swiper** component when jumping to the page with the specified index. 4004 4005**Since**: 15 4006 4007| Enum| Description| 4008| -------- | -------- | 4009| ARKUI_SWIPER_NO_ANIMATION | Jumps to the target page without any animation. | 4010| ARKUI_SWIPER_DEFAULT_ANIMATION | Animates smoothly to the target page. | 4011| ARKUI_SWIPER_FAST_ANIMATION | First jumps to a position near the target page without animation, then animates to the target page. | 4012 4013 4014### ArkUI_PreDragStatus 4015 4016``` 4017enum ArkUI_PreDragStatus 4018``` 4019**Description** 4020 4021Defines an enum for interaction states prior to a drop and drop operation. 4022 4023**Since**: 12 4024 4025| Enum| Description| 4026| -------- | -------- | 4027| ARKUI_PRE_DRAG_STATUS_UNKNOWN | Unknown. | 4028| ARKUI_PRE_DRAG_STATUS_ACTION_DETECTING | A drag gesture is being detected. | 4029| ARKUI_PRE_DRAG_STATUS_READY_TO_TRIGGER_DRAG | The component is ready to be dragged. | 4030| ARKUI_PRE_DRAG_STATUS_PREVIEW_LIFT_STARTED | A lift animation is started. | 4031| ARKUI_PRE_DRAG_STATUS_PREVIEW_LIFT_FINISHED | A lift animation is finished. | 4032| ARKUI_PRE_DRAG_STATUS_PREVIEW_LANDING_STARTED | A drop animation is started. | 4033| ARKUI_PRE_DRAG_STATUS_PREVIEW_LANDING_FINISHED | A drop animation is finished. | 4034| ARKUI_PRE_DRAG_STATUS_CANCELED_BEFORE_DRAG | A drop animation is terminated. | 4035 4036 4037### ArkUI_ProgressType 4038 4039``` 4040enum ArkUI_ProgressType 4041``` 4042**Description** 4043 4044Enumerates the styles of the progress indicator. 4045 4046**Since**: 12 4047 4048| Enum| Description| 4049| -------- | -------- | 4050| ARKUI_PROGRESS_TYPE_LINEAR | Linear type. | 4051| ARKUI_PROGRESS_TYPE_RING | Indeterminate ring style. | 4052| ARKUI_PROGRESS_TYPE_ECLIPSE | Eclipse style. | 4053| ARKUI_PROGRESS_TYPE_SCALE_RING | Determinate ring style. | 4054| ARKUI_PROGRESS_TYPE_CAPSULE | Capsule style. | 4055 4056 4057### ArkUI_RelativeLayoutChainStyle 4058 4059``` 4060enum ArkUI_RelativeLayoutChainStyle 4061``` 4062**Description** 4063 4064Enumerates the chain styles. 4065 4066**Since**: 12 4067 4068| Enum| Description| 4069| -------- | -------- | 4070| ARKUI_RELATIVE_LAYOUT_CHAIN_STYLE_SPREAD | Child components are evenly distributed among constraint anchors. | 4071| ARKUI_RELATIVE_LAYOUT_CHAIN_STYLE_SPREAD_INSIDE | All child components except the first and last ones are evenly distributed among constraint anchors. | 4072| ARKUI_RELATIVE_LAYOUT_CHAIN_STYLE_PACKED | There is no gap between child components in the chain. | 4073 4074 4075### ArkUI_RenderFit 4076 4077``` 4078enum ArkUI_RenderFit 4079``` 4080 4081| Enum| Description| 4082| -------- | -------- | 4083| ARKUI_RENDER_FIT_CENTER | The component's content stays at the final size and always aligned with the center of the component. | 4084| ARKUI_RENDER_FIT_TOP | The component's content stays at the final size and always aligned with the top center of the component. | 4085| ARKUI_RENDER_FIT_BOTTOM | The component's content stays at the final size and always aligned with the bottom center of the component. | 4086| ARKUI_RENDER_FIT_LEFT | The component's content stays at the final size and always aligned with the left of the component. | 4087| ARKUI_RENDER_FIT_RIGHT | The component's content stays at the final size and always aligned with the right of the component. | 4088| ARKUI_RENDER_FIT_TOP_LEFT | The component's content stays at the final size and always aligned with the upper left corner of the component. | 4089| ARKUI_RENDER_FIT_TOP_RIGHT | The component's content stays at the final size and always aligned with the upper right corner of the component. | 4090| ARKUI_RENDER_FIT_BOTTOM_LEFT | The component's content stays at the final size and always aligned with the lower left corner of the component. | 4091| ARKUI_RENDER_FIT_BOTTOM_RIGHT | The component's content stays at the final size and always aligned with the lower right corner of the component. | 4092| ARKUI_RENDER_FIT_RESIZE_FILL | The component's content is always resized to fill the component's content box, without considering its aspect ratio in the final state. | 4093| ARKUI_RENDER_FIT_RESIZE_CONTAIN | While maintaining its aspect ratio in the final state, the component's content is scaled to fit within the component's content box. It is always aligned with the center of the component. | 4094| ARKUI_RENDER_FIT_RESIZE_CONTAIN_TOP_LEFT | While maintaining its aspect ratio in the final state, the component's content is scaled to fit within the component's content box. When there is remaining space in the width direction of the component, the content is left-aligned with the component. When there is remaining space in the height direction of the component, the content is top-aligned with the component. | 4095| ARKUI_RENDER_FIT_RESIZE_CONTAIN_BOTTOM_RIGHT | While maintaining its aspect ratio in the final state, the component's content is scaled to fit within the component's content box. When there is remaining space in the width direction of the component, the content is right-aligned with the component. When there is remaining space in the height direction of the component, the content is bottom-aligned with the component. | 4096| ARKUI_RENDER_FIT_RESIZE_COVER | While maintaining its aspect ratio in the final state, the component's content is scaled to cover the component's entire content box. It is always aligned with the center of the component, so that its middle part is displayed. | 4097| ARKUI_RENDER_FIT_RESIZE_COVER_TOP_LEFT | While maintaining its aspect ratio in the final state, the component's content is scaled to cover the component's entire content box. When there is remaining space in the width direction, the content is left-aligned with the component, so that its left part is displayed. When there is remaining space in the height direction, the content is top-aligned with the component, so that its top part is displayed. | 4098| ARKUI_RENDER_FIT_RESIZE_COVER_BOTTOM_RIGHT | While maintaining its aspect ratio in the final state, the component's content is scaled to cover the component's entire content box. When there is remaining space in the width direction, the content is right-aligned with the component, so that its right part is displayed. When there is remaining space in the height direction, the content is bottom-aligned with the component, so that its bottom part is displayed. | 4099 4100 4101### ArkUI_RouterPageState 4102 4103``` 4104enum ArkUI_RouterPageState 4105``` 4106**Description** 4107 4108Enumerates the states of a page during routing. 4109 4110**Since**: 12 4111 4112| Enum| Description| 4113| -------- | -------- | 4114| ARKUI_ROUTER_PAGE_STATE_ON_WILL_APPEAR | The page is about to be displayed. | 4115| ARKUI_ROUTER_PAGE_STATE_ON_WILL_DISAPPEAR | The page is about to be destroyed. | 4116| ARKUI_ROUTER_PAGE_STATE_ON_SHOW | The page is displayed. | 4117| ARKUI_ROUTER_PAGE_STATE_ON_HIDE | The page is hidden. | 4118| ARKUI_ROUTER_PAGE_STATE_ON_BACK_PRESS | The back button is pressed for the page. | 4119 4120 4121### ArkUI_SafeAreaEdge 4122 4123``` 4124enum ArkUI_SafeAreaEdge 4125``` 4126**Description** 4127 4128Enumerates the edges for expanding the safe area. 4129 4130**Since**: 12 4131 4132| Enum| Description| 4133| -------- | -------- | 4134| ARKUI_SAFE_AREA_EDGE_TOP | Top edge. | 4135| ARKUI_SAFE_AREA_EDGE_BOTTOM | Bottom edge. | 4136| ARKUI_SAFE_AREA_EDGE_START | Start edge. | 4137| ARKUI_SAFE_AREA_EDGE_END | End edge. | 4138 4139 4140### ArkUI_SafeAreaType 4141 4142``` 4143enum ArkUI_SafeAreaType 4144``` 4145**Description** 4146 4147Enumerates the types of expanded safe areas. 4148 4149**Since**: 12 4150 4151| Enum| Description| 4152| -------- | -------- | 4153| ARKUI_SAFE_AREA_TYPE_SYSTEM | Default non-safe area of the system, including the status bar and navigation bar. | 4154| ARKUI_SAFE_AREA_TYPE_CUTOUT | Non-safe area of the device, for example, the notch area. | 4155| ARKUI_SAFE_AREA_TYPE_KEYBOARD | Soft keyboard area. | 4156 4157 4158### ArkUI_ListItemGroupArea 4159 4160``` 4161enum ArkUI_ListItemGroupArea 4162``` 4163**Description** 4164 4165Enumerates the component areas. 4166 4167**Since**: 15 4168 4169| Enum| Description| 4170| -------- | -------- | 4171| ARKUI_LIST_ITEM_GROUP_AREA_OUTSIDE | Outside the component area. | 4172| ARKUI_LIST_ITEM_SWIPE_AREA_NONE | Area when the component has no header, footer, or list items. | 4173| ARKUI_LIST_ITEM_SWIPE_AREA_ITEM | Area of the component's list items. | 4174| ARKUI_LIST_ITEM_SWIPE_AREA_HEADER | Header area of the component. | 4175| ARKUI_LIST_ITEM_SWIPE_AREA_FOOTER | Footer area of the component. | 4176 4177 4178### ArkUI_FocusMove 4179 4180``` 4181enum ArkUI_FocusMove 4182``` 4183**Description** 4184 4185Enumerates the focus movement directions. 4186 4187**Since**: 18 4188 4189| Enum| Description| 4190| -------- | -------- | 4191| ARKUI_FOCUS_MOVE_FORWARD | Tab key. | 4192| ARKUI_FOCUS_MOVE_BACKWARD | Shift+Tab key. | 4193| ARKUI_FOCUS_MOVE_UP | Up arrow key. | 4194| ARKUI_FOCUS_MOVE_DOWN | Down arrow key. | 4195| ARKUI_FOCUS_MOVE_LEFT | Left arrow key. | 4196| ARKUI_FOCUS_MOVE_RIGHT | Right arrow key. | 4197 4198### ArkUI_ScrollAlignment 4199 4200``` 4201enum ArkUI_ScrollAlignment 4202``` 4203**Description** 4204 4205Defines how the list item to scroll to is aligned with the container. 4206 4207**Since**: 12 4208 4209| Enum| Description| 4210| -------- | -------- | 4211| ARKUI_SCROLL_ALIGNMENT_START | The start edge of the list item is flush with the start edge of the container. | 4212| ARKUI_SCROLL_ALIGNMENT_CENTER | The list item is centered along the main axis of the list. | 4213| ARKUI_SCROLL_ALIGNMENT_END | The end edge of the list item Aligns the tail of an item with that of a container. | 4214| ARKUI_SCROLL_ALIGNMENT_AUTO | The list item is automatically aligned. If the item is fully contained within the display area, no adjustment is performed. Otherwise, the item is aligned so that its start or end edge is flush with the start or end edge of the container, whichever requires a shorter scrolling distance. | 4215 4216 4217### ArkUI_ScrollBarDisplayMode 4218 4219``` 4220enum ArkUI_ScrollBarDisplayMode 4221``` 4222**Description** 4223 4224Enumerates the scrollbar display modes. 4225 4226**Since**: 12 4227 4228| Enum| Description| 4229| -------- | -------- | 4230| ARKUI_SCROLL_BAR_DISPLAY_MODE_OFF | Not displayed. | 4231| ARKUI_SCROLL_BAR_DISPLAY_MODE_AUTO | Displayed when the screen is touched and hidden after 2s. | 4232| ARKUI_SCROLL_BAR_DISPLAY_MODE_ON | Always displayed. | 4233 4234 4235### ArkUI_ScrollDirection 4236 4237``` 4238enum ArkUI_ScrollDirection 4239``` 4240**Description** 4241 4242Enumerates the scroll directions of scrollable components. 4243 4244**Since**: 12 4245 4246| Enum| Description| 4247| -------- | -------- | 4248| ARKUI_SCROLL_DIRECTION_VERTICAL | Only vertical scrolling is supported. | 4249| ARKUI_SCROLL_DIRECTION_HORIZONTAL | Only horizontal scrolling is supported. | 4250| ARKUI_SCROLL_DIRECTION_NONE | Scrolling is forbidden. | 4251 4252 4253### ArkUI_ScrollEdge 4254 4255``` 4256enum ArkUI_ScrollEdge 4257``` 4258**Description** 4259 4260Defines the edge to which the component scrolls. 4261 4262**Since**: 12 4263 4264| Enum| Description| 4265| -------- | -------- | 4266| ARKUI_SCROLL_EDGE_TOP | Top edge in the vertical direction. | 4267| ARKUI_SCROLL_EDGE_BOTTOM | Bottom edge in the vertical direction. | 4268| ARKUI_SCROLL_EDGE_START | Start position in the horizontal direction. | 4269| ARKUI_SCROLL_EDGE_END | End position in the horizontal direction. | 4270 4271 4272### ArkUI_ScrollNestedMode 4273 4274``` 4275enum ArkUI_ScrollNestedMode 4276``` 4277**Description** 4278 4279Enumerates nested scrolling options. 4280 4281**Since**: 12 4282 4283| Enum| Description| 4284| -------- | -------- | 4285| ARKUI_SCROLL_NESTED_MODE_SELF_ONLY | The scrolling is contained within the component, and no scroll chaining occurs, that is, the parent component does not scroll when the component scrolling reaches the boundary. | 4286| ARKUI_SCROLL_NESTED_MODE_SELF_FIRST | The component scrolls first, and when it hits the boundary, the parent component scrolls. When the parent component hits the boundary, its edge effect is displayed. If no edge effect is specified for the parent component, the edge effect of the child component is displayed instead. | 4287| ARKUI_SCROLL_NESTED_MODE_PARENT_FIRST | The parent component scrolls first, and when it hits the boundary, the component scrolls. When the component hits the boundary, its edge effect is displayed. If no edge effect is specified for the component, the edge effect of the parent component is displayed instead. | 4288| ARKUI_SCROLL_NESTED_MODE_PARALLEL | The component and its parent component scroll at the same time. When both the component and its parent component hit the boundary, the edge effect of the component is displayed. If no edge effect is specified for the component, the edge effect of the parent component is displayed instead. | 4289 4290 4291### ArkUI_ScrollSnapAlign 4292 4293``` 4294enum ArkUI_ScrollSnapAlign 4295``` 4296**Description** 4297 4298Enumerates the alignment modes of list items when scrolling ends. 4299 4300**Since**: 12 4301 4302| Enum| Description| 4303| -------- | -------- | 4304| ARKUI_SCROLL_SNAP_ALIGN_NONE | No alignment. This is the default value. | 4305| ARKUI_SCROLL_SNAP_ALIGN_START | The first item in the view is aligned at the start of the list. | 4306| ARKUI_SCROLL_SNAP_ALIGN_CENTER | The middle items in the view are aligned in the center of the list. | 4307| ARKUI_SCROLL_SNAP_ALIGN_END | The last item in the view is aligned at the end of the list. | 4308 4309 4310### ArkUI_ScrollSource 4311 4312``` 4313enum ArkUI_ScrollSource 4314``` 4315**Description** 4316 4317Enumerates the scrolling sources. 4318 4319**Since**: 12 4320 4321| Enum| Description| 4322| -------- | -------- | 4323| ARKUI_SCROLL_SOURCE_DRAG | Drag your finger. | 4324| ARKUI_SCROLL_SOURCE_FLING | Inertia scrolling after finger dragging. | 4325| ARKUI_SCROLL_SOURCE_EDGE_EFFECT | Executes the EdgeEffect.Spring edge special effect when the boundary is crossed. | 4326| ARKUI_SCROLL_SOURCE_OTHER_USER_INPUT | User input other than dragging, such as mouse wheel and keyboard events. | 4327| ARKUI_SCROLL_SOURCE_SCROLL_BAR | Scrollbar dragging | 4328| ARKUI_SCROLL_SOURCE_SCROLL_BAR_FLING | Inertial scrolling after the scroll bar is dragged. | 4329| ARKUI_SCROLL_SOURCE_SCROLLER | Scrolling by the scroll controller (without animation). | 4330| ARKUI_SCROLL_SOURCE_ANIMATION | Scrolling by the scroll controller (with animation). | 4331 4332 4333### ArkUI_ScrollState 4334 4335``` 4336enum ArkUI_ScrollState 4337``` 4338**Description** 4339 4340Enumerates the scrolling states. 4341 4342**Since**: 12 4343 4344| Enum| Description| 4345| -------- | -------- | 4346| ARKUI_SCROLL_STATE_IDLE | Idle. The container enters this state when an API in the controller is used to scroll the container or when the scrollbar is dragged. | 4347| ARKUI_SCROLL_STATE_SCROLL | Scrolling. The container enters this state when the user drags the container to scroll. | 4348| ARKUI_SCROLL_STATE_FLING | Inertial scrolling. The container enters this state when inertial scrolling occurs or when the container bounces back after being released from a fling. | 4349 4350 4351### ArkUI_ShadowStyle 4352 4353``` 4354enum ArkUI_ShadowStyle 4355``` 4356**Description** 4357 4358Enumerated value of the shadow effect. 4359 4360**Since**: 12 4361 4362| Enum| Description| 4363| -------- | -------- | 4364| ARKUI_SHADOW_STYLE_OUTER_DEFAULT_XS | Mini shadow. | 4365| ARKUI_SHADOW_STYLE_OUTER_DEFAULT_SM | Small shadow. | 4366| ARKUI_SHADOW_STYLE_OUTER_DEFAULT_MD | Medium shadow. | 4367| ARKUI_SHADOW_STYLE_OUTER_DEFAULT_LG | Large shadow. | 4368| ARKUI_SHADOW_STYLE_OUTER_FLOATING_SM | Floating small shadow. | 4369| ARKUI_SHADOW_STYLE_OUTER_FLOATING_MD | Floating medium shadow. | 4370 4371 4372### ArkUI_ShadowType 4373 4374``` 4375enum ArkUI_ShadowType 4376``` 4377**Description** 4378 4379Defines the enumerated values of the shadow type. 4380 4381**Since**: 12 4382 4383| Enum| Description| 4384| -------- | -------- | 4385| ARKUI_SHADOW_TYPE_COLOR | Color. | 4386| ARKUI_SHADOW_TYPE_BLUR | Blur. | 4387 4388### ArkUI_ShapeType 4389 4390``` 4391enum ArkUI_ShapeType 4392``` 4393**Description** 4394 4395Enumerates custom shape types. 4396 4397**Since**: 12 4398 4399| Enum| Description| 4400| -------- | -------- | 4401| ARKUI_SHAPE_TYPE_RECTANGLE | Rectangle. | 4402| ARKUI_SHAPE_TYPE_CIRCLE | **(circle)** | 4403| ARKUI_SHAPE_TYPE_ELLIPSE | Ellipse. | 4404| ARKUI_SHAPE_TYPE_PATH | Path Type | 4405 4406 4407### ArkUI_SliderBlockStyle 4408 4409``` 4410enum ArkUI_SliderBlockStyle 4411``` 4412**Description** 4413 4414Enumerates the styles of the slider in the block direction. 4415 4416**Since**: 12 4417 4418| Enum| Description| 4419| -------- | -------- | 4420| ARKUI_SLIDER_BLOCK_STYLE_DEFAULT | Round slider. | 4421| ARKUI_SLIDER_BLOCK_STYLE_IMAGE | Slider with an image background. | 4422| ARKUI_SLIDER_BLOCK_STYLE_SHAPE | Slider in a custom shape. | 4423 4424 4425### ArkUI_SliderDirection 4426 4427``` 4428enum ArkUI_SliderDirection 4429``` 4430**Description** 4431 4432Enumerates the scroll directions of the slider. 4433 4434**Since**: 12 4435 4436| Enum| Description| 4437| -------- | -------- | 4438| ARKUI_SLIDER_DIRECTION_VERTICAL | Vertical direction. | 4439| ARKUI_SLIDER_DIRECTION_HORIZONTAL | Horizontal direction. | 4440 4441 4442### ArkUI_SliderStyle 4443 4444``` 4445enum ArkUI_SliderStyle 4446``` 4447**Description** 4448 4449Enumerates the slider styles. 4450 4451**Since**: 12 4452 4453| Enum| Description| 4454| -------- | -------- | 4455| ARKUI_SLIDER_STYLE_OUT_SET | The slider is on the slider rail. | 4456| ARKUI_SLIDER_STYLE_IN_SET | The slider is in the slider rail. | 4457| ARKUI_SLIDER_STYLE_NONE | There is no thumb. | 4458 4459 4460### ArkUI_StickyStyle 4461 4462``` 4463enum ArkUI_StickyStyle 4464``` 4465**Description** 4466 4467Enumerates the modes for pinning the header to the top or the footer to the bottom. 4468 4469**Since**: 12 4470 4471| Enum| Description| 4472| -------- | -------- | 4473| ARKUI_STICKY_STYLE_NONE | In the list item group, the header is not pinned to the top, and the footer is not pinned to the bottom. | 4474| ARKUI_STICKY_STYLE_HEADER | In the list item group, the header is pinned to the top, and the footer is not pinned to the bottom. | 4475| ARKUI_STICKY_STYLE_FOOTER | In the list item group, the footer is pinned to the bottom, and the header is not pinned to the top. | 4476| ARKUI_STICKY_STYLE_BOTH | In the list item group, the footer is pinned to the bottom, and the header is pinned to the top. | 4477 4478 4479### ArkUI_SwiperArrow 4480 4481``` 4482enum ArkUI_SwiperArrow 4483``` 4484**Description** 4485 4486Enumerates arrow styles of the navigation indicator. 4487 4488**Since**: 12 4489 4490| Enum| Description| 4491| -------- | -------- | 4492| ARKUI_SWIPER_ARROW_HIDE | The arrow is not displayed for the navigation indicator. | 4493| ARKUI_SWIPER_ARROW_SHOW | The arrow is displayed for the navigation indicator. | 4494| ARKUI_SWIPER_ARROW_SHOW_ON_HOVER | The arrow is displayed only when the mouse pointer hovers over the navigation indicator. | 4495 4496 4497### ArkUI_SwiperDisplayModeType 4498 4499``` 4500enum ArkUI_SwiperDisplayModeType 4501``` 4502**Description** 4503 4504Enumerates the modes in which elements are displayed along the main axis of the **Swiper** component. 4505 4506**Since**: 12 4507 4508| Enum| Description| 4509| -------- | -------- | 4510| ARKUI_SWIPER_DISPLAY_MODE_STRETCH | The slide width of the **Swiper** component is equal to the width of the component. | 4511| ARKUI_SWIPER_DISPLAY_MODE_AUTO_LINEAR | The slide width of the **Swiper** component is equal to the width of the leftmost child component in the viewport. | 4512 4513 4514### ArkUI_SwiperIndicatorType 4515 4516``` 4517enum ArkUI_SwiperIndicatorType 4518``` 4519**Description** 4520 4521Enumerates the navigation indicator types of the **Swiper** component. 4522 4523**Since**: 12 4524 4525| Enum| Description| 4526| -------- | -------- | 4527| ARKUI_SWIPER_INDICATOR_TYPE_DOT | Dot type. | 4528| ARKUI_SWIPER_INDICATOR_TYPE_DIGIT | Digit type. | 4529 4530 4531### ArkUI_SwiperNestedScrollMode 4532 4533``` 4534enum ArkUI_SwiperNestedScrollMode 4535``` 4536**Description** 4537 4538Enumerates the nested scrolling mode of the **Swiper** component and its parent container. 4539 4540**Since**: 12 4541 4542| Enum| Description| 4543| -------- | -------- | 4544| ARKUI_SWIPER_NESTED_SRCOLL_SELF_ONLY | The scrolling is contained within the **Swiper** component, and no scroll chaining occurs, that is, the parent container does not scroll when the component scrolling reaches the boundary. | 4545| ARKUI_SWIPER_NESTED_SRCOLL_SELF_FIRST | The **Swiper** component scrolls first, and when it hits the boundary, the parent container scrolls. When the parent container hits the boundary, its edge effect is displayed. If no edge effect is specified for the parent container, the edge effect of the child component is displayed instead. | 4546 4547 4548### ArkUI_SystemColorMode 4549 4550``` 4551enum ArkUI_SystemColorMode 4552``` 4553**Description** 4554 4555Enumerates the system color modes. 4556 4557**Since**: 12 4558 4559| Enum| Description| 4560| -------- | -------- | 4561| ARKUI_SYSTEM_COLOR_MODE_LIGHT | Light mode. | 4562| ARKUI_SYSTEM_COLOR_MODE_DARK | Dark mode. | 4563 4564 4565### ArkUI_TextAlignment 4566 4567``` 4568enum ArkUI_TextAlignment 4569``` 4570**Description** 4571 4572Enumerates the text alignment mode. 4573 4574**Since**: 12 4575 4576| Enum| Description| 4577| -------- | -------- | 4578| ARKUI_TEXT_ALIGNMENT_START | Aligned with the start. | 4579| ARKUI_TEXT_ALIGNMENT_CENTER | Horizontally centered. | 4580| ARKUI_TEXT_ALIGNMENT_END | Aligned with the end. | 4581| ARKUI_TEXT_ALIGNMENT_JUSTIFY | Aligned with both margins. | 4582 4583 4584### ArkUI_TextAreaType 4585 4586``` 4587enum ArkUI_TextAreaType 4588``` 4589**Description** 4590 4591Enumerates the text box types. 4592 4593**Since**: 12 4594 4595| Enum| Description| 4596| -------- | -------- | 4597| ARKUI_TEXTAREA_TYPE_NORMAL | Normal input mode. | 4598| ARKUI_TEXTAREA_TYPE_NUMBER | Number input mode. | 4599| ARKUI_TEXTAREA_TYPE_PHONE_NUMBER | Phone number input mode. | 4600| ARKUI_TEXTAREA_TYPE_EMAIL | Email address input mode. | 4601 4602 4603### ArkUI_TextCase 4604 4605``` 4606enum ArkUI_TextCase 4607``` 4608**Description** 4609 4610Defines the enumerated values of text case. 4611 4612**Since**: 12 4613 4614| Enum| Description| 4615| -------- | -------- | 4616| ARKUI_TEXT_CASE_NORMAL | The original case of the text is retained. | 4617| ARKUI_TEXT_CASE_LOWER | All letters in the text are in lowercase. | 4618| ARKUI_TEXT_CASE_UPPER | All letters in the text are in uppercase. | 4619 4620 4621### ArkUI_TextCopyOptions 4622 4623``` 4624enum ArkUI_TextCopyOptions 4625``` 4626**Description** 4627 4628Enumerates copy options, which define whether copy and paste is allowed for text content. 4629 4630**Since**: 12 4631 4632| Enum| Description| 4633| -------- | -------- | 4634| ARKUI_TEXT_COPY_OPTIONS_NONE | Copy is not allowed. | 4635| ARKUI_TEXT_COPY_OPTIONS_IN_APP | Intra-application copy is allowed. | 4636| ARKUI_TEXT_COPY_OPTIONS_LOCAL_DEVICE | Intra-device copy is allowed. | 4637| ARKUI_TEXT_COPY_OPTIONS_CROSS_DEVICE | Cross-device copy is allowed. | 4638 4639 4640### ArkUI_TextDataDetectorType 4641 4642``` 4643enum ArkUI_TextDataDetectorType 4644``` 4645**Description** 4646 4647Enumerates the entity types of text recognition. 4648 4649**Since**: 12 4650 4651| Enum| Description| 4652| -------- | -------- | 4653| ARKUI_TEXT_DATA_DETECTOR_TYPE_PHONE_NUMBER | Phone number. | 4654| ARKUI_TEXT_DATA_DETECTOR_TYPE_URL | Link. | 4655| ARKUI_TEXT_DATA_DETECTOR_TYPE_EMAIL | Email | 4656| ARKUI_TEXT_DATA_DETECTOR_TYPE_ADDRESS | Network address. | 4657 4658 4659### ArkUI_TextDecorationStyle 4660 4661``` 4662enum ArkUI_TextDecorationStyle 4663``` 4664**Description** 4665 4666Enumerates the text decoration styles. 4667 4668**Since**: 12 4669 4670| Enum| Description| 4671| -------- | -------- | 4672| ARKUI_TEXT_DECORATION_STYLE_SOLID | Single solid line. | 4673| ARKUI_TEXT_DECORATION_STYLE_DOUBLE | Double solid line. | 4674| ARKUI_TEXT_DECORATION_STYLE_DOTTED | Dotted line. | 4675| ARKUI_TEXT_DECORATION_STYLE_DASHED | Dashed style. | 4676| ARKUI_TEXT_DECORATION_STYLE_WAVY | Wavy line. | 4677 4678 4679### ArkUI_TextDecorationType 4680 4681``` 4682enum ArkUI_TextDecorationType 4683``` 4684**Description** 4685 4686Enumerates the text decoration types. 4687 4688**Since**: 12 4689 4690| Enum| Description| 4691| -------- | -------- | 4692| ARKUI_TEXT_DECORATION_TYPE_NONE | No text decoration. | 4693| ARKUI_TEXT_DECORATION_TYPE_UNDERLINE | Line under the text. | 4694| ARKUI_TEXT_DECORATION_TYPE_OVERLINE | Line over the text. | 4695| ARKUI_TEXT_DECORATION_TYPE_LINE_THROUGH | Line through the text. | 4696 4697 4698### ArkUI_TextHeightAdaptivePolicy 4699 4700``` 4701enum ArkUI_TextHeightAdaptivePolicy 4702``` 4703**Description** 4704 4705Defines how the adaptive height is determined for the text. 4706 4707**Since**: 12 4708 4709| Enum| Description| 4710| -------- | -------- | 4711| ARKUI_TEXT_HEIGHT_ADAPTIVE_POLICY_MAX_LINES_FIRST | Prioritize the **maxLines** settings. | 4712| ARKUI_TEXT_HEIGHT_ADAPTIVE_POLICY_MIN_FONT_SIZE_FIRST | Prioritize the **minFontSize** settings. | 4713| ARKUI_TEXT_HEIGHT_ADAPTIVE_POLICY_LAYOUT_CONSTRAINT_FIRST | Prioritize the layout constraint settings in terms of height. | 4714 4715 4716### ArkUI_TextInputContentType 4717 4718``` 4719enum ArkUI_TextInputContentType 4720``` 4721**Description** 4722 4723Enumerates the autofill types. 4724 4725**Since**: 12 4726 4727| Enum| Description| 4728| -------- | -------- | 4729| ARKUI_TEXTINPUT_CONTENT_TYPE_USER_NAME | Username. Password Vault, when enabled, can automatically save and fill in usernames. | 4730| ARKUI_TEXTINPUT_CONTENT_TYPE_PASSWORD | Password. Password Vault, when enabled, can automatically save and fill in passwords. | 4731| ARKUI_TEXTINPUT_CONTENT_TYPE_NEW_PASSWORD | New password. Password Vault, when enabled, can automatically generate a new password. | 4732| ARKUI_TEXTINPUT_CONTENT_TYPE_FULL_STREET_ADDRESS | Full street address. The scenario-based autofill feature, when enabled, can automatically save and fill in full street addresses. | 4733| ARKUI_TEXTINPUT_CONTENT_TYPE_HOUSE_NUMBER | House number. The scenario-based autofill feature, when enabled, can automatically save and fill in house numbers. | 4734| ARKUI_TEXTINPUT_CONTENT_TYPE_DISTRICT_ADDRESS | District and county. The scenario-based autofill feature, when enabled, can automatically save and fill in districts and counties. | 4735| ARKUI_TEXTINPUT_CONTENT_TYPE_CITY_ADDRESS | City. The scenario-based autofill feature, when enabled, can automatically save and fill in cities. | 4736| ARKUI_TEXTINPUT_CONTENT_TYPE_PROVINCE_ADDRESS | Province. The scenario-based autofill feature, when enabled, can automatically save and fill in provinces. | 4737| ARKUI_TEXTINPUT_CONTENT_TYPE_COUNTRY_ADDRESS | Country. The scenario-based autofill feature, when enabled, can automatically save and fill in countries. | 4738| ARKUI_TEXTINPUT_CONTENT_TYPE_PERSON_FULL_NAME | Full name. The scenario-based autofill feature, when enabled, can automatically save and fill in full names. | 4739| ARKUI_TEXTINPUT_CONTENT_TYPE_PERSON_LAST_NAME | Last name. The scenario-based autofill feature, when enabled, can automatically save and fill in last names. | 4740| ARKUI_TEXTINPUT_CONTENT_TYPE_PERSON_FIRST_NAME | First name. The scenario-based autofill feature, when enabled, can automatically save and fill in first names. | 4741| ARKUI_TEXTINPUT_CONTENT_TYPE_PHONE_NUMBER | Phone number. The scenario-based autofill feature, when enabled, can automatically save and fill in phone numbers. | 4742| ARKUI_TEXTINPUT_CONTENT_TYPE_PHONE_COUNTRY_CODE | Country code. The scenario-based autofill feature, when enabled, can automatically save and fill in country codes. | 4743| ARKUI_TEXTINPUT_CONTENT_TYPE_FULL_PHONE_NUMBER | Phone number with country code. The scenario-based autofill feature, when enabled, can automatically save and fill in phone numbers with country codes. | 4744| ARKUI_TEXTINPUT_CONTENT_EMAIL_ADDRESS | Email address. The scenario-based autofill feature, when enabled, can automatically save and fill in email addresses. | 4745| ARKUI_TEXTINPUT_CONTENT_TYPE_BANK_CARD_NUMBER | Bank card number. The scenario-based autofill feature, when enabled, can automatically save and fill in bank card numbers. | 4746| ARKUI_TEXTINPUT_CONTENT_TYPE_ID_CARD_NUMBER | ID card number. The scenario-based autofill feature, when enabled, can automatically save and fill in ID card numbers. | 4747| ARKUI_TEXTINPUT_CONTENT_TYPE_NICKNAME | Nickname. The scenario-based autofill feature, when enabled, can automatically save and fill in nicknames. | 4748| ARKUI_TEXTINPUT_CONTENT_TYPE_DETAIL_INFO_WITHOUT_STREET | Address information without street address. The scenario-based autofill feature, when enabled, can automatically save and fill in address information without street addresses. | 4749| ARKUI_TEXTINPUT_CONTENT_TYPE_FORMAT_ADDRESS | Standard address. The scenario-based autofill feature, when enabled, can automatically save and fill in standard addresses. | 4750| ARKUI_TEXTINPUT_CONTENT_TYPE_PASSPORT_NUMBER | Passport number. The scenario-based autofill feature, when enabled, can automatically save and fill in passport numbers. | 4751| ARKUI_TEXTINPUT_CONTENT_TYPE_VALIDITY | Passport validity period. The scenario-based autofill feature, when enabled, can automatically save and fill in passport validity periods. | 4752| ARKUI_TEXTINPUT_CONTENT_TYPE_ISSUE_AT | Passport place of issue. The scenario-based autofill feature, when enabled, can automatically save and fill in the place of issue for passports. | 4753| ARKUI_TEXTINPUT_CONTENT_TYPE_ORGANIZATION | Invoice title. The scenario-based autofill feature, when enabled, can automatically save and fill in invoice titles. | 4754| ARKUI_TEXTINPUT_CONTENT_TYPE_TAX_ID | Tax ID. The scenario-based autofill feature, when enabled, can automatically save and fill in tax IDs. | 4755| ARKUI_TEXTINPUT_CONTENT_TYPE_ADDRESS_CITY_AND_STATE | Location. The scenario-based autofill feature, when enabled, can automatically save and fill in locations. | 4756| ARKUI_TEXTINPUT_CONTENT_TYPE_FLIGHT_NUMBER | Flight number. Currently not supported for automatic saving and auto-filling. | 4757| ARKUI_TEXTINPUT_CONTENT_TYPE_LICENSE_NUMBER | Driver's license number. Currently not supported for automatic saving and auto-filling. | 4758| ARKUI_TEXTINPUT_CONTENT_TYPE_LICENSE_FILE_NUMBER | Driver's license file number. Currently not supported for automatic saving and auto-filling.| 4759| ARKUI_TEXTINPUT_CONTENT_TYPE_LICENSE_PLATE | License plate number. The scenario-based autofill feature, when enabled, can automatically save and fill in license plate numbers. | 4760| ARKUI_TEXTINPUT_CONTENT_TYPE_ENGINE_NUMBER | Vehicle registration engine number. Currently not supported for automatic saving and auto-filling. | 4761| ARKUI_TEXTINPUT_CONTENT_TYPE_LICENSE_CHASSIS_NUMBER | Chassis number. Currently not supported for automatic saving and auto-filling. | 4762 4763 4764### ArkUI_TextInputStyle 4765 4766``` 4767enum ArkUI_TextInputStyle 4768``` 4769**Description** 4770 4771Enumerates the text input styles. 4772 4773**Since**: 12 4774 4775| Enum| Description| 4776| -------- | -------- | 4777| ARKUI_TEXTINPUT_STYLE_DEFAULT | Default style. The caret width is fixed at 1.5 vp, and the caret height is subject to the background height and font size of the selected text. | 4778| ARKUI_TEXTINPUT_STYLE_INLINE | Inline input style. The background height of the selected text is the same as the height of the text box. | 4779 4780 4781### ArkUI_TextInputType 4782 4783``` 4784enum ArkUI_TextInputType 4785``` 4786**Description** 4787 4788Enumerates the text input types. 4789 4790**Since**: 12 4791 4792| Enum| Description| 4793| -------- | -------- | 4794| ARKUI_TEXTINPUT_TYPE_NORMAL | Normal input mode. | 4795| ARKUI_TEXTINPUT_TYPE_NUMBER | Number input mode. | 4796| ARKUI_TEXTINPUT_TYPE_PHONE_NUMBER | Phone number input mode. | 4797| ARKUI_TEXTINPUT_TYPE_EMAIL | Email address input mode. | 4798| ARKUI_TEXTINPUT_TYPE_PASSWORD | Password input mode. | 4799| ARKUI_TEXTINPUT_TYPE_NUMBER_PASSWORD | Numeric password input mode. | 4800| ARKUI_TEXTINPUT_TYPE_SCREEN_LOCK_PASSWORD | Lock screen password input mode. | 4801| ARKUI_TEXTINPUT_TYPE_USER_NAME | Username input mode. | 4802| ARKUI_TEXTINPUT_TYPE_NEW_PASSWORD | New password input mode. | 4803| ARKUI_TEXTINPUT_TYPE_NUMBER_DECIMAL | Number input mode with a decimal point. | 4804 4805 4806### ArkUI_TextOverflow 4807 4808``` 4809enum ArkUI_TextOverflow 4810``` 4811**Description** 4812 4813Enumerates the display modes when the text is too long. 4814 4815**Since**: 12 4816 4817| Enum| Description| 4818| -------- | -------- | 4819| ARKUI_TEXT_OVERFLOW_NONE | Extra-long text is not clipped. | 4820| ARKUI_TEXT_OVERFLOW_CLIP | Extra-long text is clipped. | 4821| ARKUI_TEXT_OVERFLOW_ELLIPSIS | An ellipsis (...) is used to represent text overflow. | 4822| ARKUI_TEXT_OVERFLOW_MARQUEE | Text continuously scrolls when text overflow occurs. | 4823 4824 4825### ArkUI_TextPickerRangeType 4826 4827``` 4828enum ArkUI_TextPickerRangeType 4829``` 4830**Description** 4831 4832Enumerates the types of the text picker. 4833 4834**Since**: 12 4835 4836| Enum| Description| 4837| -------- | -------- | 4838| ARKUI_TEXTPICKER_RANGETYPE_SINGLE | Single-column text picker. | 4839| ARKUI_TEXTPICKER_RANGETYPE_MULTI | Multi-column text picker. | 4840| ARKUI_TEXTPICKER_RANGETYPE_RANGE_CONTENT | Single-column text picker with image resources. | 4841| ARKUI_TEXTPICKER_RANGETYPE_CASCADE_RANGE_CONTENT | Interconnected multi-column text picker. | 4842 4843 4844### ArkUI_ThemeColorMode 4845 4846``` 4847enum ArkUI_ThemeColorMode 4848``` 4849 4850| Enum| Description| 4851| -------- | -------- | 4852| ARKUI_THEME_COLOR_MODE_SYSTEM | Following the system color mode. | 4853| ARKUI_THEME_COLOR_MODE_LIGHT | Light color mode. | 4854| ARKUI_THEME_COLOR_MODE_DARK | Dark color mode. | 4855 4856 4857### ArkUI_TransitionEdge 4858 4859``` 4860enum ArkUI_TransitionEdge 4861``` 4862**Description** 4863 4864Enumerates the slide-in and slide-out positions of the component from the screen edge during transition. 4865 4866**Since**: 12 4867 4868| Enum| Description| 4869| -------- | -------- | 4870| ARKUI_TRANSITION_EDGE_TOP | Top edge of the window. | 4871| ARKUI_TRANSITION_EDGE_BOTTOM | Bottom edge of the window. | 4872| ARKUI_TRANSITION_EDGE_START | Left edge of the window. | 4873| ARKUI_TRANSITION_EDGE_END | Right edge of the window. | 4874 4875 4876### ArkUI_VerticalAlignment 4877 4878``` 4879enum ArkUI_VerticalAlignment 4880``` 4881**Description** 4882 4883Enumerates the vertical alignment modes. 4884 4885**Since**: 12 4886 4887| Enum| Description| 4888| -------- | -------- | 4889| ARKUI_VERTICAL_ALIGNMENT_TOP | Top aligned. | 4890| ARKUI_VERTICAL_ALIGNMENT_CENTER | Aligned with the center. This is the default alignment mode. | 4891| ARKUI_VERTICAL_ALIGNMENT_BOTTOM | Bottom aligned. | 4892 4893 4894### ArkUI_Visibility 4895 4896``` 4897enum ArkUI_Visibility 4898``` 4899**Description** 4900 4901Enumerates the visibility values. 4902 4903**Since**: 12 4904 4905| Enum| Description| 4906| -------- | -------- | 4907| ARKUI_VISIBILITY_VISIBLE | Display | 4908| ARKUI_VISIBILITY_HIDDEN | The component is hidden, and a placeholder is used for it in the layout. | 4909| ARKUI_VISIBILITY_NONE | The component is hidden. It is not involved in the layout, and no placeholder is used for it. | 4910 4911 4912### ArkUI_WordBreak 4913 4914``` 4915enum ArkUI_WordBreak 4916``` 4917**Description** 4918 4919Enumerates the word break rules. 4920 4921**Since**: 12 4922 4923| Enum| Description| 4924| -------- | -------- | 4925| ARKUI_WORD_BREAK_NORMAL | Word breaks can occur between any two characters for Chinese, Japanese, and Korean (CJK) text, but can occur only at a space character for non-CJK text (such as English). | 4926| ARKUI_WORD_BREAK_BREAK_ALL | Word breaks can occur between any two characters for non-CJK text. CJK text behavior is the same as for **NORMAL**. | 4927| ARKUI_WORD_BREAK_BREAK_WORD | This option has the same effect as **BREAK_ALL** for non-CJK text, except that if it preferentially wraps lines at appropriate characters (for example, spaces) whenever possible. CJK text behavior is the same as for **NORMAL**. | 4928| ARKUI_WORD_BREAK_HYPHENATION | **Since**: 16 Line breaks can occur between any two syllabic units for non-CJK text. CJK text behavior is the same as for **NORMAL**. | 4929 4930 4931### ArkUI_XComponentType 4932 4933``` 4934enum ArkUI_XComponentType 4935``` 4936**Description** 4937 4938Defines the enumerated values of the XComponent type. 4939 4940**Since**: 12 4941 4942| Enum| Description| 4943| -------- | -------- | 4944| ARKUI_XCOMPONENT_TYPE_SURFACE | The custom content of EGL/OpenGL ES and media data is displayed individually on the screen. | 4945| ARKUI_XCOMPONENT_TYPE_TEXTURE | The custom content of EGL/OpenGL ES and media data is grouped and displayed together with content of the component. | 4946 4947### ArkUI_KeyboardAppearance 4948 4949``` 4950enum ArkUI_KeyboardAppearance 4951``` 4952**Description** 4953 4954Enumerates the appearance modes of the keyboard when the text box is focused. 4955 4956**Since**: 15 4957 4958| Enum| Description| 4959| -------- | -------- | 4960| ARKUI_KEYBOARD_APPEARANCE_NONE_IMMERSIVE | Default appearance mode, not using the immersive style. | 4961| ARKUI_KEYBOARD_APPEARANCE_IMMERSIVE | Immersive style, following the system color mode. | 4962| ARKUI_KEYBOARD_APPEARANCE_LIGHT_IMMERSIVE | Immersive style in light mode. | 4963| ARKUI_KEYBOARD_APPEARANCE_DARK_IMMERSIVE | Immersive style in dark mode. | 4964 4965### ArkUI_KeyboardAvoidMode 4966 4967``` 4968enum ArkUI_KeyboardAvoidMode 4969``` 4970**Description** 4971 4972Enumerates the keyboard avoidance modes of the dialog box. 4973 4974**Since**: 15 4975 4976| Enum| Description| 4977| -------- | -------- | 4978| ARKUI_KEYBOARD_AVOID_MODE_DEFAULT | Automatically avoids the soft keyboard and compresses the height when reaching the maximum limit. | 4979| ARKUI_KEYBOARD_AVOID_MODE_NONE | Does not avoid the soft keyboard. | 4980 4981### ArkUI_HoverModeAreaType 4982 4983``` 4984enum ArkUI_HoverModeAreaType 4985``` 4986**Description** 4987 4988Enumerates the default display areas of a dialog box in hover mode. 4989 4990**Since**: 15 4991 4992| Enum| Description| 4993| -------- | -------- | 4994| ARKUI_HOVER_MODE_AREA_TYPE_TOP | Upper half screen. | 4995| ARKUI_HOVER_MODE_AREA_TYPE_BOTTOM | Lower half screen. | 4996 4997 4998## Function Description 4999 5000 5001### OH_ArkUI_AccessibilityState_Create() 5002 5003``` 5004ArkUI_AccessibilityState* OH_ArkUI_AccessibilityState_Create (void ) 5005``` 5006**Description** 5007 5008Creates an accessibility state. 5009 5010**Since**: 12 5011 5012**Returns** 5013 5014Returns the pointer to the created accessibility state object. If a null pointer is returned, the creation fails. A possible cause is that the application address space is full. 5015 5016 5017### OH_ArkUI_AccessibilityState_Dispose() 5018 5019``` 5020void OH_ArkUI_AccessibilityState_Dispose (ArkUI_AccessibilityState * state) 5021``` 5022**Description** 5023 5024Disposes of the pointer to an accessibility state. 5025 5026**Since**: 12 5027 5028**Parameters** 5029 5030| Name| Description| 5031| -------- | -------- | 5032| state | Pointer to an accessibility state object. | 5033 5034 5035### OH_ArkUI_AccessibilityState_GetCheckedState() 5036 5037``` 5038int32_t OH_ArkUI_AccessibilityState_GetCheckedState (ArkUI_AccessibilityState * state) 5039``` 5040**Description** 5041 5042Obtains the check box state of an accessibility state. 5043 5044**Since**: 12 5045 5046**Parameters** 5047 5048| Name| Description| 5049| -------- | -------- | 5050| state | Pointer to an accessibility state object. | 5051 5052**Returns** 5053 5054Returns the check box state. The parameter type is [ArkUI_AccessibilityCheckedState](#arkui_accessibilitycheckedstate). The default value is **ARKUI_ACCESSIBILITY_UNCHECKED**. If a parameter error occurs, the default value is returned. 5055 5056 5057### OH_ArkUI_AccessibilityState_IsDisabled() 5058 5059``` 5060int32_t OH_ArkUI_AccessibilityState_IsDisabled (ArkUI_AccessibilityState * state) 5061``` 5062**Description** 5063 5064Obtains whether an accessibility state is disabled. 5065 5066**Since**: 12 5067 5068**Parameters** 5069 5070| Name| Description| 5071| -------- | -------- | 5072| state | Pointer to an accessibility state object. | 5073 5074**Returns** 5075 5076Returns whether the accessibility state is disabled. The value **1** means that the accessibility state is disabled, and **0** means the opposite. The default value is **0**. If the value of **state** is empty, the default value is returned. 5077 5078 5079### OH_ArkUI_AccessibilityState_IsSelected() 5080 5081``` 5082int32_t OH_ArkUI_AccessibilityState_IsSelected (ArkUI_AccessibilityState * state) 5083``` 5084**Description** 5085 5086Obtains whether an accessibility state is selected. 5087 5088**Since**: 12 5089 5090**Parameters** 5091 5092| Name| Description| 5093| -------- | -------- | 5094| state | Pointer to an accessibility state object. | 5095 5096**Returns** 5097 5098Returns whether the accessibility state is selected. The value **1** means that the accessibility state is selected, and **0** means the opposite. The default value is **0**. If the value of **state** is empty, the default value is returned. 5099 5100 5101### OH_ArkUI_AccessibilityState_SetCheckedState() 5102 5103``` 5104void OH_ArkUI_AccessibilityState_SetCheckedState (ArkUI_AccessibilityState * state, int32_t checkedState ) 5105``` 5106**Description** 5107 5108Sets the check box state of an accessibility state. 5109 5110**Since**: 12 5111 5112**Parameters** 5113 5114| Name| Description| 5115| -------- | -------- | 5116| state | Pointer to an accessibility state object. | 5117| checkedState | Check box status. The parameter type is [ArkUI_AccessibilityCheckedState](#arkui_accessibilitycheckedstate). The default value is **ARKUI_ACCESSIBILITY_UNCHECKED**. | 5118 5119 5120### OH_ArkUI_AccessibilityState_SetDisabled() 5121 5122``` 5123void OH_ArkUI_AccessibilityState_SetDisabled (ArkUI_AccessibilityState * state, int32_t isDisabled ) 5124``` 5125**Description** 5126 5127Sets whether an accessibility state is disabled. 5128 5129**Since**: 12 5130 5131**Parameters** 5132 5133| Name| Description| 5134| -------- | -------- | 5135| state | Pointer to an accessibility state object. | 5136| isDisabled | Whether the accessibility state is disabled. The value **1** means that the accessibility state is disabled, and **0** means the opposite. The default value is **0**. | 5137 5138 5139### OH_ArkUI_AccessibilityState_SetSelected() 5140 5141``` 5142void OH_ArkUI_AccessibilityState_SetSelected (ArkUI_AccessibilityState * state, int32_t isSelected ) 5143``` 5144**Description** 5145 5146Sets whether an accessibility state is selected. 5147 5148**Since**: 12 5149 5150**Parameters** 5151 5152| Name| Description| 5153| -------- | -------- | 5154| state | Pointer to an accessibility state object. | 5155| isSelected | Whether the accessibility state is selected. The value **1** means that the accessibility state is selected, and **0** means the opposite. The default value is **0**. | 5156 5157 5158### OH_ArkUI_AccessibilityValue_Create() 5159 5160``` 5161ArkUI_AccessibilityValue* OH_ArkUI_AccessibilityValue_Create (void ) 5162``` 5163**Description** 5164 5165Creates an **AccessibilityValue** instance. 5166 5167**Since**: 12 5168 5169**Returns** 5170 5171Returns the pointer to the created **AccessibilityValue** instance. 5172 5173 5174### OH_ArkUI_AccessibilityValue_Dispose() 5175 5176``` 5177void OH_ArkUI_AccessibilityValue_Dispose (ArkUI_AccessibilityValue * value) 5178``` 5179**Description** 5180 5181Disposes of the pointer to an **AccessibilityValue** instance. 5182 5183**Since**: 12 5184 5185**Parameters** 5186 5187| Name| Description| 5188| -------- | -------- | 5189| state | Pointer to an **AccessibilityValue** instance. | 5190 5191 5192### OH_ArkUI_AccessibilityValue_GetCurrent() 5193 5194``` 5195int32_t OH_ArkUI_AccessibilityValue_GetCurrent (ArkUI_AccessibilityValue * value) 5196``` 5197**Description** 5198 5199Obtains the current accessibility value. 5200 5201**Since**: 12 5202 5203**Parameters** 5204 5205| Name| Description| 5206| -------- | -------- | 5207| value | Pointer to an **AccessibilityValue** instance. | 5208 5209**Returns** 5210 5211Returns the current value based on the range component. The default value is **-1**. If a parameter error occurs, **-1** is returned. 5212 5213 5214### OH_ArkUI_AccessibilityValue_GetMax() 5215 5216``` 5217int32_t OH_ArkUI_AccessibilityValue_GetMax (ArkUI_AccessibilityValue * value) 5218``` 5219**Description** 5220 5221Obtains the maximum accessibility value. 5222 5223**Since**: 12 5224 5225**Parameters** 5226 5227| Name| Description| 5228| -------- | -------- | 5229| value | Pointer to an **AccessibilityValue** instance. | 5230 5231**Returns** 5232 5233Returns the maximum value based on the range component. The default value is **-1**. If a parameter error occurs, **-1** is returned. 5234 5235 5236### OH_ArkUI_AccessibilityValue_GetMin() 5237 5238``` 5239int32_t OH_ArkUI_AccessibilityValue_GetMin (ArkUI_AccessibilityValue * value) 5240``` 5241**Description** 5242 5243Obtains the minimum accessibility value. 5244 5245**Since**: 12 5246 5247**Parameters** 5248 5249| Name| Description| 5250| -------- | -------- | 5251| value | Pointer to an **AccessibilityValue** instance. | 5252 5253**Returns** 5254 5255Returns the minimum value based on the range component. The default value is **-1**. If a parameter error occurs, **-1** is returned. 5256 5257 5258### OH_ArkUI_AccessibilityValue_GetText() 5259 5260``` 5261const char* OH_ArkUI_AccessibilityValue_GetText (ArkUI_AccessibilityValue * value) 5262``` 5263**Description** 5264 5265Obtains the text description of an **AccessibilityValue** instance. 5266 5267**Since**: 12 5268 5269**Parameters** 5270 5271| Name| Description| 5272| -------- | -------- | 5273| value | Pointer to an **AccessibilityValue** instance. | 5274 5275**Returns** 5276 5277Returns the text description. The default value is an empty string. If a parameter error occurs, a null pointer is returned. 5278 5279 5280### OH_ArkUI_AccessibilityValue_SetCurrent() 5281 5282``` 5283void OH_ArkUI_AccessibilityValue_SetCurrent (ArkUI_AccessibilityValue * value, int32_t current ) 5284``` 5285**Description** 5286 5287Sets the current accessibility value. 5288 5289**Since**: 12 5290 5291**Parameters** 5292 5293| Name| Description| 5294| -------- | -------- | 5295| value | Pointer to an **AccessibilityValue** instance. | 5296| current | Current value based on the range component. The default value is **-1**. | 5297 5298 5299### OH_ArkUI_AccessibilityValue_SetMax() 5300 5301``` 5302void OH_ArkUI_AccessibilityValue_SetMax (ArkUI_AccessibilityValue * value, int32_t max ) 5303``` 5304**Description** 5305 5306Sets the maximum accessibility value. 5307 5308**Since**: 12 5309 5310**Parameters** 5311 5312| Name| Description| 5313| -------- | -------- | 5314| value | Pointer to an **AccessibilityValue** instance. | 5315| max | Maximum value based on the range component. The default value is **-1**. | 5316 5317 5318### OH_ArkUI_AccessibilityValue_SetMin() 5319 5320``` 5321void OH_ArkUI_AccessibilityValue_SetMin (ArkUI_AccessibilityValue * value, int32_t min ) 5322``` 5323**Description** 5324 5325Sets the minimum accessibility value. 5326 5327**Since**: 12 5328 5329**Parameters** 5330 5331| Name| Description| 5332| -------- | -------- | 5333| value | Pointer to an **AccessibilityValue** instance. | 5334| min | Minimum value based on the range component. The default value is **-1**. | 5335 5336 5337### OH_ArkUI_AccessibilityValue_SetText() 5338 5339``` 5340void OH_ArkUI_AccessibilityValue_SetText (ArkUI_AccessibilityValue * value, const char * text ) 5341``` 5342**Description** 5343 5344Sets the text description of an **AccessibilityValue** instance. 5345 5346**Since**: 12 5347 5348**Parameters** 5349 5350| Name| Description| 5351| -------- | -------- | 5352| value | Pointer to an **AccessibilityValue** instance. | 5353| text | Text description. The default value is an empty string. | 5354 5355 5356### OH_ArkUI_ActiveChildrenInfo_Destroy() 5357 5358``` 5359void OH_ArkUI_ActiveChildrenInfo_Destroy (ArkUI_ActiveChildrenInfo * handle) 5360``` 5361**Description** 5362 5363Destroys an **ActiveChildrenInfo** instance. 5364 5365**Since**: 14 5366 5367**Parameters** 5368 5369| Name| Description| 5370| -------- | -------- | 5371| handle | **ActiveChildrenInfo** instance to destroy. | 5372 5373 5374### OH_ArkUI_ActiveChildrenInfo_GetCount() 5375 5376``` 5377int32_t OH_ArkUI_ActiveChildrenInfo_GetCount (ArkUI_ActiveChildrenInfo * handle) 5378``` 5379**Description** 5380 5381Obtains the number of nodes in the specified **ActiveChildrenInfo** instance. 5382 5383**Since**: 14 5384 5385**Parameters** 5386 5387| Name| Description| 5388| -------- | -------- | 5389| handle | **ActiveChildrenInfo** instance from which to obtain the information. | 5390 5391 5392### OH_ArkUI_ActiveChildrenInfo_GetNodeByIndex() 5393 5394``` 5395ArkUI_NodeHandle OH_ArkUI_ActiveChildrenInfo_GetNodeByIndex (ArkUI_ActiveChildrenInfo * handle, int32_t index ) 5396``` 5397**Description** 5398 5399Obtains the child node at the specified index in the specified **ActiveChildrenInfo** instance. 5400 5401**Since**: 14 5402 5403**Parameters** 5404 5405| Name| Description| 5406| -------- | -------- | 5407| handle | **ActiveChildrenInfo** instance from which to obtain the information. | 5408 5409 5410### OH_ArkUI_AlignmentRuleOption_Create() 5411 5412``` 5413ArkUI_AlignmentRuleOption* OH_ArkUI_AlignmentRuleOption_Create () 5414``` 5415**Description** 5416 5417Creates an alignment rule configuration for this **RelativeContainer** component. 5418 5419**Since**: 12 5420 5421**Returns** 5422 5423Alignment rule information. 5424 5425 5426### OH_ArkUI_AlignmentRuleOption_Dispose() 5427 5428``` 5429void OH_ArkUI_AlignmentRuleOption_Dispose (ArkUI_AlignmentRuleOption * option) 5430``` 5431**Description** 5432 5433Disposes of an alignment rule configuration of this **RelativeContainer** component. 5434 5435**Since**: 12 5436 5437**Parameters** 5438 5439| Name| Description| 5440| -------- | -------- | 5441| option | Pointer to an alignment rule configuration. | 5442 5443 5444### OH_ArkUI_AlignmentRuleOption_GetBiasHorizontal() 5445 5446``` 5447float OH_ArkUI_AlignmentRuleOption_GetBiasHorizontal (ArkUI_AlignmentRuleOption * option) 5448``` 5449**Description** 5450 5451Obtains the bias value in the horizontal direction. 5452 5453**Since**: 12 5454 5455**Parameters** 5456 5457| Name| Description| 5458| -------- | -------- | 5459| option | Pointer to an alignment rule configuration. | 5460 5461**Returns** 5462 5463Bias value in the horizontal direction. 5464 5465 5466### OH_ArkUI_AlignmentRuleOption_GetBiasVertical() 5467 5468``` 5469float OH_ArkUI_AlignmentRuleOption_GetBiasVertical (ArkUI_AlignmentRuleOption * option) 5470``` 5471**Description** 5472 5473Obtains the bias value in the vertical direction. 5474 5475**Since**: 12 5476 5477**Parameters** 5478 5479| Name| Description| 5480| -------- | -------- | 5481| option | Pointer to an alignment rule configuration. | 5482 5483**Returns** 5484 5485Returns the bias value in the vertical direction. 5486 5487 5488### OH_ArkUI_AlignmentRuleOption_GetBottomAlignment() 5489 5490``` 5491ArkUI_VerticalAlignment OH_ArkUI_AlignmentRuleOption_GetBottomAlignment (ArkUI_AlignmentRuleOption * option) 5492``` 5493**Description** 5494 5495Obtains the alignment mode in bottom alignment parameters. 5496 5497**Since**: 12 5498 5499**Parameters** 5500 5501| Name| Description| 5502| -------- | -------- | 5503| option | Pointer to an alignment rule configuration. | 5504 5505**Returns** 5506 5507Returns the alignment mode in bottom alignment parameters. 5508 5509 5510### OH_ArkUI_AlignmentRuleOption_GetBottomId() 5511 5512``` 5513const char* OH_ArkUI_AlignmentRuleOption_GetBottomId (ArkUI_AlignmentRuleOption * option) 5514``` 5515**Description** 5516 5517Obtains the alignment mode in bottom alignment parameters. 5518 5519**Since**: 12 5520 5521**Parameters** 5522 5523| Name| Description| 5524| -------- | -------- | 5525| option | Pointer to an alignment rule configuration. | 5526 5527**Returns** 5528 5529Returns the ID in bottom alignment parameters. 5530 5531 5532### OH_ArkUI_AlignmentRuleOption_GetCenterAlignmentHorizontal() 5533 5534``` 5535ArkUI_HorizontalAlignment OH_ArkUI_AlignmentRuleOption_GetCenterAlignmentHorizontal (ArkUI_AlignmentRuleOption * option) 5536``` 5537**Description** 5538 5539Obtains the alignment mode in horizontal center alignment parameters. 5540 5541**Since**: 12 5542 5543**Parameters** 5544 5545| Name| Description| 5546| -------- | -------- | 5547| option | Pointer to an alignment rule configuration. | 5548 5549**Returns** 5550 5551Returns the alignment mode in horizontal center alignment parameters. 5552 5553 5554### OH_ArkUI_AlignmentRuleOption_GetCenterAlignmentVertical() 5555 5556``` 5557ArkUI_VerticalAlignment OH_ArkUI_AlignmentRuleOption_GetCenterAlignmentVertical (ArkUI_AlignmentRuleOption * option) 5558``` 5559**Description** 5560 5561Obtains the ID in vertical center alignment parameters. 5562 5563**Since**: 12 5564 5565**Parameters** 5566 5567| Name| Description| 5568| -------- | -------- | 5569| option | Pointer to an alignment rule configuration. | 5570 5571**Returns** 5572 5573Returns the vertical center alignment parameters. 5574 5575 5576### OH_ArkUI_AlignmentRuleOption_GetCenterIdHorizontal() 5577 5578``` 5579const char* OH_ArkUI_AlignmentRuleOption_GetCenterIdHorizontal (ArkUI_AlignmentRuleOption * option) 5580``` 5581**Description** 5582 5583Obtains the alignment mode in horizontal center alignment parameters. 5584 5585**Since**: 12 5586 5587**Parameters** 5588 5589| Name| Description| 5590| -------- | -------- | 5591| option | Pointer to an alignment rule configuration. | 5592 5593**Returns** 5594 5595Returns the ID in horizontal center alignment parameters. 5596 5597 5598### OH_ArkUI_AlignmentRuleOption_GetCenterIdVertical() 5599 5600``` 5601const char* OH_ArkUI_AlignmentRuleOption_GetCenterIdVertical (ArkUI_AlignmentRuleOption * option) 5602``` 5603**Description** 5604 5605Obtains the ID in vertical center alignment parameters. 5606 5607**Since**: 12 5608 5609**Parameters** 5610 5611| Name| Description| 5612| -------- | -------- | 5613| option | Pointer to an alignment rule configuration. | 5614 5615**Returns** 5616 5617Returns the ID in vertical center alignment parameters. 5618 5619 5620### OH_ArkUI_AlignmentRuleOption_GetEndAlignment() 5621 5622``` 5623ArkUI_HorizontalAlignment OH_ArkUI_AlignmentRuleOption_GetEndAlignment (ArkUI_AlignmentRuleOption * option) 5624``` 5625**Description** 5626 5627Obtains the alignment mode in the right alignment parameters. 5628 5629**Since**: 12 5630 5631**Parameters** 5632 5633| Name| Description| 5634| -------- | -------- | 5635| option | Pointer to an alignment rule configuration. | 5636 5637**Returns** 5638 5639Returns the alignment mode in the right alignment parameters. 5640 5641 5642### OH_ArkUI_AlignmentRuleOption_GetEndId() 5643 5644``` 5645const char* OH_ArkUI_AlignmentRuleOption_GetEndId (ArkUI_AlignmentRuleOption * option) 5646``` 5647**Description** 5648 5649Obtains the alignment mode in the right alignment parameters. 5650 5651**Since**: 12 5652 5653**Parameters** 5654 5655| Name| Description| 5656| -------- | -------- | 5657| option | Pointer to an alignment rule configuration. | 5658 5659**Returns** 5660 5661Returns the ID in the right alignment parameters. 5662 5663 5664### OH_ArkUI_AlignmentRuleOption_GetStartAlignment() 5665 5666``` 5667ArkUI_HorizontalAlignment OH_ArkUI_AlignmentRuleOption_GetStartAlignment (ArkUI_AlignmentRuleOption * option) 5668``` 5669**Description** 5670 5671Obtains the alignment mode in left alignment parameters. 5672 5673**Since**: 12 5674 5675**Parameters** 5676 5677| Name| Description| 5678| -------- | -------- | 5679| option | Pointer to an alignment rule configuration. | 5680 5681**Returns** 5682 5683Returns the alignment mode in left alignment parameters. 5684 5685 5686### OH_ArkUI_AlignmentRuleOption_GetStartId() 5687 5688``` 5689const char* OH_ArkUI_AlignmentRuleOption_GetStartId (ArkUI_AlignmentRuleOption * option) 5690``` 5691**Description** 5692 5693Obtains the ID in the left alignment parameters. 5694 5695**Since**: 12 5696 5697**Parameters** 5698 5699| Name| Description| 5700| -------- | -------- | 5701| option | Pointer to an alignment rule configuration. | 5702 5703**Returns** 5704 5705Returns the ID in left alignment parameters. 5706 5707 5708### OH_ArkUI_AlignmentRuleOption_GetTopAlignment() 5709 5710``` 5711ArkUI_VerticalAlignment OH_ArkUI_AlignmentRuleOption_GetTopAlignment (ArkUI_AlignmentRuleOption * option) 5712``` 5713**Description** 5714 5715Obtains the alignment mode in top alignment parameters. 5716 5717**Since**: 12 5718 5719**Parameters** 5720 5721| Name| Description| 5722| -------- | -------- | 5723| option | Pointer to an alignment rule configuration. | 5724 5725**Returns** 5726 5727Returns the alignment mode in top alignment parameters. 5728 5729 5730### OH_ArkUI_AlignmentRuleOption_GetTopId() 5731 5732``` 5733const char* OH_ArkUI_AlignmentRuleOption_GetTopId (ArkUI_AlignmentRuleOption * option) 5734``` 5735**Description** 5736 5737Obtains the alignment mode in top alignment parameters. 5738 5739**Since**: 12 5740 5741**Parameters** 5742 5743| Name| Description| 5744| -------- | -------- | 5745| option | Pointer to an alignment rule configuration. | 5746 5747**Returns** 5748 5749Returns the ID in top alignment parameters. 5750 5751 5752### OH_ArkUI_AlignmentRuleOption_SetBiasHorizontal() 5753 5754``` 5755void OH_ArkUI_AlignmentRuleOption_SetBiasHorizontal (ArkUI_AlignmentRuleOption * option, float horizontal ) 5756``` 5757**Description** 5758 5759Sets the bias value of the component in the horizontal direction under the anchor constraints. 5760 5761**Since**: 12 5762 5763**Parameters** 5764 5765| Name| Description| 5766| -------- | -------- | 5767| option | Pointer to an alignment rule configuration. | 5768| horizontal | Bias value in the horizontal direction. | 5769 5770 5771### OH_ArkUI_AlignmentRuleOption_SetBiasVertical() 5772 5773``` 5774void OH_ArkUI_AlignmentRuleOption_SetBiasVertical (ArkUI_AlignmentRuleOption * option, float vertical ) 5775``` 5776**Description** 5777 5778Sets the bias value of the component in the vertical direction under the anchor constraints. 5779 5780**Since**: 12 5781 5782**Parameters** 5783 5784| Name| Description| 5785| -------- | -------- | 5786| option | Pointer to an alignment rule configuration. | 5787| horizontal | Bias value in the vertical direction. | 5788 5789 5790### OH_ArkUI_AlignmentRuleOption_SetBottom() 5791 5792``` 5793void OH_ArkUI_AlignmentRuleOption_SetBottom (ArkUI_AlignmentRuleOption * option, const char * id, ArkUI_VerticalAlignment alignment ) 5794``` 5795**Description** 5796 5797Sets the bottom alignment parameters. 5798 5799**Since**: 12 5800 5801**Parameters** 5802 5803| Name| Description| 5804| -------- | -------- | 5805| option | Pointer to an alignment rule configuration. | 5806| id | ID of the anchor component. | 5807| value | Alignment mode relative to the anchor component. | 5808 5809 5810### OH_ArkUI_AlignmentRuleOption_SetCenterHorizontal() 5811 5812``` 5813void OH_ArkUI_AlignmentRuleOption_SetCenterHorizontal (ArkUI_AlignmentRuleOption * option, const char * id, ArkUI_HorizontalAlignment alignment ) 5814``` 5815**Description** 5816 5817Sets the horizontal center alignment parameters. 5818 5819**Since**: 12 5820 5821**Parameters** 5822 5823| Name| Description| 5824| -------- | -------- | 5825| option | Pointer to an alignment rule configuration. | 5826| id | ID of the anchor component. | 5827| value | Alignment mode relative to the anchor component. | 5828 5829 5830### OH_ArkUI_AlignmentRuleOption_SetCenterVertical() 5831 5832``` 5833void OH_ArkUI_AlignmentRuleOption_SetCenterVertical (ArkUI_AlignmentRuleOption * option, const char * id, ArkUI_VerticalAlignment alignment ) 5834``` 5835**Description** 5836 5837Sets the vertical center alignment parameters. 5838 5839**Since**: 12 5840 5841**Parameters** 5842 5843| Name| Description| 5844| -------- | -------- | 5845| option | Pointer to an alignment rule configuration. | 5846| id | ID of the anchor component. | 5847| value | Alignment mode relative to the anchor component. | 5848 5849 5850### OH_ArkUI_AlignmentRuleOption_SetEnd() 5851 5852``` 5853void OH_ArkUI_AlignmentRuleOption_SetEnd (ArkUI_AlignmentRuleOption * option, const char * id, ArkUI_HorizontalAlignment alignment ) 5854``` 5855**Description** 5856 5857Sets the right alignment parameters. 5858 5859**Since**: 12 5860 5861**Parameters** 5862 5863| Name| Description| 5864| -------- | -------- | 5865| option | Pointer to an alignment rule configuration. | 5866| id | ID of the anchor component. | 5867| value | Alignment mode relative to the anchor component. | 5868 5869 5870### OH_ArkUI_AlignmentRuleOption_SetStart() 5871 5872``` 5873void OH_ArkUI_AlignmentRuleOption_SetStart (ArkUI_AlignmentRuleOption * option, const char * id, ArkUI_HorizontalAlignment alignment ) 5874``` 5875**Description** 5876 5877Sets the left alignment parameters. 5878 5879**Since**: 12 5880 5881**Parameters** 5882 5883| Name| Description| 5884| -------- | -------- | 5885| option | Pointer to an alignment rule configuration. | 5886| id | ID of the anchor component. | 5887| value | Alignment mode relative to the anchor component. | 5888 5889 5890### OH_ArkUI_AlignmentRuleOption_SetTop() 5891 5892``` 5893void OH_ArkUI_AlignmentRuleOption_SetTop (ArkUI_AlignmentRuleOption * option, const char * id, ArkUI_VerticalAlignment alignment ) 5894``` 5895**Description** 5896 5897Sets the top alignment parameters. 5898 5899**Since**: 12 5900 5901**Parameters** 5902 5903| Name| Description| 5904| -------- | -------- | 5905| option | Pointer to an alignment rule configuration. | 5906| id | ID of the anchor component. | 5907| value | Alignment mode relative to the anchor component. | 5908 5909 5910### OH_ArkUI_AllowNodeAllDropDataTypes() 5911 5912``` 5913int32_t OH_ArkUI_AllowNodeAllDropDataTypes (ArkUI_NodeHandle node) 5914``` 5915**Description** 5916 5917Configures the specified component to allow any data types. This API resets the settings configured through [OH_ArkUI_SetNodeAllowedDropDataTypes](#oh_arkui_setnodealloweddropdatatypes). 5918 5919**Since**: 12 5920 5921**Parameters** 5922 5923| Name| Description| 5924| -------- | -------- | 5925| node | Pointer to a component node. | 5926 5927**Returns** 5928 5929Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 5930 5931 5932### OH_ArkUI_AnimateOption_Create() 5933 5934``` 5935ArkUI_AnimateOption* OH_ArkUI_AnimateOption_Create () 5936``` 5937**Description** 5938 5939Creates an animation configuration. 5940 5941**Since**: 12 5942 5943**Returns** 5944 5945Returns the pointer to the created animation configuration. 5946 5947 5948### OH_ArkUI_AnimateOption_Dispose() 5949 5950``` 5951void OH_ArkUI_AnimateOption_Dispose (ArkUI_AnimateOption * option) 5952``` 5953**Description** 5954 5955Disposes of an animation configuration. 5956 5957**Since**: 12 5958 5959 5960### OH_ArkUI_AnimateOption_GetCurve() 5961 5962``` 5963ArkUI_AnimationCurve OH_ArkUI_AnimateOption_GetCurve (ArkUI_AnimateOption * option) 5964``` 5965**Description** 5966 5967Obtains an animation curve. 5968 5969**Since**: 12 5970 5971**Parameters** 5972 5973| Name| Description| 5974| -------- | -------- | 5975| option | Pointer to an animation configuration. | 5976 5977**Returns** 5978 5979Returns the animation curve. 5980 5981 5982### OH_ArkUI_AnimateOption_GetDelay() 5983 5984``` 5985int32_t OH_ArkUI_AnimateOption_GetDelay (ArkUI_AnimateOption * option) 5986``` 5987**Description** 5988 5989Obtains the animation delay, in milliseconds. 5990 5991**Since**: 12 5992 5993**Parameters** 5994 5995| Name| Description| 5996| -------- | -------- | 5997| option | Pointer to an animation configuration. | 5998 5999**Returns** 6000 6001Returns the animation delay. 6002 6003 6004### OH_ArkUI_AnimateOption_GetDuration() 6005 6006``` 6007int32_t OH_ArkUI_AnimateOption_GetDuration (ArkUI_AnimateOption * option) 6008``` 6009**Description** 6010 6011Obtains the animation duration, in milliseconds. 6012 6013**Since**: 12 6014 6015**Parameters** 6016 6017| Name| Description| 6018| -------- | -------- | 6019| option | Pointer to an animation configuration. | 6020 6021**Returns** 6022 6023Returns the animation duration. 6024 6025 6026### OH_ArkUI_AnimateOption_GetExpectedFrameRateRange() 6027 6028``` 6029ArkUI_ExpectedFrameRateRange* OH_ArkUI_AnimateOption_GetExpectedFrameRateRange (ArkUI_AnimateOption * option) 6030``` 6031**Description** 6032 6033Obtains the expected frame rate range of an animation. 6034 6035**Since**: 12 6036 6037**Parameters** 6038 6039| Name| Description| 6040| -------- | -------- | 6041| option | Pointer to an animation configuration. | 6042 6043**Returns** 6044 6045Returns the expected frame rate range. 6046 6047 6048### OH_ArkUI_AnimateOption_GetICurve() 6049 6050``` 6051ArkUI_CurveHandle OH_ArkUI_AnimateOption_GetICurve (ArkUI_AnimateOption * option) 6052``` 6053**Description** 6054 6055Obtains the animation curve of an animation. 6056 6057**Since**: 12 6058 6059**Parameters** 6060 6061| Name| Description| 6062| -------- | -------- | 6063| option | Pointer to an animation configuration. | 6064 6065**Returns** 6066 6067Returns the animation curve of the specified animation. 6068 6069 6070### OH_ArkUI_AnimateOption_GetIterations() 6071 6072``` 6073int32_t OH_ArkUI_AnimateOption_GetIterations (ArkUI_AnimateOption * option) 6074``` 6075**Description** 6076 6077Obtains the number of times that an animation is played. 6078 6079**Since**: 12 6080 6081**Parameters** 6082 6083| Name| Description| 6084| -------- | -------- | 6085| option | Pointer to an animation configuration. | 6086 6087**Returns** 6088 6089Returns the number of times that the animation is played. 6090 6091### OH_ArkUI_AnimateOption_GetPlayMode() 6092 6093``` 6094ArkUI_AnimationPlayMode OH_ArkUI_AnimateOption_GetPlayMode (ArkUI_AnimateOption * option) 6095``` 6096**Description** 6097 6098Obtains the playback mode of an animation. 6099 6100**Since**: 12 6101 6102**Parameters** 6103 6104| Name| Description| 6105| -------- | -------- | 6106| option | Pointer to an animation configuration. | 6107 6108**Returns** 6109 6110Returns the animation playback mode. 6111 6112 6113### OH_ArkUI_AnimateOption_GetTempo() 6114 6115``` 6116float OH_ArkUI_AnimateOption_GetTempo (ArkUI_AnimateOption * option) 6117``` 6118**Description** 6119 6120Obtains the playback speed of an animation. 6121 6122**Since**: 12 6123 6124**Parameters** 6125 6126| Name| Description| 6127| -------- | -------- | 6128| option | Pointer to an animation configuration. | 6129 6130**Returns** 6131 6132Animation playback speed. 6133 6134 6135### OH_ArkUI_AnimateOption_SetCurve() 6136 6137``` 6138void OH_ArkUI_AnimateOption_SetCurve (ArkUI_AnimateOption * option, ArkUI_AnimationCurve value ) 6139``` 6140**Description** 6141 6142Sets the animation curve. 6143 6144**Since**: 12 6145 6146**Parameters** 6147 6148| Name| Description| 6149| -------- | -------- | 6150| option | Pointer to an animation configuration. | 6151| value | Returns the animation curve. Default value: **ARKUI_CURVE_LINEAR**. | 6152 6153 6154### OH_ArkUI_AnimateOption_SetDelay() 6155 6156``` 6157void OH_ArkUI_AnimateOption_SetDelay (ArkUI_AnimateOption * option, int32_t value ) 6158``` 6159**Description** 6160 6161Sets the animation delay. 6162 6163**Since**: 12 6164 6165**Parameters** 6166 6167| Name| Description| 6168| -------- | -------- | 6169| option | Pointer to an animation configuration. | 6170| value | Delay of animation playback. | 6171 6172 6173### OH_ArkUI_AnimateOption_SetDuration() 6174 6175``` 6176void OH_ArkUI_AnimateOption_SetDuration (ArkUI_AnimateOption * option, int32_t value ) 6177``` 6178**Description** 6179 6180Sets the animation duration. 6181 6182**Since**: 12 6183 6184**Parameters** 6185 6186| Name| Description| 6187| -------- | -------- | 6188| option | Pointer to an animation configuration. | 6189| value | Duration, in milliseconds. | 6190 6191 6192### OH_ArkUI_AnimateOption_SetExpectedFrameRateRange() 6193 6194``` 6195void OH_ArkUI_AnimateOption_SetExpectedFrameRateRange (ArkUI_AnimateOption * option, ArkUI_ExpectedFrameRateRange * value ) 6196``` 6197**Description** 6198 6199Sets the expected frame rate range of the animation. 6200 6201**Since**: 12 6202 6203**Parameters** 6204 6205| Name| Description| 6206| -------- | -------- | 6207| option | Pointer to an animation configuration. | 6208| value | Expected frame rate range of the animation. | 6209 6210 6211### OH_ArkUI_AnimateOption_SetICurve() 6212 6213``` 6214void OH_ArkUI_AnimateOption_SetICurve (ArkUI_AnimateOption * option, ArkUI_CurveHandle value ) 6215``` 6216**Description** 6217 6218Sets the animation curve for an animation. 6219 6220**Since**: 12 6221 6222**Parameters** 6223 6224| Name| Description| 6225| -------- | -------- | 6226| option | Pointer to an animation configuration. | 6227| value | Animation curve settings. | 6228 6229**NOTE** 6230 6231This API is preferred over the value set by **OH_ArkUI_AnimateOption_SetCurve**. 6232 6233 6234### OH_ArkUI_AnimateOption_SetIterations() 6235 6236``` 6237void OH_ArkUI_AnimateOption_SetIterations (ArkUI_AnimateOption * option, int32_t value ) 6238``` 6239**Description** 6240 6241Sets the number of times that an animation is played. 6242 6243**Since**: 12 6244 6245**Parameters** 6246 6247| Name| Description| 6248| -------- | -------- | 6249| option | Pointer to an animation configuration. | 6250| value | Number of times that the animation is played. | 6251 6252 6253### OH_ArkUI_AnimateOption_SetPlayMode() 6254 6255``` 6256void OH_ArkUI_AnimateOption_SetPlayMode (ArkUI_AnimateOption * option, ArkUI_AnimationPlayMode value ) 6257``` 6258**Description** 6259 6260Sets the playback mode for an animation. 6261 6262**Since**: 12 6263 6264**Parameters** 6265 6266| Name| Description| 6267| -------- | -------- | 6268| option | Pointer to an animation configuration. | 6269| value | Animation playback mode. | 6270 6271 6272### OH_ArkUI_AnimateOption_SetTempo() 6273 6274``` 6275void OH_ArkUI_AnimateOption_SetTempo (ArkUI_AnimateOption * option, float value ) 6276``` 6277**Description** 6278 6279Sets the playback speed of an animation. 6280 6281**Since**: 12 6282 6283**Parameters** 6284 6285| Name| Description| 6286| -------- | -------- | 6287| option | Pointer to an animation configuration. | 6288| value | Animation playback speed. | 6289 6290 6291### OH_ArkUI_Animator_Cancel() 6292 6293``` 6294int32_t OH_ArkUI_Animator_Cancel (ArkUI_AnimatorHandle animator) 6295``` 6296**Description** 6297 6298Cancels the animation of an animator. 6299 6300**Parameters** 6301 6302| Name| Description| 6303| -------- | -------- | 6304| animator | Animator object. | 6305 6306**Returns** 6307 6308Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6309 6310 6311### OH_ArkUI_Animator_Finish() 6312 6313``` 6314int32_t OH_ArkUI_Animator_Finish (ArkUI_AnimatorHandle animator) 6315``` 6316**Description** 6317 6318Ends the animation of an animator. 6319 6320**Parameters** 6321 6322| Name| Description| 6323| -------- | -------- | 6324| animator | Animator object. | 6325 6326**Returns** 6327 6328Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6329 6330 6331### OH_ArkUI_Animator_Pause() 6332 6333``` 6334int32_t OH_ArkUI_Animator_Pause (ArkUI_AnimatorHandle animator) 6335``` 6336**Description** 6337 6338Pauses the animation of an animator. 6339 6340**Parameters** 6341 6342| Name| Description| 6343| -------- | -------- | 6344| animator | Animator object. | 6345 6346**Returns** 6347 6348Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6349 6350 6351### OH_ArkUI_Animator_Play() 6352 6353``` 6354int32_t OH_ArkUI_Animator_Play (ArkUI_AnimatorHandle animator) 6355``` 6356**Description** 6357 6358Starts the animation of an animator. 6359 6360**Parameters** 6361 6362| Name| Description| 6363| -------- | -------- | 6364| animator | Animator object. | 6365 6366**Returns** 6367 6368Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6369 6370 6371### OH_ArkUI_Animator_ResetAnimatorOption() 6372 6373``` 6374int32_t OH_ArkUI_Animator_ResetAnimatorOption (ArkUI_AnimatorHandle animator, ArkUI_AnimatorOption * option ) 6375``` 6376**Description** 6377 6378Resets an animator configuration. 6379 6380**Parameters** 6381 6382| Name| Description| 6383| -------- | -------- | 6384| animator | Animator object. | 6385| option | Pointer to an animation configuration. | 6386 6387**Returns** 6388 6389Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6390 6391 6392### OH_ArkUI_Animator_Reverse() 6393 6394``` 6395int32_t OH_ArkUI_Animator_Reverse (ArkUI_AnimatorHandle animator) 6396``` 6397**Description** 6398 6399Plays the animation of an animator in reverse order. 6400 6401**Parameters** 6402 6403| Name| Description| 6404| -------- | -------- | 6405| animator | Animator object. | 6406 6407**Returns** 6408 6409Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6410 6411 6412### OH_ArkUI_AnimatorEvent_GetUserData() 6413 6414``` 6415void* OH_ArkUI_AnimatorEvent_GetUserData (ArkUI_AnimatorEvent * event) 6416``` 6417**Description** 6418 6419Obtains the custom object in an animation event object. 6420 6421**Since**: 12 6422 6423**Parameters** 6424 6425| Name| Description| 6426| -------- | -------- | 6427| event | Animation event object. | 6428 6429**Returns** 6430 6431Returns the custom object. 6432 6433 6434### OH_ArkUI_AnimatorOnFrameEvent_GetUserData() 6435 6436``` 6437void* OH_ArkUI_AnimatorOnFrameEvent_GetUserData (ArkUI_AnimatorOnFrameEvent * event) 6438``` 6439**Description** 6440 6441Obtains the custom object in an animation event object. 6442 6443**Since**: 12 6444 6445**Parameters** 6446 6447| Name| Description| 6448| -------- | -------- | 6449| event | Animation event object. | 6450 6451**Returns** 6452 6453Returns the custom object. 6454 6455 6456### OH_ArkUI_AnimatorOnFrameEvent_GetValue() 6457 6458``` 6459float OH_ArkUI_AnimatorOnFrameEvent_GetValue (ArkUI_AnimatorOnFrameEvent * event) 6460``` 6461**Description** 6462 6463Obtains the current progress in an animation event object. 6464 6465**Since**: 12 6466 6467**Parameters** 6468 6469| Name| Description| 6470| -------- | -------- | 6471| event | Animation event object. | 6472 6473**Returns** 6474 6475Returns the animation progress. 6476 6477 6478### OH_ArkUI_AnimatorOption_Create() 6479 6480``` 6481ArkUI_AnimatorOption* OH_ArkUI_AnimatorOption_Create (int32_t keyframeSize) 6482``` 6483**Description** 6484 6485Creates an animator parameter object. 6486 6487**Since**: 12 6488 6489**Parameters** 6490 6491| Name| Description| 6492| -------- | -------- | 6493| keyframeSize | Number of keyframes. | 6494 6495**NOTE** 6496 6497If the value of **keyframeSize** is greater than 0, the animation interpolation start point is 0, and the animation interpolation end point is 1; no setting is allowed. 6498 6499**Returns** 6500 6501Returns the pointer to the animator parameter object. 6502 6503 6504### OH_ArkUI_AnimatorOption_Dispose() 6505 6506``` 6507void OH_ArkUI_AnimatorOption_Dispose (ArkUI_AnimatorOption * option) 6508``` 6509**Description** 6510 6511Disposes of an **AnimatorOption** object. 6512 6513**Since**: 12 6514 6515 6516### OH_ArkUI_AnimatorOption_GetBegin() 6517 6518``` 6519float OH_ArkUI_AnimatorOption_GetBegin (ArkUI_AnimatorOption * option) 6520``` 6521**Description** 6522 6523Obtains the interpolation start point of an animation. 6524 6525**Since**: 12 6526 6527**Parameters** 6528 6529| Name| Description| 6530| -------- | -------- | 6531| option | Pointer to an animation configuration. | 6532 6533**Returns** 6534 6535Returns the start point of the animation interpolation. 6536 6537 6538### OH_ArkUI_AnimatorOption_GetCurve() 6539 6540``` 6541ArkUI_CurveHandle OH_ArkUI_AnimatorOption_GetCurve (ArkUI_AnimatorOption * option) 6542``` 6543**Description** 6544 6545Obtains the interpolation curve of the animation of an animator. 6546 6547**Since**: 12 6548 6549**Parameters** 6550 6551| Name| Description| 6552| -------- | -------- | 6553| option | Pointer to an animation configuration. | 6554 6555**Returns** 6556 6557Returns the interpolation curve of the animation. 6558 6559 6560### OH_ArkUI_AnimatorOption_GetDelay() 6561 6562``` 6563int32_t OH_ArkUI_AnimatorOption_GetDelay (ArkUI_AnimatorOption * option) 6564``` 6565**Description** 6566 6567Obtains the delay for playing an animation. 6568 6569**Since**: 12 6570 6571**Parameters** 6572 6573| Name| Description| 6574| -------- | -------- | 6575| option | Pointer to an animation configuration. | 6576 6577**Returns** 6578 6579Returns the delay for playing the animation, in milliseconds. 6580 6581 6582### OH_ArkUI_AnimatorOption_GetDirection() 6583 6584``` 6585ArkUI_AnimationDirection OH_ArkUI_AnimatorOption_GetDirection (ArkUI_AnimatorOption * option) 6586``` 6587**Description** 6588 6589Obtains the playback direction of an animation. 6590 6591**Since**: 12 6592 6593**Parameters** 6594 6595| Name| Description| 6596| -------- | -------- | 6597| option | Pointer to an animation configuration. | 6598 6599**Returns** 6600 6601Returns the animation playback direction. 6602 6603 6604### OH_ArkUI_AnimatorOption_GetDuration() 6605 6606``` 6607int32_t OH_ArkUI_AnimatorOption_GetDuration (ArkUI_AnimatorOption * option) 6608``` 6609**Description** 6610 6611Obtains the duration for playing an animation. 6612 6613**Since**: 12 6614 6615**Parameters** 6616 6617| Name| Description| 6618| -------- | -------- | 6619| option | Pointer to an animation configuration. | 6620 6621**Returns** 6622 6623Returns the duration for playing the animation, in milliseconds. 6624 6625 6626### OH_ArkUI_AnimatorOption_GetEnd() 6627 6628``` 6629float OH_ArkUI_AnimatorOption_GetEnd (ArkUI_AnimatorOption * option) 6630``` 6631**Description** 6632 6633Obtains the interpolation end point of an animation. 6634 6635**Since**: 12 6636 6637**Parameters** 6638 6639| Name| Description| 6640| -------- | -------- | 6641| option | Pointer to an animation configuration. | 6642 6643**Returns** 6644 6645Returns the interpolation end point of the animation. 6646 6647 6648### OH_ArkUI_AnimatorOption_GetExpectedFrameRateRange() 6649 6650``` 6651ArkUI_ExpectedFrameRateRange* OH_ArkUI_AnimatorOption_GetExpectedFrameRateRange (ArkUI_AnimatorOption * option) 6652``` 6653**Description** 6654 6655Obtains the expected frame rate range of an animation. 6656 6657**Since**: 12 6658 6659**Parameters** 6660 6661| Name| Description| 6662| -------- | -------- | 6663| option | Pointer to an animation configuration. | 6664 6665**Returns** 6666 6667Returns the pointer to the expected frame rate range object. 6668 6669 6670### OH_ArkUI_AnimatorOption_GetFill() 6671 6672``` 6673ArkUI_AnimationFill OH_ArkUI_AnimatorOption_GetFill (ArkUI_AnimatorOption * option) 6674``` 6675**Description** 6676 6677Obtains whether the animator animation is restored to the initial state after being executed. 6678 6679**Since**: 12 6680 6681**Parameters** 6682 6683| Name| Description| 6684| -------- | -------- | 6685| option | Pointer to an animation configuration. | 6686 6687**Returns** 6688 6689Returns whether the animator animation is restored to the initial state after being executed. 6690 6691 6692### OH_ArkUI_AnimatorOption_GetIterations() 6693 6694``` 6695int32_t OH_ArkUI_AnimatorOption_GetIterations (ArkUI_AnimatorOption * option) 6696``` 6697**Description** 6698 6699Obtains the number of times that an animation is played. 6700 6701**Since**: 12 6702 6703**Parameters** 6704 6705| Name| Description| 6706| -------- | -------- | 6707| option | Pointer to an **AnimatorOption** object. | 6708 6709**Returns** 6710 6711Number of times that the animation is played. 6712 6713 6714### OH_ArkUI_AnimatorOption_GetKeyframeCurve() 6715 6716``` 6717ArkUI_CurveHandle OH_ArkUI_AnimatorOption_GetKeyframeCurve (ArkUI_AnimatorOption * option, int32_t index ) 6718``` 6719**Description** 6720 6721Obtains the interpolation curve for a keyframe in the animation of an animator. 6722 6723**Since**: 12 6724 6725**Parameters** 6726 6727| Name| Description| 6728| -------- | -------- | 6729| option | Pointer to an **AnimatorOption** object. | 6730| index | Keyframe index. | 6731 6732**Returns** 6733 6734Returns the interpolation curve. 6735 6736 6737### OH_ArkUI_AnimatorOption_GetKeyframeTime() 6738 6739``` 6740float OH_ArkUI_AnimatorOption_GetKeyframeTime (ArkUI_AnimatorOption * option, int32_t index ) 6741``` 6742**Description** 6743 6744Obtains the keyframe time of an animation. 6745 6746**Since**: 12 6747 6748**Parameters** 6749 6750| Name| Description| 6751| -------- | -------- | 6752| option | Pointer to an **AnimatorOption** object. | 6753| index | Keyframe index. | 6754 6755**Returns** 6756 6757Keyframe time. 6758 6759 6760### OH_ArkUI_AnimatorOption_GetKeyframeValue() 6761 6762``` 6763float OH_ArkUI_AnimatorOption_GetKeyframeValue (ArkUI_AnimatorOption * option, int32_t index ) 6764``` 6765**Description** 6766 6767Obtains the keyframe value of an animation. 6768 6769**Since**: 12 6770 6771**Parameters** 6772 6773| Name| Description| 6774| -------- | -------- | 6775| option | Pointer to an **AnimatorOption** object. | 6776| index | Keyframe index. | 6777 6778**Returns** 6779 6780Keyframe value. 6781 6782 6783### OH_ArkUI_AnimatorOption_RegisterOnCancelCallback() 6784 6785``` 6786int32_t OH_ArkUI_AnimatorOption_RegisterOnCancelCallback (ArkUI_AnimatorOption * option, void * userData, void(*)(ArkUI_AnimatorEvent *event) callback ) 6787``` 6788**Description** 6789 6790Sets the callback invoked when the animation playback is canceled. 6791 6792**Parameters** 6793 6794| Name| Description| 6795| -------- | -------- | 6796| option | Pointer to an animation configuration. | 6797| userData | Custom parameter. | 6798| callback | Callback used to return the result. | 6799 6800**Returns** 6801 6802Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6803 6804 6805### OH_ArkUI_AnimatorOption_RegisterOnFinishCallback() 6806 6807``` 6808int32_t OH_ArkUI_AnimatorOption_RegisterOnFinishCallback (ArkUI_AnimatorOption * option, void * userData, void(*)(ArkUI_AnimatorEvent *event) callback ) 6809``` 6810**Description** 6811 6812Sets the callback invoked when the animation playback is complete. 6813 6814**Parameters** 6815 6816| Name| Description| 6817| -------- | -------- | 6818| option | Pointer to an animation configuration. | 6819| userData | Custom parameter. | 6820| callback | Callback used to return the result. | 6821 6822**Returns** 6823 6824Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6825 6826 6827### OH_ArkUI_AnimatorOption_RegisterOnFrameCallback() 6828 6829``` 6830int32_t OH_ArkUI_AnimatorOption_RegisterOnFrameCallback (ArkUI_AnimatorOption * option, void * userData, void(*)(ArkUI_AnimatorOnFrameEvent *event) callback ) 6831``` 6832**Description** 6833 6834Sets the callback invoked when the animator receives a frame. 6835 6836**Parameters** 6837 6838| Name| Description| 6839| -------- | -------- | 6840| option | Pointer to an animation configuration. | 6841| userData | Custom parameter. | 6842| callback | Callback used to return the result. | 6843 6844**Returns** 6845 6846Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6847 6848 6849### OH_ArkUI_AnimatorOption_RegisterOnRepeatCallback() 6850 6851``` 6852int32_t OH_ArkUI_AnimatorOption_RegisterOnRepeatCallback (ArkUI_AnimatorOption * option, void * userData, void(*)(ArkUI_AnimatorEvent *event) callback ) 6853``` 6854**Description** 6855 6856Sets the callback invoked when the animation playback is repeated. 6857 6858**Parameters** 6859 6860| Name| Description| 6861| -------- | -------- | 6862| option | Pointer to an animation configuration. | 6863| userData | Custom parameter. | 6864| callback | Callback used to return the result. | 6865 6866**Returns** 6867 6868Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6869 6870 6871### OH_ArkUI_AnimatorOption_SetBegin() 6872 6873``` 6874int32_t OH_ArkUI_AnimatorOption_SetBegin (ArkUI_AnimatorOption * option, float value ) 6875``` 6876**Description** 6877 6878Sets the interpolation start point for the animation of an animator. 6879 6880**Parameters** 6881 6882| Name| Description| 6883| -------- | -------- | 6884| option | Pointer to an **AnimatorOption** object. | 6885| value | Start point of the animation interpolation. | 6886 6887**NOTE** 6888 6889This API does not take effect when the animation is a keyframe animation. 6890 6891**Returns** 6892 6893Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6894 6895 6896### OH_ArkUI_AnimatorOption_SetCurve() 6897 6898``` 6899int32_t OH_ArkUI_AnimatorOption_SetCurve (ArkUI_AnimatorOption * option, ArkUI_CurveHandle value ) 6900``` 6901**Description** 6902 6903Sets the interpolation curve for the animation of an animator. 6904 6905**Parameters** 6906 6907| Name| Description| 6908| -------- | -------- | 6909| option | Pointer to an **AnimatorOption** object. | 6910| value | Returns the interpolation curve of the animation. Default value: **ARKUI_CURVE_LINEAR**. | 6911 6912**NOTE** 6913 6914The **springCurve**, **springMotion**, **responsiveSpringMotion**, and **interpolatingSpring customCurve** curves are not supported. 6915 6916**Returns** 6917 6918Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6919 6920 6921### OH_ArkUI_AnimatorOption_SetDelay() 6922 6923``` 6924int32_t OH_ArkUI_AnimatorOption_SetDelay (ArkUI_AnimatorOption * option, int32_t value ) 6925``` 6926**Description** 6927 6928Sets the delay of animation playback, in milliseconds. 6929 6930**Parameters** 6931 6932| Name| Description| 6933| -------- | -------- | 6934| option | Pointer to an **AnimatorOption** object. | 6935| value | Animation delay, in milliseconds. | 6936 6937**Returns** 6938 6939Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6940 6941 6942### OH_ArkUI_AnimatorOption_SetDirection() 6943 6944``` 6945int32_t OH_ArkUI_AnimatorOption_SetDirection (ArkUI_AnimatorOption * option, ArkUI_AnimationDirection value ) 6946``` 6947**Description** 6948 6949Sets the playback direction. 6950 6951**Parameters** 6952 6953| Name| Description| 6954| -------- | -------- | 6955| option | Pointer to an **AnimatorOption** object. | 6956| value | Animation playback direction. | 6957 6958**Returns** 6959 6960Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6961 6962 6963### OH_ArkUI_AnimatorOption_SetDuration() 6964 6965``` 6966int32_t OH_ArkUI_AnimatorOption_SetDuration (ArkUI_AnimatorOption * option, int32_t value ) 6967``` 6968**Description** 6969 6970Sets the duration of an animation, in milliseconds. 6971 6972**Parameters** 6973 6974| Name| Description| 6975| -------- | -------- | 6976| option | Pointer to an **AnimatorOption** object. | 6977| value | Duration for playing the animation, in milliseconds. | 6978 6979**Returns** 6980 6981Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6982 6983 6984### OH_ArkUI_AnimatorOption_SetEnd() 6985 6986``` 6987int32_t OH_ArkUI_AnimatorOption_SetEnd (ArkUI_AnimatorOption * option, float value ) 6988``` 6989**Description** 6990 6991Sets the interpolation end point for the animation of an animator. 6992 6993**Parameters** 6994 6995| Name| Description| 6996| -------- | -------- | 6997| option | Pointer to an **AnimatorOption** object. | 6998| value | End point of animation interpolation. | 6999 7000**NOTE** 7001 7002This API does not take effect when the animation is a keyframe animation. 7003 7004**Returns** 7005 7006Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7007 7008 7009### OH_ArkUI_AnimatorOption_SetExpectedFrameRateRange() 7010 7011``` 7012int32_t OH_ArkUI_AnimatorOption_SetExpectedFrameRateRange (ArkUI_AnimatorOption * option, ArkUI_ExpectedFrameRateRange * value ) 7013``` 7014**Description** 7015 7016Sets the expected frame rate range of an animation. 7017 7018**Parameters** 7019 7020| Name| Description| 7021| -------- | -------- | 7022| option | Pointer to an **AnimatorOption** object. | 7023| value | Expected frame rate range. | 7024 7025**Returns** 7026 7027Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7028 7029 7030### OH_ArkUI_AnimatorOption_SetFill() 7031 7032``` 7033int32_t OH_ArkUI_AnimatorOption_SetFill (ArkUI_AnimatorOption * option, ArkUI_AnimationFill value ) 7034``` 7035**Description** 7036 7037Sets whether the animator animation is restored to the initial state after being executed. 7038 7039**Parameters** 7040 7041| Name| Description| 7042| -------- | -------- | 7043| option | Pointer to an **AnimatorOption** object. | 7044| value | Whether to restore the animation to the initial state after the animation is executed. | 7045 7046**Returns** 7047 7048Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7049 7050 7051### OH_ArkUI_AnimatorOption_SetIterations() 7052 7053``` 7054int32_t OH_ArkUI_AnimatorOption_SetIterations (ArkUI_AnimatorOption * option, int32_t value ) 7055``` 7056**Description** 7057 7058Sets the number of times that the frame animation is played. The value **0** means not to play the animation, and **-1** means to play the animation for an unlimited number of times. 7059 7060**Parameters** 7061 7062| Name| Description| 7063| -------- | -------- | 7064| option | Pointer to an **AnimatorOption** object. | 7065| value | Number of times that the animation is played. | 7066 7067**NOTE** 7068 7069If this parameter is set to a negative value other than **-1**, the value is invalid. In this case, the animation is played once. 7070 7071**Returns** 7072 7073Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7074 7075 7076### OH_ArkUI_AnimatorOption_SetKeyframe() 7077 7078``` 7079int32_t OH_ArkUI_AnimatorOption_SetKeyframe (ArkUI_AnimatorOption * option, float time, float value, int32_t index ) 7080``` 7081**Description** 7082 7083Sets the keyframe parameters of an animation. 7084 7085**Parameters** 7086 7087| Name| Description| 7088| -------- | -------- | 7089| option | Pointer to an **AnimatorOption** object. | 7090| time | Keyframe time. Value range: [0, 1]. The value must be in ascending order. | 7091| value | Keyframe value. | 7092| index | Keyframe index. | 7093 7094**Returns** 7095 7096Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7097 7098 7099### OH_ArkUI_AnimatorOption_SetKeyframeCurve() 7100 7101``` 7102int32_t OH_ArkUI_AnimatorOption_SetKeyframeCurve (ArkUI_AnimatorOption * option, ArkUI_CurveHandle value, int32_t index ) 7103``` 7104**Description** 7105 7106Sets the keyframe curve type for the animation of an animator. 7107 7108**Parameters** 7109 7110| Name| Description| 7111| -------- | -------- | 7112| option | Pointer to an **AnimatorOption** object. | 7113| value | Animation interpolation curve. | 7114| index | Keyframe index. | 7115 7116**NOTE** 7117 7118The **springCurve**, **springMotion**, **responsiveSpringMotion**, and **interpolatingSpring customCurve** curves are not supported. 7119 7120**Returns** 7121 7122Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7123 7124 7125### OH_ArkUI_BarrierOption_Create() 7126 7127``` 7128ArkUI_BarrierOption* OH_ArkUI_BarrierOption_Create (int32_t size) 7129``` 7130**Description** 7131 7132Creates a barrier configuration for this **RelativeContainer** component. 7133 7134**Since**: 12 7135 7136**Parameters** 7137 7138| Name| Description| 7139| -------- | -------- | 7140| size | Number of barriers. | 7141 7142**Returns** 7143 7144Returns the barrier configuration. 7145 7146 7147### OH_ArkUI_BarrierOption_Dispose() 7148 7149``` 7150void OH_ArkUI_BarrierOption_Dispose (ArkUI_BarrierOption * barrierStyle) 7151``` 7152**Description** 7153 7154Disposes of a barrier configuration. 7155 7156**Since**: 12 7157 7158**Parameters** 7159 7160| Name| Description| 7161| -------- | -------- | 7162| barrierStyle | Pointer to a barrier configuration. | 7163 7164 7165### OH_ArkUI_BarrierOption_GetDirection() 7166 7167``` 7168ArkUI_BarrierDirection OH_ArkUI_BarrierOption_GetDirection (ArkUI_BarrierOption * barrierStyle, int32_t index ) 7169``` 7170**Description** 7171 7172Obtains the direction of a barrier. 7173 7174**Since**: 12 7175 7176**Parameters** 7177 7178| Name| Description| 7179| -------- | -------- | 7180| barrierStyle | Pointer to a barrier configuration. | 7181| index | Index of the barrier. | 7182 7183**Returns** 7184 7185Returns the direction of the barrier. 7186 7187 7188### OH_ArkUI_BarrierOption_GetId() 7189 7190``` 7191const char* OH_ArkUI_BarrierOption_GetId (ArkUI_BarrierOption * barrierStyle, int32_t index ) 7192``` 7193**Description** 7194 7195Obtains the ID of a barrier. 7196 7197**Since**: 12 7198 7199**Parameters** 7200 7201| Name| Description| 7202| -------- | -------- | 7203| barrierStyle | Pointer to a barrier configuration. | 7204| index | Index of the barrier. | 7205 7206**Returns** 7207 7208Returns the ID of the barrier. 7209 7210 7211### OH_ArkUI_BarrierOption_GetReferencedId() 7212 7213``` 7214const char* OH_ArkUI_BarrierOption_GetReferencedId (ArkUI_BarrierOption * barrierStyle, int32_t index, int32_t referencedIndex ) 7215``` 7216**Description** 7217 7218Obtains the referenced components of a barrier. 7219 7220**Since**: 12 7221 7222**Parameters** 7223 7224| Name| Description| 7225| -------- | -------- | 7226| barrierStyle | Pointer to a barrier configuration. | 7227| index | Index of the barrier. | 7228| referencedIndex | Index of the referenced component ID. | 7229 7230**Returns** 7231 7232Returns the referenced components of the barrier. 7233 7234 7235### OH_ArkUI_BarrierOption_GetReferencedIdSize() 7236 7237``` 7238int32_t OH_ArkUI_BarrierOption_GetReferencedIdSize (ArkUI_BarrierOption * barrierStyle, int32_t index ) 7239``` 7240**Description** 7241 7242Obtains the number of referenced components of a barrier. 7243 7244**Since**: 12 7245 7246**Parameters** 7247 7248| Name| Description| 7249| -------- | -------- | 7250| barrierStyle | Pointer to a barrier configuration. | 7251| index | Index of the barrier. | 7252 7253**Returns** 7254 7255Returns the number of referenced components of the barrier. 7256 7257 7258### OH_ArkUI_BarrierOption_SetDirection() 7259 7260``` 7261void OH_ArkUI_BarrierOption_SetDirection (ArkUI_BarrierOption * barrierStyle, ArkUI_BarrierDirection value, int32_t index ) 7262``` 7263**Description** 7264 7265Sets the direction of a barrier. 7266 7267**Since**: 12 7268 7269**Parameters** 7270 7271| Name| Description| 7272| -------- | -------- | 7273| barrierStyle | Pointer to a barrier configuration. | 7274| value | Direction. | 7275| index | Index of the barrier. | 7276 7277 7278### OH_ArkUI_BarrierOption_SetId() 7279 7280``` 7281void OH_ArkUI_BarrierOption_SetId (ArkUI_BarrierOption * barrierStyle, const char * value, int32_t index ) 7282``` 7283**Description** 7284 7285Sets the ID of a barrier. 7286 7287**Since**: 12 7288 7289**Parameters** 7290 7291| Name| Description| 7292| -------- | -------- | 7293| barrierStyle | Pointer to a barrier configuration. | 7294| value | ID of the barrier, which must be unique and cannot be the same as the name of any component in the container. | 7295| index | Index of the barrier. | 7296 7297 7298### OH_ArkUI_BarrierOption_SetReferencedId() 7299 7300``` 7301void OH_ArkUI_BarrierOption_SetReferencedId (ArkUI_BarrierOption * barrierStyle, const char * value, int32_t index ) 7302``` 7303**Description** 7304 7305Sets the referenced components of a barrier. 7306 7307**Since**: 12 7308 7309**Parameters** 7310 7311| Name| Description| 7312| -------- | -------- | 7313| barrierStyle | Pointer to a barrier configuration. | 7314| value | Referenced component IDs. | 7315| index | Index of the barrier. | 7316 7317 7318### OH_ArkUI_ConvertToHtml() 7319 7320``` 7321const char* OH_ArkUI_ConvertToHtml (ArkUI_StyledString_Descriptor * descriptor) 7322``` 7323**Description** 7324 7325Converts styled string information into HTML. 7326 7327**Since**: 14 7328 7329**Parameters** 7330 7331| Name| Description| 7332| -------- | -------- | 7333| descriptor | Pointer to an **ArkUI_StyledString_Descriptor** object. | 7334 7335**Returns** 7336 7337Returns an HTML object. The pointer is managed internally and should be destroyed by calling **OH_ArkUI_StyledString_Descriptor_Destroy()** when no longer needed to free the memory. 7338 7339 7340### OH_ArkUI_CreateAsymmetricTransitionEffect() 7341 7342``` 7343ArkUI_TransitionEffect* OH_ArkUI_CreateAsymmetricTransitionEffect (ArkUI_TransitionEffect * appear, ArkUI_TransitionEffect * disappear ) 7344``` 7345**Description** 7346 7347Creates an asymmetric transition effect. 7348 7349**Since**: 12 7350 7351**Parameters** 7352 7353| Name| Description| 7354| -------- | -------- | 7355| appear | Transition effect for appearance. | 7356| disappear | Transition effect for disappearance. | 7357 7358**NOTE** 7359 7360If the **asymmetric** function is not used for constructing **TransitionEffect**, the transition effect takes effect for both appearance and disappearance of the component. 7361 7362**Returns** 7363 7364Returns the asymmetric transition effect; returns **NULL** if a parameter error occurs. 7365 7366 7367### OH_ArkUI_CreateDragActionWithContext() 7368 7369``` 7370ArkUI_DragAction* OH_ArkUI_CreateDragActionWithContext (ArkUI_ContextHandle uiContext) 7371``` 7372**Description** 7373 7374Creates a drag action object for the specified UI instance. 7375 7376**Since**: 12 7377 7378**Parameters** 7379 7380| Name| Description| 7381| -------- | -------- | 7382| uiContext | Pointer to the UI instance object. | 7383 7384**Returns** 7385 7386Returns the pointer to the created drag action object; returns null if the operation fails. 7387 7388 7389### OH_ArkUI_CreateDragActionWithNode() 7390 7391``` 7392ArkUI_DragAction* OH_ArkUI_CreateDragActionWithNode (ArkUI_NodeHandle node) 7393``` 7394**Description** 7395 7396Creates a drag action object. The object needs to be associated with a UI instance, which can be specified by passing in a component node of the current UI instance. 7397 7398**Since**: 12 7399 7400**Parameters** 7401 7402| Name| Description| 7403| -------- | -------- | 7404| node | Pointer to a component node. | 7405 7406**Returns** 7407 7408Returns the pointer to the created drag action object; returns null if the operation fails. 7409 7410 7411### OH_ArkUI_CreateDragPreviewOption() 7412 7413``` 7414ArkUI_DragPreviewOption* OH_ArkUI_CreateDragPreviewOption (void ) 7415``` 7416**Description** 7417 7418Creates an **ArkUI_DragPreviewOption** object. 7419 7420**Since**: 12 7421 7422**Returns** 7423 7424ArkUI_DragPreviewOption object. 7425 7426 7427### OH_ArkUI_CreateMovementTransitionEffect() 7428 7429``` 7430ArkUI_TransitionEffect* OH_ArkUI_CreateMovementTransitionEffect (ArkUI_TransitionEdge move) 7431``` 7432**Description** 7433 7434Creates a movement object for component transition. 7435 7436**Since**: 12 7437 7438**Parameters** 7439 7440| Name| Description| 7441| -------- | -------- | 7442| move | Panning type. | 7443 7444**Returns** 7445 7446Returns the movement object created for component transition; returns **NULL** if a parameter error occurs. 7447 7448 7449### OH_ArkUI_CreateOpacityTransitionEffect() 7450 7451``` 7452ArkUI_TransitionEffect* OH_ArkUI_CreateOpacityTransitionEffect (float opacity) 7453``` 7454**Description** 7455 7456Creates an opacity object for component transition. 7457 7458**Since**: 12 7459 7460**Parameters** 7461 7462| Name| Description| 7463| -------- | -------- | 7464| opacity | Opacity. The value range is [0, 1]. | 7465 7466**NOTE** 7467 7468If the value specified is less than 0, the value **0** is used. If the value specified is greater than 1, the value **1** is used. 7469 7470**Returns** 7471 7472Returns the created opacity object for component transition. 7473 7474 7475### OH_ArkUI_CreateRotationTransitionEffect() 7476 7477``` 7478ArkUI_TransitionEffect* OH_ArkUI_CreateRotationTransitionEffect (ArkUI_RotationOptions * rotate) 7479``` 7480**Description** 7481 7482Creates a rotation object for component transition. 7483 7484**Since**: 12 7485 7486**Parameters** 7487 7488| Name| Description| 7489| -------- | -------- | 7490| rotate | Rotation parameter object during component transition. | 7491 7492**Returns** 7493 7494Returns the rotation object created for component transition; returns **NULL** if a parameter error occurs. 7495 7496 7497### OH_ArkUI_CreateScaleTransitionEffect() 7498 7499``` 7500ArkUI_TransitionEffect* OH_ArkUI_CreateScaleTransitionEffect (ArkUI_ScaleOptions * scale) 7501``` 7502**Description** 7503 7504Creates a scaling transition effect object. 7505 7506**Since**: 12 7507 7508**Parameters** 7509 7510| Name| Description| 7511| -------- | -------- | 7512| scale | Scaling settings for component transition. | 7513 7514**Returns** 7515 7516Returns the created scaling transition effect object; returns **NULL** if a parameter error occurs. 7517 7518 7519### OH_ArkUI_CreateTranslationTransitionEffect() 7520 7521``` 7522ArkUI_TransitionEffect* OH_ArkUI_CreateTranslationTransitionEffect (ArkUI_TranslationOptions * translate) 7523``` 7524**Description** 7525 7526Creates a translation transition effect object. 7527 7528**Since**: 12 7529 7530**Parameters** 7531 7532| Name| Description| 7533| -------- | -------- | 7534| translate | Translation settings for component transition. | 7535 7536**Returns** 7537 7538Returns the created translation transition effect object; returns **NULL** if a parameter error occurs. 7539 7540### OH_ArkUI_Curve_CreateCubicBezierCurve() 7541 7542``` 7543ArkUI_CurveHandle OH_ArkUI_Curve_CreateCubicBezierCurve (float x1, float y1, float x2, float y2 ) 7544``` 7545**Description** 7546 7547Creates a cubic Bezier curve. 7548 7549**Parameters** 7550 7551| Name| Description| 7552| -------- | -------- | 7553| x1 | X coordinate of the first point on the Bezier curve. Value range: [0, 1]. A value less than 0 evaluates to the value **0**. A value greater than 1 evaluates to the value **1**. | 7554| y1 | Y coordinate of the first point on the Bezier curve. | 7555| x2 | X coordinate of the second point on the Bezier curve. Value range: [0, 1]. A value less than 0 evaluates to the value **0**. A value greater than 1 evaluates to the value **1**. | 7556| y2 | Y coordinate of the second point on the Bezier curve. | 7557 7558**Returns** 7559 7560Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 7561 7562 7563### OH_ArkUI_Curve_CreateCurveByType() 7564 7565``` 7566ArkUI_CurveHandle OH_ArkUI_Curve_CreateCurveByType (ArkUI_AnimationCurve curve) 7567``` 7568**Description** 7569 7570Implements initialization for the interpolation curve, which is used to create an interpolation curve based on the input parameter. 7571 7572**Parameters** 7573 7574| Name| Description| 7575| -------- | -------- | 7576| curve | Curve type. | 7577 7578**Returns** 7579 7580Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 7581 7582 7583### OH_ArkUI_Curve_CreateCustomCurve() 7584 7585``` 7586ArkUI_CurveHandle OH_ArkUI_Curve_CreateCustomCurve (void * userData, float(*)(float fraction, void *userdata) interpolate ) 7587``` 7588**Description** 7589 7590Creates a custom curve. 7591 7592**Parameters** 7593 7594| Name| Description| 7595| -------- | -------- | 7596| userData | Custom data. | 7597| interpolate | Custom interpolation callback. **fraction** indicates the input x value for interpolation when the animation starts; value range: [0,1]. The return value is the **y** value of the curve; value range: [0,1]. If **fraction** is **0**, the return value **0** corresponds to the animation start point; any other return value means that the animation jumps at the start point. If **fraction** is **1**, the return value **1** corresponds to the animation end point; any other return value means that the end value of the animation is not the value of the state variable, which will result in an effect of transition from that end value to the value of the state variable. | 7598 7599**Returns** 7600 7601Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 7602 7603 7604### OH_ArkUI_Curve_CreateInterpolatingSpring() 7605 7606``` 7607ArkUI_CurveHandle OH_ArkUI_Curve_CreateInterpolatingSpring (float velocity, float mass, float stiffness, float damping ) 7608``` 7609**Description** 7610 7611Creates an interpolating spring curve animated from 0 to 1. The actual animation value is calculated based on the curve. 7612 7613**Parameters** 7614 7615| Name| Description| 7616| -------- | -------- | 7617| velocity | Initial velocity. It is applied by external factors to the spring animation, designed to help ensure the smooth transition from the previous motion state. The velocity is the normalized velocity, and its value is equal to the actual velocity at the beginning of the animation divided by the animation attribute change value. | 7618| mass | Mass, which influences the inertia in the spring system. The greater the mass, the greater the amplitude of the oscillation, and the slower the speed of restoring to the equilibrium position. | 7619| stiffness | Stiffness. It is the degree to which an object deforms by resisting the force applied. In an elastic system, the greater the stiffness, the stronger the ability to resist deformation, and the faster the speed of restoring to the equilibrium position. | 7620| damping | Damping. It is used to describe the oscillation and attenuation of the system after being disturbed. The larger the damping, the smaller the number of oscillations of elastic motion, and the smaller the oscillation amplitude. | 7621 7622**NOTE** 7623 7624The animation duration is subject to the curve parameters, rather than the **duration** parameter in **animation** or **animateTo**. 7625 7626**Returns** 7627 7628Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 7629 7630 7631### OH_ArkUI_Curve_CreateResponsiveSpringMotion() 7632 7633``` 7634ArkUI_CurveHandle OH_ArkUI_Curve_CreateResponsiveSpringMotion (float response, float dampingFraction, float overlapDuration ) 7635``` 7636**Description** 7637 7638Creates a responsive spring animation curve. It is a special case of **springMotion**, with the only difference in the default values. It can be used together with **springMotion**. 7639 7640**Parameters** 7641 7642| Name| Description| 7643| -------- | -------- | 7644| response | Duration of one complete oscillation. | 7645| dampingFraction | Damping coefficient. If the value is greater than 0 and less than 1, the value is underdamped and exceeds the target value during motion. If the value is equal to 1, the value is critical damping. If the value is greater than 1, the value is overdamped and gradually approaches the target value during motion. | 7646| overlapDuration | Duration for animations to overlap, in seconds. When animations overlap, the **response** values of these animations will transit smoothly over this duration if they are different. | 7647 7648**NOTE** 7649 7650The animation duration is subject to the curve parameters, rather than the **duration** parameter in **animation** or **animateTo**. 7651 7652**Returns** 7653 7654Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 7655 7656 7657### OH_ArkUI_Curve_CreateSpringCurve() 7658 7659``` 7660ArkUI_CurveHandle OH_ArkUI_Curve_CreateSpringCurve (float velocity, float mass, float stiffness, float damping ) 7661``` 7662**Description** 7663 7664Creates a spring curve. The curve shape is subject to the spring parameters, and the animation duration is subject to the **duration** parameter in **animation** and **animateTo**. 7665 7666**Parameters** 7667 7668| Name| Description| 7669| -------- | -------- | 7670| velocity | Initial velocity. It is applied by external factors to the spring animation, designed to help ensure the smooth transition from the previous motion state. The velocity is the normalized velocity, and its value is equal to the actual velocity at the beginning of the animation divided by the animation attribute change value. | 7671| mass | Mass, which influences the inertia in the spring system. The greater the mass, the greater the amplitude of the oscillation, and the slower the speed of restoring to the equilibrium position. | 7672| stiffness | Stiffness. It is the degree to which an object deforms by resisting the force applied. In an elastic system, the greater the stiffness, the stronger the ability to resist deformation, and the faster the speed of restoring to the equilibrium position. | 7673| damping | Damping. It is used to describe the oscillation and attenuation of the system after being disturbed. The larger the damping, the smaller the number of oscillations of elastic motion, and the smaller the oscillation amplitude. | 7674 7675**Returns** 7676 7677Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 7678 7679 7680### OH_ArkUI_Curve_CreateSpringMotion() 7681 7682``` 7683ArkUI_CurveHandle OH_ArkUI_Curve_CreateSpringMotion (float response, float dampingFraction, float overlapDuration ) 7684``` 7685**Description** 7686 7687Creates a spring animation curve. If multiple spring animations are applied to the same attribute of an object, each animation replaces their predecessor and inherits the velocity. 7688 7689**Parameters** 7690 7691| Name| Description| 7692| -------- | -------- | 7693| response | Duration of one complete oscillation. | 7694| dampingFraction | Damping coefficient. If the value is greater than 0 and less than 1, the value is underdamped and exceeds the target value during motion. If the value is equal to 1, the value is critical damping. If the value is greater than 1, the value is overdamped and gradually approaches the target value during motion. | 7695| overlapDuration | Duration for animations to overlap, in seconds. When animations overlap, the **response** values of these animations will transit smoothly over this duration if they are different. | 7696 7697**NOTE** 7698 7699The animation duration is subject to the curve parameters, rather than the **duration** parameter in **animation** or **animateTo**. 7700 7701**Returns** 7702 7703Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 7704 7705 7706### OH_ArkUI_Curve_CreateStepsCurve() 7707 7708``` 7709ArkUI_CurveHandle OH_ArkUI_Curve_CreateStepsCurve (int32_t count, bool end ) 7710``` 7711**Description** 7712 7713Creates a step curve. 7714 7715**Parameters** 7716 7717| Name| Description| 7718| -------- | -------- | 7719| count | Number of tiers. The value must be a positive integer. Value range: [1, +∞). | 7720| end | Step change occurs at the start point or end point of each interval. true: Step change occurs at the end point. false: Step change occurs at the start point. | 7721 7722**Returns** 7723 7724Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 7725 7726 7727### OH_ArkUI_Curve_DisposeCurve() 7728 7729``` 7730void OH_ArkUI_Curve_DisposeCurve (ArkUI_CurveHandle curveHandle) 7731``` 7732**Description** 7733 7734Disposes of a custom curve. 7735 7736**Parameters** 7737 7738| Name| Description| 7739| -------- | -------- | 7740| curve | Returns the pointer to the interpolation object of the curve; | 7741 7742 7743### OH_ArkUI_CustomProperty_Destroy() 7744 7745``` 7746void OH_ArkUI_CustomProperty_Destroy (ArkUI_CustomProperty * handle) 7747``` 7748**Description** 7749 7750Destroys a **CustomProperty** instance. 7751 7752**Since**: 14 7753 7754**Parameters** 7755 7756| Name| Description| 7757| -------- | -------- | 7758| handle | **CustomProperty** instance to destroy. | 7759 7760 7761### OH_ArkUI_CustomProperty_GetStringValue() 7762 7763``` 7764const char* OH_ArkUI_CustomProperty_GetStringValue (ArkUI_CustomProperty * handle) 7765``` 7766**Description** 7767 7768Obtains the value of a custom property. 7769 7770**Since**: 14 7771 7772**Parameters** 7773 7774| Name| Description| 7775| -------- | -------- | 7776| handle | Pointer to the custom property object. | 7777 7778**Returns** 7779 7780Returns the value of the custom property. 7781 7782 7783### OH_ArkUI_CustomSpanDrawInfo_Create() 7784 7785``` 7786ArkUI_CustomSpanDrawInfo* OH_ArkUI_CustomSpanDrawInfo_Create (void ) 7787``` 7788**Description** 7789 7790Creates drawing information for this custom span. 7791 7792**Since**: 12 7793 7794**Returns** 7795 7796Returns a **CustomSpanDrawInfo** instance. If a null pointer is returned, the memory may be insufficient. 7797 7798 7799### OH_ArkUI_CustomSpanDrawInfo_Dispose() 7800 7801``` 7802void OH_ArkUI_CustomSpanDrawInfo_Dispose (ArkUI_CustomSpanDrawInfo * info) 7803``` 7804**Description** 7805 7806Disposes of drawing information for this custom span. 7807 7808**Since**: 12 7809 7810**Parameters** 7811 7812| Name| Description| 7813| -------- | -------- | 7814| info | Pointer to the drawing information of a custom span. | 7815 7816 7817### OH_ArkUI_CustomSpanDrawInfo_GetBaseline() 7818 7819``` 7820float OH_ArkUI_CustomSpanDrawInfo_GetBaseline (ArkUI_CustomSpanDrawInfo * info) 7821``` 7822**Description** 7823 7824Obtains the baseline offset of the custom span relative to the mounted component. 7825 7826**Since**: 12 7827 7828**Parameters** 7829 7830| Name| Description| 7831| -------- | -------- | 7832| info | Pointer to the drawing information of a custom span. | 7833 7834**Returns** 7835 7836Returns the baseline offset. If a parameter error occurs, **0.0f** is returned. A possible cause is that mandatory parameters are left unspecified. 7837 7838### OH_ArkUI_NodeUtils_GetWindowInfo() 7839 7840``` 7841int32_t OH_ArkUI_NodeUtils_GetWindowInfo(ArkUI_NodeHandle node, ArkUI_HostWindowInfo** info) 7842``` 7843**Description** 7844 7845Obtains the information about the window to which a node belongs. 7846 7847**Since**: 15 7848 7849**Parameters** 7850 7851| Name| Description| 7852| -------- | -------- | 7853| node | Pointer to the target node.| 7854| info | Pointer to the window information object.| 7855 7856**Returns** 7857 7858Returns the result code. Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful; returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs; returns **ARKUI_ERROR_CODE_NODE_NOT_ON_MAIN_TREE** if the node is not mounted on the main component tree. 7859 7860### OH_ArkUI_HostWindowInfo_GetName() 7861 7862``` 7863const char* OH_ArkUI_HostWindowInfo_GetName(ArkUI_HostWindowInfo* info) 7864``` 7865**Description** 7866 7867Obtains the window name from a **HostWindowInfo** object. 7868 7869**Since**: 15 7870 7871**Parameters** 7872 7873| Name| Description| 7874| -------- | -------- | 7875| info | **HostWindowInfo** object.| 7876 7877**Returns** 7878 7879Returns the window name obtained from the **HostWindowInfo** object. 7880 7881### OH_ArkUI_HostWindowInfo_Destroy() 7882 7883``` 7884void OH_ArkUI_HostWindowInfo_Destroy(ArkUI_HostWindowInfo* info) 7885``` 7886**Description** 7887 7888Destroys n **HostWindowInfo** object. 7889 7890**Since**: 15 7891 7892**Parameters** 7893 7894| Name| Description| 7895| -------- | -------- | 7896| info | **HostWindowInfo** object to be destroyed.| 7897 7898### OH_ArkUI_NodeUtils_MoveTo() 7899 7900``` 7901int32_t OH_ArkUI_NodeUtils_MoveTo(ArkUI_NodeHandle node, ArkUI_NodeHandle target_parent, int32_t index) 7902``` 7903**Description** 7904 7905Moves a node to a target parent node as a child. 7906 7907**Since**: 16 7908 7909**Parameters** 7910 7911| Name| Description| 7912| -------- | -------- | 7913| node | Node to be moved.| 7914| target_parent | Pointer to the target parent node.| 7915| index | Index of the node after the movement. If the index is invalid, the node will be added to the end of the target parent node.| 7916 7917**Returns** 7918 7919Returns the result code. Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful; returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7920 7921### OH_ArkUI_NodeUtils_GetAttachedNodeHandleById() 7922 7923``` 7924int32_t OH_ArkUI_NodeUtils_GetAttachedNodeHandleById(const char* id, ArkUI_NodeHandle* node) 7925``` 7926**Description** 7927 7928Obtains the target node based on the provided user ID. 7929 7930**Since**: 15 7931 7932**Parameters** 7933 7934| Name| Description| 7935| -------- | -------- | 7936| id | ID of the target node.| 7937| node | Pointer to the target parent node.| 7938 7939**Returns** 7940 7941Returns the result code. Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful; returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7942 7943### OH_ArkUI_NodeUtils_SetCrossLanguageOption() 7944 7945``` 7946int32_t OH_ArkUI_NodeUtils_SetCrossLanguageOption(ArkUI_NodeHandle node, ArkUI_CrossLanguageOption* option) 7947``` 7948**Description** 7949 7950Sets the cross-language options for the target node. 7951 7952**Since**: 15 7953 7954**Parameters** 7955 7956| Name| Description| 7957| -------- | -------- | 7958| node | Pointer to the target node.| 7959| option | Cross-language configuration class. For details, see **ArkUI_CrossLanguageOption**.| 7960 7961**Returns** 7962 7963Returns the result code. Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful; returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7964 7965### OH_ArkUI_NodeUtils_GetCrossLanguageOption() 7966 7967``` 7968int32_t OH_ArkUI_NodeUtils_GetCrossLanguageOption(ArkUI_NodeHandle node, ArkUI_CrossLanguageOption* option) 7969``` 7970**Description** 7971 7972Obtains the cross-language options for the target node. 7973 7974**Since**: 15 7975 7976**Parameters** 7977 7978| Name| Description| 7979| -------- | -------- | 7980| node | Pointer to the target node.| 7981| option | Cross-language configuration class. For details, see **ArkUI_CrossLanguageOption**.| 7982 7983**Returns** 7984 7985Returns the result code. Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful; returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7986 7987### OH_ArkUI_NodeUtils_GetFirstChildIndexWithoutExpand() 7988 7989``` 7990int32_t OH_ArkUI_NodeUtils_GetFirstChildIndexWithoutExpand(ArkUI_NodeHandle node, uint32_t* index) 7991``` 7992**Description** 7993 7994Obtains the index of the first child node of the target node in the tree without expanding any nodes. 7995 7996**Since**: 15 7997 7998**Parameters** 7999 8000| Name| Description| 8001| -------- | -------- | 8002| node | Pointer to the target node.| 8003| index | Pointer to a variable where the index of the first child node is stored.| 8004 8005**Returns** 8006 8007Returns the result code. Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful; returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 8008 8009### OH_ArkUI_NodeUtils_GetLastChildIndexWithoutExpand() 8010 8011``` 8012int32_t OH_ArkUI_NodeUtils_GetLastChildIndexWithoutExpand(ArkUI_NodeHandle node, uint32_t* index) 8013``` 8014**Description** 8015 8016Obtains the index of the last child node of the target node in the tree without expanding any nodes. 8017 8018**Since**: 15 8019 8020**Parameters** 8021 8022| Name| Description| 8023| -------- | -------- | 8024| node | Pointer to the target node.| 8025| index | Pointer to a variable where the index of the last child node is stored.| 8026 8027**Returns** 8028 8029Returns the result code. Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful; returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 8030 8031### OH_ArkUI_NodeUtils_GetChildWithExpandMode() 8032 8033``` 8034int32_t OH_ArkUI_NodeUtils_GetChildWithExpandMode(ArkUI_NodeHandle node, int32_t position, 8035 ArkUI_NodeHandle* subnode, uint32_t expandMode) 8036``` 8037**Description** 8038 8039Obtains a child node at the specified index using different expansion modes. 8040 8041**Since**: 15 8042 8043**Parameters** 8044 8045| Name| Description| 8046| -------- | -------- | 8047| node | Pointer to the target node.| 8048| position | Index of the child node to obtain.| 8049| subnode | Pointer to the obtained child node.| 8050| expandMode | Expansion mode for node traversal. For details, see **ArkUI_ExpandMode**.| 8051 8052**Returns** 8053 8054Returns the result code. Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful; returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 8055 8056### OH_ArkUI_CustomSpanDrawInfo_GetLineBottom() 8057 8058``` 8059float OH_ArkUI_CustomSpanDrawInfo_GetLineBottom (ArkUI_CustomSpanDrawInfo * info) 8060``` 8061**Description** 8062 8063Obtains the bottom margin of the custom span relative to the mounted component. 8064 8065**Since**: 12 8066 8067**Parameters** 8068 8069| Name| Description| 8070| -------- | -------- | 8071| info | Pointer to the drawing information of a custom span. | 8072 8073**Returns** 8074 8075Returns the bottom margin. If a parameter error occurs, **0.0f** is returned. A possible cause is that mandatory parameters are left unspecified. 8076 8077 8078### OH_ArkUI_CustomSpanDrawInfo_GetLineTop() 8079 8080``` 8081float OH_ArkUI_CustomSpanDrawInfo_GetLineTop (ArkUI_CustomSpanDrawInfo * info) 8082``` 8083**Description** 8084 8085Obtains the top margin of the custom span relative to the mounted component. 8086 8087**Since**: 12 8088 8089**Parameters** 8090 8091| Name| Description| 8092| -------- | -------- | 8093| info | Pointer to the drawing information of a custom span. | 8094 8095**Returns** 8096 8097Returns the top margin. If a parameter error occurs, **0.0f** is returned. A possible cause is that mandatory parameters are left unspecified. 8098 8099 8100### OH_ArkUI_CustomSpanDrawInfo_GetXOffset() 8101 8102``` 8103float OH_ArkUI_CustomSpanDrawInfo_GetXOffset (ArkUI_CustomSpanDrawInfo * info) 8104``` 8105**Description** 8106 8107Obtains the x-axis offset of the custom span relative to the mounted component. 8108 8109**Since**: 12 8110 8111**Parameters** 8112 8113| Name| Description| 8114| -------- | -------- | 8115| info | Pointer to the drawing information of a custom span. | 8116 8117**Returns** 8118 8119Returns the x-axis offset. If a parameter error occurs, **0.0f** is returned. A possible cause is that mandatory parameters are left unspecified. 8120 8121 8122### OH_ArkUI_CustomSpanMeasureInfo_Create() 8123 8124``` 8125ArkUI_CustomSpanMeasureInfo* OH_ArkUI_CustomSpanMeasureInfo_Create (void ) 8126``` 8127**Description** 8128 8129Creates measurement information for this custom span. 8130 8131**Since**: 12 8132 8133**Returns** 8134 8135Returns a **CustomSpanMeasureInfo** instance. If a null pointer is returned, the memory may be insufficient. 8136 8137 8138### OH_ArkUI_CustomSpanMeasureInfo_Dispose() 8139 8140``` 8141void OH_ArkUI_CustomSpanMeasureInfo_Dispose (ArkUI_CustomSpanMeasureInfo * info) 8142``` 8143**Description** 8144 8145Disposes of measurement information of a custom span. 8146 8147**Since**: 12 8148 8149**Parameters** 8150 8151| Name| Description| 8152| -------- | -------- | 8153| info | Pointer to the measurement information of a custom span. | 8154 8155 8156### OH_ArkUI_CustomSpanMeasureInfo_GetFontSize() 8157 8158``` 8159float OH_ArkUI_CustomSpanMeasureInfo_GetFontSize (ArkUI_CustomSpanMeasureInfo * info) 8160``` 8161**Description** 8162 8163Obtains the font size of the parent text node of a custom span. 8164 8165**Since**: 12 8166 8167**Parameters** 8168 8169| Name| Description| 8170| -------- | -------- | 8171| info | Pointer to the measurement information of a custom span. | 8172 8173**Returns** 8174 8175Returns the font size of the parent text node. If a parameter error occurs, **0.0f** is returned. A possible cause is that mandatory parameters are left unspecified. 8176 8177 8178### OH_ArkUI_CustomSpanMetrics_Create() 8179 8180``` 8181ArkUI_CustomSpanMetrics* OH_ArkUI_CustomSpanMetrics_Create (void ) 8182``` 8183**Description** 8184 8185Creates measurement metrics for this custom span. 8186 8187**Since**: 12 8188 8189**Returns** 8190 8191Returns a **CustomSpanMetrics** instance. If a null pointer is returned, the memory may be insufficient. 8192 8193 8194### OH_ArkUI_CustomSpanMetrics_Dispose() 8195 8196``` 8197void OH_ArkUI_CustomSpanMetrics_Dispose (ArkUI_CustomSpanMetrics * metrics) 8198``` 8199**Description** 8200 8201Disposes of measurement metrics of this custom span. 8202 8203**Since**: 12 8204 8205**Parameters** 8206 8207| Name| Description| 8208| -------- | -------- | 8209| metrics | Returns a **CustomSpanMetrics** instance. | 8210 8211 8212### OH_ArkUI_CustomSpanMetrics_SetHeight() 8213 8214``` 8215int32_t OH_ArkUI_CustomSpanMetrics_SetHeight (ArkUI_CustomSpanMetrics * metrics, float height ) 8216``` 8217**Description** 8218 8219Sets the height for a custom span. 8220 8221**Since**: 12 8222 8223**Parameters** 8224 8225| Name| Description| 8226| -------- | -------- | 8227| metrics | Returns a **CustomSpanMetrics** instance. | 8228| height | Height, in vp. | 8229 8230**Returns** 8231 8232Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. A possible cause is that mandatory parameters are left unspecified. 8233 8234 8235### OH_ArkUI_CustomSpanMetrics_SetWidth() 8236 8237``` 8238int32_t OH_ArkUI_CustomSpanMetrics_SetWidth (ArkUI_CustomSpanMetrics * metrics, float width ) 8239``` 8240**Description** 8241 8242Sets the width for a custom span. 8243 8244**Since**: 12 8245 8246**Parameters** 8247 8248| Name| Description| 8249| -------- | -------- | 8250| metrics | Returns a **CustomSpanMetrics** instance. | 8251| width | Width, in vp. | 8252 8253**Returns** 8254 8255Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. A possible cause is that mandatory parameters are left unspecified. 8256 8257 8258### OH_ArkUI_DialogDismissEvent_GetDismissReason() 8259 8260``` 8261int32_t OH_ArkUI_DialogDismissEvent_GetDismissReason (ArkUI_DialogDismissEvent * event) 8262``` 8263**Description** 8264 8265Obtains the dismissal reason from a dialog box dismiss event object. 8266 8267**Since**: 12 8268 8269**Parameters** 8270 8271| Name| Description| 8272| -------- | -------- | 8273| event | Pointer to a dialog box dismiss event object.| 8274 8275**Returns** 8276 8277Returns the dismissal reason. Returns **-1** if an exception occurs.<br> **DIALOG_DISMISS_BACK_PRESS**: touching the Back button, swiping left or right on the screen, or pressing the Esc key.<br> **DIALOG_DISMISS_TOUCH_OUTSIDE**: touching the mask.<br> **DIALOG_DISMISS_CLOSE_BUTTON**: touching the Close button.<br> **DIALOG_DISMISS_SLIDE_DOWN**: sliding down. 8278 8279### OH_ArkUI_CustomDialog_OpenDialog() 8280 8281``` 8282int32_t OH_ArkUI_CustomDialog_OpenDialog(ArkUI_CustomDialogOptions* options, void (*callback)(int32_t dialogId)) 8283``` 8284**Description** 8285 8286Displays a custom dialog box. 8287 8288**Since**: 18 8289 8290**Parameters** 8291 8292| Name| Description| 8293| -------- | -------- | 8294| options | Dialog box parameters.| 8295| callback | Callback invoked when the dialog box is displayed. The parameter is the dialog box ID.| 8296 8297**Returns** 8298 8299Returns [ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) if the operation is successful; returns [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) if a parameter error occurs. 8300 8301### OH_ArkUI_CustomDialog_UpdateDialog() 8302 8303``` 8304int32_t OH_ArkUI_CustomDialog_UpdateDialog(ArkUI_CustomDialogOptions* options, void (*callback)(int32_t dialogId)) 8305``` 8306**Description** 8307 8308Updates a custom dialog box. 8309 8310**Since**: 18 8311 8312**Parameters** 8313 8314| Name| Description| 8315| -------- | -------- | 8316| options | Dialog box parameters.| 8317| callback | Callback invoked when the dialog box is updated. The parameter is the dialog box ID.| 8318 8319**Returns** 8320 8321Returns [ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) if the operation is successful; returns [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) if a parameter error occurs. 8322 8323### OH_ArkUI_CustomDialog_CloseDialog() 8324 8325``` 8326int32_t OH_ArkUI_CustomDialog_CloseDialog(int32_t dialogId) 8327``` 8328**Description** 8329 8330Closes a custom dialog box. 8331 8332**Since**: 18 8333 8334**Parameters** 8335 8336| Name| Description| 8337| -------- | -------- | 8338| dialogId | ID of the dialog box to close.| 8339 8340**Returns** 8341 8342Returns [ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) if the operation is successful; returns [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) if a parameter error occurs. 8343 8344### OH_ArkUI_CustomDialog_CreateOptions() 8345 8346``` 8347ArkUI_CustomDialogOptions* OH_ArkUI_CustomDialog_CreateOptions(ArkUI_NodeHandle content) 8348``` 8349**Description** 8350 8351Creates options for a custom dialog. 8352 8353**Since**: 18 8354 8355**Parameters** 8356 8357| Name| Description| 8358| -------- | -------- | 8359| content | Content of the custom dialog box.| 8360 8361**Returns** 8362 8363Returns the pointer to the custom dialog box options. 8364 8365### OH_ArkUI_CustomDialog_DisposeOptions() 8366 8367``` 8368void OH_ArkUI_CustomDialog_DisposeOptions(ArkUI_CustomDialogOptions* options) 8369``` 8370**Description** 8371 8372Destroys custom dialog box options. 8373 8374**Since**: 18 8375 8376**Parameters** 8377 8378| Name| Description| 8379| -------- | -------- | 8380| options | Pointer to the custom dialog box options.| 8381 8382 8383### OH_ArkUI_CustomDialog_SetLevelMode() 8384 8385``` 8386int32_t OH_ArkUI_CustomDialog_SetLevelMode(ArkUI_CustomDialogOptions* options, ArkUI_LevelMode levelMode) 8387``` 8388**Description** 8389 8390Sets the display level of a dialog box. 8391 8392**Since**: 18 8393 8394**Parameters** 8395 8396| Name| Description| 8397| -------- | -------- | 8398| options | Pointer to the custom dialog box options.| 8399| levelMode | Display level to set, specified by an enumeration value of **ArkUI_LevelMode**.| 8400 8401**NOTE** 8402 8403This method must be called before the **OH_ArkUI_CustomDialog_OpenDialog** method. 8404 8405**Returns** 8406 8407Returns [ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) if the operation is successful; returns [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) if a parameter error occurs. 8408 8409### OH_ArkUI_CustomDialog_SetLevelUniqueId() 8410 8411``` 8412int32_t OH_ArkUI_CustomDialog_SetLevelUniqueId(ArkUI_CustomDialogOptions* options, int32_t uniqueId) 8413``` 8414**Description** 8415 8416Sets the ID of the node under the dialog box's display level. 8417 8418**Since**: 18 8419 8420**Parameters** 8421 8422| Name| Description| 8423| -------- | -------- | 8424| options | Pointer to the custom dialog box options.| 8425| uniqueId | ID of the node under the dialog box's display level. The dialog box will be displayed on the same page as this node.| 8426 8427**NOTE** 8428 8429This method must be called before the **OH_ArkUI_CustomDialog_OpenDialog** method. 8430 8431**Returns** 8432 8433Returns [ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) if the operation is successful; returns [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) if a parameter error occurs. 8434 8435### OH_ArkUI_CustomDialog_SetImmersiveMode() 8436 8437``` 8438int32_t OH_ArkUI_CustomDialog_SetImmersiveMode(ArkUI_CustomDialogOptions* options, ArkUI_ImmersiveMode immersiveMode) 8439``` 8440**Description** 8441 8442Sets the display area of the embedded pop-up window mask. 8443 8444**Since**: 18 8445 8446**Parameters** 8447 8448| Name| Description| 8449| -------- | -------- | 8450| options | Pointer to the custom dialog box options.| 8451| immersiveMode | Display area, specified by an enumeration value of **ArkUI_ImmersiveMode**.| 8452 8453**NOTE** 8454 8455This method must be called before the **OH_ArkUI_CustomDialog_OpenDialog** method. 8456 8457**Returns** 8458 8459Returns [ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) if the operation is successful; returns [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) if a parameter error occurs. 8460 8461### OH_ArkUI_CustomDialog_SetBackgroundColor() 8462 8463``` 8464int32_t OH_ArkUI_CustomDialog_SetBackgroundColor(ArkUI_CustomDialogOptions* options, uint32_t backgroundColor) 8465``` 8466**Description** 8467 8468Sets the background color of a dialog box. 8469 8470**Since**: 18 8471 8472**Parameters** 8473 8474| Name| Description| 8475| -------- | -------- | 8476| options | Dialog box parameters.| 8477| backgroundColor | Background color of the dialog box.| 8478 8479**Returns** 8480 8481Returns [ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) if the operation is successful; returns [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) if a parameter error occurs. 8482 8483### OH_ArkUI_CustomDialog_SetCornerRadius() 8484 8485``` 8486int32_t OH_ArkUI_CustomDialog_SetCornerRadius( 8487 ArkUI_CustomDialogOptions* options, float topLeft, float topRight, float bottomLeft, float bottomRight) 8488``` 8489**Description** 8490 8491Sets the corner radius for a dialog box. 8492 8493**Since**: 18 8494 8495**Parameters** 8496 8497| Name| Description| 8498| -------- | -------- | 8499| options | Dialog box parameters.| 8500| topLeft | Radius of the upper left corner of the dialog box.| 8501| topRight | Radius of the upper right corner of the dialog box.| 8502| bottomLeft |Radius of the lower left corner of the dialog box.| 8503| bottomRight | Radius of the lower right corner of the dialog box.| 8504 8505**Returns** 8506 8507Returns [ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) if the operation is successful; returns [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) if a parameter error occurs. 8508 8509### OH_ArkUI_CustomDialog_SetBorderWidth() 8510 8511``` 8512int32_t OH_ArkUI_CustomDialog_SetBorderWidth( 8513 ArkUI_CustomDialogOptions* options, float top, float right, float bottom, float left, ArkUI_LengthMetricUnit unit) 8514``` 8515**Description** 8516 8517Sets the border width of a dialog box. 8518 8519**Since**: 18 8520 8521**Parameters** 8522 8523| Name| Description| 8524| -------- | -------- | 8525| options | Dialog box parameters.| 8526| top | Width of the top border of the dialog box.| 8527| right | Width of the right border of the dialog box.| 8528| bottom |Width of the bottom border of the dialog box.| 8529| left | Width of the left border of the dialog box.| 8530| unit | Unit of the width. The default value is vp.| 8531 8532**Returns** 8533 8534Returns [ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) if the operation is successful; returns [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) if a parameter error occurs. 8535 8536### OH_ArkUI_CustomDialog_SetBorderColor() 8537 8538``` 8539int32_t OH_ArkUI_CustomDialog_SetBorderColor( 8540 ArkUI_CustomDialogOptions* options, uint32_t top, uint32_t right, uint32_t bottom, uint32_t left) 8541``` 8542**Description** 8543 8544Sets the border color of the dialog box. 8545 8546**Since**: 18 8547 8548**Parameters** 8549 8550| Name| Description| 8551| -------- | -------- | 8552| options | Dialog box parameters.| 8553| top | Color of the top border of the dialog box.| 8554| right | Color of the right border of the dialog box.| 8555| bottom |Color of the bottom border of the dialog box.| 8556| left | Color of the left border of the dialog box.| 8557 8558**Returns** 8559 8560Returns [ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) if the operation is successful; returns [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) if a parameter error occurs. 8561 8562### OH_ArkUI_CustomDialog_SetBorderStyle() 8563 8564``` 8565int32_t OH_ArkUI_CustomDialog_SetBorderStyle( 8566 ArkUI_CustomDialogOptions* options, int32_t top, int32_t right, int32_t bottom, int32_t left) 8567``` 8568**Description** 8569 8570Sets the border style of a dialog box. 8571 8572**Since**: 18 8573 8574**Parameters** 8575 8576| Name| Description| 8577| -------- | -------- | 8578| options | Dialog box parameters.| 8579| top | Style of the top border of the dialog box.| 8580| right | Style of the right border of the dialog box.| 8581| bottom | Style of the bottom border of the dialog box.| 8582| left | Style of the left border of the dialog box.| 8583 8584**Returns** 8585 8586Returns [ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) if the operation is successful; returns [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) if a parameter error occurs. 8587 8588### OH_ArkUI_CustomDialog_SetWidth() 8589 8590``` 8591int32_t OH_ArkUI_CustomDialog_SetWidth(ArkUI_CustomDialogOptions* options, float width, ArkUI_LengthMetricUnit unit) 8592``` 8593**Description** 8594 8595Sets the width of the dialog box background. 8596 8597**Since**: 18 8598 8599**Parameters** 8600 8601| Name| Description| 8602| -------- | -------- | 8603| options | Dialog box parameters.| 8604| width | Width of the dialog box background.| 8605| unit | Unit of the width. The default value is vp.| 8606 8607**Returns** 8608 8609Returns [ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) if the operation is successful; returns [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) if a parameter error occurs. 8610 8611### OH_ArkUI_CustomDialog_SetHeight() 8612 8613``` 8614int32_t OH_ArkUI_CustomDialog_SetHeight(ArkUI_CustomDialogOptions* options, float height, ArkUI_LengthMetricUnit unit) 8615``` 8616**Description** 8617 8618Sets the height of the dialog box background. 8619 8620**Since**: 18 8621 8622**Parameters** 8623 8624| Name| Description| 8625| -------- | -------- | 8626| options | Dialog box parameters.| 8627| height | Height of the dialog box background.| 8628| unit | Unit of the height. The default value is vp.| 8629 8630**Returns** 8631 8632Returns [ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) if the operation is successful; returns [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) if a parameter error occurs. 8633 8634### OH_ArkUI_CustomDialog_SetShadow() 8635 8636``` 8637int32_t OH_ArkUI_CustomDialog_SetShadow(ArkUI_CustomDialogOptions* options, ArkUI_ShadowStyle shadow) 8638``` 8639**Description** 8640 8641Sets the shadow of the dialog box background. 8642 8643**Since**: 18 8644 8645**Parameters** 8646 8647| Name| Description| 8648| -------- | -------- | 8649| options | Dialog box parameters.| 8650| shadow | Shadow style of the background, specified by an enumerated value.| 8651 8652**Returns** 8653 8654Returns [ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) if the operation is successful; returns [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) if a parameter error occurs. 8655 8656### OH_ArkUI_CustomDialog_SetCustomShadow() 8657 8658``` 8659int32_t OH_ArkUI_CustomDialog_SetCustomShadow( 8660 ArkUI_CustomDialogOptions* options, const ArkUI_AttributeItem* customShadow) 8661``` 8662**Description** 8663 8664Sets the custom shadow of the dialog box background. 8665 8666**Since**: 18 8667 8668**Parameters** 8669 8670| Name| Description| 8671| -------- | -------- | 8672| options | Dialog box parameters.| 8673| customShadow | Custom shadow parameter. The format is the same as that of the **NODE_SHADOW** property.| 8674 8675**Returns** 8676 8677Returns [ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) if the operation is successful; returns [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) if a parameter error occurs. 8678 8679### OH_ArkUI_CustomDialog_SetBackgroundBlurStyle() 8680 8681``` 8682int32_t OH_ArkUI_CustomDialog_SetBackgroundBlurStyle(ArkUI_CustomDialogOptions* options, ArkUI_BlurStyle blurStyle) 8683``` 8684**Description** 8685 8686Sets the background blur style of the dialog box. 8687 8688**Since**: 18 8689 8690**Parameters** 8691 8692| Name| Description| 8693| -------- | -------- | 8694| options | Dialog box parameters.| 8695| blurStyle | Background blur style, specified by an enumerated value.| 8696 8697**Returns** 8698 8699Returns [ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) if the operation is successful; returns [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) if a parameter error occurs. 8700 8701### OH_ArkUI_CustomDialog_SetAlignment() 8702 8703``` 8704int32_t OH_ArkUI_CustomDialog_SetAlignment( 8705 ArkUI_CustomDialogOptions* options, int32_t alignment, float offsetX, float offsetY) 8706``` 8707**Description** 8708 8709Sets the alignment mode of a dialog box. 8710 8711**Since**: 18 8712 8713**Parameters** 8714 8715| Name| Description| 8716| -------- | -------- | 8717| options | Dialog box parameters.| 8718| alignment | Alignment mode of the dialog box. The parameter type is **ArkUI_Alignment**.| 8719| offsetX | Horizontal offset of the dialog box. The value is a floating point number.| 8720| offsetY | Vertical offset of the dialog box. The value is a floating point number.| 8721 8722**Returns** 8723 8724Returns [ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) if the operation is successful; returns [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) if a parameter error occurs. 8725 8726### OH_ArkUI_CustomDialog_SetModalMode() 8727 8728``` 8729int32_t OH_ArkUI_CustomDialog_SetModalMode(ArkUI_CustomDialogOptions* options, bool isModal) 8730``` 8731**Description** 8732 8733Sets the modal mode for a custom dialog box. 8734 8735**Since**: 18 8736 8737**Parameters** 8738 8739| Name| Description| 8740| -------- | -------- | 8741| options | Dialog box parameters.| 8742| isModal | Whether the dialog box is a modal. A modal dialog box has a mask applied, while a non-modal dialog box does not. The value **true** means that the dialog box is a modal.| 8743 8744**Returns** 8745 8746Returns [ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) if the operation is successful; returns [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) if a parameter error occurs. 8747 8748### OH_ArkUI_CustomDialog_SetAutoCancel() 8749 8750``` 8751int32_t OH_ArkUI_CustomDialog_SetAutoCancel(ArkUI_CustomDialogOptions* options, bool autoCancel) 8752``` 8753**Description** 8754 8755Specifies whether to allow users to touch the mask to dismiss the custom dialog box. 8756 8757**Since**: 18 8758 8759**Parameters** 8760 8761| Name| Description| 8762| -------- | -------- | 8763| options | Dialog box parameters.| 8764| autoCancel | Whether to allow users to touch the mask to dismiss the dialog box. The value **true** means to allow users to do so, and **false** means the opposite.| 8765 8766**Returns** 8767 8768Returns [ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) if the operation is successful; returns [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) if a parameter error occurs. 8769 8770### OH_ArkUI_CustomDialog_SetSubwindowMode() 8771 8772``` 8773int32_t OH_ArkUI_CustomDialog_SetSubwindowMode(ArkUI_CustomDialogOptions* options, bool isShowInSubwindow) 8774``` 8775**Description** 8776 8777Sets whether to display the dialog box in a subwindow. 8778 8779**Since**: 18 8780 8781**Parameters** 8782 8783| Name| Description| 8784| -------- | -------- | 8785| options | Dialog box parameters.| 8786| isShowInSubwindow | Whether to show the dialog box in a subwindow when the dialog box needs to be displayed outside the main window. The default value is **false**, meaning the dialog box is displayed within the application, not in a separate subwindow.| 8787 8788**Returns** 8789 8790Returns [ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) if the operation is successful; returns [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) if a parameter error occurs. 8791 8792### OH_ArkUI_CustomDialog_SetMask() 8793 8794``` 8795int32_t OH_ArkUI_CustomDialog_SetMask( 8796 ArkUI_CustomDialogOptions* options, uint32_t maskColor, const ArkUI_Rect* maskRect) 8797``` 8798**Description** 8799 8800Sets the mask for a custom dialog box. 8801 8802**Since**: 18 8803 8804**Parameters** 8805 8806| Name| Description| 8807| -------- | -------- | 8808| options | Dialog box parameters.| 8809| maskColor | Mask color, in 0xargb format.| 8810| maskRect | Pointer to the mask area. Events outside the mask area are transparently transmitted, and events within the mask area are not. The parameter type is **ArkUI_Rect**.| 8811 8812**Returns** 8813 8814Returns [ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) if the operation is successful; returns [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) if a parameter error occurs. 8815 8816### OH_ArkUI_CustomDialog_SetKeyboardAvoidMode() 8817 8818``` 8819int32_t OH_ArkUI_CustomDialog_SetKeyboardAvoidMode( 8820 ArkUI_CustomDialogOptions* options, ArkUI_KeyboardAvoidMode keyboardAvoidMode) 8821``` 8822**Description** 8823 8824Sets the keyboard avoidance mode of a dialog box. 8825 8826**Since**: 18 8827 8828**Parameters** 8829 8830| Name| Description| 8831| -------- | -------- | 8832| options | Dialog box parameters.| 8833| keyboardAvoidMode | Keyboard avoidance mode, specified by an enumerated value.| 8834 8835**Returns** 8836 8837Returns [ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) if the operation is successful; returns [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) if a parameter error occurs. 8838 8839### OH_ArkUI_CustomDialog_SetHoverModeEnabled() 8840 8841``` 8842int32_t OH_ArkUI_CustomDialog_SetHoverModeEnabled(ArkUI_CustomDialogOptions* options, bool enabled) 8843``` 8844**Description** 8845 8846Sets whether to enable the hover mode for a dialog box. 8847 8848**Since**: 18 8849 8850**Parameters** 8851 8852| Name| Description| 8853| -------- | -------- | 8854| options | Dialog box parameters.| 8855| enabled | Whether to enable the hover mode. The default value is **false**.| 8856 8857**Returns** 8858 8859Returns [ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) if the operation is successful; returns [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) if a parameter error occurs. 8860 8861### OH_ArkUI_CustomDialog_SetHoverModeArea() 8862 8863``` 8864int32_t OH_ArkUI_CustomDialog_SetHoverModeArea( 8865 ArkUI_CustomDialogOptions* options, ArkUI_HoverModeAreaType hoverModeAreaType) 8866``` 8867**Description** 8868 8869Sets the default display area of a dialog box in hover mode. 8870 8871**Since**: 18 8872 8873**Parameters** 8874 8875| Name| Description| 8876| -------- | -------- | 8877| options | Dialog box parameters.| 8878| hoverModeAreaType | Display area in hover mode, specified by an enumerated value.| 8879 8880**Returns** 8881 8882Returns [ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) if the operation is successful; returns [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) if a parameter error occurs. 8883 8884### OH_ArkUI_CustomDialog_RegisterOnWillDismissCallback() 8885 8886``` 8887int32_t OH_ArkUI_CustomDialog_RegisterOnWillDismissCallback( 8888 ArkUI_CustomDialogOptions* options, void* userData, void (*callback)(ArkUI_DialogDismissEvent* event)) 8889``` 8890**Description** 8891 8892Registers a callback for the dismissal event of a custom dialog box. 8893 8894**Since**: 18 8895 8896**Parameters** 8897 8898| Name| Description| 8899| -------- | -------- | 8900| options | Dialog box parameters.| 8901| userData | Returns the pointer to user data.| 8902| callback | Callback for the dismissal event of the custom dialog box.| 8903 8904**Returns** 8905 8906Returns [ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) if the operation is successful; returns [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) if a parameter error occurs. 8907 8908### OH_ArkUI_CustomDialog_RegisterOnWillAppearCallback() 8909 8910``` 8911int32_t OH_ArkUI_CustomDialog_RegisterOnWillAppearCallback( 8912 ArkUI_CustomDialogOptions* options, void* userData, void (*callback)(void* userData)) 8913``` 8914**Description** 8915 8916Registers a callback to be invoked when the specified custom dialog box is about to appear. 8917 8918**Since**: 18 8919 8920**Parameters** 8921 8922| Name| Description| 8923| -------- | -------- | 8924| options | Dialog box parameters.| 8925| userData | Returns the pointer to user data.| 8926| callback | Event callback when the dialog box is about to appear.| 8927 8928**Returns** 8929 8930Returns [ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) if the operation is successful; returns [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) if a parameter error occurs. 8931 8932### OH_ArkUI_CustomDialog_RegisterOnDidAppearCallback() 8933 8934``` 8935int32_t OH_ArkUI_CustomDialog_RegisterOnDidAppearCallback( 8936 ArkUI_CustomDialogOptions* options, void* userData, void (*callback)(void* userData)) 8937``` 8938**Description** 8939 8940Registers a callback to be invoked when the specifiedcustom dialog box appears. 8941 8942**Since**: 18 8943 8944**Parameters** 8945 8946| Name| Description| 8947| -------- | -------- | 8948| options | Dialog box parameters.| 8949| userData | Returns the pointer to user data.| 8950| callback | Event callback when the dialog box appears.| 8951 8952**Returns** 8953 8954Returns [ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) if the operation is successful; returns [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) if a parameter error occurs. 8955 8956### OH_ArkUI_CustomDialog_RegisterOnWillDisappearCallback() 8957 8958``` 8959int32_t OH_ArkUI_CustomDialog_RegisterOnWillDisappearCallback( 8960 ArkUI_CustomDialogOptions* options, void* userData, void (*callback)(void* userData)) 8961``` 8962**Description** 8963 8964Registers a callback to be invoked when the specified custom dialog box is about to disappear. 8965 8966**Since**: 18 8967 8968**Parameters** 8969 8970| Name| Description| 8971| -------- | -------- | 8972| options | Dialog box parameters.| 8973| userData | Returns the pointer to user data.| 8974| callback | Event callback when the dialog box is about to disappear.| 8975 8976**Returns** 8977 8978Returns [ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) if the operation is successful; returns [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) if a parameter error occurs. 8979 8980### OH_ArkUI_CustomDialog_RegisterOnDidDisappearCallback() 8981 8982``` 8983int32_t OH_ArkUI_CustomDialog_RegisterOnDidDisappearCallback( 8984 ArkUI_CustomDialogOptions* options, void* userData, void (*callback)(void* userData)) 8985``` 8986**Description** 8987 8988* @brief Registers a callback to be invoked when the specified custom dialog box disappears. 8989 8990**Since**: 18 8991 8992**Parameters** 8993 8994| Name| Description| 8995| -------- | -------- | 8996| options | Dialog box parameters.| 8997| userData | Returns the pointer to user data.| 8998| callback | Event callback when the dialog box disappears.| 8999 9000**Returns** 9001 9002Returns [ARKUI_ERROR_CODE_NO_ERROR](_ark_u_i___native_module.md) if the operation is successful; returns [ARKUI_ERROR_CODE_PARAM_INVALID](_ark_u_i___native_module.md) if a parameter error occurs. 9003 9004### OH_ArkUI_DialogDismissEvent_GetUserData() 9005 9006``` 9007void* OH_ArkUI_DialogDismissEvent_GetUserData (ArkUI_DialogDismissEvent * event) 9008``` 9009**Description** 9010 9011Obtains the pointer to user data in a dialog box dismiss event object. 9012 9013**Since**: 12 9014 9015**Parameters** 9016 9017| Name| Description| 9018| -------- | -------- | 9019| event | Pointer to a dialog box dismiss event object.| 9020 9021**Returns** 9022 9023Returns the pointer to user data. 9024 9025 9026### OH_ArkUI_DialogDismissEvent_SetShouldBlockDismiss() 9027 9028``` 9029void OH_ArkUI_DialogDismissEvent_SetShouldBlockDismiss (ArkUI_DialogDismissEvent * event, bool shouldBlockDismiss ) 9030``` 9031**Description** 9032 9033Sets whether to block the system behavior of dismissing a dialog box. 9034 9035**Since**: 12 9036 9037**Parameters** 9038 9039| Name| Description| 9040| -------- | -------- | 9041| event | Pointer to a dialog box dismiss event object. | 9042| shouldBlockDismiss | Whether to block the system behavior of dismissing the dialog box. The value **true** means to block the system behavior, and **false** means the opposite. | 9043 9044 9045### OH_ArkUI_DisallowNodeAnyDropDataTypes() 9046 9047``` 9048int32_t OH_ArkUI_DisallowNodeAnyDropDataTypes (ArkUI_NodeHandle node) 9049``` 9050**Description** 9051 9052The configuration component is not allowed to accept any data type. This interface resets the data type configured through [OH_ArkUI_SetNodeAllowedDropDataTypes](#oh_arkui_setnodealloweddropdatatypes). 9053 9054**Since**: 12 9055 9056**Parameters** 9057 9058| Name| Description| 9059| -------- | -------- | 9060| node | Pointer to a component node. | 9061 9062**Returns** 9063 9064Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9065 9066 9067### OH_ArkUI_DragAction_Dispose() 9068 9069``` 9070void OH_ArkUI_DragAction_Dispose (ArkUI_DragAction * dragAction) 9071``` 9072**Description** 9073 9074Disposes of an **ArkUI_DragAction** object. 9075 9076**Since**: 12 9077 9078**Parameters** 9079 9080| Name| Description| 9081| -------- | -------- | 9082| dragAction | Pointer to the target drag action object. | 9083 9084 9085### OH_ArkUI_DragAction_RegisterStatusListener() 9086 9087``` 9088int32_t OH_ArkUI_DragAction_RegisterStatusListener (ArkUI_DragAction * dragAction, void * userData, void(*)(ArkUI_DragAndDropInfo *dragAndDropInfo, void *userData) listener ) 9089``` 9090**Description** 9091 9092Registers a drag status listener. This listener can be used to check whether the data is successfully received and processed. 9093 9094**Since**: 12 9095 9096**Parameters** 9097 9098| Name| Description| 9099| -------- | -------- | 9100| dragAction | Pointer to the target drag action object. | 9101| userData | Custom user data. | 9102| listener | Listener to register. When the callback is invoked, the system returns a pointer to the drag status object. The pointer is destroyed after the callback is complete and the application should not hold it anymore. | 9103 9104**Returns** 9105 9106Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9107 9108 9109### OH_ArkUI_DragAction_SetData() 9110 9111``` 9112int32_t OH_ArkUI_DragAction_SetData (ArkUI_DragAction * dragAction, OH_UdmfData * data ) 9113``` 9114**Description** 9115 9116Sets the drag data. 9117 9118**Since**: 12 9119 9120**Parameters** 9121 9122| Name| Description| 9123| -------- | -------- | 9124| dragAction | Pointer to the target drag action object. | 9125| data | Drag data. | 9126 9127**Returns** 9128 9129Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9130 9131 9132### OH_ArkUI_DragAction_SetDragPreviewOption() 9133 9134``` 9135int32_t OH_ArkUI_DragAction_SetDragPreviewOption (ArkUI_DragAction * dragAction, ArkUI_DragPreviewOption * option ) 9136``` 9137**Description** 9138 9139Sets an **ArkUI_DragPreviewOption** object for the specified drag action object. 9140 9141**Since**: 12 9142 9143**Parameters** 9144 9145| Name| Description| 9146| -------- | -------- | 9147| dragAction | Pointer to the target drag action object. | 9148| option | Custom parameters. | 9149 9150**Returns** 9151 9152Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9153 9154 9155### OH_ArkUI_DragAction_SetPixelMaps() 9156 9157``` 9158int32_t OH_ArkUI_DragAction_SetPixelMaps (ArkUI_DragAction * dragAction, OH_PixelmapNative * pixelmapArray[], int32_t size ) 9159``` 9160**Description** 9161 9162Sets the drag previews for a drag action. 9163 9164**Since**: 12 9165 9166**Parameters** 9167 9168| Name| Description| 9169| -------- | -------- | 9170| dragAction | Pointer to the target drag action object. | 9171| pixelmapArray | Drag the bitmap array of the follower map. | 9172| size | Number of drag-and-drop images. | 9173 9174**Returns** 9175 9176Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9177 9178 9179### OH_ArkUI_DragAction_SetPointerId() 9180 9181``` 9182int32_t OH_ArkUI_DragAction_SetPointerId (ArkUI_DragAction * dragAction, int32_t pointer ) 9183``` 9184**Description** 9185 9186Sets the pointer ID. If only one finger is operating on the screen, the pointer ID is 0. In general cases, you can set the pointer ID to 0. 9187 9188**Since**: 12 9189 9190**Parameters** 9191 9192| Name| Description| 9193| -------- | -------- | 9194| dragAction | Pointer to the target drag action object. | 9195| pointer | Pointer ID. The value ranges from 0 to 9. | 9196 9197**Returns** 9198 9199Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9200 9201 9202### OH_ArkUI_DragAction_SetTouchPointX() 9203 9204``` 9205int32_t OH_ArkUI_DragAction_SetTouchPointX (ArkUI_DragAction * dragAction, float x ) 9206``` 9207**Description** 9208 9209Sets the touch point relative to the upper left corner of the first drag preview (pixel map). 9210 9211**Since**: 12 9212 9213**Parameters** 9214 9215| Name| Description| 9216| -------- | -------- | 9217| dragAction | Pointer to the target drag action object. | 9218| x | X value of the hand point coordinate. | 9219 9220**Returns** 9221 9222Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9223 9224 9225### OH_ArkUI_DragAction_SetTouchPointY() 9226 9227``` 9228int32_t OH_ArkUI_DragAction_SetTouchPointY (ArkUI_DragAction * dragAction, float y ) 9229``` 9230**Description** 9231 9232Sets the touch point relative to the upper left corner of the first drag preview (pixel map). 9233 9234**Since**: 12 9235 9236**Parameters** 9237 9238| Name| Description| 9239| -------- | -------- | 9240| dragAction | Pointer to the target drag action object. | 9241| y | Y value of the hand point coordinate. | 9242 9243**Returns** 9244 9245Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9246 9247 9248### OH_ArkUI_DragAction_UnregisterStatusListener() 9249 9250``` 9251void OH_ArkUI_DragAction_UnregisterStatusListener (ArkUI_DragAction * dragAction) 9252``` 9253**Description** 9254 9255Unregisters a drag status listener. 9256 9257**Since**: 12 9258 9259**Parameters** 9260 9261| Name| Description| 9262| -------- | -------- | 9263| dragAction | Pointer to the target drag action object. | 9264 9265 9266### OH_ArkUI_DragAndDropInfo_GetDragEvent() 9267 9268``` 9269ArkUI_DragEvent* OH_ArkUI_DragAndDropInfo_GetDragEvent (ArkUI_DragAndDropInfo * dragAndDropInfo) 9270``` 9271**Description** 9272 9273Obtains a drag event based on the specified drag and drop information. The drag event can then be used to obtain the drag result. 9274 9275**Since**: 12 9276 9277**Parameters** 9278 9279| Name| Description| 9280| -------- | -------- | 9281| dragAndDropInfo | Drag-related information returned by the drag status listener. | 9282 9283**Returns** 9284 9285Returns an **ArkUI_DragEvent** object; returns null if an error occurs. 9286 9287 9288### OH_ArkUI_DragAndDropInfo_GetDragStatus() 9289 9290``` 9291ArkUI_DragStatus OH_ArkUI_DragAndDropInfo_GetDragStatus (ArkUI_DragAndDropInfo * dragAndDropInfo) 9292``` 9293**Description** 9294 9295Obtains the drag status of a drag action. 9296 9297**Since**: 12 9298 9299**Parameters** 9300 9301| Name| Description| 9302| -------- | -------- | 9303| dragAndDropInfo | Drag-related information returned by the drag status listener. | 9304 9305**Returns** 9306 9307Returns an **ArkUI_DragStatus** object; returns **ArkUI_DRAG_STATUS_UNKNOWN** if an error occurs. 9308 9309 9310### OH_ArkUI_DragEvent_DisableDefaultDropAnimation() 9311 9312``` 9313int32_t OH_ArkUI_DragEvent_DisableDefaultDropAnimation (ArkUI_DragEvent * event, bool disable ) 9314``` 9315**Description** 9316 9317Sets whether to disable the default drop animation, which is enabled by default. Use this API to apply a custom drop animation. 9318 9319**Since**: 12 9320 9321**Parameters** 9322 9323| Name| Description| 9324| -------- | -------- | 9325| event | Pointer to an **ArkUI_DragEvent** object. | 9326| disable | Whether to disable the default drop animation. The value **true** means to disable the default drop animation, and **false** means the opposite. | 9327 9328**Returns** 9329 9330Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9331 9332 9333### OH_ArkUI_DragEvent_GetDataTypes() 9334 9335``` 9336int32_t OH_ArkUI_DragEvent_GetDataTypes (ArkUI_DragEvent * event, char * eventTypeArray[], int32_t length, int32_t maxStrLen) 9337``` 9338**Description** 9339 9340Obtains the type list of drag data types from a drag event. 9341 9342**Since**: 12 9343 9344**Parameters** 9345 9346| Name| Description| 9347| -------- | -------- | 9348| event | Pointer to an **ArkUI_DragEvent** object. | 9349| char | List of the drag data types. You need to create a string array first. | 9350| length | Total length of the array, which cannot be less than the number obtained using [OH_ArkUI_DragEvent_GetDataTypeCount](#oh_arkui_dragevent_getdatatypecount). | 9351| maxStrLen | Maximum length of each data type string. | 9352 9353**Returns** 9354 9355Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. Returns **ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR** if the provided buffer size is insufficient. 9356 9357 9358### OH_ArkUI_DragEvent_GetDataTypeCount() 9359 9360``` 9361int32_t OH_ArkUI_DragEvent_GetDataTypeCount (ArkUI_DragEvent * event, int32_t * count ) 9362``` 9363**Description** 9364 9365Obtains the number of drag data types from a drag event. 9366 9367**Since**: 12 9368 9369**Parameters** 9370 9371| Name| Description| 9372| -------- | -------- | 9373| event | Pointer to an **ArkUI_DragEvent** object. | 9374| count | Number of drag data types returned. | 9375 9376**Returns** 9377 9378Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9379 9380 9381### OH_ArkUI_DragEvent_GetDragResult() 9382 9383``` 9384int32_t OH_ArkUI_DragEvent_GetDragResult (ArkUI_DragEvent * event, ArkUI_DragResult * result ) 9385``` 9386**Description** 9387 9388Obtains the drag and drop result from the drag event. 9389 9390**Since**: 12 9391 9392**Parameters** 9393 9394| Name| Description| 9395| -------- | -------- | 9396| event | Pointer to an **ArkUI_DragEvent** object. | 9397| result | Drag result returned. | 9398 9399**Returns** 9400 9401Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9402 9403 9404### OH_ArkUI_DragEvent_GetDropOperation() 9405 9406``` 9407int32_t OH_ArkUI_DragEvent_GetDropOperation (ArkUI_DragEvent * event, ArkUI_DropOperation * operation) 9408``` 9409**Description** 9410 9411Obtains the data handling method from the drag event. 9412 9413**Since**: 12 9414 9415**Parameters** 9416 9417| Name| Description| 9418| -------- | -------- | 9419| event | Pointer to an **ArkUI_DragEvent** object. | 9420| operation | Data handling method returned. | 9421 9422**Returns** 9423 9424Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9425 9426 9427### OH_ArkUI_DragEvent_GetModifierKeyStates() 9428 9429``` 9430int32_t OH_ArkUI_DragEvent_GetModifierKeyStates (ArkUI_DragEvent * event, uint64_t * keys ) 9431``` 9432**Description** 9433 9434Obtains the pressed status of modifier keys from a drag event. 9435 9436**Since**: 12 9437 9438**Parameters** 9439 9440| Name| Description| 9441| -------- | -------- | 9442| event | Pointer to an **ArkUI_DragEvent** object. | 9443| keys | Returns the modifier key combination that is currently pressed. The application can determine the modifier key combination through bitwise operations. | 9444 9445**Returns** 9446 9447Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9448 9449 9450### OH_ArkUI_DragEvent_GetPreviewRectHeight() 9451 9452``` 9453float OH_ArkUI_DragEvent_GetPreviewRectHeight (ArkUI_DragEvent * event) 9454``` 9455**Description** 9456 9457Obtains the height of a drag preview from a drag event. 9458 9459**Since**: 12 9460 9461**Parameters** 9462 9463| Name| Description| 9464| -------- | -------- | 9465| event | Pointer to an **ArkUI_DragEvent** object. | 9466 9467**Returns** 9468 9469Returns the height of the drag preview, in px; returns the default value **0** if the input parameter is invalid. 9470 9471 9472### OH_ArkUI_DragEvent_GetPreviewRectWidth() 9473 9474``` 9475float OH_ArkUI_DragEvent_GetPreviewRectWidth (ArkUI_DragEvent * event) 9476``` 9477**Description** 9478 9479Obtains the width of a drag preview from a drag event. 9480 9481**Since**: 12 9482 9483**Parameters** 9484 9485| Name| Description| 9486| -------- | -------- | 9487| event | Pointer to an **ArkUI_DragEvent** object. | 9488 9489**Returns** 9490 9491Returns the width of the drag preview, in px; returns the default value **0** if the input parameter is invalid. 9492 9493 9494### OH_ArkUI_DragEvent_GetPreviewTouchPointX() 9495 9496``` 9497float OH_ArkUI_DragEvent_GetPreviewTouchPointX (ArkUI_DragEvent * event) 9498``` 9499**Description** 9500 9501Obtains the X coordinate of the touch point for a drag preview from a drag event. 9502 9503**Since**: 12 9504 9505**Parameters** 9506 9507| Name| Description| 9508| -------- | -------- | 9509| event | Pointer to an **ArkUI_DragEvent** object. | 9510 9511**Returns** 9512 9513Returns the X coordinate of the touch point, in px; returns the default value **0** if the input parameter is invalid. 9514 9515 9516### OH_ArkUI_DragEvent_GetPreviewTouchPointY() 9517 9518``` 9519float OH_ArkUI_DragEvent_GetPreviewTouchPointY (ArkUI_DragEvent * event) 9520``` 9521**Description** 9522 9523Obtains the Y coordinate of the touch point for a drag preview from a drag event. 9524 9525**Since**: 12 9526 9527**Parameters** 9528 9529| Name| Description| 9530| -------- | -------- | 9531| event | Pointer to an **ArkUI_DragEvent** object. | 9532 9533**Returns** 9534 9535Returns the Y coordinate of the touch point, in px; returns the default value **0** if the input parameter is invalid. 9536 9537 9538### OH_ArkUI_DragEvent_GetTouchPointXToDisplay() 9539 9540``` 9541float OH_ArkUI_DragEvent_GetTouchPointXToDisplay (ArkUI_DragEvent * event) 9542``` 9543**Description** 9544 9545Obtains the X coordinate of the touch point relative to the display from a drag event. 9546 9547**Since**: 12 9548 9549**Parameters** 9550 9551| Name| Description| 9552| -------- | -------- | 9553| event | Pointer to an **ArkUI_DragEvent** object. | 9554 9555**Returns** 9556 9557Returns the X coordinate of the touch point relative to the display, in px; returns the default value **0** if the input parameter is invalid. 9558 9559 9560### OH_ArkUI_DragEvent_GetTouchPointXToWindow() 9561 9562``` 9563float OH_ArkUI_DragEvent_GetTouchPointXToWindow (ArkUI_DragEvent * event) 9564``` 9565**Description** 9566 9567Obtains the X coordinate of the touch point relative to the window from a drag event. 9568 9569**Since**: 12 9570 9571**Parameters** 9572 9573| Name| Description| 9574| -------- | -------- | 9575| event | Pointer to an **ArkUI_DragEvent** object. | 9576 9577**Returns** 9578 9579Returns the X coordinate of the touch point relative to the window, in px; returns the default value **0** if the input parameter is invalid. 9580 9581 9582### OH_ArkUI_DragEvent_GetTouchPointYToDisplay() 9583 9584``` 9585float OH_ArkUI_DragEvent_GetTouchPointYToDisplay (ArkUI_DragEvent * event) 9586``` 9587**Description** 9588 9589Obtains the Y coordinate of the touch point relative to the display from a drag event. 9590 9591**Since**: 12 9592 9593**Parameters** 9594 9595| Name| Description| 9596| -------- | -------- | 9597| event | Pointer to an **ArkUI_DragEvent** object. | 9598 9599**Returns** 9600 9601Returns the Y coordinate of the touch point relative to the display, in px; returns the default value **0** if the input parameter is invalid. 9602 9603 9604### OH_ArkUI_DragEvent_GetTouchPointYToWindow() 9605 9606``` 9607float OH_ArkUI_DragEvent_GetTouchPointYToWindow (ArkUI_DragEvent * event) 9608``` 9609**Description** 9610 9611Obtains the Y coordinate of the touch point relative to the window from a drag event. 9612 9613**Since**: 12 9614 9615**Parameters** 9616 9617| Name| Description| 9618| -------- | -------- | 9619| event | Pointer to an **ArkUI_DragEvent** object. | 9620 9621**Returns** 9622 9623Returns the Y coordinate of the touch point relative to the window, in px; returns the default value **0** if the input parameter is invalid. 9624 9625 9626### OH_ArkUI_DragEvent_GetUdmfData() 9627 9628``` 9629int32_t OH_ArkUI_DragEvent_GetUdmfData (ArkUI_DragEvent * event, OH_UdmfData * data ) 9630``` 9631**Description** 9632 9633Obtain the default drag-and-drop data from ArkUI_DragEvent. 9634 9635**Since**: 12 9636 9637**Parameters** 9638 9639| Name| Description| 9640| -------- | -------- | 9641| event | Pointer to an **ArkUI_DragEvent** object. | 9642| data | Pointer to the dragged data of OH_UdmfData. When receiving data, the application needs to create a pointer for receiving data by using the OH_UdmfData_Create method. | 9643 9644**Returns** 9645 9646Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9647 9648 9649### OH_ArkUI_DragEvent_GetVelocity() 9650 9651``` 9652float OH_ArkUI_DragEvent_GetVelocity (ArkUI_DragEvent * event) 9653``` 9654**Description** 9655 9656Obtains the dragging velocity along the main axis. 9657 9658**Since**: 12 9659 9660**Parameters** 9661 9662| Name| Description| 9663| -------- | -------- | 9664| event | Pointer to an **ArkUI_DragEvent** object. | 9665 9666**Returns** 9667 9668Returns the dragging velocity along the main axis, in px; returns the default value **0** if the input parameter is invalid. 9669 9670 9671### OH_ArkUI_DragEvent_GetVelocityX() 9672 9673``` 9674float OH_ArkUI_DragEvent_GetVelocityX (ArkUI_DragEvent * event) 9675``` 9676**Description** 9677 9678Obtains the dragging velocity along the x-axis. 9679 9680**Since**: 12 9681 9682**Parameters** 9683 9684| Name| Description| 9685| -------- | -------- | 9686| event | Pointer to an **ArkUI_DragEvent** object. | 9687 9688**Returns** 9689 9690Returns the dragging velocity along the x-axis, in px; returns the default value **0** if the input parameter is invalid. 9691 9692 9693### OH_ArkUI_DragEvent_GetVelocityY() 9694 9695``` 9696float OH_ArkUI_DragEvent_GetVelocityY (ArkUI_DragEvent * event) 9697``` 9698**Description** 9699 9700Obtains the dragging velocity along the y-axis. 9701 9702**Since**: 12 9703 9704**Parameters** 9705 9706| Name| Description| 9707| -------- | -------- | 9708| event | Pointer to an **ArkUI_DragEvent** object. | 9709 9710**Returns** 9711 9712Returns the dragging velocity along the y-axis, in px; returns the default value **0** if the input parameter is invalid. 9713 9714 9715### OH_ArkUI_DragEvent_SetData() 9716 9717``` 9718int32_t OH_ArkUI_DragEvent_SetData (ArkUI_DragEvent * event, OH_UdmfData * data ) 9719``` 9720**Description** 9721 9722Sets drag data for a drag event. 9723 9724**Since**: 12 9725 9726**Parameters** 9727 9728| Name| Description| 9729| -------- | -------- | 9730| event | Pointer to an **ArkUI_DragEvent** object. | 9731| data | Drag data. | 9732 9733**Returns** 9734 9735Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9736 9737 9738### OH_ArkUI_DragEvent_SetDragResult() 9739 9740``` 9741int32_t OH_ArkUI_DragEvent_SetDragResult (ArkUI_DragEvent * event, ArkUI_DragResult result ) 9742``` 9743**Description** 9744 9745Sets the result for a drag event. 9746 9747**Since**: 12 9748 9749**Parameters** 9750 9751| Name| Description| 9752| -------- | -------- | 9753| event | Pointer to an **ArkUI_DragEvent** object. | 9754| result | Drag the data processing result. | 9755 9756**Returns** 9757 9758Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9759 9760 9761### OH_ArkUI_DragEvent_SetSuggestedDropOperation() 9762 9763``` 9764int32_t OH_ArkUI_DragEvent_SetSuggestedDropOperation (ArkUI_DragEvent * event, ArkUI_DropOperation dropOperation) 9765``` 9766**Description** 9767 9768Sets the data processing mode. 9769 9770**Since**: 12 9771 9772**Parameters** 9773 9774| Name| Description| 9775| -------- | -------- | 9776| proposal | Recommended data processing mode | 9777| proposal | Type of the badge display status. | 9778 9779**Returns** 9780 9781Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9782 9783 9784### OH_ArkUI_DragPreviewOption_Dispose() 9785 9786``` 9787void OH_ArkUI_DragPreviewOption_Dispose (ArkUI_DragPreviewOption * option) 9788``` 9789**Description** 9790 9791Disposes of an **ArkUI_DragPreviewOption** object. 9792 9793**Since**: 12 9794 9795**Parameters** 9796 9797| Name| Description| 9798| -------- | -------- | 9799| option | Custom parameters. | 9800 9801 9802### OH_ArkUI_DragPreviewOption_SetBadgeNumber() 9803 9804``` 9805int32_t OH_ArkUI_DragPreviewOption_SetBadgeNumber (ArkUI_DragPreviewOption * option, uint32_t forcedNumber ) 9806``` 9807**Description** 9808 9809Sets the count on the badge. The settings will overwrite the value in the **SetDragPreviewNumberBadgeEnabled** API. 9810 9811**Since**: 12 9812 9813**Parameters** 9814 9815| Name| Description| 9816| -------- | -------- | 9817| option | Custom parameters. | 9818| forcedNumber | Number of corner marks. | 9819 9820**Returns** 9821 9822Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9823 9824 9825### OH_ArkUI_DragPreviewOption_SetDefaultAnimationBeforeLiftingEnabled() 9826 9827``` 9828int32_t OH_ArkUI_DragPreviewOption_SetDefaultAnimationBeforeLiftingEnabled (ArkUI_DragPreviewOption * option, bool enabled ) 9829``` 9830**Description** 9831 9832Sets whether to enable the default animation on a click or touch. 9833 9834**Since**: 12 9835 9836**Parameters** 9837 9838| Name| Description| 9839| -------- | -------- | 9840| option | Custom parameters. | 9841| enabled | Whether to enable the default click effect. | 9842 9843**Returns** 9844 9845Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9846 9847 9848### OH_ArkUI_DragPreviewOption_SetDefaultRadiusEnabled() 9849 9850``` 9851int32_t OH_ArkUI_DragPreviewOption_SetDefaultRadiusEnabled (ArkUI_DragPreviewOption * option, bool enabled ) 9852``` 9853**Description** 9854 9855Sets whether to enable the default corner radius effect for an **ArkUI_DragPreviewOption** object. The effect is disabled by default. 9856 9857**Since**: 12 9858 9859**Parameters** 9860 9861| Name| Description| 9862| -------- | -------- | 9863| option | Custom parameters. | 9864| enabled | Whether to enable the default corner radius effect. | 9865 9866**Returns** 9867 9868Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9869 9870 9871### OH_ArkUI_DragPreviewOption_SetDefaultShadowEnabled() 9872 9873``` 9874int32_t OH_ArkUI_DragPreviewOption_SetDefaultShadowEnabled (ArkUI_DragPreviewOption * option, bool enabled ) 9875``` 9876**Description** 9877 9878Sets whether to enable the default shadow effect for an **ArkUI_DragPreviewOption** object. The effect is disabled by default. 9879 9880**Since**: 12 9881 9882**Parameters** 9883 9884| Name| Description| 9885| -------- | -------- | 9886| option | Custom parameters. | 9887| enabled | Whether to enable the default shadow effect. | 9888 9889**Returns** 9890 9891Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9892 9893 9894### OH_ArkUI_DragPreviewOption_SetNumberBadgeEnabled() 9895 9896``` 9897int32_t OH_ArkUI_DragPreviewOption_SetNumberBadgeEnabled (ArkUI_DragPreviewOption * option, bool enabled ) 9898``` 9899**Description** 9900 9901Sets whether to enable the badge for an **ArkUI_DragPreviewOption** object. If this feature is enabled, a badge that contains the number of dragged items is displayed. 9902 9903**Since**: 12 9904 9905**Parameters** 9906 9907| Name| Description| 9908| -------- | -------- | 9909| option | Custom parameters. | 9910| enabled | Whether to enable the badge. | 9911 9912**Returns** 9913 9914Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9915 9916 9917### OH_ArkUI_DragPreviewOption_SetScaleMode() 9918 9919``` 9920int32_t OH_ArkUI_DragPreviewOption_SetScaleMode (ArkUI_DragPreviewOption * option, ArkUI_DragPreviewScaleMode scaleMode ) 9921``` 9922**Description** 9923 9924Sets the scale mode for an **ArkUI_DragPreviewOption** object. 9925 9926**Since**: 12 9927 9928**Parameters** 9929 9930| Name| Description| 9931| -------- | -------- | 9932| option | Custom parameters. | 9933| scaleMode | Scale mode to set. | 9934 9935**Returns** 9936 9937Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9938 9939 9940### OH_ArkUI_DrawableDescriptor_CreateFromAnimatedPixelMap() 9941 9942``` 9943ArkUI_DrawableDescriptor* OH_ArkUI_DrawableDescriptor_CreateFromAnimatedPixelMap (OH_PixelmapNativeHandle * array, int32_t size ) 9944``` 9945**Description** 9946 9947Creates a **DrawableDescriptor** object from an array of **PixelMap** objects. 9948 9949**Since**: 12 9950 9951**Parameters** 9952 9953| Name| Description| 9954| -------- | -------- | 9955| array | Pointer to the array of **PixelMap** objects. | 9956| size | Size of the **PixelMap** object array. | 9957 9958**Returns** 9959 9960Returns the pointer to the created **DrawableDescriptor** object. 9961 9962 9963### OH_ArkUI_DrawableDescriptor_CreateFromPixelMap() 9964 9965``` 9966ArkUI_DrawableDescriptor* OH_ArkUI_DrawableDescriptor_CreateFromPixelMap (OH_PixelmapNativeHandle pixelMap) 9967``` 9968**Description** 9969 9970Creates a **DrawableDescriptor** object from a **PixelMap** object. 9971 9972**Since**: 12 9973 9974**Parameters** 9975 9976| Name| Description| 9977| -------- | -------- | 9978| pixelMap | Pointer to the **PixelMap** object. | 9979 9980**Returns** 9981 9982Returns the pointer to the created **DrawableDescriptor** object. 9983 9984 9985### OH_ArkUI_DrawableDescriptor_Dispose() 9986 9987``` 9988void OH_ArkUI_DrawableDescriptor_Dispose (ArkUI_DrawableDescriptor * drawableDescriptor) 9989``` 9990**Description** 9991 9992Disposes of the pointer to a **DrawableDescriptor** object. 9993 9994**Since**: 12 9995 9996**Parameters** 9997 9998| Name| Description| 9999| -------- | -------- | 10000| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 10001 10002 10003### OH_ArkUI_DrawableDescriptor_GetAnimatedPixelMapArray() 10004 10005``` 10006OH_PixelmapNativeHandle* OH_ArkUI_DrawableDescriptor_GetAnimatedPixelMapArray (ArkUI_DrawableDescriptor * drawableDescriptor) 10007``` 10008**Description** 10009 10010Obtains an array of **PixelMap** objects for playing an animation. 10011 10012**Since**: 12 10013 10014**Parameters** 10015 10016| Name| Description| 10017| -------- | -------- | 10018| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 10019 10020**Returns** 10021 10022Pointer to the PixelMap image array. 10023 10024 10025### OH_ArkUI_DrawableDescriptor_GetAnimatedPixelMapArraySize() 10026 10027``` 10028int32_t OH_ArkUI_DrawableDescriptor_GetAnimatedPixelMapArraySize (ArkUI_DrawableDescriptor * drawableDescriptor) 10029``` 10030**Description** 10031 10032Obtains an array of **PixelMap** objects for playing an animation. 10033 10034**Since**: 12 10035 10036**Parameters** 10037 10038| Name| Description| 10039| -------- | -------- | 10040| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 10041 10042**Returns** 10043 10044Size of the PixelMap image array. 10045 10046 10047### OH_ArkUI_DrawableDescriptor_GetAnimationDuration() 10048 10049``` 10050int32_t OH_ArkUI_DrawableDescriptor_GetAnimationDuration (ArkUI_DrawableDescriptor * drawableDescriptor) 10051``` 10052**Description** 10053 10054Obtains the total playback duration of a PixelMap image array. 10055 10056**Since**: 12 10057 10058**Parameters** 10059 10060| Name| Description| 10061| -------- | -------- | 10062| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 10063 10064**Returns** 10065 10066Total playback duration, in milliseconds. 10067 10068 10069### OH_ArkUI_DrawableDescriptor_GetAnimationIteration() 10070 10071``` 10072int32_t OH_ArkUI_DrawableDescriptor_GetAnimationIteration (ArkUI_DrawableDescriptor * drawableDescriptor) 10073``` 10074**Description** 10075 10076Obtains the number of times that a **PixelMap** object array is played. 10077 10078**Since**: 12 10079 10080**Parameters** 10081 10082| Name| Description| 10083| -------- | -------- | 10084| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 10085 10086**Returns** 10087 10088Returns the number of playback times. 10089 10090 10091### OH_ArkUI_DrawableDescriptor_GetStaticPixelMap() 10092 10093``` 10094OH_PixelmapNativeHandle OH_ArkUI_DrawableDescriptor_GetStaticPixelMap (ArkUI_DrawableDescriptor * drawableDescriptor) 10095``` 10096**Description** 10097 10098Obtains the pointer to a **PixelMap** object. 10099 10100**Since**: 12 10101 10102**Parameters** 10103 10104| Name| Description| 10105| -------- | -------- | 10106| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 10107 10108**Returns** 10109 10110Pointer to the PixelMap object. 10111 10112 10113### OH_ArkUI_DrawableDescriptor_SetAnimationDuration() 10114 10115``` 10116void OH_ArkUI_DrawableDescriptor_SetAnimationDuration (ArkUI_DrawableDescriptor * drawableDescriptor, int32_t duration ) 10117``` 10118**Description** 10119 10120Sets the total playback duration of a PixelMap image array. 10121 10122**Since**: 12 10123 10124**Parameters** 10125 10126| Name| Description| 10127| -------- | -------- | 10128| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 10129| duration | Total playback duration, in milliseconds. | 10130 10131 10132### OH_ArkUI_DrawableDescriptor_SetAnimationIteration() 10133 10134``` 10135void OH_ArkUI_DrawableDescriptor_SetAnimationIteration (ArkUI_DrawableDescriptor * drawableDescriptor, int32_t iteration ) 10136``` 10137**Description** 10138 10139Sets the number of times that a pixel map image array is played. 10140 10141**Since**: 12 10142 10143**Parameters** 10144 10145| Name| Description| 10146| -------- | -------- | 10147| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 10148| iterations | Number of playback times. | 10149 10150 10151### OH_ArkUI_DrawContext_GetCanvas() 10152 10153``` 10154void* OH_ArkUI_DrawContext_GetCanvas (ArkUI_DrawContext * context) 10155``` 10156**Description** 10157 10158Obtains the drawing canvas pointer, which can be converted into the OH_Drawing_Canvas pointer of the graphics library for drawing. 10159 10160**Since**: 12 10161 10162**Parameters** 10163 10164| Name| Description| 10165| -------- | -------- | 10166| context | Drawing context. | 10167 10168**Returns** 10169 10170Returns the pointer to the canvas for drawing. 10171 10172 10173### OH_ArkUI_DrawContext_GetSize() 10174 10175``` 10176ArkUI_IntSize OH_ArkUI_DrawContext_GetSize (ArkUI_DrawContext * context) 10177``` 10178**Description** 10179 10180Obtains the size of a drawing area. 10181 10182**Since**: 12 10183 10184**Parameters** 10185 10186| Name| Description| 10187| -------- | -------- | 10188| context | Drawing context. | 10189 10190**Returns** 10191 10192Returns the size of the drawing area. 10193 10194### OH_ArkUI_FocusActivate() 10195``` 10196void OH_ArkUI_FocusActivate(ArkUI_ContextHandle uiContext, bool isActive, bool isAutoInactive); 10197``` 10198**Description** 10199 10200Sets the focus activation state for the current page. When activated, the focused node displays a focus box. 10201 10202**Since**: 15 10203 10204**Parameters** 10205 10206| Name| Description| 10207| -------- | -------- | 10208| uiContext | Pointer to the UI instance object.| 10209| isActive | Whether to enter or exit the focus active state.| 10210| isAutoInactive | Whether to automatically exit the focus active state on touch or mouse down events.<br>**true**: Automatically exit the focus active state.<br>**false**: Maintain the current state until the corresponding setting API is called.| 10211 10212### OH_ArkUI_FocusClear() 10213``` 10214void OH_ArkUI_FocusClear(ArkUI_ContextHandle uiContext); 10215``` 10216**Description** 10217 10218Clears the focus to the root container node. 10219 10220**Since**: 15 10221 10222**Parameters** 10223 10224| Name| Description| 10225| -------- | -------- | 10226| uiContext | Pointer to the UI instance object.| 10227 10228### OH_ArkUI_FocusRequest() 10229``` 10230ArkUI_ErrorCode OH_ArkUI_FocusRequest(ArkUI_NodeHandle node); 10231``` 10232**Description** 10233 10234Requests focus for a specific node. 10235 10236**Since**: 15 10237 10238**Parameters** 10239 10240| Name| Description| 10241| -------- | -------- | 10242| node | Pointer to a component node. | 10243 10244### OH_ArkUI_FocusSetAutoTransfer() 10245``` 10246void OH_ArkUI_FocusSetAutoTransfer(ArkUI_ContextHandle uiContext, bool autoTransfer); 10247``` 10248**Description** 10249 10250 Configures the focus transfer behavior when pages are switched. 10251 10252**Since**: 15 10253 10254**Parameters** 10255 10256| Name| Description| 10257| -------- | -------- | 10258| uiContext | Pointer to the UI instance object.| 10259| autoTransfer | Whether to automatically transfer focus when pages are switched.| 10260 10261### OH_ArkUI_FocusSetKeyProcessingMode() 10262``` 10263void OH_ArkUI_FocusSetKeyProcessingMode(ArkUI_ContextHandle uiContext, ArkUI_KeyProcessingMode mode) 10264``` 10265**Description** 10266 10267Sets the mode for processing key events. 10268 10269**Since**: 15 10270 10271**Parameters** 10272 10273| Name| Description| 10274| -------- | -------- | 10275| uiContext | Pointer to the UI instance object.| 10276| mode | Mode for processing key events.| 10277 10278### OH_ArkUI_GestureEvent_GetActionType() 10279 10280``` 10281ArkUI_GestureEventActionType OH_ArkUI_GestureEvent_GetActionType (const ArkUI_GestureEvent * event) 10282``` 10283**Description** 10284 10285Obtains the gesture event type. 10286 10287**Since**: 12 10288 10289**Parameters** 10290 10291| Name| Description| 10292| -------- | -------- | 10293| event | Gesture event. | 10294 10295**Returns** 10296 10297Returns the gesture event type. 10298 10299 10300### OH_ArkUI_GestureEvent_GetNode() 10301 10302``` 10303ArkUI_NodeHandle OH_ArkUI_GestureEvent_GetNode (const ArkUI_GestureEvent * event) 10304``` 10305**Description** 10306 10307Obtains the ArkUI component to which the gesture is bound. 10308 10309**Since**: 12 10310 10311**Parameters** 10312 10313| Name| Description| 10314| -------- | -------- | 10315| event | Gesture event. | 10316 10317**Returns** 10318 10319Returns the ArkUI component. 10320 10321 10322### OH_ArkUI_GestureEvent_GetRawInputEvent() 10323 10324``` 10325const ArkUI_UIInputEvent* OH_ArkUI_GestureEvent_GetRawInputEvent (const ArkUI_GestureEvent * event) 10326``` 10327**Description** 10328 10329Obtains gesture input. 10330 10331**Since**: 12 10332 10333**Parameters** 10334 10335| Name| Description| 10336| -------- | -------- | 10337| event | Gesture event. | 10338 10339**Returns** 10340 10341Returns the pointer to the input event of the gesture event. 10342 10343 10344### OH_ArkUI_GestureEvent_GetResponseNode() 10345 10346``` 10347ArkUI_NodeHandle OH_ArkUI_GestureEvent_GetResponseNode (ArkUI_GestureEvent * event) 10348``` 10349**Description** 10350 10351Obtains the node that responds to the gesture. 10352 10353**Since**: 12 10354 10355**Parameters** 10356 10357| Name| Description| 10358| -------- | -------- | 10359| event | Gesture event. | 10360 10361**Returns** 10362 10363Returns the pointer to the node if the node exists; returns **NULL** otherwise. 10364 10365 10366### OH_ArkUI_GestureEventTargetInfo_IsScrollBegin() 10367 10368``` 10369int32_t OH_ArkUI_GestureEventTargetInfo_IsScrollBegin (ArkUI_GestureEventTargetInfo * info, bool * ret ) 10370``` 10371**Description** 10372 10373Obtains whether this scroll container is scrolled to the top. 10374 10375**Since**: 12 10376 10377**Parameters** 10378 10379| Name| Description| 10380| -------- | -------- | 10381| info | Gesture event target information. | 10382| ret | Obtains whether this scroll container is scrolled to the top. | 10383 10384**Returns** 10385 10386Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. Returns **180001** if the component is not a scroll container. 10387 10388 10389### OH_ArkUI_GestureEventTargetInfo_IsScrollEnd() 10390 10391``` 10392int32_t OH_ArkUI_GestureEventTargetInfo_IsScrollEnd (ArkUI_GestureEventTargetInfo * info, bool * ret ) 10393``` 10394**Description** 10395 10396Obtains whether this scroll container is scrolled to the bottom. 10397 10398**Since**: 12 10399 10400**Parameters** 10401 10402| Name| Description| 10403| -------- | -------- | 10404| info | Gesture event target information. | 10405| ret | Obtains whether this scroll container is scrolled to the bottom. | 10406 10407**Returns** 10408 10409Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. Returns **180001** if the component is not a scroll container. 10410 10411 10412### OH_ArkUI_GestureInterruptInfo_GetGestureEvent() 10413 10414``` 10415ArkUI_GestureEvent* OH_ArkUI_GestureInterruptInfo_GetGestureEvent (const ArkUI_GestureInterruptInfo * event) 10416``` 10417**Description** 10418 10419Obtains the pointer to the interrupted gesture event. 10420 10421**Since**: 12 10422 10423**Parameters** 10424 10425| Name| Description| 10426| -------- | -------- | 10427| event | Interrupt callback event. | 10428 10429**Returns** 10430 10431Returns the pointer to the interrupted gesture event. 10432 10433### OH_ArkUI_GestureInterruptInfo_GetRecognizer() 10434 10435``` 10436ArkUI_GestureRecognizer* OH_ArkUI_GestureInterruptInfo_GetRecognizer (const ArkUI_GestureInterruptInfo * event) 10437``` 10438**Description** 10439 10440Returns the pointer to interrupted gesture recognizer. 10441 10442**Since**: 12 10443 10444**Parameters** 10445 10446| Name| Description| 10447| -------- | -------- | 10448| event | Interrupt callback event. | 10449 10450**Returns** 10451 10452Pointer to the interrupted gesture. 10453 10454 10455### OH_ArkUI_GestureInterruptInfo_GetSystemFlag() 10456 10457``` 10458bool OH_ArkUI_GestureInterruptInfo_GetSystemFlag (const ArkUI_GestureInterruptInfo * event) 10459``` 10460**Description** 10461 10462Checks whether a gesture is a built-in gesture of the component. 10463 10464**Since**: 12 10465 10466**Parameters** 10467 10468| Name| Description| 10469| -------- | -------- | 10470| event | Gesture interrupt callback event. | 10471 10472**Returns** 10473 10474true: built-in gestures; false: non-built-in gestures. 10475 10476 10477### OH_ArkUI_GestureInterruptInfo_GetSystemRecognizerType() 10478 10479``` 10480int32_t OH_ArkUI_GestureInterruptInfo_GetSystemRecognizerType (const ArkUI_GestureInterruptInfo * event) 10481``` 10482**Description** 10483 10484Obtains the type of the system gesture to trigger. 10485 10486**Since**: 12 10487 10488**Parameters** 10489 10490| Name| Description| 10491| -------- | -------- | 10492| event | Interrupt callback event. | 10493 10494**Returns** 10495 10496Returns the type of the system gesture to trigger. If the gesture to trigger is not a system gesture, **-1** is returned. 10497 10498 10499### OH_ArkUI_GestureInterruptInfo_GetTouchRecognizers() 10500 10501``` 10502int32_t OH_ArkUI_GestureInterruptInfo_GetTouchRecognizers(const ArkUI_GestureInterruptInfo* info, 10503 ArkUI_TouchRecognizerHandleArray* recognizers, int32_t* size) 10504``` 10505**Description** 10506 10507Obtains touch recognizers from gesture interruption information. 10508 10509**Since**: 15 10510 10511**Parameters** 10512 10513| Name| Description| 10514| -------- | -------- | 10515| info | Interrupt callback event. | 10516| recognizers | Pointer to the array of touch recognizers. | 10517| size | Pointer to the size of the touch recognizer array. | 10518 10519**Returns** 10520 10521Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 10522 10523 10524### OH_ArkUI_TouchRecognizer_GetNodeHandle() 10525 10526``` 10527ArkUI_NodeHandle OH_ArkUI_TouchRecognizer_GetNodeHandle(const ArkUI_TouchRecognizerHandle recognizer) 10528``` 10529**Description** 10530 10531Obtains the component handle corresponding to a touch recognizer. 10532 10533**Since**: 15 10534 10535**Parameters** 10536 10537| Name| Description| 10538| -------- | -------- | 10539| recognizer | Handle to the touch recognizer. | 10540 10541**Returns** 10542 10543Returns the component handle corresponding to the touch recognizer. 10544 10545 10546### OH_ArkUI_TouchRecognizer_CancelTouch() 10547 10548``` 10549int32_t OH_ArkUI_TouchRecognizer_CancelTouch(ArkUI_TouchRecognizerHandle recognizer, ArkUI_GestureInterruptInfo* info) 10550``` 10551**Description** 10552 10553Sends a cancel touch event to a touch recognizer in a gesture interruption callback. 10554 10555**Since**: 15 10556 10557**Parameters** 10558 10559| Name| Description| 10560| -------- | -------- | 10561| recognizer | Handle to the touch recognizer. | 10562| info | Interrupt callback event. | 10563 10564**Returns** 10565 10566Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 10567 10568 10569### OH_ArkUI_GetContextByNode() 10570 10571``` 10572ArkUI_ContextHandle OH_ArkUI_GetContextByNode (ArkUI_NodeHandle node) 10573``` 10574**Description** 10575 10576Obtains the pointer to the UI context object of the specified node. 10577 10578**Since**: 12 10579 10580**Parameters** 10581 10582| Name| Description| 10583| -------- | -------- | 10584| node | Specified node. | 10585 10586**Returns** 10587 10588Returns the pointer to the UI context object. 10589 10590 10591### OH_ArkUI_GetContextFromNapiValue() 10592 10593``` 10594int32_t OH_ArkUI_GetContextFromNapiValue (napi_env env, napi_value value, ArkUI_ContextHandle * context ) 10595``` 10596**Description** 10597 10598Obtains a **UIContext** object on the ArkTS side and maps it to an **ArkUI_ContextHandle** object on the native side. 10599 10600**Since**: 12 10601 10602**Parameters** 10603 10604| Name| Description| 10605| -------- | -------- | 10606| env | Pointer to the NAPI environment. | 10607| value | Context object created on the ArkTS side. | 10608| context | ArkUI_ContextHandle pointer. | 10609 10610**Returns** 10611 10612Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 10613 10614 10615### OH_ArkUI_GetDrawableDescriptorFromNapiValue() 10616 10617``` 10618int32_t OH_ArkUI_GetDrawableDescriptorFromNapiValue (napi_env env, napi_value value, ArkUI_DrawableDescriptor ** drawableDescriptor ) 10619``` 10620**Description** 10621 10622Maps a **DrawableDescriptor** object on the ArkTS side to an **ArkUI_DrawableDescriptor** object on the native side. 10623 10624**Since**: 12 10625 10626**Parameters** 10627 10628| Name| Description| 10629| -------- | -------- | 10630| env | Pointer to the NAPI environment. | 10631| value | **DrawableDescriptor** object created on the ArkTS side. | 10632| drawableDescriptor | Object that receives the pointer to the **ArkUI_DrawableDescriptor** object. | 10633 10634**Returns** 10635 10636Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 10637 10638 10639### OH_ArkUI_GetDrawableDescriptorFromResourceNapiValue() 10640 10641``` 10642int32_t OH_ArkUI_GetDrawableDescriptorFromResourceNapiValue (napi_env env, napi_value value, ArkUI_DrawableDescriptor ** drawableDescriptor ) 10643``` 10644**Description** 10645 10646Maps an $r resource object on the ArkTS side to an **ArkUI_DrawableDescriptor** object on the native side. 10647 10648**Since**: 12 10649 10650**Parameters** 10651 10652| Name| Description| 10653| -------- | -------- | 10654| env | Pointer to the NAPI environment. | 10655| value | $r resource object created on ArkTS. | 10656| drawableDescriptor | Object that receives the pointer to the **ArkUI_DrawableDescriptor** object. | 10657 10658**Returns** 10659 10660Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 10661 10662 10663### OH_ArkUI_GetGestureBindNodeId() 10664 10665``` 10666int32_t OH_ArkUI_GetGestureBindNodeId (ArkUI_GestureRecognizer * recognizer, char * nodeId, int32_t size, int32_t * result ) 10667``` 10668**Description** 10669 10670Obtains the ID of the component linked to a gesture recognizer. 10671 10672**Since**: 12 10673 10674**Parameters** 10675 10676| Name| Description| 10677| -------- | -------- | 10678| recognizer | Pointer to the gesture recognizer. | 10679| nodeId | ID of a component. | 10680| size | Size of the storage area. | 10681| result | Length of the string to be copied. | 10682 10683**Returns** 10684 10685Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. Returns **180002** if the buffer is not large enough. 10686 10687 10688### OH_ArkUI_GetGestureEventTargetInfo() 10689 10690``` 10691int32_t OH_ArkUI_GetGestureEventTargetInfo (ArkUI_GestureRecognizer * recognizer, ArkUI_GestureEventTargetInfo ** info ) 10692``` 10693**Description** 10694 10695Obtains the information about a gesture event target. 10696 10697**Since**: 12 10698 10699**Parameters** 10700 10701| Name| Description| 10702| -------- | -------- | 10703| recognizer | Pointer to the gesture recognizer. | 10704| info | Gesture event target information. | 10705 10706**Returns** 10707 10708Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 10709 10710 10711### OH_ArkUI_GetGestureRecognizerEnabled() 10712 10713``` 10714bool OH_ArkUI_GetGestureRecognizerEnabled (ArkUI_GestureRecognizer * recognizer) 10715``` 10716**Description** 10717 10718Obtains the enabled state of a gesture recognizer. 10719 10720**Since**: 12 10721 10722**Parameters** 10723 10724| Name| Description| 10725| -------- | -------- | 10726| recognizer | Pointer to the gesture recognizer. | 10727 10728**Returns** 10729 10730**true**: enabled false: disabled 10731 10732 10733### OH_ArkUI_GetGestureRecognizerState() 10734 10735``` 10736int32_t OH_ArkUI_GetGestureRecognizerState (ArkUI_GestureRecognizer * recognizer, ArkUI_GestureRecognizerState * state ) 10737``` 10738**Description** 10739 10740Obtains the state of a gesture recognizer. 10741 10742**Since**: 12 10743 10744**Parameters** 10745 10746| Name| Description| 10747| -------- | -------- | 10748| recognizer | Pointer to the gesture recognizer. | 10749| state | Status of the gesture recognizer. | 10750 10751**Returns** 10752 10753Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 10754 10755 10756### OH_ArkUI_GetGestureTag() 10757 10758``` 10759int32_t OH_ArkUI_GetGestureTag (ArkUI_GestureRecognizer * recognizer, char * buffer, int32_t bufferSize, int32_t * result ) 10760``` 10761**Description** 10762 10763Obtains the mark of the gesture recognizer. 10764 10765**Since**: 12 10766 10767**Parameters** 10768 10769| Name| Description| 10770| -------- | -------- | 10771| recognizer | Pointer to the gesture recognizer. | 10772| buffer | Storage zone | 10773| bufferSize | Size of the storage area. | 10774| result | Length of the string to be copied. | 10775 10776**Returns** 10777 10778Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. Returns **180002** if the buffer is not large enough. 10779 10780 10781### OH_ArkUI_GetNavDestinationId() 10782 10783``` 10784ArkUI_ErrorCode OH_ArkUI_GetNavDestinationId (ArkUI_NodeHandle node, char * buffer, int32_t bufferSize, int32_t * writeLength ) 10785``` 10786**Description** 10787 10788Obtains the ID of the **NavDestination** component where the specified node is located. 10789 10790**Since**: 12 10791 10792**Parameters** 10793 10794| Name| Description| 10795| -------- | -------- | 10796| node | Specified node. | 10797| buffer | buffer. NavDestinationID is written to this memory area. | 10798| bufferSize | Pointer to the buffer size. | 10799| writeLength | When ARKUI_ERROR_CODE_NO_ERROR is returned, this parameter indicates the length of the string written to the buffer. When ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR is returned, this parameter indicates the minimum buffer size that can hold the target. | 10800 10801**Returns** 10802 10803Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. The ARKUI_ERROR_CODE_GET_INFO_FAILED fails to query information. The possible cause is that the current node is not in Navigation. The buffer size specified by ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR is less than the minimum buffer size that can hold the target. 10804 10805 10806### OH_ArkUI_GetNavDestinationIndex() 10807 10808``` 10809ArkUI_ErrorCode OH_ArkUI_GetNavDestinationIndex (ArkUI_NodeHandle node, int32_t * index ) 10810``` 10811**Description** 10812 10813Obtains the index of the **NavDestination** component where the specified node is located in the navigation stack. 10814 10815**Since**: 12 10816 10817**Parameters** 10818 10819| Name| Description| 10820| -------- | -------- | 10821| node | Specified node. | 10822| index | Returns the index, starting from 0. | 10823 10824**Returns** 10825 10826Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. The ARKUI_ERROR_CODE_GET_INFO_FAILED fails to query information. The possible cause is that the current node is not in Navigation. 10827 10828 10829### OH_ArkUI_GetNavDestinationName() 10830 10831``` 10832ArkUI_ErrorCode OH_ArkUI_GetNavDestinationName (ArkUI_NodeHandle node, char * buffer, int32_t bufferSize, int32_t * writeLength ) 10833``` 10834**Description** 10835 10836Obtains the name of the **NavDestination** component where the specified node is located. 10837 10838**Since**: 12 10839 10840**Parameters** 10841 10842| Name| Description| 10843| -------- | -------- | 10844| node | Specified node. | 10845| buffer | Buffer. The queried NavDestination name is written to this memory area. | 10846| bufferSize | Pointer to the buffer size. | 10847| writeLength | When ARKUI_ERROR_CODE_NO_ERROR is returned, this parameter indicates the length of the string written to the buffer. When ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR is returned, this parameter indicates the minimum buffer size that can hold the target. | 10848 10849**Returns** 10850 10851Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. The ARKUI_ERROR_CODE_GET_INFO_FAILED fails to query information. The possible cause is that the current node is not in Navigation. The buffer size specified by ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR is less than the minimum buffer size that can hold the target. 10852 10853 10854### OH_ArkUI_GetNavDestinationNameByIndex() 10855 10856``` 10857ArkUI_ErrorCode OH_ArkUI_GetNavDestinationNameByIndex (ArkUI_NodeHandle node, int32_t index, char * buffer, int32_t bufferSize, int32_t * writeLength ) 10858``` 10859**Description** 10860 10861Obtains the page name that matches the specified index in the navigation stack where the specified node is located. The index starts from 0, which indicates the bottom of the stack. 10862 10863**Since**: 12 10864 10865**Parameters** 10866 10867| Name| Description| 10868| -------- | -------- | 10869| node | Specified node. | 10870| index | Index of the queried NavDestination in the stack. | 10871| buffer | Buffer. The name of the queried page is written to this memory area. | 10872| bufferSize | Pointer to the buffer size. | 10873| writeLength | When ARKUI_ERROR_CODE_NO_ERROR is returned, this parameter indicates the length of the string written to the buffer. When ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR is returned, this parameter indicates the minimum buffer size that can hold the target. | 10874 10875**Returns** 10876 10877Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. The value of ARKUI_ERROR_CODE_NODE_INDEX_INVALID index is invalid. The ARKUI_ERROR_CODE_GET_INFO_FAILED fails to query information. The possible cause is that the current node is not in Navigation. The buffer size specified by ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR is less than the minimum buffer size that can hold the target. 10878 10879 10880### OH_ArkUI_GetNavDestinationParam() 10881 10882``` 10883napi_value OH_ArkUI_GetNavDestinationParam (ArkUI_NodeHandle node) 10884``` 10885**Description** 10886 10887Obtains the parameters of the **NavDestination** component where the specified node is located. 10888 10889**Since**: 12 10890 10891**Parameters** 10892 10893| Name| Description| 10894| -------- | -------- | 10895| node | Specified node. | 10896 10897**Returns** 10898 10899Parameter object. 10900 10901 10902### OH_ArkUI_GetNavDestinationState() 10903 10904``` 10905ArkUI_ErrorCode OH_ArkUI_GetNavDestinationState (ArkUI_NodeHandle node, ArkUI_NavDestinationState * state ) 10906``` 10907**Description** 10908 10909Obtains the state of the **NavDestination** component where the specified node is located. 10910 10911**Since**: 12 10912 10913**Parameters** 10914 10915| Name| Description| 10916| -------- | -------- | 10917| node | Specified node. | 10918| state | The status value of NavDestination is written back to this parameter. | 10919 10920**Returns** 10921 10922The error code ARKUI_ERROR_CODE_NO_ERROR is returned. The ARKUI_ERROR_CODE_GET_INFO_FAILED fails to query information. The possible cause is that the current node is not in Navigation. 10923 10924 10925### OH_ArkUI_GetNavigationId() 10926 10927``` 10928ArkUI_ErrorCode OH_ArkUI_GetNavigationId (ArkUI_NodeHandle node, char * buffer, int32_t bufferSize, int32_t * writeLength ) 10929``` 10930**Description** 10931 10932Obtains the ID of the **Navigation** component where the specified node is located. 10933 10934**Since**: 12 10935 10936**Parameters** 10937 10938| Name| Description| 10939| -------- | -------- | 10940| node | Specified node. | 10941| buffer | buffer. The NavigationID is written to this memory area. | 10942| bufferSize | Pointer to the buffer size. | 10943| writeLength | When ARKUI_ERROR_CODE_NO_ERROR is returned, this parameter indicates the length of the string written to the buffer. When ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR is returned, this parameter indicates the minimum buffer size that can hold the target. | 10944 10945**Returns** 10946 10947Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. The ARKUI_ERROR_CODE_GET_INFO_FAILED fails to query information. The possible cause is that the current node is not in Navigation. The buffer size specified by ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR is less than the minimum buffer size that can hold the target. 10948 10949 10950### OH_ArkUI_GetNavStackLength() 10951 10952``` 10953ArkUI_ErrorCode OH_ArkUI_GetNavStackLength (ArkUI_NodeHandle node, int32_t * length ) 10954``` 10955**Description** 10956 10957Obtains the length of the navigation stack where the specified node is located. 10958 10959**Since**: 12 10960 10961**Parameters** 10962 10963| Name| Description| 10964| -------- | -------- | 10965| node | Specified node. | 10966| length | Length of the stack. The result, if obtained successfully, is written back to this parameter. | 10967 10968**Returns** 10969 10970Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. The ARKUI_ERROR_CODE_GET_INFO_FAILED fails to query information. The possible cause is that the current node is not in Navigation. 10971 10972 10973### OH_ArkUI_GetNodeContentFromNapiValue() 10974 10975``` 10976int32_t OH_ArkUI_GetNodeContentFromNapiValue (napi_env env, napi_value value, ArkUI_NodeContentHandle * content ) 10977``` 10978**Description** 10979 10980Obtains a **NodeContent** object on the ArkTS side and maps it to an **ArkUI_NodeContentHandle** object on the native side. 10981 10982**Since**: 12 10983 10984**Parameters** 10985 10986| Name| Description| 10987| -------- | -------- | 10988| env | Pointer to the NAPI environment. | 10989| value | NodeContent object created on ArkTS. | 10990| context | ArkUI_NodeContentHandle pointer. | 10991 10992**Returns** 10993 10994Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 10995 10996 10997### OH_ArkUI_GetNodeHandleFromNapiValue() 10998 10999``` 11000int32_t OH_ArkUI_GetNodeHandleFromNapiValue (napi_env env, napi_value frameNode, ArkUI_NodeHandle * handle ) 11001``` 11002**Description** 11003 11004Obtains a **FrameNode** object on the ArkTS side and maps it to an **ArkUI_NodeHandle** object on the native side. 11005 11006**Since**: 12 11007 11008**Parameters** 11009 11010| Name| Description| 11011| -------- | -------- | 11012| env | Pointer to the NAPI environment. | 11013| frameNode | FrameNode object created on the ArkTS side. | 11014| handle | **ArkUI_NodeHandle** pointer. | 11015 11016**Returns** 11017 11018Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11019 11020 11021### OH_ArkUI_GetPanGestureDirectionMask() 11022 11023``` 11024int32_t OH_ArkUI_GetPanGestureDirectionMask (ArkUI_GestureRecognizer * recognizer, ArkUI_GestureDirectionMask * directionMask ) 11025``` 11026**Description** 11027 11028Obtains the direction of a pan gesture. 11029 11030**Since**: 12 11031 11032**Parameters** 11033 11034| Name| Description| 11035| -------- | -------- | 11036| recognizer | Pointer to the gesture recognizer. | 11037| directionMask | Sliding direction of the sliding gesture. | 11038 11039**Returns** 11040 11041Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 11042 11043 11044### OH_ArkUI_GetResponseRecognizersFromInterruptInfo() 11045 11046``` 11047int32_t OH_ArkUI_GetResponseRecognizersFromInterruptInfo (const ArkUI_GestureInterruptInfo * event, ArkUI_GestureRecognizerHandleArray * responseChain, int32_t * count ) 11048``` 11049**Description** 11050 11051Obtains information about a gesture response chain. 11052 11053**Since**: 12 11054 11055**Parameters** 11056 11057| Name| Description| 11058| -------- | -------- | 11059| event | Gesture interrupt callback event. | 11060| responseChain | Gesture recognizer on the response chain component. | 11061| count | Number of gesture recognizers on the response chain component. | 11062 11063**Returns** 11064 11065Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 11066 11067 11068### OH_ArkUI_GetRouterPageId() 11069 11070``` 11071ArkUI_ErrorCode OH_ArkUI_GetRouterPageId (ArkUI_NodeHandle node, char * buffer, int32_t bufferSize, int32_t * writeLength ) 11072``` 11073**Description** 11074 11075Obtains the ID of the page where the specified node is located. 11076 11077**Since**: 12 11078 11079**Parameters** 11080 11081| Name| Description| 11082| -------- | -------- | 11083| node | Specified node. | 11084| buffer | buffer. Page Id is written to this memory area. | 11085| bufferSize | Pointer to the buffer size. | 11086| writeLength | When ARKUI_ERROR_CODE_NO_ERROR is returned, this parameter indicates the length of the string written to the buffer. When ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR is returned, this parameter indicates the minimum buffer size that can hold the target. | 11087 11088**Returns** 11089 11090Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. The ARKUI_ERROR_CODE_GET_INFO_FAILED fails to query information. The buffer size specified by ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR is less than the minimum buffer size that can hold the target. 11091 11092 11093### OH_ArkUI_GetRouterPageIndex() 11094 11095``` 11096ArkUI_ErrorCode OH_ArkUI_GetRouterPageIndex (ArkUI_NodeHandle node, int32_t * index ) 11097``` 11098**Description** 11099 11100Obtains the index of the page where the specified node is located in the page stack for routing. 11101 11102**Since**: 12 11103 11104**Parameters** 11105 11106| Name| Description| 11107| -------- | -------- | 11108| node | Specified node. | 11109| index | Returns the index, starting from 1. | 11110 11111**Returns** 11112 11113Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. The ARKUI_ERROR_CODE_GET_INFO_FAILED fails to query information. The possible cause is that the current node is not in Navigation. 11114 11115 11116### OH_ArkUI_GetRouterPageName() 11117 11118``` 11119ArkUI_ErrorCode OH_ArkUI_GetRouterPageName (ArkUI_NodeHandle node, char * buffer, int32_t bufferSize, int32_t * writeLength ) 11120``` 11121**Description** 11122 11123Obtains the name of the page where the specified node is located. 11124 11125**Since**: 12 11126 11127**Parameters** 11128 11129| Name| Description| 11130| -------- | -------- | 11131| node | Specified node. | 11132| buffer | Buffer. The page name is written to this memory area. | 11133| bufferSize | Pointer to the buffer size. | 11134| writeLength | When ARKUI_ERROR_CODE_NO_ERROR is returned, this parameter indicates the length of the string written to the buffer. When ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR is returned, this parameter indicates the minimum buffer size that can hold the target. | 11135 11136**Returns** 11137 11138Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. The ARKUI_ERROR_CODE_GET_INFO_FAILED fails to query information. The buffer size specified by ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR is less than the minimum buffer size that can hold the target. 11139 11140 11141### OH_ArkUI_GetRouterPagePath() 11142 11143``` 11144ArkUI_ErrorCode OH_ArkUI_GetRouterPagePath (ArkUI_NodeHandle node, char * buffer, int32_t bufferSize, int32_t * writeLength ) 11145``` 11146**Description** 11147 11148Obtains the path to the page where the specified node is located. 11149 11150**Since**: 12 11151 11152**Parameters** 11153 11154| Name| Description| 11155| -------- | -------- | 11156| node | Specified node. | 11157| buffer | buffer. Page Path is written to this memory area. | 11158| bufferSize | Pointer to the buffer size. | 11159| writeLength | When ARKUI_ERROR_CODE_NO_ERROR is returned, this parameter indicates the length of the string written to the buffer. When ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR is returned, this parameter indicates the minimum buffer size that can hold the target. | 11160 11161**Returns** 11162 11163Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. The ARKUI_ERROR_CODE_GET_INFO_FAILED fails to query information. The buffer size specified by ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR is less than the minimum buffer size that can hold the target. 11164 11165 11166### OH_ArkUI_GetRouterPageState() 11167 11168``` 11169ArkUI_ErrorCode OH_ArkUI_GetRouterPageState (ArkUI_NodeHandle node, ArkUI_RouterPageState * state ) 11170``` 11171**Description** 11172 11173Obtains the state of the page where the specified node is located. 11174 11175**Since**: 12 11176 11177**Parameters** 11178 11179| Name| Description| 11180| -------- | -------- | 11181| node | Specified node. | 11182| state | The status value of Router Page is written back to this parameter. | 11183 11184**Returns** 11185 11186The error code ARKUI_ERROR_CODE_NO_ERROR is returned. The ARKUI_ERROR_CODE_GET_INFO_FAILED fails to query information. 11187 11188 11189### OH_ArkUI_GuidelineOption_Create() 11190 11191``` 11192ArkUI_GuidelineOption* OH_ArkUI_GuidelineOption_Create (int32_t size) 11193``` 11194**Description** 11195 11196Creates a guideline configuration for this **RelativeContainer**. 11197 11198**Since**: 12 11199 11200**Parameters** 11201 11202| Name| Description| 11203| -------- | -------- | 11204| size | Number of guidelines. | 11205 11206**Returns** 11207 11208Returns the guideline configuration. 11209 11210 11211### OH_ArkUI_GuidelineOption_Dispose() 11212 11213``` 11214void OH_ArkUI_GuidelineOption_Dispose (ArkUI_GuidelineOption * guideline) 11215``` 11216**Description** 11217 11218Destroys auxiliary line information. 11219 11220**Since**: 12 11221 11222**Parameters** 11223 11224| Name| Description| 11225| -------- | -------- | 11226| guideline | Pointer to a guideline configuration. | 11227 11228 11229### OH_ArkUI_GuidelineOption_GetDirection() 11230 11231``` 11232ArkUI_Axis OH_ArkUI_GuidelineOption_GetDirection (ArkUI_GuidelineOption * guideline, int32_t index ) 11233``` 11234**Description** 11235 11236Obtains the direction of a guideline. 11237 11238**Since**: 12 11239 11240**Parameters** 11241 11242| Name| Description| 11243| -------- | -------- | 11244| guideline | Pointer to a guideline configuration. | 11245| index | Index of the barrier. | 11246 11247**Returns** 11248 11249Returns the direction of the guideline. 11250 11251 11252### OH_ArkUI_GuidelineOption_GetId() 11253 11254``` 11255const char* OH_ArkUI_GuidelineOption_GetId (ArkUI_GuidelineOption * guideline, int32_t index ) 11256``` 11257**Description** 11258 11259Obtains the ID of a guideline. 11260 11261**Since**: 12 11262 11263**Parameters** 11264 11265| Name| Description| 11266| -------- | -------- | 11267| guideline | Pointer to a guideline configuration. | 11268| index | Index of the barrier. | 11269 11270**Returns** 11271 11272Returns the ID of the guideline. 11273 11274 11275### OH_ArkUI_GuidelineOption_GetPositionEnd() 11276 11277``` 11278float OH_ArkUI_GuidelineOption_GetPositionEnd (ArkUI_GuidelineOption * guideline, int32_t index ) 11279``` 11280**Description** 11281 11282Obtains the distance between a guideline and the right or bottom of the container. 11283 11284**Since**: 12 11285 11286**Parameters** 11287 11288| Name| Description| 11289| -------- | -------- | 11290| guideline | Pointer to a guideline configuration. | 11291| index | Index of the barrier. | 11292 11293**Returns** 11294 11295Distance between the guideline and the right or bottom of the container. 11296 11297 11298### OH_ArkUI_GuidelineOption_GetPositionStart() 11299 11300``` 11301float OH_ArkUI_GuidelineOption_GetPositionStart (ArkUI_GuidelineOption * guideline, int32_t index ) 11302``` 11303**Description** 11304 11305Obtains the distance between a guideline and the left or top of the container. 11306 11307**Since**: 12 11308 11309**Parameters** 11310 11311| Name| Description| 11312| -------- | -------- | 11313| guideline | Pointer to a guideline configuration. | 11314| index | Index of the barrier. | 11315 11316**Returns** 11317 11318Distance between the guideline and the left or top of the container. 11319 11320 11321### OH_ArkUI_GuidelineOption_SetDirection() 11322 11323``` 11324void OH_ArkUI_GuidelineOption_SetDirection (ArkUI_GuidelineOption * guideline, ArkUI_Axis value, int32_t index ) 11325``` 11326**Description** 11327 11328Sets the direction of a guideline. 11329 11330**Since**: 12 11331 11332**Parameters** 11333 11334| Name| Description| 11335| -------- | -------- | 11336| guideline | Pointer to a guideline configuration. | 11337| value | Direction. | 11338| index | Index of the guideline. | 11339 11340 11341### OH_ArkUI_GuidelineOption_SetId() 11342 11343``` 11344void OH_ArkUI_GuidelineOption_SetId (ArkUI_GuidelineOption * guideline, const char * value, int32_t index ) 11345``` 11346**Description** 11347 11348Sets the ID of a guideline. 11349 11350**Since**: 12 11351 11352**Parameters** 11353 11354| Name| Description| 11355| -------- | -------- | 11356| guideline | Pointer to a guideline configuration. | 11357| value | ID of the barrier, which must be unique and cannot be the same as the name of any component in the container. | 11358| index | Index of the guideline. | 11359 11360 11361### OH_ArkUI_GuidelineOption_SetPositionEnd() 11362 11363``` 11364void OH_ArkUI_GuidelineOption_SetPositionEnd (ArkUI_GuidelineOption * guideline, float value, int32_t index ) 11365``` 11366**Description** 11367 11368Sets the distance between a guideline and the right or bottom of the container. 11369 11370**Since**: 12 11371 11372**Parameters** 11373 11374| Name| Description| 11375| -------- | -------- | 11376| guideline | Pointer to a guideline configuration. | 11377| value | Distance between the guideline and the right or bottom of the container. | 11378| index | Index of the guideline. | 11379 11380 11381### OH_ArkUI_GuidelineOption_SetPositionStart() 11382 11383``` 11384void OH_ArkUI_GuidelineOption_SetPositionStart (ArkUI_GuidelineOption * guideline, float value, int32_t index ) 11385``` 11386**Description** 11387 11388Sets the distance between a guideline and the left or top of the container. 11389 11390**Since**: 12 11391 11392**Parameters** 11393 11394| Name| Description| 11395| -------- | -------- | 11396| guideline | Pointer to a guideline configuration. | 11397| value | Distance between the guideline and the left or top of the container. | 11398| index | Index of the guideline. | 11399 11400 11401### OH_ArkUI_ImageAnimatorFrameInfo_CreateFromDrawableDescriptor() 11402 11403``` 11404ArkUI_ImageAnimatorFrameInfo* OH_ArkUI_ImageAnimatorFrameInfo_CreateFromDrawableDescriptor (ArkUI_DrawableDescriptor * drawable) 11405``` 11406**Description** 11407 11408Creates an image frame information object based on a **DrawableDescriptor** object, with the image format being Resource or PixelMap. 11409 11410**Since**: 12 11411 11412**Parameters** 11413 11414| Name| Description| 11415| -------- | -------- | 11416| drawable | Pointer to an **ArkUI_DrawableDescriptor** object created using Resource or PixelMap. | 11417 11418**Returns** 11419 11420Returns the pointer to the created frame image object. 11421 11422 11423### OH_ArkUI_ImageAnimatorFrameInfo_CreateFromString() 11424 11425``` 11426ArkUI_ImageAnimatorFrameInfo* OH_ArkUI_ImageAnimatorFrameInfo_CreateFromString (char * src) 11427``` 11428**Description** 11429 11430Creates an image frame information object based on an image path, with the image format being SVG, PNG, or JPG. 11431 11432**Since**: 12 11433 11434**Parameters** 11435 11436| Name| Description| 11437| -------- | -------- | 11438| src | Image path. | 11439 11440**Returns** 11441 11442Returns the pointer to the created frame image object. 11443 11444 11445### OH_ArkUI_ImageAnimatorFrameInfo_Dispose() 11446 11447``` 11448void OH_ArkUI_ImageAnimatorFrameInfo_Dispose (ArkUI_ImageAnimatorFrameInfo * imageInfo) 11449``` 11450**Description** 11451 11452Disposes of the pointer to an image frame information object. 11453 11454**Since**: 12 11455 11456**Parameters** 11457 11458| Name| Description| 11459| -------- | -------- | 11460| imageInfo | Pointer to the frame image object. | 11461 11462 11463### OH_ArkUI_ImageAnimatorFrameInfo_GetDuration() 11464 11465``` 11466int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetDuration (ArkUI_ImageAnimatorFrameInfo * imageInfo) 11467``` 11468**Description** 11469 11470Obtains the playback duration of an image. 11471 11472**Since**: 12 11473 11474**Parameters** 11475 11476| Name| Description| 11477| -------- | -------- | 11478| imageInfo | Pointer to the frame image object. | 11479 11480**Returns** 11481 11482Returns the playback duration of the image, in milliseconds. If **imageInfo** is a null pointer, **0** is returned. 11483 11484 11485### OH_ArkUI_ImageAnimatorFrameInfo_GetHeight() 11486 11487``` 11488int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetHeight (ArkUI_ImageAnimatorFrameInfo * imageInfo) 11489``` 11490**Description** 11491 11492Obtains the image height. 11493 11494**Since**: 12 11495 11496**Parameters** 11497 11498| Name| Description| 11499| -------- | -------- | 11500| imageInfo | Pointer to the frame image object. | 11501 11502**Returns** 11503 11504Returns the image height, in PX. If **imageInfo** is a null pointer, **0** is returned. 11505 11506 11507### OH_ArkUI_ImageAnimatorFrameInfo_GetLeft() 11508 11509``` 11510int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetLeft (ArkUI_ImageAnimatorFrameInfo * imageInfo) 11511``` 11512**Description** 11513 11514Obtains the horizontal coordinate of an image relative to the upper left corner of the component. 11515 11516**Since**: 12 11517 11518**Parameters** 11519 11520| Name| Description| 11521| -------- | -------- | 11522| imageInfo | Pointer to the frame image object. | 11523 11524**Returns** 11525 11526Returns the horizontal coordinate of the image relative to the upper left corner of the component, in px. If **imageInfo** is a null pointer, **0** is returned. 11527 11528 11529### OH_ArkUI_ImageAnimatorFrameInfo_GetTop() 11530 11531``` 11532int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetTop (ArkUI_ImageAnimatorFrameInfo * imageInfo) 11533``` 11534**Description** 11535 11536Obtains the vertical coordinate of an image relative to the upper left corner of the component. 11537 11538**Since**: 12 11539 11540**Parameters** 11541 11542| Name| Description| 11543| -------- | -------- | 11544| imageInfo | Pointer to the frame image object. | 11545 11546**Returns** 11547 11548Returns the vertical coordinate of the image relative to the upper left corner of the component, in px. If **imageInfo** is a null pointer, **0** is returned. 11549 11550 11551### OH_ArkUI_ImageAnimatorFrameInfo_GetWidth() 11552 11553``` 11554int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetWidth (ArkUI_ImageAnimatorFrameInfo * imageInfo) 11555``` 11556**Description** 11557 11558Obtains the image width. 11559 11560**Since**: 12 11561 11562**Parameters** 11563 11564| Name| Description| 11565| -------- | -------- | 11566| imageInfo | Pointer to the frame image object. | 11567 11568**Returns** 11569 11570Returns the image width, in PX. If **imageInfo** is a null pointer, **0** is returned. 11571 11572 11573### OH_ArkUI_ImageAnimatorFrameInfo_SetDuration() 11574 11575``` 11576void OH_ArkUI_ImageAnimatorFrameInfo_SetDuration (ArkUI_ImageAnimatorFrameInfo * imageInfo, int32_t duration ) 11577``` 11578**Description** 11579 11580Sets the playback duration of an image. 11581 11582**Since**: 12 11583 11584**Parameters** 11585 11586| Name| Description| 11587| -------- | -------- | 11588| imageInfo | Pointer to the frame image object. | 11589| duration | Playback duration of an image, in milliseconds. | 11590 11591 11592### OH_ArkUI_ImageAnimatorFrameInfo_SetHeight() 11593 11594``` 11595void OH_ArkUI_ImageAnimatorFrameInfo_SetHeight (ArkUI_ImageAnimatorFrameInfo * imageInfo, int32_t height ) 11596``` 11597**Description** 11598 11599Sets the image height. 11600 11601**Since**: 12 11602 11603**Parameters** 11604 11605| Name| Description| 11606| -------- | -------- | 11607| imageInfo | Pointer to the frame image object. | 11608| height | Image height, in px. | 11609 11610 11611### OH_ArkUI_ImageAnimatorFrameInfo_SetLeft() 11612 11613``` 11614void OH_ArkUI_ImageAnimatorFrameInfo_SetLeft (ArkUI_ImageAnimatorFrameInfo * imageInfo, int32_t left ) 11615``` 11616**Description** 11617 11618Sets the horizontal coordinate of an image relative to the upper left corner of the component. 11619 11620**Since**: 12 11621 11622**Parameters** 11623 11624| Name| Description| 11625| -------- | -------- | 11626| imageInfo | Pointer to the frame image object. | 11627| left | Horizontal coordinate of the image relative to the upper left corner of the component, in px. | 11628 11629 11630### OH_ArkUI_ImageAnimatorFrameInfo_SetTop() 11631 11632``` 11633void OH_ArkUI_ImageAnimatorFrameInfo_SetTop (ArkUI_ImageAnimatorFrameInfo * imageInfo, int32_t top ) 11634``` 11635**Description** 11636 11637Sets the vertical coordinate of an image relative to the upper left corner of the component. 11638 11639**Since**: 12 11640 11641**Parameters** 11642 11643| Name| Description| 11644| -------- | -------- | 11645| imageInfo | Pointer to the frame image object. | 11646| top | Vertical coordinate of the image relative to the upper left corner of the component, in px. | 11647 11648 11649### OH_ArkUI_ImageAnimatorFrameInfo_SetWidth() 11650 11651``` 11652void OH_ArkUI_ImageAnimatorFrameInfo_SetWidth (ArkUI_ImageAnimatorFrameInfo * imageInfo, int32_t width ) 11653``` 11654**Description** 11655 11656Sets the image width. 11657 11658**Since**: 12 11659 11660**Parameters** 11661 11662| Name| Description| 11663| -------- | -------- | 11664| imageInfo | Pointer to the frame image object. | 11665| width | Image width, in px. | 11666 11667 11668### OH_ArkUI_IsBuiltInGesture() 11669 11670``` 11671bool OH_ArkUI_IsBuiltInGesture (ArkUI_GestureRecognizer * recognizer) 11672``` 11673**Description** 11674 11675Obtains whether a gesture is a built-in gesture. 11676 11677**Since**: 12 11678 11679**Parameters** 11680 11681| Name| Description| 11682| -------- | -------- | 11683| recognizer | Pointer to the gesture recognizer. | 11684 11685**Returns** 11686 11687true: built-in gestures. false: The gesture is not a built-in gesture. 11688 11689 11690### OH_ArkUI_IsGestureRecognizerValid() 11691 11692``` 11693bool OH_ArkUI_IsGestureRecognizerValid (ArkUI_GestureRecognizer * recognizer) 11694``` 11695**Description** 11696 11697Obtains whether a gesture recognizer is valid. 11698 11699**Since**: 12 11700 11701**Parameters** 11702 11703| Name| Description| 11704| -------- | -------- | 11705| recognizer | Pointer to the gesture recognizer. | 11706 11707**Returns** 11708 11709true: The gesture recognizer is valid. Returns **false** if the gesture recognizer is invalid. 11710 11711 11712### OH_ArkUI_KeyEvent_GetKeyCode() 11713 11714``` 11715int32_t OH_ArkUI_KeyEvent_GetKeyCode (const ArkUI_UIInputEvent * event) 11716``` 11717**Description** 11718 11719Obtains the key code from a key event. 11720 11721**Since**: 14 11722 11723**Parameters** 11724 11725| Name| Description| 11726| -------- | -------- | 11727| event | Pointer to an **ArkUI_UIInputEvent** object. | 11728 11729**Returns** 11730 11731Key code. 11732 11733 11734### OH_ArkUI_KeyEvent_GetKeyIntensionCode() 11735 11736``` 11737ArkUI_KeyIntension OH_ArkUI_KeyEvent_GetKeyIntensionCode (const ArkUI_UIInputEvent * event) 11738``` 11739**Description** 11740 11741Obtains the intention code associated with a key event. 11742 11743**Since**: 14 11744 11745**Parameters** 11746 11747| Name| Description| 11748| -------- | -------- | 11749| event | Pointer to an **ArkUI_UIInputEvent** object. | 11750 11751**Returns** 11752 11753Returns the intention code associated with the key event. 11754 11755 11756### OH_ArkUI_KeyEvent_GetKeySource() 11757 11758``` 11759ArkUI_KeySourceType OH_ArkUI_KeyEvent_GetKeySource (const ArkUI_UIInputEvent * event) 11760``` 11761**Description** 11762 11763Obtains the type of input device that triggers a key event. 11764 11765**Since**: 14 11766 11767**Parameters** 11768 11769| Name| Description| 11770| -------- | -------- | 11771| event | Pointer to an **ArkUI_UIInputEvent** object. | 11772 11773**Returns** 11774 11775Returns the device type. 11776 11777 11778### OH_ArkUI_KeyEvent_GetKeyText() 11779 11780``` 11781const char* OH_ArkUI_KeyEvent_GetKeyText (const ArkUI_UIInputEvent * event) 11782``` 11783**Description** 11784 11785Obtains the key value from a key event. 11786 11787**Since**: 14 11788 11789**Parameters** 11790 11791| Name| Description| 11792| -------- | -------- | 11793| event | Pointer to an **ArkUI_UIInputEvent** object. | 11794 11795**Returns** 11796 11797Key value. 11798 11799 11800### OH_ArkUI_KeyEvent_GetType() 11801 11802``` 11803ArkUI_KeyEventType OH_ArkUI_KeyEvent_GetType (const ArkUI_UIInputEvent * event) 11804``` 11805**Description** 11806 11807Obtains the type of a key event. 11808 11809**Since**: 14 11810 11811**Parameters** 11812 11813| Name| Description| 11814| -------- | -------- | 11815| event | Pointer to an **ArkUI_UIInputEvent** object. | 11816 11817**Returns** 11818 11819Returns the key event type. 11820 11821 11822### OH_ArkUI_KeyEvent_GetUnicode() 11823 11824``` 11825uint32_t OH_ArkUI_KeyEvent_GetUnicode (const ArkUI_UIInputEvent * event) 11826``` 11827**Description** 11828 11829Obtains the Unicode value of a key event. Non-space basic Latin characters in the 0x0021-0x007E range are supported. Characters with a value of 0 are not supported. In the case of key combination, this API returns the Unicode value of the key corresponding to the key event. 11830 11831**Since**: 14 11832 11833**Parameters** 11834 11835| Name| Description| 11836| -------- | -------- | 11837| event | Pointer to an **ArkUI_UIInputEvent** object. | 11838 11839**Returns** 11840 11841Returns the Unicode value. 11842 11843 11844### OH_ArkUI_KeyEvent_SetConsumed() 11845 11846``` 11847void OH_ArkUI_KeyEvent_SetConsumed (const ArkUI_UIInputEvent * event, bool isConsumed ) 11848``` 11849**Description** 11850 11851Sets whether a key event is consumed in the key event callback. 11852 11853**Since**: 14 11854 11855**Parameters** 11856 11857| Name| Description| 11858| -------- | -------- | 11859| event | Pointer to an **ArkUI_UIInputEvent** object. | 11860| isConsumed | Whether the event is consumed. | 11861 11862 11863### OH_ArkUI_KeyEvent_StopPropagation() 11864 11865``` 11866void OH_ArkUI_KeyEvent_StopPropagation (const ArkUI_UIInputEvent * event, bool stopPropagation ) 11867``` 11868**Description** 11869 11870Stops the event from bubbling upwards or downwards. 11871 11872**Since**: 14 11873 11874**Parameters** 11875 11876| Name| Description| 11877| -------- | -------- | 11878| event | Pointer to an **ArkUI_UIInputEvent** object. | 11879| stopPropagation | Whether to stop event propagation. | 11880 11881 11882### OH_ArkUI_KeyEvent_Dispatch() 11883 11884``` 11885void OH_ArkUI_KeyEvent_Dispatch(ArkUI_NodeHandle node, const ArkUI_UIInputEvent* event) 11886``` 11887**Description** 11888 11889Dispatches a key event to a specific node. 11890 11891**Since**: 15 11892 11893**Parameters** 11894 11895| Name| Description| 11896| -------- | -------- | 11897| node | Node object for which an event needs to be registered. | 11898| event | Pointer to an **ArkUI_UIInputEvent** object. | 11899 11900### OH_ArkUI_KeyframeAnimateOption_Create() 11901 11902``` 11903ArkUI_KeyframeAnimateOption* OH_ArkUI_KeyframeAnimateOption_Create (int32_t size) 11904``` 11905**Description** 11906 11907Obtains the keyframe animation parameters. 11908 11909**Since**: 12 11910 11911**Parameters** 11912 11913| Name| Description| 11914| -------- | -------- | 11915| size | Number of key frame animation states. | 11916 11917**Returns** 11918 11919Returns the keyframe animation parameter object; returns **NULL** if the value of **size** is less than 0. 11920 11921 11922### OH_ArkUI_KeyframeAnimateOption_Dispose() 11923 11924``` 11925void OH_ArkUI_KeyframeAnimateOption_Dispose (ArkUI_KeyframeAnimateOption * option) 11926``` 11927**Description** 11928 11929Destroys a keyframe animation parameter object. 11930 11931**Since**: 12 11932 11933**Parameters** 11934 11935| Name| Description| 11936| -------- | -------- | 11937| option | Returns the keyframe animation parameter object; | 11938 11939 11940### OH_ArkUI_KeyframeAnimateOption_GetCurve() 11941 11942``` 11943ArkUI_CurveHandle OH_ArkUI_KeyframeAnimateOption_GetCurve (ArkUI_KeyframeAnimateOption * option, int32_t index ) 11944``` 11945**Description** 11946 11947Obtains the animation curve of a specific state in a keyframe animation. 11948 11949**Since**: 12 11950 11951**Parameters** 11952 11953| Name| Description| 11954| -------- | -------- | 11955| option | Keyframe animation parameters. | 11956| index | Status index. | 11957 11958**Returns** 11959 11960Returns the animation curve. 11961 11962 11963### OH_ArkUI_KeyframeAnimateOption_GetDelay() 11964 11965``` 11966int32_t OH_ArkUI_KeyframeAnimateOption_GetDelay (ArkUI_KeyframeAnimateOption * option) 11967``` 11968**Description** 11969 11970Obtains the overall delay of a keyframe animation 11971 11972**Since**: 12 11973 11974**Parameters** 11975 11976| Name| Description| 11977| -------- | -------- | 11978| option | Keyframe animation parameters. | 11979 11980**Returns** 11981 11982Returns the overall delay. 11983 11984 11985### OH_ArkUI_KeyframeAnimateOption_GetDuration() 11986 11987``` 11988int32_t OH_ArkUI_KeyframeAnimateOption_GetDuration (ArkUI_KeyframeAnimateOption * option, int32_t index ) 11989``` 11990**Description** 11991 11992Obtains the duration of a specific state in a keyframe animation. 11993 11994**Since**: 12 11995 11996**Parameters** 11997 11998| Name| Description| 11999| -------- | -------- | 12000| option | Keyframe animation parameters. | 12001| index | Status index. | 12002 12003**Returns** 12004 12005Duration, in milliseconds. 12006 12007 12008### OH_ArkUI_KeyframeAnimateOption_GetIterations() 12009 12010``` 12011int32_t OH_ArkUI_KeyframeAnimateOption_GetIterations (ArkUI_KeyframeAnimateOption * option) 12012``` 12013**Description** 12014 12015Obtains the number of times that a keyframe animation is played. 12016 12017**Since**: 12 12018 12019**Parameters** 12020 12021| Name| Description| 12022| -------- | -------- | 12023| option | Keyframe animation parameters. | 12024 12025**Returns** 12026 12027Returns the number of times that the animation is played. 12028 12029### OH_ArkUI_KeyframeAnimateOption_GetExpectedFrameRate() 12030 12031``` 12032ArkUI_ExpectedFrameRateRange* OH_ArkUI_KeyframeAnimateOption_GetExpectedFrameRate(ArkUI_KeyframeAnimateOption* option) 12033``` 12034**Description** 12035 12036Obtains the expected frame rate from keyframe animation parameters. 12037 12038**Since**: 18 12039 12040**Parameters** 12041 12042| Name| Description| 12043| -------- | -------- | 12044| option | Keyframe animation parameters. | 12045 12046**Returns** 12047 12048Returns the expected frame rate obtained. 12049 12050 12051### OH_ArkUI_KeyframeAnimateOption_RegisterOnEventCallback() 12052 12053``` 12054int32_t OH_ArkUI_KeyframeAnimateOption_RegisterOnEventCallback (ArkUI_KeyframeAnimateOption * option, void * userData, void(*)(void *userData) event, int32_t index ) 12055``` 12056**Description** 12057 12058Sets the closure function of the state at the time of the keyframe, that is, the state to be reached at the time of the keyframe. 12059 12060**Parameters** 12061 12062| Name| Description| 12063| -------- | -------- | 12064| option | Keyframe animation parameters. | 12065| event | Closure function. | 12066| userData | Pointer to a custom object. | 12067| index | Status index. | 12068 12069**Returns** 12070 12071Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12072 12073 12074### OH_ArkUI_KeyframeAnimateOption_RegisterOnFinishCallback() 12075 12076``` 12077int32_t OH_ArkUI_KeyframeAnimateOption_RegisterOnFinishCallback (ArkUI_KeyframeAnimateOption * option, void * userData, void(*)(void *userData) onFinish ) 12078``` 12079**Description** 12080 12081Sets the callback invoked when the keyframe animation playback is complete. This API is called after the keyframe animation has played for the specified number of times. 12082 12083**Parameters** 12084 12085| Name| Description| 12086| -------- | -------- | 12087| option | Keyframe animation parameters. | 12088| userData | Pointer to a custom object. | 12089| onFinish | Callback used to return the result. | 12090 12091**Returns** 12092 12093Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12094 12095 12096### OH_ArkUI_KeyframeAnimateOption_SetCurve() 12097 12098``` 12099int32_t OH_ArkUI_KeyframeAnimateOption_SetCurve (ArkUI_KeyframeAnimateOption * option, ArkUI_CurveHandle value, int32_t index ) 12100``` 12101**Description** 12102 12103Sets the animation curve for a specific keyframe in a keyframe animation. 12104 12105**Parameters** 12106 12107| Name| Description| 12108| -------- | -------- | 12109| option | Keyframe animation parameters. | 12110| value | Animation curve used by the key frame. Default value: **EASE_IN_OUT**. | 12111| index | Status index. | 12112 12113**NOTE** 12114 12115Because the **springMotion**, **responsiveSpringMotion**, and **interpolatingSpring** curves do not have effective duration settings, they are not supported. 12116 12117**Returns** 12118 12119Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12120 12121 12122### OH_ArkUI_KeyframeAnimateOption_SetDelay() 12123 12124``` 12125int32_t OH_ArkUI_KeyframeAnimateOption_SetDelay (ArkUI_KeyframeAnimateOption * option, int32_t value ) 12126``` 12127**Description** 12128 12129Sets the overall delay of a keyframe animation, in milliseconds. By default, the keyframe animation is played without delay. 12130 12131**Parameters** 12132 12133| Name| Description| 12134| -------- | -------- | 12135| option | Keyframe animation parameters. | 12136| value | Delay time, in milliseconds. | 12137 12138**Returns** 12139 12140Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12141 12142 12143### OH_ArkUI_KeyframeAnimateOption_SetDuration() 12144 12145``` 12146int32_t OH_ArkUI_KeyframeAnimateOption_SetDuration (ArkUI_KeyframeAnimateOption * option, int32_t value, int32_t index ) 12147``` 12148**Description** 12149 12150Sets the duration of a keyframe animation, in milliseconds. 12151 12152**Parameters** 12153 12154| Name| Description| 12155| -------- | -------- | 12156| option | Keyframe animation parameters. | 12157| value | Duration, in milliseconds. | 12158| index | Status index. | 12159 12160**Returns** 12161 12162Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12163 12164 12165### OH_ArkUI_KeyframeAnimateOption_SetIterations() 12166 12167``` 12168int32_t OH_ArkUI_KeyframeAnimateOption_SetIterations (ArkUI_KeyframeAnimateOption * option, int32_t value ) 12169``` 12170**Description** 12171 12172Sets the number of times that the keyframe animation is played. By default, the animation is played once. The value **-1** indicates that the animation is played for an unlimited number of times. The value **0** indicates that there is no animation. 12173 12174**Parameters** 12175 12176| Name| Description| 12177| -------- | -------- | 12178| option | Keyframe animation parameters. | 12179| value | Number of times that the animation is played. | 12180 12181**Returns** 12182 12183Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12184 12185### OH_ArkUI_KeyframeAnimateOption_SetExpectedFrameRate() 12186 12187``` 12188int32_t OH_ArkUI_KeyframeAnimateOption_SetExpectedFrameRate( 12189 ArkUI_KeyframeAnimateOption* option, ArkUI_ExpectedFrameRateRange* frameRate) 12190``` 12191**Description** 12192 12193Sets the expected frame rate for a keyframe animation. 12194 12195**Since**: 18 12196 12197**Parameters** 12198 12199| Name| Description| 12200| -------- | -------- | 12201| option | Keyframe animation parameters. | 12202| frameRate | Expected frame rate to set. | 12203 12204**Returns** 12205 12206Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 12207Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12208 12209 12210### OH_ArkUI_LayoutConstraint_Copy() 12211 12212``` 12213ArkUI_LayoutConstraint* OH_ArkUI_LayoutConstraint_Copy (const ArkUI_LayoutConstraint * Constraint) 12214``` 12215**Description** 12216 12217Constraint size deep copy. 12218 12219**Since**: 12 12220 12221**Parameters** 12222 12223| Name| Description| 12224| -------- | -------- | 12225| Constraint | Size constraint. | 12226 12227**Returns** 12228 12229Pointer to the new constraint size. 12230 12231 12232### OH_ArkUI_LayoutConstraint_Create() 12233 12234``` 12235ArkUI_LayoutConstraint* OH_ArkUI_LayoutConstraint_Create () 12236``` 12237**Description** 12238 12239Create a constraint size. 12240 12241**Since**: 12 12242 12243 12244### OH_ArkUI_LayoutConstraint_Dispose() 12245 12246``` 12247void* OH_ArkUI_LayoutConstraint_Dispose (ArkUI_LayoutConstraint * Constraint) 12248``` 12249**Description** 12250 12251Pointer to the size of the destruction constraint. 12252 12253**Since**: 12 12254 12255**Parameters** 12256 12257| Name| Description| 12258| -------- | -------- | 12259| Constraint | Size constraint. | 12260 12261 12262### OH_ArkUI_LayoutConstraint_GetMaxHeight() 12263 12264``` 12265int32_t OH_ArkUI_LayoutConstraint_GetMaxHeight (const ArkUI_LayoutConstraint * Constraint) 12266``` 12267**Description** 12268 12269Obtains the maximum height for a size constraint, in px. 12270 12271**Since**: 12 12272 12273**Parameters** 12274 12275| Name| Description| 12276| -------- | -------- | 12277| Constraint | Size constraint. | 12278 12279**Returns** 12280 12281Maximum height. 12282 12283 12284### OH_ArkUI_LayoutConstraint_GetMaxWidth() 12285 12286``` 12287int32_t OH_ArkUI_LayoutConstraint_GetMaxWidth (const ArkUI_LayoutConstraint * Constraint) 12288``` 12289**Description** 12290 12291Obtains the maximum width for a size constraint, in px. 12292 12293**Since**: 12 12294 12295**Parameters** 12296 12297| Name| Description| 12298| -------- | -------- | 12299| Constraint | Size constraint. | 12300 12301**Returns** 12302 12303Maximum width. 12304 12305 12306### OH_ArkUI_LayoutConstraint_GetMinHeight() 12307 12308``` 12309int32_t OH_ArkUI_LayoutConstraint_GetMinHeight (const ArkUI_LayoutConstraint * Constraint) 12310``` 12311**Description** 12312 12313Obtains the minimum height for a size constraint, in px. 12314 12315**Since**: 12 12316 12317**Parameters** 12318 12319| Name| Description| 12320| -------- | -------- | 12321| Constraint | Size constraint. | 12322 12323**Returns** 12324 12325Minimum Height 12326 12327 12328### OH_ArkUI_LayoutConstraint_GetMinWidth() 12329 12330``` 12331int32_t OH_ArkUI_LayoutConstraint_GetMinWidth (const ArkUI_LayoutConstraint * Constraint) 12332``` 12333**Description** 12334 12335Obtains the minimum width for a size constraint, in px. 12336 12337**Since**: 12 12338 12339**Parameters** 12340 12341| Name| Description| 12342| -------- | -------- | 12343| Constraint | Size constraint. | 12344 12345**Returns** 12346 12347Minimum Width 12348 12349 12350### OH_ArkUI_LayoutConstraint_GetPercentReferenceHeight() 12351 12352``` 12353int32_t OH_ArkUI_LayoutConstraint_GetPercentReferenceHeight (const ArkUI_LayoutConstraint * Constraint) 12354``` 12355**Description** 12356 12357Obtains the height percentage reference for a size constraint, in px. 12358 12359**Since**: 12 12360 12361**Parameters** 12362 12363| Name| Description| 12364| -------- | -------- | 12365| Constraint | Size constraint. | 12366 12367**Returns** 12368 12369Height percentage benchmark. 12370 12371 12372### OH_ArkUI_LayoutConstraint_GetPercentReferenceWidth() 12373 12374``` 12375int32_t OH_ArkUI_LayoutConstraint_GetPercentReferenceWidth (const ArkUI_LayoutConstraint * Constraint) 12376``` 12377**Description** 12378 12379Obtains the width percentage reference for a size constraint, in px. 12380 12381**Since**: 12 12382 12383**Parameters** 12384 12385| Name| Description| 12386| -------- | -------- | 12387| Constraint | Size constraint. | 12388 12389**Returns** 12390 12391Width percentage reference. 12392 12393 12394### OH_ArkUI_LayoutConstraint_SetMaxHeight() 12395 12396``` 12397void OH_ArkUI_LayoutConstraint_SetMaxHeight (ArkUI_LayoutConstraint * Constraint, int32_t value ) 12398``` 12399**Description** 12400 12401Sets the maximum height. 12402 12403**Since**: 12 12404 12405**Parameters** 12406 12407| Name| Description| 12408| -------- | -------- | 12409| Constraint | Size constraint. | 12410| value | Maximum height, in pixels. | 12411 12412 12413### OH_ArkUI_LayoutConstraint_SetMaxWidth() 12414 12415``` 12416void OH_ArkUI_LayoutConstraint_SetMaxWidth (ArkUI_LayoutConstraint * Constraint, int32_t value ) 12417``` 12418**Description** 12419 12420Sets the maximum width. 12421 12422**Since**: 12 12423 12424**Parameters** 12425 12426| Name| Description| 12427| -------- | -------- | 12428| Constraint | Size constraint. | 12429| value | Maximum width, in pixels. | 12430 12431 12432### OH_ArkUI_LayoutConstraint_SetMinHeight() 12433 12434``` 12435void OH_ArkUI_LayoutConstraint_SetMinHeight (ArkUI_LayoutConstraint * Constraint, int32_t value ) 12436``` 12437**Description** 12438 12439Sets the minimum height. 12440 12441**Since**: 12 12442 12443**Parameters** 12444 12445| Name| Description| 12446| -------- | -------- | 12447| Constraint | Size constraint. | 12448| value | Minimum height, in pixels. | 12449 12450 12451### OH_ArkUI_LayoutConstraint_SetMinWidth() 12452 12453``` 12454void OH_ArkUI_LayoutConstraint_SetMinWidth (ArkUI_LayoutConstraint * Constraint, int32_t value ) 12455``` 12456**Description** 12457 12458Sets the minimum width. 12459 12460**Since**: 12 12461 12462**Parameters** 12463 12464| Name| Description| 12465| -------- | -------- | 12466| Constraint | Size constraint. | 12467| value | Minimum width, in pixels. | 12468 12469 12470### OH_ArkUI_LayoutConstraint_SetPercentReferenceHeight() 12471 12472``` 12473void OH_ArkUI_LayoutConstraint_SetPercentReferenceHeight (ArkUI_LayoutConstraint * Constraint, int32_t value ) 12474``` 12475**Description** 12476 12477Sets the height percentage reference. 12478 12479**Since**: 12 12480 12481**Parameters** 12482 12483| Name| Description| 12484| -------- | -------- | 12485| Constraint | Size constraint. | 12486| value | Height percentage base, in px. | 12487 12488 12489### OH_ArkUI_LayoutConstraint_SetPercentReferenceWidth() 12490 12491``` 12492void OH_ArkUI_LayoutConstraint_SetPercentReferenceWidth (ArkUI_LayoutConstraint * Constraint, int32_t value ) 12493``` 12494**Description** 12495 12496Sets the width percentage reference. 12497 12498**Since**: 12 12499 12500**Parameters** 12501 12502| Name| Description| 12503| -------- | -------- | 12504| Constraint | Size constraint. | 12505| value | Width percentage benchmark, in px. | 12506 12507 12508### OH_ArkUI_List_CloseAllSwipeActions() 12509 12510``` 12511int32_t OH_ArkUI_List_CloseAllSwipeActions (ArkUI_NodeHandle node, void * userData, void(*)(void *userData) onFinish ) 12512``` 12513**Description** 12514 12515Collapse the expanded ListItem. 12516 12517**Since**: 12 12518 12519**Parameters** 12520 12521| Name| Description| 12522| -------- | -------- | 12523| node | Node object for which an event needs to be registered. | 12524| userData | Custom event parameter, which is passed in the callback when the event is triggered. | 12525| onFinish | Callback triggered after the collapse animation is complete. | 12526 12527**Returns** 12528 12529Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. Returns **ARKUI_ERROR_CODE_ATTRIBUTE_OR_EVENT_NOT_SUPPORTED** if the event is not supported. 12530 12531 12532### OH_ArkUI_ListChildrenMainSizeOption_Create() 12533 12534``` 12535ArkUI_ListChildrenMainSize* OH_ArkUI_ListChildrenMainSizeOption_Create () 12536``` 12537**Description** 12538 12539Creates a **ListChildrenMainSize** instance. 12540 12541**Since**: 12 12542 12543**Returns** 12544 12545Returns the created **ListChildrenMainSize** instance. 12546 12547### OH_ArkUI_ListChildrenMainSizeOption_Dispose() 12548 12549``` 12550void OH_ArkUI_ListChildrenMainSizeOption_Dispose (ArkUI_ListChildrenMainSize * option) 12551``` 12552**Description** 12553 12554Destroys a ListChildrenMainSize instance. 12555 12556**Since**: 12 12557 12558**Parameters** 12559 12560| Name| Description| 12561| -------- | -------- | 12562| option | ListChildrenMainSize instance to be destroyed. | 12563 12564 12565### OH_ArkUI_ListChildrenMainSizeOption_GetDefaultMainSize() 12566 12567``` 12568float OH_ArkUI_ListChildrenMainSizeOption_GetDefaultMainSize (ArkUI_ListChildrenMainSize * option) 12569``` 12570**Description** 12571 12572Obtains the default size in a **ListChildrenMainSize** instance. 12573 12574**Since**: 12 12575 12576**Parameters** 12577 12578| Name| Description| 12579| -------- | -------- | 12580| option | **ListChildrenMainSize** instance. | 12581 12582**Returns** 12583 12584Returns the default size, in vp. The default value is **0**. If **option** is a null pointer, **-1** is returned. 12585 12586 12587### OH_ArkUI_ListChildrenMainSizeOption_GetMainSize() 12588 12589``` 12590float OH_ArkUI_ListChildrenMainSizeOption_GetMainSize (ArkUI_ListChildrenMainSize * option, int32_t index ) 12591``` 12592**Description** 12593 12594Obtains the value of the **ChildrenMainSizeOption** array of the **List** component. 12595 12596**Since**: 12 12597 12598**Parameters** 12599 12600| Name| Description| 12601| -------- | -------- | 12602| option | **ListChildrenMainSize** instance. | 12603| index | Subscript position of the value to be obtained. | 12604 12605**Returns** 12606 12607Value of the specific position of the array. If a parameter error occurs, **-1** is returned. 12608 12609 12610### OH_ArkUI_ListChildrenMainSizeOption_Resize() 12611 12612``` 12613void OH_ArkUI_ListChildrenMainSizeOption_Resize (ArkUI_ListChildrenMainSize * option, int32_t totalSize ) 12614``` 12615**Description** 12616 12617Resets the array size of ChildrenMainSizeOption of the List component. 12618 12619**Since**: 12 12620 12621**Parameters** 12622 12623| Name| Description| 12624| -------- | -------- | 12625| option | **ListChildrenMainSize** instance. | 12626| totalSize | Array size. | 12627 12628 12629### OH_ArkUI_ListChildrenMainSizeOption_SetDefaultMainSize() 12630 12631``` 12632int32_t OH_ArkUI_ListChildrenMainSizeOption_SetDefaultMainSize (ArkUI_ListChildrenMainSize * option, float defaultMainSize ) 12633``` 12634**Description** 12635 12636Sets the default size in a **ListChildrenMainSize** instance. 12637 12638**Since**: 12 12639 12640**Parameters** 12641 12642| Name| Description| 12643| -------- | -------- | 12644| option | **ListChildrenMainSize** instance. | 12645| defaultMainSize | Default size of a list item in a list. The unit is vp. | 12646 12647**Returns** 12648 12649Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12650 12651 12652### OH_ArkUI_ListChildrenMainSizeOption_Splice() 12653 12654``` 12655int32_t OH_ArkUI_ListChildrenMainSizeOption_Splice (ArkUI_ListChildrenMainSize * option, int32_t index, int32_t deleteCount, int32_t addCount ) 12656``` 12657**Description** 12658 12659The size of the ChildrenMainSizeOption array of the List component is adjusted. 12660 12661**Since**: 12 12662 12663**Parameters** 12664 12665| Name| Description| 12666| -------- | -------- | 12667| option | **ListChildrenMainSize** instance. | 12668| index | Start position of the array whose MainSize is to be modified. | 12669| deleteCount | Number of MainSize arrays to be deleted starting from index. | 12670| addCount | Number of MainSize arrays to be added starting from index. | 12671 12672**Returns** 12673 12674Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12675 12676 12677### OH_ArkUI_ListChildrenMainSizeOption_UpdateSize() 12678 12679``` 12680int32_t OH_ArkUI_ListChildrenMainSizeOption_UpdateSize (ArkUI_ListChildrenMainSize * option, int32_t index, float mainSize ) 12681``` 12682**Description** 12683 12684Updates the values in a **ChildrenMainSizeOption** array of a **List** component. 12685 12686**Since**: 12 12687 12688**Parameters** 12689 12690| Name| Description| 12691| -------- | -------- | 12692| option | **ListChildrenMainSize** instance. | 12693| index | Index at which to start changing the values in the array. | 12694| mainSize | New size value to set at the specified index. | 12695 12696**Returns** 12697 12698Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12699 12700 12701### OH_ArkUI_ListItemSwipeActionItem_Create() 12702 12703``` 12704ArkUI_ListItemSwipeActionItem* OH_ArkUI_ListItemSwipeActionItem_Create () 12705``` 12706**Description** 12707 12708Creates a **ListItemSwipeActionItem** instance. 12709 12710**Since**: 12 12711 12712**Returns** 12713 12714Returns the created **ListItemSwipeActionItem** instance. 12715 12716 12717### OH_ArkUI_ListItemSwipeActionItem_Dispose() 12718 12719``` 12720void OH_ArkUI_ListItemSwipeActionItem_Dispose (ArkUI_ListItemSwipeActionItem * item) 12721``` 12722**Description** 12723 12724Disposes of a **ListItemSwipeActionItem** instance. 12725 12726**Since**: 12 12727 12728**Parameters** 12729 12730| Name| Description| 12731| -------- | -------- | 12732| item | **ListItemSwipeActionItem** instance to dispose of. | 12733 12734 12735### OH_ArkUI_ListItemSwipeActionItem_GetActionAreaDistance() 12736 12737``` 12738float OH_ArkUI_ListItemSwipeActionItem_GetActionAreaDistance (ArkUI_ListItemSwipeActionItem * item) 12739``` 12740**Description** 12741 12742Obtains the swipe distance threshold for deleting the list item. 12743 12744**Since**: 12 12745 12746**Parameters** 12747 12748| Name| Description| 12749| -------- | -------- | 12750| item | Target **ListItemSwipeActionItem** instance. | 12751 12752**Returns** 12753 12754Returns the swipe distance threshold for deleting the list item. Return **0** if an error occurs. 12755 12756 12757### OH_ArkUI_ListItemSwipeActionItem_SetActionAreaDistance() 12758 12759``` 12760void OH_ArkUI_ListItemSwipeActionItem_SetActionAreaDistance (ArkUI_ListItemSwipeActionItem * item, float distance ) 12761``` 12762**Description** 12763 12764Swipe distance threshold for deleting the list item. 12765 12766**Since**: 12 12767 12768**Parameters** 12769 12770| Name| Description| 12771| -------- | -------- | 12772| item | Target **ListItemSwipeActionItem** instance. | 12773| distance | Returns the swipe distance threshold for deleting the list item. | 12774 12775 12776### OH_ArkUI_ListItemSwipeActionItem_SetContent() 12777 12778``` 12779void OH_ArkUI_ListItemSwipeActionItem_SetContent (ArkUI_ListItemSwipeActionItem * item, ArkUI_NodeHandle node ) 12780``` 12781**Description** 12782 12783Sets the layout content of ListItemSwipeActionItem. 12784 12785**Since**: 12 12786 12787**Parameters** 12788 12789| Name| Description| 12790| -------- | -------- | 12791| item | Target **ListItemSwipeActionItem** instance. | 12792| node | Layout information | 12793 12794 12795### OH_ArkUI_ListItemSwipeActionItem_SetOnAction() 12796 12797``` 12798void OH_ArkUI_ListItemSwipeActionItem_SetOnAction (ArkUI_ListItemSwipeActionItem * item, void(*)() callback ) 12799``` 12800**Description** 12801 12802Sets the callback invoked when the list item is deleted while in the delete area. 12803 12804**Since**: 12 12805 12806**Parameters** 12807 12808| Name| Description| 12809| -------- | -------- | 12810| item | Target **ListItemSwipeActionItem** instance. | 12811| callback | Callback to invoke when an event of the specified type occurs. | 12812 12813 12814### OH_ArkUI_ListItemSwipeActionItem_SetOnActionWithUserData() 12815 12816``` 12817void OH_ArkUI_ListItemSwipeActionItem_SetOnActionWithUserData (ArkUI_ListItemSwipeActionItem * item, void * userData, void(*)(void *userData) callback ) 12818``` 12819**Description** 12820 12821Sets the callback invoked when the list item is deleted while in the delete area. 12822 12823**Since**: 12 12824 12825**Parameters** 12826 12827| Name| Description| 12828| -------- | -------- | 12829| item | Target **ListItemSwipeActionItem** instance. | 12830| userData | Custom data. | 12831| callback | Callback to invoke when an event of the specified type occurs. | 12832 12833 12834### OH_ArkUI_ListItemSwipeActionItem_SetOnEnterActionArea() 12835 12836``` 12837void OH_ArkUI_ListItemSwipeActionItem_SetOnEnterActionArea (ArkUI_ListItemSwipeActionItem * item, void(*)() callback ) 12838``` 12839**Description** 12840 12841Sets the callback invoked each time the list item enters the delete area. 12842 12843**Since**: 12 12844 12845**Parameters** 12846 12847| Name| Description| 12848| -------- | -------- | 12849| item | Target **ListItemSwipeActionItem** instance. | 12850| callback | Callback to invoke when an event of the specified type occurs. | 12851 12852 12853### OH_ArkUI_ListItemSwipeActionItem_SetOnEnterActionAreaWithUserData() 12854 12855``` 12856void OH_ArkUI_ListItemSwipeActionItem_SetOnEnterActionAreaWithUserData (ArkUI_ListItemSwipeActionItem * item, void * userData, void(*)(void *userData) callback ) 12857``` 12858**Description** 12859 12860Sets the callback invoked each time the list item enters the delete area. 12861 12862**Since**: 12 12863 12864**Parameters** 12865 12866| Name| Description| 12867| -------- | -------- | 12868| item | Target **ListItemSwipeActionItem** instance. | 12869| userData | Custom data. | 12870| callback | Callback to invoke when an event of the specified type occurs. | 12871 12872 12873### OH_ArkUI_ListItemSwipeActionItem_SetOnExitActionArea() 12874 12875``` 12876void OH_ArkUI_ListItemSwipeActionItem_SetOnExitActionArea (ArkUI_ListItemSwipeActionItem * item, void(*)() callback ) 12877``` 12878**Description** 12879 12880Sets the callback invoked each time the list item exits the delete area. 12881 12882**Since**: 12 12883 12884**Parameters** 12885 12886| Name| Description| 12887| -------- | -------- | 12888| item | Target **ListItemSwipeActionItem** instance. | 12889| callback | Callback to invoke when an event of the specified type occurs. | 12890 12891 12892### OH_ArkUI_ListItemSwipeActionItem_SetOnExitActionAreaWithUserData() 12893 12894``` 12895void OH_ArkUI_ListItemSwipeActionItem_SetOnExitActionAreaWithUserData (ArkUI_ListItemSwipeActionItem * item, void * userData, void(*)(void *userData) callback ) 12896``` 12897**Description** 12898 12899Sets the callback invoked each time the list item exits the delete area. 12900 12901**Since**: 12 12902 12903**Parameters** 12904 12905| Name| Description| 12906| -------- | -------- | 12907| item | Target **ListItemSwipeActionItem** instance. | 12908| userData | Custom data. | 12909| callback | Callback to invoke when an event of the specified type occurs. | 12910 12911 12912### OH_ArkUI_ListItemSwipeActionItem_SetOnStateChange() 12913 12914``` 12915void OH_ArkUI_ListItemSwipeActionItem_SetOnStateChange (ArkUI_ListItemSwipeActionItem * item, void(*)(ArkUI_ListItemSwipeActionState swipeActionState) callback ) 12916``` 12917**Description** 12918 12919Sets the callback invoked when the swipe state of the list item changes. 12920 12921**Since**: 12 12922 12923**Parameters** 12924 12925| Name| Description| 12926| -------- | -------- | 12927| item | Target **ListItemSwipeActionItem** instance. | 12928| callback | Status after the callback event swipeActionState changes. | 12929 12930 12931### OH_ArkUI_ListItemSwipeActionItem_SetOnStateChangeWithUserData() 12932 12933``` 12934void OH_ArkUI_ListItemSwipeActionItem_SetOnStateChangeWithUserData (ArkUI_ListItemSwipeActionItem * item, void * userData, void(*)(ArkUI_ListItemSwipeActionState swipeActionState, void *userData) callback ) 12935``` 12936**Description** 12937 12938Sets the callback invoked when the swipe state of the list item changes. 12939 12940**Since**: 12 12941 12942**Parameters** 12943 12944| Name| Description| 12945| -------- | -------- | 12946| item | Target **ListItemSwipeActionItem** instance. | 12947| userData | Custom data. | 12948| callback | Status after the callback event swipeActionState changes. | 12949 12950 12951### OH_ArkUI_ListItemSwipeActionOption_Create() 12952 12953``` 12954ArkUI_ListItemSwipeActionOption* OH_ArkUI_ListItemSwipeActionOption_Create () 12955``` 12956**Description** 12957 12958Creates a **ListItemSwipeActionOption** instance. 12959 12960**Since**: 12 12961 12962**Returns** 12963 12964ListItemSwipeActionOption configuration item instance. 12965 12966 12967### OH_ArkUI_ListItemSwipeActionOption_Dispose() 12968 12969``` 12970void OH_ArkUI_ListItemSwipeActionOption_Dispose (ArkUI_ListItemSwipeActionOption * option) 12971``` 12972**Description** 12973 12974Destroys a ListItemSwipeActionOption instance. 12975 12976**Since**: 12 12977 12978**Parameters** 12979 12980| Name| Description| 12981| -------- | -------- | 12982| option | ListItemSwipeActionOption instance to destroy. | 12983 12984 12985### OH_ArkUI_ListItemSwipeActionOption_GetEdgeEffect() 12986 12987``` 12988int32_t OH_ArkUI_ListItemSwipeActionOption_GetEdgeEffect (ArkUI_ListItemSwipeActionOption * option) 12989``` 12990**Description** 12991 12992Obtains the sliding effect. 12993 12994**Since**: 12 12995 12996**Parameters** 12997 12998| Name| Description| 12999| -------- | -------- | 13000| option | Target **ListItemSwipeActionItem** instance. | 13001 13002**Returns** 13003 13004Scroll effect. The default return value is **ARKUI_LIST_ITEM_SWIPE_EDGE_EFFECT_SPRING**. 13005 13006 13007### OH_ArkUI_ListItemSwipeActionOption_SetEdgeEffect() 13008 13009``` 13010void OH_ArkUI_ListItemSwipeActionOption_SetEdgeEffect (ArkUI_ListItemSwipeActionOption * option, ArkUI_ListItemSwipeEdgeEffect edgeEffect ) 13011``` 13012**Description** 13013 13014Sets the sliding effect. 13015 13016**Since**: 12 13017 13018**Parameters** 13019 13020| Name| Description| 13021| -------- | -------- | 13022| option | Target **ListItemSwipeActionItem** instance. | 13023| edgeEffect | Scroll effect. | 13024 13025 13026### OH_ArkUI_ListItemSwipeActionOption_SetEnd() 13027 13028``` 13029void OH_ArkUI_ListItemSwipeActionOption_SetEnd (ArkUI_ListItemSwipeActionOption * option, ArkUI_ListItemSwipeActionItem * item ) 13030``` 13031**Description** 13032 13033Sets the layout content for the right edge (for a vertical layout) or bottom edge (for a horizontal layout) of a **ListItemSwipeActionItem** instance. 13034 13035**Since**: 12 13036 13037**Parameters** 13038 13039| Name| Description| 13040| -------- | -------- | 13041| option | Target **ListItemSwipeActionItem** instance. | 13042| builder | Layout information | 13043 13044 13045### OH_ArkUI_ListItemSwipeActionOption_SetOnOffsetChange() 13046 13047``` 13048void OH_ArkUI_ListItemSwipeActionOption_SetOnOffsetChange (ArkUI_ListItemSwipeActionOption * option, void(*)(float offset) callback ) 13049``` 13050**Description** 13051 13052Sets the callback invoked when the scroll offset changes. 13053 13054**Since**: 12 13055 13056**Parameters** 13057 13058| Name| Description| 13059| -------- | -------- | 13060| option | Target **ListItemSwipeActionItem** instance. | 13061| callback | Sliding offset of the callback event offset. | 13062 13063 13064### OH_ArkUI_ListItemSwipeActionOption_SetOnOffsetChangeWithUserData() 13065 13066``` 13067void OH_ArkUI_ListItemSwipeActionOption_SetOnOffsetChangeWithUserData (ArkUI_ListItemSwipeActionOption * option, void * userData, void(*)(float offset, void *userData) callback ) 13068``` 13069**Description** 13070 13071Sets the callback invoked when the scroll offset changes. 13072 13073**Since**: 12 13074 13075**Parameters** 13076 13077| Name| Description| 13078| -------- | -------- | 13079| option | Target **ListItemSwipeActionItem** instance. | 13080| userData | Custom data. | 13081| callback | Sliding offset of the callback event offset. | 13082 13083 13084### OH_ArkUI_ListItemSwipeActionOption_SetStart() 13085 13086``` 13087void OH_ArkUI_ListItemSwipeActionOption_SetStart (ArkUI_ListItemSwipeActionOption * option, ArkUI_ListItemSwipeActionItem * item ) 13088``` 13089**Description** 13090 13091Sets the layout content for the left edge (for a vertical layout) or top edge (for a horizontal layout) of a **ListItemSwipeActionItem** instance. 13092 13093**Since**: 12 13094 13095**Parameters** 13096 13097| Name| Description| 13098| -------- | -------- | 13099| option | Target **ListItemSwipeActionItem** instance. | 13100| builder | Layout information | 13101 13102 13103### OH_ArkUI_LongPress_GetRepeatCount() 13104 13105``` 13106int32_t OH_ArkUI_LongPress_GetRepeatCount (const ArkUI_GestureEvent * event) 13107``` 13108**Description** 13109 13110Obtains the number of times that a long press gesture is triggered periodically. 13111 13112**Since**: 12 13113 13114**Parameters** 13115 13116| Name| Description| 13117| -------- | -------- | 13118| event | Gesture event. | 13119 13120**Returns** 13121 13122Returns the number of times that the long press gesture is triggered periodically. 13123 13124 13125### OH_ArkUI_MarshallStyledStringDescriptor() 13126 13127``` 13128int32_t OH_ArkUI_MarshallStyledStringDescriptor (uint8_t * buffer, size_t bufferSize, ArkUI_StyledString_Descriptor * descriptor ) 13129``` 13130**Description** 13131 13132Serializes the styled string information into a byte array. 13133 13134**Since**: 14 13135 13136**Parameters** 13137 13138| Name| Description| 13139| -------- | -------- | 13140| buffer | Byte array where the serialized data will be stored. | 13141| bufferSize | Length of the byte array. | 13142| descriptor | Pointer to an **ArkUI_StyledString_Descriptor** object. | 13143 13144**Returns** 13145 13146Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. Returns **ARKUI_ERROR_CODE_INVALID_STYLED_STRING** if the styled string is invalid. 13147 13148 13149### OH_ArkUI_NodeAdapter_Create() 13150 13151``` 13152ArkUI_NodeAdapterHandle OH_ArkUI_NodeAdapter_Create () 13153``` 13154**Description** 13155 13156Creates a component adapter. 13157 13158**Since**: 12 13159 13160 13161### OH_ArkUI_NodeAdapter_Dispose() 13162 13163``` 13164void OH_ArkUI_NodeAdapter_Dispose (ArkUI_NodeAdapterHandle handle) 13165``` 13166**Description** 13167 13168Destroys a component adapter. 13169 13170**Since**: 12 13171 13172**Parameters** 13173 13174| Name| Description| 13175| -------- | -------- | 13176| handle | Component adapter object. | 13177 13178 13179### OH_ArkUI_NodeAdapter_GetAllItems() 13180 13181``` 13182int32_t OH_ArkUI_NodeAdapter_GetAllItems (ArkUI_NodeAdapterHandle handle, ArkUI_NodeHandle ** items, uint32_t * size ) 13183``` 13184**Description** 13185 13186Obtains all elements stored in the specified adapter. 13187 13188When the API is called, the array object pointer of the element is returned. The memory data pointed by the pointer needs to be manually released by developers. 13189 13190**Since**: 12 13191 13192**Parameters** 13193 13194| Name| Description| 13195| -------- | -------- | 13196| handle | Component adapter object. | 13197| items | Array of nodes in the adapter. | 13198| size | Number of elements. | 13199 13200**Returns** 13201 13202Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13203 13204 13205### OH_ArkUI_NodeAdapter_GetTotalNodeCount() 13206 13207``` 13208uint32_t OH_ArkUI_NodeAdapter_GetTotalNodeCount (ArkUI_NodeAdapterHandle handle) 13209``` 13210**Description** 13211 13212Obtains the total number of elements in the Adapter. 13213 13214**Since**: 12 13215 13216**Parameters** 13217 13218| Name| Description| 13219| -------- | -------- | 13220| handle | Component adapter object. | 13221 13222**Returns** 13223 13224Total number of elements in the Adapter. 13225 13226 13227### OH_ArkUI_NodeAdapter_InsertItem() 13228 13229``` 13230int32_t OH_ArkUI_NodeAdapter_InsertItem (ArkUI_NodeAdapterHandle handle, uint32_t startPosition, uint32_t itemCount ) 13231``` 13232**Description** 13233 13234Instructs the specified adapter to insert certain elements. 13235 13236**Since**: 12 13237 13238**Parameters** 13239 13240| Name| Description| 13241| -------- | -------- | 13242| handle | Component adapter object. | 13243| startPosition | Start position for inserting an element. | 13244| itemCount | Number of inserted elements. | 13245 13246**Returns** 13247 13248Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13249 13250 13251### OH_ArkUI_NodeAdapter_MoveItem() 13252 13253``` 13254int32_t OH_ArkUI_NodeAdapter_MoveItem (ArkUI_NodeAdapterHandle handle, uint32_t from, uint32_t to ) 13255``` 13256**Description** 13257 13258Instructs the specified adapter to move certain elements. 13259 13260**Since**: 12 13261 13262**Parameters** 13263 13264| Name| Description| 13265| -------- | -------- | 13266| handle | Component adapter object. | 13267| from | Start position of the element shift. | 13268| to | End position of the element shift. | 13269 13270**Returns** 13271 13272Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13273 13274 13275### OH_ArkUI_NodeAdapter_RegisterEventReceiver() 13276 13277``` 13278int32_t OH_ArkUI_NodeAdapter_RegisterEventReceiver (ArkUI_NodeAdapterHandle handle, void * userData, void(*)(ArkUI_NodeAdapterEvent *event) receiver ) 13279``` 13280**Description** 13281 13282Registers callback events related to the Adapter. 13283 13284**Since**: 12 13285 13286**Parameters** 13287 13288| Name| Description| 13289| -------- | -------- | 13290| handle | Component adapter object. | 13291| userData | Custom data. | 13292| receiver | Event receiving callback. | 13293 13294**Returns** 13295 13296Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13297 13298 13299### OH_ArkUI_NodeAdapter_ReloadAllItems() 13300 13301``` 13302int32_t OH_ArkUI_NodeAdapter_ReloadAllItems (ArkUI_NodeAdapterHandle handle) 13303``` 13304**Description** 13305 13306Instructs the specified adapter to reload all elements. 13307 13308**Since**: 12 13309 13310**Parameters** 13311 13312| Name| Description| 13313| -------- | -------- | 13314| handle | Component adapter object. | 13315 13316**Returns** 13317 13318Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13319 13320 13321### OH_ArkUI_NodeAdapter_ReloadItem() 13322 13323``` 13324int32_t OH_ArkUI_NodeAdapter_ReloadItem (ArkUI_NodeAdapterHandle handle, uint32_t startPosition, uint32_t itemCount ) 13325``` 13326**Description** 13327 13328Instructs the specified adapter to reload certain elements. 13329 13330**Since**: 12 13331 13332**Parameters** 13333 13334| Name| Description| 13335| -------- | -------- | 13336| handle | Component adapter object. | 13337| startPosition | Start position of an element change. | 13338| itemCount | Number of changed elements. | 13339 13340**Returns** 13341 13342Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13343 13344 13345### OH_ArkUI_NodeAdapter_RemoveItem() 13346 13347``` 13348int32_t OH_ArkUI_NodeAdapter_RemoveItem (ArkUI_NodeAdapterHandle handle, uint32_t startPosition, uint32_t itemCount ) 13349``` 13350**Description** 13351 13352Instructs the specified adapter to remove certain elements. 13353 13354**Since**: 12 13355 13356**Parameters** 13357 13358| Name| Description| 13359| -------- | -------- | 13360| handle | Component adapter object. | 13361| startPosition | Start position for deleting an element. | 13362| itemCount | Number of deleted elements. | 13363 13364**Returns** 13365 13366Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13367 13368 13369### OH_ArkUI_NodeAdapter_SetTotalNodeCount() 13370 13371``` 13372int32_t OH_ArkUI_NodeAdapter_SetTotalNodeCount (ArkUI_NodeAdapterHandle handle, uint32_t size ) 13373``` 13374**Description** 13375 13376Sets the total number of elements in the specified adapter. 13377 13378**Since**: 12 13379 13380**Parameters** 13381 13382| Name| Description| 13383| -------- | -------- | 13384| handle | Component adapter object. | 13385| size | Number of elements. | 13386 13387**Returns** 13388 13389Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13390 13391 13392### OH_ArkUI_NodeAdapter_UnregisterEventReceiver() 13393 13394``` 13395void OH_ArkUI_NodeAdapter_UnregisterEventReceiver (ArkUI_NodeAdapterHandle handle) 13396``` 13397**Description** 13398 13399Deregisters Adapter-related callback events. 13400 13401**Since**: 12 13402 13403**Parameters** 13404 13405| Name| Description| 13406| -------- | -------- | 13407| handle | Component adapter object. | 13408 13409 13410### OH_ArkUI_NodeAdapterEvent_GetHostNode() 13411 13412``` 13413ArkUI_NodeHandle OH_ArkUI_NodeAdapterEvent_GetHostNode (ArkUI_NodeAdapterEvent * event) 13414``` 13415**Description** 13416 13417Obtains the scrolling class container node that uses the adapter. 13418 13419**Since**: 12 13420 13421**Parameters** 13422 13423| Name| Description| 13424| -------- | -------- | 13425| event | Adapter event object. | 13426 13427**Returns** 13428 13429Returns the scrollable container node that uses the specified adapter. 13430 13431 13432### OH_ArkUI_NodeAdapterEvent_GetItemIndex() 13433 13434``` 13435uint32_t OH_ArkUI_NodeAdapterEvent_GetItemIndex (ArkUI_NodeAdapterEvent * event) 13436``` 13437**Description** 13438 13439Sequence number of the element to be operated when the adapter event is obtained. 13440 13441**Since**: 12 13442 13443**Parameters** 13444 13445| Name| Description| 13446| -------- | -------- | 13447| event | Adapter event object. | 13448 13449**Returns** 13450 13451Sequence number of an element. 13452 13453 13454### OH_ArkUI_NodeAdapterEvent_GetRemovedNode() 13455 13456``` 13457ArkUI_NodeHandle OH_ArkUI_NodeAdapterEvent_GetRemovedNode (ArkUI_NodeAdapterEvent * event) 13458``` 13459**Description** 13460 13461Obtains the element to be destroyed in the event to be destroyed. 13462 13463**Since**: 12 13464 13465**Parameters** 13466 13467| Name| Description| 13468| -------- | -------- | 13469| event | Adapter event object. | 13470 13471**Returns** 13472 13473Element to be destroyed. 13474 13475 13476### OH_ArkUI_NodeAdapterEvent_GetType() 13477 13478``` 13479ArkUI_NodeAdapterEventType OH_ArkUI_NodeAdapterEvent_GetType (ArkUI_NodeAdapterEvent * event) 13480``` 13481**Description** 13482 13483Obtains the event type. 13484 13485**Since**: 12 13486 13487**Parameters** 13488 13489| Name| Description| 13490| -------- | -------- | 13491| event | Adapter event object. | 13492 13493**Returns** 13494 13495Represents an event type. 13496 13497 13498### OH_ArkUI_NodeAdapterEvent_GetUserData() 13499 13500``` 13501void* OH_ArkUI_NodeAdapterEvent_GetUserData (ArkUI_NodeAdapterEvent * event) 13502``` 13503**Description** 13504 13505Obtains the custom data passed in during registration of the specified event. 13506 13507**Since**: 12 13508 13509**Parameters** 13510 13511| Name| Description| 13512| -------- | -------- | 13513| event | Adapter event object. | 13514 13515 13516### OH_ArkUI_NodeAdapterEvent_SetItem() 13517 13518``` 13519int32_t OH_ArkUI_NodeAdapterEvent_SetItem (ArkUI_NodeAdapterEvent * event, ArkUI_NodeHandle node ) 13520``` 13521**Description** 13522 13523Sets the component to be added to the specified adapter. 13524 13525**Since**: 12 13526 13527**Parameters** 13528 13529| Name| Description| 13530| -------- | -------- | 13531| event | Adapter event object. | 13532| node | Component to be added. | 13533 13534**Returns** 13535 13536Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13537 13538 13539### OH_ArkUI_NodeAdapterEvent_SetNodeId() 13540 13541``` 13542int32_t OH_ArkUI_NodeAdapterEvent_SetNodeId (ArkUI_NodeAdapterEvent * event, int32_t id ) 13543``` 13544**Description** 13545 13546Sets the generated component ID. 13547 13548**Since**: 12 13549 13550**Parameters** 13551 13552| Name| Description| 13553| -------- | -------- | 13554| event | Adapter event object. | 13555| id | Sets the returned component ID. | 13556 13557**Returns** 13558 13559Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13560 13561 13562### OH_ArkUI_NodeContent_AddNode() 13563 13564``` 13565int32_t OH_ArkUI_NodeContent_AddNode (ArkUI_NodeContentHandle content, ArkUI_NodeHandle node ) 13566``` 13567**Description** 13568 13569Adds an ArkUI component node to the specified NodeContent object. 13570 13571**Since**: 12 13572 13573**Parameters** 13574 13575| Name| Description| 13576| -------- | -------- | 13577| content | NodeContent object to which a node is to be added. | 13578| node | Node to be added. | 13579 13580**Returns** 13581 13582Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13583 13584 13585### OH_ArkUI_NodeContent_GetUserData() 13586 13587``` 13588void* OH_ArkUI_NodeContent_GetUserData (ArkUI_NodeContentHandle content) 13589``` 13590**Description** 13591 13592Obtains the user-defined data saved on the NodeContent object. 13593 13594**Since**: 12 13595 13596**Parameters** 13597 13598| Name| Description| 13599| -------- | -------- | 13600| content | NodeContent object whose user-defined data needs to be saved. | 13601 13602**Returns** 13603 13604Custom data. 13605 13606 13607### OH_ArkUI_NodeContent_InsertNode() 13608 13609``` 13610int32_t OH_ArkUI_NodeContent_InsertNode (ArkUI_NodeContentHandle content, ArkUI_NodeHandle node, int32_t position ) 13611``` 13612**Description** 13613 13614Inserts an ArkUI component node into a specific location of the corresponding NodeContent object. 13615 13616**Since**: 12 13617 13618**Parameters** 13619 13620| Name| Description| 13621| -------- | -------- | 13622| content | NodeContent object of the node to be inserted. | 13623| node | Node to be inserted. | 13624| position | Start time for an asset to be inserted, | 13625 13626**Returns** 13627 13628Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13629 13630 13631### OH_ArkUI_NodeContent_RegisterCallback() 13632 13633``` 13634int32_t OH_ArkUI_NodeContent_RegisterCallback (ArkUI_NodeContentHandle content, ArkUI_NodeContentCallback callback ) 13635``` 13636**Description** 13637 13638Registers the NodeContent event function. 13639 13640**Since**: 12 13641 13642**Parameters** 13643 13644| Name| Description| 13645| -------- | -------- | 13646| content | NodeContent object for which an event needs to be registered. | 13647| callback | Callback to be executed when the event is triggered. | 13648 13649**Returns** 13650 13651Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13652 13653 13654### OH_ArkUI_NodeContent_RemoveNode() 13655 13656``` 13657int32_t OH_ArkUI_NodeContent_RemoveNode (ArkUI_NodeContentHandle content, ArkUI_NodeHandle node ) 13658``` 13659**Description** 13660 13661Removes an ArkUI component node from the specified NodeContent object. 13662 13663**Since**: 12 13664 13665**Parameters** 13666 13667| Name| Description| 13668| -------- | -------- | 13669| content | NodeContent object of the node to be deleted. | 13670| node | Node to be deleted. | 13671 13672**Returns** 13673 13674Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13675 13676 13677### OH_ArkUI_NodeContent_SetUserData() 13678 13679``` 13680int32_t OH_ArkUI_NodeContent_SetUserData (ArkUI_NodeContentHandle content, void * userData ) 13681``` 13682**Description** 13683 13684Saves user-defined data on the NodeContent object. 13685 13686**Since**: 12 13687 13688**Parameters** 13689 13690| Name| Description| 13691| -------- | -------- | 13692| content | NodeContent object whose user-defined data needs to be saved. | 13693| userData | User-defined data to be saved. | 13694 13695**Returns** 13696 13697Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13698 13699 13700### OH_ArkUI_NodeContentEvent_GetEventType() 13701 13702``` 13703ArkUI_NodeContentEventType OH_ArkUI_NodeContentEvent_GetEventType (ArkUI_NodeContentEvent * event) 13704``` 13705**Description** 13706 13707Obtains the type of the specified NodeContent event. 13708 13709**Since**: 12 13710 13711**Parameters** 13712 13713| Name| Description| 13714| -------- | -------- | 13715| event | Pointer to the NodeContent event. | 13716 13717**Returns** 13718 13719NodeContent event type. 13720 13721 13722### OH_ArkUI_NodeContentEvent_GetNodeContentHandle() 13723 13724``` 13725ArkUI_NodeContentHandle OH_ArkUI_NodeContentEvent_GetNodeContentHandle (ArkUI_NodeContentEvent * event) 13726``` 13727**Description** 13728 13729Obtains the object that triggers the specified NodeContent event. 13730 13731**Since**: 12 13732 13733**Parameters** 13734 13735| Name| Description| 13736| -------- | -------- | 13737| event | Pointer to the NodeContent event. | 13738 13739**Returns** 13740 13741Returns the NodeContent object that triggers the event. 13742 13743 13744### OH_ArkUI_NodeCustomEvent_GetCustomSpanDrawInfo() 13745 13746``` 13747int32_t OH_ArkUI_NodeCustomEvent_GetCustomSpanDrawInfo (ArkUI_NodeCustomEvent * event, ArkUI_CustomSpanDrawInfo * info ) 13748``` 13749**Description** 13750 13751Obtains the drawing information of a custom span through a custom component event. 13752 13753**Since**: 12 13754 13755**Parameters** 13756 13757| Name| Description| 13758| -------- | -------- | 13759| event | Pointer to the custom component event. | 13760| info | Drawing information to obtain. | 13761 13762**Returns** 13763 13764Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. A possible cause is that mandatory parameters are left unspecified. 13765 13766 13767### OH_ArkUI_NodeCustomEvent_GetCustomSpanMeasureInfo() 13768 13769``` 13770int32_t OH_ArkUI_NodeCustomEvent_GetCustomSpanMeasureInfo (ArkUI_NodeCustomEvent * event, ArkUI_CustomSpanMeasureInfo * info ) 13771``` 13772**Description** 13773 13774Obtains the measurement information of a custom span through a custom component event. 13775 13776**Since**: 12 13777 13778**Parameters** 13779 13780| Name| Description| 13781| -------- | -------- | 13782| event | Pointer to the custom component event. | 13783| info | Measurement information to obtain. | 13784 13785**Returns** 13786 13787Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. A possible cause is that mandatory parameters are left unspecified. 13788 13789 13790### OH_ArkUI_NodeCustomEvent_GetDrawContextInDraw() 13791 13792``` 13793ArkUI_DrawContext* OH_ArkUI_NodeCustomEvent_GetDrawContextInDraw (ArkUI_NodeCustomEvent * event) 13794``` 13795**Description** 13796 13797Obtains the drawing context through a custom component event. 13798 13799**Since**: 12 13800 13801**Parameters** 13802 13803| Name| Description| 13804| -------- | -------- | 13805| event | Pointer to the custom component event. | 13806 13807**Returns** 13808 13809Returns the drawing context. 13810 13811 13812### OH_ArkUI_NodeCustomEvent_GetEventTargetId() 13813 13814``` 13815int32_t OH_ArkUI_NodeCustomEvent_GetEventTargetId (ArkUI_NodeCustomEvent * event) 13816``` 13817**Description** 13818 13819Obtains the ID of a custom component event. 13820 13821**Since**: 12 13822 13823**Parameters** 13824 13825| Name| Description| 13826| -------- | -------- | 13827| event | Pointer to the custom component event. | 13828 13829**Returns** 13830 13831Returns the custom event ID. 13832 13833 13834### OH_ArkUI_NodeCustomEvent_GetEventType() 13835 13836``` 13837ArkUI_NodeCustomEventType OH_ArkUI_NodeCustomEvent_GetEventType (ArkUI_NodeCustomEvent * event) 13838``` 13839**Description** 13840 13841Obtains the event type through a custom component event. 13842 13843**Since**: 12 13844 13845**Parameters** 13846 13847| Name| Description| 13848| -------- | -------- | 13849| event | Pointer to the custom component event. | 13850 13851**Returns** 13852 13853Returns the type of the custom component event. 13854 13855 13856### OH_ArkUI_NodeCustomEvent_GetLayoutConstraintInMeasure() 13857 13858``` 13859ArkUI_LayoutConstraint* OH_ArkUI_NodeCustomEvent_GetLayoutConstraintInMeasure (ArkUI_NodeCustomEvent * event) 13860``` 13861**Description** 13862 13863Obtains the size constraint for measurement through a custom component event. 13864 13865**Since**: 12 13866 13867**Parameters** 13868 13869| Name| Description| 13870| -------- | -------- | 13871| event | Pointer to the custom component event. | 13872 13873**Returns** 13874 13875Pointer to the constraint size. 13876 13877 13878### OH_ArkUI_NodeCustomEvent_GetNodeHandle() 13879 13880``` 13881ArkUI_NodeHandle OH_ArkUI_NodeCustomEvent_GetNodeHandle (ArkUI_NodeCustomEvent * event) 13882``` 13883**Description** 13884 13885Obtains a component object through a custom component event. 13886 13887**Since**: 12 13888 13889**Parameters** 13890 13891| Name| Description| 13892| -------- | -------- | 13893| event | Pointer to the custom component event. | 13894 13895**Returns** 13896 13897Returns the obtained component object. 13898 13899 13900### OH_ArkUI_NodeCustomEvent_GetPositionInLayout() 13901 13902``` 13903ArkUI_IntOffset OH_ArkUI_NodeCustomEvent_GetPositionInLayout (ArkUI_NodeCustomEvent * event) 13904``` 13905**Description** 13906 13907Obtains the expected position of a component relative to its parent component in the layout phase through a custom component event. 13908 13909**Since**: 12 13910 13911**Parameters** 13912 13913| Name| Description| 13914| -------- | -------- | 13915| event | Pointer to the custom component event. | 13916 13917**Returns** 13918 13919Returns the expected position relative to the parent component. 13920 13921 13922### OH_ArkUI_NodeCustomEvent_GetUserData() 13923 13924``` 13925void* OH_ArkUI_NodeCustomEvent_GetUserData (ArkUI_NodeCustomEvent * event) 13926``` 13927**Description** 13928 13929Obtains custom event parameters through a custom component event. 13930 13931**Since**: 12 13932 13933**Parameters** 13934 13935| Name| Description| 13936| -------- | -------- | 13937| event | Pointer to the custom component event. | 13938 13939**Returns** 13940 13941Returns the custom event parameters. 13942 13943 13944### OH_ArkUI_NodeCustomEvent_SetCustomSpanMetrics() 13945 13946``` 13947int32_t OH_ArkUI_NodeCustomEvent_SetCustomSpanMetrics (ArkUI_NodeCustomEvent * event, ArkUI_CustomSpanMetrics * metrics ) 13948``` 13949**Description** 13950 13951Sets the measurement metrics of a custom span through a custom component event. 13952 13953**Since**: 12 13954 13955**Parameters** 13956 13957| Name| Description| 13958| -------- | -------- | 13959| event | Pointer to the custom component event. | 13960| metrics | Measurement metrics to set. | 13961 13962**Returns** 13963 13964Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. A possible cause is that mandatory parameters are left unspecified. 13965 13966 13967### OH_ArkUI_NodeEvent_GetDragEvent() 13968 13969``` 13970ArkUI_DragEvent* OH_ArkUI_NodeEvent_GetDragEvent (ArkUI_NodeEvent * nodeEvent) 13971``` 13972**Description** 13973 13974Obtains an **ArkUI_DragEvent** object from the specified **ArkUI_DragEvent** object. 13975 13976**Since**: 12 13977 13978**Parameters** 13979 13980| Name| Description| 13981| -------- | -------- | 13982| node | Pointer to an **ArkUI_NodeEvent** object. | 13983 13984**Returns** 13985 13986Returns the pointer to an **ArkUI_DragEvent** object; returns null if the parameter passed in is invalid or is not a drag-related event. 13987 13988 13989### OH_ArkUI_NodeEvent_GetEventType() 13990 13991``` 13992ArkUI_NodeEventType OH_ArkUI_NodeEvent_GetEventType (ArkUI_NodeEvent * event) 13993``` 13994**Description** 13995 13996Obtains the type of a component event. 13997 13998**Since**: 12 13999 14000**Parameters** 14001 14002| Name| Description| 14003| -------- | -------- | 14004| event | Pointer to the component event. | 14005 14006**Returns** 14007 14008Returns the type of the component event. 14009 14010 14011### OH_ArkUI_NodeEvent_GetInputEvent() 14012 14013``` 14014ArkUI_UIInputEvent* OH_ArkUI_NodeEvent_GetInputEvent (ArkUI_NodeEvent * event) 14015``` 14016**Description** 14017 14018Obtains input event (for example, touch event) data for a component event. 14019 14020**Since**: 12 14021 14022**Parameters** 14023 14024| Name| Description| 14025| -------- | -------- | 14026| event | Pointer to the component event. | 14027 14028**Returns** 14029 14030Returns the pointer to the input event data. 14031 14032 14033### OH_ArkUI_NodeEvent_GetNodeComponentEvent() 14034 14035``` 14036ArkUI_NodeComponentEvent* OH_ArkUI_NodeEvent_GetNodeComponentEvent (ArkUI_NodeEvent * event) 14037``` 14038**Description** 14039 14040Obtains the numerical data in a component event. 14041 14042**Since**: 12 14043 14044**Parameters** 14045 14046| Name| Description| 14047| -------- | -------- | 14048| event | Pointer to the component event. | 14049 14050**Returns** 14051 14052Returns the pointer to the numerical data. 14053 14054 14055### OH_ArkUI_NodeEvent_GetNodeHandle() 14056 14057``` 14058ArkUI_NodeHandle OH_ArkUI_NodeEvent_GetNodeHandle (ArkUI_NodeEvent * event) 14059``` 14060**Description** 14061 14062Obtains the component object that triggers an event. 14063 14064**Since**: 12 14065 14066**Parameters** 14067 14068| Name| Description| 14069| -------- | -------- | 14070| event | Pointer to the component event. | 14071 14072**Returns** 14073 14074Component object that triggers the event. 14075 14076 14077### OH_ArkUI_NodeEvent_GetNumberValue() 14078 14079``` 14080int32_t OH_ArkUI_NodeEvent_GetNumberValue (ArkUI_NodeEvent * event, int32_t index, ArkUI_NumberValue * value ) 14081``` 14082**Description** 14083 14084Obtains the numeric-type parameter of a component event. 14085 14086**Since**: 12 14087 14088**Parameters** 14089 14090| Name| Description| 14091| -------- | -------- | 14092| event | Pointer to the component event. | 14093| index | Return value index. | 14094| value | Return value. | 14095 14096**Returns** 14097 14098Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_NODE_EVENT_PARAM_INDEX_OUT_OF_RANGE** if the parameter length in the parameter event exceeds the limit. Returns **ARKUI_ERROR_CODE_NODE_EVENT_PARAM_INVALID** if the data does not exist in the component event. 14099 14100 14101### OH_ArkUI_NodeEvent_GetPreDragStatus() 14102 14103``` 14104ArkUI_PreDragStatus OH_ArkUI_NodeEvent_GetPreDragStatus (ArkUI_NodeEvent * nodeEvent) 14105``` 14106**Description** 14107 14108Obtains the state prior to a drop and drop operation. 14109 14110**Since**: 12 14111 14112**Parameters** 14113 14114| Name| Description| 14115| -------- | -------- | 14116| node | ArkUI_NodeEvent node object. | 14117 14118**Returns** 14119 14120Returns the state prior to the drop and drop operation. 14121 14122 14123### OH_ArkUI_NodeEvent_GetStringAsyncEvent() 14124 14125``` 14126ArkUI_StringAsyncEvent* OH_ArkUI_NodeEvent_GetStringAsyncEvent (ArkUI_NodeEvent * event) 14127``` 14128**Description** 14129 14130Obtains the string data in a component event. 14131 14132**Since**: 12 14133 14134**Parameters** 14135 14136| Name| Description| 14137| -------- | -------- | 14138| event | Pointer to the component event. | 14139 14140**Returns** 14141 14142ArkUI_StringAsyncEvent\Pointer to string data. 14143 14144 14145### OH_ArkUI_NodeEvent_GetStringValue() 14146 14147``` 14148int32_t OH_ArkUI_NodeEvent_GetStringValue (ArkUI_NodeEvent * event, int32_t index, char ** string, int32_t * stringSize ) 14149``` 14150**Description** 14151 14152Obtains the string-type parameter of the component callback event. The string data is valid only during event callback and needs to be used outside event callback. You are advised to copy the string data. 14153 14154**Since**: 12 14155 14156**Parameters** 14157 14158| Name| Description| 14159| -------- | -------- | 14160| event | Pointer to the component event. | 14161| index | Return value index. | 14162| string | Pointer to the string array. | 14163| stringSize | Length of the string array. | 14164 14165**Returns** 14166 14167Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_NODE_EVENT_PARAM_INDEX_OUT_OF_RANGE** if the parameter length in the parameter event exceeds the limit. Returns **ARKUI_ERROR_CODE_NODE_EVENT_PARAM_INVALID** if the data does not exist in the component event. 14168 14169 14170### OH_ArkUI_NodeEvent_GetTargetId() 14171 14172``` 14173int32_t OH_ArkUI_NodeEvent_GetTargetId (ArkUI_NodeEvent * event) 14174``` 14175**Description** 14176 14177Obtains the custom ID of a component event. 14178 14179The event ID is transferred as a parameter when the registerNodeEvent function is called and can be used in the distribution logic of the same event entry function registerNodeEventReceiver. 14180 14181**Since**: 12 14182 14183**Parameters** 14184 14185| Name| Description| 14186| -------- | -------- | 14187| event | Pointer to the component event. | 14188 14189**Returns** 14190 14191Returns the custom ID of the component event. 14192 14193 14194### OH_ArkUI_NodeEvent_GetUserData() 14195 14196``` 14197void* OH_ArkUI_NodeEvent_GetUserData (ArkUI_NodeEvent * event) 14198``` 14199**Description** 14200 14201Obtains the custom data in a component event. 14202 14203This parameter is passed in **registerNodeEvent** and can be applied to the service logic when the event is triggered. 14204 14205**Since**: 12 14206 14207**Parameters** 14208 14209| Name| Description| 14210| -------- | -------- | 14211| event | Pointer to the component event. | 14212 14213**Returns** 14214 14215Returns the pointer to user data. 14216 14217 14218### OH_ArkUI_NodeEvent_SetReturnNumberValue() 14219 14220``` 14221int32_t OH_ArkUI_NodeEvent_SetReturnNumberValue (ArkUI_NodeEvent * event, ArkUI_NumberValue * value, int32_t size ) 14222``` 14223**Description** 14224 14225Sets the return value for a component event. 14226 14227**Since**: 12 14228 14229**Parameters** 14230 14231| Name| Description| 14232| -------- | -------- | 14233| event | Pointer to the component event. | 14234| value | Event numeric type array. | 14235| size | Size of the array. | 14236 14237**Returns** 14238 14239Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. The component event does not support return values. Returns **ARKUI_ERROR_CODE_NODE_EVENT_PARAM_INVALID** if the data does not exist in the component event. 14240 14241 14242### OH_ArkUI_NodeUtils_AddCustomProperty() 14243 14244``` 14245void OH_ArkUI_NodeUtils_AddCustomProperty (ArkUI_NodeHandle node, const char * name, const char * value ) 14246``` 14247**Description** 14248 14249Sets a custom property for a component. This API takes effect only in the main thread. 14250 14251**Since**: 13 14252 14253**Parameters** 14254 14255| Name| Description| 14256| -------- | -------- | 14257| node | **ArkUI_NodeHandle** pointer. | 14258| name | Name of the custom property. A null pointer is not allowed. | 14259| value | Value of the custom property. A null pointer is not allowed. | 14260 14261 14262### OH_ArkUI_NodeUtils_GetActiveChildrenInfo() 14263 14264``` 14265int32_t OH_ArkUI_NodeUtils_GetActiveChildrenInfo (ArkUI_NodeHandle head, ArkUI_ActiveChildrenInfo ** handle ) 14266``` 14267**Description** 14268 14269Obtains all active child nodes of the specified node. Spans are not counted as child nodes. 14270 14271**Since**: 14 14272 14273**Parameters** 14274 14275| Name| Description| 14276| -------- | -------- | 14277| head | Node for which to obtain the child nodes. | 14278| handle | Pointer to the struct containing information about the child nodes of the head node. | 14279 14280**Returns** 14281 14282Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 14283 14284 14285### OH_ArkUI_NodeUtils_GetCurrentPageRootNode() 14286 14287``` 14288ArkUI_NodeHandle OH_ArkUI_NodeUtils_GetCurrentPageRootNode (ArkUI_NodeHandle node) 14289``` 14290**Description** 14291 14292Obtains the root node of the current page. 14293 14294**Since**: 14 14295 14296**Parameters** 14297 14298| Name| Description| 14299| -------- | -------- | 14300| node | Target node. | 14301 14302**Returns** 14303 14304Returns the pointer to the root node if the node exists; returns **NULL** otherwise. 14305 14306 14307### OH_ArkUI_NodeUtils_GetCustomProperty() 14308 14309``` 14310int32_t OH_ArkUI_NodeUtils_GetCustomProperty (ArkUI_NodeHandle node, const char * name, ArkUI_CustomProperty ** handle ) 14311``` 14312**Description** 14313 14314Obtains the value of a custom property of the specified component. 14315 14316**Since**: 14 14317 14318**Parameters** 14319 14320| Name| Description| 14321| -------- | -------- | 14322| node | **ArkUI_NodeHandle** pointer. | 14323| name | Name of the custom property. | 14324| handle | Pointer to the struct that receives the custom property corresponding to the key parameter name. | 14325 14326**Returns** 14327 14328Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 14329 14330 14331### OH_ArkUI_NodeUtils_GetLayoutPosition() 14332 14333``` 14334int32_t OH_ArkUI_NodeUtils_GetLayoutPosition (ArkUI_NodeHandle node, ArkUI_IntOffset * localOffset ) 14335``` 14336**Description** 14337 14338Obtains the position of the component's layout area relative to its parent component. The relative position does not count in transformation attributes, such as translate. 14339 14340**Since**: 12 14341 14342**Parameters** 14343 14344| Name| Description| 14345| -------- | -------- | 14346| node | **ArkUI_NodeHandle** pointer. | 14347| localOffset | Offset of the component handle relative to the parent component, in pixels. | 14348 14349**Returns** 14350 14351Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 14352 14353 14354### OH_ArkUI_NodeUtils_GetLayoutPositionInScreen() 14355 14356``` 14357int32_t OH_ArkUI_NodeUtils_GetLayoutPositionInScreen (ArkUI_NodeHandle node, ArkUI_IntOffset * screenOffset ) 14358``` 14359**Description** 14360 14361Obtains the position of the component's layout area relative to the screen. The relative position does not count in transformation attributes, such as translate. 14362 14363**Since**: 12 14364 14365**Parameters** 14366 14367| Name| Description| 14368| -------- | -------- | 14369| node | **ArkUI_NodeHandle** pointer. | 14370| screenOffset | Offset of the component handle relative to the screen, in pixels. | 14371 14372**Returns** 14373 14374Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 14375 14376 14377### OH_ArkUI_NodeUtils_GetLayoutPositionInWindow() 14378 14379``` 14380int32_t OH_ArkUI_NodeUtils_GetLayoutPositionInWindow (ArkUI_NodeHandle node, ArkUI_IntOffset * globalOffset ) 14381``` 14382**Description** 14383 14384Obtains the position of the component's layout area relative to the window. The relative position does not count in transformation attributes, such as translate. 14385 14386**Since**: 12 14387 14388**Parameters** 14389 14390| Name| Description| 14391| -------- | -------- | 14392| node | **ArkUI_NodeHandle** pointer. | 14393| globalOffset | Offset of the component handle relative to the window, in pixels. | 14394 14395**Returns** 14396 14397Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 14398 14399 14400### OH_ArkUI_NodeUtils_GetLayoutSize() 14401 14402``` 14403int32_t OH_ArkUI_NodeUtils_GetLayoutSize (ArkUI_NodeHandle node, ArkUI_IntSize * size ) 14404``` 14405**Description** 14406 14407Obtains the layout area size of a component. The size does not count in transformation attributes, such as scale. 14408 14409**Since**: 12 14410 14411**Parameters** 14412 14413| Name| Description| 14414| -------- | -------- | 14415| node | **ArkUI_NodeHandle** pointer. | 14416| size | Size of the layout area, in px. | 14417 14418**Returns** 14419 14420Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 14421 14422 14423### OH_ArkUI_NodeUtils_GetNodeType() 14424 14425``` 14426int32_t OH_ArkUI_NodeUtils_GetNodeType (ArkUI_NodeHandle node) 14427``` 14428**Description** 14429 14430Obtains the type of the specified node. 14431 14432**Since**: 14 14433 14434**Parameters** 14435 14436| Name| Description| 14437| -------- | -------- | 14438| node | Target node. | 14439 14440**Returns** 14441 14442Returns the type of the node. Returns **-1** if the type is not supported yet. For details about the available types, see [ArkUI_NodeType](#arkui_nodetype). 14443 14444 14445### OH_ArkUI_NodeUtils_GetParentInPageTree() 14446 14447``` 14448ArkUI_NodeHandle OH_ArkUI_NodeUtils_GetParentInPageTree (ArkUI_NodeHandle node) 14449``` 14450**Description** 14451 14452Obtains the parent node, which can be a component node created with ArkTS. 14453 14454**Since**: 14 14455 14456**Parameters** 14457 14458| Name| Description| 14459| -------- | -------- | 14460| node | Target node. | 14461 14462**Returns** 14463 14464Returns the pointer to the component if the component exists; returns **NULL** otherwise. 14465 14466 14467### OH_ArkUI_NodeUtils_GetPositionWithTranslateInScreen() 14468 14469``` 14470int32_t OH_ArkUI_NodeUtils_GetPositionWithTranslateInScreen (ArkUI_NodeHandle node, ArkUI_IntOffset * translateOffset ) 14471``` 14472**Description** 14473 14474Obtains the position of a component on the screen, including the translate attribute. 14475 14476**Since**: 12 14477 14478**Parameters** 14479 14480| Name| Description| 14481| -------- | -------- | 14482| node | **ArkUI_NodeHandle** pointer. | 14483| translateOffset | Accumulated offset of the component, its parent component, and its ancestor node, in px. | 14484 14485**Returns** 14486 14487Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 14488 14489 14490### OH_ArkUI_NodeUtils_GetPositionWithTranslateInWindow() 14491 14492``` 14493int32_t OH_ArkUI_NodeUtils_GetPositionWithTranslateInWindow (ArkUI_NodeHandle node, ArkUI_IntOffset * translateOffset ) 14494``` 14495**Description** 14496 14497Obtains the position of a component in the window, including the translate attribute. 14498 14499**Since**: 12 14500 14501**Parameters** 14502 14503| Name| Description| 14504| -------- | -------- | 14505| node | **ArkUI_NodeHandle** pointer. | 14506| translateOffset | Accumulated offset of the component, its parent component, and its ancestor node, in px. | 14507 14508**Returns** 14509 14510Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 14511 14512 14513### OH_ArkUI_NodeUtils_IsCreatedByNDK() 14514 14515``` 14516bool OH_ArkUI_NodeUtils_IsCreatedByNDK (ArkUI_NodeHandle node) 14517``` 14518**Description** 14519 14520Checks whether the specified component is created with the C API. 14521 14522**Since**: 14 14523 14524**Parameters** 14525 14526| Name| Description| 14527| -------- | -------- | 14528| node | Target node. | 14529 14530**Returns** 14531 14532Returns whether the node is created with the C API. The value **true** means that the node is created with the C API, and **false** means the opposite. 14533 14534 14535### OH_ArkUI_NodeUtils_RemoveCustomProperty() 14536 14537``` 14538void OH_ArkUI_NodeUtils_RemoveCustomProperty (ArkUI_NodeHandle node, const char * name ) 14539``` 14540**Description** 14541 14542Removes a custom property that has been set for the specified component. 14543 14544**Since**: 13 14545 14546**Parameters** 14547 14548| Name| Description| 14549| -------- | -------- | 14550| node | **ArkUI_NodeHandle** pointer. | 14551| name | Name of the custom property. | 14552 14553 14554### OH_ArkUI_PanGesture_GetOffsetX() 14555 14556``` 14557float OH_ArkUI_PanGesture_GetOffsetX (const ArkUI_GestureEvent * event) 14558``` 14559**Description** 14560 14561Obtains the relative offset of a pan gesture along the x-axis. 14562 14563**Since**: 12 14564 14565**Parameters** 14566 14567| Name| Description| 14568| -------- | -------- | 14569| event | Gesture event. | 14570 14571**Returns** 14572 14573Returns the relative offset of the gesture along the x-axis, in px. 14574 14575 14576### OH_ArkUI_PanGesture_GetOffsetY() 14577 14578``` 14579float OH_ArkUI_PanGesture_GetOffsetY (const ArkUI_GestureEvent * event) 14580``` 14581**Description** 14582 14583Obtains the relative offset of a pan gesture along the y-axis. 14584 14585**Since**: 12 14586 14587**Parameters** 14588 14589| Name| Description| 14590| -------- | -------- | 14591| event | Gesture event. | 14592 14593**Returns** 14594 14595Returns the relative offset of the gesture along the y-axis, in px. 14596 14597 14598### OH_ArkUI_PanGesture_GetVelocity() 14599 14600``` 14601float OH_ArkUI_PanGesture_GetVelocity (const ArkUI_GestureEvent * event) 14602``` 14603**Description** 14604 14605Obtains the velocity of a pan gesture along the main axis. 14606 14607**Since**: 12 14608 14609**Parameters** 14610 14611| Name| Description| 14612| -------- | -------- | 14613| event | Gesture event. | 14614 14615**Returns** 14616 14617Returns the velocity of the pan gesture along the main axis, in px/s. The value is the square root of the sum of the squares of the velocity on the x-axis and y-axis. 14618 14619 14620### OH_ArkUI_PanGesture_GetVelocityX() 14621 14622``` 14623float OH_ArkUI_PanGesture_GetVelocityX (const ArkUI_GestureEvent * event) 14624``` 14625**Description** 14626 14627Obtains the velocity of a pan gesture along the x-axis. 14628 14629**Since**: 12 14630 14631**Parameters** 14632 14633| Name| Description| 14634| -------- | -------- | 14635| event | Gesture event. | 14636 14637**Returns** 14638 14639Returns the velocity of the pan gesture along the x-axis, in px/s. 14640 14641 14642### OH_ArkUI_PanGesture_GetVelocityY() 14643 14644``` 14645float OH_ArkUI_PanGesture_GetVelocityY (const ArkUI_GestureEvent * event) 14646``` 14647**Description** 14648 14649Obtains the velocity of a pan gesture along the y-axis. 14650 14651**Since**: 12 14652 14653**Parameters** 14654 14655| Name| Description| 14656| -------- | -------- | 14657| event | Gesture event. | 14658 14659**Returns** 14660 14661Returns the velocity of the pan gesture along the y-axis, in px/s. 14662 14663 14664### OH_ArkUI_ParallelInnerGestureEvent_GetConflictRecognizers() 14665 14666``` 14667int32_t OH_ArkUI_ParallelInnerGestureEvent_GetConflictRecognizers (ArkUI_ParallelInnerGestureEvent * event, ArkUI_GestureRecognizerHandleArray * array, int32_t * size ) 14668``` 14669**Description** 14670 14671Obtains the conflicting gesture recognizers in a parallel internal gesture event. 14672 14673**Since**: 12 14674 14675**Parameters** 14676 14677| Name| Description| 14678| -------- | -------- | 14679| event | Parallel internal gesture event. | 14680| array | Array of conflicting gesture recognizers. | 14681| size | Size of the conflicting gesture recognizer array. | 14682 14683**Returns** 14684 14685Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 14686 14687 14688### OH_ArkUI_ParallelInnerGestureEvent_GetCurrentRecognizer() 14689 14690``` 14691ArkUI_GestureRecognizer* OH_ArkUI_ParallelInnerGestureEvent_GetCurrentRecognizer (ArkUI_ParallelInnerGestureEvent * event) 14692``` 14693**Description** 14694 14695Obtains the current gesture recognizer in a parallel internal gesture event. 14696 14697**Since**: 12 14698 14699**Parameters** 14700 14701| Name| Description| 14702| -------- | -------- | 14703| event | Parallel internal gesture event. | 14704 14705**Returns** 14706 14707Returns the pointer to the current gesture recognizer. 14708 14709### OH_ArkUI_ParallelInnerGestureEvent_GetUserData() 14710 14711``` 14712void* OH_ArkUI_ParallelInnerGestureEvent_GetUserData (ArkUI_ParallelInnerGestureEvent * event) 14713``` 14714**Description** 14715 14716Obtains custom data in the parallel internal gesture event. 14717 14718**Since**: 12 14719 14720**Parameters** 14721 14722| Name| Description| 14723| -------- | -------- | 14724| event | Parallel internal gesture event. | 14725 14726**Returns** 14727 14728Returns the pointer to custom data. 14729 14730### OH_ArkUI_GestureInterrupter_GetUserData 14731 14732``` 14733void* OH_ArkUI_GestureInterrupter_GetUserData(ArkUI_GestureInterruptInfo* event) 14734``` 14735 14736**Description** 14737 14738Obtains the custom data from a gesture interruption event. 14739 14740**Since**: 18 14741 14742**Parameters** 14743 14744| Name | Description | 14745| ----- | -------------------------- | 14746| event | Pointer to the gesture interruption information.| 14747 14748**Returns** 14749 14750Returns the pointer to the custom data. 14751 14752 14753### OH_ArkUI_PinchGesture_GetCenterX() 14754 14755``` 14756float OH_ArkUI_PinchGesture_GetCenterX (const ArkUI_GestureEvent * event) 14757``` 14758**Description** 14759 14760Obtains the X coordinate of the center of the pinch gesture, in vp, relative to the upper left corner of the current component. 14761 14762**Since**: 12 14763 14764**Parameters** 14765 14766| Name| Description| 14767| -------- | -------- | 14768| event | Gesture event. | 14769 14770**Returns** 14771 14772Returns the X coordinate of the center of the pinch gesture, in vp, relative to the upper left corner of the current component. 14773 14774 14775### OH_ArkUI_PinchGesture_GetCenterY() 14776 14777``` 14778float OH_ArkUI_PinchGesture_GetCenterY (const ArkUI_GestureEvent * event) 14779``` 14780**Description** 14781 14782Obtains the Y coordinate of the center of the pinch gesture, in vp, relative to the upper left corner of the current component. 14783 14784**Since**: 12 14785 14786**Parameters** 14787 14788| Name| Description| 14789| -------- | -------- | 14790| event | Gesture event. | 14791 14792**Returns** 14793 14794Returns the Y coordinate of the center of the pinch gesture, in vp, relative to the upper left corner of the current component. 14795 14796 14797### OH_ArkUI_PinchGesture_GetScale() 14798 14799``` 14800float OH_ArkUI_PinchGesture_GetScale (const ArkUI_GestureEvent * event) 14801``` 14802**Description** 14803 14804Obtains the scale ratio of a pinch gesture. 14805 14806**Since**: 12 14807 14808**Parameters** 14809 14810| Name| Description| 14811| -------- | -------- | 14812| event | Gesture event. | 14813 14814**Returns** 14815 14816Scale. 14817 14818 14819### OH_ArkUI_QueryModuleInterfaceByName() 14820 14821``` 14822void* OH_ArkUI_QueryModuleInterfaceByName (ArkUI_NativeAPIVariantKind type, const char * structName ) 14823``` 14824**Description** 14825 14826Obtains the native API set of a specified type. 14827 14828**Since**: 12 14829 14830**Parameters** 14831 14832| Name| Description| 14833| -------- | -------- | 14834| type | Type of the native API set provided by ArkUI, for example, **ARKUI_NATIVE_NODE** or **ARKUI_NATIVE_GESTURE**. | 14835| sturctName | Name of a native struct defined in the corresponding header file, for example, **ArkUI_NativeNodeAPI_1** in <arkui/native_node.h>. | 14836 14837**Returns** 14838 14839Returns the pointer to the abstract native API, which can be used after being converted into a specific type. \#include<arkui/native_interface.h> \#include<arkui/native_node.h> \#include<arkui/native_gesture.h> auto\* anyNativeAPI = [OH_ArkUI_QueryModuleInterfaceByName](#oh_arkui_querymoduleinterfacebyname)(ARKUI_NATIVE_NODE, "ArkUI_NativeNodeAPI_1"); if (anyNativeAPI) { auto nativeNodeApi = reinterpret_cast<[ArkUI_NativeNodeAPI_1](_ark_u_i___native_node_a_p_i__1.md)\*>(anyNativeAPI); } auto anyGestureAPI = OH_ArkUI_QueryModuleInterface(ARKUI_NATIVE_GESTURE, "ArkUI_NativeGestureAPI_1"); if (anyNativeAPI) { auto basicGestureApi = reinterpret_cast<[ArkUI_NativeGestureAPI_1](_ark_u_i___native_gesture_a_p_i__1.md)\*>(anyGestureAPI); } 14840 14841 14842### OH_ArkUI_RegisterSystemColorModeChangeEvent() 14843 14844``` 14845int32_t OH_ArkUI_RegisterSystemColorModeChangeEvent (ArkUI_NodeHandle node, void * userData, void(*)(ArkUI_SystemColorMode colorMode, void *userData) onColorModeChange ) 14846``` 14847**Description** 14848 14849Registers an event listener for system color mode changes. A single component can only register one callback for system color mode changes. 14850 14851**Since**: 12 14852 14853**Parameters** 14854 14855| Name| Description| 14856| -------- | -------- | 14857| node | Specified node. | 14858| userData | Custom event parameter, which is passed in the callback when the event is triggered. | 14859| onColorModeChange | Callback to be executed when the event is triggered. | 14860 14861**Returns** 14862 14863Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. Returns **ARKUI_ERROR_CODE_ATTRIBUTE_OR_EVENT_NOT_SUPPORTED** if the event is not supported. 14864 14865 14866### OH_ArkUI_RegisterSystemFontStyleChangeEvent() 14867 14868``` 14869int32_t OH_ArkUI_RegisterSystemFontStyleChangeEvent (ArkUI_NodeHandle node, void * userData, void(*)(ArkUI_SystemFontStyleEvent *event, void *userData) onFontStyleChange ) 14870``` 14871**Description** 14872 14873Registers an event listener for system font style changes. A single component can only register one callback for system font style changes. 14874 14875**Since**: 12 14876 14877**Parameters** 14878 14879| Name| Description| 14880| -------- | -------- | 14881| node | Specified node. | 14882| userData | Custom event parameter, which is passed in the callback when the event is triggered. | 14883| onFontStyleChange | Callback to be executed when the event is triggered. | 14884 14885**Returns** 14886 14887Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. Returns **ARKUI_ERROR_CODE_ATTRIBUTE_OR_EVENT_NOT_SUPPORTED** if the event is not supported. 14888 14889 14890### OH_ArkUI_RotationGesture_GetAngle() 14891 14892``` 14893float OH_ArkUI_RotationGesture_GetAngle (const ArkUI_GestureEvent * event) 14894``` 14895**Description** 14896 14897Obtains the angle information of a rotation gesture. 14898 14899**Since**: 12 14900 14901**Parameters** 14902 14903| Name| Description| 14904| -------- | -------- | 14905| event | Gesture event. | 14906 14907**Returns** 14908 14909Rotation angle. 14910 14911 14912### OH_ArkUI_SetArkUIGestureRecognizerDisposeNotify() 14913 14914``` 14915int32_t OH_ArkUI_SetArkUIGestureRecognizerDisposeNotify (ArkUI_GestureRecognizer * recognizer, ArkUI_GestureRecognizerDestructNotifyCallback callback, void * userData ) 14916``` 14917**Description** 14918 14919Sets a callback function for notifying gesture recognizer destruction. 14920 14921**Parameters** 14922 14923| Name| Description| 14924| -------- | -------- | 14925| recognizer | Pointer to the gesture recognizer. | 14926| callback | Callback function for notifying gesture recognizer destruction. | 14927| userData | Custom data. | 14928 14929**Returns** 14930 14931Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 14932 14933 14934### OH_ArkUI_SetDragEventStrictReportWithContext() 14935 14936``` 14937int32_t OH_ArkUI_SetDragEventStrictReportWithContext (ArkUI_ContextHandle uiContext, bool enabled ) 14938``` 14939**Description** 14940 14941Sets whether to enable strict reporting on drag events. This feature is disabled by default, and you are advised to enable it. If this feature is disabled, the parent component is not notified when an item in it is dragged over its child component. If this feature is enabled, the component is notified of the dragged item's leaving, and the child component to which the dragged item is dropped is notified of the item's entering. This configuration is related to a specific UI instance. You can pass in a UI instance for association. 14942 14943**Since**: 12 14944 14945**Parameters** 14946 14947| Name| Description| 14948| -------- | -------- | 14949| uiContext | Pointer to the UI instance. | 14950| enabled | Whether to enable strict reporting on drag events. | 14951 14952**Returns** 14953 14954Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 14955 14956 14957### OH_ArkUI_SetDragEventStrictReportWithNode() 14958 14959``` 14960int32_t OH_ArkUI_SetDragEventStrictReportWithNode (ArkUI_NodeHandle node, bool enabled ) 14961``` 14962**Description** 14963 14964Sets whether to enable strict reporting on drag events. This feature is disabled by default, and you are advised to enable it. If this feature is disabled, the parent component is not notified when an item in it is dragged over its child component. If this feature is enabled, the component is notified of the dragged item's leaving, and the child component to which the dragged item is dropped is notified of the item's entering. This configuration is related to a specific UI instance. You can pass in a specific component node on the current UI instance for association. 14965 14966**Since**: 12 14967 14968**Parameters** 14969 14970| Name| Description| 14971| -------- | -------- | 14972| node | Pointer to a component node. | 14973| enabled | Whether to enable strict reporting on drag events. | 14974 14975**Returns** 14976 14977Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 14978 14979 14980### OH_ArkUI_SetGestureRecognizerEnabled() 14981 14982``` 14983int32_t OH_ArkUI_SetGestureRecognizerEnabled (ArkUI_GestureRecognizer * recognizer, bool enabled ) 14984``` 14985**Description** 14986 14987Sets the enabled state of a gesture recognizer. 14988 14989**Since**: 12 14990 14991**Parameters** 14992 14993| Name| Description| 14994| -------- | -------- | 14995| recognizer | Pointer to the gesture recognizer. | 14996| enabled | Whether to enable notification. | 14997 14998**Returns** 14999 15000Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 15001 15002### OH_ArkUI_SetGestureRecognizerLimitFingerCount 15003 15004``` 15005int32_t OH_ArkUI_SetGestureRecognizerLimitFingerCount (ArkUI_GestureRecognizer * recognizer, bool limitFingerCount ) 15006``` 15007**Description** 15008 15009Sets whether to enforce the exact number of fingers touching the screen. 15010 15011**Parameters** 15012 15013| Name| Description| 15014| -------- | -------- | 15015| recognizer | Pointer to the gesture recognizer. | 15016| limitFingerCount | Whether to enforce the exact number of fingers touching the screen. | 15017 15018**Returns** 15019 15020Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 15021 15022 15023 15024 15025### OH_ArkUI_SetNodeAllowedDropDataTypes() 15026 15027``` 15028int32_t OH_ArkUI_SetNodeAllowedDropDataTypes (ArkUI_NodeHandle node, const char * typesArray[], int32_t count ) 15029``` 15030**Description** 15031 15032Sets the types of data that can be dropped to the specified component. This API resets the settings configured through [OH_ArkUI_DisallowNodeAnyDropDataTypes](#oh_arkui_disallownodeanydropdatatypes) or [OH_ArkUI_AllowNodeAllDropDataTypes](#oh_arkui_allownodealldropdatatypes). 15033 15034**Since**: 12 15035 15036**Parameters** 15037 15038| Name| Description| 15039| -------- | -------- | 15040| node | Pointer to a component node. | 15041| typesArray | Array of data types that can fall into. | 15042| count | Length of an array. | 15043 15044**Returns** 15045 15046Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 15047 15048 15049### OH_ArkUI_SetNodeDraggable() 15050 15051``` 15052int32_t OH_ArkUI_SetNodeDraggable (ArkUI_NodeHandle node, bool enabled ) 15053``` 15054**Description** 15055 15056Sets whether the component is draggable. 15057 15058**Since**: 12 15059 15060**Parameters** 15061 15062| Name| Description| 15063| -------- | -------- | 15064| node | Pointer to a component node. | 15065| bool | Whether the component is draggable. | 15066 15067**Returns** 15068 15069Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 15070 15071 15072### OH_ArkUI_SetNodeDragPreview() 15073 15074``` 15075int32_t OH_ArkUI_SetNodeDragPreview (ArkUI_NodeHandle node, OH_PixelmapNative * preview ) 15076``` 15077**Description** 15078 15079Sets a custom drag preview for the specified component. 15080 15081**Since**: 12 15082 15083**Parameters** 15084 15085| Name| Description| 15086| -------- | -------- | 15087| node | Pointer to the target component node. | 15088| preview | Custom drag preview, which is a pixel map. | 15089 15090**Returns** 15091 15092Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 15093 15094 15095### OH_ArkUI_SetNodeDragPreviewOption() 15096 15097``` 15098int32_t OH_ArkUI_SetNodeDragPreviewOption (ArkUI_NodeHandle node, ArkUI_DragPreviewOption * option ) 15099``` 15100**Description** 15101 15102Sets an **ArkUI_DragPreviewOption** object for the specified component. 15103 15104**Since**: 12 15105 15106**Parameters** 15107 15108| Name| Description| 15109| -------- | -------- | 15110| node | Pointer to a component node. | 15111| option | Custom parameters. | 15112 15113**Returns** 15114 15115Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 15116 15117 15118### OH_ArkUI_StartDrag() 15119 15120``` 15121int32_t OH_ArkUI_StartDrag (ArkUI_DragAction * dragAction) 15122``` 15123**Description** 15124 15125Initiates a drag action through the specified drag action object. 15126 15127**Since**: 12 15128 15129**Parameters** 15130 15131| Name| Description| 15132| -------- | -------- | 15133| dragAction | Drag action object. | 15134 15135**Returns** 15136 15137Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 15138 15139 15140### OH_ArkUI_StyledString_AddPlaceholder() 15141 15142``` 15143void OH_ArkUI_StyledString_AddPlaceholder (ArkUI_StyledString * handle, OH_Drawing_PlaceholderSpan * placeholder ) 15144``` 15145**Description** 15146 15147Adds a placeholder. 15148 15149**Since**: 12 15150 15151**Parameters** 15152 15153| Name| Description| 15154| -------- | -------- | 15155| handle | Pointer to an **ArkUI_StyledString** object. | 15156| placeholder | Pointer to an **OH_Drawing_PlaceholderSpan** object. | 15157 15158 15159### OH_ArkUI_StyledString_AddText() 15160 15161``` 15162void OH_ArkUI_StyledString_AddText (ArkUI_StyledString * handle, const char * content ) 15163``` 15164**Description** 15165 15166Sets the text content based on the current format string style. 15167 15168**Since**: 12 15169 15170**Parameters** 15171 15172| Name| Description| 15173| -------- | -------- | 15174| handle | Pointer to an **ArkUI_StyledString** object. | 15175| content | Pointer to the text content. | 15176 15177 15178### OH_ArkUI_StyledString_Create() 15179 15180``` 15181ArkUI_StyledString* OH_ArkUI_StyledString_Create (OH_Drawing_TypographyStyle * style, OH_Drawing_FontCollection * collection ) 15182``` 15183**Description** 15184 15185Creates an **ArkUI_StyledString** object. 15186 15187**Since**: 12 15188 15189**Parameters** 15190 15191| Name| Description| 15192| -------- | -------- | 15193| style | Pointer to an **OH_Drawing_TypographyStyle** object, which is obtained by calling **OH_Drawing_CreateTypographyStyle**. | 15194| collection | Pointer to an **OH_Drawing_FontCollection** object, which is obtained by calling **OH_Drawing_CreateFontCollection**. | 15195 15196**Returns** 15197 15198Returns the pointer to the **ArkUI_StyledString** object created. If a null pointer is returned, the creation fails. A possible cause is that the application address space is full, or a parameter error, for example, a null pointer for the **style** or **collection** parameter, occurs. 15199 15200 15201### OH_ArkUI_StyledString_CreateTypography() 15202 15203``` 15204OH_Drawing_Typography* OH_ArkUI_StyledString_CreateTypography (ArkUI_StyledString * handle) 15205``` 15206**Description** 15207 15208Creates an **OH_Drawing_Typography** object based on an **ArkUI_StyledString** object. 15209 15210**Since**: 12 15211 15212**Parameters** 15213 15214| Name| Description| 15215| -------- | -------- | 15216| handle | Pointer to an **ArkUI_StyledString** object. | 15217 15218**Returns** 15219 15220Returns the pointer to the **OH_Drawing_Typography** object created. If a null pointer is returned, the creation fails. A possible cause is that a parameter error, for example, a null pointer for the **handle** parameter, occurs. 15221 15222 15223### OH_ArkUI_StyledString_Descriptor_Create() 15224 15225``` 15226ArkUI_StyledString_Descriptor* OH_ArkUI_StyledString_Descriptor_Create (void ) 15227``` 15228**Description** 15229 15230Creates an **ArkUI_StyledString_Descriptor** object. 15231 15232**Since**: 14 15233 15234**Returns** 15235 15236Pointer to an **ArkUI_StyledString_Descriptor** object. 15237 15238 15239### OH_ArkUI_StyledString_Descriptor_Destroy() 15240 15241``` 15242void OH_ArkUI_StyledString_Descriptor_Destroy (ArkUI_StyledString_Descriptor * descriptor) 15243``` 15244**Description** 15245 15246Destroys an **ArkUI_StyledString_Descriptor** object and reclaims the memory occupied by the object. 15247 15248**Since**: 14 15249 15250**Parameters** 15251 15252| Name| Description| 15253| -------- | -------- | 15254| descriptor | Pointer to an **ArkUI_StyledString_Descriptor** object. | 15255 15256 15257### OH_ArkUI_StyledString_Destroy() 15258 15259``` 15260void OH_ArkUI_StyledString_Destroy (ArkUI_StyledString * handle) 15261``` 15262**Description** 15263 15264Destroys an **OH_Drawing_TextStyle** object and reclaims the memory occupied by the object. 15265 15266**Since**: 12 15267 15268**Parameters** 15269 15270| Name| Description| 15271| -------- | -------- | 15272| handle | Pointer to an **ArkUI_StyledString** object. | 15273 15274 15275### OH_ArkUI_StyledString_PopTextStyle() 15276 15277``` 15278void OH_ArkUI_StyledString_PopTextStyle (ArkUI_StyledString * handle) 15279``` 15280**Description** 15281 15282Removes the top style from the current formatted string object. 15283 15284**Since**: 12 15285 15286**Parameters** 15287 15288| Name| Description| 15289| -------- | -------- | 15290| handle | Pointer to an **ArkUI_StyledString** object. | 15291 15292 15293### OH_ArkUI_StyledString_PushTextStyle() 15294 15295``` 15296void OH_ArkUI_StyledString_PushTextStyle (ArkUI_StyledString * handle, OH_Drawing_TextStyle * style ) 15297``` 15298**Description** 15299 15300Sets the new typesetting style to the top of the current format string style stack. 15301 15302**Since**: 12 15303 15304**Parameters** 15305 15306| Name| Description| 15307| -------- | -------- | 15308| handle | Pointer to an **ArkUI_StyledString** object. | 15309| style | Pointer to an **OH_Drawing_TextStyle** object. | 15310 15311 15312### OH_ArkUI_SwipeGesture_GetAngle() 15313 15314``` 15315float OH_ArkUI_SwipeGesture_GetAngle (const ArkUI_GestureEvent * event) 15316``` 15317**Description** 15318 15319Obtains the angle information of the swipe gesture. 15320 15321**Since**: 12 15322 15323**Parameters** 15324 15325| Name| Description| 15326| -------- | -------- | 15327| event | Gesture event. | 15328 15329**Returns** 15330 15331Returns the angle of the swipe gesture, which is the result obtained based on the aforementioned formula. 15332 15333 15334### OH_ArkUI_SwipeGesture_GetVelocity() 15335 15336``` 15337float OH_ArkUI_SwipeGesture_GetVelocity (const ArkUI_GestureEvent * event) 15338``` 15339**Description** 15340 15341Obtains the average velocity of all fingers used in the swipe gesture. 15342 15343**Since**: 12 15344 15345**Parameters** 15346 15347| Name| Description| 15348| -------- | -------- | 15349| event | Gesture event. | 15350 15351**Returns** 15352 15353Returns the average velocity of all fingers used in the swipe gesture, in px/s. 15354 15355 15356### OH_ArkUI_SwiperIndicator_Create() 15357 15358``` 15359ArkUI_SwiperIndicator* OH_ArkUI_SwiperIndicator_Create (ArkUI_SwiperIndicatorType type) 15360``` 15361**Description** 15362 15363Creates a navigation indicator for the Swiper component. 15364 15365**Since**: 12 15366 15367**Parameters** 15368 15369| Name| Description| 15370| -------- | -------- | 15371| type | Type of the navigation indicator. | 15372 15373**Returns** 15374 15375Returns the pointer to the navigation indicator. 15376 15377 15378### OH_ArkUI_SwiperIndicator_Dispose() 15379 15380``` 15381void OH_ArkUI_SwiperIndicator_Dispose (ArkUI_SwiperIndicator * indicator) 15382``` 15383**Description** 15384 15385Disposes of the navigation indicator of this **Swiper** component. 15386 15387**Since**: 12 15388 15389**Parameters** 15390 15391| Name| Description| 15392| -------- | -------- | 15393| indicator | Returns the pointer to the navigation indicator. | 15394 15395 15396### OH_ArkUI_SwiperIndicator_GetBottomPosition() 15397 15398``` 15399float OH_ArkUI_SwiperIndicator_GetBottomPosition (ArkUI_SwiperIndicator * indicator) 15400``` 15401**Description** 15402 15403Obtains the distance between the navigation indicator and the bottom edge of the **Swiper** component. 15404 15405**Since**: 12 15406 15407**Parameters** 15408 15409| Name| Description| 15410| -------- | -------- | 15411| indicator | Returns the pointer to the navigation indicator. | 15412 15413**Returns** 15414 15415Returns the distance between a navigation indicator and the bottom edge of the **Swiper** component. 15416 15417 15418### OH_ArkUI_SwiperIndicator_GetColor() 15419 15420``` 15421uint32_t OH_ArkUI_SwiperIndicator_GetColor (ArkUI_SwiperIndicator * indicator) 15422``` 15423**Description** 15424 15425Obtains the color of a dot-style navigation indicator of the **Swiper** component. 15426 15427**Since**: 12 15428 15429**Parameters** 15430 15431| Name| Description| 15432| -------- | -------- | 15433| indicator | Returns the pointer to the navigation indicator. | 15434 15435**Returns** 15436 15437Returns the color, in 0xARGB format. For example, 0xFFFF0000 indicates red. 15438 15439 15440### OH_ArkUI_SwiperIndicator_GetEndPosition() 15441 15442``` 15443float OH_ArkUI_SwiperIndicator_GetEndPosition (ArkUI_SwiperIndicator * indicator) 15444``` 15445**Description** 15446 15447Obtains the distance between a navigation indicator and the right edge of the **Swiper** component. 15448 15449**Since**: 12 15450 15451**Parameters** 15452 15453| Name| Description| 15454| -------- | -------- | 15455| indicator | Returns the pointer to the navigation indicator. | 15456 15457**Returns** 15458 15459Returns the distance between the navigation indicator and the right edge of the **Swiper** component. 15460 15461 15462### OH_ArkUI_SwiperIndicator_GetItemHeight() 15463 15464``` 15465float OH_ArkUI_SwiperIndicator_GetItemHeight (ArkUI_SwiperIndicator * indicator) 15466``` 15467**Description** 15468 15469Obtains the height of a dot-style navigation indicator of the **Swiper** component. 15470 15471**Since**: 12 15472 15473**Parameters** 15474 15475| Name| Description| 15476| -------- | -------- | 15477| indicator | Returns the pointer to the navigation indicator. | 15478 15479**Returns** 15480 15481Returns the height of the dot-style navigation indicator. 15482 15483 15484### OH_ArkUI_SwiperIndicator_GetItemWidth() 15485 15486``` 15487float OH_ArkUI_SwiperIndicator_GetItemWidth (ArkUI_SwiperIndicator * indicator) 15488``` 15489**Description** 15490 15491Obtains the width of a dot-style navigation indicator of the **Swiper** component. 15492 15493**Since**: 12 15494 15495**Parameters** 15496 15497| Name| Description| 15498| -------- | -------- | 15499| indicator | Returns the pointer to the navigation indicator. | 15500 15501**Returns** 15502 15503Returns the width of the dot-style navigation indicator. 15504 15505 15506### OH_ArkUI_SwiperIndicator_GetMask() 15507 15508``` 15509int32_t OH_ArkUI_SwiperIndicator_GetMask (ArkUI_SwiperIndicator * indicator) 15510``` 15511**Description** 15512 15513Obtains whether the mask is enabled for a dot-style navigation indicator of the **Swiper** component. 15514 15515**Since**: 12 15516 15517**Parameters** 15518 15519| Name| Description| 15520| -------- | -------- | 15521| indicator | Returns the pointer to the navigation indicator. | 15522 15523**Returns** 15524 15525Returns **1** if the mask is enabled; returns **0** otherwise. 15526 15527 15528### OH_ArkUI_SwiperIndicator_GetMaxDisplayCount() 15529 15530``` 15531int32_t OH_ArkUI_SwiperIndicator_GetMaxDisplayCount (ArkUI_SwiperIndicator * indicator) 15532``` 15533**Description** 15534 15535Obtains the maximum number of dots for the dot-style navigation indicator. 15536 15537**Since**: 12 15538 15539**Parameters** 15540 15541| Name| Description| 15542| -------- | -------- | 15543| indicator | Returns the pointer to the navigation indicator. | 15544 15545**Returns** 15546 15547Returns the maximum number of dots. The value ranges from 6 to 9. 15548 15549 15550### OH_ArkUI_SwiperDigitIndicator_Create() 15551 15552``` 15553ArkUI_SwiperDigitIndicator *OH_ArkUI_SwiperDigitIndicator_Create() 15554``` 15555**Description** 15556 15557Creates a digit-style navigation indicator for this **Swiper** component. 15558 15559**Since**: 18 15560 15561**Returns** 15562 15563Returns the pointer to the digit-style navigation indicator. 15564 15565### OH_ArkUI_SwiperDigitIndicator_SetStartPosition() 15566 15567``` 15568void OH_ArkUI_SwiperDigitIndicator_SetStartPosition(ArkUI_SwiperDigitIndicator* indicator, float value) 15569``` 15570**Description** 15571 15572Sets the start position of the digit-style navigation indicator for the **Swiper** component. This determines the distance from the left edge of the **Swiper** component. For right-to-left scripts, this determines the distance from the right edge. 15573 15574**Since**: 18 15575 15576**Parameters** 15577 15578| Name| Description| 15579| -------- | -------- | 15580| indicator | Pointer to a digit-style navigation indicator. | 15581| value | Distance from the left edge of the **Swiper** component. For right-to-left scripts, this indicates the distance from the right edge. | 15582 15583### OH_ArkUI_SwiperDigitIndicator_GetStartPosition() 15584 15585``` 15586float OH_ArkUI_SwiperDigitIndicator_GetStartPosition(ArkUI_SwiperDigitIndicator* indicator) 15587``` 15588**Description** 15589 15590Obtains the start position of the digit-style navigation indicator for the **Swiper** component. This indicates the distance from the left edge of the **Swiper** component. For right-to-left scripts, this indicates the distance from the right edge. 15591 15592**Since**: 18 15593 15594**Parameters** 15595 15596| Name| Description| 15597| -------- | -------- | 15598| indicator | Pointer to a digit-style navigation indicator.| 15599 15600**Returns** 15601 15602Returns the distance from the left edge of the **Swiper** component. For right-to-left scripts, this indicates the distance from the right edge. 15603 15604### OH_ArkUI_SwiperDigitIndicator_SetTopPosition() 15605 15606``` 15607void OH_ArkUI_SwiperDigitIndicator_SetTopPosition(ArkUI_SwiperDigitIndicator* indicator, float value) 15608``` 15609**Description** 15610 15611Sets the distance from the digit-style navigation indicator to the top of the **Swiper** component. 15612 15613**Since**: 18 15614 15615**Parameters** 15616 15617| Name| Description| 15618| -------- | -------- | 15619| indicator | Pointer to a digit-style navigation indicator. | 15620| value | Distance from the digit-style navigation indicator to the top of the **Swiper** component. | 15621 15622### OH_ArkUI_SwiperDigitIndicator_GetTopPosition() 15623 15624``` 15625float OH_ArkUI_SwiperDigitIndicator_GetTopPosition(ArkUI_SwiperDigitIndicator* indicator) 15626``` 15627**Description** 15628 15629Obtains the distance from the digit-style navigation indicator to the top of the **Swiper** component. 15630 15631**Since**: 18 15632 15633**Parameters** 15634 15635| Name| Description| 15636| -------- | -------- | 15637| indicator | Pointer to a digit-style navigation indicator.| 15638 15639**Returns** 15640 15641Returns the distance from the digit-style navigation indicator to the top of the **Swiper** component. 15642 15643### OH_ArkUI_SwiperDigitIndicator_SetEndPosition() 15644 15645``` 15646void OH_ArkUI_SwiperDigitIndicator_SetEndPosition(ArkUI_SwiperDigitIndicator* indicator, float value) 15647``` 15648**Description** 15649 15650Sets the end position of the digit-style navigation indicator for the **Swiper** component. This determines the distance from the right edge of the **Swiper** component. For right-to-left scripts, this determines the distance from the left edge. 15651 15652**Since**: 18 15653 15654**Parameters** 15655 15656| Name| Description| 15657| -------- | -------- | 15658| indicator | Pointer to a digit-style navigation indicator. | 15659| value | Distance from the right edge of the **Swiper** component. For right-to-left scripts, this indicates the distance from the left edge. | 15660 15661### OH_ArkUI_SwiperDigitIndicator_GetEndPosition() 15662 15663``` 15664float OH_ArkUI_SwiperDigitIndicator_GetEndPosition(ArkUI_SwiperDigitIndicator* indicator) 15665``` 15666**Description** 15667 15668Obtains the end position of the digit-style navigation indicator for the **Swiper** component. This indicates the distance from the right edge of the **Swiper** component. For right-to-left scripts, this indicates the distance from the left edge. 15669 15670**Since**: 18 15671 15672**Parameters** 15673 15674| Name| Description| 15675| -------- | -------- | 15676| indicator | Pointer to a digit-style navigation indicator.| 15677 15678**Returns** 15679 15680Returns the distance from the right edge of the **Swiper** component. For right-to-left scripts, this indicates the distance from the left edge. 15681 15682### OH_ArkUI_SwiperDigitIndicator_SetBottomPosition() 15683 15684``` 15685void OH_ArkUI_SwiperDigitIndicator_SetBottomPosition(ArkUI_SwiperDigitIndicator* indicator, float value) 15686``` 15687**Description** 15688 15689Sets the distance from the digit-style navigation indicator to the bottom of the **Swiper** component. 15690 15691**Since**: 18 15692 15693**Parameters** 15694 15695| Name| Description| 15696| -------- | -------- | 15697| indicator | Pointer to a digit-style navigation indicator. | 15698| value | Distance from the digit-style navigation indicator to the bottom of the **Swiper** component. | 15699 15700### OH_ArkUI_SwiperDigitIndicator_GetBottomPosition() 15701 15702``` 15703float OH_ArkUI_SwiperDigitIndicator_GetBottomPosition(ArkUI_SwiperDigitIndicator* indicator) 15704``` 15705**Description** 15706 15707Obtains the distance from the digit-style navigation indicator to the bottom of the **Swiper** component. 15708 15709**Since**: 18 15710 15711**Parameters** 15712 15713| Name| Description| 15714| -------- | -------- | 15715| indicator | Pointer to a digit-style navigation indicator.| 15716 15717**Returns** 15718 15719Returns the distance from the digit-style navigation indicator to the bottom of the **Swiper** component. 15720 15721### OH_ArkUI_SwiperDigitIndicator_SetFontColor() 15722 15723``` 15724void OH_ArkUI_SwiperDigitIndicator_SetFontColor(ArkUI_SwiperDigitIndicator* indicator, uint32_t color) 15725``` 15726**Description** 15727 15728Sets the font color of the digit-style navigation indicator for the **Swiper** component. 15729 15730**Since**: 18 15731 15732**Parameters** 15733 15734| Name| Description| 15735| -------- | -------- | 15736| indicator | Pointer to a digit-style navigation indicator. | 15737| color | Color, in 0xARGB format. For example, 0xFFFF0000 indicates red. | 15738 15739### OH_ArkUI_SwiperDigitIndicator_GetFontColor() 15740 15741``` 15742uint32_t OH_ArkUI_SwiperDigitIndicator_GetFontColor(ArkUI_SwiperDigitIndicator* indicator) 15743``` 15744**Description** 15745 15746Obtains the font color of the digit-style navigation indicator for the **Swiper** component. 15747 15748**Since**: 18 15749 15750**Parameters** 15751 15752| Name| Description| 15753| -------- | -------- | 15754| indicator | Pointer to a digit-style navigation indicator.| 15755 15756**Returns** 15757 15758Returns the color, in 0xARGB format. For example, 0xFFFF0000 indicates red. 15759 15760### OH_ArkUI_SwiperDigitIndicator_SetSelectedFontColor() 15761 15762``` 15763void OH_ArkUI_SwiperDigitIndicator_SetSelectedFontColor(ArkUI_SwiperDigitIndicator* indicator, uint32_t selectedColor) 15764``` 15765**Description** 15766 15767Sets the font color of the selected digit-style navigation indicator for the **Swiper** component. 15768 15769**Since**: 18 15770 15771**Parameters** 15772 15773| Name| Description| 15774| -------- | -------- | 15775| indicator | Pointer to a digit-style navigation indicator. | 15776| selectedColor | Color, in 0xARGB format. For example, 0xFFFF0000 indicates red. | 15777 15778### OH_ArkUI_SwiperDigitIndicator_GetSelectedFontColor() 15779 15780``` 15781uint32_t OH_ArkUI_SwiperDigitIndicator_GetSelectedFontColor(ArkUI_SwiperDigitIndicator* indicator) 15782``` 15783**Description** 15784 15785Obtains the font color of the selected digit-style navigation indicator for the **Swiper** component. 15786 15787**Since**: 18 15788 15789**Parameters** 15790 15791| Name| Description| 15792| -------- | -------- | 15793| indicator | Pointer to a digit-style navigation indicator.| 15794 15795**Returns** 15796 15797Returns the color, in 0xARGB format. For example, 0xFFFF0000 indicates red. 15798 15799### OH_ArkUI_SwiperDigitIndicator_SetFontSize() 15800 15801``` 15802void OH_ArkUI_SwiperDigitIndicator_SetFontSize(ArkUI_SwiperDigitIndicator* indicator, float size) 15803``` 15804**Description** 15805 15806Sets the font size of the digit-style navigation indicator for the **Swiper** component. 15807 15808**Since**: 18 15809 15810**Parameters** 15811 15812| Name| Description| 15813| -------- | -------- | 15814| indicator | Pointer to a digit-style navigation indicator. | 15815| size | Font size, in fp. | 15816 15817### OH_ArkUI_SwiperDigitIndicator_GetFontSize() 15818 15819``` 15820float OH_ArkUI_SwiperDigitIndicator_GetFontSize(ArkUI_SwiperDigitIndicator* indicator) 15821``` 15822**Description** 15823 15824Obtains the font size of the digit-style navigation indicator for the **Swiper** component. 15825 15826**Since**: 18 15827 15828**Parameters** 15829 15830| Name| Description| 15831| -------- | -------- | 15832| indicator | Pointer to a digit-style navigation indicator.| 15833 15834**Returns** 15835 15836Font size, in fp. 15837 15838### OH_ArkUI_SwiperDigitIndicator_SetSelectedFontSize() 15839 15840``` 15841void OH_ArkUI_SwiperDigitIndicator_SetSelectedFontSize(ArkUI_SwiperDigitIndicator* indicator, float size) 15842``` 15843**Description** 15844 15845Sets the font size of the selected digit-style navigation indicator for the **Swiper** component. 15846 15847**Since**: 18 15848 15849**Parameters** 15850 15851| Name| Description| 15852| -------- | -------- | 15853| indicator | Pointer to a digit-style navigation indicator. | 15854| size | Font size, in fp. | 15855 15856### OH_ArkUI_SwiperDigitIndicator_GetSelectedFontSize() 15857 15858``` 15859float OH_ArkUI_SwiperDigitIndicator_GetSelectedFontSize(ArkUI_SwiperDigitIndicator* indicator) 15860``` 15861**Description** 15862 15863Obtains the font size of the selected digit-style navigation indicator for the **Swiper** component. 15864 15865**Since**: 18 15866 15867**Parameters** 15868 15869| Name| Description| 15870| -------- | -------- | 15871| indicator | Pointer to a digit-style navigation indicator.| 15872 15873**Returns** 15874 15875Returns the font size, in fp. 15876 15877### OH_ArkUI_SwiperDigitIndicator_SetFontWeight() 15878 15879``` 15880void OH_ArkUI_SwiperDigitIndicator_SetFontWeight(ArkUI_SwiperDigitIndicator* indicator, ArkUI_FontWeight fontWeight) 15881``` 15882**Description** 15883 15884Sets the font weight of the digit-style navigation indicator for the **Swiper** component. 15885 15886**Since**: 18 15887 15888**Parameters** 15889 15890| Name| Description| 15891| -------- | -------- | 15892| indicator | Pointer to a digit-style navigation indicator. | 15893| fontWeight | Font weight, specified by an enumeration value of [ArkUI_FontWeight](#arkui_fontweight). | 15894 15895### OH_ArkUI_SwiperDigitIndicator_GetFontWeight() 15896 15897``` 15898ArkUI_FontWeight OH_ArkUI_SwiperDigitIndicator_GetFontWeight(ArkUI_SwiperDigitIndicator* indicator) 15899``` 15900**Description** 15901 15902 Obtains the font weight of the digit-style navigation indicator for the **Swiper** component. 15903 15904**Since**: 18 15905 15906**Parameters** 15907 15908| Name| Description| 15909| -------- | -------- | 15910| indicator | Pointer to a digit-style navigation indicator.| 15911 15912**Returns** 15913 15914Returns the font weight, specified by an enumeration value of [ArkUI_FontWeight](#arkui_fontweight). 15915 15916### OH_ArkUI_SwiperDigitIndicator_SetSelectedFontWeight() 15917 15918``` 15919void OH_ArkUI_SwiperDigitIndicator_SetSelectedFontWeight(ArkUI_SwiperDigitIndicator* indicator, ArkUI_FontWeight fontWeight) 15920``` 15921**Description** 15922 15923Sets the font weight of the selected digit-style navigation indicator for the **Swiper** component. 15924 15925**Since**: 18 15926 15927**Parameters** 15928 15929| Name| Description| 15930| -------- | -------- | 15931| indicator | Pointer to a digit-style navigation indicator. | 15932| fontWeight | Font weight, specified by an enumeration value of [ArkUI_FontWeight](#arkui_fontweight). | 15933 15934### OH_ArkUI_SwiperDigitIndicator_GetSelectedFontWeight() 15935 15936``` 15937ArkUI_FontWeight OH_ArkUI_SwiperDigitIndicator_GetSelectedFontWeight(ArkUI_SwiperDigitIndicator* indicator) 15938``` 15939**Description** 15940 15941 Obtains the font weight of the selected digit-style navigation indicator for the **Swiper** component. 15942 15943**Since**: 18 15944 15945**Parameters** 15946 15947| Name| Description| 15948| -------- | -------- | 15949| indicator | Pointer to a digit-style navigation indicator.| 15950 15951**Returns** 15952 15953Returns the font weight, specified by an enumeration value of [ArkUI_FontWeight](#arkui_fontweight). 15954 15955### OH_ArkUI_SwiperDigitIndicator_Dispose 15956 15957``` 15958void OH_ArkUI_SwiperDigitIndicator_Dispose(ArkUI_SwiperDigitIndicator* indicator) 15959``` 15960**Description** 15961 15962Disposes of the digit-style navigation indicator of this **Swiper** component. 15963 15964**Since**: 18 15965 15966**Parameters** 15967 15968| Name| Description| 15969| -------- | -------- | 15970| indicator | Pointer to a digit-style navigation indicator. | 15971 15972### OH_ArkUI_SwiperArrowStyle_Create() 15973 15974``` 15975ArkUI_SwiperArrowStyle *OH_ArkUI_SwiperArrowStyle_Create() 15976``` 15977**Description** 15978 15979Creates an arrow style for the **Swiper** component. 15980 15981**Since**: 18 15982 15983**Returns** 15984 15985Returns the pointer to the arrow object. 15986 15987### OH_ArkUI_SwiperArrowStyle_SetShowBackground() 15988 15989``` 15990void OH_ArkUI_SwiperArrowStyle_SetShowBackground(ArkUI_SwiperArrowStyle *arrowStyle, int32_t showBackground) 15991``` 15992**Description** 15993 15994Sets whether to display the background of the arrow for the **Swiper** component. 15995 15996**Since**: 18 15997 15998**Parameters** 15999 16000| Name| Description| 16001| -------- | -------- | 16002| arrowStyle | Pointer to the arrow object. | 16003| showBackground | Whether to show the arrow background. The value **1** means to show the background, and **0** means the opposite. The default value is **0**. | 16004 16005### OH_ArkUI_SwiperArrowStyle_GetShowBackground() 16006 16007``` 16008int32_t OH_ArkUI_SwiperArrowStyle_GetShowBackground(ArkUI_SwiperArrowStyle* arrowStyle) 16009``` 16010**Description** 16011 16012 Checks whether the background of the arrow is displayed for the **Swiper** component. 16013 16014**Since**: 18 16015 16016**Parameters** 16017 16018| Name| Description| 16019| -------- | -------- | 16020| arrowStyle | Pointer to the arrow object.| 16021 16022**Returns** 16023 16024Returns whether the arrow background is displayed. The value **1** means that the background is displayed, and **0** means the opposite. 16025 16026### OH_ArkUI_SwiperArrowStyle_SetShowSidebarMiddle() 16027 16028``` 16029void OH_ArkUI_SwiperArrowStyle_SetShowSidebarMiddle(ArkUI_SwiperArrowStyle *arrowStyle, int32_t showSidebarMiddle) 16030``` 16031**Description** 16032 16033Sets the position of the arrow for the **Swiper** component. 16034 16035**Since**: 18 16036 16037**Parameters** 16038 16039| Name| Description| 16040| -------- | -------- | 16041| arrowStyle | Pointer to the arrow object. | 16042| showSidebarMiddle | Position of the arrow. **0**: The arrow is displayed on both sides of the navigation indicator. **1**: The arrow is displayed on both sides of the **Swiper** component. The default value is **0**. | 16043 16044### OH_ArkUI_SwiperArrowStyle_GetShowSidebarMiddle() 16045 16046``` 16047int32_t OH_ArkUI_SwiperArrowStyle_GetShowSidebarMiddle(ArkUI_SwiperArrowStyle* arrowStyle) 16048``` 16049**Description** 16050 16051Obtains the position of the arrow for the **Swiper** component. 16052 16053**Since**: 18 16054 16055**Parameters** 16056 16057| Name| Description| 16058| -------- | -------- | 16059| arrowStyle | Pointer to the arrow object.| 16060 16061**Returns** 16062 16063Returns the position of the arrow. **0**: The arrow is displayed on both sides of the navigation indicator. **1**: The arrow is displayed on both sides of the **Swiper** component. 16064 16065### OH_ArkUI_SwiperArrowStyle_SetBackgroundSize() 16066 16067``` 16068void OH_ArkUI_SwiperArrowStyle_SetBackgroundSize(ArkUI_SwiperArrowStyle* arrowStyle, float backgroundSize) 16069``` 16070**Description** 16071 16072Sets the background size for the arrow of the **Swiper** component. 16073 16074**Since**: 18 16075 16076**Parameters** 16077 16078| Name| Description| 16079| -------- | -------- | 16080| arrowStyle | Pointer to the arrow object. | 16081| backgroundSize | Background size of the arrow, in vp. Default value: 24 vp when displayed on both sides of the navigation indicator and 32 vp when displayed on both sides of the **Swiper** component. | 16082 16083### OH_ArkUI_SwiperArrowStyle_GetBackgroundSize() 16084 16085``` 16086float OH_ArkUI_SwiperArrowStyle_GetBackgroundSize(ArkUI_SwiperArrowStyle* arrowStyle) 16087``` 16088**Description** 16089 16090Obtains the background size of the arrow of the **Swiper** component. 16091 16092**Since**: 18 16093 16094**Parameters** 16095 16096| Name| Description| 16097| -------- | -------- | 16098| arrowStyle | Pointer to the arrow object.| 16099 16100**Returns** 16101 16102Returns the background size of the arrow, in vp. 16103 16104### OH_ArkUI_SwiperArrowStyle_SetBackgroundColor() 16105 16106``` 16107void OH_ArkUI_SwiperArrowStyle_SetBackgroundColor(ArkUI_SwiperArrowStyle* arrowStyle, uint32_t backgroundColor) 16108``` 16109**Description** 16110 16111Sets the background color for the arrow of the **Swiper** component. 16112 16113**Since**: 18 16114 16115**Parameters** 16116 16117| Name| Description| 16118| -------- | -------- | 16119| arrowStyle | Pointer to the arrow object. | 16120| backgroundColor | Background color of the arrow, in 0xARGB format. For example, 0xFFFF0000 indicates red. | 16121 16122### OH_ArkUI_SwiperArrowStyle_GetBackgroundColor() 16123 16124``` 16125uint32_t OH_ArkUI_SwiperArrowStyle_GetBackgroundColor(ArkUI_SwiperArrowStyle* arrowStyle) 16126``` 16127**Description** 16128 16129Obtains the background color for the arrow of the **Swiper** component. 16130 16131**Since**: 18 16132 16133**Parameters** 16134 16135| Name| Description| 16136| -------- | -------- | 16137| arrowStyle | Pointer to the arrow object.| 16138 16139**Returns** 16140 16141Returns the background color of the arrow, in 0xARGB format. For example, 0xFFFF0000 indicates red. 16142 16143### OH_ArkUI_SwiperArrowStyle_SetArrowSize() 16144 16145``` 16146void OH_ArkUI_SwiperArrowStyle_SetArrowSize(ArkUI_SwiperArrowStyle* arrowStyle, float arrowSize) 16147``` 16148**Description** 16149 16150Sets the size for the arrow of the **Swiper** component. 16151 16152**Since**: 18 16153 16154**Parameters** 16155 16156| Name| Description| 16157| -------- | -------- | 16158| arrowStyle | Pointer to the arrow object. | 16159| arrowSize | Size of the arrow, in vp. Default value: 18 vp when displayed on both sides of the navigation indicator and 24 vp when displayed on both sides of the **Swiper** component. When the arrow background is displayed, the value of **arrowSize** is fixed at 3/4 of the value of **backgroundSize**.| 16160 16161### OH_ArkUI_SwiperArrowStyle_GetArrowSize() 16162 16163``` 16164float OH_ArkUI_SwiperArrowStyle_GetArrowSize(ArkUI_SwiperArrowStyle* arrowStyle) 16165``` 16166**Description** 16167 16168Obtains the size of the arrow of the **Swiper** component. 16169 16170**Since**: 18 16171 16172**Parameters** 16173 16174| Name| Description| 16175| -------- | -------- | 16176| arrowStyle | Pointer to the arrow object.| 16177 16178**Returns** 16179 16180Returns the size of the arrow, in vp. 16181 16182### OH_ArkUI_SwiperArrowStyle_SetArrowColor() 16183 16184``` 16185void OH_ArkUI_SwiperArrowStyle_SetArrowColor(ArkUI_SwiperArrowStyle* arrowStyle, uint32_t arrowColor) 16186``` 16187**Description** 16188 16189Sets the color for the arrow of the **Swiper** component. 16190 16191**Since**: 18 16192 16193**Parameters** 16194 16195| Name| Description| 16196| -------- | -------- | 16197| arrowStyle | Pointer to the arrow object. | 16198| arrowColor | Color of the arrow, in 0xARGB format. For example, 0xFFFF0000 indicates red.| 16199 16200### OH_ArkUI_SwiperArrowStyle_GetArrowColor() 16201 16202``` 16203uint32_t OH_ArkUI_SwiperArrowStyle_GetArrowColor(ArkUI_SwiperArrowStyle* arrowStyle) 16204``` 16205**Description** 16206 16207Obtains the color of the arrow of the **Swiper** component. 16208 16209**Since**: 18 16210 16211**Parameters** 16212 16213| Name| Description| 16214| -------- | -------- | 16215| arrowStyle | Pointer to the arrow object.| 16216 16217**Returns** 16218 16219Returns the color of the arrow, in 0xARGB format. For example, 0xFFFF0000 indicates red. 16220 16221### OH_ArkUI_SwiperArrowStyle_Dispose 16222 16223``` 16224void OH_ArkUI_SwiperArrowStyle_Dispose(ArkUI_SwiperArrowStyle* arrowStyle) 16225``` 16226**Description** 16227 16228Disposes of the arrow of the **Swiper** component. 16229 16230**Since**: 18 16231 16232**Parameters** 16233 16234| Name| Description| 16235| -------- | -------- | 16236| arrowStyle | Pointer to the arrow object. | 16237 16238### OH_ArkUI_SwiperIndicator_GetSelectedColor() 16239 16240``` 16241uint32_t OH_ArkUI_SwiperIndicator_GetSelectedColor (ArkUI_SwiperIndicator * indicator) 16242``` 16243**Description** 16244 16245Obtains the color of the selected dot-style navigation indicator of the **Swiper** component. 16246 16247**Since**: 12 16248 16249**Parameters** 16250 16251| Name| Description| 16252| -------- | -------- | 16253| indicator | Returns the pointer to the navigation indicator. | 16254 16255**Returns** 16256 16257Returns the color, in 0xARGB format. For example, 0xFFFF0000 indicates red. 16258 16259 16260### OH_ArkUI_SwiperIndicator_GetSelectedItemHeight() 16261 16262``` 16263float OH_ArkUI_SwiperIndicator_GetSelectedItemHeight (ArkUI_SwiperIndicator * indicator) 16264``` 16265**Description** 16266 16267Obtains the height of the selected dot-style navigation indicator of the **Swiper** component. 16268 16269**Since**: 12 16270 16271**Parameters** 16272 16273| Name| Description| 16274| -------- | -------- | 16275| indicator | Returns the pointer to the navigation indicator. | 16276 16277**Returns** 16278 16279Returns the height of the dot-style navigation indicator. 16280 16281 16282### OH_ArkUI_SwiperIndicator_GetSelectedItemWidth() 16283 16284``` 16285float OH_ArkUI_SwiperIndicator_GetSelectedItemWidth (ArkUI_SwiperIndicator * indicator) 16286``` 16287**Description** 16288 16289Obtains the width of the selected dot-style navigation indicator of the **Swiper** component. 16290 16291**Since**: 12 16292 16293**Parameters** 16294 16295| Name| Description| 16296| -------- | -------- | 16297| indicator | Returns the pointer to the navigation indicator. | 16298 16299**Returns** 16300 16301Returns the width of the dot-style navigation indicator. 16302 16303 16304### OH_ArkUI_SwiperIndicator_GetStartPosition() 16305 16306``` 16307float OH_ArkUI_SwiperIndicator_GetStartPosition (ArkUI_SwiperIndicator * indicator) 16308``` 16309**Description** 16310 16311Obtains the distance between a navigation indicator and the left edge of the **Swiper** component. 16312 16313**Since**: 12 16314 16315**Parameters** 16316 16317| Name| Description| 16318| -------- | -------- | 16319| indicator | Returns the pointer to the navigation indicator. | 16320 16321**Returns** 16322 16323Returns the distance between the navigation indicator and the left edge of the **Swiper** component. 16324 16325 16326### OH_ArkUI_SwiperIndicator_GetTopPosition() 16327 16328``` 16329float OH_ArkUI_SwiperIndicator_GetTopPosition (ArkUI_SwiperIndicator * indicator) 16330``` 16331**Description** 16332 16333Obtains the distance between the navigation indicator and the top edge of the **Swiper** component. 16334 16335**Since**: 12 16336 16337**Parameters** 16338 16339| Name| Description| 16340| -------- | -------- | 16341| indicator | Returns the pointer to the navigation indicator. | 16342 16343**Returns** 16344 16345Returns the distance between a navigation indicator and the top edge of the **Swiper** component. 16346 16347 16348### OH_ArkUI_SwiperIndicator_SetBottomPosition() 16349 16350``` 16351void OH_ArkUI_SwiperIndicator_SetBottomPosition (ArkUI_SwiperIndicator * indicator, float value ) 16352``` 16353**Description** 16354 16355Sets the distance between the navigation indicator and the bottom edge of the **Swiper** component. 16356 16357**Since**: 12 16358 16359**Parameters** 16360 16361| Name| Description| 16362| -------- | -------- | 16363| indicator | Pointer to a navigation indicator. | 16364| value | Distance between a navigation indicator and the bottom edge of the **Swiper** component. | 16365 16366 16367### OH_ArkUI_SwiperIndicator_SetColor() 16368 16369``` 16370void OH_ArkUI_SwiperIndicator_SetColor (ArkUI_SwiperIndicator * indicator, uint32_t color ) 16371``` 16372**Description** 16373 16374Sets the color of a dot-style navigation indicator for the **Swiper** component. 16375 16376**Since**: 12 16377 16378**Parameters** 16379 16380| Name| Description| 16381| -------- | -------- | 16382| indicator | Returns the pointer to the navigation indicator. | 16383| color | Color, in 0xARGB format. For example, 0xFFFF0000 indicates red. | 16384 16385 16386### OH_ArkUI_SwiperIndicator_SetEndPosition() 16387 16388``` 16389void OH_ArkUI_SwiperIndicator_SetEndPosition (ArkUI_SwiperIndicator * indicator, float value ) 16390``` 16391**Description** 16392 16393Distance between the navigation indicator and the left edge of the **Swiper** component. 16394 16395**Since**: 12 16396 16397**Parameters** 16398 16399| Name| Description| 16400| -------- | -------- | 16401| indicator | Pointer to a navigation indicator. | 16402| value | Returns the distance between the navigation indicator and the right edge of the **Swiper** component. | 16403 16404 16405### OH_ArkUI_SwiperIndicator_SetItemHeight() 16406 16407``` 16408void OH_ArkUI_SwiperIndicator_SetItemHeight (ArkUI_SwiperIndicator * indicator, float value ) 16409``` 16410**Description** 16411 16412Sets the height of a dot-style navigation indicator for the **Swiper** component. 16413 16414**Since**: 12 16415 16416**Parameters** 16417 16418| Name| Description| 16419| -------- | -------- | 16420| indicator | Pointer to a navigation indicator. | 16421| value | Returns the height of the dot-style navigation indicator. | 16422 16423 16424### OH_ArkUI_SwiperIndicator_SetItemWidth() 16425 16426``` 16427void OH_ArkUI_SwiperIndicator_SetItemWidth (ArkUI_SwiperIndicator * indicator, float value ) 16428``` 16429**Description** 16430 16431Sets the width of a dot-style navigation indicator for the **Swiper** component. 16432 16433**Since**: 12 16434 16435**Parameters** 16436 16437| Name| Description| 16438| -------- | -------- | 16439| indicator | Pointer to a navigation indicator. | 16440| value | Returns the width of the dot-style navigation indicator. | 16441 16442 16443### OH_ArkUI_SwiperIndicator_SetMask() 16444 16445``` 16446void OH_ArkUI_SwiperIndicator_SetMask (ArkUI_SwiperIndicator * indicator, int32_t mask ) 16447``` 16448**Description** 16449 16450Sets whether to enable the mask for a dot-style navigation indicator for the **Swiper** component. 16451 16452**Since**: 12 16453 16454**Parameters** 16455 16456| Name| Description| 16457| -------- | -------- | 16458| indicator | Pointer to a navigation indicator. | 16459| mask | Whether to enable the mask. The value **1** means to enable the mask, and **0** means the opposite. | 16460 16461 16462### OH_ArkUI_SwiperIndicator_SetMaxDisplayCount() 16463 16464``` 16465int32_t OH_ArkUI_SwiperIndicator_SetMaxDisplayCount (ArkUI_SwiperIndicator * indicator, int32_t maxDisplayCount ) 16466``` 16467**Description** 16468 16469Sets the maximum number of dots for the dot-style navigation indicator. 16470 16471**Since**: 12 16472 16473**Parameters** 16474 16475| Name| Description| 16476| -------- | -------- | 16477| indicator | Pointer to a navigation indicator. | 16478| maxDisplayCount | Maximum number of navigation points. The value ranges from 6 to 9. | 16479 16480**Returns** 16481 16482Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if **maxDisplayCount** is set to an invalid value. 16483 16484 16485### OH_ArkUI_SwiperIndicator_SetSelectedColor() 16486 16487``` 16488void OH_ArkUI_SwiperIndicator_SetSelectedColor (ArkUI_SwiperIndicator * indicator, uint32_t selectedColor ) 16489``` 16490**Description** 16491 16492Sets the color of the selected dot-style navigation indicator for the **Swiper** component. 16493 16494**Since**: 12 16495 16496**Parameters** 16497 16498| Name| Description| 16499| -------- | -------- | 16500| indicator | Pointer to a navigation indicator. | 16501| selectedColor | Color, in 0xARGB format. For example, 0xFFFF0000 indicates red. | 16502 16503 16504### OH_ArkUI_SwiperIndicator_SetSelectedItemHeight() 16505 16506``` 16507void OH_ArkUI_SwiperIndicator_SetSelectedItemHeight (ArkUI_SwiperIndicator * indicator, float value ) 16508``` 16509**Description** 16510 16511Sets the height of the selected dot-style navigation indicator for the **Swiper** component. 16512 16513**Since**: 12 16514 16515**Parameters** 16516 16517| Name| Description| 16518| -------- | -------- | 16519| indicator | Pointer to a navigation indicator. | 16520| value | Height of the dot-style navigation indicator. | 16521 16522 16523### OH_ArkUI_SwiperIndicator_SetSelectedItemWidth() 16524 16525``` 16526void OH_ArkUI_SwiperIndicator_SetSelectedItemWidth (ArkUI_SwiperIndicator * indicator, float value ) 16527``` 16528**Description** 16529 16530Sets the width of the selected dot-style navigation indicator for the **Swiper** component. 16531 16532**Since**: 12 16533 16534**Parameters** 16535 16536| Name| Description| 16537| -------- | -------- | 16538| indicator | Pointer to a navigation indicator. | 16539| value | Width of the dot-style navigation indicator. | 16540 16541 16542### OH_ArkUI_SwiperIndicator_SetStartPosition() 16543 16544``` 16545void OH_ArkUI_SwiperIndicator_SetStartPosition (ArkUI_SwiperIndicator * indicator, float value ) 16546``` 16547**Description** 16548 16549Sets the distance between the navigation indicator and the left edge of the **Swiper** component. 16550 16551**Since**: 12 16552 16553**Parameters** 16554 16555| Name| Description| 16556| -------- | -------- | 16557| indicator | Pointer to a navigation indicator. | 16558| value | Distance between the navigation indicator and the left edge of the **Swiper** component. | 16559 16560 16561### OH_ArkUI_SwiperIndicator_SetTopPosition() 16562 16563``` 16564void OH_ArkUI_SwiperIndicator_SetTopPosition (ArkUI_SwiperIndicator * indicator, float value ) 16565``` 16566**Description** 16567 16568Sets the distance between the navigation indicator and the top edge of the **Swiper** component. 16569 16570**Since**: 12 16571 16572**Parameters** 16573 16574| Name| Description| 16575| -------- | -------- | 16576| indicator | Pointer to a navigation indicator. | 16577| value | Distance between a navigation indicator and the top edge of the **Swiper** component. | 16578 16579 16580### OH_ArkUI_SystemFontStyleEvent_GetFontSizeScale() 16581 16582``` 16583float OH_ArkUI_SystemFontStyleEvent_GetFontSizeScale (const ArkUI_SystemFontStyleEvent * event) 16584``` 16585**Description** 16586 16587Obtains the font size scale from the system font style change event. 16588 16589**Since**: 12 16590 16591**Parameters** 16592 16593| Name| Description| 16594| -------- | -------- | 16595| event | Pointer to the current system font style change event. | 16596 16597**Returns** 16598 16599Returns the font size scale after the change. Default value: **1.0**. 16600 16601 16602### OH_ArkUI_SystemFontStyleEvent_GetFontWeightScale() 16603 16604``` 16605float OH_ArkUI_SystemFontStyleEvent_GetFontWeightScale (const ArkUI_SystemFontStyleEvent * event) 16606``` 16607**Description** 16608 16609Obtains the font weight scale from the system font style change event. 16610 16611**Since**: 12 16612 16613**Parameters** 16614 16615| Name| Description| 16616| -------- | -------- | 16617| event | Pointer to the current system font style change event. | 16618 16619**Returns** 16620 16621Returns the font weight scale after the change. Default value: **1.0**. 16622 16623 16624### OH_ArkUI_TransitionEffect_Combine() 16625 16626``` 16627int32_t OH_ArkUI_TransitionEffect_Combine (ArkUI_TransitionEffect * option, ArkUI_TransitionEffect * combine ) 16628``` 16629**Description** 16630 16631Sets a combination of transition effects. 16632 16633**Since**: 12 16634 16635**Parameters** 16636 16637| Name| Description| 16638| -------- | -------- | 16639| option | Transition effect options. | 16640| combine | Combination of transition effects. | 16641 16642**Returns** 16643 16644Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 16645 16646 16647### OH_ArkUI_TransitionEffect_Dispose() 16648 16649``` 16650void OH_ArkUI_TransitionEffect_Dispose (ArkUI_TransitionEffect * option) 16651``` 16652**Description** 16653 16654Destroys a transition effect object. 16655 16656**Since**: 12 16657 16658**Parameters** 16659 16660| Name| Description| 16661| -------- | -------- | 16662| option | Transition effect object. | 16663 16664 16665### OH_ArkUI_TransitionEffect_SetAnimation() 16666 16667``` 16668int32_t OH_ArkUI_TransitionEffect_SetAnimation (ArkUI_TransitionEffect * option, ArkUI_AnimateOption * animation ) 16669``` 16670**Description** 16671 16672Sets transition effect animation settings. 16673 16674**Since**: 12 16675 16676**Parameters** 16677 16678| Name| Description| 16679| -------- | -------- | 16680| option | Transition effect options. | 16681| animation | Animation settings. | 16682 16683**NOTE** 16684 16685If **combine** is used for combining transition effects, the animation settings of a transition effect are applicable to the one following it. 16686 16687**Returns** 16688 16689Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 16690 16691 16692### OH_ArkUI_UnmarshallStyledStringDescriptor() 16693 16694``` 16695int32_t OH_ArkUI_UnmarshallStyledStringDescriptor (uint8_t * buffer, size_t bufferSize, ArkUI_StyledString_Descriptor * descriptor, size_t * resultSize ) 16696``` 16697**Description** 16698 16699Deserializes a byte array containing styled string information into a styled string. 16700 16701**Since**: 14 16702 16703**Parameters** 16704 16705| Name| Description| 16706| -------- | -------- | 16707| buffer | Byte array to be deserialized. | 16708| bufferSize | Length of the byte array. | 16709| descriptor | Pointer to an **ArkUI_StyledString_Descriptor** object. | 16710| resultSize | Actual length of the resulting byte array after deserialization. | 16711 16712**Returns** 16713 16714Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 16715 16716 16717### OH_ArkUI_UnregisterSystemColorModeChangeEvent() 16718 16719``` 16720void OH_ArkUI_UnregisterSystemColorModeChangeEvent (ArkUI_NodeHandle node) 16721``` 16722**Description** 16723 16724Unregisters the event listener for system color mode changes. 16725 16726**Since**: 12 16727 16728**Parameters** 16729 16730| Name| Description| 16731| -------- | -------- | 16732| node | Specified node. | 16733 16734 16735### OH_ArkUI_UnregisterSystemFontStyleChangeEvent() 16736 16737``` 16738void OH_ArkUI_UnregisterSystemFontStyleChangeEvent (ArkUI_NodeHandle node) 16739``` 16740**Description** 16741 16742Unregisters the event listener for system font style changes. 16743 16744**Since**: 12 16745 16746**Parameters** 16747 16748| Name| Description| 16749| -------- | -------- | 16750| node | Specified node. | 16751 16752 16753### OH_ArkUI_WaterFlowSectionOption_Create() 16754 16755``` 16756ArkUI_WaterFlowSectionOption* OH_ArkUI_WaterFlowSectionOption_Create () 16757``` 16758**Description** 16759 16760Creates a water flow section configuration. 16761 16762**Since**: 12 16763 16764**Returns** 16765 16766Return the pointer to the created water flow section configuration. 16767 16768 16769### OH_ArkUI_WaterFlowSectionOption_Dispose() 16770 16771``` 16772void OH_ArkUI_WaterFlowSectionOption_Dispose (ArkUI_WaterFlowSectionOption * option) 16773``` 16774**Description** 16775 16776Disposes of the pointer to a water flow section configuration. 16777 16778**Since**: 12 16779 16780**Parameters** 16781 16782| Name| Description| 16783| -------- | -------- | 16784| option | Pointer to a water flow section configuration. | 16785 16786 16787### OH_ArkUI_WaterFlowSectionOption_GetColumnGap() 16788 16789``` 16790float OH_ArkUI_WaterFlowSectionOption_GetColumnGap (ArkUI_WaterFlowSectionOption * option, int32_t index ) 16791``` 16792**Description** 16793 16794Obtains the gap between columns in the water flow section that matches the specified index. 16795 16796**Since**: 12 16797 16798**Parameters** 16799 16800| Name| Description| 16801| -------- | -------- | 16802| option | Pointer to a water flow section configuration. | 16803| index | Index of the target water flow section. | 16804 16805**Returns** 16806 16807Returns the gap between columns. 16808 16809 16810### OH_ArkUI_WaterFlowSectionOption_GetCrossCount() 16811 16812``` 16813int32_t OH_ArkUI_WaterFlowSectionOption_GetCrossCount (ArkUI_WaterFlowSectionOption * option, int32_t index ) 16814``` 16815**Description** 16816 16817Obtains the number of columns (in a vertical layout) or rows (in a horizontal layout) of a water flow. 16818 16819**Since**: 12 16820 16821**Parameters** 16822 16823| Name| Description| 16824| -------- | -------- | 16825| option | Pointer to a water flow section configuration. | 16826| index | Index of the target water flow section. | 16827 16828**Returns** 16829 16830Returns the number of columns (in a vertical layout) or rows (in a horizontal layout) of a water flow. 16831 16832 16833### OH_ArkUI_WaterFlowSectionOption_GetItemCount() 16834 16835``` 16836int32_t OH_ArkUI_WaterFlowSectionOption_GetItemCount (ArkUI_WaterFlowSectionOption * option, int32_t index ) 16837``` 16838**Description** 16839 16840Obtains the number of items in the water flow section that matches the specified index. 16841 16842**Since**: 12 16843 16844**Parameters** 16845 16846| Name| Description| 16847| -------- | -------- | 16848| option | Pointer to a water flow section configuration. | 16849| index | Index of the target water flow section. | 16850 16851**Returns** 16852 16853Returns the number of items in the water flow section. 16854 16855 16856### OH_ArkUI_WaterFlowSectionOption_GetMargin() 16857 16858``` 16859ArkUI_Margin OH_ArkUI_WaterFlowSectionOption_GetMargin (ArkUI_WaterFlowSectionOption * option, int32_t index ) 16860``` 16861**Description** 16862 16863Obtains the margins of the water flow section that matches the specified index. 16864 16865**Since**: 12 16866 16867**Parameters** 16868 16869| Name| Description| 16870| -------- | -------- | 16871| option | Pointer to a water flow section configuration. | 16872| index | Index of the target water flow section. | 16873 16874**Returns** 16875 16876Returns the margins. 16877 16878 16879### OH_ArkUI_WaterFlowSectionOption_GetRowGap() 16880 16881``` 16882float OH_ArkUI_WaterFlowSectionOption_GetRowGap (ArkUI_WaterFlowSectionOption * option, int32_t index ) 16883``` 16884**Description** 16885 16886Obtains the gap between rows in the water flow section that matches the specified index. 16887 16888**Since**: 12 16889 16890**Parameters** 16891 16892| Name| Description| 16893| -------- | -------- | 16894| option | Pointer to a water flow section configuration. | 16895| index | Index of the target water flow section. | 16896 16897**Returns** 16898 16899Returns the gap between rows. 16900 16901 16902### OH_ArkUI_WaterFlowSectionOption_GetSize() 16903 16904``` 16905int32_t OH_ArkUI_WaterFlowSectionOption_GetSize (ArkUI_WaterFlowSectionOption * option) 16906``` 16907**Description** 16908 16909Sets the array length for a water flow section configuration. 16910 16911**Since**: 12 16912 16913**Parameters** 16914 16915| Name| Description| 16916| -------- | -------- | 16917| option | Pointer to a water flow section configuration. | 16918 16919**Returns** 16920 16921Returns the array length. If **-1** is returned, an error code indicating failure is returned. The possible cause is that the **option** parameter is abnormal, for example, a null pointer. 16922 16923 16924### OH_ArkUI_WaterFlowSectionOption_RegisterGetItemMainSizeCallbackByIndex() 16925 16926``` 16927void OH_ArkUI_WaterFlowSectionOption_RegisterGetItemMainSizeCallbackByIndex (ArkUI_WaterFlowSectionOption * option, int32_t index, float(*)(int32_t itemIndex) callback ) 16928``` 16929**Description** 16930 16931Obtains the main axis size of a specified item based on **flowItemIndex** through a water flow section configuration. 16932 16933**Since**: 12 16934 16935**Parameters** 16936 16937| Name| Description| 16938| -------- | -------- | 16939| option | Pointer to a water flow section configuration. | 16940| index | Index of the target water flow section. | 16941| callback | Callback used to return the result. | 16942 16943 16944### OH_ArkUI_WaterFlowSectionOption_RegisterGetItemMainSizeCallbackByIndexWithUserData() 16945 16946``` 16947void OH_ArkUI_WaterFlowSectionOption_RegisterGetItemMainSizeCallbackByIndexWithUserData (ArkUI_WaterFlowSectionOption * option, int32_t index, void * userData, float(*)(int32_t itemIndex, void *userData) callback ) 16948``` 16949**Description** 16950 16951Obtains the main axis size of a specified item based on **flowItemIndex** through a water flow section configuration. 16952 16953**Since**: 12 16954 16955**Parameters** 16956 16957| Name| Description| 16958| -------- | -------- | 16959| option | Pointer to a water flow section configuration. | 16960| index | Index of the target water flow section. | 16961| userData | Custom data of the water flow item. | 16962| callback | Callback used to return the result. | 16963 16964 16965### OH_ArkUI_WaterFlowSectionOption_SetColumnGap() 16966 16967``` 16968void OH_ArkUI_WaterFlowSectionOption_SetColumnGap (ArkUI_WaterFlowSectionOption * , int32_t index, float columnGap ) 16969``` 16970**Description** 16971 16972Sets the gap between columns in the specified water flow section. 16973 16974**Since**: 12 16975 16976**Parameters** 16977 16978| Name| Description| 16979| -------- | -------- | 16980| option | Pointer to a water flow section configuration. | 16981| index | Index of the target water flow section. | 16982| columnGap | Gap between columns. | 16983 16984 16985### OH_ArkUI_WaterFlowSectionOption_SetCrossCount() 16986 16987``` 16988void OH_ArkUI_WaterFlowSectionOption_SetCrossCount (ArkUI_WaterFlowSectionOption * option, int32_t index, int32_t crossCount ) 16989``` 16990**Description** 16991 16992Sets the number of columns (in a vertical layout) or rows (in a horizontal layout) of a water flow. 16993 16994**Since**: 12 16995 16996**Parameters** 16997 16998| Name| Description| 16999| -------- | -------- | 17000| option | Pointer to a water flow section configuration. | 17001| index | Index of the target water flow section. | 17002| crossCount | Number of columns or rows, depending on the layout direction. | 17003 17004 17005### OH_ArkUI_WaterFlowSectionOption_SetItemCount() 17006 17007``` 17008void OH_ArkUI_WaterFlowSectionOption_SetItemCount (ArkUI_WaterFlowSectionOption * option, int32_t index, int32_t itemCount ) 17009``` 17010**Description** 17011 17012Sets the number of items in a water flow section. 17013 17014**Since**: 12 17015 17016**Parameters** 17017 17018| Name| Description| 17019| -------- | -------- | 17020| option | Pointer to a water flow section configuration. | 17021| index | Index of the target water flow section. | 17022| itemCount | Number of items in the water flow section. | 17023 17024 17025### OH_ArkUI_WaterFlowSectionOption_SetMargin() 17026 17027``` 17028void OH_ArkUI_WaterFlowSectionOption_SetMargin (ArkUI_WaterFlowSectionOption * option, int32_t index, float marginTop, float marginRight, float marginBottom, float marginLeft ) 17029``` 17030**Description** 17031 17032Sets the margins for the specified water flow section. 17033 17034**Since**: 12 17035 17036**Parameters** 17037 17038| Name| Description| 17039| -------- | -------- | 17040| option | Pointer to a water flow section configuration. | 17041| index | Index of the target water flow section. | 17042| marginTop | Top margin of the water flow section. | 17043| marginRight | Right margin of the water flow section. | 17044| marginBottom | Bottom margin of the water flow section. | 17045| marginLeft | Left margin of the water flow section. | 17046 17047 17048### OH_ArkUI_WaterFlowSectionOption_SetRowGap() 17049 17050``` 17051void OH_ArkUI_WaterFlowSectionOption_SetRowGap (ArkUI_WaterFlowSectionOption * option, int32_t index, float rowGap ) 17052``` 17053**Description** 17054 17055Sets the gap between rows in the specified water flow section. 17056 17057**Since**: 12 17058 17059**Parameters** 17060 17061| Name| Description| 17062| -------- | -------- | 17063| option | Pointer to a water flow section configuration. | 17064| index | Index of the target water flow section. | 17065| rowGap | Gap between rows to set. | 17066 17067 17068### OH_ArkUI_WaterFlowSectionOption_SetSize() 17069 17070``` 17071void OH_ArkUI_WaterFlowSectionOption_SetSize (ArkUI_WaterFlowSectionOption * option, int32_t size ) 17072``` 17073**Description** 17074 17075Sets the array length for a water flow section configuration. 17076 17077**Since**: 12 17078 17079**Parameters** 17080 17081| Name| Description| 17082| -------- | -------- | 17083| option | Pointer to a water flow section configuration. | 17084| size | Size of the array. | 17085 17086 17087### OH_ArkUI_PostFrameCallback() 17088 17089``` 17090int32_t OH_ArkUI_PostFrameCallback(ArkUI_ContextHandle uiContext, void* userData, void (*callback)(uint64_t nanoTimestamp, uint32_t frameCount, void* userData)) 17091``` 17092**Description** 17093 17094Registers a callback to be executed after the next frame is rendered. This callback must not be called from a non-UI thread. The application will abort if a non-UI thread call is detected. 17095 17096**Since**: 16 17097 17098**Parameters** 17099 17100| Name| Description| 17101| -------- | -------- | 17102| uiContext | UI context object used to bind the instance.| 17103| userData | Custom event parameter, which is passed in the callback when the event is triggered.| 17104| callback | Custom callback to be invoked after the next frame event completes.| 17105| nanoTimestamp | Timestamp of the frame signal.| 17106| frameCount | Frame number.| 17107 17108**Returns** 17109 17110Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17111Returns **ARKUI_ERROR_CODE_CAPI_INIT_ERROR** if there is an API initialization error. 17112Returns **ARKUI_ERROR_CODE_UI_CONTEXT_INVALID** if the UIContext object is invalid. 17113Returns **ARKUI_ERROR_CODE_CALLBACK_INVALID** if the callback is invalid. 17114 17115 17116### OH_ArkUI_RegisterLayoutCallbackOnNodeHandle() 17117 17118``` 17119int32_t OH_ArkUI_RegisterLayoutCallbackOnNodeHandle (ArkUI_NodeHandle node, void* userData, void (*onLayoutCompleted)(void* userData)) 17120``` 17121**Description** 17122 17123Registers a layout completion callback function for a specific component. Only one layout completion callback can be registered per component. 17124 17125**Since**: 16 17126 17127**Parameters** 17128 17129| Name| Description| 17130| -------- | -------- | 17131| node | Specified node. | 17132| userData | Custom event parameter, which is passed in the callback when the event is triggered. | 17133| onLayoutCompleted | Callback to be executed when the event is triggered. | 17134 17135**Returns** 17136 17137Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17138Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17139 17140 17141### OH_ArkUI_RegisterDrawCallbackOnNodeHandle() 17142 17143``` 17144int32_t OH_ArkUI_RegisterDrawCallbackOnNodeHandle (ArkUI_NodeHandle node, void* userData, void (*onDrawCompleted)(void* userData)) 17145``` 17146**Description** 17147 17148Registers a drawing completion callback function for a specific component. Only one drawing completion callback can be registered per component. 17149 17150**Since**: 16 17151 17152**Parameters** 17153 17154| Name| Description| 17155| -------- | -------- | 17156| node | Specified node. | 17157| userData | Custom event parameter, which is passed in the callback when the event is triggered. | 17158| onDrawCompleted | Callback to be executed when the event is triggered. | 17159 17160**Returns** 17161 17162Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17163Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17164 17165 17166### OH_ArkUI_UnregisterLayoutCallbackOnNodeHandle() 17167 17168``` 17169int32_t OH_ArkUI_UnregisterLayoutCallbackOnNodeHandle (ArkUI_NodeHandle node) 17170``` 17171**Description** 17172 17173Unregisters the layout completion callback function for a specific component. 17174 17175**Since**: 16 17176 17177**Parameters** 17178 17179| Name| Description| 17180| -------- | -------- | 17181| node | Specified node. | 17182 17183**Returns** 17184 17185Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17186Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17187 17188 17189### OH_ArkUI_UnregisterDrawCallbackOnNodeHandle() 17190 17191``` 17192int32_t OH_ArkUI_UnregisterDrawCallbackOnNodeHandle (ArkUI_NodeHandle node) 17193``` 17194**Description** 17195 17196Unregisters the drawing completion callback function for a specific component. 17197 17198**Since**: 16 17199 17200**Parameters** 17201 17202| Name| Description| 17203| -------- | -------- | 17204| node | Specified node. | 17205 17206**Returns** 17207 17208Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17209Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17210 17211 17212### OH_ArkUI_ProgressLinearStyleOption_Create 17213 17214``` 17215ArkUI_ProgressLinearStyleOption* OH_ArkUI_ProgressLinearStyleOption_Create(void) 17216``` 17217**Description** 17218 17219Creates a **ProgressLinearStyleOption** instance. 17220 17221**Since**: 15 17222 17223**Returns** 17224 17225Returns the **ProgressLinearStyleOption** instance created. 17226 17227 17228### OH_ArkUI_ProgressLinearStyleOption_Destroy 17229 17230``` 17231void OH_ArkUI_ProgressLinearStyleOption_Destroy(ArkUI_ProgressLinearStyleOption* option) 17232``` 17233**Description** 17234 17235Destroys a **ProgressLinearStyleOption** instance. 17236 17237**Since**: 15 17238 17239**Parameters** 17240 17241| Name| Description| 17242| -------- | -------- | 17243| option | **ProgressLinearStyleOption** instance to destroy. | 17244 17245 17246### OH_ArkUI_ProgressLinearStyleOption_SetScanEffectEnabled 17247 17248``` 17249void OH_ArkUI_ProgressLinearStyleOption_SetSmoothEffectEnabled(ArkUI_ProgressLinearStyleOption* option, bool enabled) 17250``` 17251**Description** 17252 17253Sets whether to enable the scan effect. 17254 17255**Since**: 15 17256 17257 17258**Parameters** 17259 17260| Name| Description| 17261| -------- | -------- | 17262| option | Pointer to the **ProgressLinearStyleOption** instance. | 17263| enabled | Whether to enable the scan effect. The default value is **false**.| 17264 17265 17266### OH_ArkUI_ProgressLinearStyleOption_SetSmoothEffectEnabled 17267 17268``` 17269void OH_ArkUI_ProgressLinearStyleOption_SetSmoothEffectEnabled(ArkUI_ProgressLinearStyleOption* option, bool enabled) 17270``` 17271**Description** 17272 17273Sets whether to enable the smooth progress effect. 17274 17275**Since**: 15 17276 17277 17278**Parameters** 17279 17280| Name| Description| 17281| -------- | -------- | 17282| option | Pointer to the **ProgressLinearStyleOption** instance. | 17283| enabled | Whether to enable the smooth effect. When this effect is enabled, the progress changes smoothly from the current value to the target value. When this effect is disabled, the progress changes abruptly to the target value. The default value is **true**.| 17284 17285 17286### OH_ArkUI_ProgressLinearStyleOption_SetStrokeWidth 17287 17288``` 17289void OH_ArkUI_ProgressLinearStyleOption_SetStrokeWidth(ArkUI_ProgressLinearStyleOption* option, float strokeWidth) 17290``` 17291**Description** 17292 17293Sets the stroke width of the linear progress indicator. 17294 17295**Since**: 15 17296 17297 17298**Parameters** 17299 17300| Name| Description| 17301| -------- | -------- | 17302| option | Pointer to the **ProgressLinearStyleOption** instance. | 17303| strokeWidth | Stroke width of the progress indicator. The value cannot be set in percentage. The default value is **4.0vp**.| 17304 17305 17306### OH_ArkUI_ProgressLinearStyleOption_SetStrokeRadius 17307 17308``` 17309void OH_ArkUI_ProgressLinearStyleOption_SetStrokeRadius(ArkUI_ProgressLinearStyleOption* option, float strokeRadius) 17310``` 17311**Description** 17312 17313Sets the corner radius of the linear progress indicator. 17314 17315**Since**: 15 17316 17317 17318**Parameters** 17319 17320| Name| Description| 17321| -------- | -------- | 17322| option | Pointer to the **ProgressLinearStyleOption** instance. | 17323| strokeRadius | Corner radius of the progress indicator. The value range is [0, strokeWidth/2]. Default value: **strokeWidth/2**.| 17324 17325 17326### OH_ArkUI_ProgressLinearStyleOption_GetScanEffectEnabled 17327 17328``` 17329bool OH_ArkUI_ProgressLinearStyleOption_GetScanEffectEnabled(ArkUI_ProgressLinearStyleOption* option) 17330``` 17331**Description** 17332 17333Obtains the enabled status of the scan effect for the linear progress indicator. 17334 17335**Since**: 15 17336 17337**Parameters** 17338 17339| Name| Description| 17340| -------- | -------- | 17341| option | Pointer to the **ProgressLinearStyleOption** instance. | 17342 17343**Returns** 17344 17345Returns the enabled status of the scan effect. 17346 17347 17348### OH_ArkUI_ProgressLinearStyleOption_GetSmoothEffectEnabled 17349 17350``` 17351bool OH_ArkUI_ProgressLinearStyleOption_GetSmoothEffectEnabled(ArkUI_ProgressLinearStyleOption* option) 17352``` 17353**Description** 17354 17355Obtains the enabled status of the smooth progress effect for the linear progress indicator. 17356 17357**Since**: 15 17358 17359**Parameters** 17360 17361| Name| Description| 17362| -------- | -------- | 17363| option | Pointer to the **ProgressLinearStyleOption** instance. | 17364 17365**Returns** 17366 17367Returns the enabled status of the smooth progress effect. 17368 17369 17370### OH_ArkUI_ProgressLinearStyleOption_GetStrokeWidth 17371 17372``` 17373float OH_ArkUI_ProgressLinearStyleOption_GetStrokeWidth(ArkUI_ProgressLinearStyleOption* option) 17374``` 17375**Description** 17376 17377Obtains the stroke width of the linear progress indicator. 17378 17379**Since**: 15 17380 17381**Parameters** 17382 17383| Name| Description| 17384| -------- | -------- | 17385| option | Pointer to the **ProgressLinearStyleOption** instance. | 17386 17387**Returns** 17388 17389Returns the stroke width of the progress indicator. 17390 17391 17392### OH_ArkUI_ProgressLinearStyleOption_GetStrokeRadius 17393 17394``` 17395float OH_ArkUI_ProgressLinearStyleOption_GetStrokeRadius(ArkUI_ProgressLinearStyleOption* option) 17396``` 17397**Description** 17398 17399Obtains the corner radius of the linear progress indicator. 17400 17401**Since**: 15 17402 17403**Parameters** 17404 17405| Name| Description| 17406| -------- | -------- | 17407| option | Pointer to the **ProgressLinearStyleOption** instance. | 17408 17409**Returns** 17410 17411Returns the corner radius of the progress indicator. 17412 17413 17414### OH_ArkUI_DragEvent_StartDataLoading() 17415 17416``` 17417int32_t OH_ArkUI_DragEvent_StartDataLoading (ArkUI_DragEvent* event, OH_UdmfGetDataParams* options, char* key, unsigned int keyLen) 17418``` 17419**Description** 17420 17421Asynchronously obtains drag data. 17422 17423**Since**: 15 17424 17425**Parameters** 17426 17427| Name| Description| 17428| -------- | -------- | 17429| event | Pointer to an **ArkUI_DragEvent** object. | 17430| options | Parameters for obtaining data from UDMF. | 17431| key | Unique ID of data, which is returned in the callback parameters when the event is triggered. | 17432| keyLen | Length of **key**, which must be greater than or equal to the value of **UDMF_KEY_BUFFER_LEN**. | 17433 17434**Returns** 17435 17436Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17437Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17438 17439 17440### OH_ArkUI_CancelDataLoading() 17441 17442``` 17443int32_t OH_ArkUI_CancelDataLoading (ArkUI_ContextHandle uiContext, const char* key) 17444``` 17445**Description** 17446 17447Cancels the asynchronous obtaining of drag data. 17448 17449**Since**: 15 17450 17451**Parameters** 17452 17453| Name| Description| 17454| -------- | -------- | 17455| uiContext | UI context object used to bind the instance.| 17456| key | Unique ID of data.| 17457 17458**Returns** 17459 17460Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17461Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17462 17463 17464### OH_ArkUI_DisableDropDataPrefetchOnNode() 17465 17466``` 17467int32_t OH_ArkUI_DisableDropDataPrefetchOnNode (ArkUI_NodeHandle node, bool disable) 17468``` 17469**Description** 17470 17471Sets whether to enable data prefetching for drag and drop operations on a specified node. 17472 17473**Since**: 15 17474 17475**Parameters** 17476 17477| Name| Description| 17478| -------- | -------- | 17479| node | Specified node. | 17480| disable | Whether to enable data prefetching for the drop and drop operation. The value **true** means to disable data prefetching, and **false** means to enable data prefetching. The default value is **false**. To use **OH_ArkUI_DragEvent_StartDataLoading** to obtain data, set this parameter to **true**.| 17481 17482 17483**Returns** 17484 17485Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17486Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17487 17488### OH_ArkUI_CrossLanguageOption_Create() 17489 17490``` 17491ArkUI_CrossLanguageOption* OH_ArkUI_CrossLanguageOption_Create(void) 17492``` 17493**Description** 17494 17495Creates an instance of the cross-language configuration option. 17496 17497**Since**: 15 17498 17499**Returns** 17500 17501Returns the pointer to the **ArkUI_CrossLanguageOption** instance created. If a null pointer is returned, creation failed, possibly due to insufficient memory. 17502 17503 17504### OH_ArkUI_CrossLanguageOption_Destroy() 17505 17506``` 17507void OH_ArkUI_CrossLanguageOption_Destroy(ArkUI_CrossLanguageOption* option) 17508``` 17509**Description** 17510 17511Destroys an instance of the cross-language configuration option. 17512 17513**Since**: 15 17514 17515**Parameters** 17516 17517| Name| Description| 17518| -------- | -------- | 17519| option | Cross-language configuration option instance to be destroyed. | 17520 17521### OH_ArkUI_CrossLanguageOption_SetAttributeSettingStatus() 17522 17523``` 17524void OH_ArkUI_CrossLanguageOption_SetAttributeSettingStatus(ArkUI_CrossLanguageOption* option, bool enable) 17525``` 17526**Description** 17527 17528Sets whether cross-language attribute setting is allowed in the configuration option. 17529 17530**Since**: 15 17531 17532**Parameters** 17533 17534| Name| Description| 17535| -------- | -------- | 17536| option | Pointer to the cross-language configuration option instance. | 17537| enable | Whether cross-language attribute setting is allowed. The default value is **false**. | 17538 17539### OH_ArkUI_CrossLanguageOption_GetAttributeSettingStatus() 17540 17541``` 17542bool OH_ArkUI_CrossLanguageOption_GetAttributeSettingStatus(ArkUI_CrossLanguageOption* option) 17543``` 17544**Description** 17545 17546Checks whether cross-language attribute setting is allowed in the configuration option. 17547 17548**Since**: 15 17549 17550**Parameters** 17551 17552| Name| Description| 17553| -------- | -------- | 17554| option | Pointer to the cross-language configuration option instance. | 17555 17556**Returns** 17557 17558Whether cross-language attribute setting is allowed. 17559 17560### OH_ArkUI_VisibleAreaEventOptions_Create() 17561 17562``` 17563ArkUI_VisibleAreaEventOptions* OH_ArkUI_VisibleAreaEventOptions_Create() 17564``` 17565**Description** 17566 17567Creates an instance of visible area change event parameters. 17568 17569**Since**: 18 17570 17571**Returns** 17572Returns the created instance of visible area change event parameters. 17573 17574### OH_ArkUI_VisibleAreaEventOptions_Dispose() 17575 17576``` 17577void OH_ArkUI_VisibleAreaEventOptions_Dispose(ArkUI_VisibleAreaEventOptions* option) 17578``` 17579**Description** 17580 17581Disposes of an instance of visible area change event parameters. 17582 17583**Since**: 18 17584 17585**Parameters** 17586 17587| Name| Description| 17588| -------- | -------- | 17589| option | Instance of visible area change event parameters to be destroyed. | 17590 17591### OH_ArkUI_VisibleAreaEventOptions_SetRatios() 17592 17593``` 17594int32_t OH_ArkUI_VisibleAreaEventOptions_SetRatios(ArkUI_VisibleAreaEventOptions* option, float* value, int32_t size) 17595``` 17596**Description** 17597 17598Sets the threshold ratios for visible area changes. 17599 17600**Since**: 18 17601 17602**Parameters** 17603 17604| Name| Description| 17605| -------- | -------- | 17606| option | Pointer to the instance of visible area change event parameters.| 17607| value | Array of threshold ratios.| 17608| size | Size of the array of threshold ratios.| 17609 17610**Returns** 17611 17612Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17613Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17614 17615### OH_ArkUI_VisibleAreaEventOptions_SetExpectedUpdateInterval() 17616 17617``` 17618int32_t OH_ArkUI_VisibleAreaEventOptions_SetExpectedUpdateInterval( 17619 ArkUI_VisibleAreaEventOptions *option, int32_t value) 17620``` 17621**Description** 17622 17623Sets the expected update interval for visible area changes. 17624 17625**Since**: 18 17626 17627**Parameters** 17628 17629| Name| Description| 17630| -------- | -------- | 17631| option | Pointer to the instance of visible area change event parameters.| 17632| value | Expected update interval, in ms. | 17633 17634**Returns** 17635 17636Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17637Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17638 17639### OH_ArkUI_VisibleAreaEventOptions_GetRatios() 17640 17641``` 17642int32_t OH_ArkUI_VisibleAreaEventOptions_GetRatios(ArkUI_VisibleAreaEventOptions* option, float* value, int32_t* size) 17643``` 17644**Description** 17645 17646 Obtains the threshold ratios for visible area changes. 17647 17648**Since**: 18 17649 17650**Parameters** 17651 17652| Name| Description| 17653| -------- | -------- | 17654| option | Pointer to the instance of visible area change event parameters.| 17655| value | Array of threshold ratios.| 17656| size | Size of the array of threshold ratios.| 17657 17658**Returns** 17659 17660Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17661Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17662Returns **ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR** if the provided buffer size is insufficient. 17663 17664### OH_ArkUI_VisibleAreaEventOptions_GetExpectedUpdateInterval() 17665 17666``` 17667int32_t OH_ArkUI_VisibleAreaEventOptions_GetExpectedUpdateInterval(ArkUI_VisibleAreaEventOptions* option) 17668``` 17669**Description** 17670 17671 Obtains the expected update interval for visible area changes. 17672 17673**Since**: 18 17674 17675**Parameters** 17676 17677| Name| Description| 17678| -------- | -------- | 17679| option | Pointer to the instance of visible area change event parameters.| 17680 17681**Returns** 17682Returns the expected update interval, in ms. 17683 17684### OH_ArkUI_NodeUtils_GetPositionToParent() 17685 17686``` 17687int32_t OH_ArkUI_NodeUtils_GetPositionToParent (ArkUI_NodeHandle node, ArkUI_IntOffset* globalOffset ) 17688``` 17689**Description** 17690 17691Obtains the offset of a specific node relative to its parent node. 17692 17693**Since**: 15 17694 17695**Parameters** 17696 17697| Name| Description| 17698| -------- | -------- | 17699| node | **ArkUI_NodeHandle** pointer. | 17700| globalOffset | Offset of the target node relative to its parent node, in px. | 17701 17702**Returns** 17703 17704Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17705Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17706 17707### OH_ArkUI_GetGestureParam_DirectMask() 17708 17709``` 17710int32_t OH_ArkUI_GetGestureParam_DirectMask(ArkUI_GestureRecognizer* recognizer, ArkUI_GestureDirectionMask* directMask) 17711``` 17712**Description** 17713 17714Obtains the swipe direction of a gesture recognizer. 17715 17716**Since**: 18 17717 17718**Parameters** 17719 17720| Name| Description| 17721| -------- | -------- | 17722| recognizer | Pointer to the gesture recognizer. | 17723| directMask | Swipe direction of the gesture recognizer. | 17724 17725**Returns** 17726 17727Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17728Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17729 17730### OH_ArkUI_GetGestureParam_FingerCount() 17731 17732``` 17733int32_t OH_ArkUI_GetGestureParam_FingerCount(ArkUI_GestureRecognizer* recognizer, int* finger) 17734``` 17735**Description** 17736 17737Obtains the number of fingers used by a gesture recognizer. 17738 17739**Since**: 18 17740 17741**Parameters** 17742 17743| Name| Description| 17744| -------- | -------- | 17745| recognizer | Pointer to the gesture recognizer. | 17746| finger | Number of fingers used by the gesture recognizer. | 17747 17748**Returns** 17749 17750Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17751Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17752 17753### OH_ArkUI_GetGestureParam_limitFingerCount() 17754 17755``` 17756int32_t OH_ArkUI_GetGestureParam_limitFingerCount(ArkUI_GestureRecognizer* recognizer, bool* isLimited) 17757``` 17758**Description** 17759 17760Checks whether a gesture recognizer has a finger count limit. 17761 17762**Since**: 18 17763 17764**Parameters** 17765 17766| Name| Description| 17767| -------- | -------- | 17768| recognizer | Pointer to the gesture recognizer. | 17769| isLimited | Whether the gesture recognizer has a finger count limit. | 17770 17771**Returns** 17772 17773Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17774Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17775 17776### OH_ArkUI_GetGestureParam_repeat() 17777 17778``` 17779int32_t OH_ArkUI_GetGestureParam_repeat(ArkUI_GestureRecognizer* recognizer, bool* isRepeat) 17780``` 17781**Description** 17782 17783Checks whether a gesture recognizer supports repeated event callbacks. 17784 17785**Since**: 18 17786 17787**Parameters** 17788 17789| Name| Description| 17790| -------- | -------- | 17791| recognizer | Pointer to the gesture recognizer. | 17792| isRepeat | Whether the gesture recognizer supports repeated event callbacks. | 17793 17794**Returns** 17795 17796Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17797Returns **ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED** if the gesture recognizer type is not supported. 17798 17799### OH_ArkUI_GetGestureParam_distance() 17800 17801``` 17802int32_t OH_ArkUI_GetGestureParam_distance(ArkUI_GestureRecognizer* recognizer, double* distance) 17803``` 17804**Description** 17805 17806Obtains the allowed movement distance range for a gesture recognizer. 17807 17808**Since**: 18 17809 17810**Parameters** 17811 17812| Name| Description| 17813| -------- | -------- | 17814| recognizer | Pointer to the gesture recognizer. | 17815| distance | Allowed movement distance range of the gesture recognizer. | 17816 17817**Returns** 17818 17819Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17820Returns **ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED** if the gesture recognizer type is not supported. 17821 17822### OH_ArkUI_GetGestureParam_speed() 17823 17824``` 17825int32_t OH_ArkUI_GetGestureParam_speed(ArkUI_GestureRecognizer* recognizer, double* speed) 17826``` 17827**Description** 17828 17829Obtains the minimum swipe speed recognized by a gesture recognizer. 17830 17831**Since**: 18 17832 17833**Parameters** 17834 17835| Name| Description| 17836| -------- | -------- | 17837| recognizer | Pointer to the gesture recognizer. | 17838| speed | Minimum swipe speed recognized by the gesture recognizer. | 17839 17840**Returns** 17841 17842Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17843Returns **ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED** if the gesture recognizer type is not supported. 17844 17845### OH_ArkUI_GetGestureParam_duration() 17846 17847``` 17848int32_t OH_ArkUI_GetGestureParam_duration(ArkUI_GestureRecognizer* recognizer, int* duration) 17849``` 17850**Description** 17851 17852Obtains the minimum duration required to trigger a long press by a gesture recognizer. 17853 17854**Since**: 18 17855 17856**Parameters** 17857 17858| Name| Description| 17859| -------- | -------- | 17860| recognizer | Pointer to the gesture recognizer. | 17861| duration | Minimum duration for a long press. | 17862 17863**Returns** 17864 17865Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17866Returns **ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED** if the gesture recognizer type is not supported. 17867 17868### OH_ArkUI_GetGestureParam_angle() 17869 17870``` 17871int32_t OH_ArkUI_GetGestureParam_angle(ArkUI_GestureRecognizer* recognizer, double* angle) 17872``` 17873**Description** 17874 17875Obtains the minimum angle change required for a rotation gesture to be recognized by a gesture recognizer. 17876 17877**Since**: 18 17878 17879**Parameters** 17880 17881| Name| Description| 17882| -------- | -------- | 17883| recognizer | Pointer to the gesture recognizer. | 17884| angle | Minimum angle change. | 17885 17886**Returns** 17887 17888Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17889Returns **ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED** if the gesture recognizer type is not supported. 17890 17891### OH_ArkUI_GetGestureParam_distanceThreshold() 17892 17893``` 17894int32_t OH_ArkUI_GetGestureParam_distanceThreshold(ArkUI_GestureRecognizer* recognizer, double* distanceThreshold) 17895``` 17896**Description** 17897 17898Obtains the movement threshold for gestures to be recognized by a gesture recognizer. 17899 17900**Since**: 18 17901 17902**Parameters** 17903 17904| Name| Description| 17905| -------- | -------- | 17906| recognizer | Pointer to the gesture recognizer. | 17907| distanceThreshold | Gesture movement threshold of the gesture recognizer. | 17908 17909**Returns** 17910 17911Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17912Returns **ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED** if the gesture recognizer type is not supported. 17913 17914### OH_ArkUI_TextPickerRangeContentArray_Create() 17915 17916``` 17917ArkUI_TextPickerRangeContentArray* OH_ArkUI_TextPickerRangeContentArray_Create(int32_t length) 17918``` 17919**Description** 17920 17921Creates a **TextPickerRangeContent** array object. 17922 17923**Since**: 18 17924 17925**Parameters** 17926 17927| Name| Description| 17928| -------- | -------- | 17929| length | Length of the **TextPickerRangeContent** array. | 17930 17931**Returns** 17932 17933Returns a pointer to an empty **TextPickerRangeContent** array. 17934 17935### OH_ArkUI_TextPickerRangeArray_SetIconAtIndex() 17936 17937``` 17938void OH_ArkUI_TextPickerRangeArray_SetIconAtIndex(ArkUI_TextPickerRangeContentArray* handle,char* icon,int32_t index); 17939``` 17940**Description** 17941 17942 Sets the icon data at the specified position in the **TextPickerRangeContent** array. 17943 17944**Since**: 18 17945 17946**Parameters** 17947 17948| Name| Description| 17949| -------- | -------- | 17950| handle | Pointer to the **TextPickerRangeContent** array.| 17951| icon | Pointer to the icon image address.| 17952| index | Position in the array, starting from 0.| 17953 17954 17955### OH_ArkUI_TextPickerRangeContentArray_SetTextAtIndex() 17956 17957``` 17958void OH_ArkUI_TextPickerRangeContentArray_SetTextAtIndex(ArkUI_TextPickerRangeContentArray* handle,char* text,int32_t index); 17959``` 17960**Description** 17961 17962 Sets the text data at the specified position in the **TextPickerRangeContent** array. 17963 17964**Since**: 18 17965 17966**Parameters** 17967 17968| Name| Description| 17969| -------- | -------- | 17970| handle | Pointer to the **TextPickerRangeContent** array.| 17971| text | Pointer to the text content.| 17972| index | Position in the array, starting from 0.| 17973 17974 17975### OH_ArkUI_TextPickerRangeContentArray_Destroy() 17976 17977``` 17978void OH_ArkUI_TextPickerRangeContentArray_Destroy(ArkUI_TextPickerRangeContentArray* handle); 17979``` 17980**Description** 17981 17982 Destroys a **TextPickerRangeContent** array object. 17983 17984**Since**: 18 17985 17986**Parameters** 17987 17988| Name| Description| 17989| -------- | -------- | 17990| handle | Pointer to the **TextPickerRangeContent** array.| 17991 17992 17993### OH_ArkUI_TextCascadePickerRangeContentArray_Create() 17994 17995``` 17996ArkUI_TextCascadePickerRangeContentArray* OH_ArkUI_TextCascadePickerRangeContentArray_Create(int32_t length); 17997``` 17998**Description** 17999 18000Creates a **TextCascadePickerRangeContent** array object. 18001 18002**Since**: 18 18003 18004**Parameters** 18005 18006| Name| Description| 18007| -------- | -------- | 18008| length | Length of the **TextPickerRangeContent** array.| 18009 18010**Returns** 18011 18012Returns a pointer to an empty **TextCascadePickerRangeContent** array. 18013 18014### OH_ArkUI_TextCascadePickerRangeContentArray_SetTextAtIndex() 18015 18016``` 18017void OH_ArkUI_TextCascadePickerRangeContentArray_SetTextAtIndex(ArkUI_TextCascadePickerRangeContentArray* handle,char* text,int32_t index); 18018``` 18019**Description** 18020 18021 Sets the text data at the specified position in the **TextCascadePickerRangeContent** array. 18022 18023**Since**: 18 18024 18025**Parameters** 18026 18027| Name| Description| 18028| -------- | -------- | 18029| handle | Pointer to the **TextCascadePickerRangeContent** array.| 18030| text | Pointer to the text content.| 18031| index | Position in the array, starting from 0.| 18032 18033 18034### OH_ArkUI_TextCascadePickerRangeContentArray_setChildAtIndex() 18035 18036``` 18037void OH_ArkUI_TextCascadePickerRangeContentArray_setChildAtIndex(ArkUI_TextCascadePickerRangeContentArray* handle,ArkUI_TextCascadePickerRangeContentArray* child,int32_t index); 18038``` 18039**Description** 18040 18041 Sets the child data at the specified position in the **TextCascadePickerRangeContent** array. 18042 18043**Since**: 18 18044 18045**Parameters** 18046 18047| Name| Description| 18048| -------- | -------- | 18049| handle | Pointer to the **TextCascadePickerRangeContent** array.| 18050| child | Pointer to the child node array.| 18051| index | Position in the array, starting from 0.| 18052 18053 18054### OH_ArkUI_TextCascadePickerRangeContentArray_Destroy() 18055 18056``` 18057void OH_ArkUI_TextCascadePickerRangeContentArray_Destroy(ArkUI_TextCascadePickerRangeContentArray* handle); 18058``` 18059**Description** 18060 18061 Destroys a **TextCascadePickerRangeContent** array object. 18062 18063**Since**: 18 18064 18065**Parameters** 18066 18067| Name| Description| 18068| -------- | -------- | 18069| handle | Pointer to the **TextCascadePickerRangeContent** array.| 18070
