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_INPUT_EVENT_TYPE_NOT_SUPPORTED = 180006,<br/>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|int32_t [OH_ArkUI_DragEvent_RequestDragEndPending](#oh_arkui_dragevent_requestdragendpending)([ArkUI_DragEvent](_ark_u_i___native_module.md#arkui_dragevent)\* event, int32_t* requestIdentify); | Requests a delayed execution of the end of the drag and drop operation.| 870|int32_t [OH_ArkUI_NotifyDragResult](#oh_arkui_notifydragresult)(int32_t requestIdentify, [ArkUI_DragResult](#arkui_dragresult) \* result); | Notifies the system of the drag result.| 871|int32_t [OH_ArkUI_NotifyDragEndPendingDone](#oh_arkui_notifydragendpendingdone)(int32_t requestIdentify);| Notifies that the drag delay execution is complete.| 872 873 874## Macro Description 875 876 877### OH_ArkUI_GetModuleInterface 878 879``` 880#define OH_ArkUI_GetModuleInterface( nativeAPIVariantKind, structType, structPtr ) 881``` 882**Value:** 883``` 884 do { \ 885 void* anyNativeAPI = OH_ArkUI_QueryModuleInterfaceByName(nativeAPIVariantKind, #structType); \ 886 if (anyNativeAPI) { \ 887 structPtr = (structType*)(anyNativeAPI); \ 888 } \ 889 } while (0) 890#include<arkui/native_interface.h> 891#include<arkui/native_node.h> 892 893ArkUI_NativeNodeAPI_1* nativeNodeApi = nullptr; 894OH_ArkUI_GetModuleInterface(ARKUI_NATIVE_NODE, ArkUI_NativeNodeAPI_1, nativeNodeApi); 895``` 896**Description** 897 898Obtains the macro function corresponding to a struct pointer based on the struct type. 899 900**Since**: 12 901 902 903## Type Description 904 905 906### ArkUI_AccessibilityState 907 908``` 909typedef struct ArkUI_AccessibilityState ArkUI_AccessibilityState 910``` 911**Description** 912 913Defines a struct for the component accessibility state. 914 915**Since**: 12 916 917 918### ArkUI_AccessibilityValue 919 920``` 921typedef struct ArkUI_AccessibilityValue ArkUI_AccessibilityValue 922``` 923**Description** 924 925Defines a struct for the component accessibility value. 926 927**Since**: 12 928 929 930### ArkUI_AlignmentRuleOption 931 932``` 933typedef struct ArkUI_AlignmentRuleOption ArkUI_AlignmentRuleOption 934``` 935**Description** 936 937Defines the alignment rule in the relative container. 938 939**Since**: 12 940 941 942### ArkUI_AnimateOption 943 944``` 945typedef struct ArkUI_AnimateOption ArkUI_AnimateOption 946``` 947**Description** 948 949Defines a struct for the animation configuration. 950 951**Since**: 12 952 953 954### ArkUI_AnimatorHandle 955 956``` 957typedef struct ArkUI_Animator* ArkUI_AnimatorHandle 958``` 959**Description** 960 961Defines a struct for the pointer to an animator object. 962 963**Since**: 12 964 965 966### ArkUI_AnimatorOption 967 968``` 969typedef struct ArkUI_AnimatorOption ArkUI_AnimatorOption 970``` 971**Description** 972 973Defines the animator parameter object. 974 975**Since**: 12 976 977 978### ArkUI_BarrierOption 979 980``` 981typedef struct ArkUI_BarrierOption ArkUI_BarrierOption 982``` 983**Description** 984 985Defines the ID, direction, and referenced component of a barrier. 986 987**Since**: 12 988 989 990### ArkUI_Context 991 992``` 993typedef struct ArkUI_Context ArkUI_Context 994``` 995**Description** 996 997Defines a struct for a UI context object. 998 999**Since**: 12 1000 1001 1002### ArkUI_ContextHandle [1/2] 1003 1004``` 1005typedef struct ArkUI_Context* ArkUI_ContextHandle 1006``` 1007**Description** 1008 1009Defines a struct for the handle to the ArkUI native UI context. 1010 1011**Since**: 12 1012 1013 1014### ArkUI_ContextHandle [2/2] 1015 1016``` 1017typedef struct ArkUI_Context* ArkUI_ContextHandle 1018``` 1019**Description** 1020 1021Defines the handle to the ArkUI native UI context. 1022 1023**Since**: 12 1024 1025 1026### ArkUI_CurveHandle 1027 1028``` 1029typedef struct ArkUI_Curve* ArkUI_CurveHandle 1030``` 1031**Description** 1032 1033Defines a struct for the pointer to an interpolation curve. 1034 1035**Since**: 12 1036 1037 1038### ArkUI_CustomSpanDrawInfo 1039 1040``` 1041typedef struct ArkUI_CustomSpanDrawInfo ArkUI_CustomSpanDrawInfo 1042``` 1043**Description** 1044 1045Defines a struct for the drawing information of a custom span. 1046 1047**Since**: 12 1048 1049 1050### ArkUI_CustomSpanMeasureInfo 1051 1052``` 1053typedef struct ArkUI_CustomSpanMeasureInfo ArkUI_CustomSpanMeasureInfo 1054``` 1055**Description** 1056 1057Defines a struct for the measurement information of a custom span. 1058 1059**Since**: 12 1060 1061 1062### ArkUI_CustomSpanMetrics 1063 1064``` 1065typedef struct ArkUI_CustomSpanMetrics ArkUI_CustomSpanMetrics 1066``` 1067**Description** 1068 1069Defines a struct for the measurement metrics of a custom span. 1070 1071**Since**: 12 1072 1073 1074### ArkUI_DialogDismissEvent 1075 1076``` 1077typedef struct ArkUI_DialogDismissEvent ArkUI_DialogDismissEvent 1078``` 1079**Description** 1080 1081Defines a struct for a dialog box dismiss event. 1082 1083**Since**: 12 1084 1085### ArkUI_CustomDialogOptions 1086 1087``` 1088typedef struct ArkUI_CustomDialogOptions ArkUI_CustomDialogOptions 1089``` 1090**Description** 1091 1092Defines a struct for custom dialog box options. 1093 1094**Since**: 16 1095 1096 1097### ArkUI_DragAction 1098 1099``` 1100typedef struct ArkUI_DragAction ArkUI_DragAction 1101``` 1102**Description** 1103 1104Defines a struct for a drag action. 1105 1106**Since**: 12 1107 1108 1109### ArkUI_DragAndDropInfo 1110 1111``` 1112typedef struct ArkUI_DragAndDropInfo ArkUI_DragAndDropInfo 1113``` 1114**Description** 1115 1116Defines a struct for drag and drop information returned through a drag status listener. 1117 1118**Since**: 12 1119 1120### ArkUI_DragEvent 1121 1122``` 1123typedef struct ArkUI_DragEvent ArkUI_DragEvent 1124``` 1125**Description** 1126 1127Defines a struct for a drag event. 1128 1129**Since**: 12 1130 1131 1132### ArkUI_DragPreviewOption 1133 1134``` 1135typedef struct ArkUI_DragPreviewOption ArkUI_DragPreviewOption 1136``` 1137**Description** 1138 1139Defines a struct for custom drag preview options. 1140 1141**Since**: 12 1142 1143 1144### ArkUI_DrawableDescriptor 1145 1146``` 1147typedef struct ArkUI_DrawableDescriptor ArkUI_DrawableDescriptor 1148``` 1149**Description** 1150 1151Defines a struct for the **DrawableDescriptor** object. 1152 1153**Since**: 12 1154 1155 1156### ArkUI_DrawContext 1157 1158``` 1159typedef struct ArkUI_DrawContext ArkUI_DrawContext 1160``` 1161**Description** 1162 1163Defines the component drawing context. 1164 1165**Since**: 12 1166 1167 1168### ArkUI_GestureDirectionMask 1169 1170``` 1171typedef uint32_t ArkUI_GestureDirectionMask 1172``` 1173**Description** 1174 1175Defines a set of gesture directions. 1176 1177**Since**: 12 1178 1179 1180### ArkUI_GestureEventActionTypeMask 1181 1182``` 1183typedef uint32_t ArkUI_GestureEventActionTypeMask 1184``` 1185**Description** 1186 1187Defines a set of gesture event types. 1188 1189Example: **ArkUI_GestureEventActionTypeMask actions = GESTURE_EVENT_ACTION_ACCEPT | GESTURE_EVENT_ACTION_UPDATE** 1190 1191**Since**: 12 1192 1193 1194### ArkUI_GestureEventTargetInfo 1195 1196``` 1197typedef struct ArkUI_GestureEventTargetInfo ArkUI_GestureEventTargetInfo 1198``` 1199**Description** 1200 1201Defines a struct for a **GestureEventTargetInfo** object that provides information about a gesture event target. 1202 1203**Since**: 12 1204 1205 1206### ArkUI_GestureRecognizerDestructNotifyCallback 1207 1208``` 1209typedef void(* ArkUI_GestureRecognizerDestructNotifyCallback) (ArkUI_GestureRecognizer *recognizer, void *userData) 1210``` 1211**Description** 1212 1213Defines a callback function for notifying gesture recognizer destruction. 1214 1215**Since**: 12 1216 1217 1218### ArkUI_GestureRecognizerHandle 1219 1220``` 1221typedef ArkUI_GestureRecognizer* ArkUI_GestureRecognizerHandle 1222``` 1223**Description** 1224 1225Defines the gesture recognizer handle. 1226 1227**Since**: 12 1228 1229 1230### ArkUI_GestureRecognizerHandleArray 1231 1232``` 1233typedef ArkUI_GestureRecognizerHandle* ArkUI_GestureRecognizerHandleArray 1234``` 1235**Description** 1236 1237Defines the gesture recognizer handle array. 1238 1239**Since**: 12 1240 1241 1242### ArkUI_TouchRecognizerHandle 1243 1244``` 1245typedef ArkUI_TouchRecognizer* ArkUI_TouchRecognizerHandle 1246``` 1247**Description** 1248 1249Defines the gesture recognizer handle. 1250 1251**Since**: 15 1252 1253 1254### ArkUI_TouchRecognizerHandleArray 1255 1256``` 1257typedef ArkUI_TouchRecognizerHandle* ArkUI_TouchRecognizerHandleArray 1258``` 1259**Description** 1260 1261Defines an array of gesture recognizer handles. 1262 1263**Since**: 15 1264 1265### ArkUI_GuidelineOption 1266 1267``` 1268typedef struct ArkUI_GuidelineOption ArkUI_GuidelineOption 1269``` 1270**Description** 1271 1272Defines the ID, direction, and position of a guideline. 1273 1274**Since**: 12 1275 1276 1277### ArkUI_ImageAnimatorFrameInfo 1278 1279``` 1280typedef struct ArkUI_ImageAnimatorFrameInfo ArkUI_ImageAnimatorFrameInfo 1281``` 1282**Description** 1283 1284Defines the image frame information. 1285 1286**Since**: 12 1287 1288 1289### ArkUI_KeyframeAnimateOption 1290 1291``` 1292typedef struct ArkUI_KeyframeAnimateOption ArkUI_KeyframeAnimateOption 1293``` 1294**Description** 1295 1296Defines a struct for the keyframe animation parameter object. 1297 1298**Since**: 12 1299 1300 1301### ArkUI_LayoutConstraint 1302 1303``` 1304typedef struct ArkUI_LayoutConstraint ArkUI_LayoutConstraint 1305``` 1306**Description** 1307 1308Defines the size constraints of a component during component layout. 1309 1310**Since**: 12 1311 1312 1313### ArkUI_ListChildrenMainSize 1314 1315``` 1316typedef struct ArkUI_ListChildrenMainSize ArkUI_ListChildrenMainSize 1317``` 1318**Description** 1319 1320Defines the **ChildrenMainSize** information of the **List** component. 1321 1322**Since**: 12 1323 1324 1325### ArkUI_ListItemSwipeActionItem 1326 1327``` 1328typedef struct ArkUI_ListItemSwipeActionItem ArkUI_ListItemSwipeActionItem 1329``` 1330**Description** 1331 1332Defines the item configuration for **ListItemSwipeActionOption**. 1333 1334**Since**: 12 1335 1336 1337### ArkUI_ListItemSwipeActionOption 1338 1339``` 1340typedef struct ArkUI_ListItemSwipeActionOption ArkUI_ListItemSwipeActionOption 1341``` 1342**Description** 1343 1344Defines the configuration for **ListItemSwipeActionOption**. 1345 1346**Since**: 12 1347 1348 1349### ArkUI_NativeDialogHandle 1350 1351``` 1352typedef struct ArkUI_NativeDialog* ArkUI_NativeDialogHandle 1353``` 1354**Description** 1355 1356Defines the handle to the custom dialog box controller of ArkUI on the native side. 1357 1358**Since**: 12 1359 1360 1361### ArkUI_NodeAdapterEvent 1362 1363``` 1364typedef struct ArkUI_NodeAdapterEvent ArkUI_NodeAdapterEvent 1365``` 1366**Description** 1367 1368Defines the component adapter event. 1369 1370**Since**: 12 1371 1372 1373### ArkUI_NodeAdapterHandle 1374 1375``` 1376typedef struct ArkUI_NodeAdapter* ArkUI_NodeAdapterHandle 1377``` 1378**Description** 1379 1380Defines the component adapter, which is used for lazy loading of elements of scrollable components. 1381 1382**Since**: 12 1383 1384 1385### ArkUI_NodeContentCallback 1386 1387``` 1388typedef void(* ArkUI_NodeContentCallback) (ArkUI_NodeContentEvent *event) 1389``` 1390**Description** 1391 1392Defines the callback for the NodeContent event. 1393 1394**Since**: 12 1395 1396 1397### ArkUI_NodeContentEvent 1398 1399``` 1400typedef struct ArkUI_NodeContentEvent ArkUI_NodeContentEvent 1401``` 1402**Description** 1403 1404Defines the common structure type of a NodeContent event. 1405 1406**Since**: 12 1407 1408 1409### ArkUI_NodeContentHandle 1410 1411``` 1412typedef struct ArkUI_NodeContent* ArkUI_NodeContentHandle 1413``` 1414**Description** 1415 1416Defines the handle to the ArkUI NodeContent instance on the native side. 1417 1418**Since**: 12 1419 1420 1421### ArkUI_NodeCustomEvent 1422 1423``` 1424typedef struct ArkUI_NodeCustomEvent ArkUI_NodeCustomEvent 1425``` 1426**Description** 1427 1428Defines the common structure of a custom component event. 1429 1430**Since**: 12 1431 1432 1433### ArkUI_NodeEvent [1/2] 1434 1435``` 1436typedef struct ArkUI_NodeEvent ArkUI_NodeEvent 1437``` 1438**Description** 1439 1440Defines a struct for a component event. 1441 1442**Since**: 12 1443 1444 1445### ArkUI_NodeEvent [2/2] 1446 1447``` 1448typedef struct ArkUI_NodeEventArkUI_NodeEvent 1449``` 1450**Description** 1451 1452Defines the common structure of a component event. 1453 1454**Since**: 12 1455 1456 1457### ArkUI_NodeHandle 1458 1459``` 1460typedef struct ArkUI_Node* ArkUI_NodeHandle 1461``` 1462**Description** 1463 1464Defines the pointer to the ArkUI native component object. 1465 1466**Since**: 12 1467 1468 1469### ArkUI_OnWillDismissEvent 1470 1471``` 1472typedef bool(* ArkUI_OnWillDismissEvent) (int32_t reason) 1473``` 1474**Description** 1475 1476Defines a pointer to the callback invoked when the dialog box is closed. 1477 1478**Since**: 12 1479 1480 1481### ArkUI_ParallelInnerGestureEvent 1482 1483``` 1484typedef struct ArkUI_ParallelInnerGestureEvent ArkUI_ParallelInnerGestureEvent 1485``` 1486**Description** 1487 1488Defines a parallel internal gesture event. 1489 1490**Since**: 12 1491 1492 1493### ArkUI_GestureInterruptInfo 1494 1495``` 1496typedef struct ArkUI_GestureInterruptInfo ArkUI_GestureInterruptInfo 1497``` 1498 1499**Description** 1500 1501Defines the gesture interruption information. 1502 1503**Since**: 12 1504 1505 1506### ArkUI_StyledString 1507 1508``` 1509typedef struct ArkUI_StyledString ArkUI_StyledString 1510``` 1511**Description** 1512 1513Defines a struct for the styled string object supported by the text component. 1514 1515**Since**: 12 1516 1517 1518### ArkUI_StyledString_Descriptor 1519 1520``` 1521typedef struct ArkUI_StyledString_Descriptor ArkUI_StyledString_Descriptor 1522``` 1523**Description** 1524 1525Defines a struct for the styled string descriptor object supported by the text component. 1526 1527**Since**: 14 1528 1529 1530### ArkUI_SwiperIndicator 1531 1532``` 1533typedef struct ArkUI_SwiperIndicator ArkUI_SwiperIndicator 1534``` 1535**Description** 1536 1537Defines the navigation indicator style of the **Swiper** component. 1538 1539**Since**: 12 1540 1541 1542### ArkUI_SystemFontStyleEvent 1543 1544``` 1545typedef struct ArkUI_SystemFontStyleEvent ArkUI_SystemFontStyleEvent 1546``` 1547**Description** 1548 1549Defines a struct for the system font style event. 1550 1551**Since**: 12 1552 1553### ArkUI_SwiperDigitIndicator 1554 1555``` 1556typedef struct ArkUI_SwiperDigitIndicator ArkUI_SwiperDigitIndicator 1557``` 1558**Description** 1559 1560Defines the digit-style navigation indicator of the **Swiper** component. 1561 1562**Since**: 15 1563 1564### ArkUI_SwiperArrowStyle 1565 1566``` 1567typedef struct ArkUI_SwiperArrowStyle ArkUI_SwiperArrowStyle 1568``` 1569**Description** 1570 1571Defines the arrow style for the **Swiper** component. 1572 1573**Since**: 15 1574 1575### ArkUI_TransitionEffect 1576 1577``` 1578typedef struct ArkUI_TransitionEffect ArkUI_TransitionEffect 1579``` 1580**Description** 1581 1582Defines a struct for the transition effect. 1583 1584**Since**: 12 1585 1586 1587### ArkUI_WaterFlowSectionOption 1588 1589``` 1590typedef struct ArkUI_WaterFlowSectionOption ArkUI_WaterFlowSectionOption 1591``` 1592**Description** 1593 1594Defines the water flow section configuration. 1595 1596**Since**: 12 1597 1598 1599### OH_PixelmapNative 1600 1601``` 1602typedef struct OH_PixelmapNative OH_PixelmapNative 1603``` 1604**Description** 1605 1606Defines the **Pixelmap** struct, which is used to perform operations related to a pixel map. 1607 1608**Since**: 12 1609 1610 1611### OH_PixelmapNativeHandle 1612 1613``` 1614typedef struct OH_PixelmapNative* OH_PixelmapNativeHandle 1615``` 1616**Description** 1617 1618Defines a struct for the pointer to an **OH_PixelmapNative** object. 1619 1620**Since**: 12 1621 1622 1623### OH_UdmfData 1624 1625``` 1626typedef struct OH_UdmfData OH_UdmfData 1627``` 1628**Description** 1629 1630Defines a struct for UDMF unified data. 1631 1632**Since**: 12 1633 1634 1635### ArkUI_ProgressLinearStyleOption 1636 1637``` 1638typedef struct ArkUI_ProgressLinearStyleOption ArkUI_ProgressLinearStyleOption 1639``` 1640**Description** 1641 1642Defines the style information for a linear progress indicator in the **Progress** component. 1643 1644**Since**: 15 1645 1646### OH_HostWindowInfo 1647 1648``` 1649typedef struct ArkUI_HostWindowInfo ArkUI_HostWindowInfo 1650``` 1651**Description** 1652 1653Defines a struct for the host window information. 1654 1655**Since**: 15 1656 1657 1658### OH_UdmfGetDataParams 1659 1660``` 1661typedef struct OH_UdmfGetDataParams OH_UdmfGetDataParams 1662``` 1663**Description** 1664 1665Defines the parameters used for obtaining data from UDMF. 1666 1667**Since**: 15 1668 1669### ArkUI_VisibleAreaEventOptions 1670 1671``` 1672typedef struct ArkUI_VisibleAreaEventOptions ArkUI_VisibleAreaEventOptions 1673``` 1674**Description** 1675 1676Defines the parameters for visible area change events. 1677 1678**Since**: 18 1679 1680 1681### ArkUI_TextPickerRangeContentArray 1682``` 1683typedef struct ArkUI_TextPickerRangeContentArray ArkUI_TextPickerRangeContentArray 1684``` 1685**Description** 1686 1687Defines the data selection list for the text picker. 1688 1689**Since**: 18 1690 1691### ArkUI_TextCascadePickerRangeContentArray 1692 1693``` 1694typedef struct ArkUI_TextCascadePickerRangeContentArray ArkUI_TextCascadePickerRangeContentArray 1695``` 1696**Description** 1697 1698Defines the content array for a multi-column cascading data picker. 1699 1700**Since**: 18 1701 1702## Enum Description 1703 1704 1705### ArkUI_AccessibilityActionType 1706 1707``` 1708enum ArkUI_AccessibilityActionType 1709``` 1710**Description** 1711 1712Defines an enum for the accessibility action types. 1713 1714**Since**: 12 1715 1716| Enum| Description| 1717| -------- | -------- | 1718| ARKUI_ACCESSIBILITY_ACTION_CLICK | Tapping | 1719| ARKUI_ACCESSIBILITY_ACTION_LONG_CLICK | Long press | 1720| ARKUI_ACCESSIBILITY_ACTION_CUT | Cut. | 1721| ARKUI_ACCESSIBILITY_ACTION_COPY | | 1722| ARKUI_ACCESSIBILITY_ACTION_PASTE | Paste. | 1723 1724 1725### ArkUI_AccessibilityCheckedState 1726 1727``` 1728enum ArkUI_AccessibilityCheckedState 1729``` 1730**Description** 1731 1732Enumerates the accessibility check box states. 1733 1734**Since**: 12 1735 1736| Enum| Description| 1737| -------- | -------- | 1738| ARKUI_ACCESSIBILITY_UNCHECKED | The check box is not selected. | 1739| ARKUI_ACCESSIBILITY_CHECKED | The check box is selected. | 1740 1741 1742### ArkUI_AccessibilityMode 1743 1744``` 1745enum ArkUI_AccessibilityMode 1746``` 1747**Description** 1748 1749Enumerates the accessibility modes. 1750 1751**Since**: 12 1752 1753| Enum| Description| 1754| -------- | -------- | 1755| ARKUI_ACCESSIBILITY_MODE_AUTO | The mode is automatically set to enabled or disabled based on the component. | 1756| ARKUI_ACCESSIBILITY_MODE_ENABLED | The component can be identified by the accessibility service. | 1757| ARKUI_ACCESSIBILITY_MODE_DISABLED | The component cannot be identified by the accessibility service. | 1758| ARKUI_ACCESSIBILITY_MODE_DISABLED_FOR_DESCENDANTS | The component and all its child components cannot be identified by the accessibility service. | 1759 1760 1761### ArkUI_AdaptiveColor 1762 1763``` 1764enum ArkUI_AdaptiveColor 1765``` 1766**Description** 1767 1768Enumerates the adaptive color modes. 1769 1770**Since**: 12 1771 1772| Enum| Description| 1773| -------- | -------- | 1774| ARKUI_ADAPTIVE_COLOR_DEFAULT | Adaptive color mode is not used. | 1775| ARKUI_ADAPTIVE_COLOR_AVERAGE | Adaptive color mode is used. | 1776 1777 1778### ArkUI_Alignment 1779 1780``` 1781enum ArkUI_Alignment 1782``` 1783**Description** 1784 1785Enumerates the alignment modes. 1786 1787**Since**: 12 1788 1789| Enum| Description| 1790| -------- | -------- | 1791| ARKUI_ALIGNMENT_TOP_START | Top start. | 1792| ARKUI_ALIGNMENT_TOP | Top center. | 1793| ARKUI_ALIGNMENT_TOP_END | Top end. | 1794| ARKUI_ALIGNMENT_START | Vertically centered start. | 1795| ARKUI_ALIGNMENT_CENTER | Horizontally and vertically centered. | 1796| ARKUI_ALIGNMENT_END | Vertically centered end. | 1797| ARKUI_ALIGNMENT_BOTTOM_START | Bottom start. | 1798| ARKUI_ALIGNMENT_BOTTOM | Horizontally centered on the bottom. | 1799| ARKUI_ALIGNMENT_BOTTOM_END | Bottom end. | 1800 1801 1802### ArkUI_AnimationCurve 1803 1804``` 1805enum ArkUI_AnimationCurve 1806``` 1807**Description** 1808 1809Enumerates the animation curves. 1810 1811**Since**: 12 1812 1813| Enum| Description| 1814| -------- | -------- | 1815| ARKUI_CURVE_LINEAR | The animation speed keeps unchanged. | 1816| ARKUI_CURVE_EASE | The animation starts slowly, accelerates, and then slows down towards the end. | 1817| ARKUI_CURVE_EASE_IN | The animation starts at a low speed and then picks up speed until the end. | 1818| ARKUI_CURVE_EASE_OUT | The animation ends at a low speed. | 1819| ARKUI_CURVE_EASE_IN_OUT | The animation starts and ends at a low speed. | 1820| ARKUI_CURVE_FAST_OUT_SLOW_IN | The animation uses the standard curve | 1821| ARKUI_CURVE_LINEAR_OUT_SLOW_IN | The animation uses the deceleration curve. | 1822| ARKUI_CURVE_FAST_OUT_LINEAR_IN | The animation uses the acceleration curve. | 1823| ARKUI_CURVE_EXTREME_DECELERATION | The animation uses the extreme deceleration curve. | 1824| ARKUI_CURVE_SHARP | The animation uses the sharp curve. | 1825| ARKUI_CURVE_RHYTHM | The animation uses the rhythm curve. | 1826| ARKUI_CURVE_SMOOTH | The animation uses the smooth curve. | 1827| ARKUI_CURVE_FRICTION | The animation uses the friction curve | 1828 1829 1830### ArkUI_AnimationDirection 1831 1832``` 1833enum ArkUI_AnimationDirection 1834``` 1835**Description** 1836 1837Enumerates the animation playback modes. 1838 1839**Since**: 12 1840 1841| Enum| Description| 1842| -------- | -------- | 1843| ARKUI_ANIMATION_DIRECTION_NORMAL | The animation plays in forward loop mode. | 1844| ARKUI_ANIMATION_DIRECTION_REVERSE | The animation plays in reverse loop mode. | 1845| 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. | 1846| 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. | 1847 1848 1849### ArkUI_AnimationFill 1850 1851``` 1852enum ArkUI_AnimationFill 1853``` 1854**Description** 1855 1856Enumerates the state of the animated target after the animation is executed. 1857 1858**Since**: 12 1859 1860| Enum| Description| 1861| -------- | -------- | 1862| ARKUI_ANIMATION_FILL_NONE | No style is applied to the target before or after the animation is executed. | 1863| 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. | 1864| ARKUI_ANIMATION_FILL_BACKWARDS | The animation uses the value defined in the first key frame during the duration defined by **animation-delay**. | 1865| ARKUI_ANIMATION_FILL_BOTH | The animation follows the **forwards** and **backwards** rules. | 1866 1867 1868### ArkUI_AnimationFillMode 1869 1870``` 1871enum ArkUI_AnimationFillMode 1872``` 1873**Description** 1874 1875Enumerates the states before and after execution of the frame-by-frame animation. 1876 1877**Since**: 12 1878 1879| Enum| Description| 1880| -------- | -------- | 1881| 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. | 1882| ARKUI_ANIMATION_FILL_MODE_FORWARDS | The target component retains the state set by the last keyframe encountered during execution of the animation. | 1883| 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**. | 1884| ARKUI_ANIMATION_FILL_MODE_BOTH | The animation follows the rules for both **Forwards** and **Backwards**, extending the animation attributes in both directions. | 1885 1886 1887### ArkUI_AnimationPlayMode 1888 1889``` 1890enum ArkUI_AnimationPlayMode 1891``` 1892**Description** 1893 1894Enumerates the animation playback modes. 1895 1896**Since**: 12 1897 1898| Enum| Description| 1899| -------- | -------- | 1900| ARKUI_ANIMATION_PLAY_MODE_NORMAL | The animation is played forwards. | 1901| ARKUI_ANIMATION_PLAY_MODE_REVERSE | The animation is played backwards. | 1902| 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...). | 1903| 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...). | 1904 1905 1906### ArkUI_AnimationStatus 1907 1908``` 1909enum ArkUI_AnimationStatus 1910``` 1911**Description** 1912 1913Enumerates the playback states of the frame-by-frame animation. 1914 1915**Since**: 12 1916 1917| Enum| Description| 1918| -------- | -------- | 1919| ARKUI_ANIMATION_STATUS_INITIAL | The animation is in the initial state. | 1920| ARKUI_ANIMATION_STATUS_RUNNING | The animation is being played. | 1921| ARKUI_ANIMATION_STATUS_PAUSED | The animation is paused. | 1922| ARKUI_ANIMATION_STATUS_STOPPED | The animation is stopped. | 1923 1924 1925### ArkUI_Axis 1926 1927``` 1928enum ArkUI_Axis 1929``` 1930**Description** 1931 1932Enumerates the scroll directions. 1933 1934**Since**: 12 1935 1936| Enum| Description| 1937| -------- | -------- | 1938| ARKUI_AXIS_VERTICAL | Only vertical scrolling is supported. | 1939| ARKUI_AXIS_HORIZONTAL | Only horizontal scrolling is supported. | 1940 1941 1942### ArkUI_BarrierDirection 1943 1944``` 1945enum ArkUI_BarrierDirection 1946``` 1947**Description** 1948 1949Enumerates the barrier directions. 1950 1951**Since**: 12 1952 1953| Enum| Description| 1954| -------- | -------- | 1955| ARKUI_BARRIER_DIRECTION_START | The barrier is on the left side of all the referenced components specified by referencedId. | 1956| ARKUI_BARRIER_DIRECTION_END | The barrier is on the right side of all the referenced components specified by referencedId. | 1957| ARKUI_BARRIER_DIRECTION_TOP | The barrier is at the top of all the referenced components specified by referencedId. | 1958| ARKUI_BARRIER_DIRECTION_BOTTOM | The barrier is at the bottom of all the referenced components specified by referencedId. | 1959 1960 1961### ArkUI_BlendApplyType 1962 1963``` 1964enum ArkUI_BlendApplyType 1965``` 1966**Description** 1967 1968Defines how the specified blend mode is applied. 1969 1970**Since**: 12 1971 1972| Enum| Description| 1973| -------- | -------- | 1974| BLEND_APPLY_TYPE_FAST | The content of the view is blended in sequence on the target image. | 1975| 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. | 1976 1977 1978### ArkUI_BlendMode 1979 1980``` 1981enum ArkUI_BlendMode 1982``` 1983**Description** 1984 1985Enumerates the blend modes. 1986 1987**Since**: 12 1988 1989| Enum| Description| 1990| -------- | -------- | 1991| ARKUI_BLEND_MODE_NONE | The top image is superimposed on the bottom image without any blending. | 1992| ARKUI_BLEND_MODE_CLEAR | The target pixels covered by the source pixels are erased by being turned to completely transparent. | 1993| ARKUI_BLEND_MODE_SRC | r = s: Only the source pixels are displayed. | 1994| ARKUI_BLEND_MODE_DST | r = d: Only the target pixels are displayed. | 1995| ARKUI_BLEND_MODE_SRC_OVER | r = s + (1 - sa) \d: The source pixels are blended based on opacity and cover the target pixels. | 1996| ARKUI_BLEND_MODE_DST_OVER | r = d + (1 - da) *\ s: The target pixels are blended based on opacity and cover on the source pixels. | 1997| ARKUI_BLEND_MODE_SRC_IN | r = s \* da: Only the part of the source pixels that overlap with the target pixels is displayed. | 1998| ARKUI_BLEND_MODE_DST_IN | r = d \* sa: Only the part of the target pixels that overlap with the source pixels is displayed. | 1999| 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. | 2000| 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. | 2001| 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. | 2002| 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. | 2003| 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. | 2004| ARKUI_BLEND_MODE_PLUS | r = min(s + d, 1): New pixels resulting from adding the source pixels to the target pixels are displayed. | 2005| ARKUI_BLEND_MODE_MODULATE | r = s \* d: New pixels resulting from multiplying the source pixels with the target pixels are displayed. | 2006| 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. | 2007| ARKUI_BLEND_MODE_OVERLAY | The MULTIPLY or SCREEN mode is used based on the target pixels. | 2008| ARKUI_BLEND_MODE_DARKEN | rc = s + d - max(s \da, d \sa), ra = kSrcOver: When two colors overlap, whichever is darker is used. | 2009| ARKUI_BLEND_MODE_LIGHTEN | rc = s + d - min(s \da, d \sa), ra = kSrcOver: The darker of the pixels (source and target) is used. | 2010| ARKUI_BLEND_MODE_COLOR_DODGE | The colors of the target pixels are lightened to reflect the source pixels. | 2011| ARKUI_BLEND_MODE_COLOR_BURN | The colors of the target pixels are darkened to reflect the source pixels. | 2012| ARKUI_BLEND_MODE_HARD_LIGHT | The MULTIPLY or SCREEN mode is used, depending on the source pixels. | 2013| ARKUI_BLEND_MODE_SOFT_LIGHT | The LIGHTEN or DARKEN mode is used, depending on the source pixels. | 2014| 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. | 2015| ARKUI_BLEND_MODE_EXCLUSION | rc = s + d - two(s \* d), ra = kSrcOver: The final pixel is similar to **DIFFERENCE**, but with less contrast. | 2016| 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.| 2017| 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. | 2018| 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. | 2019| 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. | 2020| 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. | 2021 2022 2023### ArkUI_BlurStyle 2024 2025``` 2026enum ArkUI_BlurStyle 2027``` 2028**Description** 2029 2030Enumerates the blur styles. 2031 2032**Since**: 12 2033 2034| Enum| Description| 2035| -------- | -------- | 2036| ARKUI_BLUR_STYLE_THIN | Thin material. | 2037| ARKUI_BLUR_STYLE_REGULAR | Regular material. | 2038| ARKUI_BLUR_STYLE_THICK | Thick material. | 2039| ARKUI_BLUR_STYLE_BACKGROUND_THIN | Material that creates the minimum depth of field effect. | 2040| ARKUI_BLUR_STYLE_BACKGROUND_REGULAR | Material that creates a medium shallow depth of field effect. | 2041| ARKUI_BLUR_STYLE_BACKGROUND_THICK | Material that creates a high shallow depth of field effect. | 2042| ARKUI_BLUR_STYLE_BACKGROUND_ULTRA_THICK | Material that creates the maximum depth of field effect. | 2043| ARKUI_BLUR_STYLE_NONE | No blur. | 2044| ARKUI_BLUR_STYLE_COMPONENT_ULTRA_THIN | Component ultra-thin material. | 2045| ARKUI_BLUR_STYLE_COMPONENT_THIN | Component thin material. | 2046| ARKUI_BLUR_STYLE_COMPONENT_REGULAR | Component regular material. | 2047| ARKUI_BLUR_STYLE_COMPONENT_THICK | Component thick material. | 2048| ARKUI_BLUR_STYLE_COMPONENT_ULTRA_THICK | Component ultra-thick material. | 2049 2050 2051### ArkUI_BorderStyle 2052 2053``` 2054enum ArkUI_BorderStyle 2055``` 2056**Description** 2057 2058Enumerates the border styles. 2059 2060**Since**: 12 2061 2062| Enum| Description| 2063| -------- | -------- | 2064| ARKUI_BORDER_STYLE_SOLID | Solid border. | 2065| ARKUI_BORDER_STYLE_DASHED | Dashed border. | 2066| ARKUI_BORDER_STYLE_DOTTED | Dotted border. | 2067 2068 2069### ArkUI_ButtonType 2070 2071``` 2072enum ArkUI_ButtonType 2073``` 2074**Description** 2075 2076Enumerates the button types. 2077 2078**Since**: 12 2079 2080| Enum| Description| 2081| -------- | -------- | 2082| ARKUI_BUTTON_TYPE_NORMAL | Normal button (without rounded corners by default). | 2083| ARKUI_BUTTON_TYPE_CAPSULE | Capsule-type button (the round corner is half of the height by default). | 2084| ARKUI_BUTTON_TYPE_CIRCLE | Circle button. | 2085 2086 2087### ArkUI_CalendarAlignment 2088 2089``` 2090enum ArkUI_CalendarAlignment 2091``` 2092**Description** 2093 2094Enumerates the alignment modes between the calendar picker and the entry component. 2095 2096**Since**: 12 2097 2098| Enum| Description| 2099| -------- | -------- | 2100| ARKUI_CALENDAR_ALIGNMENT_START | Left aligned. | 2101| ARKUI_CALENDAR_ALIGNMENT_CENTER | Center aligned. | 2102| ARKUI_CALENDAR_ALIGNMENT_END | Right aligned. | 2103 2104 2105### ArkUI_CancelButtonStyle 2106 2107``` 2108enum ArkUI_CancelButtonStyle 2109``` 2110**Description** 2111 2112Enumerates the styles of the Cancel button. 2113 2114**Since**: 12 2115 2116| Enum| Description| 2117| -------- | -------- | 2118| ARKUI_CANCELBUTTON_STYLE_CONSTANT | The Cancel button is always displayed. | 2119| ARKUI_CANCELBUTTON_STYLE_INVISIBLE | The Cancel button is always hidden. | 2120| ARKUI_CANCELBUTTON_STYLE_INPUT | The Cancel button is displayed when there is text input. | 2121 2122 2123### ArkUI_CheckboxShape 2124 2125``` 2126enum ArkUI_CheckboxShape 2127``` 2128**Description** 2129 2130Enumerates the shapes of the check box. 2131 2132**Since**: 12 2133 2134| Enum| Description| 2135| -------- | -------- | 2136| ArkUI_CHECKBOX_SHAPE_CIRCLE | Circle. | 2137| ArkUI_CHECKBOX_SHAPE_ROUNDED_SQUARE | Rounded square. | 2138 2139 2140### ArkUI_ClipType 2141 2142``` 2143enum ArkUI_ClipType 2144``` 2145**Description** 2146 2147Enumerates the clipping region types. 2148 2149**Since**: 12 2150 2151| Enum| Description| 2152| -------- | -------- | 2153| ARKUI_CLIP_TYPE_RECTANGLE | Rectangle. | 2154| ARKUI_CLIP_TYPE_CIRCLE | **(circle)** | 2155| ARKUI_CLIP_TYPE_ELLIPSE | Ellipse. | 2156| ARKUI_CLIP_TYPE_PATH | Path Type | 2157 2158 2159### ArkUI_ColorMode 2160 2161``` 2162enum ArkUI_ColorMode 2163``` 2164**Description** 2165 2166Enumerates the color modes. 2167 2168**Since**: 12 2169 2170| Enum| Description| 2171| -------- | -------- | 2172| ARKUI_COLOR_MODE_SYSTEM | Following the system color mode. | 2173| ARKUI_COLOR_MODE_LIGHT | Light color mode. | 2174| ARKUI_COLOR_MODE_DARK | Dark color mode. | 2175 2176 2177### ArkUI_ColorStrategy 2178 2179``` 2180enum ArkUI_ColorStrategy 2181``` 2182**Description** 2183 2184Enumerates the foreground colors. 2185 2186**Since**: 12 2187 2188| Enum| Description| 2189| -------- | -------- | 2190| ARKUI_COLOR_STRATEGY_INVERT | The foreground colors are the inverse of the component background colors. | 2191| ARKUI_COLOR_STRATEGY_AVERAGE | The shadow colors of the component are the average color obtained from the component background shadow area. | 2192| ARKUI_COLOR_STRATEGY_PRIMARY | The shadow colors of the component are the primary color obtained from the component background shadow area. | 2193 2194 2195### ArkUI_CopyOptions 2196 2197``` 2198enum ArkUI_CopyOptions 2199``` 2200**Description** 2201 2202Enumerates the text copy and paste modes. 2203 2204**Since**: 12 2205 2206| Enum| Description| 2207| -------- | -------- | 2208| ARKUI_COPY_OPTIONS_NONE | Copy is not allowed. | 2209| ARKUI_COPY_OPTIONS_IN_APP | Intra-application copy is allowed. | 2210| ARKUI_COPY_OPTIONS_LOCAL_DEVICE | Intra-device copy is allowed. | 2211| ARKUI_COPY_OPTIONS_CROSS_DEVICE | Cross-device copy is allowed. | 2212 2213 2214### ArkUI_Direction 2215 2216``` 2217enum ArkUI_Direction 2218``` 2219**Description** 2220 2221Enumerates the modes in which components are laid out along the main axis of the container. 2222 2223**Since**: 12 2224 2225| Enum| Description| 2226| -------- | -------- | 2227| ARKUI_DIRECTION_LTR | Components are arranged from left to right. | 2228| ARKUI_DIRECTION_RTL | Components are arranged from right to left. | 2229| ARKUI_DIRECTION_AUTO | The default layout direction is used. | 2230 2231 2232### ArkUI_DismissReason 2233 2234``` 2235enum ArkUI_DismissReason 2236``` 2237**Description** 2238 2239Enumerates the actions for triggering closure of the dialog box. 2240 2241**Since**: 12 2242 2243| Enum| Description| 2244| -------- | -------- | 2245| DIALOG_DISMISS_BACK_PRESS | Touching the system-defined Back button or pressing the Esc key. | 2246| DIALOG_DISMISS_TOUCH_OUTSIDE | Touching the mask. | 2247| DIALOG_DISMISS_CLOSE_BUTTON | Touching the Close button. | 2248| DIALOG_DISMISS_SLIDE_DOWN | Sliding down. | 2249 2250 2251### ArkUI_LevelMode 2252 2253``` 2254enum ArkUI_LevelMode 2255``` 2256**Description** 2257 2258Enumerates the display level modes of the dialog box. 2259 2260**Since**: 15 2261 2262| Enum| Description| 2263| -------- | -------- | 2264| ARKUI_LEVEL_MODE_OVERLAY | The dialog box is displayed on top of all other application content. | 2265| ARKUI_LEVEL_MODE_EMBEDDED | The dialog box is embedded within the application's page content. | 2266 2267### ArkUI_ImmersiveMode 2268 2269``` 2270enum ArkUI_ImmersiveMode 2271``` 2272**Description** 2273 2274Enumerates the display areas of the embedded dialog box overlay. 2275 2276**Since**: 15 2277 2278| Enum| Description| 2279| -------- | -------- | 2280| ARKUI_IMMERSIVE_MODE_DEFAULT | The dialog box overlay follows the layout constraints of its parent node. | 2281| ARKUI_IMMERSIVE_MODE_EXTEND | The dialog box overlay can extend to cover the status bar and navigation bar for a more immersive look. | 2282 2283### ArkUI_DragPreviewScaleMode 2284 2285``` 2286enum ArkUI_DragPreviewScaleMode 2287``` 2288**Description** 2289 2290Defines an enum for drag preview scale modes. 2291 2292**Since**: 12 2293 2294| Enum| Description| 2295| -------- | -------- | 2296| 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. | 2297| ARKUI_DRAG_PREVIEW_SCALE_DISABLED | The system does not scale the drag preview. | 2298 2299 2300### ArkUI_DragResult 2301 2302``` 2303enum ArkUI_DragResult 2304``` 2305**Description** 2306 2307Defines 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. 2308 2309**Since**: 12 2310 2311| Enum| Description| 2312| -------- | -------- | 2313| ARKUI_DRAG_RESULT_SUCCESSFUL | The drag and drop operation succeeded. | 2314| ARKUI_DRAG_RESULT_FAILED | The drag and drop operation failed. | 2315| ARKUI_DRAG_RESULT_CANCELED | The drag and drop operation was canceled. | 2316 2317 2318### ArkUI_DragStatus 2319 2320``` 2321enum ArkUI_DragStatus 2322``` 2323**Description** 2324 2325Enumerates dragging states. 2326 2327**Since**: 12 2328 2329| Enum| Description| 2330| -------- | -------- | 2331| ArkUI_DRAG_STATUS_UNKNOWN | Unknown. | 2332| ArkUI_DRAG_STATUS_STARTED | Started. | 2333| ArkUI_DRAG_STATUS_ENDED | Ended. | 2334 2335 2336### ArkUI_DropOperation 2337 2338``` 2339enum ArkUI_DropOperation 2340``` 2341**Description** 2342 2343Defines an enum for data processing modes used when data is dropped, which affects the display of the badge. 2344 2345**Since**: 12 2346 2347| Enum| Description| 2348| -------- | -------- | 2349| ARKUI_DROP_OPERATION_COPY | Copy. | 2350| ARKUI_DROP_OPERATION_MOVE | Cut. | 2351 2352 2353### ArkUI_EdgeEffect 2354 2355``` 2356enum ArkUI_EdgeEffect 2357``` 2358**Description** 2359 2360Enumerates the effects used at the edges of the component when the boundary of the scrollable content is reached. 2361 2362**Since**: 12 2363 2364| Enum| Description| 2365| -------- | -------- | 2366| 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. | 2367| ARKUI_EDGE_EFFECT_FADE | Fade effect. When at one of the edges, the component produces a fade effect. | 2368| ARKUI_EDGE_EFFECT_NONE | No effect when the component is at one of the edges. | 2369 2370 2371### ArkUI_EffectEdge 2372 2373``` 2374enum ArkUI_EffectEdge 2375``` 2376**Description** 2377 2378Enumerates the edges for which the effect takes effect when the boundary of the scrollable content is reached. 2379 2380**Since**: 17 2381 2382| Enum| Description| 2383| -------- | -------- | 2384| ARKUI_EFFECT_EDGE_START | Start edge. | 2385| ARKUI_EFFECT_EDGE_END | End edge. | 2386 2387 2388### ArkUI_EllipsisMode 2389 2390``` 2391enum ArkUI_EllipsisMode 2392``` 2393**Description** 2394 2395Enumerates the ellipsis positions. 2396 2397**Since**: 12 2398 2399| Enum| Description| 2400| -------- | -------- | 2401| ARKUI_ELLIPSIS_MODE_START | An ellipsis is used at the start of the line of text. | 2402| ARKUI_ELLIPSIS_MODE_CENTER | An ellipsis is used at the center of the line of text. | 2403| ARKUI_ELLIPSIS_MODE_END | An ellipsis is used at the end of the line of text. | 2404 2405 2406### ArkUI_EnterKeyType 2407 2408``` 2409enum ArkUI_EnterKeyType 2410``` 2411**Description** 2412 2413Enumerates the types of the Enter key for a single-line text box. 2414 2415**Since**: 12 2416 2417| Enum| Description| 2418| -------- | -------- | 2419| ARKUI_ENTER_KEY_TYPE_GO | The Enter key is labeled "Go." | 2420| ARKUI_ENTER_KEY_TYPE_SEARCH | The Enter key is labeled "Search." | 2421| ARKUI_ENTER_KEY_TYPE_SEND | The Enter key is labeled "Send." | 2422| ARKUI_ENTER_KEY_TYPE_NEXT | The Enter key is labeled "Next." | 2423| ARKUI_ENTER_KEY_TYPE_DONE | The Enter key is labeled "Done." | 2424| ARKUI_ENTER_KEY_TYPE_PREVIOUS | The Enter key is labeled "Previous." | 2425| ARKUI_ENTER_KEY_TYPE_NEW_LINE | The Enter key is labeled "Return." | 2426 2427 2428### ArkUI_ErrorCode 2429 2430``` 2431enum ArkUI_ErrorCode 2432``` 2433**Description** 2434 2435Defines an enum for the error codes. 2436 2437**Since**: 12 2438 2439| Enum| Description| 2440| -------- | -------- | 2441| ARKUI_ERROR_CODE_NO_ERROR | No error. | 2442| ARKUI_ERROR_CODE_PARAM_INVALID | Parameter error. | 2443| ARKUI_ERROR_CODE_ATTRIBUTE_OR_EVENT_NOT_SUPPORTED | The component does not support specific attributes or events. | 2444| ARKUI_ERROR_CODE_NOT_SUPPROTED_FOR_ARKTS_NODE | The specific operation is not allowed on the node created by ArkTS. | 2445| ARKUI_ERROR_CODE_NODE_ADAPTER_NONE_HOST | The adapter for lazy loading is not bound to the component. | 2446| ARKUI_ERROR_CODE_NODE_ADAPTER_EXIST_IN_HOST | The adapter already exists. | 2447| ARKUI_ERROR_CODE_NODE_ADAPTER_CHILD_NODE_EXIST | Failed to add the adapter because the corresponding node already has a subnode. | 2448| ARKUI_ERROR_CODE_NODE_EVENT_PARAM_INDEX_OUT_OF_RANGE | The parameter length in the parameter event exceeds the limit. | 2449| ARKUI_ERROR_CODE_NODE_EVENT_PARAM_INVALID | The data does not exist in the component event. | 2450| ARKUI_ERROR_CODE_NODE_EVENT_NO_RETURN | The component event does not support return values. | 2451| ARKUI_ERROR_CODE_NODE_INDEX_INVALID | Invalid index. | 2452| ARKUI_ERROR_CODE_GET_INFO_FAILED | Failed to obtain the route navigation information. | 2453| ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR | Buffer size error. | 2454| ARKUI_ERROR_CODE_FOCUS_NON_FOCUSABLE | The current node is not focusable.| 2455| ARKUI_ERROR_CODE_FOCUS_NON_FOCUSABLE_ANCESTOR | An ancestor of the current node is not focusable.| 2456| ARKUI_ERROR_CODE_FOCUS_NON_EXISTENT | The current node does not exist.| 2457| ARKUI_ERROR_CODE_NON_SCROLLABLE_CONTAINER | The component is not a scrollable container. | 2458| ARKUI_ERROR_CODE_BUFFER_SIZE_NOT_ENOUGH | The buffer is not large enough. | 2459| ARKUI_ERROR_INPUT_EVENT_TYPE_NOT_SUPPORTED | Input event type not supported. | 2460| ARKUI_ERROR_CODE_INVALID_STYLED_STRING | Invalid styled string. | 2461| ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED | The gesture recognizer type is not supported. | 2462 2463 2464### ArkUI_FinishCallbackType 2465 2466``` 2467enum ArkUI_FinishCallbackType 2468``` 2469**Description** 2470 2471Enumerates the animation **onFinish** callback types. 2472 2473**Since**: 12 2474 2475| Enum| Description| 2476| -------- | -------- | 2477| ARKUI_FINISH_CALLBACK_REMOVED | The callback is invoked when the entire animation is removed once it has finished. | 2478| 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. | 2479 2480 2481### ArkUI_FlexAlignment 2482 2483``` 2484enum ArkUI_FlexAlignment 2485``` 2486**Description** 2487 2488Enumerates the vertical alignment modes. 2489 2490**Since**: 12 2491 2492| Enum| Description| 2493| -------- | -------- | 2494| ARKUI_FLEX_ALIGNMENT_START | The child components are aligned with the start edge of the main axis. | 2495| ARKUI_FLEX_ALIGNMENT_CENTER | The child components are aligned in the center of the main axis. | 2496| ARKUI_FLEX_ALIGNMENT_END | The child components are aligned with the end edge of the main axis. | 2497| 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. | 2498| 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. | 2499| 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. | 2500 2501 2502### ArkUI_FlexDirection 2503 2504``` 2505enum ArkUI_FlexDirection 2506``` 2507**Description** 2508 2509Enumerates the directions of the main axis in the flex container. 2510 2511**Since**: 12 2512 2513| Enum| Description| 2514| -------- | -------- | 2515| ARKUI_FLEX_DIRECTION_ROW | The child components are arranged in the same direction as the main axis runs along the rows. | 2516| ARKUI_FLEX_DIRECTION_COLUMN | The child components are arranged in the same direction as the main axis runs down the columns. | 2517| ARKUI_FLEX_DIRECTION_ROW_REVERSE | The child components are arranged opposite to the **ROW** direction. | 2518| ARKUI_FLEX_DIRECTION_COLUMN_REVERSE | The child components are arranged opposite to the **COLUMN** direction. | 2519 2520 2521### ArkUI_FlexWrap 2522 2523``` 2524enum ArkUI_FlexWrap 2525``` 2526**Description** 2527 2528Defines whether the flex container has a single line or multiple lines. 2529 2530**Since**: 12 2531 2532| Enum| Description| 2533| -------- | -------- | 2534| ARKUI_FLEX_WRAP_NO_WRAP | The child components in the flex container are arranged in a single line, and they cannot overflow. | 2535| ARKUI_FLEX_WRAP_WRAP | The child components in the flex container are arranged in multiple lines, and they may overflow. | 2536| ARKUI_FLEX_WRAP_WRAP_REVERSE | The child components in the flex container are reversely arranged in multiple lines, and they may overflow. | 2537 2538 2539### ArkUI_FontStyle 2540 2541``` 2542enum ArkUI_FontStyle 2543``` 2544**Description** 2545 2546Enumerates the font styles. 2547 2548**Since**: 12 2549 2550| Enum| Description| 2551| -------- | -------- | 2552| ARKUI_FONT_STYLE_NORMAL | Standard font style. | 2553| ARKUI_FONT_STYLE_ITALIC | Italic font style. | 2554 2555 2556### ArkUI_FontWeight 2557 2558``` 2559enum ArkUI_FontWeight 2560``` 2561**Description** 2562 2563Enumerates the font weights. 2564 2565**Since**: 12 2566 2567| Enum| Description| 2568| -------- | -------- | 2569| ARKUI_FONT_WEIGHT_W100 | 100 | 2570| ARKUI_FONT_WEIGHT_W200 | 200 | 2571| ARKUI_FONT_WEIGHT_W300 | 300 | 2572| ARKUI_FONT_WEIGHT_W400 | 400 | 2573| ARKUI_FONT_WEIGHT_W500 | 500 | 2574| ARKUI_FONT_WEIGHT_W600 | 600 | 2575| ARKUI_FONT_WEIGHT_W700 | 700 | 2576| ARKUI_FONT_WEIGHT_W800 | 800 | 2577| ARKUI_FONT_WEIGHT_W900 | 900 | 2578| ARKUI_FONT_WEIGHT_BOLD | The font weight is bold. | 2579| ARKUI_FONT_WEIGHT_NORMAL | The font weight is normal. | 2580| ARKUI_FONT_WEIGHT_BOLDER | The font weight is bolder. | 2581| ARKUI_FONT_WEIGHT_LIGHTER | The font weight is lighter. | 2582| ARKUI_FONT_WEIGHT_MEDIUM | The font weight is medium. | 2583| ARKUI_FONT_WEIGHT_REGULAR | The font weight is normal. | 2584 2585 2586### ArkUI_GestureDirection 2587 2588``` 2589enum ArkUI_GestureDirection 2590``` 2591**Description** 2592 2593Enumerates gesture directions. 2594 2595**Since**: 12 2596 2597| Enum| Description| 2598| -------- | -------- | 2599| GESTURE_DIRECTION_ALL | All directions. | 2600| GESTURE_DIRECTION_HORIZONTAL | Horizontal direction. | 2601| GESTURE_DIRECTION_VERTICAL | Vertical direction. | 2602| GESTURE_DIRECTION_LEFT | Leftward. | 2603| GESTURE_DIRECTION_RIGHT | Rightward. | 2604| GESTURE_DIRECTION_UP | Upward. | 2605| GESTURE_DIRECTION_DOWN | Downward. | 2606| GESTURE_DIRECTION_NONE | None. | 2607 2608 2609### ArkUI_GestureEventActionType 2610 2611``` 2612enum ArkUI_GestureEventActionType 2613``` 2614**Description** 2615 2616Enumerates gesture event types. 2617 2618**Since**: 12 2619 2620| Enum| Description| 2621| -------- | -------- | 2622| GESTURE_EVENT_ACTION_ACCEPT | Triggered. | 2623| GESTURE_EVENT_ACTION_UPDATE | Updated. | 2624| GESTURE_EVENT_ACTION_END | Ended. | 2625| GESTURE_EVENT_ACTION_CANCEL | Canceled. | 2626 2627 2628### ArkUI_GestureInterruptResult 2629 2630``` 2631enum ArkUI_GestureInterruptResult 2632``` 2633**Description** 2634 2635Enumerates gesture interruption results. 2636 2637**Since**: 12 2638 2639| Enum| Description| 2640| -------- | -------- | 2641| GESTURE_INTERRUPT_RESULT_CONTINUE | The gesture recognition process continues. | 2642| GESTURE_INTERRUPT_RESULT_REJECT | The gesture recognition process is paused. | 2643 2644 2645### ArkUI_GestureMask 2646 2647``` 2648enum ArkUI_GestureMask 2649``` 2650**Description** 2651 2652Enumerates gesture masking modes. 2653 2654**Since**: 12 2655 2656| Enum| Description| 2657| -------- | -------- | 2658| NORMAL_GESTURE_MASK | The gestures of child components are enabled and recognized based on the default gesture recognition sequence. | 2659| IGNORE_INTERNAL_GESTURE_MASK | The gestures of child components are disabled, including the built-in gestures. | 2660 2661 2662### ArkUI_GesturePriority 2663 2664``` 2665enum ArkUI_GesturePriority 2666``` 2667**Description** 2668 2669Enumerates gesture event modes. 2670 2671**Since**: 12 2672 2673| Enum| Description| 2674| -------- | -------- | 2675| NORMAL | Normal. | 2676| PRIORITY | High-priority. | 2677| PARALLEL | Parallel. | 2678 2679 2680### ArkUI_GestureRecognizerState 2681 2682``` 2683enum ArkUI_GestureRecognizerState 2684``` 2685**Description** 2686 2687Enumerates the gesture recognizer states. 2688 2689**Since**: 12 2690 2691| Enum| Description| 2692| -------- | -------- | 2693| ARKUI_GESTURE_RECOGNIZER_STATE_REDAY | Prepared. | 2694| ARKUI_GESTURE_RECOGNIZER_STATE_DETECTING | Check status. | 2695| ARKUI_GESTURE_RECOGNIZER_STATE_PENDING | Waiting | 2696| ARKUI_GESTURE_RECOGNIZER_STATE_BLOCKED | Blocked. | 2697| ARKUI_GESTURE_RECOGNIZER_STATE_SUCCESSFUL | (Success status) | 2698| ARKUI_GESTURE_RECOGNIZER_STATE_FAILED | Failed. | 2699 2700 2701### ArkUI_GestureRecognizerType 2702 2703``` 2704enum ArkUI_GestureRecognizerType 2705``` 2706**Description** 2707 2708Enumerates gesture recognizer types. 2709 2710**Since**: 12 2711 2712| Enum| Description| 2713| -------- | -------- | 2714| TAP_GESTURE | Tap. | 2715| LONG_PRESS_GESTURE | Long press gesture. | 2716| PAN_GESTURE | Pan gesture. | 2717| PINCH_GESTURE | Pinch gesture. | 2718| ROTATION_GESTURE | Rotation gesture. | 2719| SWIPE_GESTURE | Swipe gesture. | 2720| GROUP_GESTURE | A group of gestures. | 2721 2722 2723### ArkUI_GroupGestureMode 2724 2725``` 2726enum ArkUI_GroupGestureMode 2727``` 2728**Description** 2729 2730Enumerates gesture group modes. 2731 2732**Since**: 12 2733 2734| Enum| Description| 2735| -------- | -------- | 2736| 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. | 2737| 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. | 2738| EXCLUSIVE_GROUP | Exclusive recognition. Registered gestures are identified concurrently. If one gesture is successfully recognized, gesture recognition ends. | 2739 2740 2741### ArkUI_HitTestMode 2742 2743``` 2744enum ArkUI_HitTestMode 2745``` 2746**Description** 2747 2748Enumerates the hit test modes. 2749 2750**Since**: 12 2751 2752| Enum| Description| 2753| -------- | -------- | 2754| 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. | 2755| 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. | 2756| 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. | 2757| ARKUI_HIT_TEST_MODE_NONE | The node does not respond to the hit test of a touch event. | 2758 2759 2760### ArkUI_HorizontalAlignment 2761 2762``` 2763enum ArkUI_HorizontalAlignment 2764``` 2765**Description** 2766 2767Enumerates the alignment mode in the horizontal direction. 2768 2769**Since**: 12 2770 2771| Enum| Description| 2772| -------- | -------- | 2773| ARKUI_HORIZONTAL_ALIGNMENT_START | Aligned with the start edge in the same direction as the language in use. | 2774| ARKUI_HORIZONTAL_ALIGNMENT_CENTER | Aligned with the center. This is the default alignment mode. | 2775| ARKUI_HORIZONTAL_ALIGNMENT_END | Aligned with the end edge in the same direction as the language in use. | 2776 2777 2778### ArkUI_ImageInterpolation 2779 2780``` 2781enum ArkUI_ImageInterpolation 2782``` 2783**Description** 2784 2785Enumerates the image interpolation effects. 2786 2787**Since**: 12 2788 2789| Enum| Description| 2790| -------- | -------- | 2791| ARKUI_IMAGE_INTERPOLATION_NONE | No image interpolation. | 2792| ARKUI_IMAGE_INTERPOLATION_LOW | Low quality interpolation. | 2793| ARKUI_IMAGE_INTERPOLATION_MEDIUM | Medium quality interpolation. | 2794| ARKUI_IMAGE_INTERPOLATION_HIGH | High quality interpolation. This mode produces scaled images of the highest possible quality. | 2795 2796 2797### ArkUI_ImageRenderMode 2798 2799``` 2800enum ArkUI_ImageRenderMode 2801``` 2802**Description** 2803 2804Enumerates the image rendering modes. 2805 2806**Since**: 12 2807 2808| Enum| Description| 2809| -------- | -------- | 2810| ARKUI_IMAGE_RENDER_MODE_ORIGINAL | Render image pixels as they are in the original source image. | 2811| ARKUI_IMAGE_RENDER_MODE_TEMPLATE | Render image pixels to create a monochrome template image. | 2812 2813 2814### ArkUI_ImageRepeat 2815 2816``` 2817enum ArkUI_ImageRepeat 2818``` 2819**Description** 2820 2821Enumerates the image repeat patterns. 2822 2823**Since**: 12 2824 2825| Enum| Description| 2826| -------- | -------- | 2827| ARKUI_IMAGE_REPEAT_NONE | The image is not repeatedly drawn. | 2828| ARKUI_IMAGE_REPEAT_X | The image is repeatedly drawn only along the x-axis. | 2829| ARKUI_IMAGE_REPEAT_Y | The image is repeatedly drawn only along the y-axis. | 2830| ARKUI_IMAGE_REPEAT_XY | The image is repeatedly drawn along both axes. | 2831 2832 2833### ArkUI_ImageSize 2834 2835``` 2836enum ArkUI_ImageSize 2837``` 2838**Description** 2839 2840Defines the image size. 2841 2842**Since**: 12 2843 2844| Enum| Description| 2845| -------- | -------- | 2846| ARKUI_IMAGE_SIZE_AUTO | The original image aspect ratio is retained. | 2847| 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. | 2848| ARKUI_IMAGE_SIZE_CONTAIN | The image is scaled with its aspect ratio retained for the content to be completely displayed within the display boundaries. | 2849 2850 2851### ArkUI_ImageSpanAlignment 2852 2853``` 2854enum ArkUI_ImageSpanAlignment 2855``` 2856**Description** 2857 2858Enumerates the alignment mode of the image with the text. 2859 2860**Since**: 12 2861 2862| Enum| Description| 2863| -------- | -------- | 2864| ARKUI_IMAGE_SPAN_ALIGNMENT_BASELINE | The image is bottom aligned with the text baseline. | 2865| ARKUI_IMAGE_SPAN_ALIGNMENT_BOTTOM | The image is bottom aligned with the text. | 2866| ARKUI_IMAGE_SPAN_ALIGNMENT_CENTER | The image is centered aligned with the text. | 2867| ARKUI_IMAGE_SPAN_ALIGNMENT_TOP | The image is top aligned with the text. | 2868 2869 2870### ArkUI_ItemAlignment 2871 2872``` 2873enum ArkUI_ItemAlignment 2874``` 2875**Description** 2876 2877Enumerates the modes in which components are laid out along the cross axis of the container. 2878 2879**Since**: 12 2880 2881| Enum| Description| 2882| -------- | -------- | 2883| ARKUI_ITEM_ALIGNMENT_AUTO | The default configuration of the flex container is used. | 2884| ARKUI_ITEM_ALIGNMENT_START | The items in the flex container are aligned with the cross-start edge. | 2885| ARKUI_ITEM_ALIGNMENT_CENTER | The items in the flex container are centered along the cross axis. | 2886| ARKUI_ITEM_ALIGNMENT_END | The items in the flex container are aligned with the cross-end edge. | 2887| ARKUI_ITEM_ALIGNMENT_STRETCH | The items in the flex container are stretched and padded along the cross axis. | 2888| 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. | 2889 2890 2891### ArkUI_KeyCode 2892 2893``` 2894enum ArkUI_KeyCode 2895``` 2896**Description** 2897 2898Enumerates the key codes for key events. 2899 2900**Since**: 14 2901 2902| Enum| Description| 2903| -------- | -------- | 2904| ARKUI_KEYCODE_UNKNOWN | Unknown key. | 2905| ARKUI_KEYCODE_FN | Function (Fn) key. | 2906| ARKUI_KEYCODE_VOLUME_UP | Volume Up key. | 2907| ARKUI_KEYCODE_VOLUME_DOWN | Volume Down key. | 2908| ARKUI_KEYCODE_POWER | Power key. | 2909| ARKUI_KEYCODE_CAMERA | Camera key. | 2910| ARKUI_KEYCODE_VOLUME_MUTE | Speaker Mute key. | 2911| ARKUI_KEYCODE_MUTE | Mute key. | 2912| ARKUI_KEYCODE_BRIGHTNESS_UP | Brightness Up key. | 2913| ARKUI_KEYCODE_BRIGHTNESS_DOWN | Brightness Down key. | 2914| ARKUI_KEYCODE_0 | Key 0. | 2915| ARKUI_KEYCODE_1 | Key 1. | 2916| ARKUI_KEYCODE_2 | Key 2. | 2917| ARKUI_KEYCODE_3 | Key 3. | 2918| ARKUI_KEYCODE_4 | Key 4. | 2919| ARKUI_KEYCODE_5 | Key 5. | 2920| ARKUI_KEYCODE_6 | Key 6. | 2921| ARKUI_KEYCODE_7 | Key 7. | 2922| ARKUI_KEYCODE_8 | Key 8. | 2923| ARKUI_KEYCODE_9 | Key 9. | 2924| ARKUI_KEYCODE_STAR | Key *. | 2925| ARKUI_KEYCODE_POUND | Key #. | 2926| ARKUI_KEYCODE_DPAD_UP | Up key on D-pad. | 2927| ARKUI_KEYCODE_DPAD_DOWN | Down key on D-pad. | 2928| ARKUI_KEYCODE_DPAD_LEFT | Left key on D-pad. | 2929| ARKUI_KEYCODE_DPAD_RIGHT | Right key on D-pad. | 2930| ARKUI_KEYCODE_DPAD_CENTER | Center key on D-pad. | 2931| ARKUI_KEYCODE_A | Key A. | 2932| ARKUI_KEYCODE_B | Key B. | 2933| ARKUI_KEYCODE_C | Key C. | 2934| ARKUI_KEYCODE_D | Key D. | 2935| ARKUI_KEYCODE_E | Key E. | 2936| ARKUI_KEYCODE_F | Key F. | 2937| ARKUI_KEYCODE_G | Key G. | 2938| ARKUI_KEYCODE_H | Key H. | 2939| ARKUI_KEYCODE_I | Key I. | 2940| ARKUI_KEYCODE_J | Key J. | 2941| ARKUI_KEYCODE_K | Key K. | 2942| ARKUI_KEYCODE_L | Key L. | 2943| ARKUI_KEYCODE_M | Key M. | 2944| ARKUI_KEYCODE_N | Key N. | 2945| ARKUI_KEYCODE_O | Key O. | 2946| ARKUI_KEYCODE_P | Key P. | 2947| ARKUI_KEYCODE_Q | Key R. | 2948| ARKUI_KEYCODE_R | Key R. | 2949| ARKUI_KEYCODE_S | Key S. | 2950| ARKUI_KEYCODE_T | Key T. | 2951| ARKUI_KEYCODE_U | Key U. | 2952| ARKUI_KEYCODE_V | Key V. | 2953| ARKUI_KEYCODE_W | Key W. | 2954| ARKUI_KEYCODE_X | Key X. | 2955| ARKUI_KEYCODE_Y | Key Y. | 2956| ARKUI_KEYCODE_Z | Key Z. | 2957| ARKUI_KEYCODE_COMMA | Key ,. | 2958| ARKUI_KEYCODE_PERIOD | Key .. | 2959| ARKUI_KEYCODE_ALT_LEFT | Left Alt key. | 2960| ARKUI_KEYCODE_ALT_RIGHT | Right Alt key. | 2961| ARKUI_KEYCODE_SHIFT_LEFT | Left Shift key. | 2962| ARKUI_KEYCODE_SHIFT_RIGHT | Right Shift key. | 2963| ARKUI_KEYCODE_TAB | Tab key. | 2964| ARKUI_KEYCODE_SPACE | Space key. | 2965| ARKUI_KEYCODE_SYM | Symbol key. | 2966| ARKUI_KEYCODE_EXPLORER | Explorer key, which is used to start the explorer application. | 2967| ARKUI_KEYCODE_ENVELOPE | Email key, which is used to start the email application. | 2968| ARKUI_KEYCODE_ENTER | Enter key. | 2969| ARKUI_KEYCODE_DEL | Delete key. | 2970| ARKUI_KEYCODE_GRAVE | Key `. | 2971| ARKUI_KEYCODE_MINUS | Key -. | 2972| ARKUI_KEYCODE_EQUALS | Key =. | 2973| ARKUI_KEYCODE_LEFT_BRACKET | Key [. | 2974| ARKUI_KEYCODE_RIGHT_BRACKET | Key ]. | 2975| ARKUI_KEYCODE_BACKSLASH | Key \. | 2976| ARKUI_KEYCODE_SEMICOLON | Key ;. | 2977| ARKUI_KEYCODE_APOSTROPHE | Key '. | 2978| ARKUI_KEYCODE_SLASH | Key /. | 2979| ARKUI_KEYCODE_AT | Key @. | 2980| ARKUI_KEYCODE_PLUS | Key +. | 2981| ARKUI_KEYCODE_MENU | Menu key. | 2982| ARKUI_KEYCODE_PAGE_UP | Page Up key. | 2983| ARKUI_KEYCODE_PAGE_DOWN | Page Down key. | 2984| ARKUI_KEYCODE_ESCAPE | ESC key. | 2985| ARKUI_KEYCODE_FORWARD_DEL | Forward Delete key. | 2986| ARKUI_KEYCODE_CTRL_LEFT | Left Ctrl key. | 2987| ARKUI_KEYCODE_CTRL_RIGHT | Right Ctrl key. | 2988| ARKUI_KEYCODE_CAPS_LOCK | Caps Lock key. | 2989| ARKUI_KEYCODE_SCROLL_LOCK | Scroll Lock key. | 2990| ARKUI_KEYCODE_META_LEFT | Left Meta key. | 2991| ARKUI_KEYCODE_META_RIGHT | Right Meta key. | 2992| ARKUI_KEYCODE_FUNCTION | Function key. | 2993| ARKUI_KEYCODE_SYSRQ | System Request/Print Screen key. | 2994| ARKUI_KEYCODE_BREAK | Break/Pause key. | 2995| ARKUI_KEYCODE_MOVE_HOME | Move to Home key. | 2996| ARKUI_KEYCODE_MOVE_END | Move to End key. | 2997| ARKUI_KEYCODE_INSERT | Insert key. | 2998| ARKUI_KEYCODE_FORWARD | Forward key. | 2999| ARKUI_KEYCODE_MEDIA_PLAY | Play key. | 3000| ARKUI_KEYCODE_MEDIA_PAUSE | Pause key. | 3001| ARKUI_KEYCODE_MEDIA_CLOSE | Close key. | 3002| ARKUI_KEYCODE_MEDIA_EJECT | Eject key. | 3003| ARKUI_KEYCODE_MEDIA_RECORD | Record key. | 3004| ARKUI_KEYCODE_F1 | F1 key. | 3005| ARKUI_KEYCODE_F2 | F2 key. | 3006| ARKUI_KEYCODE_F3 | F3 key. | 3007| ARKUI_KEYCODE_F4 | F4 key. | 3008| ARKUI_KEYCODE_F5 | F5 key. | 3009| ARKUI_KEYCODE_F6 | F6 key. | 3010| ARKUI_KEYCODE_F7 | F7 key. | 3011| ARKUI_KEYCODE_F8 | F8 key. | 3012| ARKUI_KEYCODE_F9 | F9 key. | 3013| ARKUI_KEYCODE_F10 | F10 key. | 3014| ARKUI_KEYCODE_F11 | F11 key. | 3015| ARKUI_KEYCODE_F12 | F12 key. | 3016| ARKUI_KEYCODE_NUM_LOCK | Number Lock key. | 3017| ARKUI_KEYCODE_NUMPAD_0 | Key 0 on numeric keypad. | 3018| ARKUI_KEYCODE_NUMPAD_1 | Key 1 on numeric keypad. | 3019| ARKUI_KEYCODE_NUMPAD_2 | Key 2 on numeric keypad. | 3020| ARKUI_KEYCODE_NUMPAD_3 | Key 3 on numeric keypad. | 3021| ARKUI_KEYCODE_NUMPAD_4 | Key 4 on numeric keypad. | 3022| ARKUI_KEYCODE_NUMPAD_5 | Key 5 on numeric keypad. | 3023| ARKUI_KEYCODE_NUMPAD_6 | Key 6 on numeric keypad. | 3024| ARKUI_KEYCODE_NUMPAD_7 | Key 7 on numeric keypad. | 3025| ARKUI_KEYCODE_NUMPAD_8 | Key 8 on numeric keypad. | 3026| ARKUI_KEYCODE_NUMPAD_9 | Key 9 on numeric keypad. | 3027| ARKUI_KEYCODE_NUMPAD_DIVIDE | Key / on numeric keypad. | 3028| ARKUI_KEYCODE_NUMPAD_MULTIPLY | Key * on numeric keypad. | 3029| ARKUI_KEYCODE_NUMPAD_SUBTRACT | Key - on numeric keypad. | 3030| ARKUI_KEYCODE_NUMPAD_ADD | Key + on numeric keypad. | 3031| ARKUI_KEYCODE_NUMPAD_DOT | Key . on numeric keypad. | 3032| ARKUI_KEYCODE_NUMPAD_COMMA | Key , on numeric keypad. | 3033| ARKUI_KEYCODE_NUMPAD_ENTER | Enter key on numeric keypad. | 3034| ARKUI_KEYCODE_NUMPAD_EQUALS | Key = on numeric keypad. | 3035| ARKUI_KEYCODE_NUMPAD_LEFT_PAREN | Key ( on numeric keypad. | 3036| ARKUI_KEYCODE_NUMPAD_RIGHT_PAREN | Key ) on numeric keypad. | 3037 3038 3039### ArkUI_KeyEventType 3040 3041``` 3042enum ArkUI_KeyEventType 3043``` 3044**Description** 3045 3046Type of a key. 3047 3048**Since**: 14 3049 3050| Enum| Description| 3051| -------- | -------- | 3052| ARKUI_KEY_EVENT_UNKNOWN | Unknown. | 3053| ARKUI_KEY_EVENT_DOWN | Pressing of a key. | 3054| ARKUI_KEY_EVENT_UP | Release of a key. | 3055| ARKUI_KEY_EVENT_LONG_PRESS | Long press of a key. | 3056| ARKUI_KEY_EVENT_CLICK | Click of a key. | 3057 3058 3059### ArkUI_KeyIntension 3060 3061``` 3062enum ArkUI_KeyIntension 3063``` 3064**Description** 3065 3066Enumerates the key intentions. 3067 3068**Since**: 14 3069 3070| Enum| Description| 3071| -------- | -------- | 3072| ARKUI_KEY_INTENSION_UNKNOWN | Unknown intention. | 3073| ARKUI_KEY_INTENSION_UP | Upward. | 3074| ARKUI_KEY_INTENSION_DOWN | Downward. | 3075| ARKUI_KEY_INTENSION_LEFT | Leftward. | 3076| ARKUI_KEY_INTENSION_RIGHT | Rightward. | 3077| ARKUI_KEY_INTENSION_SELECT | Select. | 3078| ARKUI_KEY_INTENSION_ESCAPE | | 3079| ARKUI_KEY_INTENSION_BACK | Back. | 3080| ARKUI_KEY_INTENSION_FORWARD | Forward. | 3081| ARKUI_KEY_INTENSION_MENU | Menu. | 3082| ARKUI_KEY_INTENSION_HOME | Home. | 3083| ARKUI_KEY_INTENSION_PAGE_UP | Page up. | 3084| ARKUI_KEY_INTENSION_PAGE_DOWN | Page down. | 3085| ARKUI_KEY_INTENSION_ZOOM_OUT | Zoom out. | 3086| ARKUI_KEY_INTENSION_ZOOM_IN | Zoom in. | 3087| ARKUI_KEY_INTENTION_MEDIA_PLAY_PAUSE | Play. | 3088| ARKUI_KEY_INTENTION_MEDIA_FAST_FORWARD | Fast-forward. | 3089| ARKUI_KEY_INTENTION_MEDIA_FAST_PLAYBACK | Fast playback. | 3090| ARKUI_KEY_INTENTION_MEDIA_NEXT | Play next. | 3091| ARKUI_KEY_INTENTION_MEDIA_PREVIOUS | Play previous. | 3092| ARKUI_KEY_INTENTION_MEDIA_MUTE | Mute. | 3093| ARKUI_KEY_INTENTION_VOLUME_UP | Volume up. | 3094| ARKUI_KEY_INTENTION_VOLUME_DOWN | Volume down. | 3095| ARKUI_KEY_INTENTION_CALL | Answer a call. | 3096| ARKUI_KEY_INTENTION_CAMERA | Camera. | 3097 3098 3099### ArkUI_KeySourceType 3100 3101``` 3102enum ArkUI_KeySourceType 3103``` 3104**Description** 3105 3106Enumerates the types of input devices that trigger key events. 3107 3108**Since**: 14 3109 3110| Enum| Description| 3111| -------- | -------- | 3112| ARKUI_KEY_SOURCE_UNKNOWN | Unknown type. | 3113| ARKUI_KEY_SOURCE_TYPE_MOUSE | Mouse. | 3114| ARKUI_KEY_SOURCE_TYPE_KEYBOARD | Keyboard. | 3115| ARKUI_KEY_SOURCE_TYPE_JOYSTICK | Joystick. | 3116 3117 3118### ArkUI_LengthMetricUnit 3119 3120``` 3121enum ArkUI_LengthMetricUnit 3122``` 3123**Description** 3124 3125Enumerates the component units. 3126 3127**Since**: 12 3128 3129| Enum| Description| 3130| -------- | -------- | 3131| ARKUI_LENGTH_METRIC_UNIT_DEFAULT | Default, which is fp for fonts and vp for non-fonts. | 3132| ARKUI_LENGTH_METRIC_UNIT_PX | px. | 3133| ARKUI_LENGTH_METRIC_UNIT_VP | vp. | 3134| ARKUI_LENGTH_METRIC_UNIT_FP | fp. | 3135 3136 3137### ArkUI_LinearGradientDirection 3138 3139``` 3140enum ArkUI_LinearGradientDirection 3141``` 3142**Description** 3143 3144Enumerates the gradient directions. 3145 3146**Since**: 12 3147 3148| Enum| Description| 3149| -------- | -------- | 3150| ARKUI_LINEAR_GRADIENT_DIRECTION_LEFT | From right to left. | 3151| ARKUI_LINEAR_GRADIENT_DIRECTION_TOP | From bottom to top. | 3152| ARKUI_LINEAR_GRADIENT_DIRECTION_RIGHT | From left to right. | 3153| ARKUI_LINEAR_GRADIENT_DIRECTION_BOTTOM | From top to bottom. | 3154| ARKUI_LINEAR_GRADIENT_DIRECTION_LEFT_TOP | From lower right to upper left. | 3155| ARKUI_LINEAR_GRADIENT_DIRECTION_LEFT_BOTTOM | From upper right to lower left. | 3156| ARKUI_LINEAR_GRADIENT_DIRECTION_RIGHT_TOP | From lower left to upper right. | 3157| ARKUI_LINEAR_GRADIENT_DIRECTION_RIGHT_BOTTOM | From upper left to lower right. | 3158| ARKUI_LINEAR_GRADIENT_DIRECTION_NONE | No gradient. | 3159| ARKUI_LINEAR_GRADIENT_DIRECTION_CUSTOM | Custom direction. | 3160 3161 3162### ArkUI_ListItemAlignment 3163 3164``` 3165enum ArkUI_ListItemAlignment 3166``` 3167**Description** 3168 3169Enumerates the alignment modes of items along the cross axis. 3170 3171**Since**: 12 3172 3173| Enum| Description| 3174| -------- | -------- | 3175| ARKUI_LIST_ITEM_ALIGNMENT_START | The list items are packed toward the start edge of the **List** component along the cross axis. | 3176| ARKUI_LIST_ITEM_ALIGNMENT_CENTER | The list items are centered in the **List** component along the cross axis. | 3177| ARKUI_LIST_ITEM_ALIGNMENT_END | The list items are packed toward the end edge of the **List** component along the cross axis. | 3178 3179 3180### ArkUI_ListItemSwipeActionState 3181 3182``` 3183enum ArkUI_ListItemSwipeActionState 3184``` 3185**Description** 3186 3187Enumerates the swipe action item states of list items. 3188 3189**Since**: 12 3190 3191| Enum| Description| 3192| -------- | -------- | 3193| 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. | 3194| 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. | 3195| ARKUI_LIST_ITEM_SWIPE_ACTION_STATE_ACTIONING | In-action state. The list item is in this state when it enters the delete area. | 3196 3197 3198### ArkUI_ListItemSwipeEdgeEffect 3199 3200``` 3201enum ArkUI_ListItemSwipeEdgeEffect 3202``` 3203**Description** 3204 3205Enumerates the swipe action item edge effects of list items. 3206 3207**Since**: 12 3208 3209| Enum| Description| 3210| -------- | -------- | 3211| 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. | 3212| ARKUI_LIST_ITEM_SWIPE_EDGE_EFFECT_NONE | The list item cannot scroll beyond the edge of the list. | 3213 3214 3215### ArkUI_MaskType 3216 3217``` 3218enum ArkUI_MaskType 3219``` 3220**Description** 3221 3222Enumerates the mask types. 3223 3224**Since**: 12 3225 3226| Enum| Description| 3227| -------- | -------- | 3228| ARKUI_MASK_TYPE_RECTANGLE | Rectangle. | 3229| ARKUI_MASK_TYPE_CIRCLE | **(circle)** | 3230| ARKUI_MASK_TYPE_ELLIPSE | Ellipse. | 3231| ARKUI_MASK_TYPE_PATH | Path Type | 3232| ARKUI_MASK_TYPE_PROGRESS | Progress indicator. | 3233 3234 3235### ArkUI_NativeAPIVariantKind 3236 3237``` 3238enum ArkUI_NativeAPIVariantKind 3239``` 3240**Description** 3241 3242Defines the native API types. 3243 3244**Since**: 12 3245 3246| Enum| Description| 3247| -------- | -------- | 3248| ARKUI_NATIVE_NODE | API related to UI components. For details, see the struct definition in <arkui/native_node.h>. | 3249| ARKUI_NATIVE_DIALOG | API related to dialog boxes. For details, see the struct definition in <arkui/native_dialog.h>. | 3250| ARKUI_NATIVE_GESTURE | API related to gestures. For details, see the struct definition in <arkui/native_gesture.h>. | 3251| ARKUI_NATIVE_ANIMATE | API related to animations. For details, see the struct definition in <arkui/native_animate.h>. | 3252 3253 3254### ArkUI_NavDestinationState 3255 3256``` 3257enum ArkUI_NavDestinationState 3258``` 3259**Description** 3260 3261Defines an enum for the **NavDestination** component states. 3262 3263**Since**: 12 3264 3265| Enum| Description| 3266| -------- | -------- | 3267| ARKUI_NAV_DESTINATION_STATE_ON_SHOW | The **NavDestination** component is displayed. | 3268| ARKUI_NAV_DESTINATION_STATE_ON_HIDE | The **NavDestination** component is hidden. | 3269| ARKUI_NAV_DESTINATION_STATE_ON_APPEAR | The **NavDestination** component is mounted to the component tree. | 3270| ARKUI_NAV_DESTINATION_STATE_ON_DISAPPEAR | The **NavDestination** component is unmounted from the component tree. | 3271| ARKUI_NAV_DESTINATION_STATE_ON_WILL_SHOW | The **NavDestination** is about to be displayed. | 3272| ARKUI_NAV_DESTINATION_STATE_ON_WILL_HIDE | The **NavDestination** is about to be hidden. | 3273| ARKUI_NAV_DESTINATION_STATE_ON_WILL_APPEAR | The **NavDestination** is about to be mounted to the component tree. | 3274| ARKUI_NAV_DESTINATION_STATE_ON_WILL_DISAPPEAR | The **NavDestination** component is about to be unmounted from the component tree. | 3275| ARKUI_NAV_DESTINATION_STATE_ON_BACK_PRESS | The back button is pressed for the **NavDestination** component. | 3276 3277 3278### ArkUI_NodeAdapterEventType 3279 3280``` 3281enum ArkUI_NodeAdapterEventType 3282``` 3283**Description** 3284 3285Enumerates node adapter events. 3286 3287**Since**: 12 3288 3289| Enum| Description| 3290| -------- | -------- | 3291| NODE_ADAPTER_EVENT_WILL_ATTACH_TO_NODE | This event occurs when the component is attached to the adapter. | 3292| NODE_ADAPTER_EVENT_WILL_DETACH_FROM_NODE | This event occurs when the component is detached from the adapter. | 3293| NODE_ADAPTER_EVENT_ON_GET_NODE_ID | This event occurs when the adapter obtains the unique ID of the new element to add. | 3294| NODE_ADAPTER_EVENT_ON_ADD_NODE_TO_ADAPTER | This event occurs when the adapter obtains the content of the new element to add. | 3295| NODE_ADAPTER_EVENT_ON_REMOVE_NODE_FROM_ADAPTER | This event occurs when the adapter removes an element. | 3296 3297### ArkUI_NodeAttributeType 3298 3299``` 3300enum ArkUI_NodeAttributeType 3301``` 3302**Description** 3303 3304Defines the ArkUI style attributes that can be set on the native side. 3305 3306**Since**: 12 3307 3308 3309| Enum| Description| 3310| -------- | -------- | 3311| 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.| 3312| 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.| 3313| 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.| 3314| 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.| 3315| 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.| 3316| 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.| 3317| 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. | 3318| 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.| 3319| 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.| 3320| 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.| 3321| 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.| 3322| 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.| 3323| 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.| 3324| 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.| 3325| 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.| 3326| 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).| 3327| 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.| 3328| 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.| 3329| 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.| 3330| 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**.| 3331| 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.| 3332| 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.| 3333| 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**.| 3334| 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.| 3335| 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.| 3336| 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.| 3337| 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**.| 3338| 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.| 3339| 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).| 3340| 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.| 3341| 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.| 3342| 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).| 3343| 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.| 3344| 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.| 3345| 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.| 3346| 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.| 3347| 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.| 3348| 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.| 3349| 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.| 3350| 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.| 3351| 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.| 3352| 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.| 3353| 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.| 3354| 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.| 3355| 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.| 3356| 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.| 3357| 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**.| 3358| 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**.| 3359| 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.| 3360| 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.| 3361| 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.| 3362| 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.| 3363| 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).| 3364| 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.| 3365| 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.| 3366| 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.| 3367| 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.| 3368| 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.| 3369| 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**.| 3370| 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.| 3371| 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.| 3372| 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.| 3373| 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**.| 3374| 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.| 3375| 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).| 3376| 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.| 3377| 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.| 3378| 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.| 3379| 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.| 3380| 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.| 3381| 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.| 3382| 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. | 3383| 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. | 3384| 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. | 3385| 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. | 3386| 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.| 3387| 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).| 3388| 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.| 3389| 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**.| 3390| 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.| 3391| 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.| 3392| 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**.| 3393| 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].| 3394| 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. | 3395| 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.| 3396| 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.| 3397| 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.| 3398| 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.| 3399| 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).| 3400| 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).| 3401| 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).| 3402| 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).| 3403| 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> | 3404| 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> | 3405| 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).| 3406| 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.| 3407| 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.| 3408| 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.| 3409| 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.| 3410| 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 | 3411| 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 | 3412| 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.| 3413| 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.| 3414| 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.| 3415| 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).| 3416| 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).| 3417| 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.| 3418| 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).| 3419| 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.| 3420| 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.| 3421| 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.| 3422| 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).| 3423| 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} | 3424| 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 (,).| 3425| 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).| 3426| 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.| 3427| 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.| 3428| 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.| 3429| 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.| 3430| 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**.| 3431| 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).| 3432| 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.| 3433| 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).| 3434| 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).| 3435| 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. | 3436| 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 (,).| 3437| 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.| 3438| 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).| 3439| 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.| 3440| 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).| 3441| 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.| 3442| 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).| 3443| 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.| 3444| 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.| 3445| 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.| 3446| 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.| 3447| 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.| 3448| 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).| 3449| 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.| 3450| 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).| 3451| 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.| 3452| 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.| 3453| 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.| 3454| 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**.| 3455| 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.| 3456| 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).| 3457| 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.| 3458| 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).| 3459| 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.| 3460| 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.| 3461| 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.| 3462| 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.| 3463| 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.| 3464| 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.| 3465| 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.| 3466| 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.| 3467| 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.| 3468| 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.| 3469| 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.| 3470| 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. | 3471| 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.| 3472| 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.| 3473| 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.| 3474| 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).| 3475| 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.| 3476| 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 (,).| 3477| 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.| 3478| 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).| 3479| 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.| 3480| 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.| 3481| 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.| 3482| 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.| 3483| 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. | 3484| 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. | 3485| 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.| 3486| 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).| 3487| 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.| 3488| 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.| 3489| 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.| 3490| 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).| 3491| 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.| 3492| 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.| 3493| 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.| 3494| 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.| 3495| 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.| 3496| 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.| 3497| 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).| 3498| 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.| 3499| 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.| 3500| 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.| 3501| 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.| 3502| 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 | 3503| 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.| 3504| 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.| 3505| 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.| 3506| 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.| 3507| 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 (,).| 3508| 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.| 3509| 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.| 3510| 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).| 3511| 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**.| 3512| 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.| 3513| 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.| 3514| 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.| 3515| 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.| 3516| 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).| 3517| 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.| 3518| 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.| 3519| 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.| 3520| 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.| 3521| 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. | 3522| 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.| 3523| 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).| 3524| 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.| 3525| 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.| 3526| 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.| 3527| 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.| 3528| 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 | 3529| 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.| 3530| 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: button style. The parameter type is [ArkUI_ButtonType](#arkui_buttontype). The default value is ARKUI_BUTTON_TYPE_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.| 3531| NODE_BUTTON_MIN_FONT_SCALE | 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.| 3532| NODE_BUTTON_MAX_FONT_SCALE | 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.| 3533| 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.| 3534| 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.| 3535| 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.| 3536| 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).| 3537| 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.| 3538| 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.| 3539| 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**.| 3540| 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**.| 3541| 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**.| 3542| 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).| 3543| 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.| 3544| 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.| 3545| 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.| 3546| 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).| 3547| 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. | 3548| 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.| 3549| 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. 3550| 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.| 3551| 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.| 3552| 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.| 3553| 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.| 3554| 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"**.| 3555| 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"**.| 3556| 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"**.| 3557| 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).| 3558| 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. 3559| 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.| 3560| 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.| 3561| 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"**.| 3562| 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"**.| 3563| 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"**.| 3564| 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"**.| 3565| 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"**.| 3566| 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.| 3567| 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).| 3568| 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.| 3569| 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 (;).| 3570| 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"**.| 3571| 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"**.| 3572| 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"**.| 3573| 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.| 3574| 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.| 3575| 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.| 3576| 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.| 3577| 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.| 3578| 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.| 3579| 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.| 3580| 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).| 3581| NODE_CALENDAR_PICKER_START<sup>16+</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. 3582| NODE_CALENDAR_PICKER_END<sup>16+</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. 3583| 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.| 3584| 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.| 3585| 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**.| 3586| 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**.| 3587| 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**.| 3588| 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.| 3589| 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.| 3590| 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.| 3591| 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.| 3592| 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.| 3593| 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].| 3594| 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).| 3595| 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.| 3596| 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).| 3597| 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. | 3598| 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.| 3599| 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.| 3600| 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**.| 3601| 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.| 3602| 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. | 3603| 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.| 3604| 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.| 3605| 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**.| 3606| 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**.| 3607| 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**.| 3608| 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).| 3609| 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).| 3610| 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).| 3611| 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.| 3612| 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.| 3613| 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).| 3614| 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 | 3615| 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.| 3616| 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.| 3617| 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.| 3618| 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).| 3619| 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.| 3620| 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).| 3621| 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.| 3622| 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.| 3623| 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.| 3624| 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.| 3625| 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 | 3626| 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 | 3627| 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.| 3628| 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.| 3629| 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).| 3630| 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).| 3631| 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.| 3632| 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.| 3633| 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.| 3634| 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.| 3635| 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**.| 3636| 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**.| 3637| 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**.| 3638| 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.| 3639| 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**.| 3640| 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.| 3641| 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).| 3642| 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.| 3643| 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.| 3644| 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**.| 3645| 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**.| 3646| 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**.| 3647| 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.| 3648| 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**.| 3649| 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**.| 3650| 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.| 3651| 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.| 3652| 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.| 3653| 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>**Since**<br>15<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**<br>15| 3654| 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**.| 3655| 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>15 <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>15 | 3656| 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).| 3657| 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.| 3658| 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>15<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>15 | 3659| 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.| 3660| 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.| 3661| 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>15 <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>15 | 3662| 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).| 3663| 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.| 3664| 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.| 3665| 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 | 3666| 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>15 | 3667| 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.| 3668| 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.| 3669| 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.| 3670| 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.| 3671| 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**.| 3672| 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. | 3673| 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).| 3674| 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).| 3675| 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).| 3676| 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).| 3677| 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.| 3678| 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.| 3679| 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**.| 3680| 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.| 3681| 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.| 3682| 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.| 3683| 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**.| 3684| 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.| 3685| 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.| 3686| 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.| 3687| 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.| 3688| 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.| 3689| 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.| 3690| 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.| 3691| 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).| 3692| 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**.| 3693| 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. | 3694| 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**.| 3695| 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.| 3696| 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.| 3697| 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.| 3698| 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.| 3699| 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.| 3700| 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.| 3701| 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. | 3702| NODE_TEXT_PICKER_COLUMN_WIDTHS<sup>16+</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.| 3703| 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**. | 3704| 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).| 3705| 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**.| 3706| 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.| 3707| 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.| 3708| 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**.| 3709| 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.| 3710| 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].| 3711 3712 3713### ArkUI_DatePickerMode 3714 3715``` 3716enum ArkUI_DatePickerMode 3717``` 3718**Description** 3719 3720Enumerates the column display modes of the date picker. 3721 3722**Since**: 16 3723 3724| Enum| Description| 3725| -------- | -------- | 3726| ARKUI_DATEPICKER_MODE_DATE | Default value. The date displays three columns: year, month, and day.| 3727| ARKUI_DATEPICKER_YEAR_AND_MONTH | The date displays two columns: year and month.| 3728| 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.| 3729 3730### ArkUI_NodeContentEventType 3731 3732``` 3733enum ArkUI_NodeContentEventType 3734``` 3735**Description** 3736 3737Defines the NodeContent event type. 3738 3739**Since**: 12 3740 3741| Enum| Description| 3742| -------- | -------- | 3743| NODE_CONTENT_EVENT_ON_ATTACH_TO_WINDOW | Attach event. | 3744| NODE_CONTENT_EVENT_ON_DETACH_FROM_WINDOW | Detach event. | 3745 3746 3747### ArkUI_NodeCustomEventType 3748 3749``` 3750enum ArkUI_NodeCustomEventType 3751``` 3752**Description** 3753 3754Enumerates the custom component event types. 3755 3756**Since**: 12 3757 3758| Enum| Description| 3759| -------- | -------- | 3760| ARKUI_NODE_CUSTOM_EVENT_ON_MEASURE | Measure. | 3761| ARKUI_NODE_CUSTOM_EVENT_ON_LAYOUT | Layout. | 3762| ARKUI_NODE_CUSTOM_EVENT_ON_DRAW | Draw. | 3763| ARKUI_NODE_CUSTOM_EVENT_ON_FOREGROUND_DRAW | Foreground. | 3764| ARKUI_NODE_CUSTOM_EVENT_ON_OVERLAY_DRAW | Overlay. | 3765 3766### ArkUI_NodeDirtyFlag 3767 3768``` 3769enum ArkUI_NodeDirtyFlag 3770``` 3771**Description** 3772 3773Enumerates the dirty area flags passed in the **::markDirty** API. 3774 3775**Since**: 12 3776 3777| Enum| Description| 3778| -------- | -------- | 3779| NODE_NEED_MEASURE | Remeasure.<br>When this type of flag is specified, re-layout is triggered by default.| 3780| NODE_NEED_LAYOUT | Re-layout. | 3781| NODE_NEED_RENDER | Re-rendering. | 3782 3783 3784### ArkUI_NodeEventType 3785 3786``` 3787enum ArkUI_NodeEventType 3788``` 3789**Description** 3790 3791Enumerates the event types supported by the NativeNode component. 3792 3793**Since**: 12 3794 3795| Enum| Description| 3796| -------- | -------- | 3797| 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).| 3798| 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.| 3799| 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.| 3800| 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.| 3801| 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.| 3802| 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.| 3803| 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.| 3804| 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).| 3805| 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).| 3806| 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.| 3807| 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.| 3808| 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).| 3809| 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).| 3810| 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.| 3811| 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.| 3812| 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).| 3813| 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).| 3814| 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.| 3815| 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.| 3816| 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.| 3817| 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.| 3818| 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.| 3819| 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.| 3820| 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 | 3821| 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 | 3822| 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| 3823| 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 | 3824| 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 | 3825| 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.| 3826| 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.| 3827| 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.| 3828| 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.| 3829| 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:.| 3830| 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.| 3831| 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.| 3832| 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.| 3833| 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.| 3834| 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.| 3835| 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.| 3836| 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.| 3837| 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.| 3838| 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.| 3839| 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.| 3840| 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**.| 3841| 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**.| 3842| 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**.| 3843| 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**.| 3844| 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.| 3845| 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.| 3846| 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.| 3847| 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.| 3848| 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.| 3849| 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.| 3850| 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.| 3851| 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.| 3852| 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.| 3853| 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**.| 3854| 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**.| 3855| 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**.| 3856| 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**.| 3857| 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.| 3858| 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| 3859| 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.| 3860| 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.| 3861| 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.| 3862| 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.| 3863| 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.| 3864| 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.| 3865| 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.| 3866| 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.| 3867| 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.| 3868| 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.| 3869| 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.| 3870| 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.| 3871| 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.| 3872| 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.| 3873| 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.| 3874| 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.| 3875| 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.| 3876| NODE_SWIPER_EVENT_ON_SELECTED<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 currently selected element.| 3877| 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.| 3878| 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.| 3879| 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.| 3880| 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.| 3881| 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.| 3882| 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).| 3883| 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.| 3884| 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.| 3885| 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.| 3886| 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.| 3887| 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.| 3888| 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.| 3889| 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.| 3890| 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.| 3891| 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**.| 3892| 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.| 3893| 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.| 3894| 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.| 3895| 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.| 3896| 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:.| 3897| 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:.| 3898 3899 3900### ArkUI_NodeType 3901 3902``` 3903enum ArkUI_NodeType 3904``` 3905**Description** 3906 3907Enumerates ArkUI component types that can be created on the native side. 3908 3909**Since**: 12 3910 3911| Enum| Description| 3912| -------- | -------- | 3913| ARKUI_NODE_CUSTOM | *Custom nodes* | 3914| ARKUI_NODE_TEXT | Text to insert. | 3915| ARKUI_NODE_SPAN | Text span. | 3916| ARKUI_NODE_IMAGE_SPAN | Image span. | 3917| ARKUI_NODE_IMAGE | Image. | 3918| ARKUI_NODE_TOGGLE | Toggle. | 3919| ARKUI_NODE_LOADING_PROGRESS | Loading icon. | 3920| ARKUI_NODE_TEXT_INPUT | Single-line text input. | 3921| ARKUI_NODE_TEXT_AREA | Multi-line text input. | 3922| ARKUI_NODE_BUTTON | Icon | 3923| ARKUI_NODE_PROGRESS | Progress indicator. | 3924| ARKUI_NODE_CHECKBOX | Check box. | 3925| ARKUI_NODE_XCOMPONENT | XComponent of the SURFACE type. | 3926| ARKUI_NODE_DATE_PICKER | Date picker. | 3927| ARKUI_NODE_TIME_PICKER | Time picker. | 3928| ARKUI_NODE_TEXT_PICKER | Text picker. | 3929| ARKUI_NODE_CALENDAR_PICKER | Calendar picker. | 3930| ARKUI_NODE_SLIDER | Slider. | 3931| ARKUI_NODE_RADIO | Radio button. | 3932| ARKUI_NODE_IMAGE_ANIMATOR | Frame animation component. | 3933| ARKUI_NODE_XCOMPONENT_TEXTURE | XComponent of the TEXTURE type. | 3934| ARKUI_NODE_CHECKBOX_GROUP | Check box group.| 3935| ARKUI_NODE_STACK | Stack container. | 3936| ARKUI_NODE_SWIPER | Swiper. | 3937| ARKUI_NODE_SCROLL | Scrolling container. | 3938| ARKUI_NODE_LIST | List. | 3939| ARKUI_NODE_LIST_ITEM | List item. | 3940| ARKUI_NODE_LIST_ITEM_GROUP | List item group. | 3941| ARKUI_NODE_COLUMN | Column container. | 3942| ARKUI_NODE_ROW | Row container. | 3943| ARKUI_NODE_FLEX | Flex container. | 3944| ARKUI_NODE_REFRESH | Refresh component. | 3945| ARKUI_NODE_WATER_FLOW | Water flow container. | 3946| ARKUI_NODE_FLOW_ITEM | Water flow item. | 3947| ARKUI_NODE_RELATIVE_CONTAINER | Relative layout component. | 3948| ARKUI_NODE_GRID | Grid. | 3949| ARKUI_NODE_GRID_ITEM | Grid item. | 3950| ARKUI_NODE_CUSTOM_SPAN | Custom span. | 3951 3952 3953### ArkUI_ObjectFit 3954 3955``` 3956enum ArkUI_ObjectFit 3957``` 3958**Description** 3959 3960Enumerates the image filling effects. ImageSpanAlignment 3961 3962**Since**: 12 3963 3964| Enum| Description| 3965| -------- | -------- | 3966| ARKUI_OBJECT_FIT_CONTAIN | The image is scaled with its aspect ratio retained for the content to be completely displayed within the display boundaries. | 3967| 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. | 3968| ARKUI_OBJECT_FIT_AUTO | The image is scaled automatically to fit the display area. | 3969| ARKUI_OBJECT_FIT_FILL | The image is scaled to fill the display area, and its aspect ratio is not retained. | 3970| 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. | 3971| ARKUI_OBJECT_FIT_NONE | The original size is retained. | 3972| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_TOP_START | Not resized, the image is aligned with the start edge of the top of the container. | 3973| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_TOP | Not resized, the image is horizontally centered at the top of the container. | 3974| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_TOP_END | Not resized, the image is aligned with the end edge at the top of the container. | 3975| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_START | Not resized, the image is vertically centered on the start edge of the container. | 3976| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_CENTER | Not resized, the image is horizontally and vertically centered in the container. | 3977| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_END | Not resized, the image is vertically centered on the end edge of the container. | 3978| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_BOTTOM_START | Not resized, the image is aligned with the start edge at the bottom of the container. | 3979| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_BOTTOM | Not resized, the image is horizontally centered at the bottom of the container. | 3980| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_BOTTOM_END | Not resized, the image is aligned with the end edge at the bottom of the container. | 3981 3982 3983### ArkUI_PageFlipMode 3984 3985``` 3986enum ArkUI_PageFlipMode 3987``` 3988**Description** 3989 3990Enumerates the page flipping modes using the mouse wheel for the <b>Swiper</b> component. 3991 3992**Since**: 14 3993 3994| Enum| Description| 3995| -------- | -------- | 3996| 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. | 3997| ARKUI_PAGE_FLIP_MODE_SINGLE | The system does not respond to other mouse wheel events until the page flipping animation ends. | 3998 3999 4000### ArkUI_SwiperAnimationMode 4001 4002``` 4003enum ArkUI_SwiperAnimationMode 4004``` 4005**Description** 4006 4007Enumerates the animation modes for the **Swiper** component when jumping to the page with the specified index. 4008 4009**Since**: 15 4010 4011| Enum| Description| 4012| -------- | -------- | 4013| ARKUI_SWIPER_NO_ANIMATION | Jumps to the target page without any animation. | 4014| ARKUI_SWIPER_DEFAULT_ANIMATION | Animates smoothly to the target page. | 4015| ARKUI_SWIPER_FAST_ANIMATION | First jumps to a position near the target page without animation, then animates to the target page. | 4016 4017 4018### ArkUI_PreDragStatus 4019 4020``` 4021enum ArkUI_PreDragStatus 4022``` 4023**Description** 4024 4025Defines an enum for interaction states prior to a drop and drop operation. 4026 4027**Since**: 12 4028 4029| Enum| Description| 4030| -------- | -------- | 4031| ARKUI_PRE_DRAG_STATUS_UNKNOWN | Unknown. | 4032| ARKUI_PRE_DRAG_STATUS_ACTION_DETECTING | A drag gesture is being detected. | 4033| ARKUI_PRE_DRAG_STATUS_READY_TO_TRIGGER_DRAG | The component is ready to be dragged. | 4034| ARKUI_PRE_DRAG_STATUS_PREVIEW_LIFT_STARTED | A lift animation is started. | 4035| ARKUI_PRE_DRAG_STATUS_PREVIEW_LIFT_FINISHED | A lift animation is finished. | 4036| ARKUI_PRE_DRAG_STATUS_PREVIEW_LANDING_STARTED | A drop animation is started. | 4037| ARKUI_PRE_DRAG_STATUS_PREVIEW_LANDING_FINISHED | A drop animation is finished. | 4038| ARKUI_PRE_DRAG_STATUS_CANCELED_BEFORE_DRAG | A drop animation is terminated. | 4039 4040 4041### ArkUI_ProgressType 4042 4043``` 4044enum ArkUI_ProgressType 4045``` 4046**Description** 4047 4048Enumerates the styles of the progress indicator. 4049 4050**Since**: 12 4051 4052| Enum| Description| 4053| -------- | -------- | 4054| ARKUI_PROGRESS_TYPE_LINEAR | Linear type. | 4055| ARKUI_PROGRESS_TYPE_RING | Indeterminate ring style. | 4056| ARKUI_PROGRESS_TYPE_ECLIPSE | Eclipse style. | 4057| ARKUI_PROGRESS_TYPE_SCALE_RING | Determinate ring style. | 4058| ARKUI_PROGRESS_TYPE_CAPSULE | Capsule style. | 4059 4060 4061### ArkUI_RelativeLayoutChainStyle 4062 4063``` 4064enum ArkUI_RelativeLayoutChainStyle 4065``` 4066**Description** 4067 4068Enumerates the chain styles. 4069 4070**Since**: 12 4071 4072| Enum| Description| 4073| -------- | -------- | 4074| ARKUI_RELATIVE_LAYOUT_CHAIN_STYLE_SPREAD | Child components are evenly distributed among constraint anchors. | 4075| ARKUI_RELATIVE_LAYOUT_CHAIN_STYLE_SPREAD_INSIDE | All child components except the first and last ones are evenly distributed among constraint anchors. | 4076| ARKUI_RELATIVE_LAYOUT_CHAIN_STYLE_PACKED | There is no gap between child components in the chain. | 4077 4078 4079### ArkUI_RenderFit 4080 4081``` 4082enum ArkUI_RenderFit 4083``` 4084 4085| Enum| Description| 4086| -------- | -------- | 4087| ARKUI_RENDER_FIT_CENTER | The component's content stays at the final size and always aligned with the center of the component. | 4088| ARKUI_RENDER_FIT_TOP | The component's content stays at the final size and always aligned with the top center of the component. | 4089| ARKUI_RENDER_FIT_BOTTOM | The component's content stays at the final size and always aligned with the bottom center of the component. | 4090| ARKUI_RENDER_FIT_LEFT | The component's content stays at the final size and always aligned with the left of the component. | 4091| ARKUI_RENDER_FIT_RIGHT | The component's content stays at the final size and always aligned with the right of the component. | 4092| 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. | 4093| 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. | 4094| 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. | 4095| 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. | 4096| 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. | 4097| 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. | 4098| 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. | 4099| 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. | 4100| 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. | 4101| 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. | 4102| 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. | 4103 4104 4105### ArkUI_RouterPageState 4106 4107``` 4108enum ArkUI_RouterPageState 4109``` 4110**Description** 4111 4112Enumerates the states of a page during routing. 4113 4114**Since**: 12 4115 4116| Enum| Description| 4117| -------- | -------- | 4118| ARKUI_ROUTER_PAGE_STATE_ON_WILL_APPEAR | The page is about to be displayed. | 4119| ARKUI_ROUTER_PAGE_STATE_ON_WILL_DISAPPEAR | The page is about to be destroyed. | 4120| ARKUI_ROUTER_PAGE_STATE_ON_SHOW | The page is displayed. | 4121| ARKUI_ROUTER_PAGE_STATE_ON_HIDE | The page is hidden. | 4122| ARKUI_ROUTER_PAGE_STATE_ON_BACK_PRESS | The back button is pressed for the page. | 4123 4124 4125### ArkUI_SafeAreaEdge 4126 4127``` 4128enum ArkUI_SafeAreaEdge 4129``` 4130**Description** 4131 4132Enumerates the edges for expanding the safe area. 4133 4134**Since**: 12 4135 4136| Enum| Description| 4137| -------- | -------- | 4138| ARKUI_SAFE_AREA_EDGE_TOP | Top edge. | 4139| ARKUI_SAFE_AREA_EDGE_BOTTOM | Bottom edge. | 4140| ARKUI_SAFE_AREA_EDGE_START | Start edge. | 4141| ARKUI_SAFE_AREA_EDGE_END | End edge. | 4142 4143 4144### ArkUI_SafeAreaType 4145 4146``` 4147enum ArkUI_SafeAreaType 4148``` 4149**Description** 4150 4151Enumerates the types of expanded safe areas. 4152 4153**Since**: 12 4154 4155| Enum| Description| 4156| -------- | -------- | 4157| ARKUI_SAFE_AREA_TYPE_SYSTEM | Default non-safe area of the system, including the status bar and navigation bar. | 4158| ARKUI_SAFE_AREA_TYPE_CUTOUT | Non-safe area of the device, for example, the notch area. | 4159| ARKUI_SAFE_AREA_TYPE_KEYBOARD | Soft keyboard area. | 4160 4161 4162### ArkUI_ListItemGroupArea 4163 4164``` 4165enum ArkUI_ListItemGroupArea 4166``` 4167**Description** 4168 4169Enumerates the component areas. 4170 4171**Since**: 15 4172 4173| Enum| Description| 4174| -------- | -------- | 4175| ARKUI_LIST_ITEM_GROUP_AREA_OUTSIDE | Outside the component area. | 4176| ARKUI_LIST_ITEM_SWIPE_AREA_NONE | Area when the component has no header, footer, or list items. | 4177| ARKUI_LIST_ITEM_SWIPE_AREA_ITEM | Area of the component's list items. | 4178| ARKUI_LIST_ITEM_SWIPE_AREA_HEADER | Header area of the component. | 4179| ARKUI_LIST_ITEM_SWIPE_AREA_FOOTER | Footer area of the component. | 4180 4181 4182### ArkUI_FocusMove 4183 4184``` 4185enum ArkUI_FocusMove 4186``` 4187**Description** 4188 4189Enumerates the focus movement directions. 4190 4191**Since**: 18 4192 4193| Enum| Description| 4194| -------- | -------- | 4195| ARKUI_FOCUS_MOVE_FORWARD | Tab key. | 4196| ARKUI_FOCUS_MOVE_BACKWARD | Shift+Tab key. | 4197| ARKUI_FOCUS_MOVE_UP | Up arrow key. | 4198| ARKUI_FOCUS_MOVE_DOWN | Down arrow key. | 4199| ARKUI_FOCUS_MOVE_LEFT | Left arrow key. | 4200| ARKUI_FOCUS_MOVE_RIGHT | Right arrow key. | 4201 4202### ArkUI_ScrollAlignment 4203 4204``` 4205enum ArkUI_ScrollAlignment 4206``` 4207**Description** 4208 4209Defines how the list item to scroll to is aligned with the container. 4210 4211**Since**: 12 4212 4213| Enum| Description| 4214| -------- | -------- | 4215| ARKUI_SCROLL_ALIGNMENT_START | The start edge of the list item is flush with the start edge of the container. | 4216| ARKUI_SCROLL_ALIGNMENT_CENTER | The list item is centered along the main axis of the list. | 4217| ARKUI_SCROLL_ALIGNMENT_END | The end edge of the list item Aligns the tail of an item with that of a container. | 4218| 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. | 4219 4220 4221### ArkUI_ScrollBarDisplayMode 4222 4223``` 4224enum ArkUI_ScrollBarDisplayMode 4225``` 4226**Description** 4227 4228Enumerates the scrollbar display modes. 4229 4230**Since**: 12 4231 4232| Enum| Description| 4233| -------- | -------- | 4234| ARKUI_SCROLL_BAR_DISPLAY_MODE_OFF | Not displayed. | 4235| ARKUI_SCROLL_BAR_DISPLAY_MODE_AUTO | Displayed when the screen is touched and hidden after 2s. | 4236| ARKUI_SCROLL_BAR_DISPLAY_MODE_ON | Always displayed. | 4237 4238 4239### ArkUI_ScrollDirection 4240 4241``` 4242enum ArkUI_ScrollDirection 4243``` 4244**Description** 4245 4246Enumerates the scroll directions of scrollable components. 4247 4248**Since**: 12 4249 4250| Enum| Description| 4251| -------- | -------- | 4252| ARKUI_SCROLL_DIRECTION_VERTICAL | Only vertical scrolling is supported. | 4253| ARKUI_SCROLL_DIRECTION_HORIZONTAL | Only horizontal scrolling is supported. | 4254| ARKUI_SCROLL_DIRECTION_NONE | Scrolling is forbidden. | 4255 4256 4257### ArkUI_ScrollEdge 4258 4259``` 4260enum ArkUI_ScrollEdge 4261``` 4262**Description** 4263 4264Defines the edge to which the component scrolls. 4265 4266**Since**: 12 4267 4268| Enum| Description| 4269| -------- | -------- | 4270| ARKUI_SCROLL_EDGE_TOP | Top edge in the vertical direction. | 4271| ARKUI_SCROLL_EDGE_BOTTOM | Bottom edge in the vertical direction. | 4272| ARKUI_SCROLL_EDGE_START | Start position in the horizontal direction. | 4273| ARKUI_SCROLL_EDGE_END | End position in the horizontal direction. | 4274 4275 4276### ArkUI_ScrollNestedMode 4277 4278``` 4279enum ArkUI_ScrollNestedMode 4280``` 4281**Description** 4282 4283Enumerates nested scrolling options. 4284 4285**Since**: 12 4286 4287| Enum| Description| 4288| -------- | -------- | 4289| 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. | 4290| 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. | 4291| 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. | 4292| 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. | 4293 4294 4295### ArkUI_ScrollSnapAlign 4296 4297``` 4298enum ArkUI_ScrollSnapAlign 4299``` 4300**Description** 4301 4302Enumerates the alignment modes of list items when scrolling ends. 4303 4304**Since**: 12 4305 4306| Enum| Description| 4307| -------- | -------- | 4308| ARKUI_SCROLL_SNAP_ALIGN_NONE | No alignment. This is the default value. | 4309| ARKUI_SCROLL_SNAP_ALIGN_START | The first item in the view is aligned at the start of the list. | 4310| ARKUI_SCROLL_SNAP_ALIGN_CENTER | The middle items in the view are aligned in the center of the list. | 4311| ARKUI_SCROLL_SNAP_ALIGN_END | The last item in the view is aligned at the end of the list. | 4312 4313 4314### ArkUI_ScrollSource 4315 4316``` 4317enum ArkUI_ScrollSource 4318``` 4319**Description** 4320 4321Enumerates the scrolling sources. 4322 4323**Since**: 12 4324 4325| Enum| Description| 4326| -------- | -------- | 4327| ARKUI_SCROLL_SOURCE_DRAG | Drag your finger. | 4328| ARKUI_SCROLL_SOURCE_FLING | Inertia scrolling after finger dragging. | 4329| ARKUI_SCROLL_SOURCE_EDGE_EFFECT | Executes the EdgeEffect.Spring edge special effect when the boundary is crossed. | 4330| ARKUI_SCROLL_SOURCE_OTHER_USER_INPUT | User input other than dragging, such as mouse wheel and keyboard events. | 4331| ARKUI_SCROLL_SOURCE_SCROLL_BAR | Scrollbar dragging | 4332| ARKUI_SCROLL_SOURCE_SCROLL_BAR_FLING | Inertial scrolling after the scroll bar is dragged. | 4333| ARKUI_SCROLL_SOURCE_SCROLLER | Scrolling by the scroll controller (without animation). | 4334| ARKUI_SCROLL_SOURCE_ANIMATION | Scrolling by the scroll controller (with animation). | 4335 4336 4337### ArkUI_ScrollState 4338 4339``` 4340enum ArkUI_ScrollState 4341``` 4342**Description** 4343 4344Enumerates the scrolling states. 4345 4346**Since**: 12 4347 4348| Enum| Description| 4349| -------- | -------- | 4350| 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. | 4351| ARKUI_SCROLL_STATE_SCROLL | Scrolling. The container enters this state when the user drags the container to scroll. | 4352| 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. | 4353 4354 4355### ArkUI_ShadowStyle 4356 4357``` 4358enum ArkUI_ShadowStyle 4359``` 4360**Description** 4361 4362Enumerated value of the shadow effect. 4363 4364**Since**: 12 4365 4366| Enum| Description| 4367| -------- | -------- | 4368| ARKUI_SHADOW_STYLE_OUTER_DEFAULT_XS | Mini shadow. | 4369| ARKUI_SHADOW_STYLE_OUTER_DEFAULT_SM | Small shadow. | 4370| ARKUI_SHADOW_STYLE_OUTER_DEFAULT_MD | Medium shadow. | 4371| ARKUI_SHADOW_STYLE_OUTER_DEFAULT_LG | Large shadow. | 4372| ARKUI_SHADOW_STYLE_OUTER_FLOATING_SM | Floating small shadow. | 4373| ARKUI_SHADOW_STYLE_OUTER_FLOATING_MD | Floating medium shadow. | 4374 4375 4376### ArkUI_ShadowType 4377 4378``` 4379enum ArkUI_ShadowType 4380``` 4381**Description** 4382 4383Defines the enumerated values of the shadow type. 4384 4385**Since**: 12 4386 4387| Enum| Description| 4388| -------- | -------- | 4389| ARKUI_SHADOW_TYPE_COLOR | Color. | 4390| ARKUI_SHADOW_TYPE_BLUR | Blur. | 4391 4392### ArkUI_ShapeType 4393 4394``` 4395enum ArkUI_ShapeType 4396``` 4397**Description** 4398 4399Enumerates custom shape types. 4400 4401**Since**: 12 4402 4403| Enum| Description| 4404| -------- | -------- | 4405| ARKUI_SHAPE_TYPE_RECTANGLE | Rectangle. | 4406| ARKUI_SHAPE_TYPE_CIRCLE | **(circle)** | 4407| ARKUI_SHAPE_TYPE_ELLIPSE | Ellipse. | 4408| ARKUI_SHAPE_TYPE_PATH | Path Type | 4409 4410 4411### ArkUI_SliderBlockStyle 4412 4413``` 4414enum ArkUI_SliderBlockStyle 4415``` 4416**Description** 4417 4418Enumerates the styles of the slider in the block direction. 4419 4420**Since**: 12 4421 4422| Enum| Description| 4423| -------- | -------- | 4424| ARKUI_SLIDER_BLOCK_STYLE_DEFAULT | Round slider. | 4425| ARKUI_SLIDER_BLOCK_STYLE_IMAGE | Slider with an image background. | 4426| ARKUI_SLIDER_BLOCK_STYLE_SHAPE | Slider in a custom shape. | 4427 4428 4429### ArkUI_SliderDirection 4430 4431``` 4432enum ArkUI_SliderDirection 4433``` 4434**Description** 4435 4436Enumerates the scroll directions of the slider. 4437 4438**Since**: 12 4439 4440| Enum| Description| 4441| -------- | -------- | 4442| ARKUI_SLIDER_DIRECTION_VERTICAL | Vertical direction. | 4443| ARKUI_SLIDER_DIRECTION_HORIZONTAL | Horizontal direction. | 4444 4445 4446### ArkUI_SliderStyle 4447 4448``` 4449enum ArkUI_SliderStyle 4450``` 4451**Description** 4452 4453Enumerates the slider styles. 4454 4455**Since**: 12 4456 4457| Enum| Description| 4458| -------- | -------- | 4459| ARKUI_SLIDER_STYLE_OUT_SET | The slider is on the slider rail. | 4460| ARKUI_SLIDER_STYLE_IN_SET | The slider is in the slider rail. | 4461| ARKUI_SLIDER_STYLE_NONE | There is no thumb. | 4462 4463 4464### ArkUI_StickyStyle 4465 4466``` 4467enum ArkUI_StickyStyle 4468``` 4469**Description** 4470 4471Enumerates the modes for pinning the header to the top or the footer to the bottom. 4472 4473**Since**: 12 4474 4475| Enum| Description| 4476| -------- | -------- | 4477| 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. | 4478| 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. | 4479| 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. | 4480| ARKUI_STICKY_STYLE_BOTH | In the list item group, the footer is pinned to the bottom, and the header is pinned to the top. | 4481 4482 4483### ArkUI_SwiperArrow 4484 4485``` 4486enum ArkUI_SwiperArrow 4487``` 4488**Description** 4489 4490Enumerates arrow styles of the navigation indicator. 4491 4492**Since**: 12 4493 4494| Enum| Description| 4495| -------- | -------- | 4496| ARKUI_SWIPER_ARROW_HIDE | The arrow is not displayed for the navigation indicator. | 4497| ARKUI_SWIPER_ARROW_SHOW | The arrow is displayed for the navigation indicator. | 4498| ARKUI_SWIPER_ARROW_SHOW_ON_HOVER | The arrow is displayed only when the mouse pointer hovers over the navigation indicator. | 4499 4500 4501### ArkUI_SwiperDisplayModeType 4502 4503``` 4504enum ArkUI_SwiperDisplayModeType 4505``` 4506**Description** 4507 4508Enumerates the modes in which elements are displayed along the main axis of the **Swiper** component. 4509 4510**Since**: 12 4511 4512| Enum| Description| 4513| -------- | -------- | 4514| ARKUI_SWIPER_DISPLAY_MODE_STRETCH | The slide width of the **Swiper** component is equal to the width of the component. | 4515| 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. | 4516 4517 4518### ArkUI_SwiperIndicatorType 4519 4520``` 4521enum ArkUI_SwiperIndicatorType 4522``` 4523**Description** 4524 4525Enumerates the navigation indicator types of the **Swiper** component. 4526 4527**Since**: 12 4528 4529| Enum| Description| 4530| -------- | -------- | 4531| ARKUI_SWIPER_INDICATOR_TYPE_DOT | Dot type. | 4532| ARKUI_SWIPER_INDICATOR_TYPE_DIGIT | Digit type. | 4533 4534 4535### ArkUI_SwiperNestedScrollMode 4536 4537``` 4538enum ArkUI_SwiperNestedScrollMode 4539``` 4540**Description** 4541 4542Enumerates the nested scrolling mode of the **Swiper** component and its parent container. 4543 4544**Since**: 12 4545 4546| Enum| Description| 4547| -------- | -------- | 4548| 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. | 4549| 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. | 4550 4551 4552### ArkUI_SystemColorMode 4553 4554``` 4555enum ArkUI_SystemColorMode 4556``` 4557**Description** 4558 4559Enumerates the system color modes. 4560 4561**Since**: 12 4562 4563| Enum| Description| 4564| -------- | -------- | 4565| ARKUI_SYSTEM_COLOR_MODE_LIGHT | Light mode. | 4566| ARKUI_SYSTEM_COLOR_MODE_DARK | Dark mode. | 4567 4568 4569### ArkUI_TextAlignment 4570 4571``` 4572enum ArkUI_TextAlignment 4573``` 4574**Description** 4575 4576Enumerates the text alignment mode. 4577 4578**Since**: 12 4579 4580| Enum| Description| 4581| -------- | -------- | 4582| ARKUI_TEXT_ALIGNMENT_START | Aligned with the start. | 4583| ARKUI_TEXT_ALIGNMENT_CENTER | Horizontally centered. | 4584| ARKUI_TEXT_ALIGNMENT_END | Aligned with the end. | 4585| ARKUI_TEXT_ALIGNMENT_JUSTIFY | Aligned with both margins. | 4586 4587 4588### ArkUI_TextAreaType 4589 4590``` 4591enum ArkUI_TextAreaType 4592``` 4593**Description** 4594 4595Enumerates the text box types. 4596 4597**Since**: 12 4598 4599| Enum| Description| 4600| -------- | -------- | 4601| ARKUI_TEXTAREA_TYPE_NORMAL | Normal input mode. | 4602| ARKUI_TEXTAREA_TYPE_NUMBER | Number input mode. | 4603| ARKUI_TEXTAREA_TYPE_PHONE_NUMBER | Phone number input mode. | 4604| ARKUI_TEXTAREA_TYPE_EMAIL | Email address input mode. | 4605 4606 4607### ArkUI_TextCase 4608 4609``` 4610enum ArkUI_TextCase 4611``` 4612**Description** 4613 4614Defines the enumerated values of text case. 4615 4616**Since**: 12 4617 4618| Enum| Description| 4619| -------- | -------- | 4620| ARKUI_TEXT_CASE_NORMAL | The original case of the text is retained. | 4621| ARKUI_TEXT_CASE_LOWER | All letters in the text are in lowercase. | 4622| ARKUI_TEXT_CASE_UPPER | All letters in the text are in uppercase. | 4623 4624 4625### ArkUI_TextCopyOptions 4626 4627``` 4628enum ArkUI_TextCopyOptions 4629``` 4630**Description** 4631 4632Enumerates copy options, which define whether copy and paste is allowed for text content. 4633 4634**Since**: 12 4635 4636| Enum| Description| 4637| -------- | -------- | 4638| ARKUI_TEXT_COPY_OPTIONS_NONE | Copy is not allowed. | 4639| ARKUI_TEXT_COPY_OPTIONS_IN_APP | Intra-application copy is allowed. | 4640| ARKUI_TEXT_COPY_OPTIONS_LOCAL_DEVICE | Intra-device copy is allowed. | 4641| ARKUI_TEXT_COPY_OPTIONS_CROSS_DEVICE | Cross-device copy is allowed. | 4642 4643 4644### ArkUI_TextDataDetectorType 4645 4646``` 4647enum ArkUI_TextDataDetectorType 4648``` 4649**Description** 4650 4651Enumerates the entity types of text recognition. 4652 4653**Since**: 12 4654 4655| Enum| Description| 4656| -------- | -------- | 4657| ARKUI_TEXT_DATA_DETECTOR_TYPE_PHONE_NUMBER | Phone number. | 4658| ARKUI_TEXT_DATA_DETECTOR_TYPE_URL | Link. | 4659| ARKUI_TEXT_DATA_DETECTOR_TYPE_EMAIL | Email | 4660| ARKUI_TEXT_DATA_DETECTOR_TYPE_ADDRESS | Network address. | 4661 4662 4663### ArkUI_TextDecorationStyle 4664 4665``` 4666enum ArkUI_TextDecorationStyle 4667``` 4668**Description** 4669 4670Enumerates the text decoration styles. 4671 4672**Since**: 12 4673 4674| Enum| Description| 4675| -------- | -------- | 4676| ARKUI_TEXT_DECORATION_STYLE_SOLID | Single solid line. | 4677| ARKUI_TEXT_DECORATION_STYLE_DOUBLE | Double solid line. | 4678| ARKUI_TEXT_DECORATION_STYLE_DOTTED | Dotted line. | 4679| ARKUI_TEXT_DECORATION_STYLE_DASHED | Dashed style. | 4680| ARKUI_TEXT_DECORATION_STYLE_WAVY | Wavy line. | 4681 4682 4683### ArkUI_TextDecorationType 4684 4685``` 4686enum ArkUI_TextDecorationType 4687``` 4688**Description** 4689 4690Enumerates the text decoration types. 4691 4692**Since**: 12 4693 4694| Enum| Description| 4695| -------- | -------- | 4696| ARKUI_TEXT_DECORATION_TYPE_NONE | No text decoration. | 4697| ARKUI_TEXT_DECORATION_TYPE_UNDERLINE | Line under the text. | 4698| ARKUI_TEXT_DECORATION_TYPE_OVERLINE | Line over the text. | 4699| ARKUI_TEXT_DECORATION_TYPE_LINE_THROUGH | Line through the text. | 4700 4701 4702### ArkUI_TextHeightAdaptivePolicy 4703 4704``` 4705enum ArkUI_TextHeightAdaptivePolicy 4706``` 4707**Description** 4708 4709Defines how the adaptive height is determined for the text. 4710 4711**Since**: 12 4712 4713| Enum| Description| 4714| -------- | -------- | 4715| ARKUI_TEXT_HEIGHT_ADAPTIVE_POLICY_MAX_LINES_FIRST | Prioritize the **maxLines** settings. | 4716| ARKUI_TEXT_HEIGHT_ADAPTIVE_POLICY_MIN_FONT_SIZE_FIRST | Prioritize the **minFontSize** settings. | 4717| ARKUI_TEXT_HEIGHT_ADAPTIVE_POLICY_LAYOUT_CONSTRAINT_FIRST | Prioritize the layout constraint settings in terms of height. | 4718 4719 4720### ArkUI_TextInputContentType 4721 4722``` 4723enum ArkUI_TextInputContentType 4724``` 4725**Description** 4726 4727Enumerates the autofill types. 4728 4729**Since**: 12 4730 4731| Enum| Description| 4732| -------- | -------- | 4733| ARKUI_TEXTINPUT_CONTENT_TYPE_USER_NAME | Username. Password Vault, when enabled, can automatically save and fill in usernames. | 4734| ARKUI_TEXTINPUT_CONTENT_TYPE_PASSWORD | Password. Password Vault, when enabled, can automatically save and fill in passwords. | 4735| ARKUI_TEXTINPUT_CONTENT_TYPE_NEW_PASSWORD | New password. Password Vault, when enabled, can automatically generate a new password. | 4736| 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. | 4737| ARKUI_TEXTINPUT_CONTENT_TYPE_HOUSE_NUMBER | House number. The scenario-based autofill feature, when enabled, can automatically save and fill in house numbers. | 4738| 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. | 4739| ARKUI_TEXTINPUT_CONTENT_TYPE_CITY_ADDRESS | City. The scenario-based autofill feature, when enabled, can automatically save and fill in cities. | 4740| ARKUI_TEXTINPUT_CONTENT_TYPE_PROVINCE_ADDRESS | Province. The scenario-based autofill feature, when enabled, can automatically save and fill in provinces. | 4741| ARKUI_TEXTINPUT_CONTENT_TYPE_COUNTRY_ADDRESS | Country. The scenario-based autofill feature, when enabled, can automatically save and fill in countries. | 4742| ARKUI_TEXTINPUT_CONTENT_TYPE_PERSON_FULL_NAME | Full name. The scenario-based autofill feature, when enabled, can automatically save and fill in full names. | 4743| ARKUI_TEXTINPUT_CONTENT_TYPE_PERSON_LAST_NAME | Last name. The scenario-based autofill feature, when enabled, can automatically save and fill in last names. | 4744| ARKUI_TEXTINPUT_CONTENT_TYPE_PERSON_FIRST_NAME | First name. The scenario-based autofill feature, when enabled, can automatically save and fill in first names. | 4745| ARKUI_TEXTINPUT_CONTENT_TYPE_PHONE_NUMBER | Phone number. The scenario-based autofill feature, when enabled, can automatically save and fill in phone numbers. | 4746| ARKUI_TEXTINPUT_CONTENT_TYPE_PHONE_COUNTRY_CODE | Country code. The scenario-based autofill feature, when enabled, can automatically save and fill in country codes. | 4747| 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. | 4748| ARKUI_TEXTINPUT_CONTENT_EMAIL_ADDRESS | Email address. The scenario-based autofill feature, when enabled, can automatically save and fill in email addresses. | 4749| 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. | 4750| 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. | 4751| ARKUI_TEXTINPUT_CONTENT_TYPE_NICKNAME | Nickname. The scenario-based autofill feature, when enabled, can automatically save and fill in nicknames. | 4752| 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. | 4753| ARKUI_TEXTINPUT_CONTENT_TYPE_FORMAT_ADDRESS | Standard address. The scenario-based autofill feature, when enabled, can automatically save and fill in standard addresses. | 4754| ARKUI_TEXTINPUT_CONTENT_TYPE_PASSPORT_NUMBER | Passport number. The scenario-based autofill feature, when enabled, can automatically save and fill in passport numbers. | 4755| ARKUI_TEXTINPUT_CONTENT_TYPE_VALIDITY | Passport validity period. The scenario-based autofill feature, when enabled, can automatically save and fill in passport validity periods. | 4756| 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. | 4757| ARKUI_TEXTINPUT_CONTENT_TYPE_ORGANIZATION | Invoice title. The scenario-based autofill feature, when enabled, can automatically save and fill in invoice titles. | 4758| ARKUI_TEXTINPUT_CONTENT_TYPE_TAX_ID | Tax ID. The scenario-based autofill feature, when enabled, can automatically save and fill in tax IDs. | 4759| ARKUI_TEXTINPUT_CONTENT_TYPE_ADDRESS_CITY_AND_STATE | Location. The scenario-based autofill feature, when enabled, can automatically save and fill in locations. | 4760| ARKUI_TEXTINPUT_CONTENT_TYPE_FLIGHT_NUMBER | Flight number. Currently not supported for automatic saving and auto-filling. | 4761| ARKUI_TEXTINPUT_CONTENT_TYPE_LICENSE_NUMBER | Driver's license number. Currently not supported for automatic saving and auto-filling. | 4762| ARKUI_TEXTINPUT_CONTENT_TYPE_LICENSE_FILE_NUMBER | Driver's license file number. Currently not supported for automatic saving and auto-filling.| 4763| 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. | 4764| ARKUI_TEXTINPUT_CONTENT_TYPE_ENGINE_NUMBER | Vehicle registration engine number. Currently not supported for automatic saving and auto-filling. | 4765| ARKUI_TEXTINPUT_CONTENT_TYPE_LICENSE_CHASSIS_NUMBER | Chassis number. Currently not supported for automatic saving and auto-filling. | 4766 4767 4768### ArkUI_TextInputStyle 4769 4770``` 4771enum ArkUI_TextInputStyle 4772``` 4773**Description** 4774 4775Enumerates the text input styles. 4776 4777**Since**: 12 4778 4779| Enum| Description| 4780| -------- | -------- | 4781| 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. | 4782| ARKUI_TEXTINPUT_STYLE_INLINE | Inline input style. The background height of the selected text is the same as the height of the text box. | 4783 4784 4785### ArkUI_TextInputType 4786 4787``` 4788enum ArkUI_TextInputType 4789``` 4790**Description** 4791 4792Enumerates the text input types. 4793 4794**Since**: 12 4795 4796| Enum| Description| 4797| -------- | -------- | 4798| ARKUI_TEXTINPUT_TYPE_NORMAL | Normal input mode. | 4799| ARKUI_TEXTINPUT_TYPE_NUMBER | Number input mode. | 4800| ARKUI_TEXTINPUT_TYPE_PHONE_NUMBER | Phone number input mode. | 4801| ARKUI_TEXTINPUT_TYPE_EMAIL | Email address input mode. | 4802| ARKUI_TEXTINPUT_TYPE_PASSWORD | Password input mode. | 4803| ARKUI_TEXTINPUT_TYPE_NUMBER_PASSWORD | Numeric password input mode. | 4804| ARKUI_TEXTINPUT_TYPE_SCREEN_LOCK_PASSWORD | Lock screen password input mode. | 4805| ARKUI_TEXTINPUT_TYPE_USER_NAME | Username input mode. | 4806| ARKUI_TEXTINPUT_TYPE_NEW_PASSWORD | New password input mode. | 4807| ARKUI_TEXTINPUT_TYPE_NUMBER_DECIMAL | Number input mode with a decimal point. | 4808 4809 4810### ArkUI_TextOverflow 4811 4812``` 4813enum ArkUI_TextOverflow 4814``` 4815**Description** 4816 4817Enumerates the display modes when the text is too long. 4818 4819**Since**: 12 4820 4821| Enum| Description| 4822| -------- | -------- | 4823| ARKUI_TEXT_OVERFLOW_NONE | Extra-long text is not clipped. | 4824| ARKUI_TEXT_OVERFLOW_CLIP | Extra-long text is clipped. | 4825| ARKUI_TEXT_OVERFLOW_ELLIPSIS | An ellipsis (...) is used to represent text overflow. | 4826| ARKUI_TEXT_OVERFLOW_MARQUEE | Text continuously scrolls when text overflow occurs. | 4827 4828 4829### ArkUI_TextPickerRangeType 4830 4831``` 4832enum ArkUI_TextPickerRangeType 4833``` 4834**Description** 4835 4836Enumerates the types of the text picker. 4837 4838**Since**: 12 4839 4840| Enum| Description| 4841| -------- | -------- | 4842| ARKUI_TEXTPICKER_RANGETYPE_SINGLE | Single-column text picker. | 4843| ARKUI_TEXTPICKER_RANGETYPE_MULTI | Multi-column text picker. | 4844| ARKUI_TEXTPICKER_RANGETYPE_RANGE_CONTENT | Single-column text picker with image resources. | 4845| ARKUI_TEXTPICKER_RANGETYPE_CASCADE_RANGE_CONTENT | Interconnected multi-column text picker. | 4846 4847 4848### ArkUI_ThemeColorMode 4849 4850``` 4851enum ArkUI_ThemeColorMode 4852``` 4853 4854| Enum| Description| 4855| -------- | -------- | 4856| ARKUI_THEME_COLOR_MODE_SYSTEM | Following the system color mode. | 4857| ARKUI_THEME_COLOR_MODE_LIGHT | Light color mode. | 4858| ARKUI_THEME_COLOR_MODE_DARK | Dark color mode. | 4859 4860 4861### ArkUI_TransitionEdge 4862 4863``` 4864enum ArkUI_TransitionEdge 4865``` 4866**Description** 4867 4868Enumerates the slide-in and slide-out positions of the component from the screen edge during transition. 4869 4870**Since**: 12 4871 4872| Enum| Description| 4873| -------- | -------- | 4874| ARKUI_TRANSITION_EDGE_TOP | Top edge of the window. | 4875| ARKUI_TRANSITION_EDGE_BOTTOM | Bottom edge of the window. | 4876| ARKUI_TRANSITION_EDGE_START | Left edge of the window. | 4877| ARKUI_TRANSITION_EDGE_END | Right edge of the window. | 4878 4879 4880### ArkUI_VerticalAlignment 4881 4882``` 4883enum ArkUI_VerticalAlignment 4884``` 4885**Description** 4886 4887Enumerates the vertical alignment modes. 4888 4889**Since**: 12 4890 4891| Enum| Description| 4892| -------- | -------- | 4893| ARKUI_VERTICAL_ALIGNMENT_TOP | Top aligned. | 4894| ARKUI_VERTICAL_ALIGNMENT_CENTER | Aligned with the center. This is the default alignment mode. | 4895| ARKUI_VERTICAL_ALIGNMENT_BOTTOM | Bottom aligned. | 4896 4897 4898### ArkUI_Visibility 4899 4900``` 4901enum ArkUI_Visibility 4902``` 4903**Description** 4904 4905Enumerates the visibility values. 4906 4907**Since**: 12 4908 4909| Enum| Description| 4910| -------- | -------- | 4911| ARKUI_VISIBILITY_VISIBLE | Display | 4912| ARKUI_VISIBILITY_HIDDEN | The component is hidden, and a placeholder is used for it in the layout. | 4913| ARKUI_VISIBILITY_NONE | The component is hidden. It is not involved in the layout, and no placeholder is used for it. | 4914 4915 4916### ArkUI_WordBreak 4917 4918``` 4919enum ArkUI_WordBreak 4920``` 4921**Description** 4922 4923Enumerates the word break rules. 4924 4925**Since**: 12 4926 4927| Enum| Description| 4928| -------- | -------- | 4929| 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). | 4930| 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**. | 4931| 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**. | 4932| 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**. | 4933 4934 4935### ArkUI_XComponentType 4936 4937``` 4938enum ArkUI_XComponentType 4939``` 4940**Description** 4941 4942Defines the enumerated values of the XComponent type. 4943 4944**Since**: 12 4945 4946| Enum| Description| 4947| -------- | -------- | 4948| ARKUI_XCOMPONENT_TYPE_SURFACE | The custom content of EGL/OpenGL ES and media data is displayed individually on the screen. | 4949| ARKUI_XCOMPONENT_TYPE_TEXTURE | The custom content of EGL/OpenGL ES and media data is grouped and displayed together with content of the component. | 4950 4951### ArkUI_KeyboardAppearance 4952 4953``` 4954enum ArkUI_KeyboardAppearance 4955``` 4956**Description** 4957 4958Enumerates the appearance modes of the keyboard when the text box is focused. 4959 4960**Since**: 15 4961 4962| Enum| Description| 4963| -------- | -------- | 4964| ARKUI_KEYBOARD_APPEARANCE_NONE_IMMERSIVE | Default appearance mode, not using the immersive style. | 4965| ARKUI_KEYBOARD_APPEARANCE_IMMERSIVE | Immersive style, following the system color mode. | 4966| ARKUI_KEYBOARD_APPEARANCE_LIGHT_IMMERSIVE | Immersive style in light mode. | 4967| ARKUI_KEYBOARD_APPEARANCE_DARK_IMMERSIVE | Immersive style in dark mode. | 4968 4969### ArkUI_KeyboardAvoidMode 4970 4971``` 4972enum ArkUI_KeyboardAvoidMode 4973``` 4974**Description** 4975 4976Enumerates the keyboard avoidance modes of the dialog box. 4977 4978**Since**: 18 4979 4980| Enum| Description| 4981| -------- | -------- | 4982| ARKUI_KEYBOARD_AVOID_MODE_DEFAULT | Automatically avoids the soft keyboard and compresses the height when reaching the maximum limit. | 4983| ARKUI_KEYBOARD_AVOID_MODE_NONE | Does not avoid the soft keyboard. | 4984 4985### ArkUI_HoverModeAreaType 4986 4987``` 4988enum ArkUI_HoverModeAreaType 4989``` 4990**Description** 4991 4992Enumerates the default display areas of a dialog box in hover mode. 4993 4994**Since**: 18 4995 4996| Enum| Description| 4997| -------- | -------- | 4998| ARKUI_HOVER_MODE_AREA_TYPE_TOP | Upper half screen. | 4999| ARKUI_HOVER_MODE_AREA_TYPE_BOTTOM | Lower half screen. | 5000 5001 5002## Function Description 5003 5004 5005### OH_ArkUI_AccessibilityState_Create() 5006 5007``` 5008ArkUI_AccessibilityState* OH_ArkUI_AccessibilityState_Create (void ) 5009``` 5010**Description** 5011 5012Creates an accessibility state. 5013 5014**Since**: 12 5015 5016**Returns** 5017 5018Returns 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. 5019 5020 5021### OH_ArkUI_AccessibilityState_Dispose() 5022 5023``` 5024void OH_ArkUI_AccessibilityState_Dispose (ArkUI_AccessibilityState * state) 5025``` 5026**Description** 5027 5028Disposes of the pointer to an accessibility state. 5029 5030**Since**: 12 5031 5032**Parameters** 5033 5034| Name| Description| 5035| -------- | -------- | 5036| state | Pointer to an accessibility state object. | 5037 5038 5039### OH_ArkUI_AccessibilityState_GetCheckedState() 5040 5041``` 5042int32_t OH_ArkUI_AccessibilityState_GetCheckedState (ArkUI_AccessibilityState * state) 5043``` 5044**Description** 5045 5046Obtains the check box state of an accessibility state. 5047 5048**Since**: 12 5049 5050**Parameters** 5051 5052| Name| Description| 5053| -------- | -------- | 5054| state | Pointer to an accessibility state object. | 5055 5056**Returns** 5057 5058Returns 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. 5059 5060 5061### OH_ArkUI_AccessibilityState_IsDisabled() 5062 5063``` 5064int32_t OH_ArkUI_AccessibilityState_IsDisabled (ArkUI_AccessibilityState * state) 5065``` 5066**Description** 5067 5068Obtains whether an accessibility state is disabled. 5069 5070**Since**: 12 5071 5072**Parameters** 5073 5074| Name| Description| 5075| -------- | -------- | 5076| state | Pointer to an accessibility state object. | 5077 5078**Returns** 5079 5080Returns 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. 5081 5082 5083### OH_ArkUI_AccessibilityState_IsSelected() 5084 5085``` 5086int32_t OH_ArkUI_AccessibilityState_IsSelected (ArkUI_AccessibilityState * state) 5087``` 5088**Description** 5089 5090Obtains whether an accessibility state is selected. 5091 5092**Since**: 12 5093 5094**Parameters** 5095 5096| Name| Description| 5097| -------- | -------- | 5098| state | Pointer to an accessibility state object. | 5099 5100**Returns** 5101 5102Returns 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. 5103 5104 5105### OH_ArkUI_AccessibilityState_SetCheckedState() 5106 5107``` 5108void OH_ArkUI_AccessibilityState_SetCheckedState (ArkUI_AccessibilityState * state, int32_t checkedState ) 5109``` 5110**Description** 5111 5112Sets the check box state of an accessibility state. 5113 5114**Since**: 12 5115 5116**Parameters** 5117 5118| Name| Description| 5119| -------- | -------- | 5120| state | Pointer to an accessibility state object. | 5121| checkedState | Check box status. The parameter type is [ArkUI_AccessibilityCheckedState](#arkui_accessibilitycheckedstate). The default value is **ARKUI_ACCESSIBILITY_UNCHECKED**. | 5122 5123 5124### OH_ArkUI_AccessibilityState_SetDisabled() 5125 5126``` 5127void OH_ArkUI_AccessibilityState_SetDisabled (ArkUI_AccessibilityState * state, int32_t isDisabled ) 5128``` 5129**Description** 5130 5131Sets whether an accessibility state is disabled. 5132 5133**Since**: 12 5134 5135**Parameters** 5136 5137| Name| Description| 5138| -------- | -------- | 5139| state | Pointer to an accessibility state object. | 5140| 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**. | 5141 5142 5143### OH_ArkUI_AccessibilityState_SetSelected() 5144 5145``` 5146void OH_ArkUI_AccessibilityState_SetSelected (ArkUI_AccessibilityState * state, int32_t isSelected ) 5147``` 5148**Description** 5149 5150Sets whether an accessibility state is selected. 5151 5152**Since**: 12 5153 5154**Parameters** 5155 5156| Name| Description| 5157| -------- | -------- | 5158| state | Pointer to an accessibility state object. | 5159| 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**. | 5160 5161 5162### OH_ArkUI_AccessibilityValue_Create() 5163 5164``` 5165ArkUI_AccessibilityValue* OH_ArkUI_AccessibilityValue_Create (void ) 5166``` 5167**Description** 5168 5169Creates an **AccessibilityValue** instance. 5170 5171**Since**: 12 5172 5173**Returns** 5174 5175Returns the pointer to the created **AccessibilityValue** instance. 5176 5177 5178### OH_ArkUI_AccessibilityValue_Dispose() 5179 5180``` 5181void OH_ArkUI_AccessibilityValue_Dispose (ArkUI_AccessibilityValue * value) 5182``` 5183**Description** 5184 5185Disposes of the pointer to an **AccessibilityValue** instance. 5186 5187**Since**: 12 5188 5189**Parameters** 5190 5191| Name| Description| 5192| -------- | -------- | 5193| state | Pointer to an **AccessibilityValue** instance. | 5194 5195 5196### OH_ArkUI_AccessibilityValue_GetCurrent() 5197 5198``` 5199int32_t OH_ArkUI_AccessibilityValue_GetCurrent (ArkUI_AccessibilityValue * value) 5200``` 5201**Description** 5202 5203Obtains the current accessibility value. 5204 5205**Since**: 12 5206 5207**Parameters** 5208 5209| Name| Description| 5210| -------- | -------- | 5211| value | Pointer to an **AccessibilityValue** instance. | 5212 5213**Returns** 5214 5215Returns the current value based on the range component. The default value is **-1**. If a parameter error occurs, **-1** is returned. 5216 5217 5218### OH_ArkUI_AccessibilityValue_GetMax() 5219 5220``` 5221int32_t OH_ArkUI_AccessibilityValue_GetMax (ArkUI_AccessibilityValue * value) 5222``` 5223**Description** 5224 5225Obtains the maximum accessibility value. 5226 5227**Since**: 12 5228 5229**Parameters** 5230 5231| Name| Description| 5232| -------- | -------- | 5233| value | Pointer to an **AccessibilityValue** instance. | 5234 5235**Returns** 5236 5237Returns the maximum value based on the range component. The default value is **-1**. If a parameter error occurs, **-1** is returned. 5238 5239 5240### OH_ArkUI_AccessibilityValue_GetMin() 5241 5242``` 5243int32_t OH_ArkUI_AccessibilityValue_GetMin (ArkUI_AccessibilityValue * value) 5244``` 5245**Description** 5246 5247Obtains the minimum accessibility value. 5248 5249**Since**: 12 5250 5251**Parameters** 5252 5253| Name| Description| 5254| -------- | -------- | 5255| value | Pointer to an **AccessibilityValue** instance. | 5256 5257**Returns** 5258 5259Returns the minimum value based on the range component. The default value is **-1**. If a parameter error occurs, **-1** is returned. 5260 5261 5262### OH_ArkUI_AccessibilityValue_GetText() 5263 5264``` 5265const char* OH_ArkUI_AccessibilityValue_GetText (ArkUI_AccessibilityValue * value) 5266``` 5267**Description** 5268 5269Obtains the text description of an **AccessibilityValue** instance. 5270 5271**Since**: 12 5272 5273**Parameters** 5274 5275| Name| Description| 5276| -------- | -------- | 5277| value | Pointer to an **AccessibilityValue** instance. | 5278 5279**Returns** 5280 5281Returns the text description. The default value is an empty string. If a parameter error occurs, a null pointer is returned. 5282 5283 5284### OH_ArkUI_AccessibilityValue_SetCurrent() 5285 5286``` 5287void OH_ArkUI_AccessibilityValue_SetCurrent (ArkUI_AccessibilityValue * value, int32_t current ) 5288``` 5289**Description** 5290 5291Sets the current accessibility value. 5292 5293**Since**: 12 5294 5295**Parameters** 5296 5297| Name| Description| 5298| -------- | -------- | 5299| value | Pointer to an **AccessibilityValue** instance. | 5300| current | Current value based on the range component. The default value is **-1**. | 5301 5302 5303### OH_ArkUI_AccessibilityValue_SetMax() 5304 5305``` 5306void OH_ArkUI_AccessibilityValue_SetMax (ArkUI_AccessibilityValue * value, int32_t max ) 5307``` 5308**Description** 5309 5310Sets the maximum accessibility value. 5311 5312**Since**: 12 5313 5314**Parameters** 5315 5316| Name| Description| 5317| -------- | -------- | 5318| value | Pointer to an **AccessibilityValue** instance. | 5319| max | Maximum value based on the range component. The default value is **-1**. | 5320 5321 5322### OH_ArkUI_AccessibilityValue_SetMin() 5323 5324``` 5325void OH_ArkUI_AccessibilityValue_SetMin (ArkUI_AccessibilityValue * value, int32_t min ) 5326``` 5327**Description** 5328 5329Sets the minimum accessibility value. 5330 5331**Since**: 12 5332 5333**Parameters** 5334 5335| Name| Description| 5336| -------- | -------- | 5337| value | Pointer to an **AccessibilityValue** instance. | 5338| min | Minimum value based on the range component. The default value is **-1**. | 5339 5340 5341### OH_ArkUI_AccessibilityValue_SetText() 5342 5343``` 5344void OH_ArkUI_AccessibilityValue_SetText (ArkUI_AccessibilityValue * value, const char * text ) 5345``` 5346**Description** 5347 5348Sets the text description of an **AccessibilityValue** instance. 5349 5350**Since**: 12 5351 5352**Parameters** 5353 5354| Name| Description| 5355| -------- | -------- | 5356| value | Pointer to an **AccessibilityValue** instance. | 5357| text | Text description. The default value is an empty string. | 5358 5359 5360### OH_ArkUI_ActiveChildrenInfo_Destroy() 5361 5362``` 5363void OH_ArkUI_ActiveChildrenInfo_Destroy (ArkUI_ActiveChildrenInfo * handle) 5364``` 5365**Description** 5366 5367Destroys an **ActiveChildrenInfo** instance. 5368 5369**Since**: 14 5370 5371**Parameters** 5372 5373| Name| Description| 5374| -------- | -------- | 5375| handle | **ActiveChildrenInfo** instance to destroy. | 5376 5377 5378### OH_ArkUI_ActiveChildrenInfo_GetCount() 5379 5380``` 5381int32_t OH_ArkUI_ActiveChildrenInfo_GetCount (ArkUI_ActiveChildrenInfo * handle) 5382``` 5383**Description** 5384 5385Obtains the number of nodes in the specified **ActiveChildrenInfo** instance. 5386 5387**Since**: 14 5388 5389**Parameters** 5390 5391| Name| Description| 5392| -------- | -------- | 5393| handle | **ActiveChildrenInfo** instance from which to obtain the information. | 5394 5395 5396### OH_ArkUI_ActiveChildrenInfo_GetNodeByIndex() 5397 5398``` 5399ArkUI_NodeHandle OH_ArkUI_ActiveChildrenInfo_GetNodeByIndex (ArkUI_ActiveChildrenInfo * handle, int32_t index ) 5400``` 5401**Description** 5402 5403Obtains the child node at the specified index in the specified **ActiveChildrenInfo** instance. 5404 5405**Since**: 14 5406 5407**Parameters** 5408 5409| Name| Description| 5410| -------- | -------- | 5411| handle | **ActiveChildrenInfo** instance from which to obtain the information. | 5412 5413 5414### OH_ArkUI_AlignmentRuleOption_Create() 5415 5416``` 5417ArkUI_AlignmentRuleOption* OH_ArkUI_AlignmentRuleOption_Create () 5418``` 5419**Description** 5420 5421Creates an alignment rule configuration for this **RelativeContainer** component. 5422 5423**Since**: 12 5424 5425**Returns** 5426 5427Alignment rule information. 5428 5429 5430### OH_ArkUI_AlignmentRuleOption_Dispose() 5431 5432``` 5433void OH_ArkUI_AlignmentRuleOption_Dispose (ArkUI_AlignmentRuleOption * option) 5434``` 5435**Description** 5436 5437Disposes of an alignment rule configuration of this **RelativeContainer** component. 5438 5439**Since**: 12 5440 5441**Parameters** 5442 5443| Name| Description| 5444| -------- | -------- | 5445| option | Pointer to an alignment rule configuration. | 5446 5447 5448### OH_ArkUI_AlignmentRuleOption_GetBiasHorizontal() 5449 5450``` 5451float OH_ArkUI_AlignmentRuleOption_GetBiasHorizontal (ArkUI_AlignmentRuleOption * option) 5452``` 5453**Description** 5454 5455Obtains the bias value in the horizontal direction. 5456 5457**Since**: 12 5458 5459**Parameters** 5460 5461| Name| Description| 5462| -------- | -------- | 5463| option | Pointer to an alignment rule configuration. | 5464 5465**Returns** 5466 5467Bias value in the horizontal direction. 5468 5469 5470### OH_ArkUI_AlignmentRuleOption_GetBiasVertical() 5471 5472``` 5473float OH_ArkUI_AlignmentRuleOption_GetBiasVertical (ArkUI_AlignmentRuleOption * option) 5474``` 5475**Description** 5476 5477Obtains the bias value in the vertical direction. 5478 5479**Since**: 12 5480 5481**Parameters** 5482 5483| Name| Description| 5484| -------- | -------- | 5485| option | Pointer to an alignment rule configuration. | 5486 5487**Returns** 5488 5489Returns the bias value in the vertical direction. 5490 5491 5492### OH_ArkUI_AlignmentRuleOption_GetBottomAlignment() 5493 5494``` 5495ArkUI_VerticalAlignment OH_ArkUI_AlignmentRuleOption_GetBottomAlignment (ArkUI_AlignmentRuleOption * option) 5496``` 5497**Description** 5498 5499Obtains the alignment mode in bottom alignment parameters. 5500 5501**Since**: 12 5502 5503**Parameters** 5504 5505| Name| Description| 5506| -------- | -------- | 5507| option | Pointer to an alignment rule configuration. | 5508 5509**Returns** 5510 5511Returns the alignment mode in bottom alignment parameters. 5512 5513 5514### OH_ArkUI_AlignmentRuleOption_GetBottomId() 5515 5516``` 5517const char* OH_ArkUI_AlignmentRuleOption_GetBottomId (ArkUI_AlignmentRuleOption * option) 5518``` 5519**Description** 5520 5521Obtains the alignment mode in bottom alignment parameters. 5522 5523**Since**: 12 5524 5525**Parameters** 5526 5527| Name| Description| 5528| -------- | -------- | 5529| option | Pointer to an alignment rule configuration. | 5530 5531**Returns** 5532 5533Returns the ID in bottom alignment parameters. 5534 5535 5536### OH_ArkUI_AlignmentRuleOption_GetCenterAlignmentHorizontal() 5537 5538``` 5539ArkUI_HorizontalAlignment OH_ArkUI_AlignmentRuleOption_GetCenterAlignmentHorizontal (ArkUI_AlignmentRuleOption * option) 5540``` 5541**Description** 5542 5543Obtains the alignment mode in horizontal center alignment parameters. 5544 5545**Since**: 12 5546 5547**Parameters** 5548 5549| Name| Description| 5550| -------- | -------- | 5551| option | Pointer to an alignment rule configuration. | 5552 5553**Returns** 5554 5555Returns the alignment mode in horizontal center alignment parameters. 5556 5557 5558### OH_ArkUI_AlignmentRuleOption_GetCenterAlignmentVertical() 5559 5560``` 5561ArkUI_VerticalAlignment OH_ArkUI_AlignmentRuleOption_GetCenterAlignmentVertical (ArkUI_AlignmentRuleOption * option) 5562``` 5563**Description** 5564 5565Obtains the ID in vertical center alignment parameters. 5566 5567**Since**: 12 5568 5569**Parameters** 5570 5571| Name| Description| 5572| -------- | -------- | 5573| option | Pointer to an alignment rule configuration. | 5574 5575**Returns** 5576 5577Returns the vertical center alignment parameters. 5578 5579 5580### OH_ArkUI_AlignmentRuleOption_GetCenterIdHorizontal() 5581 5582``` 5583const char* OH_ArkUI_AlignmentRuleOption_GetCenterIdHorizontal (ArkUI_AlignmentRuleOption * option) 5584``` 5585**Description** 5586 5587Obtains the alignment mode in horizontal center alignment parameters. 5588 5589**Since**: 12 5590 5591**Parameters** 5592 5593| Name| Description| 5594| -------- | -------- | 5595| option | Pointer to an alignment rule configuration. | 5596 5597**Returns** 5598 5599Returns the ID in horizontal center alignment parameters. 5600 5601 5602### OH_ArkUI_AlignmentRuleOption_GetCenterIdVertical() 5603 5604``` 5605const char* OH_ArkUI_AlignmentRuleOption_GetCenterIdVertical (ArkUI_AlignmentRuleOption * option) 5606``` 5607**Description** 5608 5609Obtains the ID in vertical center alignment parameters. 5610 5611**Since**: 12 5612 5613**Parameters** 5614 5615| Name| Description| 5616| -------- | -------- | 5617| option | Pointer to an alignment rule configuration. | 5618 5619**Returns** 5620 5621Returns the ID in vertical center alignment parameters. 5622 5623 5624### OH_ArkUI_AlignmentRuleOption_GetEndAlignment() 5625 5626``` 5627ArkUI_HorizontalAlignment OH_ArkUI_AlignmentRuleOption_GetEndAlignment (ArkUI_AlignmentRuleOption * option) 5628``` 5629**Description** 5630 5631Obtains the alignment mode in the right alignment parameters. 5632 5633**Since**: 12 5634 5635**Parameters** 5636 5637| Name| Description| 5638| -------- | -------- | 5639| option | Pointer to an alignment rule configuration. | 5640 5641**Returns** 5642 5643Returns the alignment mode in the right alignment parameters. 5644 5645 5646### OH_ArkUI_AlignmentRuleOption_GetEndId() 5647 5648``` 5649const char* OH_ArkUI_AlignmentRuleOption_GetEndId (ArkUI_AlignmentRuleOption * option) 5650``` 5651**Description** 5652 5653Obtains the alignment mode in the right alignment parameters. 5654 5655**Since**: 12 5656 5657**Parameters** 5658 5659| Name| Description| 5660| -------- | -------- | 5661| option | Pointer to an alignment rule configuration. | 5662 5663**Returns** 5664 5665Returns the ID in the right alignment parameters. 5666 5667 5668### OH_ArkUI_AlignmentRuleOption_GetStartAlignment() 5669 5670``` 5671ArkUI_HorizontalAlignment OH_ArkUI_AlignmentRuleOption_GetStartAlignment (ArkUI_AlignmentRuleOption * option) 5672``` 5673**Description** 5674 5675Obtains the alignment mode in left alignment parameters. 5676 5677**Since**: 12 5678 5679**Parameters** 5680 5681| Name| Description| 5682| -------- | -------- | 5683| option | Pointer to an alignment rule configuration. | 5684 5685**Returns** 5686 5687Returns the alignment mode in left alignment parameters. 5688 5689 5690### OH_ArkUI_AlignmentRuleOption_GetStartId() 5691 5692``` 5693const char* OH_ArkUI_AlignmentRuleOption_GetStartId (ArkUI_AlignmentRuleOption * option) 5694``` 5695**Description** 5696 5697Obtains the ID in the left alignment parameters. 5698 5699**Since**: 12 5700 5701**Parameters** 5702 5703| Name| Description| 5704| -------- | -------- | 5705| option | Pointer to an alignment rule configuration. | 5706 5707**Returns** 5708 5709Returns the ID in left alignment parameters. 5710 5711 5712### OH_ArkUI_AlignmentRuleOption_GetTopAlignment() 5713 5714``` 5715ArkUI_VerticalAlignment OH_ArkUI_AlignmentRuleOption_GetTopAlignment (ArkUI_AlignmentRuleOption * option) 5716``` 5717**Description** 5718 5719Obtains the alignment mode in top alignment parameters. 5720 5721**Since**: 12 5722 5723**Parameters** 5724 5725| Name| Description| 5726| -------- | -------- | 5727| option | Pointer to an alignment rule configuration. | 5728 5729**Returns** 5730 5731Returns the alignment mode in top alignment parameters. 5732 5733 5734### OH_ArkUI_AlignmentRuleOption_GetTopId() 5735 5736``` 5737const char* OH_ArkUI_AlignmentRuleOption_GetTopId (ArkUI_AlignmentRuleOption * option) 5738``` 5739**Description** 5740 5741Obtains the alignment mode in top alignment parameters. 5742 5743**Since**: 12 5744 5745**Parameters** 5746 5747| Name| Description| 5748| -------- | -------- | 5749| option | Pointer to an alignment rule configuration. | 5750 5751**Returns** 5752 5753Returns the ID in top alignment parameters. 5754 5755 5756### OH_ArkUI_AlignmentRuleOption_SetBiasHorizontal() 5757 5758``` 5759void OH_ArkUI_AlignmentRuleOption_SetBiasHorizontal (ArkUI_AlignmentRuleOption * option, float horizontal ) 5760``` 5761**Description** 5762 5763Sets the bias value of the component in the horizontal direction under the anchor constraints. 5764 5765**Since**: 12 5766 5767**Parameters** 5768 5769| Name| Description| 5770| -------- | -------- | 5771| option | Pointer to an alignment rule configuration. | 5772| horizontal | Bias value in the horizontal direction. | 5773 5774 5775### OH_ArkUI_AlignmentRuleOption_SetBiasVertical() 5776 5777``` 5778void OH_ArkUI_AlignmentRuleOption_SetBiasVertical (ArkUI_AlignmentRuleOption * option, float vertical ) 5779``` 5780**Description** 5781 5782Sets the bias value of the component in the vertical direction under the anchor constraints. 5783 5784**Since**: 12 5785 5786**Parameters** 5787 5788| Name| Description| 5789| -------- | -------- | 5790| option | Pointer to an alignment rule configuration. | 5791| horizontal | Bias value in the vertical direction. | 5792 5793 5794### OH_ArkUI_AlignmentRuleOption_SetBottom() 5795 5796``` 5797void OH_ArkUI_AlignmentRuleOption_SetBottom (ArkUI_AlignmentRuleOption * option, const char * id, ArkUI_VerticalAlignment alignment ) 5798``` 5799**Description** 5800 5801Sets the bottom alignment parameters. 5802 5803**Since**: 12 5804 5805**Parameters** 5806 5807| Name| Description| 5808| -------- | -------- | 5809| option | Pointer to an alignment rule configuration. | 5810| id | ID of the anchor component. | 5811| value | Alignment mode relative to the anchor component. | 5812 5813 5814### OH_ArkUI_AlignmentRuleOption_SetCenterHorizontal() 5815 5816``` 5817void OH_ArkUI_AlignmentRuleOption_SetCenterHorizontal (ArkUI_AlignmentRuleOption * option, const char * id, ArkUI_HorizontalAlignment alignment ) 5818``` 5819**Description** 5820 5821Sets the horizontal center alignment parameters. 5822 5823**Since**: 12 5824 5825**Parameters** 5826 5827| Name| Description| 5828| -------- | -------- | 5829| option | Pointer to an alignment rule configuration. | 5830| id | ID of the anchor component. | 5831| value | Alignment mode relative to the anchor component. | 5832 5833 5834### OH_ArkUI_AlignmentRuleOption_SetCenterVertical() 5835 5836``` 5837void OH_ArkUI_AlignmentRuleOption_SetCenterVertical (ArkUI_AlignmentRuleOption * option, const char * id, ArkUI_VerticalAlignment alignment ) 5838``` 5839**Description** 5840 5841Sets the vertical center alignment parameters. 5842 5843**Since**: 12 5844 5845**Parameters** 5846 5847| Name| Description| 5848| -------- | -------- | 5849| option | Pointer to an alignment rule configuration. | 5850| id | ID of the anchor component. | 5851| value | Alignment mode relative to the anchor component. | 5852 5853 5854### OH_ArkUI_AlignmentRuleOption_SetEnd() 5855 5856``` 5857void OH_ArkUI_AlignmentRuleOption_SetEnd (ArkUI_AlignmentRuleOption * option, const char * id, ArkUI_HorizontalAlignment alignment ) 5858``` 5859**Description** 5860 5861Sets the right alignment parameters. 5862 5863**Since**: 12 5864 5865**Parameters** 5866 5867| Name| Description| 5868| -------- | -------- | 5869| option | Pointer to an alignment rule configuration. | 5870| id | ID of the anchor component. | 5871| value | Alignment mode relative to the anchor component. | 5872 5873 5874### OH_ArkUI_AlignmentRuleOption_SetStart() 5875 5876``` 5877void OH_ArkUI_AlignmentRuleOption_SetStart (ArkUI_AlignmentRuleOption * option, const char * id, ArkUI_HorizontalAlignment alignment ) 5878``` 5879**Description** 5880 5881Sets the left alignment parameters. 5882 5883**Since**: 12 5884 5885**Parameters** 5886 5887| Name| Description| 5888| -------- | -------- | 5889| option | Pointer to an alignment rule configuration. | 5890| id | ID of the anchor component. | 5891| value | Alignment mode relative to the anchor component. | 5892 5893 5894### OH_ArkUI_AlignmentRuleOption_SetTop() 5895 5896``` 5897void OH_ArkUI_AlignmentRuleOption_SetTop (ArkUI_AlignmentRuleOption * option, const char * id, ArkUI_VerticalAlignment alignment ) 5898``` 5899**Description** 5900 5901Sets the top alignment parameters. 5902 5903**Since**: 12 5904 5905**Parameters** 5906 5907| Name| Description| 5908| -------- | -------- | 5909| option | Pointer to an alignment rule configuration. | 5910| id | ID of the anchor component. | 5911| value | Alignment mode relative to the anchor component. | 5912 5913 5914### OH_ArkUI_AllowNodeAllDropDataTypes() 5915 5916``` 5917int32_t OH_ArkUI_AllowNodeAllDropDataTypes (ArkUI_NodeHandle node) 5918``` 5919**Description** 5920 5921Configures the specified component to allow any data types. This API resets the settings configured through [OH_ArkUI_SetNodeAllowedDropDataTypes](#oh_arkui_setnodealloweddropdatatypes). 5922 5923**Since**: 12 5924 5925**Parameters** 5926 5927| Name| Description| 5928| -------- | -------- | 5929| node | Pointer to a component node. | 5930 5931**Returns** 5932 5933Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 5934 5935 5936### OH_ArkUI_AnimateOption_Create() 5937 5938``` 5939ArkUI_AnimateOption* OH_ArkUI_AnimateOption_Create () 5940``` 5941**Description** 5942 5943Creates an animation configuration. 5944 5945**Since**: 12 5946 5947**Returns** 5948 5949Returns the pointer to the created animation configuration. 5950 5951 5952### OH_ArkUI_AnimateOption_Dispose() 5953 5954``` 5955void OH_ArkUI_AnimateOption_Dispose (ArkUI_AnimateOption * option) 5956``` 5957**Description** 5958 5959Disposes of an animation configuration. 5960 5961**Since**: 12 5962 5963 5964### OH_ArkUI_AnimateOption_GetCurve() 5965 5966``` 5967ArkUI_AnimationCurve OH_ArkUI_AnimateOption_GetCurve (ArkUI_AnimateOption * option) 5968``` 5969**Description** 5970 5971Obtains an animation curve. 5972 5973**Since**: 12 5974 5975**Parameters** 5976 5977| Name| Description| 5978| -------- | -------- | 5979| option | Pointer to an animation configuration. | 5980 5981**Returns** 5982 5983Returns the animation curve. 5984 5985 5986### OH_ArkUI_AnimateOption_GetDelay() 5987 5988``` 5989int32_t OH_ArkUI_AnimateOption_GetDelay (ArkUI_AnimateOption * option) 5990``` 5991**Description** 5992 5993Obtains the animation delay, in milliseconds. 5994 5995**Since**: 12 5996 5997**Parameters** 5998 5999| Name| Description| 6000| -------- | -------- | 6001| option | Pointer to an animation configuration. | 6002 6003**Returns** 6004 6005Returns the animation delay. 6006 6007 6008### OH_ArkUI_AnimateOption_GetDuration() 6009 6010``` 6011int32_t OH_ArkUI_AnimateOption_GetDuration (ArkUI_AnimateOption * option) 6012``` 6013**Description** 6014 6015Obtains the animation duration, in milliseconds. 6016 6017**Since**: 12 6018 6019**Parameters** 6020 6021| Name| Description| 6022| -------- | -------- | 6023| option | Pointer to an animation configuration. | 6024 6025**Returns** 6026 6027Returns the animation duration. 6028 6029 6030### OH_ArkUI_AnimateOption_GetExpectedFrameRateRange() 6031 6032``` 6033ArkUI_ExpectedFrameRateRange* OH_ArkUI_AnimateOption_GetExpectedFrameRateRange (ArkUI_AnimateOption * option) 6034``` 6035**Description** 6036 6037Obtains the expected frame rate range of an animation. 6038 6039**Since**: 12 6040 6041**Parameters** 6042 6043| Name| Description| 6044| -------- | -------- | 6045| option | Pointer to an animation configuration. | 6046 6047**Returns** 6048 6049Returns the expected frame rate range. 6050 6051 6052### OH_ArkUI_AnimateOption_GetICurve() 6053 6054``` 6055ArkUI_CurveHandle OH_ArkUI_AnimateOption_GetICurve (ArkUI_AnimateOption * option) 6056``` 6057**Description** 6058 6059Obtains the animation curve of an animation. 6060 6061**Since**: 12 6062 6063**Parameters** 6064 6065| Name| Description| 6066| -------- | -------- | 6067| option | Pointer to an animation configuration. | 6068 6069**Returns** 6070 6071Returns the animation curve of the specified animation. 6072 6073 6074### OH_ArkUI_AnimateOption_GetIterations() 6075 6076``` 6077int32_t OH_ArkUI_AnimateOption_GetIterations (ArkUI_AnimateOption * option) 6078``` 6079**Description** 6080 6081Obtains the number of times that an animation is played. 6082 6083**Since**: 12 6084 6085**Parameters** 6086 6087| Name| Description| 6088| -------- | -------- | 6089| option | Pointer to an animation configuration. | 6090 6091**Returns** 6092 6093Returns the number of times that the animation is played. 6094 6095### OH_ArkUI_AnimateOption_GetPlayMode() 6096 6097``` 6098ArkUI_AnimationPlayMode OH_ArkUI_AnimateOption_GetPlayMode (ArkUI_AnimateOption * option) 6099``` 6100**Description** 6101 6102Obtains the playback mode of an animation. 6103 6104**Since**: 12 6105 6106**Parameters** 6107 6108| Name| Description| 6109| -------- | -------- | 6110| option | Pointer to an animation configuration. | 6111 6112**Returns** 6113 6114Returns the animation playback mode. 6115 6116 6117### OH_ArkUI_AnimateOption_GetTempo() 6118 6119``` 6120float OH_ArkUI_AnimateOption_GetTempo (ArkUI_AnimateOption * option) 6121``` 6122**Description** 6123 6124Obtains the playback speed of an animation. 6125 6126**Since**: 12 6127 6128**Parameters** 6129 6130| Name| Description| 6131| -------- | -------- | 6132| option | Pointer to an animation configuration. | 6133 6134**Returns** 6135 6136Animation playback speed. 6137 6138 6139### OH_ArkUI_AnimateOption_SetCurve() 6140 6141``` 6142void OH_ArkUI_AnimateOption_SetCurve (ArkUI_AnimateOption * option, ArkUI_AnimationCurve value ) 6143``` 6144**Description** 6145 6146Sets the animation curve. 6147 6148**Since**: 12 6149 6150**Parameters** 6151 6152| Name| Description| 6153| -------- | -------- | 6154| option | Pointer to an animation configuration. | 6155| value | Returns the animation curve. Default value: **ARKUI_CURVE_LINEAR**. | 6156 6157 6158### OH_ArkUI_AnimateOption_SetDelay() 6159 6160``` 6161void OH_ArkUI_AnimateOption_SetDelay (ArkUI_AnimateOption * option, int32_t value ) 6162``` 6163**Description** 6164 6165Sets the animation delay. 6166 6167**Since**: 12 6168 6169**Parameters** 6170 6171| Name| Description| 6172| -------- | -------- | 6173| option | Pointer to an animation configuration. | 6174| value | Delay of animation playback. | 6175 6176 6177### OH_ArkUI_AnimateOption_SetDuration() 6178 6179``` 6180void OH_ArkUI_AnimateOption_SetDuration (ArkUI_AnimateOption * option, int32_t value ) 6181``` 6182**Description** 6183 6184Sets the animation duration. 6185 6186**Since**: 12 6187 6188**Parameters** 6189 6190| Name| Description| 6191| -------- | -------- | 6192| option | Pointer to an animation configuration. | 6193| value | Duration, in milliseconds. | 6194 6195 6196### OH_ArkUI_AnimateOption_SetExpectedFrameRateRange() 6197 6198``` 6199void OH_ArkUI_AnimateOption_SetExpectedFrameRateRange (ArkUI_AnimateOption * option, ArkUI_ExpectedFrameRateRange * value ) 6200``` 6201**Description** 6202 6203Sets the expected frame rate range of the animation. 6204 6205**Since**: 12 6206 6207**Parameters** 6208 6209| Name| Description| 6210| -------- | -------- | 6211| option | Pointer to an animation configuration. | 6212| value | Expected frame rate range of the animation. | 6213 6214 6215### OH_ArkUI_AnimateOption_SetICurve() 6216 6217``` 6218void OH_ArkUI_AnimateOption_SetICurve (ArkUI_AnimateOption * option, ArkUI_CurveHandle value ) 6219``` 6220**Description** 6221 6222Sets the animation curve for an animation. 6223 6224**Since**: 12 6225 6226**Parameters** 6227 6228| Name| Description| 6229| -------- | -------- | 6230| option | Pointer to an animation configuration. | 6231| value | Animation curve settings. | 6232 6233**NOTE** 6234 6235This API is preferred over the value set by **OH_ArkUI_AnimateOption_SetCurve**. 6236 6237 6238### OH_ArkUI_AnimateOption_SetIterations() 6239 6240``` 6241void OH_ArkUI_AnimateOption_SetIterations (ArkUI_AnimateOption * option, int32_t value ) 6242``` 6243**Description** 6244 6245Sets the number of times that an animation is played. 6246 6247**Since**: 12 6248 6249**Parameters** 6250 6251| Name| Description| 6252| -------- | -------- | 6253| option | Pointer to an animation configuration. | 6254| value | Number of times that the animation is played. | 6255 6256 6257### OH_ArkUI_AnimateOption_SetPlayMode() 6258 6259``` 6260void OH_ArkUI_AnimateOption_SetPlayMode (ArkUI_AnimateOption * option, ArkUI_AnimationPlayMode value ) 6261``` 6262**Description** 6263 6264Sets the playback mode for an animation. 6265 6266**Since**: 12 6267 6268**Parameters** 6269 6270| Name| Description| 6271| -------- | -------- | 6272| option | Pointer to an animation configuration. | 6273| value | Animation playback mode. | 6274 6275 6276### OH_ArkUI_AnimateOption_SetTempo() 6277 6278``` 6279void OH_ArkUI_AnimateOption_SetTempo (ArkUI_AnimateOption * option, float value ) 6280``` 6281**Description** 6282 6283Sets the playback speed of an animation. 6284 6285**Since**: 12 6286 6287**Parameters** 6288 6289| Name| Description| 6290| -------- | -------- | 6291| option | Pointer to an animation configuration. | 6292| value | Animation playback speed. | 6293 6294 6295### OH_ArkUI_Animator_Cancel() 6296 6297``` 6298int32_t OH_ArkUI_Animator_Cancel (ArkUI_AnimatorHandle animator) 6299``` 6300**Description** 6301 6302Cancels the animation of an animator. 6303 6304**Parameters** 6305 6306| Name| Description| 6307| -------- | -------- | 6308| animator | Animator object. | 6309 6310**Returns** 6311 6312Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6313 6314 6315### OH_ArkUI_Animator_Finish() 6316 6317``` 6318int32_t OH_ArkUI_Animator_Finish (ArkUI_AnimatorHandle animator) 6319``` 6320**Description** 6321 6322Ends the animation of an animator. 6323 6324**Parameters** 6325 6326| Name| Description| 6327| -------- | -------- | 6328| animator | Animator object. | 6329 6330**Returns** 6331 6332Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6333 6334 6335### OH_ArkUI_Animator_Pause() 6336 6337``` 6338int32_t OH_ArkUI_Animator_Pause (ArkUI_AnimatorHandle animator) 6339``` 6340**Description** 6341 6342Pauses the animation of an animator. 6343 6344**Parameters** 6345 6346| Name| Description| 6347| -------- | -------- | 6348| animator | Animator object. | 6349 6350**Returns** 6351 6352Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6353 6354 6355### OH_ArkUI_Animator_Play() 6356 6357``` 6358int32_t OH_ArkUI_Animator_Play (ArkUI_AnimatorHandle animator) 6359``` 6360**Description** 6361 6362Starts the animation of an animator. 6363 6364**Parameters** 6365 6366| Name| Description| 6367| -------- | -------- | 6368| animator | Animator object. | 6369 6370**Returns** 6371 6372Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6373 6374 6375### OH_ArkUI_Animator_ResetAnimatorOption() 6376 6377``` 6378int32_t OH_ArkUI_Animator_ResetAnimatorOption (ArkUI_AnimatorHandle animator, ArkUI_AnimatorOption * option ) 6379``` 6380**Description** 6381 6382Resets an animator configuration. 6383 6384**Parameters** 6385 6386| Name| Description| 6387| -------- | -------- | 6388| animator | Animator object. | 6389| option | Pointer to an animation configuration. | 6390 6391**Returns** 6392 6393Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6394 6395 6396### OH_ArkUI_Animator_Reverse() 6397 6398``` 6399int32_t OH_ArkUI_Animator_Reverse (ArkUI_AnimatorHandle animator) 6400``` 6401**Description** 6402 6403Plays the animation of an animator in reverse order. 6404 6405**Parameters** 6406 6407| Name| Description| 6408| -------- | -------- | 6409| animator | Animator object. | 6410 6411**Returns** 6412 6413Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6414 6415 6416### OH_ArkUI_AnimatorEvent_GetUserData() 6417 6418``` 6419void* OH_ArkUI_AnimatorEvent_GetUserData (ArkUI_AnimatorEvent * event) 6420``` 6421**Description** 6422 6423Obtains the custom object in an animation event object. 6424 6425**Since**: 12 6426 6427**Parameters** 6428 6429| Name| Description| 6430| -------- | -------- | 6431| event | Animation event object. | 6432 6433**Returns** 6434 6435Returns the custom object. 6436 6437 6438### OH_ArkUI_AnimatorOnFrameEvent_GetUserData() 6439 6440``` 6441void* OH_ArkUI_AnimatorOnFrameEvent_GetUserData (ArkUI_AnimatorOnFrameEvent * event) 6442``` 6443**Description** 6444 6445Obtains the custom object in an animation event object. 6446 6447**Since**: 12 6448 6449**Parameters** 6450 6451| Name| Description| 6452| -------- | -------- | 6453| event | Animation event object. | 6454 6455**Returns** 6456 6457Returns the custom object. 6458 6459 6460### OH_ArkUI_AnimatorOnFrameEvent_GetValue() 6461 6462``` 6463float OH_ArkUI_AnimatorOnFrameEvent_GetValue (ArkUI_AnimatorOnFrameEvent * event) 6464``` 6465**Description** 6466 6467Obtains the current progress in an animation event object. 6468 6469**Since**: 12 6470 6471**Parameters** 6472 6473| Name| Description| 6474| -------- | -------- | 6475| event | Animation event object. | 6476 6477**Returns** 6478 6479Returns the animation progress. 6480 6481 6482### OH_ArkUI_AnimatorOption_Create() 6483 6484``` 6485ArkUI_AnimatorOption* OH_ArkUI_AnimatorOption_Create (int32_t keyframeSize) 6486``` 6487**Description** 6488 6489Creates an animator parameter object. 6490 6491**Since**: 12 6492 6493**Parameters** 6494 6495| Name| Description| 6496| -------- | -------- | 6497| keyframeSize | Number of keyframes. | 6498 6499**NOTE** 6500 6501If 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. 6502 6503**Returns** 6504 6505Returns the pointer to the animator parameter object. 6506 6507 6508### OH_ArkUI_AnimatorOption_Dispose() 6509 6510``` 6511void OH_ArkUI_AnimatorOption_Dispose (ArkUI_AnimatorOption * option) 6512``` 6513**Description** 6514 6515Disposes of an **AnimatorOption** object. 6516 6517**Since**: 12 6518 6519 6520### OH_ArkUI_AnimatorOption_GetBegin() 6521 6522``` 6523float OH_ArkUI_AnimatorOption_GetBegin (ArkUI_AnimatorOption * option) 6524``` 6525**Description** 6526 6527Obtains the interpolation start point of an animation. 6528 6529**Since**: 12 6530 6531**Parameters** 6532 6533| Name| Description| 6534| -------- | -------- | 6535| option | Pointer to an animation configuration. | 6536 6537**Returns** 6538 6539Returns the start point of the animation interpolation. 6540 6541 6542### OH_ArkUI_AnimatorOption_GetCurve() 6543 6544``` 6545ArkUI_CurveHandle OH_ArkUI_AnimatorOption_GetCurve (ArkUI_AnimatorOption * option) 6546``` 6547**Description** 6548 6549Obtains the interpolation curve of the animation of an animator. 6550 6551**Since**: 12 6552 6553**Parameters** 6554 6555| Name| Description| 6556| -------- | -------- | 6557| option | Pointer to an animation configuration. | 6558 6559**Returns** 6560 6561Returns the interpolation curve of the animation. 6562 6563 6564### OH_ArkUI_AnimatorOption_GetDelay() 6565 6566``` 6567int32_t OH_ArkUI_AnimatorOption_GetDelay (ArkUI_AnimatorOption * option) 6568``` 6569**Description** 6570 6571Obtains the delay for playing an animation. 6572 6573**Since**: 12 6574 6575**Parameters** 6576 6577| Name| Description| 6578| -------- | -------- | 6579| option | Pointer to an animation configuration. | 6580 6581**Returns** 6582 6583Returns the delay for playing the animation, in milliseconds. 6584 6585 6586### OH_ArkUI_AnimatorOption_GetDirection() 6587 6588``` 6589ArkUI_AnimationDirection OH_ArkUI_AnimatorOption_GetDirection (ArkUI_AnimatorOption * option) 6590``` 6591**Description** 6592 6593Obtains the playback direction of an animation. 6594 6595**Since**: 12 6596 6597**Parameters** 6598 6599| Name| Description| 6600| -------- | -------- | 6601| option | Pointer to an animation configuration. | 6602 6603**Returns** 6604 6605Returns the animation playback direction. 6606 6607 6608### OH_ArkUI_AnimatorOption_GetDuration() 6609 6610``` 6611int32_t OH_ArkUI_AnimatorOption_GetDuration (ArkUI_AnimatorOption * option) 6612``` 6613**Description** 6614 6615Obtains the duration for playing an animation. 6616 6617**Since**: 12 6618 6619**Parameters** 6620 6621| Name| Description| 6622| -------- | -------- | 6623| option | Pointer to an animation configuration. | 6624 6625**Returns** 6626 6627Returns the duration for playing the animation, in milliseconds. 6628 6629 6630### OH_ArkUI_AnimatorOption_GetEnd() 6631 6632``` 6633float OH_ArkUI_AnimatorOption_GetEnd (ArkUI_AnimatorOption * option) 6634``` 6635**Description** 6636 6637Obtains the interpolation end point of an animation. 6638 6639**Since**: 12 6640 6641**Parameters** 6642 6643| Name| Description| 6644| -------- | -------- | 6645| option | Pointer to an animation configuration. | 6646 6647**Returns** 6648 6649Returns the interpolation end point of the animation. 6650 6651 6652### OH_ArkUI_AnimatorOption_GetExpectedFrameRateRange() 6653 6654``` 6655ArkUI_ExpectedFrameRateRange* OH_ArkUI_AnimatorOption_GetExpectedFrameRateRange (ArkUI_AnimatorOption * option) 6656``` 6657**Description** 6658 6659Obtains the expected frame rate range of an animation. 6660 6661**Since**: 12 6662 6663**Parameters** 6664 6665| Name| Description| 6666| -------- | -------- | 6667| option | Pointer to an animation configuration. | 6668 6669**Returns** 6670 6671Returns the pointer to the expected frame rate range object. 6672 6673 6674### OH_ArkUI_AnimatorOption_GetFill() 6675 6676``` 6677ArkUI_AnimationFill OH_ArkUI_AnimatorOption_GetFill (ArkUI_AnimatorOption * option) 6678``` 6679**Description** 6680 6681Obtains whether the animator animation is restored to the initial state after being executed. 6682 6683**Since**: 12 6684 6685**Parameters** 6686 6687| Name| Description| 6688| -------- | -------- | 6689| option | Pointer to an animation configuration. | 6690 6691**Returns** 6692 6693Returns whether the animator animation is restored to the initial state after being executed. 6694 6695 6696### OH_ArkUI_AnimatorOption_GetIterations() 6697 6698``` 6699int32_t OH_ArkUI_AnimatorOption_GetIterations (ArkUI_AnimatorOption * option) 6700``` 6701**Description** 6702 6703Obtains the number of times that an animation is played. 6704 6705**Since**: 12 6706 6707**Parameters** 6708 6709| Name| Description| 6710| -------- | -------- | 6711| option | Pointer to an **AnimatorOption** object. | 6712 6713**Returns** 6714 6715Number of times that the animation is played. 6716 6717 6718### OH_ArkUI_AnimatorOption_GetKeyframeCurve() 6719 6720``` 6721ArkUI_CurveHandle OH_ArkUI_AnimatorOption_GetKeyframeCurve (ArkUI_AnimatorOption * option, int32_t index ) 6722``` 6723**Description** 6724 6725Obtains the interpolation curve for a keyframe in the animation of an animator. 6726 6727**Since**: 12 6728 6729**Parameters** 6730 6731| Name| Description| 6732| -------- | -------- | 6733| option | Pointer to an **AnimatorOption** object. | 6734| index | Keyframe index. | 6735 6736**Returns** 6737 6738Returns the interpolation curve. 6739 6740 6741### OH_ArkUI_AnimatorOption_GetKeyframeTime() 6742 6743``` 6744float OH_ArkUI_AnimatorOption_GetKeyframeTime (ArkUI_AnimatorOption * option, int32_t index ) 6745``` 6746**Description** 6747 6748Obtains the keyframe time of an animation. 6749 6750**Since**: 12 6751 6752**Parameters** 6753 6754| Name| Description| 6755| -------- | -------- | 6756| option | Pointer to an **AnimatorOption** object. | 6757| index | Keyframe index. | 6758 6759**Returns** 6760 6761Keyframe time. 6762 6763 6764### OH_ArkUI_AnimatorOption_GetKeyframeValue() 6765 6766``` 6767float OH_ArkUI_AnimatorOption_GetKeyframeValue (ArkUI_AnimatorOption * option, int32_t index ) 6768``` 6769**Description** 6770 6771Obtains the keyframe value of an animation. 6772 6773**Since**: 12 6774 6775**Parameters** 6776 6777| Name| Description| 6778| -------- | -------- | 6779| option | Pointer to an **AnimatorOption** object. | 6780| index | Keyframe index. | 6781 6782**Returns** 6783 6784Keyframe value. 6785 6786 6787### OH_ArkUI_AnimatorOption_RegisterOnCancelCallback() 6788 6789``` 6790int32_t OH_ArkUI_AnimatorOption_RegisterOnCancelCallback (ArkUI_AnimatorOption * option, void * userData, void(*)(ArkUI_AnimatorEvent *event) callback ) 6791``` 6792**Description** 6793 6794Sets the callback invoked when the animation playback is canceled. 6795 6796**Parameters** 6797 6798| Name| Description| 6799| -------- | -------- | 6800| option | Pointer to an animation configuration. | 6801| userData | Custom parameter. | 6802| callback | Callback used to return the result. | 6803 6804**Returns** 6805 6806Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6807 6808 6809### OH_ArkUI_AnimatorOption_RegisterOnFinishCallback() 6810 6811``` 6812int32_t OH_ArkUI_AnimatorOption_RegisterOnFinishCallback (ArkUI_AnimatorOption * option, void * userData, void(*)(ArkUI_AnimatorEvent *event) callback ) 6813``` 6814**Description** 6815 6816Sets the callback invoked when the animation playback is complete. 6817 6818**Parameters** 6819 6820| Name| Description| 6821| -------- | -------- | 6822| option | Pointer to an animation configuration. | 6823| userData | Custom parameter. | 6824| callback | Callback used to return the result. | 6825 6826**Returns** 6827 6828Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6829 6830 6831### OH_ArkUI_AnimatorOption_RegisterOnFrameCallback() 6832 6833``` 6834int32_t OH_ArkUI_AnimatorOption_RegisterOnFrameCallback (ArkUI_AnimatorOption * option, void * userData, void(*)(ArkUI_AnimatorOnFrameEvent *event) callback ) 6835``` 6836**Description** 6837 6838Sets the callback invoked when the animator receives a frame. 6839 6840**Parameters** 6841 6842| Name| Description| 6843| -------- | -------- | 6844| option | Pointer to an animation configuration. | 6845| userData | Custom parameter. | 6846| callback | Callback used to return the result. | 6847 6848**Returns** 6849 6850Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6851 6852 6853### OH_ArkUI_AnimatorOption_RegisterOnRepeatCallback() 6854 6855``` 6856int32_t OH_ArkUI_AnimatorOption_RegisterOnRepeatCallback (ArkUI_AnimatorOption * option, void * userData, void(*)(ArkUI_AnimatorEvent *event) callback ) 6857``` 6858**Description** 6859 6860Sets the callback invoked when the animation playback is repeated. 6861 6862**Parameters** 6863 6864| Name| Description| 6865| -------- | -------- | 6866| option | Pointer to an animation configuration. | 6867| userData | Custom parameter. | 6868| callback | Callback used to return the result. | 6869 6870**Returns** 6871 6872Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6873 6874 6875### OH_ArkUI_AnimatorOption_SetBegin() 6876 6877``` 6878int32_t OH_ArkUI_AnimatorOption_SetBegin (ArkUI_AnimatorOption * option, float value ) 6879``` 6880**Description** 6881 6882Sets the interpolation start point for the animation of an animator. 6883 6884**Parameters** 6885 6886| Name| Description| 6887| -------- | -------- | 6888| option | Pointer to an **AnimatorOption** object. | 6889| value | Start point of the animation interpolation. | 6890 6891**NOTE** 6892 6893This API does not take effect when the animation is a keyframe animation. 6894 6895**Returns** 6896 6897Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6898 6899 6900### OH_ArkUI_AnimatorOption_SetCurve() 6901 6902``` 6903int32_t OH_ArkUI_AnimatorOption_SetCurve (ArkUI_AnimatorOption * option, ArkUI_CurveHandle value ) 6904``` 6905**Description** 6906 6907Sets the interpolation curve for the animation of an animator. 6908 6909**Parameters** 6910 6911| Name| Description| 6912| -------- | -------- | 6913| option | Pointer to an **AnimatorOption** object. | 6914| value | Returns the interpolation curve of the animation. Default value: **ARKUI_CURVE_LINEAR**. | 6915 6916**NOTE** 6917 6918The **springCurve**, **springMotion**, **responsiveSpringMotion**, and **interpolatingSpring customCurve** curves are not supported. 6919 6920**Returns** 6921 6922Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6923 6924 6925### OH_ArkUI_AnimatorOption_SetDelay() 6926 6927``` 6928int32_t OH_ArkUI_AnimatorOption_SetDelay (ArkUI_AnimatorOption * option, int32_t value ) 6929``` 6930**Description** 6931 6932Sets the delay of animation playback, in milliseconds. 6933 6934**Parameters** 6935 6936| Name| Description| 6937| -------- | -------- | 6938| option | Pointer to an **AnimatorOption** object. | 6939| value | Animation delay, in milliseconds. | 6940 6941**Returns** 6942 6943Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6944 6945 6946### OH_ArkUI_AnimatorOption_SetDirection() 6947 6948``` 6949int32_t OH_ArkUI_AnimatorOption_SetDirection (ArkUI_AnimatorOption * option, ArkUI_AnimationDirection value ) 6950``` 6951**Description** 6952 6953Sets the playback direction. 6954 6955**Parameters** 6956 6957| Name| Description| 6958| -------- | -------- | 6959| option | Pointer to an **AnimatorOption** object. | 6960| value | Animation playback direction. | 6961 6962**Returns** 6963 6964Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6965 6966 6967### OH_ArkUI_AnimatorOption_SetDuration() 6968 6969``` 6970int32_t OH_ArkUI_AnimatorOption_SetDuration (ArkUI_AnimatorOption * option, int32_t value ) 6971``` 6972**Description** 6973 6974Sets the duration of an animation, in milliseconds. 6975 6976**Parameters** 6977 6978| Name| Description| 6979| -------- | -------- | 6980| option | Pointer to an **AnimatorOption** object. | 6981| value | Duration for playing the animation, in milliseconds. | 6982 6983**Returns** 6984 6985Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6986 6987 6988### OH_ArkUI_AnimatorOption_SetEnd() 6989 6990``` 6991int32_t OH_ArkUI_AnimatorOption_SetEnd (ArkUI_AnimatorOption * option, float value ) 6992``` 6993**Description** 6994 6995Sets the interpolation end point for the animation of an animator. 6996 6997**Parameters** 6998 6999| Name| Description| 7000| -------- | -------- | 7001| option | Pointer to an **AnimatorOption** object. | 7002| value | End point of animation interpolation. | 7003 7004**NOTE** 7005 7006This API does not take effect when the animation is a keyframe animation. 7007 7008**Returns** 7009 7010Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7011 7012 7013### OH_ArkUI_AnimatorOption_SetExpectedFrameRateRange() 7014 7015``` 7016int32_t OH_ArkUI_AnimatorOption_SetExpectedFrameRateRange (ArkUI_AnimatorOption * option, ArkUI_ExpectedFrameRateRange * value ) 7017``` 7018**Description** 7019 7020Sets the expected frame rate range of an animation. 7021 7022**Parameters** 7023 7024| Name| Description| 7025| -------- | -------- | 7026| option | Pointer to an **AnimatorOption** object. | 7027| value | Expected frame rate range. | 7028 7029**Returns** 7030 7031Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7032 7033 7034### OH_ArkUI_AnimatorOption_SetFill() 7035 7036``` 7037int32_t OH_ArkUI_AnimatorOption_SetFill (ArkUI_AnimatorOption * option, ArkUI_AnimationFill value ) 7038``` 7039**Description** 7040 7041Sets whether the animator animation is restored to the initial state after being executed. 7042 7043**Parameters** 7044 7045| Name| Description| 7046| -------- | -------- | 7047| option | Pointer to an **AnimatorOption** object. | 7048| value | Whether to restore the animation to the initial state after the animation is executed. | 7049 7050**Returns** 7051 7052Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7053 7054 7055### OH_ArkUI_AnimatorOption_SetIterations() 7056 7057``` 7058int32_t OH_ArkUI_AnimatorOption_SetIterations (ArkUI_AnimatorOption * option, int32_t value ) 7059``` 7060**Description** 7061 7062Sets 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. 7063 7064**Parameters** 7065 7066| Name| Description| 7067| -------- | -------- | 7068| option | Pointer to an **AnimatorOption** object. | 7069| value | Number of times that the animation is played. | 7070 7071**NOTE** 7072 7073If this parameter is set to a negative value other than **-1**, the value is invalid. In this case, the animation is played once. 7074 7075**Returns** 7076 7077Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7078 7079 7080### OH_ArkUI_AnimatorOption_SetKeyframe() 7081 7082``` 7083int32_t OH_ArkUI_AnimatorOption_SetKeyframe (ArkUI_AnimatorOption * option, float time, float value, int32_t index ) 7084``` 7085**Description** 7086 7087Sets the keyframe parameters of an animation. 7088 7089**Parameters** 7090 7091| Name| Description| 7092| -------- | -------- | 7093| option | Pointer to an **AnimatorOption** object. | 7094| time | Keyframe time. Value range: [0, 1]. The value must be in ascending order. | 7095| value | Keyframe value. | 7096| index | Keyframe index. | 7097 7098**Returns** 7099 7100Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7101 7102 7103### OH_ArkUI_AnimatorOption_SetKeyframeCurve() 7104 7105``` 7106int32_t OH_ArkUI_AnimatorOption_SetKeyframeCurve (ArkUI_AnimatorOption * option, ArkUI_CurveHandle value, int32_t index ) 7107``` 7108**Description** 7109 7110Sets the keyframe curve type for the animation of an animator. 7111 7112**Parameters** 7113 7114| Name| Description| 7115| -------- | -------- | 7116| option | Pointer to an **AnimatorOption** object. | 7117| value | Animation interpolation curve. | 7118| index | Keyframe index. | 7119 7120**NOTE** 7121 7122The **springCurve**, **springMotion**, **responsiveSpringMotion**, and **interpolatingSpring customCurve** curves are not supported. 7123 7124**Returns** 7125 7126Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7127 7128 7129### OH_ArkUI_BarrierOption_Create() 7130 7131``` 7132ArkUI_BarrierOption* OH_ArkUI_BarrierOption_Create (int32_t size) 7133``` 7134**Description** 7135 7136Creates a barrier configuration for this **RelativeContainer** component. 7137 7138**Since**: 12 7139 7140**Parameters** 7141 7142| Name| Description| 7143| -------- | -------- | 7144| size | Number of barriers. | 7145 7146**Returns** 7147 7148Returns the barrier configuration. 7149 7150 7151### OH_ArkUI_BarrierOption_Dispose() 7152 7153``` 7154void OH_ArkUI_BarrierOption_Dispose (ArkUI_BarrierOption * barrierStyle) 7155``` 7156**Description** 7157 7158Disposes of a barrier configuration. 7159 7160**Since**: 12 7161 7162**Parameters** 7163 7164| Name| Description| 7165| -------- | -------- | 7166| barrierStyle | Pointer to a barrier configuration. | 7167 7168 7169### OH_ArkUI_BarrierOption_GetDirection() 7170 7171``` 7172ArkUI_BarrierDirection OH_ArkUI_BarrierOption_GetDirection (ArkUI_BarrierOption * barrierStyle, int32_t index ) 7173``` 7174**Description** 7175 7176Obtains the direction of a barrier. 7177 7178**Since**: 12 7179 7180**Parameters** 7181 7182| Name| Description| 7183| -------- | -------- | 7184| barrierStyle | Pointer to a barrier configuration. | 7185| index | Index of the barrier. | 7186 7187**Returns** 7188 7189Returns the direction of the barrier. 7190 7191 7192### OH_ArkUI_BarrierOption_GetId() 7193 7194``` 7195const char* OH_ArkUI_BarrierOption_GetId (ArkUI_BarrierOption * barrierStyle, int32_t index ) 7196``` 7197**Description** 7198 7199Obtains the ID of a barrier. 7200 7201**Since**: 12 7202 7203**Parameters** 7204 7205| Name| Description| 7206| -------- | -------- | 7207| barrierStyle | Pointer to a barrier configuration. | 7208| index | Index of the barrier. | 7209 7210**Returns** 7211 7212Returns the ID of the barrier. 7213 7214 7215### OH_ArkUI_BarrierOption_GetReferencedId() 7216 7217``` 7218const char* OH_ArkUI_BarrierOption_GetReferencedId (ArkUI_BarrierOption * barrierStyle, int32_t index, int32_t referencedIndex ) 7219``` 7220**Description** 7221 7222Obtains the referenced components of a barrier. 7223 7224**Since**: 12 7225 7226**Parameters** 7227 7228| Name| Description| 7229| -------- | -------- | 7230| barrierStyle | Pointer to a barrier configuration. | 7231| index | Index of the barrier. | 7232| referencedIndex | Index of the referenced component ID. | 7233 7234**Returns** 7235 7236Returns the referenced components of the barrier. 7237 7238 7239### OH_ArkUI_BarrierOption_GetReferencedIdSize() 7240 7241``` 7242int32_t OH_ArkUI_BarrierOption_GetReferencedIdSize (ArkUI_BarrierOption * barrierStyle, int32_t index ) 7243``` 7244**Description** 7245 7246Obtains the number of referenced components of a barrier. 7247 7248**Since**: 12 7249 7250**Parameters** 7251 7252| Name| Description| 7253| -------- | -------- | 7254| barrierStyle | Pointer to a barrier configuration. | 7255| index | Index of the barrier. | 7256 7257**Returns** 7258 7259Returns the number of referenced components of the barrier. 7260 7261 7262### OH_ArkUI_BarrierOption_SetDirection() 7263 7264``` 7265void OH_ArkUI_BarrierOption_SetDirection (ArkUI_BarrierOption * barrierStyle, ArkUI_BarrierDirection value, int32_t index ) 7266``` 7267**Description** 7268 7269Sets the direction of a barrier. 7270 7271**Since**: 12 7272 7273**Parameters** 7274 7275| Name| Description| 7276| -------- | -------- | 7277| barrierStyle | Pointer to a barrier configuration. | 7278| value | Direction. | 7279| index | Index of the barrier. | 7280 7281 7282### OH_ArkUI_BarrierOption_SetId() 7283 7284``` 7285void OH_ArkUI_BarrierOption_SetId (ArkUI_BarrierOption * barrierStyle, const char * value, int32_t index ) 7286``` 7287**Description** 7288 7289Sets the ID of a barrier. 7290 7291**Since**: 12 7292 7293**Parameters** 7294 7295| Name| Description| 7296| -------- | -------- | 7297| barrierStyle | Pointer to a barrier configuration. | 7298| value | ID of the barrier, which must be unique and cannot be the same as the name of any component in the container. | 7299| index | Index of the barrier. | 7300 7301 7302### OH_ArkUI_BarrierOption_SetReferencedId() 7303 7304``` 7305void OH_ArkUI_BarrierOption_SetReferencedId (ArkUI_BarrierOption * barrierStyle, const char * value, int32_t index ) 7306``` 7307**Description** 7308 7309Sets the referenced components of a barrier. 7310 7311**Since**: 12 7312 7313**Parameters** 7314 7315| Name| Description| 7316| -------- | -------- | 7317| barrierStyle | Pointer to a barrier configuration. | 7318| value | Referenced component IDs. | 7319| index | Index of the barrier. | 7320 7321 7322### OH_ArkUI_ConvertToHtml() 7323 7324``` 7325const char* OH_ArkUI_ConvertToHtml (ArkUI_StyledString_Descriptor * descriptor) 7326``` 7327**Description** 7328 7329Converts styled string information into HTML. 7330 7331**Since**: 14 7332 7333**Parameters** 7334 7335| Name| Description| 7336| -------- | -------- | 7337| descriptor | Pointer to an **ArkUI_StyledString_Descriptor** object. | 7338 7339**Returns** 7340 7341Returns 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. 7342 7343 7344### OH_ArkUI_CreateAsymmetricTransitionEffect() 7345 7346``` 7347ArkUI_TransitionEffect* OH_ArkUI_CreateAsymmetricTransitionEffect (ArkUI_TransitionEffect * appear, ArkUI_TransitionEffect * disappear ) 7348``` 7349**Description** 7350 7351Creates an asymmetric transition effect. 7352 7353**Since**: 12 7354 7355**Parameters** 7356 7357| Name| Description| 7358| -------- | -------- | 7359| appear | Transition effect for appearance. | 7360| disappear | Transition effect for disappearance. | 7361 7362**NOTE** 7363 7364If the **asymmetric** function is not used for constructing **TransitionEffect**, the transition effect takes effect for both appearance and disappearance of the component. 7365 7366**Returns** 7367 7368Returns the asymmetric transition effect; returns **NULL** if a parameter error occurs. 7369 7370 7371### OH_ArkUI_CreateDragActionWithContext() 7372 7373``` 7374ArkUI_DragAction* OH_ArkUI_CreateDragActionWithContext (ArkUI_ContextHandle uiContext) 7375``` 7376**Description** 7377 7378Creates a drag action object for the specified UI instance. 7379 7380**Since**: 12 7381 7382**Parameters** 7383 7384| Name| Description| 7385| -------- | -------- | 7386| uiContext | Pointer to the UI instance object. | 7387 7388**Returns** 7389 7390Returns the pointer to the created drag action object; returns null if the operation fails. 7391 7392 7393### OH_ArkUI_CreateDragActionWithNode() 7394 7395``` 7396ArkUI_DragAction* OH_ArkUI_CreateDragActionWithNode (ArkUI_NodeHandle node) 7397``` 7398**Description** 7399 7400Creates 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. 7401 7402**Since**: 12 7403 7404**Parameters** 7405 7406| Name| Description| 7407| -------- | -------- | 7408| node | Pointer to a component node. | 7409 7410**Returns** 7411 7412Returns the pointer to the created drag action object; returns null if the operation fails. 7413 7414 7415### OH_ArkUI_CreateDragPreviewOption() 7416 7417``` 7418ArkUI_DragPreviewOption* OH_ArkUI_CreateDragPreviewOption (void ) 7419``` 7420**Description** 7421 7422Creates an **ArkUI_DragPreviewOption** object. 7423 7424**Since**: 12 7425 7426**Returns** 7427 7428ArkUI_DragPreviewOption object. 7429 7430 7431### OH_ArkUI_CreateMovementTransitionEffect() 7432 7433``` 7434ArkUI_TransitionEffect* OH_ArkUI_CreateMovementTransitionEffect (ArkUI_TransitionEdge move) 7435``` 7436**Description** 7437 7438Creates a movement object for component transition. 7439 7440**Since**: 12 7441 7442**Parameters** 7443 7444| Name| Description| 7445| -------- | -------- | 7446| move | Panning type. | 7447 7448**Returns** 7449 7450Returns the movement object created for component transition; returns **NULL** if a parameter error occurs. 7451 7452 7453### OH_ArkUI_CreateOpacityTransitionEffect() 7454 7455``` 7456ArkUI_TransitionEffect* OH_ArkUI_CreateOpacityTransitionEffect (float opacity) 7457``` 7458**Description** 7459 7460Creates an opacity object for component transition. 7461 7462**Since**: 12 7463 7464**Parameters** 7465 7466| Name| Description| 7467| -------- | -------- | 7468| opacity | Opacity. The value range is [0, 1]. | 7469 7470**NOTE** 7471 7472If 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. 7473 7474**Returns** 7475 7476Returns the created opacity object for component transition. 7477 7478 7479### OH_ArkUI_CreateRotationTransitionEffect() 7480 7481``` 7482ArkUI_TransitionEffect* OH_ArkUI_CreateRotationTransitionEffect (ArkUI_RotationOptions * rotate) 7483``` 7484**Description** 7485 7486Creates a rotation object for component transition. 7487 7488**Since**: 12 7489 7490**Parameters** 7491 7492| Name| Description| 7493| -------- | -------- | 7494| rotate | Rotation parameter object during component transition. | 7495 7496**Returns** 7497 7498Returns the rotation object created for component transition; returns **NULL** if a parameter error occurs. 7499 7500 7501### OH_ArkUI_CreateScaleTransitionEffect() 7502 7503``` 7504ArkUI_TransitionEffect* OH_ArkUI_CreateScaleTransitionEffect (ArkUI_ScaleOptions * scale) 7505``` 7506**Description** 7507 7508Creates a scaling transition effect object. 7509 7510**Since**: 12 7511 7512**Parameters** 7513 7514| Name| Description| 7515| -------- | -------- | 7516| scale | Scaling settings for component transition. | 7517 7518**Returns** 7519 7520Returns the created scaling transition effect object; returns **NULL** if a parameter error occurs. 7521 7522 7523### OH_ArkUI_CreateTranslationTransitionEffect() 7524 7525``` 7526ArkUI_TransitionEffect* OH_ArkUI_CreateTranslationTransitionEffect (ArkUI_TranslationOptions * translate) 7527``` 7528**Description** 7529 7530Creates a translation transition effect object. 7531 7532**Since**: 12 7533 7534**Parameters** 7535 7536| Name| Description| 7537| -------- | -------- | 7538| translate | Translation settings for component transition. | 7539 7540**Returns** 7541 7542Returns the created translation transition effect object; returns **NULL** if a parameter error occurs. 7543 7544### OH_ArkUI_Curve_CreateCubicBezierCurve() 7545 7546``` 7547ArkUI_CurveHandle OH_ArkUI_Curve_CreateCubicBezierCurve (float x1, float y1, float x2, float y2 ) 7548``` 7549**Description** 7550 7551Creates a cubic Bezier curve. 7552 7553**Parameters** 7554 7555| Name| Description| 7556| -------- | -------- | 7557| 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**. | 7558| y1 | Y coordinate of the first point on the Bezier curve. | 7559| 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**. | 7560| y2 | Y coordinate of the second point on the Bezier curve. | 7561 7562**Returns** 7563 7564Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 7565 7566 7567### OH_ArkUI_Curve_CreateCurveByType() 7568 7569``` 7570ArkUI_CurveHandle OH_ArkUI_Curve_CreateCurveByType (ArkUI_AnimationCurve curve) 7571``` 7572**Description** 7573 7574Implements initialization for the interpolation curve, which is used to create an interpolation curve based on the input parameter. 7575 7576**Parameters** 7577 7578| Name| Description| 7579| -------- | -------- | 7580| curve | Curve type. | 7581 7582**Returns** 7583 7584Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 7585 7586 7587### OH_ArkUI_Curve_CreateCustomCurve() 7588 7589``` 7590ArkUI_CurveHandle OH_ArkUI_Curve_CreateCustomCurve (void * userData, float(*)(float fraction, void *userdata) interpolate ) 7591``` 7592**Description** 7593 7594Creates a custom curve. 7595 7596**Parameters** 7597 7598| Name| Description| 7599| -------- | -------- | 7600| userData | Custom data. | 7601| 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. | 7602 7603**Returns** 7604 7605Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 7606 7607 7608### OH_ArkUI_Curve_CreateInterpolatingSpring() 7609 7610``` 7611ArkUI_CurveHandle OH_ArkUI_Curve_CreateInterpolatingSpring (float velocity, float mass, float stiffness, float damping ) 7612``` 7613**Description** 7614 7615Creates an interpolating spring curve animated from 0 to 1. The actual animation value is calculated based on the curve. 7616 7617**Parameters** 7618 7619| Name| Description| 7620| -------- | -------- | 7621| 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. | 7622| 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. | 7623| 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. | 7624| 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. | 7625 7626**NOTE** 7627 7628The animation duration is subject to the curve parameters, rather than the **duration** parameter in **animation** or **animateTo**. 7629 7630**Returns** 7631 7632Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 7633 7634 7635### OH_ArkUI_Curve_CreateResponsiveSpringMotion() 7636 7637``` 7638ArkUI_CurveHandle OH_ArkUI_Curve_CreateResponsiveSpringMotion (float response, float dampingFraction, float overlapDuration ) 7639``` 7640**Description** 7641 7642Creates 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**. 7643 7644**Parameters** 7645 7646| Name| Description| 7647| -------- | -------- | 7648| response | Duration of one complete oscillation. | 7649| 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. | 7650| 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. | 7651 7652**NOTE** 7653 7654The animation duration is subject to the curve parameters, rather than the **duration** parameter in **animation** or **animateTo**. 7655 7656**Returns** 7657 7658Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 7659 7660 7661### OH_ArkUI_Curve_CreateSpringCurve() 7662 7663``` 7664ArkUI_CurveHandle OH_ArkUI_Curve_CreateSpringCurve (float velocity, float mass, float stiffness, float damping ) 7665``` 7666**Description** 7667 7668Creates 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**. 7669 7670**Parameters** 7671 7672| Name| Description| 7673| -------- | -------- | 7674| 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. | 7675| 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. | 7676| 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. | 7677| 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. | 7678 7679**Returns** 7680 7681Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 7682 7683 7684### OH_ArkUI_Curve_CreateSpringMotion() 7685 7686``` 7687ArkUI_CurveHandle OH_ArkUI_Curve_CreateSpringMotion (float response, float dampingFraction, float overlapDuration ) 7688``` 7689**Description** 7690 7691Creates 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. 7692 7693**Parameters** 7694 7695| Name| Description| 7696| -------- | -------- | 7697| response | Duration of one complete oscillation. | 7698| 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. | 7699| 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. | 7700 7701**NOTE** 7702 7703The animation duration is subject to the curve parameters, rather than the **duration** parameter in **animation** or **animateTo**. 7704 7705**Returns** 7706 7707Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 7708 7709 7710### OH_ArkUI_Curve_CreateStepsCurve() 7711 7712``` 7713ArkUI_CurveHandle OH_ArkUI_Curve_CreateStepsCurve (int32_t count, bool end ) 7714``` 7715**Description** 7716 7717Creates a step curve. 7718 7719**Parameters** 7720 7721| Name| Description| 7722| -------- | -------- | 7723| count | Number of tiers. The value must be a positive integer. Value range: [1, +∞). | 7724| 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. | 7725 7726**Returns** 7727 7728Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 7729 7730 7731### OH_ArkUI_Curve_DisposeCurve() 7732 7733``` 7734void OH_ArkUI_Curve_DisposeCurve (ArkUI_CurveHandle curveHandle) 7735``` 7736**Description** 7737 7738Disposes of a custom curve. 7739 7740**Parameters** 7741 7742| Name| Description| 7743| -------- | -------- | 7744| curve | Returns the pointer to the interpolation object of the curve; | 7745 7746 7747### OH_ArkUI_CustomProperty_Destroy() 7748 7749``` 7750void OH_ArkUI_CustomProperty_Destroy (ArkUI_CustomProperty * handle) 7751``` 7752**Description** 7753 7754Destroys a **CustomProperty** instance. 7755 7756**Since**: 14 7757 7758**Parameters** 7759 7760| Name| Description| 7761| -------- | -------- | 7762| handle | **CustomProperty** instance to destroy. | 7763 7764 7765### OH_ArkUI_CustomProperty_GetStringValue() 7766 7767``` 7768const char* OH_ArkUI_CustomProperty_GetStringValue (ArkUI_CustomProperty * handle) 7769``` 7770**Description** 7771 7772Obtains the value of a custom property. 7773 7774**Since**: 14 7775 7776**Parameters** 7777 7778| Name| Description| 7779| -------- | -------- | 7780| handle | Pointer to the custom property object. | 7781 7782**Returns** 7783 7784Returns the value of the custom property. 7785 7786 7787### OH_ArkUI_CustomSpanDrawInfo_Create() 7788 7789``` 7790ArkUI_CustomSpanDrawInfo* OH_ArkUI_CustomSpanDrawInfo_Create (void ) 7791``` 7792**Description** 7793 7794Creates drawing information for this custom span. 7795 7796**Since**: 12 7797 7798**Returns** 7799 7800Returns a **CustomSpanDrawInfo** instance. If a null pointer is returned, the memory may be insufficient. 7801 7802 7803### OH_ArkUI_CustomSpanDrawInfo_Dispose() 7804 7805``` 7806void OH_ArkUI_CustomSpanDrawInfo_Dispose (ArkUI_CustomSpanDrawInfo * info) 7807``` 7808**Description** 7809 7810Disposes of drawing information for this custom span. 7811 7812**Since**: 12 7813 7814**Parameters** 7815 7816| Name| Description| 7817| -------- | -------- | 7818| info | Pointer to the drawing information of a custom span. | 7819 7820 7821### OH_ArkUI_CustomSpanDrawInfo_GetBaseline() 7822 7823``` 7824float OH_ArkUI_CustomSpanDrawInfo_GetBaseline (ArkUI_CustomSpanDrawInfo * info) 7825``` 7826**Description** 7827 7828Obtains the baseline offset of the custom span relative to the mounted component. 7829 7830**Since**: 12 7831 7832**Parameters** 7833 7834| Name| Description| 7835| -------- | -------- | 7836| info | Pointer to the drawing information of a custom span. | 7837 7838**Returns** 7839 7840Returns the baseline offset. If a parameter error occurs, **0.0f** is returned. A possible cause is that mandatory parameters are left unspecified. 7841 7842### OH_ArkUI_NodeUtils_GetWindowInfo() 7843 7844``` 7845int32_t OH_ArkUI_NodeUtils_GetWindowInfo(ArkUI_NodeHandle node, ArkUI_HostWindowInfo** info) 7846``` 7847**Description** 7848 7849Obtains the information about the window to which a node belongs. 7850 7851**Since**: 15 7852 7853**Parameters** 7854 7855| Name| Description| 7856| -------- | -------- | 7857| node | Pointer to the target node.| 7858| info | Pointer to the window information object.| 7859 7860**Returns** 7861 7862Returns 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. 7863 7864### OH_ArkUI_HostWindowInfo_GetName() 7865 7866``` 7867const char* OH_ArkUI_HostWindowInfo_GetName(ArkUI_HostWindowInfo* info) 7868``` 7869**Description** 7870 7871Obtains the window name from a **HostWindowInfo** object. 7872 7873**Since**: 15 7874 7875**Parameters** 7876 7877| Name| Description| 7878| -------- | -------- | 7879| info | **HostWindowInfo** object.| 7880 7881**Returns** 7882 7883Returns the window name obtained from the **HostWindowInfo** object. 7884 7885### OH_ArkUI_HostWindowInfo_Destroy() 7886 7887``` 7888void OH_ArkUI_HostWindowInfo_Destroy(ArkUI_HostWindowInfo* info) 7889``` 7890**Description** 7891 7892Destroys n **HostWindowInfo** object. 7893 7894**Since**: 15 7895 7896**Parameters** 7897 7898| Name| Description| 7899| -------- | -------- | 7900| info | **HostWindowInfo** object to be destroyed.| 7901 7902### OH_ArkUI_NodeUtils_MoveTo() 7903 7904``` 7905int32_t OH_ArkUI_NodeUtils_MoveTo(ArkUI_NodeHandle node, ArkUI_NodeHandle target_parent, int32_t index) 7906``` 7907**Description** 7908 7909Moves a node to a target parent node as a child. 7910 7911**Since**: 16 7912 7913**Parameters** 7914 7915| Name| Description| 7916| -------- | -------- | 7917| node | Node to be moved.| 7918| target_parent | Pointer to the target parent node.| 7919| 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.| 7920 7921**Returns** 7922 7923Returns 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. 7924 7925### OH_ArkUI_NodeUtils_GetAttachedNodeHandleById() 7926 7927``` 7928int32_t OH_ArkUI_NodeUtils_GetAttachedNodeHandleById(const char* id, ArkUI_NodeHandle* node) 7929``` 7930**Description** 7931 7932Obtains the target node based on the provided user ID. 7933 7934**Since**: 15 7935 7936**Parameters** 7937 7938| Name| Description| 7939| -------- | -------- | 7940| id | ID of the target node.| 7941| node | Pointer to the target parent node.| 7942 7943**Returns** 7944 7945Returns 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. 7946 7947### OH_ArkUI_NodeUtils_SetCrossLanguageOption() 7948 7949``` 7950int32_t OH_ArkUI_NodeUtils_SetCrossLanguageOption(ArkUI_NodeHandle node, ArkUI_CrossLanguageOption* option) 7951``` 7952**Description** 7953 7954Sets the cross-language options for the target node. 7955 7956**Since**: 15 7957 7958**Parameters** 7959 7960| Name| Description| 7961| -------- | -------- | 7962| node | Pointer to the target node.| 7963| option | Cross-language configuration class. For details, see **ArkUI_CrossLanguageOption**.| 7964 7965**Returns** 7966 7967Returns 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. 7968 7969### OH_ArkUI_NodeUtils_GetCrossLanguageOption() 7970 7971``` 7972int32_t OH_ArkUI_NodeUtils_GetCrossLanguageOption(ArkUI_NodeHandle node, ArkUI_CrossLanguageOption* option) 7973``` 7974**Description** 7975 7976Obtains the cross-language options for the target node. 7977 7978**Since**: 15 7979 7980**Parameters** 7981 7982| Name| Description| 7983| -------- | -------- | 7984| node | Pointer to the target node.| 7985| option | Cross-language configuration class. For details, see **ArkUI_CrossLanguageOption**.| 7986 7987**Returns** 7988 7989Returns 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. 7990 7991### OH_ArkUI_NodeUtils_GetFirstChildIndexWithoutExpand() 7992 7993``` 7994int32_t OH_ArkUI_NodeUtils_GetFirstChildIndexWithoutExpand(ArkUI_NodeHandle node, uint32_t* index) 7995``` 7996**Description** 7997 7998Obtains the index of the first child node of the target node in the tree without expanding any nodes. 7999 8000**Since**: 15 8001 8002**Parameters** 8003 8004| Name| Description| 8005| -------- | -------- | 8006| node | Pointer to the target node.| 8007| index | Pointer to a variable where the index of the first child node is stored.| 8008 8009**Returns** 8010 8011Returns 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. 8012 8013### OH_ArkUI_NodeUtils_GetLastChildIndexWithoutExpand() 8014 8015``` 8016int32_t OH_ArkUI_NodeUtils_GetLastChildIndexWithoutExpand(ArkUI_NodeHandle node, uint32_t* index) 8017``` 8018**Description** 8019 8020Obtains the index of the last child node of the target node in the tree without expanding any nodes. 8021 8022**Since**: 15 8023 8024**Parameters** 8025 8026| Name| Description| 8027| -------- | -------- | 8028| node | Pointer to the target node.| 8029| index | Pointer to a variable where the index of the last child node is stored.| 8030 8031**Returns** 8032 8033Returns 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. 8034 8035### OH_ArkUI_NodeUtils_GetChildWithExpandMode() 8036 8037``` 8038int32_t OH_ArkUI_NodeUtils_GetChildWithExpandMode(ArkUI_NodeHandle node, int32_t position, 8039 ArkUI_NodeHandle* subnode, uint32_t expandMode) 8040``` 8041**Description** 8042 8043Obtains a child node at the specified index using different expansion modes. 8044 8045**Since**: 15 8046 8047**Parameters** 8048 8049| Name| Description| 8050| -------- | -------- | 8051| node | Pointer to the target node.| 8052| position | Index of the child node to obtain.| 8053| subnode | Pointer to the obtained child node.| 8054| expandMode | Expansion mode for node traversal. For details, see **ArkUI_ExpandMode**.| 8055 8056**Returns** 8057 8058Returns 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. 8059 8060### OH_ArkUI_CustomSpanDrawInfo_GetLineBottom() 8061 8062``` 8063float OH_ArkUI_CustomSpanDrawInfo_GetLineBottom (ArkUI_CustomSpanDrawInfo * info) 8064``` 8065**Description** 8066 8067Obtains the bottom margin of the custom span relative to the mounted component. 8068 8069**Since**: 12 8070 8071**Parameters** 8072 8073| Name| Description| 8074| -------- | -------- | 8075| info | Pointer to the drawing information of a custom span. | 8076 8077**Returns** 8078 8079Returns the bottom margin. If a parameter error occurs, **0.0f** is returned. A possible cause is that mandatory parameters are left unspecified. 8080 8081 8082### OH_ArkUI_CustomSpanDrawInfo_GetLineTop() 8083 8084``` 8085float OH_ArkUI_CustomSpanDrawInfo_GetLineTop (ArkUI_CustomSpanDrawInfo * info) 8086``` 8087**Description** 8088 8089Obtains the top margin of the custom span relative to the mounted component. 8090 8091**Since**: 12 8092 8093**Parameters** 8094 8095| Name| Description| 8096| -------- | -------- | 8097| info | Pointer to the drawing information of a custom span. | 8098 8099**Returns** 8100 8101Returns the top margin. If a parameter error occurs, **0.0f** is returned. A possible cause is that mandatory parameters are left unspecified. 8102 8103 8104### OH_ArkUI_CustomSpanDrawInfo_GetXOffset() 8105 8106``` 8107float OH_ArkUI_CustomSpanDrawInfo_GetXOffset (ArkUI_CustomSpanDrawInfo * info) 8108``` 8109**Description** 8110 8111Obtains the x-axis offset of the custom span relative to the mounted component. 8112 8113**Since**: 12 8114 8115**Parameters** 8116 8117| Name| Description| 8118| -------- | -------- | 8119| info | Pointer to the drawing information of a custom span. | 8120 8121**Returns** 8122 8123Returns the x-axis offset. If a parameter error occurs, **0.0f** is returned. A possible cause is that mandatory parameters are left unspecified. 8124 8125 8126### OH_ArkUI_CustomSpanMeasureInfo_Create() 8127 8128``` 8129ArkUI_CustomSpanMeasureInfo* OH_ArkUI_CustomSpanMeasureInfo_Create (void ) 8130``` 8131**Description** 8132 8133Creates measurement information for this custom span. 8134 8135**Since**: 12 8136 8137**Returns** 8138 8139Returns a **CustomSpanMeasureInfo** instance. If a null pointer is returned, the memory may be insufficient. 8140 8141 8142### OH_ArkUI_CustomSpanMeasureInfo_Dispose() 8143 8144``` 8145void OH_ArkUI_CustomSpanMeasureInfo_Dispose (ArkUI_CustomSpanMeasureInfo * info) 8146``` 8147**Description** 8148 8149Disposes of measurement information of a custom span. 8150 8151**Since**: 12 8152 8153**Parameters** 8154 8155| Name| Description| 8156| -------- | -------- | 8157| info | Pointer to the measurement information of a custom span. | 8158 8159 8160### OH_ArkUI_CustomSpanMeasureInfo_GetFontSize() 8161 8162``` 8163float OH_ArkUI_CustomSpanMeasureInfo_GetFontSize (ArkUI_CustomSpanMeasureInfo * info) 8164``` 8165**Description** 8166 8167Obtains the font size of the parent text node of a custom span. 8168 8169**Since**: 12 8170 8171**Parameters** 8172 8173| Name| Description| 8174| -------- | -------- | 8175| info | Pointer to the measurement information of a custom span. | 8176 8177**Returns** 8178 8179Returns 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. 8180 8181 8182### OH_ArkUI_CustomSpanMetrics_Create() 8183 8184``` 8185ArkUI_CustomSpanMetrics* OH_ArkUI_CustomSpanMetrics_Create (void ) 8186``` 8187**Description** 8188 8189Creates measurement metrics for this custom span. 8190 8191**Since**: 12 8192 8193**Returns** 8194 8195Returns a **CustomSpanMetrics** instance. If a null pointer is returned, the memory may be insufficient. 8196 8197 8198### OH_ArkUI_CustomSpanMetrics_Dispose() 8199 8200``` 8201void OH_ArkUI_CustomSpanMetrics_Dispose (ArkUI_CustomSpanMetrics * metrics) 8202``` 8203**Description** 8204 8205Disposes of measurement metrics of this custom span. 8206 8207**Since**: 12 8208 8209**Parameters** 8210 8211| Name| Description| 8212| -------- | -------- | 8213| metrics | Returns a **CustomSpanMetrics** instance. | 8214 8215 8216### OH_ArkUI_CustomSpanMetrics_SetHeight() 8217 8218``` 8219int32_t OH_ArkUI_CustomSpanMetrics_SetHeight (ArkUI_CustomSpanMetrics * metrics, float height ) 8220``` 8221**Description** 8222 8223Sets the height for a custom span. 8224 8225**Since**: 12 8226 8227**Parameters** 8228 8229| Name| Description| 8230| -------- | -------- | 8231| metrics | Returns a **CustomSpanMetrics** instance. | 8232| height | Height, in vp. | 8233 8234**Returns** 8235 8236Returns **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. 8237 8238 8239### OH_ArkUI_CustomSpanMetrics_SetWidth() 8240 8241``` 8242int32_t OH_ArkUI_CustomSpanMetrics_SetWidth (ArkUI_CustomSpanMetrics * metrics, float width ) 8243``` 8244**Description** 8245 8246Sets the width for a custom span. 8247 8248**Since**: 12 8249 8250**Parameters** 8251 8252| Name| Description| 8253| -------- | -------- | 8254| metrics | Returns a **CustomSpanMetrics** instance. | 8255| width | Width, in vp. | 8256 8257**Returns** 8258 8259Returns **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. 8260 8261 8262### OH_ArkUI_DialogDismissEvent_GetDismissReason() 8263 8264``` 8265int32_t OH_ArkUI_DialogDismissEvent_GetDismissReason (ArkUI_DialogDismissEvent * event) 8266``` 8267**Description** 8268 8269Obtains the dismissal reason from a dialog box dismiss event object. 8270 8271**Since**: 12 8272 8273**Parameters** 8274 8275| Name| Description| 8276| -------- | -------- | 8277| event | Pointer to a dialog box dismiss event object.| 8278 8279**Returns** 8280 8281Returns 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. 8282 8283### OH_ArkUI_CustomDialog_OpenDialog() 8284 8285``` 8286int32_t OH_ArkUI_CustomDialog_OpenDialog(ArkUI_CustomDialogOptions* options, void (*callback)(int32_t dialogId)) 8287``` 8288**Description** 8289 8290Displays a custom dialog box. 8291 8292**Since**: 18 8293 8294**Parameters** 8295 8296| Name| Description| 8297| -------- | -------- | 8298| options | Dialog box parameters.| 8299| callback | Callback invoked when the dialog box is displayed. The parameter is the dialog box ID.| 8300 8301**Returns** 8302 8303Returns [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. 8304 8305### OH_ArkUI_CustomDialog_UpdateDialog() 8306 8307``` 8308int32_t OH_ArkUI_CustomDialog_UpdateDialog(ArkUI_CustomDialogOptions* options, void (*callback)(int32_t dialogId)) 8309``` 8310**Description** 8311 8312Updates a custom dialog box. 8313 8314**Since**: 18 8315 8316**Parameters** 8317 8318| Name| Description| 8319| -------- | -------- | 8320| options | Dialog box parameters.| 8321| callback | Callback invoked when the dialog box is updated. The parameter is the dialog box ID.| 8322 8323**Returns** 8324 8325Returns [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. 8326 8327### OH_ArkUI_CustomDialog_CloseDialog() 8328 8329``` 8330int32_t OH_ArkUI_CustomDialog_CloseDialog(int32_t dialogId) 8331``` 8332**Description** 8333 8334Closes a custom dialog box. 8335 8336**Since**: 18 8337 8338**Parameters** 8339 8340| Name| Description| 8341| -------- | -------- | 8342| dialogId | ID of the dialog box to close.| 8343 8344**Returns** 8345 8346Returns [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. 8347 8348### OH_ArkUI_CustomDialog_CreateOptions() 8349 8350``` 8351ArkUI_CustomDialogOptions* OH_ArkUI_CustomDialog_CreateOptions(ArkUI_NodeHandle content) 8352``` 8353**Description** 8354 8355Creates options for a custom dialog. 8356 8357**Since**: 18 8358 8359**Parameters** 8360 8361| Name| Description| 8362| -------- | -------- | 8363| content | Content of the custom dialog box.| 8364 8365**Returns** 8366 8367Returns the pointer to the custom dialog box options. 8368 8369### OH_ArkUI_CustomDialog_DisposeOptions() 8370 8371``` 8372void OH_ArkUI_CustomDialog_DisposeOptions(ArkUI_CustomDialogOptions* options) 8373``` 8374**Description** 8375 8376Destroys custom dialog box options. 8377 8378**Since**: 18 8379 8380**Parameters** 8381 8382| Name| Description| 8383| -------- | -------- | 8384| options | Pointer to the custom dialog box options.| 8385 8386 8387### OH_ArkUI_CustomDialog_SetLevelMode() 8388 8389``` 8390int32_t OH_ArkUI_CustomDialog_SetLevelMode(ArkUI_CustomDialogOptions* options, ArkUI_LevelMode levelMode) 8391``` 8392**Description** 8393 8394Sets the display level of a dialog box. 8395 8396**Since**: 16 8397 8398**Parameters** 8399 8400| Name| Description| 8401| -------- | -------- | 8402| options | Pointer to the custom dialog box options.| 8403| levelMode | Display level to set, specified by an enumeration value of **ArkUI_LevelMode**.| 8404 8405**NOTE** 8406 8407This method must be called before the **OH_ArkUI_CustomDialog_OpenDialog** method. 8408 8409**Returns** 8410 8411Returns [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. 8412 8413### OH_ArkUI_CustomDialog_SetLevelUniqueId() 8414 8415``` 8416int32_t OH_ArkUI_CustomDialog_SetLevelUniqueId(ArkUI_CustomDialogOptions* options, int32_t uniqueId) 8417``` 8418**Description** 8419 8420Sets the ID of the node under the dialog box's display level. 8421 8422**Since**: 16 8423 8424**Parameters** 8425 8426| Name| Description| 8427| -------- | -------- | 8428| options | Pointer to the custom dialog box options.| 8429| 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.| 8430 8431**NOTE** 8432 8433This method must be called before the **OH_ArkUI_CustomDialog_OpenDialog** method. 8434 8435**Returns** 8436 8437Returns [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. 8438 8439### OH_ArkUI_CustomDialog_SetImmersiveMode() 8440 8441``` 8442int32_t OH_ArkUI_CustomDialog_SetImmersiveMode(ArkUI_CustomDialogOptions* options, ArkUI_ImmersiveMode immersiveMode) 8443``` 8444**Description** 8445 8446Sets the display area of the embedded pop-up window mask. 8447 8448**Since**: 16 8449 8450**Parameters** 8451 8452| Name| Description| 8453| -------- | -------- | 8454| options | Pointer to the custom dialog box options.| 8455| immersiveMode | Display area, specified by an enumeration value of **ArkUI_ImmersiveMode**.| 8456 8457**NOTE** 8458 8459This method must be called before the **OH_ArkUI_CustomDialog_OpenDialog** method. 8460 8461**Returns** 8462 8463Returns [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. 8464 8465### OH_ArkUI_CustomDialog_SetBackgroundColor() 8466 8467``` 8468int32_t OH_ArkUI_CustomDialog_SetBackgroundColor(ArkUI_CustomDialogOptions* options, uint32_t backgroundColor) 8469``` 8470**Description** 8471 8472Sets the background color of a dialog box. 8473 8474**Since**: 18 8475 8476**Parameters** 8477 8478| Name| Description| 8479| -------- | -------- | 8480| options | Dialog box parameters.| 8481| backgroundColor | Background color of the dialog box.| 8482 8483**Returns** 8484 8485Returns [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. 8486 8487### OH_ArkUI_CustomDialog_SetCornerRadius() 8488 8489``` 8490int32_t OH_ArkUI_CustomDialog_SetCornerRadius( 8491 ArkUI_CustomDialogOptions* options, float topLeft, float topRight, float bottomLeft, float bottomRight) 8492``` 8493**Description** 8494 8495Sets the corner radius for a dialog box. 8496 8497**Since**: 18 8498 8499**Parameters** 8500 8501| Name| Description| 8502| -------- | -------- | 8503| options | Dialog box parameters.| 8504| topLeft | Radius of the upper left corner of the dialog box.| 8505| topRight | Radius of the upper right corner of the dialog box.| 8506| bottomLeft |Radius of the lower left corner of the dialog box.| 8507| bottomRight | Radius of the lower right corner of the dialog box.| 8508 8509**Returns** 8510 8511Returns [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. 8512 8513### OH_ArkUI_CustomDialog_SetBorderWidth() 8514 8515``` 8516int32_t OH_ArkUI_CustomDialog_SetBorderWidth( 8517 ArkUI_CustomDialogOptions* options, float top, float right, float bottom, float left, ArkUI_LengthMetricUnit unit) 8518``` 8519**Description** 8520 8521Sets the border width of a dialog box. 8522 8523**Since**: 18 8524 8525**Parameters** 8526 8527| Name| Description| 8528| -------- | -------- | 8529| options | Dialog box parameters.| 8530| top | Width of the top border of the dialog box.| 8531| right | Width of the right border of the dialog box.| 8532| bottom |Width of the bottom border of the dialog box.| 8533| left | Width of the left border of the dialog box.| 8534| unit | Unit of the width. The default value is vp.| 8535 8536**Returns** 8537 8538Returns [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. 8539 8540### OH_ArkUI_CustomDialog_SetBorderColor() 8541 8542``` 8543int32_t OH_ArkUI_CustomDialog_SetBorderColor( 8544 ArkUI_CustomDialogOptions* options, uint32_t top, uint32_t right, uint32_t bottom, uint32_t left) 8545``` 8546**Description** 8547 8548Sets the border color of the dialog box. 8549 8550**Since**: 18 8551 8552**Parameters** 8553 8554| Name| Description| 8555| -------- | -------- | 8556| options | Dialog box parameters.| 8557| top | Color of the top border of the dialog box.| 8558| right | Color of the right border of the dialog box.| 8559| bottom |Color of the bottom border of the dialog box.| 8560| left | Color of the left border of the dialog box.| 8561 8562**Returns** 8563 8564Returns [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. 8565 8566### OH_ArkUI_CustomDialog_SetBorderStyle() 8567 8568``` 8569int32_t OH_ArkUI_CustomDialog_SetBorderStyle( 8570 ArkUI_CustomDialogOptions* options, int32_t top, int32_t right, int32_t bottom, int32_t left) 8571``` 8572**Description** 8573 8574Sets the border style of a dialog box. 8575 8576**Since**: 18 8577 8578**Parameters** 8579 8580| Name| Description| 8581| -------- | -------- | 8582| options | Dialog box parameters.| 8583| top | Style of the top border of the dialog box.| 8584| right | Style of the right border of the dialog box.| 8585| bottom | Style of the bottom border of the dialog box.| 8586| left | Style of the left border of the dialog box.| 8587 8588**Returns** 8589 8590Returns [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. 8591 8592### OH_ArkUI_CustomDialog_SetWidth() 8593 8594``` 8595int32_t OH_ArkUI_CustomDialog_SetWidth(ArkUI_CustomDialogOptions* options, float width, ArkUI_LengthMetricUnit unit) 8596``` 8597**Description** 8598 8599Sets the width of the dialog box background. 8600 8601**Since**: 18 8602 8603**Parameters** 8604 8605| Name| Description| 8606| -------- | -------- | 8607| options | Dialog box parameters.| 8608| width | Width of the dialog box background.| 8609| unit | Unit of the width. The default value is vp.| 8610 8611**Returns** 8612 8613Returns [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. 8614 8615### OH_ArkUI_CustomDialog_SetHeight() 8616 8617``` 8618int32_t OH_ArkUI_CustomDialog_SetHeight(ArkUI_CustomDialogOptions* options, float height, ArkUI_LengthMetricUnit unit) 8619``` 8620**Description** 8621 8622Sets the height of the dialog box background. 8623 8624**Since**: 18 8625 8626**Parameters** 8627 8628| Name| Description| 8629| -------- | -------- | 8630| options | Dialog box parameters.| 8631| height | Height of the dialog box background.| 8632| unit | Unit of the height. The default value is vp.| 8633 8634**Returns** 8635 8636Returns [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. 8637 8638### OH_ArkUI_CustomDialog_SetShadow() 8639 8640``` 8641int32_t OH_ArkUI_CustomDialog_SetShadow(ArkUI_CustomDialogOptions* options, ArkUI_ShadowStyle shadow) 8642``` 8643**Description** 8644 8645Sets the shadow of the dialog box background. 8646 8647**Since**: 18 8648 8649**Parameters** 8650 8651| Name| Description| 8652| -------- | -------- | 8653| options | Dialog box parameters.| 8654| shadow | Shadow style of the background, specified by an enumerated value.| 8655 8656**Returns** 8657 8658Returns [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. 8659 8660### OH_ArkUI_CustomDialog_SetCustomShadow() 8661 8662``` 8663int32_t OH_ArkUI_CustomDialog_SetCustomShadow( 8664 ArkUI_CustomDialogOptions* options, const ArkUI_AttributeItem* customShadow) 8665``` 8666**Description** 8667 8668Sets the custom shadow of the dialog box background. 8669 8670**Since**: 18 8671 8672**Parameters** 8673 8674| Name| Description| 8675| -------- | -------- | 8676| options | Dialog box parameters.| 8677| customShadow | Custom shadow parameter. The format is the same as that of the **NODE_SHADOW** property.| 8678 8679**Returns** 8680 8681Returns [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. 8682 8683### OH_ArkUI_CustomDialog_SetBackgroundBlurStyle() 8684 8685``` 8686int32_t OH_ArkUI_CustomDialog_SetBackgroundBlurStyle(ArkUI_CustomDialogOptions* options, ArkUI_BlurStyle blurStyle) 8687``` 8688**Description** 8689 8690Sets the background blur style of the dialog box. 8691 8692**Since**: 18 8693 8694**Parameters** 8695 8696| Name| Description| 8697| -------- | -------- | 8698| options | Dialog box parameters.| 8699| blurStyle | Background blur style, specified by an enumerated value.| 8700 8701**Returns** 8702 8703Returns [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. 8704 8705### OH_ArkUI_CustomDialog_SetAlignment() 8706 8707``` 8708int32_t OH_ArkUI_CustomDialog_SetAlignment( 8709 ArkUI_CustomDialogOptions* options, int32_t alignment, float offsetX, float offsetY) 8710``` 8711**Description** 8712 8713Sets the alignment mode of a dialog box. 8714 8715**Since**: 18 8716 8717**Parameters** 8718 8719| Name| Description| 8720| -------- | -------- | 8721| options | Dialog box parameters.| 8722| alignment | Alignment mode of the dialog box. The parameter type is **ArkUI_Alignment**.| 8723| offsetX | Horizontal offset of the dialog box. The value is a floating point number.| 8724| offsetY | Vertical offset of the dialog box. The value is a floating point number.| 8725 8726**Returns** 8727 8728Returns [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. 8729 8730### OH_ArkUI_CustomDialog_SetModalMode() 8731 8732``` 8733int32_t OH_ArkUI_CustomDialog_SetModalMode(ArkUI_CustomDialogOptions* options, bool isModal) 8734``` 8735**Description** 8736 8737Sets the modal mode for a custom dialog box. 8738 8739**Since**: 18 8740 8741**Parameters** 8742 8743| Name| Description| 8744| -------- | -------- | 8745| options | Dialog box parameters.| 8746| 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.| 8747 8748**Returns** 8749 8750Returns [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. 8751 8752### OH_ArkUI_CustomDialog_SetAutoCancel() 8753 8754``` 8755int32_t OH_ArkUI_CustomDialog_SetAutoCancel(ArkUI_CustomDialogOptions* options, bool autoCancel) 8756``` 8757**Description** 8758 8759Specifies whether to allow users to touch the mask to dismiss the custom dialog box. 8760 8761**Since**: 18 8762 8763**Parameters** 8764 8765| Name| Description| 8766| -------- | -------- | 8767| options | Dialog box parameters.| 8768| 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.| 8769 8770**Returns** 8771 8772Returns [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. 8773 8774### OH_ArkUI_CustomDialog_SetSubwindowMode() 8775 8776``` 8777int32_t OH_ArkUI_CustomDialog_SetSubwindowMode(ArkUI_CustomDialogOptions* options, bool isShowInSubwindow) 8778``` 8779**Description** 8780 8781Sets whether to display the dialog box in a subwindow. 8782 8783**Since**: 18 8784 8785**Parameters** 8786 8787| Name| Description| 8788| -------- | -------- | 8789| options | Dialog box parameters.| 8790| 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.| 8791 8792**Returns** 8793 8794Returns [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. 8795 8796### OH_ArkUI_CustomDialog_SetMask() 8797 8798``` 8799int32_t OH_ArkUI_CustomDialog_SetMask( 8800 ArkUI_CustomDialogOptions* options, uint32_t maskColor, const ArkUI_Rect* maskRect) 8801``` 8802**Description** 8803 8804Sets the mask for a custom dialog box. 8805 8806**Since**: 18 8807 8808**Parameters** 8809 8810| Name| Description| 8811| -------- | -------- | 8812| options | Dialog box parameters.| 8813| maskColor | Mask color, in 0xargb format.| 8814| 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**.| 8815 8816**Returns** 8817 8818Returns [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. 8819 8820### OH_ArkUI_CustomDialog_SetKeyboardAvoidMode() 8821 8822``` 8823int32_t OH_ArkUI_CustomDialog_SetKeyboardAvoidMode( 8824 ArkUI_CustomDialogOptions* options, ArkUI_KeyboardAvoidMode keyboardAvoidMode) 8825``` 8826**Description** 8827 8828Sets the keyboard avoidance mode of a dialog box. 8829 8830**Since**: 18 8831 8832**Parameters** 8833 8834| Name| Description| 8835| -------- | -------- | 8836| options | Dialog box parameters.| 8837| keyboardAvoidMode | Keyboard avoidance mode, specified by an enumerated value.| 8838 8839**Returns** 8840 8841Returns [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. 8842 8843### OH_ArkUI_CustomDialog_SetHoverModeEnabled() 8844 8845``` 8846int32_t OH_ArkUI_CustomDialog_SetHoverModeEnabled(ArkUI_CustomDialogOptions* options, bool enabled) 8847``` 8848**Description** 8849 8850Sets whether to enable the hover mode for a dialog box. 8851 8852**Since**: 18 8853 8854**Parameters** 8855 8856| Name| Description| 8857| -------- | -------- | 8858| options | Dialog box parameters.| 8859| enabled | Whether to enable the hover mode. The default value is **false**.| 8860 8861**Returns** 8862 8863Returns [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. 8864 8865### OH_ArkUI_CustomDialog_SetHoverModeArea() 8866 8867``` 8868int32_t OH_ArkUI_CustomDialog_SetHoverModeArea( 8869 ArkUI_CustomDialogOptions* options, ArkUI_HoverModeAreaType hoverModeAreaType) 8870``` 8871**Description** 8872 8873Sets the default display area of a dialog box in hover mode. 8874 8875**Since**: 18 8876 8877**Parameters** 8878 8879| Name| Description| 8880| -------- | -------- | 8881| options | Dialog box parameters.| 8882| hoverModeAreaType | Display area in hover mode, specified by an enumerated value.| 8883 8884**Returns** 8885 8886Returns [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. 8887 8888### OH_ArkUI_CustomDialog_RegisterOnWillDismissCallback() 8889 8890``` 8891int32_t OH_ArkUI_CustomDialog_RegisterOnWillDismissCallback( 8892 ArkUI_CustomDialogOptions* options, void* userData, void (*callback)(ArkUI_DialogDismissEvent* event)) 8893``` 8894**Description** 8895 8896Registers a callback for the dismissal event of a custom dialog box. 8897 8898**Since**: 18 8899 8900**Parameters** 8901 8902| Name| Description| 8903| -------- | -------- | 8904| options | Dialog box parameters.| 8905| userData | Returns the pointer to user data.| 8906| callback | Callback for the dismissal event of the custom dialog box.| 8907 8908**Returns** 8909 8910Returns [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. 8911 8912### OH_ArkUI_CustomDialog_RegisterOnWillAppearCallback() 8913 8914``` 8915int32_t OH_ArkUI_CustomDialog_RegisterOnWillAppearCallback( 8916 ArkUI_CustomDialogOptions* options, void* userData, void (*callback)(void* userData)) 8917``` 8918**Description** 8919 8920Registers a callback to be invoked when the specified custom dialog box is about to appear. 8921 8922**Since**: 18 8923 8924**Parameters** 8925 8926| Name| Description| 8927| -------- | -------- | 8928| options | Dialog box parameters.| 8929| userData | Returns the pointer to user data.| 8930| callback | Event callback when the dialog box is about to appear.| 8931 8932**Returns** 8933 8934Returns [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. 8935 8936### OH_ArkUI_CustomDialog_RegisterOnDidAppearCallback() 8937 8938``` 8939int32_t OH_ArkUI_CustomDialog_RegisterOnDidAppearCallback( 8940 ArkUI_CustomDialogOptions* options, void* userData, void (*callback)(void* userData)) 8941``` 8942**Description** 8943 8944Registers a callback to be invoked when the specifiedcustom dialog box appears. 8945 8946**Since**: 18 8947 8948**Parameters** 8949 8950| Name| Description| 8951| -------- | -------- | 8952| options | Dialog box parameters.| 8953| userData | Returns the pointer to user data.| 8954| callback | Event callback when the dialog box appears.| 8955 8956**Returns** 8957 8958Returns [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. 8959 8960### OH_ArkUI_CustomDialog_RegisterOnWillDisappearCallback() 8961 8962``` 8963int32_t OH_ArkUI_CustomDialog_RegisterOnWillDisappearCallback( 8964 ArkUI_CustomDialogOptions* options, void* userData, void (*callback)(void* userData)) 8965``` 8966**Description** 8967 8968Registers a callback to be invoked when the specified custom dialog box is about to disappear. 8969 8970**Since**: 18 8971 8972**Parameters** 8973 8974| Name| Description| 8975| -------- | -------- | 8976| options | Dialog box parameters.| 8977| userData | Returns the pointer to user data.| 8978| callback | Event callback when the dialog box is about to disappear.| 8979 8980**Returns** 8981 8982Returns [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. 8983 8984### OH_ArkUI_CustomDialog_RegisterOnDidDisappearCallback() 8985 8986``` 8987int32_t OH_ArkUI_CustomDialog_RegisterOnDidDisappearCallback( 8988 ArkUI_CustomDialogOptions* options, void* userData, void (*callback)(void* userData)) 8989``` 8990**Description** 8991 8992* @brief Registers a callback to be invoked when the specified custom dialog box disappears. 8993 8994**Since**: 18 8995 8996**Parameters** 8997 8998| Name| Description| 8999| -------- | -------- | 9000| options | Dialog box parameters.| 9001| userData | Returns the pointer to user data.| 9002| callback | Event callback when the dialog box disappears.| 9003 9004**Returns** 9005 9006Returns [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. 9007 9008### OH_ArkUI_DialogDismissEvent_GetUserData() 9009 9010``` 9011void* OH_ArkUI_DialogDismissEvent_GetUserData (ArkUI_DialogDismissEvent * event) 9012``` 9013**Description** 9014 9015Obtains the pointer to user data in a dialog box dismiss event object. 9016 9017**Since**: 12 9018 9019**Parameters** 9020 9021| Name| Description| 9022| -------- | -------- | 9023| event | Pointer to a dialog box dismiss event object.| 9024 9025**Returns** 9026 9027Returns the pointer to user data. 9028 9029 9030### OH_ArkUI_DialogDismissEvent_SetShouldBlockDismiss() 9031 9032``` 9033void OH_ArkUI_DialogDismissEvent_SetShouldBlockDismiss (ArkUI_DialogDismissEvent * event, bool shouldBlockDismiss ) 9034``` 9035**Description** 9036 9037Sets whether to block the system behavior of dismissing a dialog box. 9038 9039**Since**: 12 9040 9041**Parameters** 9042 9043| Name| Description| 9044| -------- | -------- | 9045| event | Pointer to a dialog box dismiss event object. | 9046| 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. | 9047 9048 9049### OH_ArkUI_DisallowNodeAnyDropDataTypes() 9050 9051``` 9052int32_t OH_ArkUI_DisallowNodeAnyDropDataTypes (ArkUI_NodeHandle node) 9053``` 9054**Description** 9055 9056The configuration component is not allowed to accept any data type. This interface resets the data type configured through [OH_ArkUI_SetNodeAllowedDropDataTypes](#oh_arkui_setnodealloweddropdatatypes). 9057 9058**Since**: 12 9059 9060**Parameters** 9061 9062| Name| Description| 9063| -------- | -------- | 9064| node | Pointer to a component node. | 9065 9066**Returns** 9067 9068Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9069 9070 9071### OH_ArkUI_DragAction_Dispose() 9072 9073``` 9074void OH_ArkUI_DragAction_Dispose (ArkUI_DragAction * dragAction) 9075``` 9076**Description** 9077 9078Disposes of an **ArkUI_DragAction** object. 9079 9080**Since**: 12 9081 9082**Parameters** 9083 9084| Name| Description| 9085| -------- | -------- | 9086| dragAction | Pointer to the target drag action object. | 9087 9088 9089### OH_ArkUI_DragAction_RegisterStatusListener() 9090 9091``` 9092int32_t OH_ArkUI_DragAction_RegisterStatusListener (ArkUI_DragAction * dragAction, void * userData, void(*)(ArkUI_DragAndDropInfo *dragAndDropInfo, void *userData) listener ) 9093``` 9094**Description** 9095 9096Registers a drag status listener. This listener can be used to check whether the data is successfully received and processed. 9097 9098**Since**: 12 9099 9100**Parameters** 9101 9102| Name| Description| 9103| -------- | -------- | 9104| dragAction | Pointer to the target drag action object. | 9105| userData | Custom user data. | 9106| 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. | 9107 9108**Returns** 9109 9110Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9111 9112 9113### OH_ArkUI_DragAction_SetData() 9114 9115``` 9116int32_t OH_ArkUI_DragAction_SetData (ArkUI_DragAction * dragAction, OH_UdmfData * data ) 9117``` 9118**Description** 9119 9120Sets the drag data. 9121 9122**Since**: 12 9123 9124**Parameters** 9125 9126| Name| Description| 9127| -------- | -------- | 9128| dragAction | Pointer to the target drag action object. | 9129| data | Drag data. | 9130 9131**Returns** 9132 9133Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9134 9135 9136### OH_ArkUI_DragAction_SetDragPreviewOption() 9137 9138``` 9139int32_t OH_ArkUI_DragAction_SetDragPreviewOption (ArkUI_DragAction * dragAction, ArkUI_DragPreviewOption * option ) 9140``` 9141**Description** 9142 9143Sets an **ArkUI_DragPreviewOption** object for the specified drag action object. 9144 9145**Since**: 12 9146 9147**Parameters** 9148 9149| Name| Description| 9150| -------- | -------- | 9151| dragAction | Pointer to the target drag action object. | 9152| option | Custom parameters. | 9153 9154**Returns** 9155 9156Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9157 9158 9159### OH_ArkUI_DragAction_SetPixelMaps() 9160 9161``` 9162int32_t OH_ArkUI_DragAction_SetPixelMaps (ArkUI_DragAction * dragAction, OH_PixelmapNative * pixelmapArray[], int32_t size ) 9163``` 9164**Description** 9165 9166Sets the drag previews for a drag action. 9167 9168**Since**: 12 9169 9170**Parameters** 9171 9172| Name| Description| 9173| -------- | -------- | 9174| dragAction | Pointer to the target drag action object. | 9175| pixelmapArray | Drag the bitmap array of the follower map. | 9176| size | Number of drag-and-drop images. | 9177 9178**Returns** 9179 9180Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9181 9182 9183### OH_ArkUI_DragAction_SetPointerId() 9184 9185``` 9186int32_t OH_ArkUI_DragAction_SetPointerId (ArkUI_DragAction * dragAction, int32_t pointer ) 9187``` 9188**Description** 9189 9190Sets 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. 9191 9192**Since**: 12 9193 9194**Parameters** 9195 9196| Name| Description| 9197| -------- | -------- | 9198| dragAction | Pointer to the target drag action object. | 9199| pointer | Pointer ID. The value ranges from 0 to 9. | 9200 9201**Returns** 9202 9203Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9204 9205 9206### OH_ArkUI_DragAction_SetTouchPointX() 9207 9208``` 9209int32_t OH_ArkUI_DragAction_SetTouchPointX (ArkUI_DragAction * dragAction, float x ) 9210``` 9211**Description** 9212 9213Sets the touch point relative to the upper left corner of the first drag preview (pixel map). 9214 9215**Since**: 12 9216 9217**Parameters** 9218 9219| Name| Description| 9220| -------- | -------- | 9221| dragAction | Pointer to the target drag action object. | 9222| x | X value of the hand point coordinate. | 9223 9224**Returns** 9225 9226Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9227 9228 9229### OH_ArkUI_DragAction_SetTouchPointY() 9230 9231``` 9232int32_t OH_ArkUI_DragAction_SetTouchPointY (ArkUI_DragAction * dragAction, float y ) 9233``` 9234**Description** 9235 9236Sets the touch point relative to the upper left corner of the first drag preview (pixel map). 9237 9238**Since**: 12 9239 9240**Parameters** 9241 9242| Name| Description| 9243| -------- | -------- | 9244| dragAction | Pointer to the target drag action object. | 9245| y | Y value of the hand point coordinate. | 9246 9247**Returns** 9248 9249Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9250 9251 9252### OH_ArkUI_DragAction_UnregisterStatusListener() 9253 9254``` 9255void OH_ArkUI_DragAction_UnregisterStatusListener (ArkUI_DragAction * dragAction) 9256``` 9257**Description** 9258 9259Unregisters a drag status listener. 9260 9261**Since**: 12 9262 9263**Parameters** 9264 9265| Name| Description| 9266| -------- | -------- | 9267| dragAction | Pointer to the target drag action object. | 9268 9269 9270### OH_ArkUI_DragAndDropInfo_GetDragEvent() 9271 9272``` 9273ArkUI_DragEvent* OH_ArkUI_DragAndDropInfo_GetDragEvent (ArkUI_DragAndDropInfo * dragAndDropInfo) 9274``` 9275**Description** 9276 9277Obtains a drag event based on the specified drag and drop information. The drag event can then be used to obtain the drag result. 9278 9279**Since**: 12 9280 9281**Parameters** 9282 9283| Name| Description| 9284| -------- | -------- | 9285| dragAndDropInfo | Drag-related information returned by the drag status listener. | 9286 9287**Returns** 9288 9289Returns an **ArkUI_DragEvent** object; returns null if an error occurs. 9290 9291 9292### OH_ArkUI_DragAndDropInfo_GetDragStatus() 9293 9294``` 9295ArkUI_DragStatus OH_ArkUI_DragAndDropInfo_GetDragStatus (ArkUI_DragAndDropInfo * dragAndDropInfo) 9296``` 9297**Description** 9298 9299Obtains the drag status of a drag action. 9300 9301**Since**: 12 9302 9303**Parameters** 9304 9305| Name| Description| 9306| -------- | -------- | 9307| dragAndDropInfo | Drag-related information returned by the drag status listener. | 9308 9309**Returns** 9310 9311Returns an **ArkUI_DragStatus** object; returns **ArkUI_DRAG_STATUS_UNKNOWN** if an error occurs. 9312 9313 9314### OH_ArkUI_DragEvent_DisableDefaultDropAnimation() 9315 9316``` 9317int32_t OH_ArkUI_DragEvent_DisableDefaultDropAnimation (ArkUI_DragEvent * event, bool disable ) 9318``` 9319**Description** 9320 9321Sets whether to disable the default drop animation, which is enabled by default. Use this API to apply a custom drop animation. 9322 9323**Since**: 12 9324 9325**Parameters** 9326 9327| Name| Description| 9328| -------- | -------- | 9329| event | Pointer to an **ArkUI_DragEvent** object. | 9330| disable | Whether to disable the default drop animation. The value **true** means to disable the default drop animation, and **false** means the opposite. | 9331 9332**Returns** 9333 9334Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9335 9336 9337### OH_ArkUI_DragEvent_GetDataTypes() 9338 9339``` 9340int32_t OH_ArkUI_DragEvent_GetDataTypes (ArkUI_DragEvent * event, char * eventTypeArray[], int32_t length, int32_t maxStrLen) 9341``` 9342**Description** 9343 9344Obtains the type list of drag data types from a drag event. 9345 9346**Since**: 12 9347 9348**Parameters** 9349 9350| Name| Description| 9351| -------- | -------- | 9352| event | Pointer to an **ArkUI_DragEvent** object. | 9353| char | List of the drag data types. You need to create a string array first. | 9354| length | Total length of the array, which cannot be less than the number obtained using [OH_ArkUI_DragEvent_GetDataTypeCount](#oh_arkui_dragevent_getdatatypecount). | 9355| maxStrLen | Maximum length of each data type string. | 9356 9357**Returns** 9358 9359Returns **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. 9360 9361 9362### OH_ArkUI_DragEvent_GetDataTypeCount() 9363 9364``` 9365int32_t OH_ArkUI_DragEvent_GetDataTypeCount (ArkUI_DragEvent * event, int32_t * count ) 9366``` 9367**Description** 9368 9369Obtains the number of drag data types from a drag event. 9370 9371**Since**: 12 9372 9373**Parameters** 9374 9375| Name| Description| 9376| -------- | -------- | 9377| event | Pointer to an **ArkUI_DragEvent** object. | 9378| count | Number of drag data types returned. | 9379 9380**Returns** 9381 9382Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9383 9384 9385### OH_ArkUI_DragEvent_GetDragResult() 9386 9387``` 9388int32_t OH_ArkUI_DragEvent_GetDragResult (ArkUI_DragEvent * event, ArkUI_DragResult * result ) 9389``` 9390**Description** 9391 9392Obtains the drag and drop result from the drag event. 9393 9394**Since**: 12 9395 9396**Parameters** 9397 9398| Name| Description| 9399| -------- | -------- | 9400| event | Pointer to an **ArkUI_DragEvent** object. | 9401| result | Drag result returned. | 9402 9403**Returns** 9404 9405Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9406 9407 9408### OH_ArkUI_DragEvent_GetDropOperation() 9409 9410``` 9411int32_t OH_ArkUI_DragEvent_GetDropOperation (ArkUI_DragEvent * event, ArkUI_DropOperation * operation) 9412``` 9413**Description** 9414 9415Obtains the data handling method from the drag event. 9416 9417**Since**: 12 9418 9419**Parameters** 9420 9421| Name| Description| 9422| -------- | -------- | 9423| event | Pointer to an **ArkUI_DragEvent** object. | 9424| operation | Data handling method returned. | 9425 9426**Returns** 9427 9428Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9429 9430 9431### OH_ArkUI_DragEvent_GetModifierKeyStates() 9432 9433``` 9434int32_t OH_ArkUI_DragEvent_GetModifierKeyStates (ArkUI_DragEvent * event, uint64_t * keys ) 9435``` 9436**Description** 9437 9438Obtains the pressed status of modifier keys from a drag event. 9439 9440**Since**: 12 9441 9442**Parameters** 9443 9444| Name| Description| 9445| -------- | -------- | 9446| event | Pointer to an **ArkUI_DragEvent** object. | 9447| keys | Returns the modifier key combination that is currently pressed. The application can determine the modifier key combination through bitwise operations. | 9448 9449**Returns** 9450 9451Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9452 9453 9454### OH_ArkUI_DragEvent_GetPreviewRectHeight() 9455 9456``` 9457float OH_ArkUI_DragEvent_GetPreviewRectHeight (ArkUI_DragEvent * event) 9458``` 9459**Description** 9460 9461Obtains the height of a drag preview from a drag event. 9462 9463**Since**: 12 9464 9465**Parameters** 9466 9467| Name| Description| 9468| -------- | -------- | 9469| event | Pointer to an **ArkUI_DragEvent** object. | 9470 9471**Returns** 9472 9473Returns the height of the drag preview, in px; returns the default value **0** if the input parameter is invalid. 9474 9475 9476### OH_ArkUI_DragEvent_GetPreviewRectWidth() 9477 9478``` 9479float OH_ArkUI_DragEvent_GetPreviewRectWidth (ArkUI_DragEvent * event) 9480``` 9481**Description** 9482 9483Obtains the width of a drag preview from a drag event. 9484 9485**Since**: 12 9486 9487**Parameters** 9488 9489| Name| Description| 9490| -------- | -------- | 9491| event | Pointer to an **ArkUI_DragEvent** object. | 9492 9493**Returns** 9494 9495Returns the width of the drag preview, in px; returns the default value **0** if the input parameter is invalid. 9496 9497 9498### OH_ArkUI_DragEvent_GetPreviewTouchPointX() 9499 9500``` 9501float OH_ArkUI_DragEvent_GetPreviewTouchPointX (ArkUI_DragEvent * event) 9502``` 9503**Description** 9504 9505Obtains the X coordinate of the touch point for a drag preview from a drag event. 9506 9507**Since**: 12 9508 9509**Parameters** 9510 9511| Name| Description| 9512| -------- | -------- | 9513| event | Pointer to an **ArkUI_DragEvent** object. | 9514 9515**Returns** 9516 9517Returns the X coordinate of the touch point, in px; returns the default value **0** if the input parameter is invalid. 9518 9519 9520### OH_ArkUI_DragEvent_GetPreviewTouchPointY() 9521 9522``` 9523float OH_ArkUI_DragEvent_GetPreviewTouchPointY (ArkUI_DragEvent * event) 9524``` 9525**Description** 9526 9527Obtains the Y coordinate of the touch point for a drag preview from a drag event. 9528 9529**Since**: 12 9530 9531**Parameters** 9532 9533| Name| Description| 9534| -------- | -------- | 9535| event | Pointer to an **ArkUI_DragEvent** object. | 9536 9537**Returns** 9538 9539Returns the Y coordinate of the touch point, in px; returns the default value **0** if the input parameter is invalid. 9540 9541 9542### OH_ArkUI_DragEvent_GetTouchPointXToDisplay() 9543 9544``` 9545float OH_ArkUI_DragEvent_GetTouchPointXToDisplay (ArkUI_DragEvent * event) 9546``` 9547**Description** 9548 9549Obtains the X coordinate of the touch point relative to the display from a drag event. 9550 9551**Since**: 12 9552 9553**Parameters** 9554 9555| Name| Description| 9556| -------- | -------- | 9557| event | Pointer to an **ArkUI_DragEvent** object. | 9558 9559**Returns** 9560 9561Returns the X coordinate of the touch point relative to the display, in px; returns the default value **0** if the input parameter is invalid. 9562 9563 9564### OH_ArkUI_DragEvent_GetTouchPointXToWindow() 9565 9566``` 9567float OH_ArkUI_DragEvent_GetTouchPointXToWindow (ArkUI_DragEvent * event) 9568``` 9569**Description** 9570 9571Obtains the X coordinate of the touch point relative to the window from a drag event. 9572 9573**Since**: 12 9574 9575**Parameters** 9576 9577| Name| Description| 9578| -------- | -------- | 9579| event | Pointer to an **ArkUI_DragEvent** object. | 9580 9581**Returns** 9582 9583Returns the X coordinate of the touch point relative to the window, in px; returns the default value **0** if the input parameter is invalid. 9584 9585 9586### OH_ArkUI_DragEvent_GetTouchPointYToDisplay() 9587 9588``` 9589float OH_ArkUI_DragEvent_GetTouchPointYToDisplay (ArkUI_DragEvent * event) 9590``` 9591**Description** 9592 9593Obtains the Y coordinate of the touch point relative to the display from a drag event. 9594 9595**Since**: 12 9596 9597**Parameters** 9598 9599| Name| Description| 9600| -------- | -------- | 9601| event | Pointer to an **ArkUI_DragEvent** object. | 9602 9603**Returns** 9604 9605Returns the Y coordinate of the touch point relative to the display, in px; returns the default value **0** if the input parameter is invalid. 9606 9607 9608### OH_ArkUI_DragEvent_GetTouchPointYToWindow() 9609 9610``` 9611float OH_ArkUI_DragEvent_GetTouchPointYToWindow (ArkUI_DragEvent * event) 9612``` 9613**Description** 9614 9615Obtains the Y coordinate of the touch point relative to the window from a drag event. 9616 9617**Since**: 12 9618 9619**Parameters** 9620 9621| Name| Description| 9622| -------- | -------- | 9623| event | Pointer to an **ArkUI_DragEvent** object. | 9624 9625**Returns** 9626 9627Returns the Y coordinate of the touch point relative to the window, in px; returns the default value **0** if the input parameter is invalid. 9628 9629 9630### OH_ArkUI_DragEvent_GetUdmfData() 9631 9632``` 9633int32_t OH_ArkUI_DragEvent_GetUdmfData (ArkUI_DragEvent * event, OH_UdmfData * data ) 9634``` 9635**Description** 9636 9637Obtain the default drag-and-drop data from ArkUI_DragEvent. 9638 9639**Since**: 12 9640 9641**Parameters** 9642 9643| Name| Description| 9644| -------- | -------- | 9645| event | Pointer to an **ArkUI_DragEvent** object. | 9646| 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. | 9647 9648**Returns** 9649 9650Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9651 9652 9653### OH_ArkUI_DragEvent_GetVelocity() 9654 9655``` 9656float OH_ArkUI_DragEvent_GetVelocity (ArkUI_DragEvent * event) 9657``` 9658**Description** 9659 9660Obtains the dragging velocity along the main axis. 9661 9662**Since**: 12 9663 9664**Parameters** 9665 9666| Name| Description| 9667| -------- | -------- | 9668| event | Pointer to an **ArkUI_DragEvent** object. | 9669 9670**Returns** 9671 9672Returns the dragging velocity along the main axis, in px; returns the default value **0** if the input parameter is invalid. 9673 9674 9675### OH_ArkUI_DragEvent_GetVelocityX() 9676 9677``` 9678float OH_ArkUI_DragEvent_GetVelocityX (ArkUI_DragEvent * event) 9679``` 9680**Description** 9681 9682Obtains the dragging velocity along the x-axis. 9683 9684**Since**: 12 9685 9686**Parameters** 9687 9688| Name| Description| 9689| -------- | -------- | 9690| event | Pointer to an **ArkUI_DragEvent** object. | 9691 9692**Returns** 9693 9694Returns the dragging velocity along the x-axis, in px; returns the default value **0** if the input parameter is invalid. 9695 9696 9697### OH_ArkUI_DragEvent_GetVelocityY() 9698 9699``` 9700float OH_ArkUI_DragEvent_GetVelocityY (ArkUI_DragEvent * event) 9701``` 9702**Description** 9703 9704Obtains the dragging velocity along the y-axis. 9705 9706**Since**: 12 9707 9708**Parameters** 9709 9710| Name| Description| 9711| -------- | -------- | 9712| event | Pointer to an **ArkUI_DragEvent** object. | 9713 9714**Returns** 9715 9716Returns the dragging velocity along the y-axis, in px; returns the default value **0** if the input parameter is invalid. 9717 9718 9719### OH_ArkUI_DragEvent_SetData() 9720 9721``` 9722int32_t OH_ArkUI_DragEvent_SetData (ArkUI_DragEvent * event, OH_UdmfData * data ) 9723``` 9724**Description** 9725 9726Sets drag data for a drag event. 9727 9728**Since**: 12 9729 9730**Parameters** 9731 9732| Name| Description| 9733| -------- | -------- | 9734| event | Pointer to an **ArkUI_DragEvent** object. | 9735| data | Drag data. | 9736 9737**Returns** 9738 9739Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9740 9741 9742### OH_ArkUI_DragEvent_SetDragResult() 9743 9744``` 9745int32_t OH_ArkUI_DragEvent_SetDragResult (ArkUI_DragEvent * event, ArkUI_DragResult result ) 9746``` 9747**Description** 9748 9749Sets the result for a drag event. 9750 9751**Since**: 12 9752 9753**Parameters** 9754 9755| Name| Description| 9756| -------- | -------- | 9757| event | Pointer to an **ArkUI_DragEvent** object. | 9758| result | Drag the data processing result. | 9759 9760**Returns** 9761 9762Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9763 9764 9765### OH_ArkUI_DragEvent_SetSuggestedDropOperation() 9766 9767``` 9768int32_t OH_ArkUI_DragEvent_SetSuggestedDropOperation (ArkUI_DragEvent * event, ArkUI_DropOperation dropOperation) 9769``` 9770**Description** 9771 9772Sets the data processing mode. 9773 9774**Since**: 12 9775 9776**Parameters** 9777 9778| Name| Description| 9779| -------- | -------- | 9780| proposal | Recommended data processing mode | 9781| proposal | Type of the badge display status. | 9782 9783**Returns** 9784 9785Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9786 9787 9788### OH_ArkUI_DragPreviewOption_Dispose() 9789 9790``` 9791void OH_ArkUI_DragPreviewOption_Dispose (ArkUI_DragPreviewOption * option) 9792``` 9793**Description** 9794 9795Disposes of an **ArkUI_DragPreviewOption** object. 9796 9797**Since**: 12 9798 9799**Parameters** 9800 9801| Name| Description| 9802| -------- | -------- | 9803| option | Custom parameters. | 9804 9805 9806### OH_ArkUI_DragPreviewOption_SetBadgeNumber() 9807 9808``` 9809int32_t OH_ArkUI_DragPreviewOption_SetBadgeNumber (ArkUI_DragPreviewOption * option, uint32_t forcedNumber ) 9810``` 9811**Description** 9812 9813Sets the count on the badge. The settings will overwrite the value in the **SetDragPreviewNumberBadgeEnabled** API. 9814 9815**Since**: 12 9816 9817**Parameters** 9818 9819| Name| Description| 9820| -------- | -------- | 9821| option | Custom parameters. | 9822| forcedNumber | Number of corner marks. | 9823 9824**Returns** 9825 9826Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9827 9828 9829### OH_ArkUI_DragPreviewOption_SetDefaultAnimationBeforeLiftingEnabled() 9830 9831``` 9832int32_t OH_ArkUI_DragPreviewOption_SetDefaultAnimationBeforeLiftingEnabled (ArkUI_DragPreviewOption * option, bool enabled ) 9833``` 9834**Description** 9835 9836Sets whether to enable the default animation on a click or touch. 9837 9838**Since**: 12 9839 9840**Parameters** 9841 9842| Name| Description| 9843| -------- | -------- | 9844| option | Custom parameters. | 9845| enabled | Whether to enable the default click effect. | 9846 9847**Returns** 9848 9849Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9850 9851 9852### OH_ArkUI_DragPreviewOption_SetDefaultRadiusEnabled() 9853 9854``` 9855int32_t OH_ArkUI_DragPreviewOption_SetDefaultRadiusEnabled (ArkUI_DragPreviewOption * option, bool enabled ) 9856``` 9857**Description** 9858 9859Sets whether to enable the default corner radius effect for an **ArkUI_DragPreviewOption** object. The effect is disabled by default. 9860 9861**Since**: 12 9862 9863**Parameters** 9864 9865| Name| Description| 9866| -------- | -------- | 9867| option | Custom parameters. | 9868| enabled | Whether to enable the default corner radius effect. | 9869 9870**Returns** 9871 9872Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9873 9874 9875### OH_ArkUI_DragPreviewOption_SetDefaultShadowEnabled() 9876 9877``` 9878int32_t OH_ArkUI_DragPreviewOption_SetDefaultShadowEnabled (ArkUI_DragPreviewOption * option, bool enabled ) 9879``` 9880**Description** 9881 9882Sets whether to enable the default shadow effect for an **ArkUI_DragPreviewOption** object. The effect is disabled by default. 9883 9884**Since**: 12 9885 9886**Parameters** 9887 9888| Name| Description| 9889| -------- | -------- | 9890| option | Custom parameters. | 9891| enabled | Whether to enable the default shadow effect. | 9892 9893**Returns** 9894 9895Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9896 9897 9898### OH_ArkUI_DragPreviewOption_SetNumberBadgeEnabled() 9899 9900``` 9901int32_t OH_ArkUI_DragPreviewOption_SetNumberBadgeEnabled (ArkUI_DragPreviewOption * option, bool enabled ) 9902``` 9903**Description** 9904 9905Sets 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. 9906 9907**Since**: 12 9908 9909**Parameters** 9910 9911| Name| Description| 9912| -------- | -------- | 9913| option | Custom parameters. | 9914| enabled | Whether to enable the badge. | 9915 9916**Returns** 9917 9918Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9919 9920 9921### OH_ArkUI_DragPreviewOption_SetScaleMode() 9922 9923``` 9924int32_t OH_ArkUI_DragPreviewOption_SetScaleMode (ArkUI_DragPreviewOption * option, ArkUI_DragPreviewScaleMode scaleMode ) 9925``` 9926**Description** 9927 9928Sets the scale mode for an **ArkUI_DragPreviewOption** object. 9929 9930**Since**: 12 9931 9932**Parameters** 9933 9934| Name| Description| 9935| -------- | -------- | 9936| option | Custom parameters. | 9937| scaleMode | Scale mode to set. | 9938 9939**Returns** 9940 9941Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9942 9943 9944### OH_ArkUI_DrawableDescriptor_CreateFromAnimatedPixelMap() 9945 9946``` 9947ArkUI_DrawableDescriptor* OH_ArkUI_DrawableDescriptor_CreateFromAnimatedPixelMap (OH_PixelmapNativeHandle * array, int32_t size ) 9948``` 9949**Description** 9950 9951Creates a **DrawableDescriptor** object from an array of **PixelMap** objects. 9952 9953**Since**: 12 9954 9955**Parameters** 9956 9957| Name| Description| 9958| -------- | -------- | 9959| array | Pointer to the array of **PixelMap** objects. | 9960| size | Size of the **PixelMap** object array. | 9961 9962**Returns** 9963 9964Returns the pointer to the created **DrawableDescriptor** object. 9965 9966 9967### OH_ArkUI_DrawableDescriptor_CreateFromPixelMap() 9968 9969``` 9970ArkUI_DrawableDescriptor* OH_ArkUI_DrawableDescriptor_CreateFromPixelMap (OH_PixelmapNativeHandle pixelMap) 9971``` 9972**Description** 9973 9974Creates a **DrawableDescriptor** object from a **PixelMap** object. 9975 9976**Since**: 12 9977 9978**Parameters** 9979 9980| Name| Description| 9981| -------- | -------- | 9982| pixelMap | Pointer to the **PixelMap** object. | 9983 9984**Returns** 9985 9986Returns the pointer to the created **DrawableDescriptor** object. 9987 9988 9989### OH_ArkUI_DrawableDescriptor_Dispose() 9990 9991``` 9992void OH_ArkUI_DrawableDescriptor_Dispose (ArkUI_DrawableDescriptor * drawableDescriptor) 9993``` 9994**Description** 9995 9996Disposes of the pointer to a **DrawableDescriptor** object. 9997 9998**Since**: 12 9999 10000**Parameters** 10001 10002| Name| Description| 10003| -------- | -------- | 10004| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 10005 10006 10007### OH_ArkUI_DrawableDescriptor_GetAnimatedPixelMapArray() 10008 10009``` 10010OH_PixelmapNativeHandle* OH_ArkUI_DrawableDescriptor_GetAnimatedPixelMapArray (ArkUI_DrawableDescriptor * drawableDescriptor) 10011``` 10012**Description** 10013 10014Obtains an array of **PixelMap** objects for playing an animation. 10015 10016**Since**: 12 10017 10018**Parameters** 10019 10020| Name| Description| 10021| -------- | -------- | 10022| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 10023 10024**Returns** 10025 10026Pointer to the PixelMap image array. 10027 10028 10029### OH_ArkUI_DrawableDescriptor_GetAnimatedPixelMapArraySize() 10030 10031``` 10032int32_t OH_ArkUI_DrawableDescriptor_GetAnimatedPixelMapArraySize (ArkUI_DrawableDescriptor * drawableDescriptor) 10033``` 10034**Description** 10035 10036Obtains an array of **PixelMap** objects for playing an animation. 10037 10038**Since**: 12 10039 10040**Parameters** 10041 10042| Name| Description| 10043| -------- | -------- | 10044| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 10045 10046**Returns** 10047 10048Size of the PixelMap image array. 10049 10050 10051### OH_ArkUI_DrawableDescriptor_GetAnimationDuration() 10052 10053``` 10054int32_t OH_ArkUI_DrawableDescriptor_GetAnimationDuration (ArkUI_DrawableDescriptor * drawableDescriptor) 10055``` 10056**Description** 10057 10058Obtains the total playback duration of a PixelMap image array. 10059 10060**Since**: 12 10061 10062**Parameters** 10063 10064| Name| Description| 10065| -------- | -------- | 10066| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 10067 10068**Returns** 10069 10070Total playback duration, in milliseconds. 10071 10072 10073### OH_ArkUI_DrawableDescriptor_GetAnimationIteration() 10074 10075``` 10076int32_t OH_ArkUI_DrawableDescriptor_GetAnimationIteration (ArkUI_DrawableDescriptor * drawableDescriptor) 10077``` 10078**Description** 10079 10080Obtains the number of times that a **PixelMap** object array is played. 10081 10082**Since**: 12 10083 10084**Parameters** 10085 10086| Name| Description| 10087| -------- | -------- | 10088| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 10089 10090**Returns** 10091 10092Returns the number of playback times. 10093 10094 10095### OH_ArkUI_DrawableDescriptor_GetStaticPixelMap() 10096 10097``` 10098OH_PixelmapNativeHandle OH_ArkUI_DrawableDescriptor_GetStaticPixelMap (ArkUI_DrawableDescriptor * drawableDescriptor) 10099``` 10100**Description** 10101 10102Obtains the pointer to a **PixelMap** object. 10103 10104**Since**: 12 10105 10106**Parameters** 10107 10108| Name| Description| 10109| -------- | -------- | 10110| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 10111 10112**Returns** 10113 10114Pointer to the PixelMap object. 10115 10116 10117### OH_ArkUI_DrawableDescriptor_SetAnimationDuration() 10118 10119``` 10120void OH_ArkUI_DrawableDescriptor_SetAnimationDuration (ArkUI_DrawableDescriptor * drawableDescriptor, int32_t duration ) 10121``` 10122**Description** 10123 10124Sets the total playback duration of a PixelMap image array. 10125 10126**Since**: 12 10127 10128**Parameters** 10129 10130| Name| Description| 10131| -------- | -------- | 10132| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 10133| duration | Total playback duration, in milliseconds. | 10134 10135 10136### OH_ArkUI_DrawableDescriptor_SetAnimationIteration() 10137 10138``` 10139void OH_ArkUI_DrawableDescriptor_SetAnimationIteration (ArkUI_DrawableDescriptor * drawableDescriptor, int32_t iteration ) 10140``` 10141**Description** 10142 10143Sets the number of times that a pixel map image array is played. 10144 10145**Since**: 12 10146 10147**Parameters** 10148 10149| Name| Description| 10150| -------- | -------- | 10151| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 10152| iterations | Number of playback times. | 10153 10154 10155### OH_ArkUI_DrawContext_GetCanvas() 10156 10157``` 10158void* OH_ArkUI_DrawContext_GetCanvas (ArkUI_DrawContext * context) 10159``` 10160**Description** 10161 10162Obtains the drawing canvas pointer, which can be converted into the OH_Drawing_Canvas pointer of the graphics library for drawing. 10163 10164**Since**: 12 10165 10166**Parameters** 10167 10168| Name| Description| 10169| -------- | -------- | 10170| context | Drawing context. | 10171 10172**Returns** 10173 10174Returns the pointer to the canvas for drawing. 10175 10176 10177### OH_ArkUI_DrawContext_GetSize() 10178 10179``` 10180ArkUI_IntSize OH_ArkUI_DrawContext_GetSize (ArkUI_DrawContext * context) 10181``` 10182**Description** 10183 10184Obtains the size of a drawing area. 10185 10186**Since**: 12 10187 10188**Parameters** 10189 10190| Name| Description| 10191| -------- | -------- | 10192| context | Drawing context. | 10193 10194**Returns** 10195 10196Returns the size of the drawing area. 10197 10198### OH_ArkUI_FocusActivate() 10199``` 10200void OH_ArkUI_FocusActivate(ArkUI_ContextHandle uiContext, bool isActive, bool isAutoInactive); 10201``` 10202**Description** 10203 10204Sets the focus activation state for the current page. When activated, the focused node displays a focus box. 10205 10206**Since**: 15 10207 10208**Parameters** 10209 10210| Name| Description| 10211| -------- | -------- | 10212| uiContext | Pointer to the UI instance object.| 10213| isActive | Whether to enter or exit the focus active state.| 10214| 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.| 10215 10216### OH_ArkUI_FocusClear() 10217``` 10218void OH_ArkUI_FocusClear(ArkUI_ContextHandle uiContext); 10219``` 10220**Description** 10221 10222Clears the focus to the root container node. 10223 10224**Since**: 15 10225 10226**Parameters** 10227 10228| Name| Description| 10229| -------- | -------- | 10230| uiContext | Pointer to the UI instance object.| 10231 10232### OH_ArkUI_FocusRequest() 10233``` 10234ArkUI_ErrorCode OH_ArkUI_FocusRequest(ArkUI_NodeHandle node); 10235``` 10236**Description** 10237 10238Requests focus for a specific node. 10239 10240**Since**: 15 10241 10242**Parameters** 10243 10244| Name| Description| 10245| -------- | -------- | 10246| node | Pointer to a component node. | 10247 10248### OH_ArkUI_FocusSetAutoTransfer() 10249``` 10250void OH_ArkUI_FocusSetAutoTransfer(ArkUI_ContextHandle uiContext, bool autoTransfer); 10251``` 10252**Description** 10253 10254 Configures the focus transfer behavior when pages are switched. 10255 10256**Since**: 15 10257 10258**Parameters** 10259 10260| Name| Description| 10261| -------- | -------- | 10262| uiContext | Pointer to the UI instance object.| 10263| autoTransfer | Whether to automatically transfer focus when pages are switched.| 10264 10265### OH_ArkUI_FocusSetKeyProcessingMode() 10266``` 10267void OH_ArkUI_FocusSetKeyProcessingMode(ArkUI_ContextHandle uiContext, ArkUI_KeyProcessingMode mode) 10268``` 10269**Description** 10270 10271Sets the mode for processing key events. 10272 10273**Since**: 15 10274 10275**Parameters** 10276 10277| Name| Description| 10278| -------- | -------- | 10279| uiContext | Pointer to the UI instance object.| 10280| mode | Mode for processing key events.| 10281 10282### OH_ArkUI_GestureEvent_GetActionType() 10283 10284``` 10285ArkUI_GestureEventActionType OH_ArkUI_GestureEvent_GetActionType (const ArkUI_GestureEvent * event) 10286``` 10287**Description** 10288 10289Obtains the gesture event type. 10290 10291**Since**: 12 10292 10293**Parameters** 10294 10295| Name| Description| 10296| -------- | -------- | 10297| event | Gesture event. | 10298 10299**Returns** 10300 10301Returns the gesture event type. 10302 10303 10304### OH_ArkUI_GestureEvent_GetNode() 10305 10306``` 10307ArkUI_NodeHandle OH_ArkUI_GestureEvent_GetNode (const ArkUI_GestureEvent * event) 10308``` 10309**Description** 10310 10311Obtains the ArkUI component to which the gesture is bound. 10312 10313**Since**: 12 10314 10315**Parameters** 10316 10317| Name| Description| 10318| -------- | -------- | 10319| event | Gesture event. | 10320 10321**Returns** 10322 10323Returns the ArkUI component. 10324 10325 10326### OH_ArkUI_GestureEvent_GetRawInputEvent() 10327 10328``` 10329const ArkUI_UIInputEvent* OH_ArkUI_GestureEvent_GetRawInputEvent (const ArkUI_GestureEvent * event) 10330``` 10331**Description** 10332 10333Obtains gesture input. 10334 10335**Since**: 12 10336 10337**Parameters** 10338 10339| Name| Description| 10340| -------- | -------- | 10341| event | Gesture event. | 10342 10343**Returns** 10344 10345Returns the pointer to the input event of the gesture event. 10346 10347 10348### OH_ArkUI_GestureEvent_GetResponseNode() 10349 10350``` 10351ArkUI_NodeHandle OH_ArkUI_GestureEvent_GetResponseNode (ArkUI_GestureEvent * event) 10352``` 10353**Description** 10354 10355Obtains the node that responds to the gesture. 10356 10357**Since**: 12 10358 10359**Parameters** 10360 10361| Name| Description| 10362| -------- | -------- | 10363| event | Gesture event. | 10364 10365**Returns** 10366 10367Returns the pointer to the node if the node exists; returns **NULL** otherwise. 10368 10369 10370### OH_ArkUI_GestureEventTargetInfo_IsScrollBegin() 10371 10372``` 10373int32_t OH_ArkUI_GestureEventTargetInfo_IsScrollBegin (ArkUI_GestureEventTargetInfo * info, bool * ret ) 10374``` 10375**Description** 10376 10377Obtains whether this scroll container is scrolled to the top. 10378 10379**Since**: 12 10380 10381**Parameters** 10382 10383| Name| Description| 10384| -------- | -------- | 10385| info | Gesture event target information. | 10386| ret | Obtains whether this scroll container is scrolled to the top. | 10387 10388**Returns** 10389 10390Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. Returns **180001** if the component is not a scroll container. 10391 10392 10393### OH_ArkUI_GestureEventTargetInfo_IsScrollEnd() 10394 10395``` 10396int32_t OH_ArkUI_GestureEventTargetInfo_IsScrollEnd (ArkUI_GestureEventTargetInfo * info, bool * ret ) 10397``` 10398**Description** 10399 10400Obtains whether this scroll container is scrolled to the bottom. 10401 10402**Since**: 12 10403 10404**Parameters** 10405 10406| Name| Description| 10407| -------- | -------- | 10408| info | Gesture event target information. | 10409| ret | Obtains whether this scroll container is scrolled to the bottom. | 10410 10411**Returns** 10412 10413Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. Returns **180001** if the component is not a scroll container. 10414 10415 10416### OH_ArkUI_GestureInterruptInfo_GetGestureEvent() 10417 10418``` 10419ArkUI_GestureEvent* OH_ArkUI_GestureInterruptInfo_GetGestureEvent (const ArkUI_GestureInterruptInfo * event) 10420``` 10421**Description** 10422 10423Obtains the pointer to the interrupted gesture event. 10424 10425**Since**: 12 10426 10427**Parameters** 10428 10429| Name| Description| 10430| -------- | -------- | 10431| event | Interrupt callback event. | 10432 10433**Returns** 10434 10435Returns the pointer to the interrupted gesture event. 10436 10437### OH_ArkUI_GestureInterruptInfo_GetRecognizer() 10438 10439``` 10440ArkUI_GestureRecognizer* OH_ArkUI_GestureInterruptInfo_GetRecognizer (const ArkUI_GestureInterruptInfo * event) 10441``` 10442**Description** 10443 10444Returns the pointer to interrupted gesture recognizer. 10445 10446**Since**: 12 10447 10448**Parameters** 10449 10450| Name| Description| 10451| -------- | -------- | 10452| event | Interrupt callback event. | 10453 10454**Returns** 10455 10456Pointer to the interrupted gesture. 10457 10458 10459### OH_ArkUI_GestureInterruptInfo_GetSystemFlag() 10460 10461``` 10462bool OH_ArkUI_GestureInterruptInfo_GetSystemFlag (const ArkUI_GestureInterruptInfo * event) 10463``` 10464**Description** 10465 10466Checks whether a gesture is a built-in gesture of the component. 10467 10468**Since**: 12 10469 10470**Parameters** 10471 10472| Name| Description| 10473| -------- | -------- | 10474| event | Gesture interrupt callback event. | 10475 10476**Returns** 10477 10478true: built-in gestures; false: non-built-in gestures. 10479 10480 10481### OH_ArkUI_GestureInterruptInfo_GetSystemRecognizerType() 10482 10483``` 10484int32_t OH_ArkUI_GestureInterruptInfo_GetSystemRecognizerType (const ArkUI_GestureInterruptInfo * event) 10485``` 10486**Description** 10487 10488Obtains the type of the system gesture to trigger. 10489 10490**Since**: 12 10491 10492**Parameters** 10493 10494| Name| Description| 10495| -------- | -------- | 10496| event | Interrupt callback event. | 10497 10498**Returns** 10499 10500Returns the type of the system gesture to trigger. If the gesture to trigger is not a system gesture, **-1** is returned. 10501 10502 10503### OH_ArkUI_GestureInterruptInfo_GetTouchRecognizers() 10504 10505``` 10506int32_t OH_ArkUI_GestureInterruptInfo_GetTouchRecognizers(const ArkUI_GestureInterruptInfo* info, 10507 ArkUI_TouchRecognizerHandleArray* recognizers, int32_t* size) 10508``` 10509**Description** 10510 10511Obtains touch recognizers from gesture interruption information. 10512 10513**Since**: 15 10514 10515**Parameters** 10516 10517| Name| Description| 10518| -------- | -------- | 10519| info | Interrupt callback event. | 10520| recognizers | Pointer to the array of touch recognizers. | 10521| size | Pointer to the size of the touch recognizer array. | 10522 10523**Returns** 10524 10525Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 10526 10527 10528### OH_ArkUI_TouchRecognizer_GetNodeHandle() 10529 10530``` 10531ArkUI_NodeHandle OH_ArkUI_TouchRecognizer_GetNodeHandle(const ArkUI_TouchRecognizerHandle recognizer) 10532``` 10533**Description** 10534 10535Obtains the component handle corresponding to a touch recognizer. 10536 10537**Since**: 15 10538 10539**Parameters** 10540 10541| Name| Description| 10542| -------- | -------- | 10543| recognizer | Handle to the touch recognizer. | 10544 10545**Returns** 10546 10547Returns the component handle corresponding to the touch recognizer. 10548 10549 10550### OH_ArkUI_TouchRecognizer_CancelTouch() 10551 10552``` 10553int32_t OH_ArkUI_TouchRecognizer_CancelTouch(ArkUI_TouchRecognizerHandle recognizer, ArkUI_GestureInterruptInfo* info) 10554``` 10555**Description** 10556 10557Sends a cancel touch event to a touch recognizer in a gesture interruption callback. 10558 10559**Since**: 15 10560 10561**Parameters** 10562 10563| Name| Description| 10564| -------- | -------- | 10565| recognizer | Handle to the touch recognizer. | 10566| info | Interrupt callback event. | 10567 10568**Returns** 10569 10570Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 10571 10572 10573### OH_ArkUI_GetContextByNode() 10574 10575``` 10576ArkUI_ContextHandle OH_ArkUI_GetContextByNode (ArkUI_NodeHandle node) 10577``` 10578**Description** 10579 10580Obtains the pointer to the UI context object of the specified node. 10581 10582**Since**: 12 10583 10584**Parameters** 10585 10586| Name| Description| 10587| -------- | -------- | 10588| node | Specified node. | 10589 10590**Returns** 10591 10592Returns the pointer to the UI context object. 10593 10594 10595### OH_ArkUI_GetContextFromNapiValue() 10596 10597``` 10598int32_t OH_ArkUI_GetContextFromNapiValue (napi_env env, napi_value value, ArkUI_ContextHandle * context ) 10599``` 10600**Description** 10601 10602Obtains a **UIContext** object on the ArkTS side and maps it to an **ArkUI_ContextHandle** object on the native side. 10603 10604**Since**: 12 10605 10606**Parameters** 10607 10608| Name| Description| 10609| -------- | -------- | 10610| env | Pointer to the NAPI environment. | 10611| value | Context object created on the ArkTS side. | 10612| context | ArkUI_ContextHandle pointer. | 10613 10614**Returns** 10615 10616Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 10617 10618 10619### OH_ArkUI_GetDrawableDescriptorFromNapiValue() 10620 10621``` 10622int32_t OH_ArkUI_GetDrawableDescriptorFromNapiValue (napi_env env, napi_value value, ArkUI_DrawableDescriptor ** drawableDescriptor ) 10623``` 10624**Description** 10625 10626Maps a **DrawableDescriptor** object on the ArkTS side to an **ArkUI_DrawableDescriptor** object on the native side. 10627 10628**Since**: 12 10629 10630**Parameters** 10631 10632| Name| Description| 10633| -------- | -------- | 10634| env | Pointer to the NAPI environment. | 10635| value | **DrawableDescriptor** object created on the ArkTS side. | 10636| drawableDescriptor | Object that receives the pointer to the **ArkUI_DrawableDescriptor** object. | 10637 10638**Returns** 10639 10640Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 10641 10642 10643### OH_ArkUI_GetDrawableDescriptorFromResourceNapiValue() 10644 10645``` 10646int32_t OH_ArkUI_GetDrawableDescriptorFromResourceNapiValue (napi_env env, napi_value value, ArkUI_DrawableDescriptor ** drawableDescriptor ) 10647``` 10648**Description** 10649 10650Maps an $r resource object on the ArkTS side to an **ArkUI_DrawableDescriptor** object on the native side. 10651 10652**Since**: 12 10653 10654**Parameters** 10655 10656| Name| Description| 10657| -------- | -------- | 10658| env | Pointer to the NAPI environment. | 10659| value | $r resource object created on ArkTS. | 10660| drawableDescriptor | Object that receives the pointer to the **ArkUI_DrawableDescriptor** object. | 10661 10662**Returns** 10663 10664Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 10665 10666 10667### OH_ArkUI_GetGestureBindNodeId() 10668 10669``` 10670int32_t OH_ArkUI_GetGestureBindNodeId (ArkUI_GestureRecognizer * recognizer, char * nodeId, int32_t size, int32_t * result ) 10671``` 10672**Description** 10673 10674Obtains the ID of the component linked to a gesture recognizer. 10675 10676**Since**: 12 10677 10678**Parameters** 10679 10680| Name| Description| 10681| -------- | -------- | 10682| recognizer | Pointer to the gesture recognizer. | 10683| nodeId | ID of a component. | 10684| size | Size of the storage area. | 10685| result | Length of the string to be copied. | 10686 10687**Returns** 10688 10689Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. Returns **180002** if the buffer is not large enough. 10690 10691 10692### OH_ArkUI_GetGestureEventTargetInfo() 10693 10694``` 10695int32_t OH_ArkUI_GetGestureEventTargetInfo (ArkUI_GestureRecognizer * recognizer, ArkUI_GestureEventTargetInfo ** info ) 10696``` 10697**Description** 10698 10699Obtains the information about a gesture event target. 10700 10701**Since**: 12 10702 10703**Parameters** 10704 10705| Name| Description| 10706| -------- | -------- | 10707| recognizer | Pointer to the gesture recognizer. | 10708| info | Gesture event target information. | 10709 10710**Returns** 10711 10712Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 10713 10714 10715### OH_ArkUI_GetGestureRecognizerEnabled() 10716 10717``` 10718bool OH_ArkUI_GetGestureRecognizerEnabled (ArkUI_GestureRecognizer * recognizer) 10719``` 10720**Description** 10721 10722Obtains the enabled state of a gesture recognizer. 10723 10724**Since**: 12 10725 10726**Parameters** 10727 10728| Name| Description| 10729| -------- | -------- | 10730| recognizer | Pointer to the gesture recognizer. | 10731 10732**Returns** 10733 10734**true**: enabled false: disabled 10735 10736 10737### OH_ArkUI_GetGestureRecognizerState() 10738 10739``` 10740int32_t OH_ArkUI_GetGestureRecognizerState (ArkUI_GestureRecognizer * recognizer, ArkUI_GestureRecognizerState * state ) 10741``` 10742**Description** 10743 10744Obtains the state of a gesture recognizer. 10745 10746**Since**: 12 10747 10748**Parameters** 10749 10750| Name| Description| 10751| -------- | -------- | 10752| recognizer | Pointer to the gesture recognizer. | 10753| state | Status of the gesture recognizer. | 10754 10755**Returns** 10756 10757Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 10758 10759 10760### OH_ArkUI_GetGestureTag() 10761 10762``` 10763int32_t OH_ArkUI_GetGestureTag (ArkUI_GestureRecognizer * recognizer, char * buffer, int32_t bufferSize, int32_t * result ) 10764``` 10765**Description** 10766 10767Obtains the mark of the gesture recognizer. 10768 10769**Since**: 12 10770 10771**Parameters** 10772 10773| Name| Description| 10774| -------- | -------- | 10775| recognizer | Pointer to the gesture recognizer. | 10776| buffer | Storage zone | 10777| bufferSize | Size of the storage area. | 10778| result | Length of the string to be copied. | 10779 10780**Returns** 10781 10782Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. Returns **180002** if the buffer is not large enough. 10783 10784 10785### OH_ArkUI_GetNavDestinationId() 10786 10787``` 10788ArkUI_ErrorCode OH_ArkUI_GetNavDestinationId (ArkUI_NodeHandle node, char * buffer, int32_t bufferSize, int32_t * writeLength ) 10789``` 10790**Description** 10791 10792Obtains the ID of the **NavDestination** component where the specified node is located. 10793 10794**Since**: 12 10795 10796**Parameters** 10797 10798| Name| Description| 10799| -------- | -------- | 10800| node | Specified node. | 10801| buffer | buffer. NavDestinationID is written to this memory area. | 10802| bufferSize | Pointer to the buffer size. | 10803| 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. | 10804 10805**Returns** 10806 10807Returns **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. 10808 10809 10810### OH_ArkUI_GetNavDestinationIndex() 10811 10812``` 10813ArkUI_ErrorCode OH_ArkUI_GetNavDestinationIndex (ArkUI_NodeHandle node, int32_t * index ) 10814``` 10815**Description** 10816 10817Obtains the index of the **NavDestination** component where the specified node is located in the navigation stack. 10818 10819**Since**: 12 10820 10821**Parameters** 10822 10823| Name| Description| 10824| -------- | -------- | 10825| node | Specified node. | 10826| index | Returns the index, starting from 0. | 10827 10828**Returns** 10829 10830Returns **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. 10831 10832 10833### OH_ArkUI_GetNavDestinationName() 10834 10835``` 10836ArkUI_ErrorCode OH_ArkUI_GetNavDestinationName (ArkUI_NodeHandle node, char * buffer, int32_t bufferSize, int32_t * writeLength ) 10837``` 10838**Description** 10839 10840Obtains the name of the **NavDestination** component where the specified node is located. 10841 10842**Since**: 12 10843 10844**Parameters** 10845 10846| Name| Description| 10847| -------- | -------- | 10848| node | Specified node. | 10849| buffer | Buffer. The queried NavDestination name is written to this memory area. | 10850| bufferSize | Pointer to the buffer size. | 10851| 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. | 10852 10853**Returns** 10854 10855Returns **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. 10856 10857 10858### OH_ArkUI_GetNavDestinationNameByIndex() 10859 10860``` 10861ArkUI_ErrorCode OH_ArkUI_GetNavDestinationNameByIndex (ArkUI_NodeHandle node, int32_t index, char * buffer, int32_t bufferSize, int32_t * writeLength ) 10862``` 10863**Description** 10864 10865Obtains 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. 10866 10867**Since**: 12 10868 10869**Parameters** 10870 10871| Name| Description| 10872| -------- | -------- | 10873| node | Specified node. | 10874| index | Index of the queried NavDestination in the stack. | 10875| buffer | Buffer. The name of the queried page is written to this memory area. | 10876| bufferSize | Pointer to the buffer size. | 10877| 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. | 10878 10879**Returns** 10880 10881Returns **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. 10882 10883 10884### OH_ArkUI_GetNavDestinationParam() 10885 10886``` 10887napi_value OH_ArkUI_GetNavDestinationParam (ArkUI_NodeHandle node) 10888``` 10889**Description** 10890 10891Obtains the parameters of the **NavDestination** component where the specified node is located. 10892 10893**Since**: 12 10894 10895**Parameters** 10896 10897| Name| Description| 10898| -------- | -------- | 10899| node | Specified node. | 10900 10901**Returns** 10902 10903Parameter object. 10904 10905 10906### OH_ArkUI_GetNavDestinationState() 10907 10908``` 10909ArkUI_ErrorCode OH_ArkUI_GetNavDestinationState (ArkUI_NodeHandle node, ArkUI_NavDestinationState * state ) 10910``` 10911**Description** 10912 10913Obtains the state of the **NavDestination** component where the specified node is located. 10914 10915**Since**: 12 10916 10917**Parameters** 10918 10919| Name| Description| 10920| -------- | -------- | 10921| node | Specified node. | 10922| state | The status value of NavDestination is written back to this parameter. | 10923 10924**Returns** 10925 10926The 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. 10927 10928 10929### OH_ArkUI_GetNavigationId() 10930 10931``` 10932ArkUI_ErrorCode OH_ArkUI_GetNavigationId (ArkUI_NodeHandle node, char * buffer, int32_t bufferSize, int32_t * writeLength ) 10933``` 10934**Description** 10935 10936Obtains the ID of the **Navigation** component where the specified node is located. 10937 10938**Since**: 12 10939 10940**Parameters** 10941 10942| Name| Description| 10943| -------- | -------- | 10944| node | Specified node. | 10945| buffer | buffer. The NavigationID is written to this memory area. | 10946| bufferSize | Pointer to the buffer size. | 10947| 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. | 10948 10949**Returns** 10950 10951Returns **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. 10952 10953 10954### OH_ArkUI_GetNavStackLength() 10955 10956``` 10957ArkUI_ErrorCode OH_ArkUI_GetNavStackLength (ArkUI_NodeHandle node, int32_t * length ) 10958``` 10959**Description** 10960 10961Obtains the length of the navigation stack where the specified node is located. 10962 10963**Since**: 12 10964 10965**Parameters** 10966 10967| Name| Description| 10968| -------- | -------- | 10969| node | Specified node. | 10970| length | Length of the stack. The result, if obtained successfully, is written back to this parameter. | 10971 10972**Returns** 10973 10974Returns **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. 10975 10976 10977### OH_ArkUI_GetNodeContentFromNapiValue() 10978 10979``` 10980int32_t OH_ArkUI_GetNodeContentFromNapiValue (napi_env env, napi_value value, ArkUI_NodeContentHandle * content ) 10981``` 10982**Description** 10983 10984Obtains a **NodeContent** object on the ArkTS side and maps it to an **ArkUI_NodeContentHandle** object on the native side. 10985 10986**Since**: 12 10987 10988**Parameters** 10989 10990| Name| Description| 10991| -------- | -------- | 10992| env | Pointer to the NAPI environment. | 10993| value | NodeContent object created on ArkTS. | 10994| context | ArkUI_NodeContentHandle pointer. | 10995 10996**Returns** 10997 10998Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 10999 11000 11001### OH_ArkUI_GetNodeHandleFromNapiValue() 11002 11003``` 11004int32_t OH_ArkUI_GetNodeHandleFromNapiValue (napi_env env, napi_value frameNode, ArkUI_NodeHandle * handle ) 11005``` 11006**Description** 11007 11008Obtains a **FrameNode** object on the ArkTS side and maps it to an **ArkUI_NodeHandle** object on the native side. 11009 11010**Since**: 12 11011 11012**Parameters** 11013 11014| Name| Description| 11015| -------- | -------- | 11016| env | Pointer to the NAPI environment. | 11017| frameNode | FrameNode object created on the ArkTS side. | 11018| handle | **ArkUI_NodeHandle** pointer. | 11019 11020**Returns** 11021 11022Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11023 11024 11025### OH_ArkUI_GetPanGestureDirectionMask() 11026 11027``` 11028int32_t OH_ArkUI_GetPanGestureDirectionMask (ArkUI_GestureRecognizer * recognizer, ArkUI_GestureDirectionMask * directionMask ) 11029``` 11030**Description** 11031 11032Obtains the direction of a pan gesture. 11033 11034**Since**: 12 11035 11036**Parameters** 11037 11038| Name| Description| 11039| -------- | -------- | 11040| recognizer | Pointer to the gesture recognizer. | 11041| directionMask | Sliding direction of the sliding gesture. | 11042 11043**Returns** 11044 11045Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 11046 11047 11048### OH_ArkUI_GetResponseRecognizersFromInterruptInfo() 11049 11050``` 11051int32_t OH_ArkUI_GetResponseRecognizersFromInterruptInfo (const ArkUI_GestureInterruptInfo * event, ArkUI_GestureRecognizerHandleArray * responseChain, int32_t * count ) 11052``` 11053**Description** 11054 11055Obtains information about a gesture response chain. 11056 11057**Since**: 12 11058 11059**Parameters** 11060 11061| Name| Description| 11062| -------- | -------- | 11063| event | Gesture interrupt callback event. | 11064| responseChain | Gesture recognizer on the response chain component. | 11065| count | Number of gesture recognizers on the response chain component. | 11066 11067**Returns** 11068 11069Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 11070 11071 11072### OH_ArkUI_GetRouterPageId() 11073 11074``` 11075ArkUI_ErrorCode OH_ArkUI_GetRouterPageId (ArkUI_NodeHandle node, char * buffer, int32_t bufferSize, int32_t * writeLength ) 11076``` 11077**Description** 11078 11079Obtains the ID of the page where the specified node is located. 11080 11081**Since**: 12 11082 11083**Parameters** 11084 11085| Name| Description| 11086| -------- | -------- | 11087| node | Specified node. | 11088| buffer | buffer. Page Id is written to this memory area. | 11089| bufferSize | Pointer to the buffer size. | 11090| 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. | 11091 11092**Returns** 11093 11094Returns **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. 11095 11096 11097### OH_ArkUI_GetRouterPageIndex() 11098 11099``` 11100ArkUI_ErrorCode OH_ArkUI_GetRouterPageIndex (ArkUI_NodeHandle node, int32_t * index ) 11101``` 11102**Description** 11103 11104Obtains the index of the page where the specified node is located in the page stack for routing. 11105 11106**Since**: 12 11107 11108**Parameters** 11109 11110| Name| Description| 11111| -------- | -------- | 11112| node | Specified node. | 11113| index | Returns the index, starting from 1. | 11114 11115**Returns** 11116 11117Returns **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. 11118 11119 11120### OH_ArkUI_GetRouterPageName() 11121 11122``` 11123ArkUI_ErrorCode OH_ArkUI_GetRouterPageName (ArkUI_NodeHandle node, char * buffer, int32_t bufferSize, int32_t * writeLength ) 11124``` 11125**Description** 11126 11127Obtains the name of the page where the specified node is located. 11128 11129**Since**: 12 11130 11131**Parameters** 11132 11133| Name| Description| 11134| -------- | -------- | 11135| node | Specified node. | 11136| buffer | Buffer. The page name is written to this memory area. | 11137| bufferSize | Pointer to the buffer size. | 11138| 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. | 11139 11140**Returns** 11141 11142Returns **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. 11143 11144 11145### OH_ArkUI_GetRouterPagePath() 11146 11147``` 11148ArkUI_ErrorCode OH_ArkUI_GetRouterPagePath (ArkUI_NodeHandle node, char * buffer, int32_t bufferSize, int32_t * writeLength ) 11149``` 11150**Description** 11151 11152Obtains the path to the page where the specified node is located. 11153 11154**Since**: 12 11155 11156**Parameters** 11157 11158| Name| Description| 11159| -------- | -------- | 11160| node | Specified node. | 11161| buffer | buffer. Page Path is written to this memory area. | 11162| bufferSize | Pointer to the buffer size. | 11163| 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. | 11164 11165**Returns** 11166 11167Returns **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. 11168 11169 11170### OH_ArkUI_GetRouterPageState() 11171 11172``` 11173ArkUI_ErrorCode OH_ArkUI_GetRouterPageState (ArkUI_NodeHandle node, ArkUI_RouterPageState * state ) 11174``` 11175**Description** 11176 11177Obtains the state of the page where the specified node is located. 11178 11179**Since**: 12 11180 11181**Parameters** 11182 11183| Name| Description| 11184| -------- | -------- | 11185| node | Specified node. | 11186| state | The status value of Router Page is written back to this parameter. | 11187 11188**Returns** 11189 11190The error code ARKUI_ERROR_CODE_NO_ERROR is returned. The ARKUI_ERROR_CODE_GET_INFO_FAILED fails to query information. 11191 11192 11193### OH_ArkUI_GuidelineOption_Create() 11194 11195``` 11196ArkUI_GuidelineOption* OH_ArkUI_GuidelineOption_Create (int32_t size) 11197``` 11198**Description** 11199 11200Creates a guideline configuration for this **RelativeContainer**. 11201 11202**Since**: 12 11203 11204**Parameters** 11205 11206| Name| Description| 11207| -------- | -------- | 11208| size | Number of guidelines. | 11209 11210**Returns** 11211 11212Returns the guideline configuration. 11213 11214 11215### OH_ArkUI_GuidelineOption_Dispose() 11216 11217``` 11218void OH_ArkUI_GuidelineOption_Dispose (ArkUI_GuidelineOption * guideline) 11219``` 11220**Description** 11221 11222Destroys auxiliary line information. 11223 11224**Since**: 12 11225 11226**Parameters** 11227 11228| Name| Description| 11229| -------- | -------- | 11230| guideline | Pointer to a guideline configuration. | 11231 11232 11233### OH_ArkUI_GuidelineOption_GetDirection() 11234 11235``` 11236ArkUI_Axis OH_ArkUI_GuidelineOption_GetDirection (ArkUI_GuidelineOption * guideline, int32_t index ) 11237``` 11238**Description** 11239 11240Obtains the direction of a guideline. 11241 11242**Since**: 12 11243 11244**Parameters** 11245 11246| Name| Description| 11247| -------- | -------- | 11248| guideline | Pointer to a guideline configuration. | 11249| index | Index of the barrier. | 11250 11251**Returns** 11252 11253Returns the direction of the guideline. 11254 11255 11256### OH_ArkUI_GuidelineOption_GetId() 11257 11258``` 11259const char* OH_ArkUI_GuidelineOption_GetId (ArkUI_GuidelineOption * guideline, int32_t index ) 11260``` 11261**Description** 11262 11263Obtains the ID of a guideline. 11264 11265**Since**: 12 11266 11267**Parameters** 11268 11269| Name| Description| 11270| -------- | -------- | 11271| guideline | Pointer to a guideline configuration. | 11272| index | Index of the barrier. | 11273 11274**Returns** 11275 11276Returns the ID of the guideline. 11277 11278 11279### OH_ArkUI_GuidelineOption_GetPositionEnd() 11280 11281``` 11282float OH_ArkUI_GuidelineOption_GetPositionEnd (ArkUI_GuidelineOption * guideline, int32_t index ) 11283``` 11284**Description** 11285 11286Obtains the distance between a guideline and the right or bottom of the container. 11287 11288**Since**: 12 11289 11290**Parameters** 11291 11292| Name| Description| 11293| -------- | -------- | 11294| guideline | Pointer to a guideline configuration. | 11295| index | Index of the barrier. | 11296 11297**Returns** 11298 11299Distance between the guideline and the right or bottom of the container. 11300 11301 11302### OH_ArkUI_GuidelineOption_GetPositionStart() 11303 11304``` 11305float OH_ArkUI_GuidelineOption_GetPositionStart (ArkUI_GuidelineOption * guideline, int32_t index ) 11306``` 11307**Description** 11308 11309Obtains the distance between a guideline and the left or top of the container. 11310 11311**Since**: 12 11312 11313**Parameters** 11314 11315| Name| Description| 11316| -------- | -------- | 11317| guideline | Pointer to a guideline configuration. | 11318| index | Index of the barrier. | 11319 11320**Returns** 11321 11322Distance between the guideline and the left or top of the container. 11323 11324 11325### OH_ArkUI_GuidelineOption_SetDirection() 11326 11327``` 11328void OH_ArkUI_GuidelineOption_SetDirection (ArkUI_GuidelineOption * guideline, ArkUI_Axis value, int32_t index ) 11329``` 11330**Description** 11331 11332Sets the direction of a guideline. 11333 11334**Since**: 12 11335 11336**Parameters** 11337 11338| Name| Description| 11339| -------- | -------- | 11340| guideline | Pointer to a guideline configuration. | 11341| value | Direction. | 11342| index | Index of the guideline. | 11343 11344 11345### OH_ArkUI_GuidelineOption_SetId() 11346 11347``` 11348void OH_ArkUI_GuidelineOption_SetId (ArkUI_GuidelineOption * guideline, const char * value, int32_t index ) 11349``` 11350**Description** 11351 11352Sets the ID of a guideline. 11353 11354**Since**: 12 11355 11356**Parameters** 11357 11358| Name| Description| 11359| -------- | -------- | 11360| guideline | Pointer to a guideline configuration. | 11361| value | ID of the barrier, which must be unique and cannot be the same as the name of any component in the container. | 11362| index | Index of the guideline. | 11363 11364 11365### OH_ArkUI_GuidelineOption_SetPositionEnd() 11366 11367``` 11368void OH_ArkUI_GuidelineOption_SetPositionEnd (ArkUI_GuidelineOption * guideline, float value, int32_t index ) 11369``` 11370**Description** 11371 11372Sets the distance between a guideline and the right or bottom of the container. 11373 11374**Since**: 12 11375 11376**Parameters** 11377 11378| Name| Description| 11379| -------- | -------- | 11380| guideline | Pointer to a guideline configuration. | 11381| value | Distance between the guideline and the right or bottom of the container. | 11382| index | Index of the guideline. | 11383 11384 11385### OH_ArkUI_GuidelineOption_SetPositionStart() 11386 11387``` 11388void OH_ArkUI_GuidelineOption_SetPositionStart (ArkUI_GuidelineOption * guideline, float value, int32_t index ) 11389``` 11390**Description** 11391 11392Sets the distance between a guideline and the left or top of the container. 11393 11394**Since**: 12 11395 11396**Parameters** 11397 11398| Name| Description| 11399| -------- | -------- | 11400| guideline | Pointer to a guideline configuration. | 11401| value | Distance between the guideline and the left or top of the container. | 11402| index | Index of the guideline. | 11403 11404 11405### OH_ArkUI_ImageAnimatorFrameInfo_CreateFromDrawableDescriptor() 11406 11407``` 11408ArkUI_ImageAnimatorFrameInfo* OH_ArkUI_ImageAnimatorFrameInfo_CreateFromDrawableDescriptor (ArkUI_DrawableDescriptor * drawable) 11409``` 11410**Description** 11411 11412Creates an image frame information object based on a **DrawableDescriptor** object, with the image format being Resource or PixelMap. 11413 11414**Since**: 12 11415 11416**Parameters** 11417 11418| Name| Description| 11419| -------- | -------- | 11420| drawable | Pointer to an **ArkUI_DrawableDescriptor** object created using Resource or PixelMap. | 11421 11422**Returns** 11423 11424Returns the pointer to the created frame image object. 11425 11426 11427### OH_ArkUI_ImageAnimatorFrameInfo_CreateFromString() 11428 11429``` 11430ArkUI_ImageAnimatorFrameInfo* OH_ArkUI_ImageAnimatorFrameInfo_CreateFromString (char * src) 11431``` 11432**Description** 11433 11434Creates an image frame information object based on an image path, with the image format being SVG, PNG, or JPG. 11435 11436**Since**: 12 11437 11438**Parameters** 11439 11440| Name| Description| 11441| -------- | -------- | 11442| src | Image path. | 11443 11444**Returns** 11445 11446Returns the pointer to the created frame image object. 11447 11448 11449### OH_ArkUI_ImageAnimatorFrameInfo_Dispose() 11450 11451``` 11452void OH_ArkUI_ImageAnimatorFrameInfo_Dispose (ArkUI_ImageAnimatorFrameInfo * imageInfo) 11453``` 11454**Description** 11455 11456Disposes of the pointer to an image frame information object. 11457 11458**Since**: 12 11459 11460**Parameters** 11461 11462| Name| Description| 11463| -------- | -------- | 11464| imageInfo | Pointer to the frame image object. | 11465 11466 11467### OH_ArkUI_ImageAnimatorFrameInfo_GetDuration() 11468 11469``` 11470int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetDuration (ArkUI_ImageAnimatorFrameInfo * imageInfo) 11471``` 11472**Description** 11473 11474Obtains the playback duration of an image. 11475 11476**Since**: 12 11477 11478**Parameters** 11479 11480| Name| Description| 11481| -------- | -------- | 11482| imageInfo | Pointer to the frame image object. | 11483 11484**Returns** 11485 11486Returns the playback duration of the image, in milliseconds. If **imageInfo** is a null pointer, **0** is returned. 11487 11488 11489### OH_ArkUI_ImageAnimatorFrameInfo_GetHeight() 11490 11491``` 11492int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetHeight (ArkUI_ImageAnimatorFrameInfo * imageInfo) 11493``` 11494**Description** 11495 11496Obtains the image height. 11497 11498**Since**: 12 11499 11500**Parameters** 11501 11502| Name| Description| 11503| -------- | -------- | 11504| imageInfo | Pointer to the frame image object. | 11505 11506**Returns** 11507 11508Returns the image height, in PX. If **imageInfo** is a null pointer, **0** is returned. 11509 11510 11511### OH_ArkUI_ImageAnimatorFrameInfo_GetLeft() 11512 11513``` 11514int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetLeft (ArkUI_ImageAnimatorFrameInfo * imageInfo) 11515``` 11516**Description** 11517 11518Obtains the horizontal coordinate of an image relative to the upper left corner of the component. 11519 11520**Since**: 12 11521 11522**Parameters** 11523 11524| Name| Description| 11525| -------- | -------- | 11526| imageInfo | Pointer to the frame image object. | 11527 11528**Returns** 11529 11530Returns 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. 11531 11532 11533### OH_ArkUI_ImageAnimatorFrameInfo_GetTop() 11534 11535``` 11536int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetTop (ArkUI_ImageAnimatorFrameInfo * imageInfo) 11537``` 11538**Description** 11539 11540Obtains the vertical coordinate of an image relative to the upper left corner of the component. 11541 11542**Since**: 12 11543 11544**Parameters** 11545 11546| Name| Description| 11547| -------- | -------- | 11548| imageInfo | Pointer to the frame image object. | 11549 11550**Returns** 11551 11552Returns 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. 11553 11554 11555### OH_ArkUI_ImageAnimatorFrameInfo_GetWidth() 11556 11557``` 11558int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetWidth (ArkUI_ImageAnimatorFrameInfo * imageInfo) 11559``` 11560**Description** 11561 11562Obtains the image width. 11563 11564**Since**: 12 11565 11566**Parameters** 11567 11568| Name| Description| 11569| -------- | -------- | 11570| imageInfo | Pointer to the frame image object. | 11571 11572**Returns** 11573 11574Returns the image width, in PX. If **imageInfo** is a null pointer, **0** is returned. 11575 11576 11577### OH_ArkUI_ImageAnimatorFrameInfo_SetDuration() 11578 11579``` 11580void OH_ArkUI_ImageAnimatorFrameInfo_SetDuration (ArkUI_ImageAnimatorFrameInfo * imageInfo, int32_t duration ) 11581``` 11582**Description** 11583 11584Sets the playback duration of an image. 11585 11586**Since**: 12 11587 11588**Parameters** 11589 11590| Name| Description| 11591| -------- | -------- | 11592| imageInfo | Pointer to the frame image object. | 11593| duration | Playback duration of an image, in milliseconds. | 11594 11595 11596### OH_ArkUI_ImageAnimatorFrameInfo_SetHeight() 11597 11598``` 11599void OH_ArkUI_ImageAnimatorFrameInfo_SetHeight (ArkUI_ImageAnimatorFrameInfo * imageInfo, int32_t height ) 11600``` 11601**Description** 11602 11603Sets the image height. 11604 11605**Since**: 12 11606 11607**Parameters** 11608 11609| Name| Description| 11610| -------- | -------- | 11611| imageInfo | Pointer to the frame image object. | 11612| height | Image height, in px. | 11613 11614 11615### OH_ArkUI_ImageAnimatorFrameInfo_SetLeft() 11616 11617``` 11618void OH_ArkUI_ImageAnimatorFrameInfo_SetLeft (ArkUI_ImageAnimatorFrameInfo * imageInfo, int32_t left ) 11619``` 11620**Description** 11621 11622Sets the horizontal coordinate of an image relative to the upper left corner of the component. 11623 11624**Since**: 12 11625 11626**Parameters** 11627 11628| Name| Description| 11629| -------- | -------- | 11630| imageInfo | Pointer to the frame image object. | 11631| left | Horizontal coordinate of the image relative to the upper left corner of the component, in px. | 11632 11633 11634### OH_ArkUI_ImageAnimatorFrameInfo_SetTop() 11635 11636``` 11637void OH_ArkUI_ImageAnimatorFrameInfo_SetTop (ArkUI_ImageAnimatorFrameInfo * imageInfo, int32_t top ) 11638``` 11639**Description** 11640 11641Sets the vertical coordinate of an image relative to the upper left corner of the component. 11642 11643**Since**: 12 11644 11645**Parameters** 11646 11647| Name| Description| 11648| -------- | -------- | 11649| imageInfo | Pointer to the frame image object. | 11650| top | Vertical coordinate of the image relative to the upper left corner of the component, in px. | 11651 11652 11653### OH_ArkUI_ImageAnimatorFrameInfo_SetWidth() 11654 11655``` 11656void OH_ArkUI_ImageAnimatorFrameInfo_SetWidth (ArkUI_ImageAnimatorFrameInfo * imageInfo, int32_t width ) 11657``` 11658**Description** 11659 11660Sets the image width. 11661 11662**Since**: 12 11663 11664**Parameters** 11665 11666| Name| Description| 11667| -------- | -------- | 11668| imageInfo | Pointer to the frame image object. | 11669| width | Image width, in px. | 11670 11671 11672### OH_ArkUI_IsBuiltInGesture() 11673 11674``` 11675bool OH_ArkUI_IsBuiltInGesture (ArkUI_GestureRecognizer * recognizer) 11676``` 11677**Description** 11678 11679Obtains whether a gesture is a built-in gesture. 11680 11681**Since**: 12 11682 11683**Parameters** 11684 11685| Name| Description| 11686| -------- | -------- | 11687| recognizer | Pointer to the gesture recognizer. | 11688 11689**Returns** 11690 11691true: built-in gestures. false: The gesture is not a built-in gesture. 11692 11693 11694### OH_ArkUI_IsGestureRecognizerValid() 11695 11696``` 11697bool OH_ArkUI_IsGestureRecognizerValid (ArkUI_GestureRecognizer * recognizer) 11698``` 11699**Description** 11700 11701Obtains whether a gesture recognizer is valid. 11702 11703**Since**: 12 11704 11705**Parameters** 11706 11707| Name| Description| 11708| -------- | -------- | 11709| recognizer | Pointer to the gesture recognizer. | 11710 11711**Returns** 11712 11713true: The gesture recognizer is valid. Returns **false** if the gesture recognizer is invalid. 11714 11715 11716### OH_ArkUI_KeyEvent_GetKeyCode() 11717 11718``` 11719int32_t OH_ArkUI_KeyEvent_GetKeyCode (const ArkUI_UIInputEvent * event) 11720``` 11721**Description** 11722 11723Obtains the key code from a key event. 11724 11725**Since**: 14 11726 11727**Parameters** 11728 11729| Name| Description| 11730| -------- | -------- | 11731| event | Pointer to an **ArkUI_UIInputEvent** object. | 11732 11733**Returns** 11734 11735Key code. 11736 11737 11738### OH_ArkUI_KeyEvent_GetKeyIntensionCode() 11739 11740``` 11741ArkUI_KeyIntension OH_ArkUI_KeyEvent_GetKeyIntensionCode (const ArkUI_UIInputEvent * event) 11742``` 11743**Description** 11744 11745Obtains the intention code associated with a key event. 11746 11747**Since**: 14 11748 11749**Parameters** 11750 11751| Name| Description| 11752| -------- | -------- | 11753| event | Pointer to an **ArkUI_UIInputEvent** object. | 11754 11755**Returns** 11756 11757Returns the intention code associated with the key event. 11758 11759 11760### OH_ArkUI_KeyEvent_GetKeySource() 11761 11762``` 11763ArkUI_KeySourceType OH_ArkUI_KeyEvent_GetKeySource (const ArkUI_UIInputEvent * event) 11764``` 11765**Description** 11766 11767Obtains the type of input device that triggers a key event. 11768 11769**Since**: 14 11770 11771**Parameters** 11772 11773| Name| Description| 11774| -------- | -------- | 11775| event | Pointer to an **ArkUI_UIInputEvent** object. | 11776 11777**Returns** 11778 11779Returns the device type. 11780 11781 11782### OH_ArkUI_KeyEvent_GetKeyText() 11783 11784``` 11785const char* OH_ArkUI_KeyEvent_GetKeyText (const ArkUI_UIInputEvent * event) 11786``` 11787**Description** 11788 11789Obtains the key value from a key event. 11790 11791**Since**: 14 11792 11793**Parameters** 11794 11795| Name| Description| 11796| -------- | -------- | 11797| event | Pointer to an **ArkUI_UIInputEvent** object. | 11798 11799**Returns** 11800 11801Key value. 11802 11803 11804### OH_ArkUI_KeyEvent_GetType() 11805 11806``` 11807ArkUI_KeyEventType OH_ArkUI_KeyEvent_GetType (const ArkUI_UIInputEvent * event) 11808``` 11809**Description** 11810 11811Obtains the type of a key event. 11812 11813**Since**: 14 11814 11815**Parameters** 11816 11817| Name| Description| 11818| -------- | -------- | 11819| event | Pointer to an **ArkUI_UIInputEvent** object. | 11820 11821**Returns** 11822 11823Returns the key event type. 11824 11825 11826### OH_ArkUI_KeyEvent_GetUnicode() 11827 11828``` 11829uint32_t OH_ArkUI_KeyEvent_GetUnicode (const ArkUI_UIInputEvent * event) 11830``` 11831**Description** 11832 11833Obtains 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. 11834 11835**Since**: 14 11836 11837**Parameters** 11838 11839| Name| Description| 11840| -------- | -------- | 11841| event | Pointer to an **ArkUI_UIInputEvent** object. | 11842 11843**Returns** 11844 11845Returns the Unicode value. 11846 11847 11848### OH_ArkUI_KeyEvent_SetConsumed() 11849 11850``` 11851void OH_ArkUI_KeyEvent_SetConsumed (const ArkUI_UIInputEvent * event, bool isConsumed ) 11852``` 11853**Description** 11854 11855Sets whether a key event is consumed in the key event callback. 11856 11857**Since**: 14 11858 11859**Parameters** 11860 11861| Name| Description| 11862| -------- | -------- | 11863| event | Pointer to an **ArkUI_UIInputEvent** object. | 11864| isConsumed | Whether the event is consumed. | 11865 11866 11867### OH_ArkUI_KeyEvent_StopPropagation() 11868 11869``` 11870void OH_ArkUI_KeyEvent_StopPropagation (const ArkUI_UIInputEvent * event, bool stopPropagation ) 11871``` 11872**Description** 11873 11874Stops the event from bubbling upwards or downwards. 11875 11876**Since**: 14 11877 11878**Parameters** 11879 11880| Name| Description| 11881| -------- | -------- | 11882| event | Pointer to an **ArkUI_UIInputEvent** object. | 11883| stopPropagation | Whether to stop event propagation. | 11884 11885 11886### OH_ArkUI_KeyEvent_Dispatch() 11887 11888``` 11889void OH_ArkUI_KeyEvent_Dispatch(ArkUI_NodeHandle node, const ArkUI_UIInputEvent* event) 11890``` 11891**Description** 11892 11893Dispatches a key event to a specific node. 11894 11895**Since**: 15 11896 11897**Parameters** 11898 11899| Name| Description| 11900| -------- | -------- | 11901| node | Node object for which an event needs to be registered. | 11902| event | Pointer to an **ArkUI_UIInputEvent** object. | 11903 11904### OH_ArkUI_KeyframeAnimateOption_Create() 11905 11906``` 11907ArkUI_KeyframeAnimateOption* OH_ArkUI_KeyframeAnimateOption_Create (int32_t size) 11908``` 11909**Description** 11910 11911Obtains the keyframe animation parameters. 11912 11913**Since**: 12 11914 11915**Parameters** 11916 11917| Name| Description| 11918| -------- | -------- | 11919| size | Number of key frame animation states. | 11920 11921**Returns** 11922 11923Returns the keyframe animation parameter object; returns **NULL** if the value of **size** is less than 0. 11924 11925 11926### OH_ArkUI_KeyframeAnimateOption_Dispose() 11927 11928``` 11929void OH_ArkUI_KeyframeAnimateOption_Dispose (ArkUI_KeyframeAnimateOption * option) 11930``` 11931**Description** 11932 11933Destroys a keyframe animation parameter object. 11934 11935**Since**: 12 11936 11937**Parameters** 11938 11939| Name| Description| 11940| -------- | -------- | 11941| option | Returns the keyframe animation parameter object; | 11942 11943 11944### OH_ArkUI_KeyframeAnimateOption_GetCurve() 11945 11946``` 11947ArkUI_CurveHandle OH_ArkUI_KeyframeAnimateOption_GetCurve (ArkUI_KeyframeAnimateOption * option, int32_t index ) 11948``` 11949**Description** 11950 11951Obtains the animation curve of a specific state in a keyframe animation. 11952 11953**Since**: 12 11954 11955**Parameters** 11956 11957| Name| Description| 11958| -------- | -------- | 11959| option | Keyframe animation parameters. | 11960| index | Status index. | 11961 11962**Returns** 11963 11964Returns the animation curve. 11965 11966 11967### OH_ArkUI_KeyframeAnimateOption_GetDelay() 11968 11969``` 11970int32_t OH_ArkUI_KeyframeAnimateOption_GetDelay (ArkUI_KeyframeAnimateOption * option) 11971``` 11972**Description** 11973 11974Obtains the overall delay of a keyframe animation 11975 11976**Since**: 12 11977 11978**Parameters** 11979 11980| Name| Description| 11981| -------- | -------- | 11982| option | Keyframe animation parameters. | 11983 11984**Returns** 11985 11986Returns the overall delay. 11987 11988 11989### OH_ArkUI_KeyframeAnimateOption_GetDuration() 11990 11991``` 11992int32_t OH_ArkUI_KeyframeAnimateOption_GetDuration (ArkUI_KeyframeAnimateOption * option, int32_t index ) 11993``` 11994**Description** 11995 11996Obtains the duration of a specific state in a keyframe animation. 11997 11998**Since**: 12 11999 12000**Parameters** 12001 12002| Name| Description| 12003| -------- | -------- | 12004| option | Keyframe animation parameters. | 12005| index | Status index. | 12006 12007**Returns** 12008 12009Duration, in milliseconds. 12010 12011 12012### OH_ArkUI_KeyframeAnimateOption_GetIterations() 12013 12014``` 12015int32_t OH_ArkUI_KeyframeAnimateOption_GetIterations (ArkUI_KeyframeAnimateOption * option) 12016``` 12017**Description** 12018 12019Obtains the number of times that a keyframe animation is played. 12020 12021**Since**: 12 12022 12023**Parameters** 12024 12025| Name| Description| 12026| -------- | -------- | 12027| option | Keyframe animation parameters. | 12028 12029**Returns** 12030 12031Returns the number of times that the animation is played. 12032 12033### OH_ArkUI_KeyframeAnimateOption_GetExpectedFrameRate() 12034 12035``` 12036ArkUI_ExpectedFrameRateRange* OH_ArkUI_KeyframeAnimateOption_GetExpectedFrameRate(ArkUI_KeyframeAnimateOption* option) 12037``` 12038**Description** 12039 12040Obtains the expected frame rate from keyframe animation parameters. 12041 12042**Since**: 16 12043 12044**Parameters** 12045 12046| Name| Description| 12047| -------- | -------- | 12048| option | Keyframe animation parameters. | 12049 12050**Returns** 12051 12052Returns the expected frame rate obtained. 12053 12054 12055### OH_ArkUI_KeyframeAnimateOption_RegisterOnEventCallback() 12056 12057``` 12058int32_t OH_ArkUI_KeyframeAnimateOption_RegisterOnEventCallback (ArkUI_KeyframeAnimateOption * option, void * userData, void(*)(void *userData) event, int32_t index ) 12059``` 12060**Description** 12061 12062Sets 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. 12063 12064**Parameters** 12065 12066| Name| Description| 12067| -------- | -------- | 12068| option | Keyframe animation parameters. | 12069| event | Closure function. | 12070| userData | Pointer to a custom object. | 12071| index | Status index. | 12072 12073**Returns** 12074 12075Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12076 12077 12078### OH_ArkUI_KeyframeAnimateOption_RegisterOnFinishCallback() 12079 12080``` 12081int32_t OH_ArkUI_KeyframeAnimateOption_RegisterOnFinishCallback (ArkUI_KeyframeAnimateOption * option, void * userData, void(*)(void *userData) onFinish ) 12082``` 12083**Description** 12084 12085Sets 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. 12086 12087**Parameters** 12088 12089| Name| Description| 12090| -------- | -------- | 12091| option | Keyframe animation parameters. | 12092| userData | Pointer to a custom object. | 12093| onFinish | Callback used to return the result. | 12094 12095**Returns** 12096 12097Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12098 12099 12100### OH_ArkUI_KeyframeAnimateOption_SetCurve() 12101 12102``` 12103int32_t OH_ArkUI_KeyframeAnimateOption_SetCurve (ArkUI_KeyframeAnimateOption * option, ArkUI_CurveHandle value, int32_t index ) 12104``` 12105**Description** 12106 12107Sets the animation curve for a specific keyframe in a keyframe animation. 12108 12109**Parameters** 12110 12111| Name| Description| 12112| -------- | -------- | 12113| option | Keyframe animation parameters. | 12114| value | Animation curve used by the key frame. Default value: **EASE_IN_OUT**. | 12115| index | Status index. | 12116 12117**NOTE** 12118 12119Because the **springMotion**, **responsiveSpringMotion**, and **interpolatingSpring** curves do not have effective duration settings, they are not supported. 12120 12121**Returns** 12122 12123Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12124 12125 12126### OH_ArkUI_KeyframeAnimateOption_SetDelay() 12127 12128``` 12129int32_t OH_ArkUI_KeyframeAnimateOption_SetDelay (ArkUI_KeyframeAnimateOption * option, int32_t value ) 12130``` 12131**Description** 12132 12133Sets the overall delay of a keyframe animation, in milliseconds. By default, the keyframe animation is played without delay. 12134 12135**Parameters** 12136 12137| Name| Description| 12138| -------- | -------- | 12139| option | Keyframe animation parameters. | 12140| value | Delay time, in milliseconds. | 12141 12142**Returns** 12143 12144Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12145 12146 12147### OH_ArkUI_KeyframeAnimateOption_SetDuration() 12148 12149``` 12150int32_t OH_ArkUI_KeyframeAnimateOption_SetDuration (ArkUI_KeyframeAnimateOption * option, int32_t value, int32_t index ) 12151``` 12152**Description** 12153 12154Sets the duration of a keyframe animation, in milliseconds. 12155 12156**Parameters** 12157 12158| Name| Description| 12159| -------- | -------- | 12160| option | Keyframe animation parameters. | 12161| value | Duration, in milliseconds. | 12162| index | Status index. | 12163 12164**Returns** 12165 12166Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12167 12168 12169### OH_ArkUI_KeyframeAnimateOption_SetIterations() 12170 12171``` 12172int32_t OH_ArkUI_KeyframeAnimateOption_SetIterations (ArkUI_KeyframeAnimateOption * option, int32_t value ) 12173``` 12174**Description** 12175 12176Sets 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. 12177 12178**Parameters** 12179 12180| Name| Description| 12181| -------- | -------- | 12182| option | Keyframe animation parameters. | 12183| value | Number of times that the animation is played. | 12184 12185**Returns** 12186 12187Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12188 12189### OH_ArkUI_KeyframeAnimateOption_SetExpectedFrameRate() 12190 12191``` 12192int32_t OH_ArkUI_KeyframeAnimateOption_SetExpectedFrameRate( 12193 ArkUI_KeyframeAnimateOption* option, ArkUI_ExpectedFrameRateRange* frameRate) 12194``` 12195**Description** 12196 12197Sets the expected frame rate for a keyframe animation. 12198 12199**Parameters** 12200 12201| Name| Description| 12202| -------- | -------- | 12203| option | Keyframe animation parameters. | 12204| frameRate | Expected frame rate to set. | 12205 12206**Returns** 12207 12208Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 12209Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12210 12211 12212### OH_ArkUI_LayoutConstraint_Copy() 12213 12214``` 12215ArkUI_LayoutConstraint* OH_ArkUI_LayoutConstraint_Copy (const ArkUI_LayoutConstraint * Constraint) 12216``` 12217**Description** 12218 12219Constraint size deep copy. 12220 12221**Since**: 12 12222 12223**Parameters** 12224 12225| Name| Description| 12226| -------- | -------- | 12227| Constraint | Size constraint. | 12228 12229**Returns** 12230 12231Pointer to the new constraint size. 12232 12233 12234### OH_ArkUI_LayoutConstraint_Create() 12235 12236``` 12237ArkUI_LayoutConstraint* OH_ArkUI_LayoutConstraint_Create () 12238``` 12239**Description** 12240 12241Create a constraint size. 12242 12243**Since**: 12 12244 12245 12246### OH_ArkUI_LayoutConstraint_Dispose() 12247 12248``` 12249void* OH_ArkUI_LayoutConstraint_Dispose (ArkUI_LayoutConstraint * Constraint) 12250``` 12251**Description** 12252 12253Pointer to the size of the destruction constraint. 12254 12255**Since**: 12 12256 12257**Parameters** 12258 12259| Name| Description| 12260| -------- | -------- | 12261| Constraint | Size constraint. | 12262 12263 12264### OH_ArkUI_LayoutConstraint_GetMaxHeight() 12265 12266``` 12267int32_t OH_ArkUI_LayoutConstraint_GetMaxHeight (const ArkUI_LayoutConstraint * Constraint) 12268``` 12269**Description** 12270 12271Obtains the maximum height for a size constraint, in px. 12272 12273**Since**: 12 12274 12275**Parameters** 12276 12277| Name| Description| 12278| -------- | -------- | 12279| Constraint | Size constraint. | 12280 12281**Returns** 12282 12283Maximum height. 12284 12285 12286### OH_ArkUI_LayoutConstraint_GetMaxWidth() 12287 12288``` 12289int32_t OH_ArkUI_LayoutConstraint_GetMaxWidth (const ArkUI_LayoutConstraint * Constraint) 12290``` 12291**Description** 12292 12293Obtains the maximum width for a size constraint, in px. 12294 12295**Since**: 12 12296 12297**Parameters** 12298 12299| Name| Description| 12300| -------- | -------- | 12301| Constraint | Size constraint. | 12302 12303**Returns** 12304 12305Maximum width. 12306 12307 12308### OH_ArkUI_LayoutConstraint_GetMinHeight() 12309 12310``` 12311int32_t OH_ArkUI_LayoutConstraint_GetMinHeight (const ArkUI_LayoutConstraint * Constraint) 12312``` 12313**Description** 12314 12315Obtains the minimum height for a size constraint, in px. 12316 12317**Since**: 12 12318 12319**Parameters** 12320 12321| Name| Description| 12322| -------- | -------- | 12323| Constraint | Size constraint. | 12324 12325**Returns** 12326 12327Minimum Height 12328 12329 12330### OH_ArkUI_LayoutConstraint_GetMinWidth() 12331 12332``` 12333int32_t OH_ArkUI_LayoutConstraint_GetMinWidth (const ArkUI_LayoutConstraint * Constraint) 12334``` 12335**Description** 12336 12337Obtains the minimum width for a size constraint, in px. 12338 12339**Since**: 12 12340 12341**Parameters** 12342 12343| Name| Description| 12344| -------- | -------- | 12345| Constraint | Size constraint. | 12346 12347**Returns** 12348 12349Minimum Width 12350 12351 12352### OH_ArkUI_LayoutConstraint_GetPercentReferenceHeight() 12353 12354``` 12355int32_t OH_ArkUI_LayoutConstraint_GetPercentReferenceHeight (const ArkUI_LayoutConstraint * Constraint) 12356``` 12357**Description** 12358 12359Obtains the height percentage reference for a size constraint, in px. 12360 12361**Since**: 12 12362 12363**Parameters** 12364 12365| Name| Description| 12366| -------- | -------- | 12367| Constraint | Size constraint. | 12368 12369**Returns** 12370 12371Height percentage benchmark. 12372 12373 12374### OH_ArkUI_LayoutConstraint_GetPercentReferenceWidth() 12375 12376``` 12377int32_t OH_ArkUI_LayoutConstraint_GetPercentReferenceWidth (const ArkUI_LayoutConstraint * Constraint) 12378``` 12379**Description** 12380 12381Obtains the width percentage reference for a size constraint, in px. 12382 12383**Since**: 12 12384 12385**Parameters** 12386 12387| Name| Description| 12388| -------- | -------- | 12389| Constraint | Size constraint. | 12390 12391**Returns** 12392 12393Width percentage reference. 12394 12395 12396### OH_ArkUI_LayoutConstraint_SetMaxHeight() 12397 12398``` 12399void OH_ArkUI_LayoutConstraint_SetMaxHeight (ArkUI_LayoutConstraint * Constraint, int32_t value ) 12400``` 12401**Description** 12402 12403Sets the maximum height. 12404 12405**Since**: 12 12406 12407**Parameters** 12408 12409| Name| Description| 12410| -------- | -------- | 12411| Constraint | Size constraint. | 12412| value | Maximum height, in pixels. | 12413 12414 12415### OH_ArkUI_LayoutConstraint_SetMaxWidth() 12416 12417``` 12418void OH_ArkUI_LayoutConstraint_SetMaxWidth (ArkUI_LayoutConstraint * Constraint, int32_t value ) 12419``` 12420**Description** 12421 12422Sets the maximum width. 12423 12424**Since**: 12 12425 12426**Parameters** 12427 12428| Name| Description| 12429| -------- | -------- | 12430| Constraint | Size constraint. | 12431| value | Maximum width, in pixels. | 12432 12433 12434### OH_ArkUI_LayoutConstraint_SetMinHeight() 12435 12436``` 12437void OH_ArkUI_LayoutConstraint_SetMinHeight (ArkUI_LayoutConstraint * Constraint, int32_t value ) 12438``` 12439**Description** 12440 12441Sets the minimum height. 12442 12443**Since**: 12 12444 12445**Parameters** 12446 12447| Name| Description| 12448| -------- | -------- | 12449| Constraint | Size constraint. | 12450| value | Minimum height, in pixels. | 12451 12452 12453### OH_ArkUI_LayoutConstraint_SetMinWidth() 12454 12455``` 12456void OH_ArkUI_LayoutConstraint_SetMinWidth (ArkUI_LayoutConstraint * Constraint, int32_t value ) 12457``` 12458**Description** 12459 12460Sets the minimum width. 12461 12462**Since**: 12 12463 12464**Parameters** 12465 12466| Name| Description| 12467| -------- | -------- | 12468| Constraint | Size constraint. | 12469| value | Minimum width, in pixels. | 12470 12471 12472### OH_ArkUI_LayoutConstraint_SetPercentReferenceHeight() 12473 12474``` 12475void OH_ArkUI_LayoutConstraint_SetPercentReferenceHeight (ArkUI_LayoutConstraint * Constraint, int32_t value ) 12476``` 12477**Description** 12478 12479Sets the height percentage reference. 12480 12481**Since**: 12 12482 12483**Parameters** 12484 12485| Name| Description| 12486| -------- | -------- | 12487| Constraint | Size constraint. | 12488| value | Height percentage base, in px. | 12489 12490 12491### OH_ArkUI_LayoutConstraint_SetPercentReferenceWidth() 12492 12493``` 12494void OH_ArkUI_LayoutConstraint_SetPercentReferenceWidth (ArkUI_LayoutConstraint * Constraint, int32_t value ) 12495``` 12496**Description** 12497 12498Sets the width percentage reference. 12499 12500**Since**: 12 12501 12502**Parameters** 12503 12504| Name| Description| 12505| -------- | -------- | 12506| Constraint | Size constraint. | 12507| value | Width percentage benchmark, in px. | 12508 12509 12510### OH_ArkUI_List_CloseAllSwipeActions() 12511 12512``` 12513int32_t OH_ArkUI_List_CloseAllSwipeActions (ArkUI_NodeHandle node, void * userData, void(*)(void *userData) onFinish ) 12514``` 12515**Description** 12516 12517Collapse the expanded ListItem. 12518 12519**Since**: 12 12520 12521**Parameters** 12522 12523| Name| Description| 12524| -------- | -------- | 12525| node | Node object for which an event needs to be registered. | 12526| userData | Custom event parameter, which is passed in the callback when the event is triggered. | 12527| onFinish | Callback triggered after the collapse animation is complete. | 12528 12529**Returns** 12530 12531Returns **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. 12532 12533 12534### OH_ArkUI_ListChildrenMainSizeOption_Create() 12535 12536``` 12537ArkUI_ListChildrenMainSize* OH_ArkUI_ListChildrenMainSizeOption_Create () 12538``` 12539**Description** 12540 12541Creates a **ListChildrenMainSize** instance. 12542 12543**Since**: 12 12544 12545**Returns** 12546 12547Returns the created **ListChildrenMainSize** instance. 12548 12549### OH_ArkUI_ListChildrenMainSizeOption_Dispose() 12550 12551``` 12552void OH_ArkUI_ListChildrenMainSizeOption_Dispose (ArkUI_ListChildrenMainSize * option) 12553``` 12554**Description** 12555 12556Destroys a ListChildrenMainSize instance. 12557 12558**Since**: 12 12559 12560**Parameters** 12561 12562| Name| Description| 12563| -------- | -------- | 12564| option | ListChildrenMainSize instance to be destroyed. | 12565 12566 12567### OH_ArkUI_ListChildrenMainSizeOption_GetDefaultMainSize() 12568 12569``` 12570float OH_ArkUI_ListChildrenMainSizeOption_GetDefaultMainSize (ArkUI_ListChildrenMainSize * option) 12571``` 12572**Description** 12573 12574Obtains the default size in a **ListChildrenMainSize** instance. 12575 12576**Since**: 12 12577 12578**Parameters** 12579 12580| Name| Description| 12581| -------- | -------- | 12582| option | **ListChildrenMainSize** instance. | 12583 12584**Returns** 12585 12586Returns the default size, in vp. The default value is **0**. If **option** is a null pointer, **-1** is returned. 12587 12588 12589### OH_ArkUI_ListChildrenMainSizeOption_GetMainSize() 12590 12591``` 12592float OH_ArkUI_ListChildrenMainSizeOption_GetMainSize (ArkUI_ListChildrenMainSize * option, int32_t index ) 12593``` 12594**Description** 12595 12596Obtains the value of the **ChildrenMainSizeOption** array of the **List** component. 12597 12598**Since**: 12 12599 12600**Parameters** 12601 12602| Name| Description| 12603| -------- | -------- | 12604| option | **ListChildrenMainSize** instance. | 12605| index | Subscript position of the value to be obtained. | 12606 12607**Returns** 12608 12609Value of the specific position of the array. If a parameter error occurs, **-1** is returned. 12610 12611 12612### OH_ArkUI_ListChildrenMainSizeOption_Resize() 12613 12614``` 12615void OH_ArkUI_ListChildrenMainSizeOption_Resize (ArkUI_ListChildrenMainSize * option, int32_t totalSize ) 12616``` 12617**Description** 12618 12619Resets the array size of ChildrenMainSizeOption of the List component. 12620 12621**Since**: 12 12622 12623**Parameters** 12624 12625| Name| Description| 12626| -------- | -------- | 12627| option | **ListChildrenMainSize** instance. | 12628| totalSize | Array size. | 12629 12630 12631### OH_ArkUI_ListChildrenMainSizeOption_SetDefaultMainSize() 12632 12633``` 12634int32_t OH_ArkUI_ListChildrenMainSizeOption_SetDefaultMainSize (ArkUI_ListChildrenMainSize * option, float defaultMainSize ) 12635``` 12636**Description** 12637 12638Sets the default size in a **ListChildrenMainSize** instance. 12639 12640**Since**: 12 12641 12642**Parameters** 12643 12644| Name| Description| 12645| -------- | -------- | 12646| option | **ListChildrenMainSize** instance. | 12647| defaultMainSize | Default size of a list item in a list. The unit is vp. | 12648 12649**Returns** 12650 12651Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12652 12653 12654### OH_ArkUI_ListChildrenMainSizeOption_Splice() 12655 12656``` 12657int32_t OH_ArkUI_ListChildrenMainSizeOption_Splice (ArkUI_ListChildrenMainSize * option, int32_t index, int32_t deleteCount, int32_t addCount ) 12658``` 12659**Description** 12660 12661The size of the ChildrenMainSizeOption array of the List component is adjusted. 12662 12663**Since**: 12 12664 12665**Parameters** 12666 12667| Name| Description| 12668| -------- | -------- | 12669| option | **ListChildrenMainSize** instance. | 12670| index | Start position of the array whose MainSize is to be modified. | 12671| deleteCount | Number of MainSize arrays to be deleted starting from index. | 12672| addCount | Number of MainSize arrays to be added starting from index. | 12673 12674**Returns** 12675 12676Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12677 12678 12679### OH_ArkUI_ListChildrenMainSizeOption_UpdateSize() 12680 12681``` 12682int32_t OH_ArkUI_ListChildrenMainSizeOption_UpdateSize (ArkUI_ListChildrenMainSize * option, int32_t index, float mainSize ) 12683``` 12684**Description** 12685 12686Updates the values in a **ChildrenMainSizeOption** array of a **List** component. 12687 12688**Since**: 12 12689 12690**Parameters** 12691 12692| Name| Description| 12693| -------- | -------- | 12694| option | **ListChildrenMainSize** instance. | 12695| index | Index at which to start changing the values in the array. | 12696| mainSize | New size value to set at the specified index. | 12697 12698**Returns** 12699 12700Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12701 12702 12703### OH_ArkUI_ListItemSwipeActionItem_Create() 12704 12705``` 12706ArkUI_ListItemSwipeActionItem* OH_ArkUI_ListItemSwipeActionItem_Create () 12707``` 12708**Description** 12709 12710Creates a **ListItemSwipeActionItem** instance. 12711 12712**Since**: 12 12713 12714**Returns** 12715 12716Returns the created **ListItemSwipeActionItem** instance. 12717 12718 12719### OH_ArkUI_ListItemSwipeActionItem_Dispose() 12720 12721``` 12722void OH_ArkUI_ListItemSwipeActionItem_Dispose (ArkUI_ListItemSwipeActionItem * item) 12723``` 12724**Description** 12725 12726Disposes of a **ListItemSwipeActionItem** instance. 12727 12728**Since**: 12 12729 12730**Parameters** 12731 12732| Name| Description| 12733| -------- | -------- | 12734| item | **ListItemSwipeActionItem** instance to dispose of. | 12735 12736 12737### OH_ArkUI_ListItemSwipeActionItem_GetActionAreaDistance() 12738 12739``` 12740float OH_ArkUI_ListItemSwipeActionItem_GetActionAreaDistance (ArkUI_ListItemSwipeActionItem * item) 12741``` 12742**Description** 12743 12744Obtains the swipe distance threshold for deleting the list item. 12745 12746**Since**: 12 12747 12748**Parameters** 12749 12750| Name| Description| 12751| -------- | -------- | 12752| item | Target **ListItemSwipeActionItem** instance. | 12753 12754**Returns** 12755 12756Returns the swipe distance threshold for deleting the list item. Return **0** if an error occurs. 12757 12758 12759### OH_ArkUI_ListItemSwipeActionItem_SetActionAreaDistance() 12760 12761``` 12762void OH_ArkUI_ListItemSwipeActionItem_SetActionAreaDistance (ArkUI_ListItemSwipeActionItem * item, float distance ) 12763``` 12764**Description** 12765 12766Swipe distance threshold for deleting the list item. 12767 12768**Since**: 12 12769 12770**Parameters** 12771 12772| Name| Description| 12773| -------- | -------- | 12774| item | Target **ListItemSwipeActionItem** instance. | 12775| distance | Returns the swipe distance threshold for deleting the list item. | 12776 12777 12778### OH_ArkUI_ListItemSwipeActionItem_SetContent() 12779 12780``` 12781void OH_ArkUI_ListItemSwipeActionItem_SetContent (ArkUI_ListItemSwipeActionItem * item, ArkUI_NodeHandle node ) 12782``` 12783**Description** 12784 12785Sets the layout content of ListItemSwipeActionItem. 12786 12787**Since**: 12 12788 12789**Parameters** 12790 12791| Name| Description| 12792| -------- | -------- | 12793| item | Target **ListItemSwipeActionItem** instance. | 12794| node | Layout information | 12795 12796 12797### OH_ArkUI_ListItemSwipeActionItem_SetOnAction() 12798 12799``` 12800void OH_ArkUI_ListItemSwipeActionItem_SetOnAction (ArkUI_ListItemSwipeActionItem * item, void(*)() callback ) 12801``` 12802**Description** 12803 12804Sets the callback invoked when the list item is deleted while in the delete area. 12805 12806**Since**: 12 12807 12808**Parameters** 12809 12810| Name| Description| 12811| -------- | -------- | 12812| item | Target **ListItemSwipeActionItem** instance. | 12813| callback | Callback to invoke when an event of the specified type occurs. | 12814 12815 12816### OH_ArkUI_ListItemSwipeActionItem_SetOnActionWithUserData() 12817 12818``` 12819void OH_ArkUI_ListItemSwipeActionItem_SetOnActionWithUserData (ArkUI_ListItemSwipeActionItem * item, void * userData, void(*)(void *userData) callback ) 12820``` 12821**Description** 12822 12823Sets the callback invoked when the list item is deleted while in the delete area. 12824 12825**Since**: 12 12826 12827**Parameters** 12828 12829| Name| Description| 12830| -------- | -------- | 12831| item | Target **ListItemSwipeActionItem** instance. | 12832| userData | Custom data. | 12833| callback | Callback to invoke when an event of the specified type occurs. | 12834 12835 12836### OH_ArkUI_ListItemSwipeActionItem_SetOnEnterActionArea() 12837 12838``` 12839void OH_ArkUI_ListItemSwipeActionItem_SetOnEnterActionArea (ArkUI_ListItemSwipeActionItem * item, void(*)() callback ) 12840``` 12841**Description** 12842 12843Sets the callback invoked each time the list item enters the delete area. 12844 12845**Since**: 12 12846 12847**Parameters** 12848 12849| Name| Description| 12850| -------- | -------- | 12851| item | Target **ListItemSwipeActionItem** instance. | 12852| callback | Callback to invoke when an event of the specified type occurs. | 12853 12854 12855### OH_ArkUI_ListItemSwipeActionItem_SetOnEnterActionAreaWithUserData() 12856 12857``` 12858void OH_ArkUI_ListItemSwipeActionItem_SetOnEnterActionAreaWithUserData (ArkUI_ListItemSwipeActionItem * item, void * userData, void(*)(void *userData) callback ) 12859``` 12860**Description** 12861 12862Sets the callback invoked each time the list item enters the delete area. 12863 12864**Since**: 12 12865 12866**Parameters** 12867 12868| Name| Description| 12869| -------- | -------- | 12870| item | Target **ListItemSwipeActionItem** instance. | 12871| userData | Custom data. | 12872| callback | Callback to invoke when an event of the specified type occurs. | 12873 12874 12875### OH_ArkUI_ListItemSwipeActionItem_SetOnExitActionArea() 12876 12877``` 12878void OH_ArkUI_ListItemSwipeActionItem_SetOnExitActionArea (ArkUI_ListItemSwipeActionItem * item, void(*)() callback ) 12879``` 12880**Description** 12881 12882Sets the callback invoked each time the list item exits the delete area. 12883 12884**Since**: 12 12885 12886**Parameters** 12887 12888| Name| Description| 12889| -------- | -------- | 12890| item | Target **ListItemSwipeActionItem** instance. | 12891| callback | Callback to invoke when an event of the specified type occurs. | 12892 12893 12894### OH_ArkUI_ListItemSwipeActionItem_SetOnExitActionAreaWithUserData() 12895 12896``` 12897void OH_ArkUI_ListItemSwipeActionItem_SetOnExitActionAreaWithUserData (ArkUI_ListItemSwipeActionItem * item, void * userData, void(*)(void *userData) callback ) 12898``` 12899**Description** 12900 12901Sets the callback invoked each time the list item exits the delete area. 12902 12903**Since**: 12 12904 12905**Parameters** 12906 12907| Name| Description| 12908| -------- | -------- | 12909| item | Target **ListItemSwipeActionItem** instance. | 12910| userData | Custom data. | 12911| callback | Callback to invoke when an event of the specified type occurs. | 12912 12913 12914### OH_ArkUI_ListItemSwipeActionItem_SetOnStateChange() 12915 12916``` 12917void OH_ArkUI_ListItemSwipeActionItem_SetOnStateChange (ArkUI_ListItemSwipeActionItem * item, void(*)(ArkUI_ListItemSwipeActionState swipeActionState) callback ) 12918``` 12919**Description** 12920 12921Sets the callback invoked when the swipe state of the list item changes. 12922 12923**Since**: 12 12924 12925**Parameters** 12926 12927| Name| Description| 12928| -------- | -------- | 12929| item | Target **ListItemSwipeActionItem** instance. | 12930| callback | Status after the callback event swipeActionState changes. | 12931 12932 12933### OH_ArkUI_ListItemSwipeActionItem_SetOnStateChangeWithUserData() 12934 12935``` 12936void OH_ArkUI_ListItemSwipeActionItem_SetOnStateChangeWithUserData (ArkUI_ListItemSwipeActionItem * item, void * userData, void(*)(ArkUI_ListItemSwipeActionState swipeActionState, void *userData) callback ) 12937``` 12938**Description** 12939 12940Sets the callback invoked when the swipe state of the list item changes. 12941 12942**Since**: 12 12943 12944**Parameters** 12945 12946| Name| Description| 12947| -------- | -------- | 12948| item | Target **ListItemSwipeActionItem** instance. | 12949| userData | Custom data. | 12950| callback | Status after the callback event swipeActionState changes. | 12951 12952 12953### OH_ArkUI_ListItemSwipeActionOption_Create() 12954 12955``` 12956ArkUI_ListItemSwipeActionOption* OH_ArkUI_ListItemSwipeActionOption_Create () 12957``` 12958**Description** 12959 12960Creates a **ListItemSwipeActionOption** instance. 12961 12962**Since**: 12 12963 12964**Returns** 12965 12966ListItemSwipeActionOption configuration item instance. 12967 12968 12969### OH_ArkUI_ListItemSwipeActionOption_Dispose() 12970 12971``` 12972void OH_ArkUI_ListItemSwipeActionOption_Dispose (ArkUI_ListItemSwipeActionOption * option) 12973``` 12974**Description** 12975 12976Destroys a ListItemSwipeActionOption instance. 12977 12978**Since**: 12 12979 12980**Parameters** 12981 12982| Name| Description| 12983| -------- | -------- | 12984| option | ListItemSwipeActionOption instance to destroy. | 12985 12986 12987### OH_ArkUI_ListItemSwipeActionOption_GetEdgeEffect() 12988 12989``` 12990int32_t OH_ArkUI_ListItemSwipeActionOption_GetEdgeEffect (ArkUI_ListItemSwipeActionOption * option) 12991``` 12992**Description** 12993 12994Obtains the sliding effect. 12995 12996**Since**: 12 12997 12998**Parameters** 12999 13000| Name| Description| 13001| -------- | -------- | 13002| option | Target **ListItemSwipeActionItem** instance. | 13003 13004**Returns** 13005 13006Scroll effect. The default return value is **ARKUI_LIST_ITEM_SWIPE_EDGE_EFFECT_SPRING**. 13007 13008 13009### OH_ArkUI_ListItemSwipeActionOption_SetEdgeEffect() 13010 13011``` 13012void OH_ArkUI_ListItemSwipeActionOption_SetEdgeEffect (ArkUI_ListItemSwipeActionOption * option, ArkUI_ListItemSwipeEdgeEffect edgeEffect ) 13013``` 13014**Description** 13015 13016Sets the sliding effect. 13017 13018**Since**: 12 13019 13020**Parameters** 13021 13022| Name| Description| 13023| -------- | -------- | 13024| option | Target **ListItemSwipeActionItem** instance. | 13025| edgeEffect | Scroll effect. | 13026 13027 13028### OH_ArkUI_ListItemSwipeActionOption_SetEnd() 13029 13030``` 13031void OH_ArkUI_ListItemSwipeActionOption_SetEnd (ArkUI_ListItemSwipeActionOption * option, ArkUI_ListItemSwipeActionItem * item ) 13032``` 13033**Description** 13034 13035Sets the layout content for the right edge (for a vertical layout) or bottom edge (for a horizontal layout) of a **ListItemSwipeActionItem** instance. 13036 13037**Since**: 12 13038 13039**Parameters** 13040 13041| Name| Description| 13042| -------- | -------- | 13043| option | Target **ListItemSwipeActionItem** instance. | 13044| builder | Layout information | 13045 13046 13047### OH_ArkUI_ListItemSwipeActionOption_SetOnOffsetChange() 13048 13049``` 13050void OH_ArkUI_ListItemSwipeActionOption_SetOnOffsetChange (ArkUI_ListItemSwipeActionOption * option, void(*)(float offset) callback ) 13051``` 13052**Description** 13053 13054Sets the callback invoked when the scroll offset changes. 13055 13056**Since**: 12 13057 13058**Parameters** 13059 13060| Name| Description| 13061| -------- | -------- | 13062| option | Target **ListItemSwipeActionItem** instance. | 13063| callback | Sliding offset of the callback event offset. | 13064 13065 13066### OH_ArkUI_ListItemSwipeActionOption_SetOnOffsetChangeWithUserData() 13067 13068``` 13069void OH_ArkUI_ListItemSwipeActionOption_SetOnOffsetChangeWithUserData (ArkUI_ListItemSwipeActionOption * option, void * userData, void(*)(float offset, void *userData) callback ) 13070``` 13071**Description** 13072 13073Sets the callback invoked when the scroll offset changes. 13074 13075**Since**: 12 13076 13077**Parameters** 13078 13079| Name| Description| 13080| -------- | -------- | 13081| option | Target **ListItemSwipeActionItem** instance. | 13082| userData | Custom data. | 13083| callback | Sliding offset of the callback event offset. | 13084 13085 13086### OH_ArkUI_ListItemSwipeActionOption_SetStart() 13087 13088``` 13089void OH_ArkUI_ListItemSwipeActionOption_SetStart (ArkUI_ListItemSwipeActionOption * option, ArkUI_ListItemSwipeActionItem * item ) 13090``` 13091**Description** 13092 13093Sets the layout content for the left edge (for a vertical layout) or top edge (for a horizontal layout) of a **ListItemSwipeActionItem** instance. 13094 13095**Since**: 12 13096 13097**Parameters** 13098 13099| Name| Description| 13100| -------- | -------- | 13101| option | Target **ListItemSwipeActionItem** instance. | 13102| builder | Layout information | 13103 13104 13105### OH_ArkUI_LongPress_GetRepeatCount() 13106 13107``` 13108int32_t OH_ArkUI_LongPress_GetRepeatCount (const ArkUI_GestureEvent * event) 13109``` 13110**Description** 13111 13112Obtains the number of times that a long press gesture is triggered periodically. 13113 13114**Since**: 12 13115 13116**Parameters** 13117 13118| Name| Description| 13119| -------- | -------- | 13120| event | Gesture event. | 13121 13122**Returns** 13123 13124Returns the number of times that the long press gesture is triggered periodically. 13125 13126 13127### OH_ArkUI_MarshallStyledStringDescriptor() 13128 13129``` 13130int32_t OH_ArkUI_MarshallStyledStringDescriptor (uint8_t * buffer, size_t bufferSize, ArkUI_StyledString_Descriptor * descriptor ) 13131``` 13132**Description** 13133 13134Serializes the styled string information into a byte array. 13135 13136**Since**: 14 13137 13138**Parameters** 13139 13140| Name| Description| 13141| -------- | -------- | 13142| buffer | Byte array where the serialized data will be stored. | 13143| bufferSize | Length of the byte array. | 13144| descriptor | Pointer to an **ArkUI_StyledString_Descriptor** object. | 13145 13146**Returns** 13147 13148Returns **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. 13149 13150 13151### OH_ArkUI_NodeAdapter_Create() 13152 13153``` 13154ArkUI_NodeAdapterHandle OH_ArkUI_NodeAdapter_Create () 13155``` 13156**Description** 13157 13158Creates a component adapter. 13159 13160**Since**: 12 13161 13162 13163### OH_ArkUI_NodeAdapter_Dispose() 13164 13165``` 13166void OH_ArkUI_NodeAdapter_Dispose (ArkUI_NodeAdapterHandle handle) 13167``` 13168**Description** 13169 13170Destroys a component adapter. 13171 13172**Since**: 12 13173 13174**Parameters** 13175 13176| Name| Description| 13177| -------- | -------- | 13178| handle | Component adapter object. | 13179 13180 13181### OH_ArkUI_NodeAdapter_GetAllItems() 13182 13183``` 13184int32_t OH_ArkUI_NodeAdapter_GetAllItems (ArkUI_NodeAdapterHandle handle, ArkUI_NodeHandle ** items, uint32_t * size ) 13185``` 13186**Description** 13187 13188Obtains all elements stored in the specified adapter. 13189 13190When 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. 13191 13192**Since**: 12 13193 13194**Parameters** 13195 13196| Name| Description| 13197| -------- | -------- | 13198| handle | Component adapter object. | 13199| items | Array of nodes in the adapter. | 13200| size | Number of elements. | 13201 13202**Returns** 13203 13204Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13205 13206 13207### OH_ArkUI_NodeAdapter_GetTotalNodeCount() 13208 13209``` 13210uint32_t OH_ArkUI_NodeAdapter_GetTotalNodeCount (ArkUI_NodeAdapterHandle handle) 13211``` 13212**Description** 13213 13214Obtains the total number of elements in the Adapter. 13215 13216**Since**: 12 13217 13218**Parameters** 13219 13220| Name| Description| 13221| -------- | -------- | 13222| handle | Component adapter object. | 13223 13224**Returns** 13225 13226Total number of elements in the Adapter. 13227 13228 13229### OH_ArkUI_NodeAdapter_InsertItem() 13230 13231``` 13232int32_t OH_ArkUI_NodeAdapter_InsertItem (ArkUI_NodeAdapterHandle handle, uint32_t startPosition, uint32_t itemCount ) 13233``` 13234**Description** 13235 13236Instructs the specified adapter to insert certain elements. 13237 13238**Since**: 12 13239 13240**Parameters** 13241 13242| Name| Description| 13243| -------- | -------- | 13244| handle | Component adapter object. | 13245| startPosition | Start position for inserting an element. | 13246| itemCount | Number of inserted elements. | 13247 13248**Returns** 13249 13250Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13251 13252 13253### OH_ArkUI_NodeAdapter_MoveItem() 13254 13255``` 13256int32_t OH_ArkUI_NodeAdapter_MoveItem (ArkUI_NodeAdapterHandle handle, uint32_t from, uint32_t to ) 13257``` 13258**Description** 13259 13260Instructs the specified adapter to move certain elements. 13261 13262**Since**: 12 13263 13264**Parameters** 13265 13266| Name| Description| 13267| -------- | -------- | 13268| handle | Component adapter object. | 13269| from | Start position of the element shift. | 13270| to | End position of the element shift. | 13271 13272**Returns** 13273 13274Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13275 13276 13277### OH_ArkUI_NodeAdapter_RegisterEventReceiver() 13278 13279``` 13280int32_t OH_ArkUI_NodeAdapter_RegisterEventReceiver (ArkUI_NodeAdapterHandle handle, void * userData, void(*)(ArkUI_NodeAdapterEvent *event) receiver ) 13281``` 13282**Description** 13283 13284Registers callback events related to the Adapter. 13285 13286**Since**: 12 13287 13288**Parameters** 13289 13290| Name| Description| 13291| -------- | -------- | 13292| handle | Component adapter object. | 13293| userData | Custom data. | 13294| receiver | Event receiving callback. | 13295 13296**Returns** 13297 13298Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13299 13300 13301### OH_ArkUI_NodeAdapter_ReloadAllItems() 13302 13303``` 13304int32_t OH_ArkUI_NodeAdapter_ReloadAllItems (ArkUI_NodeAdapterHandle handle) 13305``` 13306**Description** 13307 13308Instructs the specified adapter to reload all elements. 13309 13310**Since**: 12 13311 13312**Parameters** 13313 13314| Name| Description| 13315| -------- | -------- | 13316| handle | Component adapter object. | 13317 13318**Returns** 13319 13320Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13321 13322 13323### OH_ArkUI_NodeAdapter_ReloadItem() 13324 13325``` 13326int32_t OH_ArkUI_NodeAdapter_ReloadItem (ArkUI_NodeAdapterHandle handle, uint32_t startPosition, uint32_t itemCount ) 13327``` 13328**Description** 13329 13330Instructs the specified adapter to reload certain elements. 13331 13332**Since**: 12 13333 13334**Parameters** 13335 13336| Name| Description| 13337| -------- | -------- | 13338| handle | Component adapter object. | 13339| startPosition | Start position of an element change. | 13340| itemCount | Number of changed elements. | 13341 13342**Returns** 13343 13344Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13345 13346 13347### OH_ArkUI_NodeAdapter_RemoveItem() 13348 13349``` 13350int32_t OH_ArkUI_NodeAdapter_RemoveItem (ArkUI_NodeAdapterHandle handle, uint32_t startPosition, uint32_t itemCount ) 13351``` 13352**Description** 13353 13354Instructs the specified adapter to remove certain elements. 13355 13356**Since**: 12 13357 13358**Parameters** 13359 13360| Name| Description| 13361| -------- | -------- | 13362| handle | Component adapter object. | 13363| startPosition | Start position for deleting an element. | 13364| itemCount | Number of deleted elements. | 13365 13366**Returns** 13367 13368Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13369 13370 13371### OH_ArkUI_NodeAdapter_SetTotalNodeCount() 13372 13373``` 13374int32_t OH_ArkUI_NodeAdapter_SetTotalNodeCount (ArkUI_NodeAdapterHandle handle, uint32_t size ) 13375``` 13376**Description** 13377 13378Sets the total number of elements in the specified adapter. 13379 13380**Since**: 12 13381 13382**Parameters** 13383 13384| Name| Description| 13385| -------- | -------- | 13386| handle | Component adapter object. | 13387| size | Number of elements. | 13388 13389**Returns** 13390 13391Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13392 13393 13394### OH_ArkUI_NodeAdapter_UnregisterEventReceiver() 13395 13396``` 13397void OH_ArkUI_NodeAdapter_UnregisterEventReceiver (ArkUI_NodeAdapterHandle handle) 13398``` 13399**Description** 13400 13401Deregisters Adapter-related callback events. 13402 13403**Since**: 12 13404 13405**Parameters** 13406 13407| Name| Description| 13408| -------- | -------- | 13409| handle | Component adapter object. | 13410 13411 13412### OH_ArkUI_NodeAdapterEvent_GetHostNode() 13413 13414``` 13415ArkUI_NodeHandle OH_ArkUI_NodeAdapterEvent_GetHostNode (ArkUI_NodeAdapterEvent * event) 13416``` 13417**Description** 13418 13419Obtains the scrolling class container node that uses the adapter. 13420 13421**Since**: 12 13422 13423**Parameters** 13424 13425| Name| Description| 13426| -------- | -------- | 13427| event | Adapter event object. | 13428 13429**Returns** 13430 13431Returns the scrollable container node that uses the specified adapter. 13432 13433 13434### OH_ArkUI_NodeAdapterEvent_GetItemIndex() 13435 13436``` 13437uint32_t OH_ArkUI_NodeAdapterEvent_GetItemIndex (ArkUI_NodeAdapterEvent * event) 13438``` 13439**Description** 13440 13441Sequence number of the element to be operated when the adapter event is obtained. 13442 13443**Since**: 12 13444 13445**Parameters** 13446 13447| Name| Description| 13448| -------- | -------- | 13449| event | Adapter event object. | 13450 13451**Returns** 13452 13453Sequence number of an element. 13454 13455 13456### OH_ArkUI_NodeAdapterEvent_GetRemovedNode() 13457 13458``` 13459ArkUI_NodeHandle OH_ArkUI_NodeAdapterEvent_GetRemovedNode (ArkUI_NodeAdapterEvent * event) 13460``` 13461**Description** 13462 13463Obtains the element to be destroyed in the event to be destroyed. 13464 13465**Since**: 12 13466 13467**Parameters** 13468 13469| Name| Description| 13470| -------- | -------- | 13471| event | Adapter event object. | 13472 13473**Returns** 13474 13475Element to be destroyed. 13476 13477 13478### OH_ArkUI_NodeAdapterEvent_GetType() 13479 13480``` 13481ArkUI_NodeAdapterEventType OH_ArkUI_NodeAdapterEvent_GetType (ArkUI_NodeAdapterEvent * event) 13482``` 13483**Description** 13484 13485Obtains the event type. 13486 13487**Since**: 12 13488 13489**Parameters** 13490 13491| Name| Description| 13492| -------- | -------- | 13493| event | Adapter event object. | 13494 13495**Returns** 13496 13497Represents an event type. 13498 13499 13500### OH_ArkUI_NodeAdapterEvent_GetUserData() 13501 13502``` 13503void* OH_ArkUI_NodeAdapterEvent_GetUserData (ArkUI_NodeAdapterEvent * event) 13504``` 13505**Description** 13506 13507Obtains the custom data passed in during registration of the specified event. 13508 13509**Since**: 12 13510 13511**Parameters** 13512 13513| Name| Description| 13514| -------- | -------- | 13515| event | Adapter event object. | 13516 13517 13518### OH_ArkUI_NodeAdapterEvent_SetItem() 13519 13520``` 13521int32_t OH_ArkUI_NodeAdapterEvent_SetItem (ArkUI_NodeAdapterEvent * event, ArkUI_NodeHandle node ) 13522``` 13523**Description** 13524 13525Sets the component to be added to the specified adapter. 13526 13527**Since**: 12 13528 13529**Parameters** 13530 13531| Name| Description| 13532| -------- | -------- | 13533| event | Adapter event object. | 13534| node | Component to be added. | 13535 13536**Returns** 13537 13538Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13539 13540 13541### OH_ArkUI_NodeAdapterEvent_SetNodeId() 13542 13543``` 13544int32_t OH_ArkUI_NodeAdapterEvent_SetNodeId (ArkUI_NodeAdapterEvent * event, int32_t id ) 13545``` 13546**Description** 13547 13548Sets the generated component ID. 13549 13550**Since**: 12 13551 13552**Parameters** 13553 13554| Name| Description| 13555| -------- | -------- | 13556| event | Adapter event object. | 13557| id | Sets the returned component ID. | 13558 13559**Returns** 13560 13561Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13562 13563 13564### OH_ArkUI_NodeContent_AddNode() 13565 13566``` 13567int32_t OH_ArkUI_NodeContent_AddNode (ArkUI_NodeContentHandle content, ArkUI_NodeHandle node ) 13568``` 13569**Description** 13570 13571Adds an ArkUI component node to the specified NodeContent object. 13572 13573**Since**: 12 13574 13575**Parameters** 13576 13577| Name| Description| 13578| -------- | -------- | 13579| content | NodeContent object to which a node is to be added. | 13580| node | Node to be added. | 13581 13582**Returns** 13583 13584Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13585 13586 13587### OH_ArkUI_NodeContent_GetUserData() 13588 13589``` 13590void* OH_ArkUI_NodeContent_GetUserData (ArkUI_NodeContentHandle content) 13591``` 13592**Description** 13593 13594Obtains the user-defined data saved on the NodeContent object. 13595 13596**Since**: 12 13597 13598**Parameters** 13599 13600| Name| Description| 13601| -------- | -------- | 13602| content | NodeContent object whose user-defined data needs to be saved. | 13603 13604**Returns** 13605 13606Custom data. 13607 13608 13609### OH_ArkUI_NodeContent_InsertNode() 13610 13611``` 13612int32_t OH_ArkUI_NodeContent_InsertNode (ArkUI_NodeContentHandle content, ArkUI_NodeHandle node, int32_t position ) 13613``` 13614**Description** 13615 13616Inserts an ArkUI component node into a specific location of the corresponding NodeContent object. 13617 13618**Since**: 12 13619 13620**Parameters** 13621 13622| Name| Description| 13623| -------- | -------- | 13624| content | NodeContent object of the node to be inserted. | 13625| node | Node to be inserted. | 13626| position | Start time for an asset to be inserted, | 13627 13628**Returns** 13629 13630Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13631 13632 13633### OH_ArkUI_NodeContent_RegisterCallback() 13634 13635``` 13636int32_t OH_ArkUI_NodeContent_RegisterCallback (ArkUI_NodeContentHandle content, ArkUI_NodeContentCallback callback ) 13637``` 13638**Description** 13639 13640Registers the NodeContent event function. 13641 13642**Since**: 12 13643 13644**Parameters** 13645 13646| Name| Description| 13647| -------- | -------- | 13648| content | NodeContent object for which an event needs to be registered. | 13649| callback | Callback to be executed when the event is triggered. | 13650 13651**Returns** 13652 13653Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13654 13655 13656### OH_ArkUI_NodeContent_RemoveNode() 13657 13658``` 13659int32_t OH_ArkUI_NodeContent_RemoveNode (ArkUI_NodeContentHandle content, ArkUI_NodeHandle node ) 13660``` 13661**Description** 13662 13663Removes an ArkUI component node from the specified NodeContent object. 13664 13665**Since**: 12 13666 13667**Parameters** 13668 13669| Name| Description| 13670| -------- | -------- | 13671| content | NodeContent object of the node to be deleted. | 13672| node | Node to be deleted. | 13673 13674**Returns** 13675 13676Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13677 13678 13679### OH_ArkUI_NodeContent_SetUserData() 13680 13681``` 13682int32_t OH_ArkUI_NodeContent_SetUserData (ArkUI_NodeContentHandle content, void * userData ) 13683``` 13684**Description** 13685 13686Saves user-defined data on the NodeContent object. 13687 13688**Since**: 12 13689 13690**Parameters** 13691 13692| Name| Description| 13693| -------- | -------- | 13694| content | NodeContent object whose user-defined data needs to be saved. | 13695| userData | User-defined data to be saved. | 13696 13697**Returns** 13698 13699Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13700 13701 13702### OH_ArkUI_NodeContentEvent_GetEventType() 13703 13704``` 13705ArkUI_NodeContentEventType OH_ArkUI_NodeContentEvent_GetEventType (ArkUI_NodeContentEvent * event) 13706``` 13707**Description** 13708 13709Obtains the type of the specified NodeContent event. 13710 13711**Since**: 12 13712 13713**Parameters** 13714 13715| Name| Description| 13716| -------- | -------- | 13717| event | Pointer to the NodeContent event. | 13718 13719**Returns** 13720 13721NodeContent event type. 13722 13723 13724### OH_ArkUI_NodeContentEvent_GetNodeContentHandle() 13725 13726``` 13727ArkUI_NodeContentHandle OH_ArkUI_NodeContentEvent_GetNodeContentHandle (ArkUI_NodeContentEvent * event) 13728``` 13729**Description** 13730 13731Obtains the object that triggers the specified NodeContent event. 13732 13733**Since**: 12 13734 13735**Parameters** 13736 13737| Name| Description| 13738| -------- | -------- | 13739| event | Pointer to the NodeContent event. | 13740 13741**Returns** 13742 13743Returns the NodeContent object that triggers the event. 13744 13745 13746### OH_ArkUI_NodeCustomEvent_GetCustomSpanDrawInfo() 13747 13748``` 13749int32_t OH_ArkUI_NodeCustomEvent_GetCustomSpanDrawInfo (ArkUI_NodeCustomEvent * event, ArkUI_CustomSpanDrawInfo * info ) 13750``` 13751**Description** 13752 13753Obtains the drawing information of a custom span through a custom component event. 13754 13755**Since**: 12 13756 13757**Parameters** 13758 13759| Name| Description| 13760| -------- | -------- | 13761| event | Pointer to the custom component event. | 13762| info | Drawing information to obtain. | 13763 13764**Returns** 13765 13766Returns **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. 13767 13768 13769### OH_ArkUI_NodeCustomEvent_GetCustomSpanMeasureInfo() 13770 13771``` 13772int32_t OH_ArkUI_NodeCustomEvent_GetCustomSpanMeasureInfo (ArkUI_NodeCustomEvent * event, ArkUI_CustomSpanMeasureInfo * info ) 13773``` 13774**Description** 13775 13776Obtains the measurement information of a custom span through a custom component event. 13777 13778**Since**: 12 13779 13780**Parameters** 13781 13782| Name| Description| 13783| -------- | -------- | 13784| event | Pointer to the custom component event. | 13785| info | Measurement information to obtain. | 13786 13787**Returns** 13788 13789Returns **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. 13790 13791 13792### OH_ArkUI_NodeCustomEvent_GetDrawContextInDraw() 13793 13794``` 13795ArkUI_DrawContext* OH_ArkUI_NodeCustomEvent_GetDrawContextInDraw (ArkUI_NodeCustomEvent * event) 13796``` 13797**Description** 13798 13799Obtains the drawing context through a custom component event. 13800 13801**Since**: 12 13802 13803**Parameters** 13804 13805| Name| Description| 13806| -------- | -------- | 13807| event | Pointer to the custom component event. | 13808 13809**Returns** 13810 13811Returns the drawing context. 13812 13813 13814### OH_ArkUI_NodeCustomEvent_GetEventTargetId() 13815 13816``` 13817int32_t OH_ArkUI_NodeCustomEvent_GetEventTargetId (ArkUI_NodeCustomEvent * event) 13818``` 13819**Description** 13820 13821Obtains the ID of a custom component event. 13822 13823**Since**: 12 13824 13825**Parameters** 13826 13827| Name| Description| 13828| -------- | -------- | 13829| event | Pointer to the custom component event. | 13830 13831**Returns** 13832 13833Returns the custom event ID. 13834 13835 13836### OH_ArkUI_NodeCustomEvent_GetEventType() 13837 13838``` 13839ArkUI_NodeCustomEventType OH_ArkUI_NodeCustomEvent_GetEventType (ArkUI_NodeCustomEvent * event) 13840``` 13841**Description** 13842 13843Obtains the event type through a custom component event. 13844 13845**Since**: 12 13846 13847**Parameters** 13848 13849| Name| Description| 13850| -------- | -------- | 13851| event | Pointer to the custom component event. | 13852 13853**Returns** 13854 13855Returns the type of the custom component event. 13856 13857 13858### OH_ArkUI_NodeCustomEvent_GetLayoutConstraintInMeasure() 13859 13860``` 13861ArkUI_LayoutConstraint* OH_ArkUI_NodeCustomEvent_GetLayoutConstraintInMeasure (ArkUI_NodeCustomEvent * event) 13862``` 13863**Description** 13864 13865Obtains the size constraint for measurement through a custom component event. 13866 13867**Since**: 12 13868 13869**Parameters** 13870 13871| Name| Description| 13872| -------- | -------- | 13873| event | Pointer to the custom component event. | 13874 13875**Returns** 13876 13877Pointer to the constraint size. 13878 13879 13880### OH_ArkUI_NodeCustomEvent_GetNodeHandle() 13881 13882``` 13883ArkUI_NodeHandle OH_ArkUI_NodeCustomEvent_GetNodeHandle (ArkUI_NodeCustomEvent * event) 13884``` 13885**Description** 13886 13887Obtains a component object through a custom component event. 13888 13889**Since**: 12 13890 13891**Parameters** 13892 13893| Name| Description| 13894| -------- | -------- | 13895| event | Pointer to the custom component event. | 13896 13897**Returns** 13898 13899Returns the obtained component object. 13900 13901 13902### OH_ArkUI_NodeCustomEvent_GetPositionInLayout() 13903 13904``` 13905ArkUI_IntOffset OH_ArkUI_NodeCustomEvent_GetPositionInLayout (ArkUI_NodeCustomEvent * event) 13906``` 13907**Description** 13908 13909Obtains the expected position of a component relative to its parent component in the layout phase through a custom component event. 13910 13911**Since**: 12 13912 13913**Parameters** 13914 13915| Name| Description| 13916| -------- | -------- | 13917| event | Pointer to the custom component event. | 13918 13919**Returns** 13920 13921Returns the expected position relative to the parent component. 13922 13923 13924### OH_ArkUI_NodeCustomEvent_GetUserData() 13925 13926``` 13927void* OH_ArkUI_NodeCustomEvent_GetUserData (ArkUI_NodeCustomEvent * event) 13928``` 13929**Description** 13930 13931Obtains custom event parameters through a custom component event. 13932 13933**Since**: 12 13934 13935**Parameters** 13936 13937| Name| Description| 13938| -------- | -------- | 13939| event | Pointer to the custom component event. | 13940 13941**Returns** 13942 13943Returns the custom event parameters. 13944 13945 13946### OH_ArkUI_NodeCustomEvent_SetCustomSpanMetrics() 13947 13948``` 13949int32_t OH_ArkUI_NodeCustomEvent_SetCustomSpanMetrics (ArkUI_NodeCustomEvent * event, ArkUI_CustomSpanMetrics * metrics ) 13950``` 13951**Description** 13952 13953Sets the measurement metrics of a custom span through a custom component event. 13954 13955**Since**: 12 13956 13957**Parameters** 13958 13959| Name| Description| 13960| -------- | -------- | 13961| event | Pointer to the custom component event. | 13962| metrics | Measurement metrics to set. | 13963 13964**Returns** 13965 13966Returns **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. 13967 13968 13969### OH_ArkUI_NodeEvent_GetDragEvent() 13970 13971``` 13972ArkUI_DragEvent* OH_ArkUI_NodeEvent_GetDragEvent (ArkUI_NodeEvent * nodeEvent) 13973``` 13974**Description** 13975 13976Obtains an **ArkUI_DragEvent** object from the specified **ArkUI_DragEvent** object. 13977 13978**Since**: 12 13979 13980**Parameters** 13981 13982| Name| Description| 13983| -------- | -------- | 13984| node | Pointer to an **ArkUI_NodeEvent** object. | 13985 13986**Returns** 13987 13988Returns the pointer to an **ArkUI_DragEvent** object; returns null if the parameter passed in is invalid or is not a drag-related event. 13989 13990 13991### OH_ArkUI_NodeEvent_GetEventType() 13992 13993``` 13994ArkUI_NodeEventType OH_ArkUI_NodeEvent_GetEventType (ArkUI_NodeEvent * event) 13995``` 13996**Description** 13997 13998Obtains the type of a component event. 13999 14000**Since**: 12 14001 14002**Parameters** 14003 14004| Name| Description| 14005| -------- | -------- | 14006| event | Pointer to the component event. | 14007 14008**Returns** 14009 14010Returns the type of the component event. 14011 14012 14013### OH_ArkUI_NodeEvent_GetInputEvent() 14014 14015``` 14016ArkUI_UIInputEvent* OH_ArkUI_NodeEvent_GetInputEvent (ArkUI_NodeEvent * event) 14017``` 14018**Description** 14019 14020Obtains input event (for example, touch event) data for a component event. 14021 14022**Since**: 12 14023 14024**Parameters** 14025 14026| Name| Description| 14027| -------- | -------- | 14028| event | Pointer to the component event. | 14029 14030**Returns** 14031 14032Returns the pointer to the input event data. 14033 14034 14035### OH_ArkUI_NodeEvent_GetNodeComponentEvent() 14036 14037``` 14038ArkUI_NodeComponentEvent* OH_ArkUI_NodeEvent_GetNodeComponentEvent (ArkUI_NodeEvent * event) 14039``` 14040**Description** 14041 14042Obtains the numerical data in a component event. 14043 14044**Since**: 12 14045 14046**Parameters** 14047 14048| Name| Description| 14049| -------- | -------- | 14050| event | Pointer to the component event. | 14051 14052**Returns** 14053 14054Returns the pointer to the numerical data. 14055 14056 14057### OH_ArkUI_NodeEvent_GetNodeHandle() 14058 14059``` 14060ArkUI_NodeHandle OH_ArkUI_NodeEvent_GetNodeHandle (ArkUI_NodeEvent * event) 14061``` 14062**Description** 14063 14064Obtains the component object that triggers an event. 14065 14066**Since**: 12 14067 14068**Parameters** 14069 14070| Name| Description| 14071| -------- | -------- | 14072| event | Pointer to the component event. | 14073 14074**Returns** 14075 14076Component object that triggers the event. 14077 14078 14079### OH_ArkUI_NodeEvent_GetNumberValue() 14080 14081``` 14082int32_t OH_ArkUI_NodeEvent_GetNumberValue (ArkUI_NodeEvent * event, int32_t index, ArkUI_NumberValue * value ) 14083``` 14084**Description** 14085 14086Obtains the numeric-type parameter of a component event. 14087 14088**Since**: 12 14089 14090**Parameters** 14091 14092| Name| Description| 14093| -------- | -------- | 14094| event | Pointer to the component event. | 14095| index | Return value index. | 14096| value | Return value. | 14097 14098**Returns** 14099 14100Returns **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. 14101 14102 14103### OH_ArkUI_NodeEvent_GetPreDragStatus() 14104 14105``` 14106ArkUI_PreDragStatus OH_ArkUI_NodeEvent_GetPreDragStatus (ArkUI_NodeEvent * nodeEvent) 14107``` 14108**Description** 14109 14110Obtains the state prior to a drop and drop operation. 14111 14112**Since**: 12 14113 14114**Parameters** 14115 14116| Name| Description| 14117| -------- | -------- | 14118| node | ArkUI_NodeEvent node object. | 14119 14120**Returns** 14121 14122Returns the state prior to the drop and drop operation. 14123 14124 14125### OH_ArkUI_NodeEvent_GetStringAsyncEvent() 14126 14127``` 14128ArkUI_StringAsyncEvent* OH_ArkUI_NodeEvent_GetStringAsyncEvent (ArkUI_NodeEvent * event) 14129``` 14130**Description** 14131 14132Obtains the string data in a component event. 14133 14134**Since**: 12 14135 14136**Parameters** 14137 14138| Name| Description| 14139| -------- | -------- | 14140| event | Pointer to the component event. | 14141 14142**Returns** 14143 14144ArkUI_StringAsyncEvent\Pointer to string data. 14145 14146 14147### OH_ArkUI_NodeEvent_GetStringValue() 14148 14149``` 14150int32_t OH_ArkUI_NodeEvent_GetStringValue (ArkUI_NodeEvent * event, int32_t index, char ** string, int32_t * stringSize ) 14151``` 14152**Description** 14153 14154Obtains 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. 14155 14156**Since**: 12 14157 14158**Parameters** 14159 14160| Name| Description| 14161| -------- | -------- | 14162| event | Pointer to the component event. | 14163| index | Return value index. | 14164| string | Pointer to the string array. | 14165| stringSize | Length of the string array. | 14166 14167**Returns** 14168 14169Returns **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. 14170 14171 14172### OH_ArkUI_NodeEvent_GetTargetId() 14173 14174``` 14175int32_t OH_ArkUI_NodeEvent_GetTargetId (ArkUI_NodeEvent * event) 14176``` 14177**Description** 14178 14179Obtains the custom ID of a component event. 14180 14181The 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. 14182 14183**Since**: 12 14184 14185**Parameters** 14186 14187| Name| Description| 14188| -------- | -------- | 14189| event | Pointer to the component event. | 14190 14191**Returns** 14192 14193Returns the custom ID of the component event. 14194 14195 14196### OH_ArkUI_NodeEvent_GetUserData() 14197 14198``` 14199void* OH_ArkUI_NodeEvent_GetUserData (ArkUI_NodeEvent * event) 14200``` 14201**Description** 14202 14203Obtains the custom data in a component event. 14204 14205This parameter is passed in **registerNodeEvent** and can be applied to the service logic when the event is triggered. 14206 14207**Since**: 12 14208 14209**Parameters** 14210 14211| Name| Description| 14212| -------- | -------- | 14213| event | Pointer to the component event. | 14214 14215**Returns** 14216 14217Returns the pointer to user data. 14218 14219 14220### OH_ArkUI_NodeEvent_SetReturnNumberValue() 14221 14222``` 14223int32_t OH_ArkUI_NodeEvent_SetReturnNumberValue (ArkUI_NodeEvent * event, ArkUI_NumberValue * value, int32_t size ) 14224``` 14225**Description** 14226 14227Sets the return value for a component event. 14228 14229**Since**: 12 14230 14231**Parameters** 14232 14233| Name| Description| 14234| -------- | -------- | 14235| event | Pointer to the component event. | 14236| value | Event numeric type array. | 14237| size | Size of the array. | 14238 14239**Returns** 14240 14241Returns **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. 14242 14243 14244### OH_ArkUI_NodeUtils_AddCustomProperty() 14245 14246``` 14247void OH_ArkUI_NodeUtils_AddCustomProperty (ArkUI_NodeHandle node, const char * name, const char * value ) 14248``` 14249**Description** 14250 14251Sets a custom property for a component. This API takes effect only in the main thread. 14252 14253**Since**: 13 14254 14255**Parameters** 14256 14257| Name| Description| 14258| -------- | -------- | 14259| node | **ArkUI_NodeHandle** pointer. | 14260| name | Name of the custom property. A null pointer is not allowed. | 14261| value | Value of the custom property. A null pointer is not allowed. | 14262 14263 14264### OH_ArkUI_NodeUtils_GetActiveChildrenInfo() 14265 14266``` 14267int32_t OH_ArkUI_NodeUtils_GetActiveChildrenInfo (ArkUI_NodeHandle head, ArkUI_ActiveChildrenInfo ** handle ) 14268``` 14269**Description** 14270 14271Obtains all active child nodes of the specified node. Spans are not counted as child nodes. 14272 14273**Since**: 14 14274 14275**Parameters** 14276 14277| Name| Description| 14278| -------- | -------- | 14279| head | Node for which to obtain the child nodes. | 14280| handle | Pointer to the struct containing information about the child nodes of the head node. | 14281 14282**Returns** 14283 14284Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 14285 14286 14287### OH_ArkUI_NodeUtils_GetCurrentPageRootNode() 14288 14289``` 14290ArkUI_NodeHandle OH_ArkUI_NodeUtils_GetCurrentPageRootNode (ArkUI_NodeHandle node) 14291``` 14292**Description** 14293 14294Obtains the root node of the current page. 14295 14296**Since**: 14 14297 14298**Parameters** 14299 14300| Name| Description| 14301| -------- | -------- | 14302| node | Target node. | 14303 14304**Returns** 14305 14306Returns the pointer to the root node if the node exists; returns **NULL** otherwise. 14307 14308 14309### OH_ArkUI_NodeUtils_GetCustomProperty() 14310 14311``` 14312int32_t OH_ArkUI_NodeUtils_GetCustomProperty (ArkUI_NodeHandle node, const char * name, ArkUI_CustomProperty ** handle ) 14313``` 14314**Description** 14315 14316Obtains the value of a custom property of the specified component. 14317 14318**Since**: 14 14319 14320**Parameters** 14321 14322| Name| Description| 14323| -------- | -------- | 14324| node | **ArkUI_NodeHandle** pointer. | 14325| name | Name of the custom property. | 14326| handle | Pointer to the struct that receives the custom property corresponding to the key parameter name. | 14327 14328**Returns** 14329 14330Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 14331 14332 14333### OH_ArkUI_NodeUtils_GetLayoutPosition() 14334 14335``` 14336int32_t OH_ArkUI_NodeUtils_GetLayoutPosition (ArkUI_NodeHandle node, ArkUI_IntOffset * localOffset ) 14337``` 14338**Description** 14339 14340Obtains 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. 14341 14342**Since**: 12 14343 14344**Parameters** 14345 14346| Name| Description| 14347| -------- | -------- | 14348| node | **ArkUI_NodeHandle** pointer. | 14349| localOffset | Offset of the component handle relative to the parent component, in pixels. | 14350 14351**Returns** 14352 14353Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 14354 14355 14356### OH_ArkUI_NodeUtils_GetLayoutPositionInScreen() 14357 14358``` 14359int32_t OH_ArkUI_NodeUtils_GetLayoutPositionInScreen (ArkUI_NodeHandle node, ArkUI_IntOffset * screenOffset ) 14360``` 14361**Description** 14362 14363Obtains the position of the component's layout area relative to the screen. The relative position does not count in transformation attributes, such as translate. 14364 14365**Since**: 12 14366 14367**Parameters** 14368 14369| Name| Description| 14370| -------- | -------- | 14371| node | **ArkUI_NodeHandle** pointer. | 14372| screenOffset | Offset of the component handle relative to the screen, in pixels. | 14373 14374**Returns** 14375 14376Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 14377 14378 14379### OH_ArkUI_NodeUtils_GetLayoutPositionInWindow() 14380 14381``` 14382int32_t OH_ArkUI_NodeUtils_GetLayoutPositionInWindow (ArkUI_NodeHandle node, ArkUI_IntOffset * globalOffset ) 14383``` 14384**Description** 14385 14386Obtains the position of the component's layout area relative to the window. The relative position does not count in transformation attributes, such as translate. 14387 14388**Since**: 12 14389 14390**Parameters** 14391 14392| Name| Description| 14393| -------- | -------- | 14394| node | **ArkUI_NodeHandle** pointer. | 14395| globalOffset | Offset of the component handle relative to the window, in pixels. | 14396 14397**Returns** 14398 14399Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 14400 14401 14402### OH_ArkUI_NodeUtils_GetLayoutSize() 14403 14404``` 14405int32_t OH_ArkUI_NodeUtils_GetLayoutSize (ArkUI_NodeHandle node, ArkUI_IntSize * size ) 14406``` 14407**Description** 14408 14409Obtains the layout area size of a component. The size does not count in transformation attributes, such as scale. 14410 14411**Since**: 12 14412 14413**Parameters** 14414 14415| Name| Description| 14416| -------- | -------- | 14417| node | **ArkUI_NodeHandle** pointer. | 14418| size | Size of the layout area, in px. | 14419 14420**Returns** 14421 14422Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 14423 14424 14425### OH_ArkUI_NodeUtils_GetNodeType() 14426 14427``` 14428int32_t OH_ArkUI_NodeUtils_GetNodeType (ArkUI_NodeHandle node) 14429``` 14430**Description** 14431 14432Obtains the type of the specified node. 14433 14434**Since**: 14 14435 14436**Parameters** 14437 14438| Name| Description| 14439| -------- | -------- | 14440| node | Target node. | 14441 14442**Returns** 14443 14444Returns 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). 14445 14446 14447### OH_ArkUI_NodeUtils_GetParentInPageTree() 14448 14449``` 14450ArkUI_NodeHandle OH_ArkUI_NodeUtils_GetParentInPageTree (ArkUI_NodeHandle node) 14451``` 14452**Description** 14453 14454Obtains the parent node, which can be a component node created with ArkTS. 14455 14456**Since**: 14 14457 14458**Parameters** 14459 14460| Name| Description| 14461| -------- | -------- | 14462| node | Target node. | 14463 14464**Returns** 14465 14466Returns the pointer to the component if the component exists; returns **NULL** otherwise. 14467 14468 14469### OH_ArkUI_NodeUtils_GetPositionWithTranslateInScreen() 14470 14471``` 14472int32_t OH_ArkUI_NodeUtils_GetPositionWithTranslateInScreen (ArkUI_NodeHandle node, ArkUI_IntOffset * translateOffset ) 14473``` 14474**Description** 14475 14476Obtains the position of a component on the screen, including the translate attribute. 14477 14478**Since**: 12 14479 14480**Parameters** 14481 14482| Name| Description| 14483| -------- | -------- | 14484| node | **ArkUI_NodeHandle** pointer. | 14485| translateOffset | Accumulated offset of the component, its parent component, and its ancestor node, in px. | 14486 14487**Returns** 14488 14489Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 14490 14491 14492### OH_ArkUI_NodeUtils_GetPositionWithTranslateInWindow() 14493 14494``` 14495int32_t OH_ArkUI_NodeUtils_GetPositionWithTranslateInWindow (ArkUI_NodeHandle node, ArkUI_IntOffset * translateOffset ) 14496``` 14497**Description** 14498 14499Obtains the position of a component in the window, including the translate attribute. 14500 14501**Since**: 12 14502 14503**Parameters** 14504 14505| Name| Description| 14506| -------- | -------- | 14507| node | **ArkUI_NodeHandle** pointer. | 14508| translateOffset | Accumulated offset of the component, its parent component, and its ancestor node, in px. | 14509 14510**Returns** 14511 14512Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 14513 14514 14515### OH_ArkUI_NodeUtils_IsCreatedByNDK() 14516 14517``` 14518bool OH_ArkUI_NodeUtils_IsCreatedByNDK (ArkUI_NodeHandle node) 14519``` 14520**Description** 14521 14522Checks whether the specified component is created with the C API. 14523 14524**Since**: 14 14525 14526**Parameters** 14527 14528| Name| Description| 14529| -------- | -------- | 14530| node | Target node. | 14531 14532**Returns** 14533 14534Returns 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. 14535 14536 14537### OH_ArkUI_NodeUtils_RemoveCustomProperty() 14538 14539``` 14540void OH_ArkUI_NodeUtils_RemoveCustomProperty (ArkUI_NodeHandle node, const char * name ) 14541``` 14542**Description** 14543 14544Removes a custom property that has been set for the specified component. 14545 14546**Since**: 13 14547 14548**Parameters** 14549 14550| Name| Description| 14551| -------- | -------- | 14552| node | **ArkUI_NodeHandle** pointer. | 14553| name | Name of the custom property. | 14554 14555 14556### OH_ArkUI_PanGesture_GetOffsetX() 14557 14558``` 14559float OH_ArkUI_PanGesture_GetOffsetX (const ArkUI_GestureEvent * event) 14560``` 14561**Description** 14562 14563Obtains the relative offset of a pan gesture along the x-axis. 14564 14565**Since**: 12 14566 14567**Parameters** 14568 14569| Name| Description| 14570| -------- | -------- | 14571| event | Gesture event. | 14572 14573**Returns** 14574 14575Returns the relative offset of the gesture along the x-axis, in px. 14576 14577 14578### OH_ArkUI_PanGesture_GetOffsetY() 14579 14580``` 14581float OH_ArkUI_PanGesture_GetOffsetY (const ArkUI_GestureEvent * event) 14582``` 14583**Description** 14584 14585Obtains the relative offset of a pan gesture along the y-axis. 14586 14587**Since**: 12 14588 14589**Parameters** 14590 14591| Name| Description| 14592| -------- | -------- | 14593| event | Gesture event. | 14594 14595**Returns** 14596 14597Returns the relative offset of the gesture along the y-axis, in px. 14598 14599 14600### OH_ArkUI_PanGesture_GetVelocity() 14601 14602``` 14603float OH_ArkUI_PanGesture_GetVelocity (const ArkUI_GestureEvent * event) 14604``` 14605**Description** 14606 14607Obtains the velocity of a pan gesture along the main axis. 14608 14609**Since**: 12 14610 14611**Parameters** 14612 14613| Name| Description| 14614| -------- | -------- | 14615| event | Gesture event. | 14616 14617**Returns** 14618 14619Returns 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. 14620 14621 14622### OH_ArkUI_PanGesture_GetVelocityX() 14623 14624``` 14625float OH_ArkUI_PanGesture_GetVelocityX (const ArkUI_GestureEvent * event) 14626``` 14627**Description** 14628 14629Obtains the velocity of a pan gesture along the x-axis. 14630 14631**Since**: 12 14632 14633**Parameters** 14634 14635| Name| Description| 14636| -------- | -------- | 14637| event | Gesture event. | 14638 14639**Returns** 14640 14641Returns the velocity of the pan gesture along the x-axis, in px/s. 14642 14643 14644### OH_ArkUI_PanGesture_GetVelocityY() 14645 14646``` 14647float OH_ArkUI_PanGesture_GetVelocityY (const ArkUI_GestureEvent * event) 14648``` 14649**Description** 14650 14651Obtains the velocity of a pan gesture along the y-axis. 14652 14653**Since**: 12 14654 14655**Parameters** 14656 14657| Name| Description| 14658| -------- | -------- | 14659| event | Gesture event. | 14660 14661**Returns** 14662 14663Returns the velocity of the pan gesture along the y-axis, in px/s. 14664 14665 14666### OH_ArkUI_ParallelInnerGestureEvent_GetConflictRecognizers() 14667 14668``` 14669int32_t OH_ArkUI_ParallelInnerGestureEvent_GetConflictRecognizers (ArkUI_ParallelInnerGestureEvent * event, ArkUI_GestureRecognizerHandleArray * array, int32_t * size ) 14670``` 14671**Description** 14672 14673Obtains the conflicting gesture recognizers in a parallel internal gesture event. 14674 14675**Since**: 12 14676 14677**Parameters** 14678 14679| Name| Description| 14680| -------- | -------- | 14681| event | Parallel internal gesture event. | 14682| array | Array of conflicting gesture recognizers. | 14683| size | Size of the conflicting gesture recognizer array. | 14684 14685**Returns** 14686 14687Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 14688 14689 14690### OH_ArkUI_ParallelInnerGestureEvent_GetCurrentRecognizer() 14691 14692``` 14693ArkUI_GestureRecognizer* OH_ArkUI_ParallelInnerGestureEvent_GetCurrentRecognizer (ArkUI_ParallelInnerGestureEvent * event) 14694``` 14695**Description** 14696 14697Obtains the current gesture recognizer in a parallel internal gesture event. 14698 14699**Since**: 12 14700 14701**Parameters** 14702 14703| Name| Description| 14704| -------- | -------- | 14705| event | Parallel internal gesture event. | 14706 14707**Returns** 14708 14709Returns the pointer to the current gesture recognizer. 14710 14711### OH_ArkUI_ParallelInnerGestureEvent_GetUserData() 14712 14713``` 14714void* OH_ArkUI_ParallelInnerGestureEvent_GetUserData (ArkUI_ParallelInnerGestureEvent * event) 14715``` 14716**Description** 14717 14718Obtains custom data in the parallel internal gesture event. 14719 14720**Since**: 12 14721 14722**Parameters** 14723 14724| Name| Description| 14725| -------- | -------- | 14726| event | Parallel internal gesture event. | 14727 14728**Returns** 14729 14730Returns the pointer to custom data. 14731 14732### OH_ArkUI_GestureInterrupter_GetUserData 14733 14734``` 14735void* OH_ArkUI_GestureInterrupter_GetUserData(ArkUI_GestureInterruptInfo* event) 14736``` 14737 14738**Description** 14739 14740Obtains the custom data from a gesture interruption event. 14741 14742**Since**: 18 14743 14744**Parameters** 14745 14746| Name | Description | 14747| ----- | -------------------------- | 14748| event | Pointer to the gesture interruption information.| 14749 14750**Returns** 14751 14752Returns the pointer to the custom data. 14753 14754 14755### OH_ArkUI_PinchGesture_GetCenterX() 14756 14757``` 14758float OH_ArkUI_PinchGesture_GetCenterX (const ArkUI_GestureEvent * event) 14759``` 14760**Description** 14761 14762Obtains the X coordinate of the center of the pinch gesture, in vp, relative to the upper left corner of the current component. 14763 14764**Since**: 12 14765 14766**Parameters** 14767 14768| Name| Description| 14769| -------- | -------- | 14770| event | Gesture event. | 14771 14772**Returns** 14773 14774Returns the X coordinate of the center of the pinch gesture, in vp, relative to the upper left corner of the current component. 14775 14776 14777### OH_ArkUI_PinchGesture_GetCenterY() 14778 14779``` 14780float OH_ArkUI_PinchGesture_GetCenterY (const ArkUI_GestureEvent * event) 14781``` 14782**Description** 14783 14784Obtains the Y coordinate of the center of the pinch gesture, in vp, relative to the upper left corner of the current component. 14785 14786**Since**: 12 14787 14788**Parameters** 14789 14790| Name| Description| 14791| -------- | -------- | 14792| event | Gesture event. | 14793 14794**Returns** 14795 14796Returns the Y coordinate of the center of the pinch gesture, in vp, relative to the upper left corner of the current component. 14797 14798 14799### OH_ArkUI_PinchGesture_GetScale() 14800 14801``` 14802float OH_ArkUI_PinchGesture_GetScale (const ArkUI_GestureEvent * event) 14803``` 14804**Description** 14805 14806Obtains the scale ratio of a pinch gesture. 14807 14808**Since**: 12 14809 14810**Parameters** 14811 14812| Name| Description| 14813| -------- | -------- | 14814| event | Gesture event. | 14815 14816**Returns** 14817 14818Scale. 14819 14820 14821### OH_ArkUI_QueryModuleInterfaceByName() 14822 14823``` 14824void* OH_ArkUI_QueryModuleInterfaceByName (ArkUI_NativeAPIVariantKind type, const char * structName ) 14825``` 14826**Description** 14827 14828Obtains the native API set of a specified type. 14829 14830**Since**: 12 14831 14832**Parameters** 14833 14834| Name| Description| 14835| -------- | -------- | 14836| type | Type of the native API set provided by ArkUI, for example, **ARKUI_NATIVE_NODE** or **ARKUI_NATIVE_GESTURE**. | 14837| sturctName | Name of a native struct defined in the corresponding header file, for example, **ArkUI_NativeNodeAPI_1** in <arkui/native_node.h>. | 14838 14839**Returns** 14840 14841Returns 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); } 14842 14843 14844### OH_ArkUI_RegisterSystemColorModeChangeEvent() 14845 14846``` 14847int32_t OH_ArkUI_RegisterSystemColorModeChangeEvent (ArkUI_NodeHandle node, void * userData, void(*)(ArkUI_SystemColorMode colorMode, void *userData) onColorModeChange ) 14848``` 14849**Description** 14850 14851Registers an event listener for system color mode changes. A single component can only register one callback for system color mode changes. 14852 14853**Since**: 12 14854 14855**Parameters** 14856 14857| Name| Description| 14858| -------- | -------- | 14859| node | Specified node. | 14860| userData | Custom event parameter, which is passed in the callback when the event is triggered. | 14861| onColorModeChange | Callback to be executed when the event is triggered. | 14862 14863**Returns** 14864 14865Returns **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. 14866 14867 14868### OH_ArkUI_RegisterSystemFontStyleChangeEvent() 14869 14870``` 14871int32_t OH_ArkUI_RegisterSystemFontStyleChangeEvent (ArkUI_NodeHandle node, void * userData, void(*)(ArkUI_SystemFontStyleEvent *event, void *userData) onFontStyleChange ) 14872``` 14873**Description** 14874 14875Registers an event listener for system font style changes. A single component can only register one callback for system font style changes. 14876 14877**Since**: 12 14878 14879**Parameters** 14880 14881| Name| Description| 14882| -------- | -------- | 14883| node | Specified node. | 14884| userData | Custom event parameter, which is passed in the callback when the event is triggered. | 14885| onFontStyleChange | Callback to be executed when the event is triggered. | 14886 14887**Returns** 14888 14889Returns **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. 14890 14891 14892### OH_ArkUI_RotationGesture_GetAngle() 14893 14894``` 14895float OH_ArkUI_RotationGesture_GetAngle (const ArkUI_GestureEvent * event) 14896``` 14897**Description** 14898 14899Obtains the angle information of a rotation gesture. 14900 14901**Since**: 12 14902 14903**Parameters** 14904 14905| Name| Description| 14906| -------- | -------- | 14907| event | Gesture event. | 14908 14909**Returns** 14910 14911Rotation angle. 14912 14913 14914### OH_ArkUI_SetArkUIGestureRecognizerDisposeNotify() 14915 14916``` 14917int32_t OH_ArkUI_SetArkUIGestureRecognizerDisposeNotify (ArkUI_GestureRecognizer * recognizer, ArkUI_GestureRecognizerDestructNotifyCallback callback, void * userData ) 14918``` 14919**Description** 14920 14921Sets a callback function for notifying gesture recognizer destruction. 14922 14923**Parameters** 14924 14925| Name| Description| 14926| -------- | -------- | 14927| recognizer | Pointer to the gesture recognizer. | 14928| callback | Callback function for notifying gesture recognizer destruction. | 14929| userData | Custom data. | 14930 14931**Returns** 14932 14933Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 14934 14935 14936### OH_ArkUI_SetDragEventStrictReportWithContext() 14937 14938``` 14939int32_t OH_ArkUI_SetDragEventStrictReportWithContext (ArkUI_ContextHandle uiContext, bool enabled ) 14940``` 14941**Description** 14942 14943Sets 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. 14944 14945**Since**: 12 14946 14947**Parameters** 14948 14949| Name| Description| 14950| -------- | -------- | 14951| uiContext | Pointer to the UI instance. | 14952| enabled | Whether to enable strict reporting on drag events. | 14953 14954**Returns** 14955 14956Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 14957 14958 14959### OH_ArkUI_SetDragEventStrictReportWithNode() 14960 14961``` 14962int32_t OH_ArkUI_SetDragEventStrictReportWithNode (ArkUI_NodeHandle node, bool enabled ) 14963``` 14964**Description** 14965 14966Sets 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. 14967 14968**Since**: 12 14969 14970**Parameters** 14971 14972| Name| Description| 14973| -------- | -------- | 14974| node | Pointer to a component node. | 14975| enabled | Whether to enable strict reporting on drag events. | 14976 14977**Returns** 14978 14979Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 14980 14981 14982### OH_ArkUI_SetGestureRecognizerEnabled() 14983 14984``` 14985int32_t OH_ArkUI_SetGestureRecognizerEnabled (ArkUI_GestureRecognizer * recognizer, bool enabled ) 14986``` 14987**Description** 14988 14989Sets the enabled state of a gesture recognizer. 14990 14991**Since**: 12 14992 14993**Parameters** 14994 14995| Name| Description| 14996| -------- | -------- | 14997| recognizer | Pointer to the gesture recognizer. | 14998| enabled | Whether to enable notification. | 14999 15000**Returns** 15001 15002Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 15003 15004### OH_ArkUI_SetGestureRecognizerLimitFingerCount 15005 15006``` 15007int32_t OH_ArkUI_SetGestureRecognizerLimitFingerCount (ArkUI_GestureRecognizer * recognizer, bool limitFingerCount ) 15008``` 15009**Description** 15010 15011Sets whether to enforce the exact number of fingers touching the screen. 15012 15013**Parameters** 15014 15015| Name| Description| 15016| -------- | -------- | 15017| recognizer | Pointer to the gesture recognizer. | 15018| limitFingerCount | Whether to enforce the exact number of fingers touching the screen. | 15019 15020**Returns** 15021 15022Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 15023 15024 15025 15026 15027### OH_ArkUI_SetNodeAllowedDropDataTypes() 15028 15029``` 15030int32_t OH_ArkUI_SetNodeAllowedDropDataTypes (ArkUI_NodeHandle node, const char * typesArray[], int32_t count ) 15031``` 15032**Description** 15033 15034Sets 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). 15035 15036**Since**: 12 15037 15038**Parameters** 15039 15040| Name| Description| 15041| -------- | -------- | 15042| node | Pointer to a component node. | 15043| typesArray | Array of data types that can fall into. | 15044| count | Length of an array. | 15045 15046**Returns** 15047 15048Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 15049 15050 15051### OH_ArkUI_SetNodeDraggable() 15052 15053``` 15054int32_t OH_ArkUI_SetNodeDraggable (ArkUI_NodeHandle node, bool enabled ) 15055``` 15056**Description** 15057 15058Sets whether the component is draggable. 15059 15060**Since**: 12 15061 15062**Parameters** 15063 15064| Name| Description| 15065| -------- | -------- | 15066| node | Pointer to a component node. | 15067| bool | Whether the component is draggable. | 15068 15069**Returns** 15070 15071Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 15072 15073 15074### OH_ArkUI_SetNodeDragPreview() 15075 15076``` 15077int32_t OH_ArkUI_SetNodeDragPreview (ArkUI_NodeHandle node, OH_PixelmapNative * preview ) 15078``` 15079**Description** 15080 15081Sets a custom drag preview for the specified component. 15082 15083**Since**: 12 15084 15085**Parameters** 15086 15087| Name| Description| 15088| -------- | -------- | 15089| node | Pointer to the target component node. | 15090| preview | Custom drag preview, which is a pixel map. | 15091 15092**Returns** 15093 15094Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 15095 15096 15097### OH_ArkUI_SetNodeDragPreviewOption() 15098 15099``` 15100int32_t OH_ArkUI_SetNodeDragPreviewOption (ArkUI_NodeHandle node, ArkUI_DragPreviewOption * option ) 15101``` 15102**Description** 15103 15104Sets an **ArkUI_DragPreviewOption** object for the specified component. 15105 15106**Since**: 12 15107 15108**Parameters** 15109 15110| Name| Description| 15111| -------- | -------- | 15112| node | Pointer to a component node. | 15113| option | Custom parameters. | 15114 15115**Returns** 15116 15117Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 15118 15119 15120### OH_ArkUI_StartDrag() 15121 15122``` 15123int32_t OH_ArkUI_StartDrag (ArkUI_DragAction * dragAction) 15124``` 15125**Description** 15126 15127Initiates a drag action through the specified drag action object. 15128 15129**Since**: 12 15130 15131**Parameters** 15132 15133| Name| Description| 15134| -------- | -------- | 15135| dragAction | Drag action object. | 15136 15137**Returns** 15138 15139Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 15140 15141 15142### OH_ArkUI_StyledString_AddPlaceholder() 15143 15144``` 15145void OH_ArkUI_StyledString_AddPlaceholder (ArkUI_StyledString * handle, OH_Drawing_PlaceholderSpan * placeholder ) 15146``` 15147**Description** 15148 15149Adds a placeholder. 15150 15151**Since**: 12 15152 15153**Parameters** 15154 15155| Name| Description| 15156| -------- | -------- | 15157| handle | Pointer to an **ArkUI_StyledString** object. | 15158| placeholder | Pointer to an **OH_Drawing_PlaceholderSpan** object. | 15159 15160 15161### OH_ArkUI_StyledString_AddText() 15162 15163``` 15164void OH_ArkUI_StyledString_AddText (ArkUI_StyledString * handle, const char * content ) 15165``` 15166**Description** 15167 15168Sets the text content based on the current format string style. 15169 15170**Since**: 12 15171 15172**Parameters** 15173 15174| Name| Description| 15175| -------- | -------- | 15176| handle | Pointer to an **ArkUI_StyledString** object. | 15177| content | Pointer to the text content. | 15178 15179 15180### OH_ArkUI_StyledString_Create() 15181 15182``` 15183ArkUI_StyledString* OH_ArkUI_StyledString_Create (OH_Drawing_TypographyStyle * style, OH_Drawing_FontCollection * collection ) 15184``` 15185**Description** 15186 15187Creates an **ArkUI_StyledString** object. 15188 15189**Since**: 12 15190 15191**Parameters** 15192 15193| Name| Description| 15194| -------- | -------- | 15195| style | Pointer to an **OH_Drawing_TypographyStyle** object, which is obtained by calling **OH_Drawing_CreateTypographyStyle**. | 15196| collection | Pointer to an **OH_Drawing_FontCollection** object, which is obtained by calling **OH_Drawing_CreateFontCollection**. | 15197 15198**Returns** 15199 15200Returns 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. 15201 15202 15203### OH_ArkUI_StyledString_CreateTypography() 15204 15205``` 15206OH_Drawing_Typography* OH_ArkUI_StyledString_CreateTypography (ArkUI_StyledString * handle) 15207``` 15208**Description** 15209 15210Creates an **OH_Drawing_Typography** object based on an **ArkUI_StyledString** object. 15211 15212**Since**: 12 15213 15214**Parameters** 15215 15216| Name| Description| 15217| -------- | -------- | 15218| handle | Pointer to an **ArkUI_StyledString** object. | 15219 15220**Returns** 15221 15222Returns 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. 15223 15224 15225### OH_ArkUI_StyledString_Descriptor_Create() 15226 15227``` 15228ArkUI_StyledString_Descriptor* OH_ArkUI_StyledString_Descriptor_Create (void ) 15229``` 15230**Description** 15231 15232Creates an **ArkUI_StyledString_Descriptor** object. 15233 15234**Since**: 14 15235 15236**Returns** 15237 15238Pointer to an **ArkUI_StyledString_Descriptor** object. 15239 15240 15241### OH_ArkUI_StyledString_Descriptor_Destroy() 15242 15243``` 15244void OH_ArkUI_StyledString_Descriptor_Destroy (ArkUI_StyledString_Descriptor * descriptor) 15245``` 15246**Description** 15247 15248Destroys an **ArkUI_StyledString_Descriptor** object and reclaims the memory occupied by the object. 15249 15250**Since**: 14 15251 15252**Parameters** 15253 15254| Name| Description| 15255| -------- | -------- | 15256| descriptor | Pointer to an **ArkUI_StyledString_Descriptor** object. | 15257 15258 15259### OH_ArkUI_StyledString_Destroy() 15260 15261``` 15262void OH_ArkUI_StyledString_Destroy (ArkUI_StyledString * handle) 15263``` 15264**Description** 15265 15266Destroys an **OH_Drawing_TextStyle** object and reclaims the memory occupied by the object. 15267 15268**Since**: 12 15269 15270**Parameters** 15271 15272| Name| Description| 15273| -------- | -------- | 15274| handle | Pointer to an **ArkUI_StyledString** object. | 15275 15276 15277### OH_ArkUI_StyledString_PopTextStyle() 15278 15279``` 15280void OH_ArkUI_StyledString_PopTextStyle (ArkUI_StyledString * handle) 15281``` 15282**Description** 15283 15284Removes the top style from the current formatted string object. 15285 15286**Since**: 12 15287 15288**Parameters** 15289 15290| Name| Description| 15291| -------- | -------- | 15292| handle | Pointer to an **ArkUI_StyledString** object. | 15293 15294 15295### OH_ArkUI_StyledString_PushTextStyle() 15296 15297``` 15298void OH_ArkUI_StyledString_PushTextStyle (ArkUI_StyledString * handle, OH_Drawing_TextStyle * style ) 15299``` 15300**Description** 15301 15302Sets the new typesetting style to the top of the current format string style stack. 15303 15304**Since**: 12 15305 15306**Parameters** 15307 15308| Name| Description| 15309| -------- | -------- | 15310| handle | Pointer to an **ArkUI_StyledString** object. | 15311| style | Pointer to an **OH_Drawing_TextStyle** object. | 15312 15313 15314### OH_ArkUI_SwipeGesture_GetAngle() 15315 15316``` 15317float OH_ArkUI_SwipeGesture_GetAngle (const ArkUI_GestureEvent * event) 15318``` 15319**Description** 15320 15321Obtains the angle information of the swipe gesture. 15322 15323**Since**: 12 15324 15325**Parameters** 15326 15327| Name| Description| 15328| -------- | -------- | 15329| event | Gesture event. | 15330 15331**Returns** 15332 15333Returns the angle of the swipe gesture, which is the result obtained based on the aforementioned formula. 15334 15335 15336### OH_ArkUI_SwipeGesture_GetVelocity() 15337 15338``` 15339float OH_ArkUI_SwipeGesture_GetVelocity (const ArkUI_GestureEvent * event) 15340``` 15341**Description** 15342 15343Obtains the average velocity of all fingers used in the swipe gesture. 15344 15345**Since**: 12 15346 15347**Parameters** 15348 15349| Name| Description| 15350| -------- | -------- | 15351| event | Gesture event. | 15352 15353**Returns** 15354 15355Returns the average velocity of all fingers used in the swipe gesture, in px/s. 15356 15357 15358### OH_ArkUI_SwiperIndicator_Create() 15359 15360``` 15361ArkUI_SwiperIndicator* OH_ArkUI_SwiperIndicator_Create (ArkUI_SwiperIndicatorType type) 15362``` 15363**Description** 15364 15365Creates a navigation indicator for the Swiper component. 15366 15367**Since**: 12 15368 15369**Parameters** 15370 15371| Name| Description| 15372| -------- | -------- | 15373| type | Type of the navigation indicator. | 15374 15375**Returns** 15376 15377Returns the pointer to the navigation indicator. 15378 15379 15380### OH_ArkUI_SwiperIndicator_Dispose() 15381 15382``` 15383void OH_ArkUI_SwiperIndicator_Dispose (ArkUI_SwiperIndicator * indicator) 15384``` 15385**Description** 15386 15387Disposes of the navigation indicator of this **Swiper** component. 15388 15389**Since**: 12 15390 15391**Parameters** 15392 15393| Name| Description| 15394| -------- | -------- | 15395| indicator | Returns the pointer to the navigation indicator. | 15396 15397 15398### OH_ArkUI_SwiperIndicator_GetBottomPosition() 15399 15400``` 15401float OH_ArkUI_SwiperIndicator_GetBottomPosition (ArkUI_SwiperIndicator * indicator) 15402``` 15403**Description** 15404 15405Obtains the distance between the navigation indicator and the bottom edge of the **Swiper** component. 15406 15407**Since**: 12 15408 15409**Parameters** 15410 15411| Name| Description| 15412| -------- | -------- | 15413| indicator | Returns the pointer to the navigation indicator. | 15414 15415**Returns** 15416 15417Returns the distance between a navigation indicator and the bottom edge of the **Swiper** component. 15418 15419 15420### OH_ArkUI_SwiperIndicator_GetColor() 15421 15422``` 15423uint32_t OH_ArkUI_SwiperIndicator_GetColor (ArkUI_SwiperIndicator * indicator) 15424``` 15425**Description** 15426 15427Obtains the color of a dot-style navigation indicator of the **Swiper** component. 15428 15429**Since**: 12 15430 15431**Parameters** 15432 15433| Name| Description| 15434| -------- | -------- | 15435| indicator | Returns the pointer to the navigation indicator. | 15436 15437**Returns** 15438 15439Returns the color, in 0xARGB format. For example, 0xFFFF0000 indicates red. 15440 15441 15442### OH_ArkUI_SwiperIndicator_GetEndPosition() 15443 15444``` 15445float OH_ArkUI_SwiperIndicator_GetEndPosition (ArkUI_SwiperIndicator * indicator) 15446``` 15447**Description** 15448 15449Obtains the distance between a navigation indicator and the right edge of the **Swiper** component. 15450 15451**Since**: 12 15452 15453**Parameters** 15454 15455| Name| Description| 15456| -------- | -------- | 15457| indicator | Returns the pointer to the navigation indicator. | 15458 15459**Returns** 15460 15461Returns the distance between the navigation indicator and the right edge of the **Swiper** component. 15462 15463 15464### OH_ArkUI_SwiperIndicator_GetItemHeight() 15465 15466``` 15467float OH_ArkUI_SwiperIndicator_GetItemHeight (ArkUI_SwiperIndicator * indicator) 15468``` 15469**Description** 15470 15471Obtains the height of a dot-style navigation indicator of the **Swiper** component. 15472 15473**Since**: 12 15474 15475**Parameters** 15476 15477| Name| Description| 15478| -------- | -------- | 15479| indicator | Returns the pointer to the navigation indicator. | 15480 15481**Returns** 15482 15483Returns the height of the dot-style navigation indicator. 15484 15485 15486### OH_ArkUI_SwiperIndicator_GetItemWidth() 15487 15488``` 15489float OH_ArkUI_SwiperIndicator_GetItemWidth (ArkUI_SwiperIndicator * indicator) 15490``` 15491**Description** 15492 15493Obtains the width of a dot-style navigation indicator of the **Swiper** component. 15494 15495**Since**: 12 15496 15497**Parameters** 15498 15499| Name| Description| 15500| -------- | -------- | 15501| indicator | Returns the pointer to the navigation indicator. | 15502 15503**Returns** 15504 15505Returns the width of the dot-style navigation indicator. 15506 15507 15508### OH_ArkUI_SwiperIndicator_GetMask() 15509 15510``` 15511int32_t OH_ArkUI_SwiperIndicator_GetMask (ArkUI_SwiperIndicator * indicator) 15512``` 15513**Description** 15514 15515Obtains whether the mask is enabled for a dot-style navigation indicator of the **Swiper** component. 15516 15517**Since**: 12 15518 15519**Parameters** 15520 15521| Name| Description| 15522| -------- | -------- | 15523| indicator | Returns the pointer to the navigation indicator. | 15524 15525**Returns** 15526 15527Returns **1** if the mask is enabled; returns **0** otherwise. 15528 15529 15530### OH_ArkUI_SwiperIndicator_GetMaxDisplayCount() 15531 15532``` 15533int32_t OH_ArkUI_SwiperIndicator_GetMaxDisplayCount (ArkUI_SwiperIndicator * indicator) 15534``` 15535**Description** 15536 15537Obtains the maximum number of dots for the dot-style navigation indicator. 15538 15539**Since**: 12 15540 15541**Parameters** 15542 15543| Name| Description| 15544| -------- | -------- | 15545| indicator | Returns the pointer to the navigation indicator. | 15546 15547**Returns** 15548 15549Returns the maximum number of dots. The value ranges from 6 to 9. 15550 15551 15552### OH_ArkUI_SwiperDigitIndicator_Create() 15553 15554``` 15555ArkUI_SwiperDigitIndicator *OH_ArkUI_SwiperDigitIndicator_Create() 15556``` 15557**Description** 15558 15559Creates a digit-style navigation indicator for this **Swiper** component. 15560 15561**Since**: 15 15562 15563**Returns** 15564 15565Returns the pointer to the digit-style navigation indicator. 15566 15567### OH_ArkUI_SwiperDigitIndicator_SetStartPosition() 15568 15569``` 15570void OH_ArkUI_SwiperDigitIndicator_SetStartPosition(ArkUI_SwiperDigitIndicator* indicator, float value) 15571``` 15572**Description** 15573 15574Sets 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. 15575 15576**Since**: 15 15577 15578**Parameters** 15579 15580| Name| Description| 15581| -------- | -------- | 15582| indicator | Pointer to a digit-style navigation indicator. | 15583| value | Distance from the left edge of the **Swiper** component. For right-to-left scripts, this indicates the distance from the right edge. | 15584 15585### OH_ArkUI_SwiperDigitIndicator_GetStartPosition() 15586 15587``` 15588float OH_ArkUI_SwiperDigitIndicator_GetStartPosition(ArkUI_SwiperDigitIndicator* indicator) 15589``` 15590**Description** 15591 15592Obtains 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. 15593 15594**Since**: 15 15595 15596**Parameters** 15597 15598| Name| Description| 15599| -------- | -------- | 15600| indicator | Pointer to a digit-style navigation indicator.| 15601 15602**Returns** 15603 15604Returns the distance from the left edge of the **Swiper** component. For right-to-left scripts, this indicates the distance from the right edge. 15605 15606### OH_ArkUI_SwiperDigitIndicator_SetTopPosition() 15607 15608``` 15609void OH_ArkUI_SwiperDigitIndicator_SetTopPosition(ArkUI_SwiperDigitIndicator* indicator, float value) 15610``` 15611**Description** 15612 15613Sets the distance from the digit-style navigation indicator to the top of the **Swiper** component. 15614 15615**Since**: 15 15616 15617**Parameters** 15618 15619| Name| Description| 15620| -------- | -------- | 15621| indicator | Pointer to a digit-style navigation indicator. | 15622| value | Distance from the digit-style navigation indicator to the top of the **Swiper** component. | 15623 15624### OH_ArkUI_SwiperDigitIndicator_GetTopPosition() 15625 15626``` 15627float OH_ArkUI_SwiperDigitIndicator_GetTopPosition(ArkUI_SwiperDigitIndicator* indicator) 15628``` 15629**Description** 15630 15631Obtains the distance from the digit-style navigation indicator to the top of the **Swiper** component. 15632 15633**Since**: 15 15634 15635**Parameters** 15636 15637| Name| Description| 15638| -------- | -------- | 15639| indicator | Pointer to a digit-style navigation indicator.| 15640 15641**Returns** 15642 15643Returns the distance from the digit-style navigation indicator to the top of the **Swiper** component. 15644 15645### OH_ArkUI_SwiperDigitIndicator_SetEndPosition() 15646 15647``` 15648void OH_ArkUI_SwiperDigitIndicator_SetEndPosition(ArkUI_SwiperDigitIndicator* indicator, float value) 15649``` 15650**Description** 15651 15652Sets 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. 15653 15654**Since**: 15 15655 15656**Parameters** 15657 15658| Name| Description| 15659| -------- | -------- | 15660| indicator | Pointer to a digit-style navigation indicator. | 15661| value | Distance from the right edge of the **Swiper** component. For right-to-left scripts, this indicates the distance from the left edge. | 15662 15663### OH_ArkUI_SwiperDigitIndicator_GetEndPosition() 15664 15665``` 15666float OH_ArkUI_SwiperDigitIndicator_GetEndPosition(ArkUI_SwiperDigitIndicator* indicator) 15667``` 15668**Description** 15669 15670Obtains 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. 15671 15672**Since**: 15 15673 15674**Parameters** 15675 15676| Name| Description| 15677| -------- | -------- | 15678| indicator | Pointer to a digit-style navigation indicator.| 15679 15680**Returns** 15681 15682Returns the distance from the right edge of the **Swiper** component. For right-to-left scripts, this indicates the distance from the left edge. 15683 15684### OH_ArkUI_SwiperDigitIndicator_SetBottomPosition() 15685 15686``` 15687void OH_ArkUI_SwiperDigitIndicator_SetBottomPosition(ArkUI_SwiperDigitIndicator* indicator, float value) 15688``` 15689**Description** 15690 15691Sets the distance from the digit-style navigation indicator to the bottom of the **Swiper** component. 15692 15693**Since**: 15 15694 15695**Parameters** 15696 15697| Name| Description| 15698| -------- | -------- | 15699| indicator | Pointer to a digit-style navigation indicator. | 15700| value | Distance from the digit-style navigation indicator to the bottom of the **Swiper** component. | 15701 15702### OH_ArkUI_SwiperDigitIndicator_GetBottomPosition() 15703 15704``` 15705float OH_ArkUI_SwiperDigitIndicator_GetBottomPosition(ArkUI_SwiperDigitIndicator* indicator) 15706``` 15707**Description** 15708 15709Obtains the distance from the digit-style navigation indicator to the bottom of the **Swiper** component. 15710 15711**Since**: 15 15712 15713**Parameters** 15714 15715| Name| Description| 15716| -------- | -------- | 15717| indicator | Pointer to a digit-style navigation indicator.| 15718 15719**Returns** 15720 15721Returns the distance from the digit-style navigation indicator to the bottom of the **Swiper** component. 15722 15723### OH_ArkUI_SwiperDigitIndicator_SetFontColor() 15724 15725``` 15726void OH_ArkUI_SwiperDigitIndicator_SetFontColor(ArkUI_SwiperDigitIndicator* indicator, uint32_t color) 15727``` 15728**Description** 15729 15730Sets the font color of the digit-style navigation indicator for the **Swiper** component. 15731 15732**Since**: 15 15733 15734**Parameters** 15735 15736| Name| Description| 15737| -------- | -------- | 15738| indicator | Pointer to a digit-style navigation indicator. | 15739| color | Color, in 0xARGB format. For example, 0xFFFF0000 indicates red. | 15740 15741### OH_ArkUI_SwiperDigitIndicator_GetFontColor() 15742 15743``` 15744uint32_t OH_ArkUI_SwiperDigitIndicator_GetFontColor(ArkUI_SwiperDigitIndicator* indicator) 15745``` 15746**Description** 15747 15748Obtains the font color of the digit-style navigation indicator for the **Swiper** component. 15749 15750**Since**: 15 15751 15752**Parameters** 15753 15754| Name| Description| 15755| -------- | -------- | 15756| indicator | Pointer to a digit-style navigation indicator.| 15757 15758**Returns** 15759 15760Returns the color, in 0xARGB format. For example, 0xFFFF0000 indicates red. 15761 15762### OH_ArkUI_SwiperDigitIndicator_SetSelectedFontColor() 15763 15764``` 15765void OH_ArkUI_SwiperDigitIndicator_SetSelectedFontColor(ArkUI_SwiperDigitIndicator* indicator, uint32_t selectedColor) 15766``` 15767**Description** 15768 15769Sets the font color of the selected digit-style navigation indicator for the **Swiper** component. 15770 15771**Since**: 15 15772 15773**Parameters** 15774 15775| Name| Description| 15776| -------- | -------- | 15777| indicator | Pointer to a digit-style navigation indicator. | 15778| selectedColor | Color, in 0xARGB format. For example, 0xFFFF0000 indicates red. | 15779 15780### OH_ArkUI_SwiperDigitIndicator_GetSelectedFontColor() 15781 15782``` 15783uint32_t OH_ArkUI_SwiperDigitIndicator_GetSelectedFontColor(ArkUI_SwiperDigitIndicator* indicator) 15784``` 15785**Description** 15786 15787Obtains the font color of the selected digit-style navigation indicator for the **Swiper** component. 15788 15789**Since**: 15 15790 15791**Parameters** 15792 15793| Name| Description| 15794| -------- | -------- | 15795| indicator | Pointer to a digit-style navigation indicator.| 15796 15797**Returns** 15798 15799Returns the color, in 0xARGB format. For example, 0xFFFF0000 indicates red. 15800 15801### OH_ArkUI_SwiperDigitIndicator_SetFontSize() 15802 15803``` 15804void OH_ArkUI_SwiperDigitIndicator_SetFontSize(ArkUI_SwiperDigitIndicator* indicator, float size) 15805``` 15806**Description** 15807 15808Sets the font size of the digit-style navigation indicator for the **Swiper** component. 15809 15810**Since**: 15 15811 15812**Parameters** 15813 15814| Name| Description| 15815| -------- | -------- | 15816| indicator | Pointer to a digit-style navigation indicator. | 15817| size | Font size, in fp. | 15818 15819### OH_ArkUI_SwiperDigitIndicator_GetFontSize() 15820 15821``` 15822float OH_ArkUI_SwiperDigitIndicator_GetFontSize(ArkUI_SwiperDigitIndicator* indicator) 15823``` 15824**Description** 15825 15826Obtains the font size of the digit-style navigation indicator for the **Swiper** component. 15827 15828**Since**: 15 15829 15830**Parameters** 15831 15832| Name| Description| 15833| -------- | -------- | 15834| indicator | Pointer to a digit-style navigation indicator.| 15835 15836**Returns** 15837 15838Font size, in fp. 15839 15840### OH_ArkUI_SwiperDigitIndicator_SetSelectedFontSize() 15841 15842``` 15843void OH_ArkUI_SwiperDigitIndicator_SetSelectedFontSize(ArkUI_SwiperDigitIndicator* indicator, float size) 15844``` 15845**Description** 15846 15847Sets the font size of the selected digit-style navigation indicator for the **Swiper** component. 15848 15849**Since**: 15 15850 15851**Parameters** 15852 15853| Name| Description| 15854| -------- | -------- | 15855| indicator | Pointer to a digit-style navigation indicator. | 15856| size | Font size, in fp. | 15857 15858### OH_ArkUI_SwiperDigitIndicator_GetSelectedFontSize() 15859 15860``` 15861float OH_ArkUI_SwiperDigitIndicator_GetSelectedFontSize(ArkUI_SwiperDigitIndicator* indicator) 15862``` 15863**Description** 15864 15865Obtains the font size of the selected digit-style navigation indicator for the **Swiper** component. 15866 15867**Since**: 15 15868 15869**Parameters** 15870 15871| Name| Description| 15872| -------- | -------- | 15873| indicator | Pointer to a digit-style navigation indicator.| 15874 15875**Returns** 15876 15877Returns the font size, in fp. 15878 15879### OH_ArkUI_SwiperDigitIndicator_SetFontWeight() 15880 15881``` 15882void OH_ArkUI_SwiperDigitIndicator_SetFontWeight(ArkUI_SwiperDigitIndicator* indicator, ArkUI_FontWeight fontWeight) 15883``` 15884**Description** 15885 15886Sets the font weight of the digit-style navigation indicator for the **Swiper** component. 15887 15888**Since**: 15 15889 15890**Parameters** 15891 15892| Name| Description| 15893| -------- | -------- | 15894| indicator | Pointer to a digit-style navigation indicator. | 15895| fontWeight | Font weight, specified by an enumeration value of [ArkUI_FontWeight](#arkui_fontweight). | 15896 15897### OH_ArkUI_SwiperDigitIndicator_GetFontWeight() 15898 15899``` 15900ArkUI_FontWeight OH_ArkUI_SwiperDigitIndicator_GetFontWeight(ArkUI_SwiperDigitIndicator* indicator) 15901``` 15902**Description** 15903 15904 Obtains the font weight of the digit-style navigation indicator for the **Swiper** component. 15905 15906**Since**: 15 15907 15908**Parameters** 15909 15910| Name| Description| 15911| -------- | -------- | 15912| indicator | Pointer to a digit-style navigation indicator.| 15913 15914**Returns** 15915 15916Returns the font weight, specified by an enumeration value of [ArkUI_FontWeight](#arkui_fontweight). 15917 15918### OH_ArkUI_SwiperDigitIndicator_SetSelectedFontWeight() 15919 15920``` 15921void OH_ArkUI_SwiperDigitIndicator_SetSelectedFontWeight(ArkUI_SwiperDigitIndicator* indicator, ArkUI_FontWeight fontWeight) 15922``` 15923**Description** 15924 15925Sets the font weight of the selected digit-style navigation indicator for the **Swiper** component. 15926 15927**Since**: 15 15928 15929**Parameters** 15930 15931| Name| Description| 15932| -------- | -------- | 15933| indicator | Pointer to a digit-style navigation indicator. | 15934| fontWeight | Font weight, specified by an enumeration value of [ArkUI_FontWeight](#arkui_fontweight). | 15935 15936### OH_ArkUI_SwiperDigitIndicator_GetSelectedFontWeight() 15937 15938``` 15939ArkUI_FontWeight OH_ArkUI_SwiperDigitIndicator_GetSelectedFontWeight(ArkUI_SwiperDigitIndicator* indicator) 15940``` 15941**Description** 15942 15943 Obtains the font weight of the selected digit-style navigation indicator for the **Swiper** component. 15944 15945**Since**: 15 15946 15947**Parameters** 15948 15949| Name| Description| 15950| -------- | -------- | 15951| indicator | Pointer to a digit-style navigation indicator.| 15952 15953**Returns** 15954 15955Returns the font weight, specified by an enumeration value of [ArkUI_FontWeight](#arkui_fontweight). 15956 15957### OH_ArkUI_SwiperDigitIndicator_Dispose 15958 15959``` 15960void OH_ArkUI_SwiperDigitIndicator_Dispose(ArkUI_SwiperDigitIndicator* indicator) 15961``` 15962**Description** 15963 15964Disposes of the digit-style navigation indicator of this **Swiper** component. 15965 15966**Since**: 15 15967 15968**Parameters** 15969 15970| Name| Description| 15971| -------- | -------- | 15972| indicator | Pointer to a digit-style navigation indicator. | 15973 15974### OH_ArkUI_SwiperArrowStyle_Create() 15975 15976``` 15977ArkUI_SwiperArrowStyle *OH_ArkUI_SwiperArrowStyle_Create() 15978``` 15979**Description** 15980 15981Creates an arrow style for the **Swiper** component. 15982 15983**Since**: 15 15984 15985**Returns** 15986 15987Returns the pointer to the arrow object. 15988 15989### OH_ArkUI_SwiperArrowStyle_SetShowBackground() 15990 15991``` 15992void OH_ArkUI_SwiperArrowStyle_SetShowBackground(ArkUI_SwiperArrowStyle *arrowStyle, int32_t showBackground) 15993``` 15994**Description** 15995 15996Sets whether to display the background of the arrow for the **Swiper** component. 15997 15998**Since**: 15 15999 16000**Parameters** 16001 16002| Name| Description| 16003| -------- | -------- | 16004| arrowStyle | Pointer to the arrow object. | 16005| 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**. | 16006 16007### OH_ArkUI_SwiperArrowStyle_GetShowBackground() 16008 16009``` 16010int32_t OH_ArkUI_SwiperArrowStyle_GetShowBackground(ArkUI_SwiperArrowStyle* arrowStyle) 16011``` 16012**Description** 16013 16014 Checks whether the background of the arrow is displayed for the **Swiper** component. 16015 16016**Since**: 15 16017 16018**Parameters** 16019 16020| Name| Description| 16021| -------- | -------- | 16022| arrowStyle | Pointer to the arrow object.| 16023 16024**Returns** 16025 16026Returns whether the arrow background is displayed. The value **1** means that the background is displayed, and **0** means the opposite. 16027 16028### OH_ArkUI_SwiperArrowStyle_SetShowSidebarMiddle() 16029 16030``` 16031void OH_ArkUI_SwiperArrowStyle_SetShowSidebarMiddle(ArkUI_SwiperArrowStyle *arrowStyle, int32_t showSidebarMiddle) 16032``` 16033**Description** 16034 16035Sets the position of the arrow for the **Swiper** component. 16036 16037**Since**: 15 16038 16039**Parameters** 16040 16041| Name| Description| 16042| -------- | -------- | 16043| arrowStyle | Pointer to the arrow object. | 16044| 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**. | 16045 16046### OH_ArkUI_SwiperArrowStyle_GetShowSidebarMiddle() 16047 16048``` 16049int32_t OH_ArkUI_SwiperArrowStyle_GetShowSidebarMiddle(ArkUI_SwiperArrowStyle* arrowStyle) 16050``` 16051**Description** 16052 16053Obtains the position of the arrow for the **Swiper** component. 16054 16055**Since**: 15 16056 16057**Parameters** 16058 16059| Name| Description| 16060| -------- | -------- | 16061| arrowStyle | Pointer to the arrow object.| 16062 16063**Returns** 16064 16065Returns 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. 16066 16067### OH_ArkUI_SwiperArrowStyle_SetBackgroundSize() 16068 16069``` 16070void OH_ArkUI_SwiperArrowStyle_SetBackgroundSize(ArkUI_SwiperArrowStyle* arrowStyle, float backgroundSize) 16071``` 16072**Description** 16073 16074Sets the background size for the arrow of the **Swiper** component. 16075 16076**Since**: 15 16077 16078**Parameters** 16079 16080| Name| Description| 16081| -------- | -------- | 16082| arrowStyle | Pointer to the arrow object. | 16083| 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. | 16084 16085### OH_ArkUI_SwiperArrowStyle_GetBackgroundSize() 16086 16087``` 16088float OH_ArkUI_SwiperArrowStyle_GetBackgroundSize(ArkUI_SwiperArrowStyle* arrowStyle) 16089``` 16090**Description** 16091 16092Obtains the background size of the arrow of the **Swiper** component. 16093 16094**Since**: 15 16095 16096**Parameters** 16097 16098| Name| Description| 16099| -------- | -------- | 16100| arrowStyle | Pointer to the arrow object.| 16101 16102**Returns** 16103 16104Returns the background size of the arrow, in vp. 16105 16106### OH_ArkUI_SwiperArrowStyle_SetBackgroundColor() 16107 16108``` 16109void OH_ArkUI_SwiperArrowStyle_SetBackgroundColor(ArkUI_SwiperArrowStyle* arrowStyle, uint32_t backgroundColor) 16110``` 16111**Description** 16112 16113Sets the background color for the arrow of the **Swiper** component. 16114 16115**Since**: 15 16116 16117**Parameters** 16118 16119| Name| Description| 16120| -------- | -------- | 16121| arrowStyle | Pointer to the arrow object. | 16122| backgroundColor | Background color of the arrow, in 0xARGB format. For example, 0xFFFF0000 indicates red. | 16123 16124### OH_ArkUI_SwiperArrowStyle_GetBackgroundColor() 16125 16126``` 16127uint32_t OH_ArkUI_SwiperArrowStyle_GetBackgroundColor(ArkUI_SwiperArrowStyle* arrowStyle) 16128``` 16129**Description** 16130 16131Obtains the background color for the arrow of the **Swiper** component. 16132 16133**Since**: 15 16134 16135**Parameters** 16136 16137| Name| Description| 16138| -------- | -------- | 16139| arrowStyle | Pointer to the arrow object.| 16140 16141**Returns** 16142 16143Returns the background color of the arrow, in 0xARGB format. For example, 0xFFFF0000 indicates red. 16144 16145### OH_ArkUI_SwiperArrowStyle_SetArrowSize() 16146 16147``` 16148void OH_ArkUI_SwiperArrowStyle_SetArrowSize(ArkUI_SwiperArrowStyle* arrowStyle, float arrowSize) 16149``` 16150**Description** 16151 16152Sets the size for the arrow of the **Swiper** component. 16153 16154**Since**: 15 16155 16156**Parameters** 16157 16158| Name| Description| 16159| -------- | -------- | 16160| arrowStyle | Pointer to the arrow object. | 16161| 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**.| 16162 16163### OH_ArkUI_SwiperArrowStyle_GetArrowSize() 16164 16165``` 16166float OH_ArkUI_SwiperArrowStyle_GetArrowSize(ArkUI_SwiperArrowStyle* arrowStyle) 16167``` 16168**Description** 16169 16170Obtains the size of the arrow of the **Swiper** component. 16171 16172**Since**: 15 16173 16174**Parameters** 16175 16176| Name| Description| 16177| -------- | -------- | 16178| arrowStyle | Pointer to the arrow object.| 16179 16180**Returns** 16181 16182Returns the size of the arrow, in vp. 16183 16184### OH_ArkUI_SwiperArrowStyle_SetArrowColor() 16185 16186``` 16187void OH_ArkUI_SwiperArrowStyle_SetArrowColor(ArkUI_SwiperArrowStyle* arrowStyle, uint32_t arrowColor) 16188``` 16189**Description** 16190 16191Sets the color for the arrow of the **Swiper** component. 16192 16193**Since**: 15 16194 16195**Parameters** 16196 16197| Name| Description| 16198| -------- | -------- | 16199| arrowStyle | Pointer to the arrow object. | 16200| arrowColor | Color of the arrow, in 0xARGB format. For example, 0xFFFF0000 indicates red.| 16201 16202### OH_ArkUI_SwiperArrowStyle_GetArrowColor() 16203 16204``` 16205uint32_t OH_ArkUI_SwiperArrowStyle_GetArrowColor(ArkUI_SwiperArrowStyle* arrowStyle) 16206``` 16207**Description** 16208 16209Obtains the color of the arrow of the **Swiper** component. 16210 16211**Since**: 15 16212 16213**Parameters** 16214 16215| Name| Description| 16216| -------- | -------- | 16217| arrowStyle | Pointer to the arrow object.| 16218 16219**Returns** 16220 16221Returns the color of the arrow, in 0xARGB format. For example, 0xFFFF0000 indicates red. 16222 16223### OH_ArkUI_SwiperArrowStyle_Dispose 16224 16225``` 16226void OH_ArkUI_SwiperArrowStyle_Dispose(ArkUI_SwiperArrowStyle* arrowStyle) 16227``` 16228**Description** 16229 16230Disposes of the arrow of the **Swiper** component. 16231 16232**Since**: 15 16233 16234**Parameters** 16235 16236| Name| Description| 16237| -------- | -------- | 16238| arrowStyle | Pointer to the arrow object. | 16239 16240### OH_ArkUI_SwiperIndicator_GetSelectedColor() 16241 16242``` 16243uint32_t OH_ArkUI_SwiperIndicator_GetSelectedColor (ArkUI_SwiperIndicator * indicator) 16244``` 16245**Description** 16246 16247Obtains the color of the selected dot-style navigation indicator of the **Swiper** component. 16248 16249**Since**: 12 16250 16251**Parameters** 16252 16253| Name| Description| 16254| -------- | -------- | 16255| indicator | Returns the pointer to the navigation indicator. | 16256 16257**Returns** 16258 16259Returns the color, in 0xARGB format. For example, 0xFFFF0000 indicates red. 16260 16261 16262### OH_ArkUI_SwiperIndicator_GetSelectedItemHeight() 16263 16264``` 16265float OH_ArkUI_SwiperIndicator_GetSelectedItemHeight (ArkUI_SwiperIndicator * indicator) 16266``` 16267**Description** 16268 16269Obtains the height of the selected dot-style navigation indicator of the **Swiper** component. 16270 16271**Since**: 12 16272 16273**Parameters** 16274 16275| Name| Description| 16276| -------- | -------- | 16277| indicator | Returns the pointer to the navigation indicator. | 16278 16279**Returns** 16280 16281Returns the height of the dot-style navigation indicator. 16282 16283 16284### OH_ArkUI_SwiperIndicator_GetSelectedItemWidth() 16285 16286``` 16287float OH_ArkUI_SwiperIndicator_GetSelectedItemWidth (ArkUI_SwiperIndicator * indicator) 16288``` 16289**Description** 16290 16291Obtains the width of the selected dot-style navigation indicator of the **Swiper** component. 16292 16293**Since**: 12 16294 16295**Parameters** 16296 16297| Name| Description| 16298| -------- | -------- | 16299| indicator | Returns the pointer to the navigation indicator. | 16300 16301**Returns** 16302 16303Returns the width of the dot-style navigation indicator. 16304 16305 16306### OH_ArkUI_SwiperIndicator_GetStartPosition() 16307 16308``` 16309float OH_ArkUI_SwiperIndicator_GetStartPosition (ArkUI_SwiperIndicator * indicator) 16310``` 16311**Description** 16312 16313Obtains the distance between a navigation indicator and the left edge of the **Swiper** component. 16314 16315**Since**: 12 16316 16317**Parameters** 16318 16319| Name| Description| 16320| -------- | -------- | 16321| indicator | Returns the pointer to the navigation indicator. | 16322 16323**Returns** 16324 16325Returns the distance between the navigation indicator and the left edge of the **Swiper** component. 16326 16327 16328### OH_ArkUI_SwiperIndicator_GetTopPosition() 16329 16330``` 16331float OH_ArkUI_SwiperIndicator_GetTopPosition (ArkUI_SwiperIndicator * indicator) 16332``` 16333**Description** 16334 16335Obtains the distance between the navigation indicator and the top edge of the **Swiper** component. 16336 16337**Since**: 12 16338 16339**Parameters** 16340 16341| Name| Description| 16342| -------- | -------- | 16343| indicator | Returns the pointer to the navigation indicator. | 16344 16345**Returns** 16346 16347Returns the distance between a navigation indicator and the top edge of the **Swiper** component. 16348 16349 16350### OH_ArkUI_SwiperIndicator_SetBottomPosition() 16351 16352``` 16353void OH_ArkUI_SwiperIndicator_SetBottomPosition (ArkUI_SwiperIndicator * indicator, float value ) 16354``` 16355**Description** 16356 16357Sets the distance between the navigation indicator and the bottom edge of the **Swiper** component. 16358 16359**Since**: 12 16360 16361**Parameters** 16362 16363| Name| Description| 16364| -------- | -------- | 16365| indicator | Pointer to a navigation indicator. | 16366| value | Distance between a navigation indicator and the bottom edge of the **Swiper** component. | 16367 16368 16369### OH_ArkUI_SwiperIndicator_SetColor() 16370 16371``` 16372void OH_ArkUI_SwiperIndicator_SetColor (ArkUI_SwiperIndicator * indicator, uint32_t color ) 16373``` 16374**Description** 16375 16376Sets the color of a dot-style navigation indicator for the **Swiper** component. 16377 16378**Since**: 12 16379 16380**Parameters** 16381 16382| Name| Description| 16383| -------- | -------- | 16384| indicator | Returns the pointer to the navigation indicator. | 16385| color | Color, in 0xARGB format. For example, 0xFFFF0000 indicates red. | 16386 16387 16388### OH_ArkUI_SwiperIndicator_SetEndPosition() 16389 16390``` 16391void OH_ArkUI_SwiperIndicator_SetEndPosition (ArkUI_SwiperIndicator * indicator, float value ) 16392``` 16393**Description** 16394 16395Distance between the navigation indicator and the left edge of the **Swiper** component. 16396 16397**Since**: 12 16398 16399**Parameters** 16400 16401| Name| Description| 16402| -------- | -------- | 16403| indicator | Pointer to a navigation indicator. | 16404| value | Returns the distance between the navigation indicator and the right edge of the **Swiper** component. | 16405 16406 16407### OH_ArkUI_SwiperIndicator_SetItemHeight() 16408 16409``` 16410void OH_ArkUI_SwiperIndicator_SetItemHeight (ArkUI_SwiperIndicator * indicator, float value ) 16411``` 16412**Description** 16413 16414Sets the height of a dot-style navigation indicator for the **Swiper** component. 16415 16416**Since**: 12 16417 16418**Parameters** 16419 16420| Name| Description| 16421| -------- | -------- | 16422| indicator | Pointer to a navigation indicator. | 16423| value | Returns the height of the dot-style navigation indicator. | 16424 16425 16426### OH_ArkUI_SwiperIndicator_SetItemWidth() 16427 16428``` 16429void OH_ArkUI_SwiperIndicator_SetItemWidth (ArkUI_SwiperIndicator * indicator, float value ) 16430``` 16431**Description** 16432 16433Sets the width of a dot-style navigation indicator for the **Swiper** component. 16434 16435**Since**: 12 16436 16437**Parameters** 16438 16439| Name| Description| 16440| -------- | -------- | 16441| indicator | Pointer to a navigation indicator. | 16442| value | Returns the width of the dot-style navigation indicator. | 16443 16444 16445### OH_ArkUI_SwiperIndicator_SetMask() 16446 16447``` 16448void OH_ArkUI_SwiperIndicator_SetMask (ArkUI_SwiperIndicator * indicator, int32_t mask ) 16449``` 16450**Description** 16451 16452Sets whether to enable the mask for a dot-style navigation indicator for the **Swiper** component. 16453 16454**Since**: 12 16455 16456**Parameters** 16457 16458| Name| Description| 16459| -------- | -------- | 16460| indicator | Pointer to a navigation indicator. | 16461| mask | Whether to enable the mask. The value **1** means to enable the mask, and **0** means the opposite. | 16462 16463 16464### OH_ArkUI_SwiperIndicator_SetMaxDisplayCount() 16465 16466``` 16467int32_t OH_ArkUI_SwiperIndicator_SetMaxDisplayCount (ArkUI_SwiperIndicator * indicator, int32_t maxDisplayCount ) 16468``` 16469**Description** 16470 16471Sets the maximum number of dots for the dot-style navigation indicator. 16472 16473**Since**: 12 16474 16475**Parameters** 16476 16477| Name| Description| 16478| -------- | -------- | 16479| indicator | Pointer to a navigation indicator. | 16480| maxDisplayCount | Maximum number of navigation points. The value ranges from 6 to 9. | 16481 16482**Returns** 16483 16484Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if **maxDisplayCount** is set to an invalid value. 16485 16486 16487### OH_ArkUI_SwiperIndicator_SetSelectedColor() 16488 16489``` 16490void OH_ArkUI_SwiperIndicator_SetSelectedColor (ArkUI_SwiperIndicator * indicator, uint32_t selectedColor ) 16491``` 16492**Description** 16493 16494Sets the color of the selected dot-style navigation indicator for the **Swiper** component. 16495 16496**Since**: 12 16497 16498**Parameters** 16499 16500| Name| Description| 16501| -------- | -------- | 16502| indicator | Pointer to a navigation indicator. | 16503| selectedColor | Color, in 0xARGB format. For example, 0xFFFF0000 indicates red. | 16504 16505 16506### OH_ArkUI_SwiperIndicator_SetSelectedItemHeight() 16507 16508``` 16509void OH_ArkUI_SwiperIndicator_SetSelectedItemHeight (ArkUI_SwiperIndicator * indicator, float value ) 16510``` 16511**Description** 16512 16513Sets the height of the selected dot-style navigation indicator for the **Swiper** component. 16514 16515**Since**: 12 16516 16517**Parameters** 16518 16519| Name| Description| 16520| -------- | -------- | 16521| indicator | Pointer to a navigation indicator. | 16522| value | Height of the dot-style navigation indicator. | 16523 16524 16525### OH_ArkUI_SwiperIndicator_SetSelectedItemWidth() 16526 16527``` 16528void OH_ArkUI_SwiperIndicator_SetSelectedItemWidth (ArkUI_SwiperIndicator * indicator, float value ) 16529``` 16530**Description** 16531 16532Sets the width of the selected dot-style navigation indicator for the **Swiper** component. 16533 16534**Since**: 12 16535 16536**Parameters** 16537 16538| Name| Description| 16539| -------- | -------- | 16540| indicator | Pointer to a navigation indicator. | 16541| value | Width of the dot-style navigation indicator. | 16542 16543 16544### OH_ArkUI_SwiperIndicator_SetStartPosition() 16545 16546``` 16547void OH_ArkUI_SwiperIndicator_SetStartPosition (ArkUI_SwiperIndicator * indicator, float value ) 16548``` 16549**Description** 16550 16551Sets the distance between the navigation indicator and the left edge of the **Swiper** component. 16552 16553**Since**: 12 16554 16555**Parameters** 16556 16557| Name| Description| 16558| -------- | -------- | 16559| indicator | Pointer to a navigation indicator. | 16560| value | Distance between the navigation indicator and the left edge of the **Swiper** component. | 16561 16562 16563### OH_ArkUI_SwiperIndicator_SetTopPosition() 16564 16565``` 16566void OH_ArkUI_SwiperIndicator_SetTopPosition (ArkUI_SwiperIndicator * indicator, float value ) 16567``` 16568**Description** 16569 16570Sets the distance between the navigation indicator and the top edge of the **Swiper** component. 16571 16572**Since**: 12 16573 16574**Parameters** 16575 16576| Name| Description| 16577| -------- | -------- | 16578| indicator | Pointer to a navigation indicator. | 16579| value | Distance between a navigation indicator and the top edge of the **Swiper** component. | 16580 16581 16582### OH_ArkUI_SystemFontStyleEvent_GetFontSizeScale() 16583 16584``` 16585float OH_ArkUI_SystemFontStyleEvent_GetFontSizeScale (const ArkUI_SystemFontStyleEvent * event) 16586``` 16587**Description** 16588 16589Obtains the font size scale from the system font style change event. 16590 16591**Since**: 12 16592 16593**Parameters** 16594 16595| Name| Description| 16596| -------- | -------- | 16597| event | Pointer to the current system font style change event. | 16598 16599**Returns** 16600 16601Returns the font size scale after the change. Default value: **1.0**. 16602 16603 16604### OH_ArkUI_SystemFontStyleEvent_GetFontWeightScale() 16605 16606``` 16607float OH_ArkUI_SystemFontStyleEvent_GetFontWeightScale (const ArkUI_SystemFontStyleEvent * event) 16608``` 16609**Description** 16610 16611Obtains the font weight scale from the system font style change event. 16612 16613**Since**: 12 16614 16615**Parameters** 16616 16617| Name| Description| 16618| -------- | -------- | 16619| event | Pointer to the current system font style change event. | 16620 16621**Returns** 16622 16623Returns the font weight scale after the change. Default value: **1.0**. 16624 16625 16626### OH_ArkUI_TransitionEffect_Combine() 16627 16628``` 16629int32_t OH_ArkUI_TransitionEffect_Combine (ArkUI_TransitionEffect * option, ArkUI_TransitionEffect * combine ) 16630``` 16631**Description** 16632 16633Sets a combination of transition effects. 16634 16635**Since**: 12 16636 16637**Parameters** 16638 16639| Name| Description| 16640| -------- | -------- | 16641| option | Transition effect options. | 16642| combine | Combination of transition effects. | 16643 16644**Returns** 16645 16646Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 16647 16648 16649### OH_ArkUI_TransitionEffect_Dispose() 16650 16651``` 16652void OH_ArkUI_TransitionEffect_Dispose (ArkUI_TransitionEffect * option) 16653``` 16654**Description** 16655 16656Destroys a transition effect object. 16657 16658**Since**: 12 16659 16660**Parameters** 16661 16662| Name| Description| 16663| -------- | -------- | 16664| option | Transition effect object. | 16665 16666 16667### OH_ArkUI_TransitionEffect_SetAnimation() 16668 16669``` 16670int32_t OH_ArkUI_TransitionEffect_SetAnimation (ArkUI_TransitionEffect * option, ArkUI_AnimateOption * animation ) 16671``` 16672**Description** 16673 16674Sets transition effect animation settings. 16675 16676**Since**: 12 16677 16678**Parameters** 16679 16680| Name| Description| 16681| -------- | -------- | 16682| option | Transition effect options. | 16683| animation | Animation settings. | 16684 16685**NOTE** 16686 16687If **combine** is used for combining transition effects, the animation settings of a transition effect are applicable to the one following it. 16688 16689**Returns** 16690 16691Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 16692 16693 16694### OH_ArkUI_UnmarshallStyledStringDescriptor() 16695 16696``` 16697int32_t OH_ArkUI_UnmarshallStyledStringDescriptor (uint8_t * buffer, size_t bufferSize, ArkUI_StyledString_Descriptor * descriptor, size_t * resultSize ) 16698``` 16699**Description** 16700 16701Deserializes a byte array containing styled string information into a styled string. 16702 16703**Since**: 14 16704 16705**Parameters** 16706 16707| Name| Description| 16708| -------- | -------- | 16709| buffer | Byte array to be deserialized. | 16710| bufferSize | Length of the byte array. | 16711| descriptor | Pointer to an **ArkUI_StyledString_Descriptor** object. | 16712| resultSize | Actual length of the resulting byte array after deserialization. | 16713 16714**Returns** 16715 16716Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 16717 16718 16719### OH_ArkUI_UnregisterSystemColorModeChangeEvent() 16720 16721``` 16722void OH_ArkUI_UnregisterSystemColorModeChangeEvent (ArkUI_NodeHandle node) 16723``` 16724**Description** 16725 16726Unregisters the event listener for system color mode changes. 16727 16728**Since**: 12 16729 16730**Parameters** 16731 16732| Name| Description| 16733| -------- | -------- | 16734| node | Specified node. | 16735 16736 16737### OH_ArkUI_UnregisterSystemFontStyleChangeEvent() 16738 16739``` 16740void OH_ArkUI_UnregisterSystemFontStyleChangeEvent (ArkUI_NodeHandle node) 16741``` 16742**Description** 16743 16744Unregisters the event listener for system font style changes. 16745 16746**Since**: 12 16747 16748**Parameters** 16749 16750| Name| Description| 16751| -------- | -------- | 16752| node | Specified node. | 16753 16754 16755### OH_ArkUI_WaterFlowSectionOption_Create() 16756 16757``` 16758ArkUI_WaterFlowSectionOption* OH_ArkUI_WaterFlowSectionOption_Create () 16759``` 16760**Description** 16761 16762Creates a water flow section configuration. 16763 16764**Since**: 12 16765 16766**Returns** 16767 16768Return the pointer to the created water flow section configuration. 16769 16770 16771### OH_ArkUI_WaterFlowSectionOption_Dispose() 16772 16773``` 16774void OH_ArkUI_WaterFlowSectionOption_Dispose (ArkUI_WaterFlowSectionOption * option) 16775``` 16776**Description** 16777 16778Disposes of the pointer to a water flow section configuration. 16779 16780**Since**: 12 16781 16782**Parameters** 16783 16784| Name| Description| 16785| -------- | -------- | 16786| option | Pointer to a water flow section configuration. | 16787 16788 16789### OH_ArkUI_WaterFlowSectionOption_GetColumnGap() 16790 16791``` 16792float OH_ArkUI_WaterFlowSectionOption_GetColumnGap (ArkUI_WaterFlowSectionOption * option, int32_t index ) 16793``` 16794**Description** 16795 16796Obtains the gap between columns in the water flow section that matches the specified index. 16797 16798**Since**: 12 16799 16800**Parameters** 16801 16802| Name| Description| 16803| -------- | -------- | 16804| option | Pointer to a water flow section configuration. | 16805| index | Index of the target water flow section. | 16806 16807**Returns** 16808 16809Returns the gap between columns. 16810 16811 16812### OH_ArkUI_WaterFlowSectionOption_GetCrossCount() 16813 16814``` 16815int32_t OH_ArkUI_WaterFlowSectionOption_GetCrossCount (ArkUI_WaterFlowSectionOption * option, int32_t index ) 16816``` 16817**Description** 16818 16819Obtains the number of columns (in a vertical layout) or rows (in a horizontal layout) of a water flow. 16820 16821**Since**: 12 16822 16823**Parameters** 16824 16825| Name| Description| 16826| -------- | -------- | 16827| option | Pointer to a water flow section configuration. | 16828| index | Index of the target water flow section. | 16829 16830**Returns** 16831 16832Returns the number of columns (in a vertical layout) or rows (in a horizontal layout) of a water flow. 16833 16834 16835### OH_ArkUI_WaterFlowSectionOption_GetItemCount() 16836 16837``` 16838int32_t OH_ArkUI_WaterFlowSectionOption_GetItemCount (ArkUI_WaterFlowSectionOption * option, int32_t index ) 16839``` 16840**Description** 16841 16842Obtains the number of items in the water flow section that matches the specified index. 16843 16844**Since**: 12 16845 16846**Parameters** 16847 16848| Name| Description| 16849| -------- | -------- | 16850| option | Pointer to a water flow section configuration. | 16851| index | Index of the target water flow section. | 16852 16853**Returns** 16854 16855Returns the number of items in the water flow section. 16856 16857 16858### OH_ArkUI_WaterFlowSectionOption_GetMargin() 16859 16860``` 16861ArkUI_Margin OH_ArkUI_WaterFlowSectionOption_GetMargin (ArkUI_WaterFlowSectionOption * option, int32_t index ) 16862``` 16863**Description** 16864 16865Obtains the margins of the water flow section that matches the specified index. 16866 16867**Since**: 12 16868 16869**Parameters** 16870 16871| Name| Description| 16872| -------- | -------- | 16873| option | Pointer to a water flow section configuration. | 16874| index | Index of the target water flow section. | 16875 16876**Returns** 16877 16878Returns the margins. 16879 16880 16881### OH_ArkUI_WaterFlowSectionOption_GetRowGap() 16882 16883``` 16884float OH_ArkUI_WaterFlowSectionOption_GetRowGap (ArkUI_WaterFlowSectionOption * option, int32_t index ) 16885``` 16886**Description** 16887 16888Obtains the gap between rows in the water flow section that matches the specified index. 16889 16890**Since**: 12 16891 16892**Parameters** 16893 16894| Name| Description| 16895| -------- | -------- | 16896| option | Pointer to a water flow section configuration. | 16897| index | Index of the target water flow section. | 16898 16899**Returns** 16900 16901Returns the gap between rows. 16902 16903 16904### OH_ArkUI_WaterFlowSectionOption_GetSize() 16905 16906``` 16907int32_t OH_ArkUI_WaterFlowSectionOption_GetSize (ArkUI_WaterFlowSectionOption * option) 16908``` 16909**Description** 16910 16911Sets the array length for a water flow section configuration. 16912 16913**Since**: 12 16914 16915**Parameters** 16916 16917| Name| Description| 16918| -------- | -------- | 16919| option | Pointer to a water flow section configuration. | 16920 16921**Returns** 16922 16923Returns 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. 16924 16925 16926### OH_ArkUI_WaterFlowSectionOption_RegisterGetItemMainSizeCallbackByIndex() 16927 16928``` 16929void OH_ArkUI_WaterFlowSectionOption_RegisterGetItemMainSizeCallbackByIndex (ArkUI_WaterFlowSectionOption * option, int32_t index, float(*)(int32_t itemIndex) callback ) 16930``` 16931**Description** 16932 16933Obtains the main axis size of a specified item based on **flowItemIndex** through a water flow section configuration. 16934 16935**Since**: 12 16936 16937**Parameters** 16938 16939| Name| Description| 16940| -------- | -------- | 16941| option | Pointer to a water flow section configuration. | 16942| index | Index of the target water flow section. | 16943| callback | Callback used to return the result. | 16944 16945 16946### OH_ArkUI_WaterFlowSectionOption_RegisterGetItemMainSizeCallbackByIndexWithUserData() 16947 16948``` 16949void OH_ArkUI_WaterFlowSectionOption_RegisterGetItemMainSizeCallbackByIndexWithUserData (ArkUI_WaterFlowSectionOption * option, int32_t index, void * userData, float(*)(int32_t itemIndex, void *userData) callback ) 16950``` 16951**Description** 16952 16953Obtains the main axis size of a specified item based on **flowItemIndex** through a water flow section configuration. 16954 16955**Since**: 12 16956 16957**Parameters** 16958 16959| Name| Description| 16960| -------- | -------- | 16961| option | Pointer to a water flow section configuration. | 16962| index | Index of the target water flow section. | 16963| userData | Custom data of the water flow item. | 16964| callback | Callback used to return the result. | 16965 16966 16967### OH_ArkUI_WaterFlowSectionOption_SetColumnGap() 16968 16969``` 16970void OH_ArkUI_WaterFlowSectionOption_SetColumnGap (ArkUI_WaterFlowSectionOption * , int32_t index, float columnGap ) 16971``` 16972**Description** 16973 16974Sets the gap between columns in the specified water flow section. 16975 16976**Since**: 12 16977 16978**Parameters** 16979 16980| Name| Description| 16981| -------- | -------- | 16982| option | Pointer to a water flow section configuration. | 16983| index | Index of the target water flow section. | 16984| columnGap | Gap between columns. | 16985 16986 16987### OH_ArkUI_WaterFlowSectionOption_SetCrossCount() 16988 16989``` 16990void OH_ArkUI_WaterFlowSectionOption_SetCrossCount (ArkUI_WaterFlowSectionOption * option, int32_t index, int32_t crossCount ) 16991``` 16992**Description** 16993 16994Sets the number of columns (in a vertical layout) or rows (in a horizontal layout) of a water flow. 16995 16996**Since**: 12 16997 16998**Parameters** 16999 17000| Name| Description| 17001| -------- | -------- | 17002| option | Pointer to a water flow section configuration. | 17003| index | Index of the target water flow section. | 17004| crossCount | Number of columns or rows, depending on the layout direction. | 17005 17006 17007### OH_ArkUI_WaterFlowSectionOption_SetItemCount() 17008 17009``` 17010void OH_ArkUI_WaterFlowSectionOption_SetItemCount (ArkUI_WaterFlowSectionOption * option, int32_t index, int32_t itemCount ) 17011``` 17012**Description** 17013 17014Sets the number of items in a water flow section. 17015 17016**Since**: 12 17017 17018**Parameters** 17019 17020| Name| Description| 17021| -------- | -------- | 17022| option | Pointer to a water flow section configuration. | 17023| index | Index of the target water flow section. | 17024| itemCount | Number of items in the water flow section. | 17025 17026 17027### OH_ArkUI_WaterFlowSectionOption_SetMargin() 17028 17029``` 17030void OH_ArkUI_WaterFlowSectionOption_SetMargin (ArkUI_WaterFlowSectionOption * option, int32_t index, float marginTop, float marginRight, float marginBottom, float marginLeft ) 17031``` 17032**Description** 17033 17034Sets the margins for the specified water flow section. 17035 17036**Since**: 12 17037 17038**Parameters** 17039 17040| Name| Description| 17041| -------- | -------- | 17042| option | Pointer to a water flow section configuration. | 17043| index | Index of the target water flow section. | 17044| marginTop | Top margin of the water flow section. | 17045| marginRight | Right margin of the water flow section. | 17046| marginBottom | Bottom margin of the water flow section. | 17047| marginLeft | Left margin of the water flow section. | 17048 17049 17050### OH_ArkUI_WaterFlowSectionOption_SetRowGap() 17051 17052``` 17053void OH_ArkUI_WaterFlowSectionOption_SetRowGap (ArkUI_WaterFlowSectionOption * option, int32_t index, float rowGap ) 17054``` 17055**Description** 17056 17057Sets the gap between rows in the specified water flow section. 17058 17059**Since**: 12 17060 17061**Parameters** 17062 17063| Name| Description| 17064| -------- | -------- | 17065| option | Pointer to a water flow section configuration. | 17066| index | Index of the target water flow section. | 17067| rowGap | Gap between rows to set. | 17068 17069 17070### OH_ArkUI_WaterFlowSectionOption_SetSize() 17071 17072``` 17073void OH_ArkUI_WaterFlowSectionOption_SetSize (ArkUI_WaterFlowSectionOption * option, int32_t size ) 17074``` 17075**Description** 17076 17077Sets the array length for a water flow section configuration. 17078 17079**Since**: 12 17080 17081**Parameters** 17082 17083| Name| Description| 17084| -------- | -------- | 17085| option | Pointer to a water flow section configuration. | 17086| size | Size of the array. | 17087 17088 17089### OH_ArkUI_PostFrameCallback() 17090 17091``` 17092int32_t OH_ArkUI_PostFrameCallback(ArkUI_ContextHandle uiContext, void* userData, void (*callback)(uint64_t nanoTimestamp, uint32_t frameCount, void* userData)) 17093``` 17094**Description** 17095 17096Registers 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. 17097 17098**Since**: 16 17099 17100**Parameters** 17101 17102| Name| Description| 17103| -------- | -------- | 17104| uiContext | UI context object used to bind the instance.| 17105| userData | Custom event parameter, which is passed in the callback when the event is triggered.| 17106| callback | Custom callback to be invoked after the next frame event completes.| 17107| nanoTimestamp | Timestamp of the frame signal.| 17108| frameCount | Frame number.| 17109 17110**Returns** 17111 17112Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17113Returns **ARKUI_ERROR_CODE_CAPI_INIT_ERROR** if there is an API initialization error. 17114Returns **ARKUI_ERROR_CODE_UI_CONTEXT_INVALID** if the UIContext object is invalid. 17115Returns **ARKUI_ERROR_CODE_CALLBACK_INVALID** if the callback is invalid. 17116 17117 17118### OH_ArkUI_RegisterLayoutCallbackOnNodeHandle() 17119 17120``` 17121int32_t OH_ArkUI_RegisterLayoutCallbackOnNodeHandle (ArkUI_NodeHandle node, void* userData, void (*onLayoutCompleted)(void* userData)) 17122``` 17123**Description** 17124 17125Registers a layout completion callback function for a specific component. Only one layout completion callback can be registered per component. 17126 17127**Since**: 16 17128 17129**Parameters** 17130 17131| Name| Description| 17132| -------- | -------- | 17133| node | Specified node. | 17134| userData | Custom event parameter, which is passed in the callback when the event is triggered. | 17135| onLayoutCompleted | Callback to be executed when the event is triggered. | 17136 17137**Returns** 17138 17139Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17140Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17141 17142 17143### OH_ArkUI_RegisterDrawCallbackOnNodeHandle() 17144 17145``` 17146int32_t OH_ArkUI_RegisterDrawCallbackOnNodeHandle (ArkUI_NodeHandle node, void* userData, void (*onDrawCompleted)(void* userData)) 17147``` 17148**Description** 17149 17150Registers a drawing completion callback function for a specific component. Only one drawing completion callback can be registered per component. 17151 17152**Since**: 16 17153 17154**Parameters** 17155 17156| Name| Description| 17157| -------- | -------- | 17158| node | Specified node. | 17159| userData | Custom event parameter, which is passed in the callback when the event is triggered. | 17160| onDrawCompleted | Callback to be executed when the event is triggered. | 17161 17162**Returns** 17163 17164Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17165Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17166 17167 17168### OH_ArkUI_UnregisterLayoutCallbackOnNodeHandle() 17169 17170``` 17171int32_t OH_ArkUI_UnregisterLayoutCallbackOnNodeHandle (ArkUI_NodeHandle node) 17172``` 17173**Description** 17174 17175Unregisters the layout completion callback function for a specific component. 17176 17177**Since**: 16 17178 17179**Parameters** 17180 17181| Name| Description| 17182| -------- | -------- | 17183| node | Specified node. | 17184 17185**Returns** 17186 17187Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17188Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17189 17190 17191### OH_ArkUI_UnregisterDrawCallbackOnNodeHandle() 17192 17193``` 17194int32_t OH_ArkUI_UnregisterDrawCallbackOnNodeHandle (ArkUI_NodeHandle node) 17195``` 17196**Description** 17197 17198Unregisters the drawing completion callback function for a specific component. 17199 17200**Since**: 16 17201 17202**Parameters** 17203 17204| Name| Description| 17205| -------- | -------- | 17206| node | Specified node. | 17207 17208**Returns** 17209 17210Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17211Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17212 17213 17214### OH_ArkUI_ProgressLinearStyleOption_Create 17215 17216``` 17217ArkUI_ProgressLinearStyleOption* OH_ArkUI_ProgressLinearStyleOption_Create(void) 17218``` 17219**Description** 17220 17221Creates a **ProgressLinearStyleOption** instance. 17222 17223**Since**: 15 17224 17225**Returns** 17226 17227Returns the **ProgressLinearStyleOption** instance created. 17228 17229 17230### OH_ArkUI_ProgressLinearStyleOption_Destroy 17231 17232``` 17233void OH_ArkUI_ProgressLinearStyleOption_Destroy(ArkUI_ProgressLinearStyleOption* option) 17234``` 17235**Description** 17236 17237Destroys a **ProgressLinearStyleOption** instance. 17238 17239**Since**: 15 17240 17241**Parameters** 17242 17243| Name| Description| 17244| -------- | -------- | 17245| option | **ProgressLinearStyleOption** instance to destroy. | 17246 17247 17248### OH_ArkUI_ProgressLinearStyleOption_SetScanEffectEnabled 17249 17250``` 17251void OH_ArkUI_ProgressLinearStyleOption_SetSmoothEffectEnabled(ArkUI_ProgressLinearStyleOption* option, bool enabled) 17252``` 17253**Description** 17254 17255Sets whether to enable the scan effect. 17256 17257**Since**: 15 17258 17259 17260**Parameters** 17261 17262| Name| Description| 17263| -------- | -------- | 17264| option | Pointer to the **ProgressLinearStyleOption** instance. | 17265| enabled | Whether to enable the scan effect. The default value is **false**.| 17266 17267 17268### OH_ArkUI_ProgressLinearStyleOption_SetSmoothEffectEnabled 17269 17270``` 17271void OH_ArkUI_ProgressLinearStyleOption_SetSmoothEffectEnabled(ArkUI_ProgressLinearStyleOption* option, bool enabled) 17272``` 17273**Description** 17274 17275Sets whether to enable the smooth progress effect. 17276 17277**Since**: 15 17278 17279 17280**Parameters** 17281 17282| Name| Description| 17283| -------- | -------- | 17284| option | Pointer to the **ProgressLinearStyleOption** instance. | 17285| 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**.| 17286 17287 17288### OH_ArkUI_ProgressLinearStyleOption_SetStrokeWidth 17289 17290``` 17291void OH_ArkUI_ProgressLinearStyleOption_SetStrokeWidth(ArkUI_ProgressLinearStyleOption* option, float strokeWidth) 17292``` 17293**Description** 17294 17295Sets the stroke width of the linear progress indicator. 17296 17297**Since**: 15 17298 17299 17300**Parameters** 17301 17302| Name| Description| 17303| -------- | -------- | 17304| option | Pointer to the **ProgressLinearStyleOption** instance. | 17305| strokeWidth | Stroke width of the progress indicator. The value cannot be set in percentage. The default value is **4.0vp**.| 17306 17307 17308### OH_ArkUI_ProgressLinearStyleOption_SetStrokeRadius 17309 17310``` 17311void OH_ArkUI_ProgressLinearStyleOption_SetStrokeRadius(ArkUI_ProgressLinearStyleOption* option, float strokeRadius) 17312``` 17313**Description** 17314 17315Sets the corner radius of the linear progress indicator. 17316 17317**Since**: 15 17318 17319 17320**Parameters** 17321 17322| Name| Description| 17323| -------- | -------- | 17324| option | Pointer to the **ProgressLinearStyleOption** instance. | 17325| strokeRadius | Corner radius of the progress indicator. The value range is [0, strokeWidth/2]. Default value: **strokeWidth/2**.| 17326 17327 17328### OH_ArkUI_ProgressLinearStyleOption_GetScanEffectEnabled 17329 17330``` 17331bool OH_ArkUI_ProgressLinearStyleOption_GetScanEffectEnabled(ArkUI_ProgressLinearStyleOption* option) 17332``` 17333**Description** 17334 17335Obtains the enabled status of the scan effect for the linear progress indicator. 17336 17337**Since**: 15 17338 17339**Parameters** 17340 17341| Name| Description| 17342| -------- | -------- | 17343| option | Pointer to the **ProgressLinearStyleOption** instance. | 17344 17345**Returns** 17346 17347Returns the enabled status of the scan effect. 17348 17349 17350### OH_ArkUI_ProgressLinearStyleOption_GetSmoothEffectEnabled 17351 17352``` 17353bool OH_ArkUI_ProgressLinearStyleOption_GetSmoothEffectEnabled(ArkUI_ProgressLinearStyleOption* option) 17354``` 17355**Description** 17356 17357Obtains the enabled status of the smooth progress effect for the linear progress indicator. 17358 17359**Since**: 15 17360 17361**Parameters** 17362 17363| Name| Description| 17364| -------- | -------- | 17365| option | Pointer to the **ProgressLinearStyleOption** instance. | 17366 17367**Returns** 17368 17369Returns the enabled status of the smooth progress effect. 17370 17371 17372### OH_ArkUI_ProgressLinearStyleOption_GetStrokeWidth 17373 17374``` 17375float OH_ArkUI_ProgressLinearStyleOption_GetStrokeWidth(ArkUI_ProgressLinearStyleOption* option) 17376``` 17377**Description** 17378 17379Obtains the stroke width of the linear progress indicator. 17380 17381**Since**: 15 17382 17383**Parameters** 17384 17385| Name| Description| 17386| -------- | -------- | 17387| option | Pointer to the **ProgressLinearStyleOption** instance. | 17388 17389**Returns** 17390 17391Returns the stroke width of the progress indicator. 17392 17393 17394### OH_ArkUI_ProgressLinearStyleOption_GetStrokeRadius 17395 17396``` 17397float OH_ArkUI_ProgressLinearStyleOption_GetStrokeRadius(ArkUI_ProgressLinearStyleOption* option) 17398``` 17399**Description** 17400 17401Obtains the corner radius of the linear progress indicator. 17402 17403**Since**: 15 17404 17405**Parameters** 17406 17407| Name| Description| 17408| -------- | -------- | 17409| option | Pointer to the **ProgressLinearStyleOption** instance. | 17410 17411**Returns** 17412 17413Returns the corner radius of the progress indicator. 17414 17415 17416### OH_ArkUI_DragEvent_StartDataLoading() 17417 17418``` 17419int32_t OH_ArkUI_DragEvent_StartDataLoading (ArkUI_DragEvent* event, OH_UdmfGetDataParams* options, char* key, unsigned int keyLen) 17420``` 17421**Description** 17422 17423Asynchronously obtains drag data. 17424 17425**Since**: 15 17426 17427**Parameters** 17428 17429| Name| Description| 17430| -------- | -------- | 17431| event | Pointer to an **ArkUI_DragEvent** object. | 17432| options | Parameters for obtaining data from UDMF. | 17433| key | Unique ID of data, which is returned in the callback parameters when the event is triggered. | 17434| keyLen | Length of **key**, which must be greater than or equal to the value of **UDMF_KEY_BUFFER_LEN**. | 17435 17436**Returns** 17437 17438Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17439Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17440 17441 17442### OH_ArkUI_CancelDataLoading() 17443 17444``` 17445int32_t OH_ArkUI_CancelDataLoading (ArkUI_ContextHandle uiContext, const char* key) 17446``` 17447**Description** 17448 17449Cancels the asynchronous obtaining of drag data. 17450 17451**Since**: 15 17452 17453**Parameters** 17454 17455| Name| Description| 17456| -------- | -------- | 17457| uiContext | UI context object used to bind the instance.| 17458| key | Unique ID of data.| 17459 17460**Returns** 17461 17462Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17463Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17464 17465 17466### OH_ArkUI_DisableDropDataPrefetchOnNode() 17467 17468``` 17469int32_t OH_ArkUI_DisableDropDataPrefetchOnNode (ArkUI_NodeHandle node, bool disable) 17470``` 17471**Description** 17472 17473Sets whether to enable data prefetching for drag and drop operations on a specified node. 17474 17475**Since**: 15 17476 17477**Parameters** 17478 17479| Name| Description| 17480| -------- | -------- | 17481| node | Specified node. | 17482| 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**.| 17483 17484 17485**Returns** 17486 17487Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17488Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17489 17490### OH_ArkUI_CrossLanguageOption_Create() 17491 17492``` 17493ArkUI_CrossLanguageOption* OH_ArkUI_CrossLanguageOption_Create(void) 17494``` 17495**Description** 17496 17497Creates an instance of the cross-language configuration option. 17498 17499**Since**: 15 17500 17501**Returns** 17502 17503Returns the pointer to the **ArkUI_CrossLanguageOption** instance created. If a null pointer is returned, creation failed, possibly due to insufficient memory. 17504 17505 17506### OH_ArkUI_CrossLanguageOption_Destroy() 17507 17508``` 17509void OH_ArkUI_CrossLanguageOption_Destroy(ArkUI_CrossLanguageOption* option) 17510``` 17511**Description** 17512 17513Destroys an instance of the cross-language configuration option. 17514 17515**Since**: 15 17516 17517**Parameters** 17518 17519| Name| Description| 17520| -------- | -------- | 17521| option | Cross-language configuration option instance to be destroyed. | 17522 17523### OH_ArkUI_CrossLanguageOption_SetAttributeSettingStatus() 17524 17525``` 17526void OH_ArkUI_CrossLanguageOption_SetAttributeSettingStatus(ArkUI_CrossLanguageOption* option, bool enable) 17527``` 17528**Description** 17529 17530Sets whether cross-language attribute setting is allowed in the configuration option. 17531 17532**Since**: 15 17533 17534**Parameters** 17535 17536| Name| Description| 17537| -------- | -------- | 17538| option | Pointer to the cross-language configuration option instance. | 17539| enable | Whether cross-language attribute setting is allowed. The default value is **false**. | 17540 17541### OH_ArkUI_CrossLanguageOption_GetAttributeSettingStatus() 17542 17543``` 17544bool OH_ArkUI_CrossLanguageOption_GetAttributeSettingStatus(ArkUI_CrossLanguageOption* option) 17545``` 17546**Description** 17547 17548Checks whether cross-language attribute setting is allowed in the configuration option. 17549 17550**Since**: 15 17551 17552**Parameters** 17553 17554| Name| Description| 17555| -------- | -------- | 17556| option | Pointer to the cross-language configuration option instance. | 17557 17558**Returns** 17559 17560Whether cross-language attribute setting is allowed. 17561 17562### OH_ArkUI_VisibleAreaEventOptions_Create() 17563 17564``` 17565ArkUI_VisibleAreaEventOptions* OH_ArkUI_VisibleAreaEventOptions_Create() 17566``` 17567**Description** 17568 17569Creates an instance of visible area change event parameters. 17570 17571**Since**: 18 17572 17573**Returns** 17574Returns the created instance of visible area change event parameters. 17575 17576### OH_ArkUI_VisibleAreaEventOptions_Dispose() 17577 17578``` 17579void OH_ArkUI_VisibleAreaEventOptions_Dispose(ArkUI_VisibleAreaEventOptions* option) 17580``` 17581**Description** 17582 17583Disposes of an instance of visible area change event parameters. 17584 17585**Since**: 18 17586 17587**Parameters** 17588 17589| Name| Description| 17590| -------- | -------- | 17591| option | Instance of visible area change event parameters to be destroyed. | 17592 17593### OH_ArkUI_VisibleAreaEventOptions_SetRatios() 17594 17595``` 17596int32_t OH_ArkUI_VisibleAreaEventOptions_SetRatios(ArkUI_VisibleAreaEventOptions* option, float* value, int32_t size) 17597``` 17598**Description** 17599 17600Sets the threshold ratios for visible area changes. 17601 17602**Since**: 18 17603 17604**Parameters** 17605 17606| Name| Description| 17607| -------- | -------- | 17608| option | Pointer to the instance of visible area change event parameters.| 17609| value | Array of threshold ratios.| 17610| size | Size of the array of threshold ratios.| 17611 17612**Returns** 17613 17614Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17615Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17616 17617### OH_ArkUI_VisibleAreaEventOptions_SetExpectedUpdateInterval() 17618 17619``` 17620int32_t OH_ArkUI_VisibleAreaEventOptions_SetExpectedUpdateInterval( 17621 ArkUI_VisibleAreaEventOptions *option, int32_t value) 17622``` 17623**Description** 17624 17625Sets the expected update interval for visible area changes. 17626 17627**Since**: 18 17628 17629**Parameters** 17630 17631| Name| Description| 17632| -------- | -------- | 17633| option | Pointer to the instance of visible area change event parameters.| 17634| value | Expected update interval, in ms. The default value is **1000**.| 17635 17636**Returns** 17637 17638Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17639Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17640 17641### OH_ArkUI_VisibleAreaEventOptions_GetRatios() 17642 17643``` 17644int32_t OH_ArkUI_VisibleAreaEventOptions_GetRatios(ArkUI_VisibleAreaEventOptions* option, float* value, int32_t* size) 17645``` 17646**Description** 17647 17648 Obtains the threshold ratios for visible area changes. 17649 17650**Since**: 18 17651 17652**Parameters** 17653 17654| Name| Description| 17655| -------- | -------- | 17656| option | Pointer to the instance of visible area change event parameters.| 17657| value | Array of threshold ratios.| 17658| size | Size of the array of threshold ratios.| 17659 17660**Returns** 17661 17662Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17663Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17664Returns **ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR** if the provided buffer size is insufficient. 17665 17666### OH_ArkUI_VisibleAreaEventOptions_GetExpectedUpdateInterval() 17667 17668``` 17669int32_t OH_ArkUI_VisibleAreaEventOptions_GetExpectedUpdateInterval(ArkUI_VisibleAreaEventOptions* option) 17670``` 17671**Description** 17672 17673 Obtains the expected update interval for visible area changes. 17674 17675**Since**: 18 17676 17677**Parameters** 17678 17679| Name| Description| 17680| -------- | -------- | 17681| option | Pointer to the instance of visible area change event parameters.| 17682 17683**Returns** 17684Returns the expected update interval, in ms. 17685 17686### OH_ArkUI_NodeUtils_GetPositionToParent() 17687 17688``` 17689int32_t OH_ArkUI_NodeUtils_GetPositionToParent (ArkUI_NodeHandle node, ArkUI_IntOffset* globalOffset ) 17690``` 17691**Description** 17692 17693Obtains the offset of a specific node relative to its parent node. 17694 17695**Since**: 15 17696 17697**Parameters** 17698 17699| Name| Description| 17700| -------- | -------- | 17701| node | **ArkUI_NodeHandle** pointer. | 17702| globalOffset | Offset of the target node relative to its parent node, in px. | 17703 17704**Returns** 17705 17706Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17707Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17708 17709### OH_ArkUI_GetGestureParam_DirectMask() 17710 17711``` 17712int32_t OH_ArkUI_GetGestureParam_DirectMask(ArkUI_GestureRecognizer* recognizer, ArkUI_GestureDirectionMask* directMask) 17713``` 17714**Description** 17715 17716Obtains the swipe direction of a gesture recognizer. 17717 17718**Since**: 18 17719 17720**Parameters** 17721 17722| Name| Description| 17723| -------- | -------- | 17724| recognizer | Pointer to the gesture recognizer. | 17725| directMask | Swipe direction of the gesture recognizer. | 17726 17727**Returns** 17728 17729Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17730Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17731 17732### OH_ArkUI_GetGestureParam_FingerCount() 17733 17734``` 17735int32_t OH_ArkUI_GetGestureParam_FingerCount(ArkUI_GestureRecognizer* recognizer, int* finger) 17736``` 17737**Description** 17738 17739Obtains the number of fingers used by a gesture recognizer. 17740 17741**Since**: 18 17742 17743**Parameters** 17744 17745| Name| Description| 17746| -------- | -------- | 17747| recognizer | Pointer to the gesture recognizer. | 17748| finger | Number of fingers used by the gesture recognizer. | 17749 17750**Returns** 17751 17752Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17753Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17754 17755### OH_ArkUI_GetGestureParam_limitFingerCount() 17756 17757``` 17758int32_t OH_ArkUI_GetGestureParam_limitFingerCount(ArkUI_GestureRecognizer* recognizer, bool* isLimited) 17759``` 17760**Description** 17761 17762Checks whether a gesture recognizer has a finger count limit. 17763 17764**Since**: 18 17765 17766**Parameters** 17767 17768| Name| Description| 17769| -------- | -------- | 17770| recognizer | Pointer to the gesture recognizer. | 17771| isLimited | Whether the gesture recognizer has a finger count limit. | 17772 17773**Returns** 17774 17775Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17776Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17777 17778### OH_ArkUI_GetGestureParam_repeat() 17779 17780``` 17781int32_t OH_ArkUI_GetGestureParam_repeat(ArkUI_GestureRecognizer* recognizer, bool* isRepeat) 17782``` 17783**Description** 17784 17785Checks whether a gesture recognizer supports repeated event callbacks. 17786 17787**Since**: 18 17788 17789**Parameters** 17790 17791| Name| Description| 17792| -------- | -------- | 17793| recognizer | Pointer to the gesture recognizer. | 17794| isRepeat | Whether the gesture recognizer supports repeated event callbacks. | 17795 17796**Returns** 17797 17798Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17799Returns **ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED** if the gesture recognizer type is not supported. 17800 17801### OH_ArkUI_GetGestureParam_distance() 17802 17803``` 17804int32_t OH_ArkUI_GetGestureParam_distance(ArkUI_GestureRecognizer* recognizer, double* distance) 17805``` 17806**Description** 17807 17808Obtains the allowed movement distance range for a gesture recognizer. 17809 17810**Since**: 18 17811 17812**Parameters** 17813 17814| Name| Description| 17815| -------- | -------- | 17816| recognizer | Pointer to the gesture recognizer. | 17817| distance | Allowed movement distance range of the gesture recognizer. | 17818 17819**Returns** 17820 17821Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17822Returns **ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED** if the gesture recognizer type is not supported. 17823 17824### OH_ArkUI_GetGestureParam_speed() 17825 17826``` 17827int32_t OH_ArkUI_GetGestureParam_speed(ArkUI_GestureRecognizer* recognizer, double* speed) 17828``` 17829**Description** 17830 17831Obtains the minimum swipe speed recognized by a gesture recognizer. 17832 17833**Since**: 18 17834 17835**Parameters** 17836 17837| Name| Description| 17838| -------- | -------- | 17839| recognizer | Pointer to the gesture recognizer. | 17840| speed | Minimum swipe speed recognized by the gesture recognizer. | 17841 17842**Returns** 17843 17844Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17845Returns **ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED** if the gesture recognizer type is not supported. 17846 17847### OH_ArkUI_GetGestureParam_duration() 17848 17849``` 17850int32_t OH_ArkUI_GetGestureParam_duration(ArkUI_GestureRecognizer* recognizer, int* duration) 17851``` 17852**Description** 17853 17854Obtains the minimum duration required to trigger a long press by a gesture recognizer. 17855 17856**Since**: 18 17857 17858**Parameters** 17859 17860| Name| Description| 17861| -------- | -------- | 17862| recognizer | Pointer to the gesture recognizer. | 17863| duration | Minimum duration for a long press. | 17864 17865**Returns** 17866 17867Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17868Returns **ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED** if the gesture recognizer type is not supported. 17869 17870### OH_ArkUI_GetGestureParam_angle() 17871 17872``` 17873int32_t OH_ArkUI_GetGestureParam_angle(ArkUI_GestureRecognizer* recognizer, double* angle) 17874``` 17875**Description** 17876 17877Obtains the minimum angle change required for a rotation gesture to be recognized by a gesture recognizer. 17878 17879**Since**: 18 17880 17881**Parameters** 17882 17883| Name| Description| 17884| -------- | -------- | 17885| recognizer | Pointer to the gesture recognizer. | 17886| angle | Minimum angle change. | 17887 17888**Returns** 17889 17890Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17891Returns **ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED** if the gesture recognizer type is not supported. 17892 17893### OH_ArkUI_GetGestureParam_distanceThreshold() 17894 17895``` 17896int32_t OH_ArkUI_GetGestureParam_distanceThreshold(ArkUI_GestureRecognizer* recognizer, double* distanceThreshold) 17897``` 17898**Description** 17899 17900Obtains the movement threshold for gestures to be recognized by a gesture recognizer. 17901 17902**Since**: 18 17903 17904**Parameters** 17905 17906| Name| Description| 17907| -------- | -------- | 17908| recognizer | Pointer to the gesture recognizer. | 17909| distanceThreshold | Gesture movement threshold of the gesture recognizer. | 17910 17911**Returns** 17912 17913Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17914Returns **ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED** if the gesture recognizer type is not supported. 17915 17916 17917### OH_ArkUI_DragEvent_RequestDragEndPending() 17918 17919``` 17920int32_t OH_ArkUI_DragEvent_RequestDragEndPending(ArkUI_DragEvent* event, int32_t* requestIdentify) 17921``` 17922**Description** 17923 17924Requests a delayed execution of the end of the drag and drop operation. When the system notifies the application of a drop event, this API can be called to explicitly inform the system that a delay is needed before the drag result can be processed. The system will defer the end of the drag and drop operation and wait for the application to return the drag result through the **OH_ArkUI_NotifyDragResult** API. This is typically used when the drag data is processed in a background thread to avoid blocking the main thread for an extended period, ensuring that the drag source receives an accurate result at the end of the drag operation. However, the system will not wait indefinitely; the maximum timeout is 2 seconds. If the **OH_ArkUI_NotifyDragResult** notification is not received within this time, the drag and drop operation will be forcibly terminated, and the drag source will be notified of the failure. 17925 17926**Since**: 19 17927 17928**Parameters** 17929 17930| Name| Description| 17931| -------- | -------- | 17932| event | Pointer to an **ArkUI_DragEvent** object. | 17933| requestIdentify | Unique identifier for this delayed drop operation.| 17934 17935 17936**Returns** 17937 17938Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17939Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17940Returns **ARKUI_ERROR_CODE_DRAG_DROP_OPERATION_NOT_ALLOWED** if the API is not called during the drop phase. 17941 17942 17943 17944### OH_ArkUI_NotifyDragResult() 17945 17946``` 17947int32_t OH_ArkUI_NotifyDragResult(int32_t requestIdentify, ArkUI_DragResult result) 17948``` 17949**Description** 17950 17951Notifies the system of the drag result. 17952 17953**Since**: 19 17954 17955**Parameters** 17956 17957| Name| Description| 17958| -------- | -------- | 17959| requestIdentify | Unique identifier for this delayed drop operation.| 17960| result | Drag result.| 17961 17962 17963**Returns** 17964 17965Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17966Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17967Returns **ARKUI_ERROR_CODE_DRAG_DROP_OPERATION_NOT_ALLOWED** if the API is not called during the drop phase. 17968 17969 17970### OH_ArkUI_NotifyDragEndPendingDone() 17971 17972``` 17973int32_t OH_ArkUI_NotifyDragEndPendingDone(int32_t requestIdentify) 17974``` 17975**Description** 17976 17977Notifies the system that the delayed drag and drop operation has been completed. 17978 17979**Since**: 19 17980 17981**Parameters** 17982 17983| Name| Description| 17984| -------- | -------- | 17985| requestIdentify | Unique identifier for this delayed drop operation.| 17986 17987 17988**Returns** 17989 17990Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. 17991Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 17992Returns **ARKUI_ERROR_CODE_DRAG_DROP_OPERATION_NOT_ALLOWED** if the API is not called during the drop phase. 17993 17994### OH_ArkUI_TextPickerRangeContentArray_Create() 17995 17996``` 17997ArkUI_TextPickerRangeContentArray* OH_ArkUI_TextPickerRangeContentArray_Create(int32_t length) 17998``` 17999**Description** 18000 18001Creates a **TextPickerRangeContent** array object. 18002 18003**Since**: 18 18004 18005**Parameters** 18006 18007| Name| Description| 18008| -------- | -------- | 18009| length | Length of the **TextPickerRangeContent** array. | 18010 18011**Returns** 18012 18013Returns a pointer to an empty **TextPickerRangeContent** array. 18014 18015### OH_ArkUI_TextPickerRangeArray_SetIconAtIndex() 18016 18017``` 18018void OH_ArkUI_TextPickerRangeArray_SetIconAtIndex(ArkUI_TextPickerRangeContentArray* handle,char* icon,int32_t index); 18019``` 18020**Description** 18021 18022 Sets the icon data at the specified position in the **TextPickerRangeContent** array. 18023 18024**Since**: 18 18025 18026**Parameters** 18027 18028| Name| Description| 18029| -------- | -------- | 18030| handle | Pointer to the **TextPickerRangeContent** array.| 18031| icon | Pointer to the icon image address.| 18032| index | Position in the array, starting from 0.| 18033 18034 18035### OH_ArkUI_TextPickerRangeContentArray_SetTextAtIndex() 18036 18037``` 18038void OH_ArkUI_TextPickerRangeContentArray_SetTextAtIndex(ArkUI_TextPickerRangeContentArray* handle,char* text,int32_t index); 18039``` 18040**Description** 18041 18042 Sets the text data at the specified position in the **TextPickerRangeContent** array. 18043 18044**Since**: 18 18045 18046**Parameters** 18047 18048| Name| Description| 18049| -------- | -------- | 18050| handle | Pointer to the **TextPickerRangeContent** array.| 18051| text | Pointer to the text content.| 18052| index | Position in the array, starting from 0.| 18053 18054 18055### OH_ArkUI_TextPickerRangeContentArray_Destroy() 18056 18057``` 18058void OH_ArkUI_TextPickerRangeContentArray_Destroy(ArkUI_TextPickerRangeContentArray* handle); 18059``` 18060**Description** 18061 18062 Destroys a **TextPickerRangeContent** array object. 18063 18064**Since**: 18 18065 18066**Parameters** 18067 18068| Name| Description| 18069| -------- | -------- | 18070| handle | Pointer to the **TextPickerRangeContent** array.| 18071 18072 18073### OH_ArkUI_TextCascadePickerRangeContentArray_Create() 18074 18075``` 18076ArkUI_TextCascadePickerRangeContentArray* OH_ArkUI_TextCascadePickerRangeContentArray_Create(int32_t length); 18077``` 18078**Description** 18079 18080Creates a **TextCascadePickerRangeContent** array object. 18081 18082**Since**: 18 18083 18084**Parameters** 18085 18086| Name| Description| 18087| -------- | -------- | 18088| length | Length of the **TextPickerRangeContent** array.| 18089 18090**Returns** 18091 18092Returns a pointer to an empty **TextCascadePickerRangeContent** array. 18093 18094### OH_ArkUI_TextCascadePickerRangeContentArray_SetTextAtIndex() 18095 18096``` 18097void OH_ArkUI_TextCascadePickerRangeContentArray_SetTextAtIndex(ArkUI_TextCascadePickerRangeContentArray* handle,char* text,int32_t index); 18098``` 18099**Description** 18100 18101 Sets the text data at the specified position in the **TextCascadePickerRangeContent** array. 18102 18103**Since**: 18 18104 18105**Parameters** 18106 18107| Name| Description| 18108| -------- | -------- | 18109| handle | Pointer to the **TextCascadePickerRangeContent** array.| 18110| text | Pointer to the text content.| 18111| index | Position in the array, starting from 0.| 18112 18113 18114### OH_ArkUI_TextCascadePickerRangeContentArray_setChildAtIndex() 18115 18116``` 18117void OH_ArkUI_TextCascadePickerRangeContentArray_setChildAtIndex(ArkUI_TextCascadePickerRangeContentArray* handle,ArkUI_TextCascadePickerRangeContentArray* child,int32_t index); 18118``` 18119**Description** 18120 18121 Sets the child data at the specified position in the **TextCascadePickerRangeContent** array. 18122 18123**Since**: 18 18124 18125**Parameters** 18126 18127| Name| Description| 18128| -------- | -------- | 18129| handle | Pointer to the **TextCascadePickerRangeContent** array.| 18130| child | Pointer to the child node array.| 18131| index | Position in the array, starting from 0.| 18132 18133 18134### OH_ArkUI_TextCascadePickerRangeContentArray_Destroy() 18135 18136``` 18137void OH_ArkUI_TextCascadePickerRangeContentArray_Destroy(ArkUI_TextCascadePickerRangeContentArray* handle); 18138``` 18139**Description** 18140 18141 Destroys a **TextCascadePickerRangeContent** array object. 18142 18143**Since**: 18 18144 18145**Parameters** 18146 18147| Name| Description| 18148| -------- | -------- | 18149| handle | Pointer to the **TextCascadePickerRangeContent** array.| 18150
