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_AttributeItem](_ark_u_i___attribute_item.md) | Defines the general input parameter structure of the **setAttribute** function. | 50| struct [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) | Defines a struct for the parameter type of the component callback event. | 51| struct [ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md) | Defines the string type parameter used by the component callback event. | 52| 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. | 53| struct [ArkUI_ContextCallback](_ark_u_i___context_callback.md) | Defines event callback. | 54| union [ArkUI_NumberValue](union_ark_u_i___number_value.md) | Provides the number types of ArkUI in the native code. | 55| 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. | 56| 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. | 57| struct [ArkUI_ColorStop](_ark_u_i___color_stop.md) | Defines a gradient color stop. | 58| struct [ArkUI_Rect](_ark_u_i___rect.md) | Defines a mask area. | 59| struct [ArkUI_IntSize](_ark_u_i___int_size.md) | Describes the width and height of a component. | 60| struct [ArkUI_IntOffset](_ark_u_i___int_offset.md) | Describes the position of a component. | 61| struct [ArkUI_Margin](_ark_u_i___margin.md) | Describes the margins of a component. | 62| struct [ArkUI_TranslationOptions](_ark_u_i___translation_options.md) | Defines the translation options for component transition. | 63| struct [ArkUI_ScaleOptions](_ark_u_i___scale_options.md) | Defines the scaling options for component transition. | 64| struct [ArkUI_RotationOptions](_ark_u_i___rotation_options.md) | Defines the rotation options for component transition. | 65 66 67### Macros 68 69| Name| Description| 70| -------- | -------- | 71| [OH_ArkUI_GetModuleInterface](#oh_arkui_getmoduleinterface)(nativeAPIVariantKind, structType, structPtr) | Obtains the macro function corresponding to a struct pointer based on the struct type. | 72| **MAX_NODE_SCOPE_NUM** | 1000 | 73| **MAX_COMPONENT_EVENT_ARG_NUM** | 12 | 74 75 76### Types 77 78| Name| Description| 79| -------- | -------- | 80| typedef struct [ArkUI_NodeEvent](#arkui_nodeevent-12) [ArkUI_NodeEvent](#arkui_nodeevent-12) | Defines a struct for a component event. | 81| typedef struct [ArkUI_Context](#arkui_context) [ArkUI_Context](#arkui_context) | Defines a struct for a UI context object. | 82| typedef struct [ArkUI_Context](#arkui_context) \* [ArkUI_ContextHandle](#arkui_contexthandle-12) | Defines a struct for the handle to the ArkUI native UI context. | 83| typedef struct [ArkUI_DragEvent](#arkui_dragevent) [ArkUI_DragEvent](#arkui_dragevent) | Defines a struct for a drag event. | 84| typedef struct [ArkUI_DragPreviewOption](#arkui_dragpreviewoption) [ArkUI_DragPreviewOption](#arkui_dragpreviewoption) | Defines a struct for custom drag preview options. | 85| typedef struct [ArkUI_DragAction](#arkui_dragaction) [ArkUI_DragAction](#arkui_dragaction) | Defines a struct for a drag action. | 86| typedef struct [ArkUI_DragAndDropInfo](#arkui_draganddropinfo) [ArkUI_DragAndDropInfo](#arkui_draganddropinfo) | Defines a struct for drag and drop information returned through a drag status listener. | 87| typedef struct [OH_UdmfData](#oh_udmfdata) [OH_UdmfData](#oh_udmfdata) | Defines a struct for UDMF unified data. | 88| 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. | 89| typedef struct [ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) [ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) | Defines a struct for the **DrawableDescriptor** object. | 90| typedef struct [OH_PixelmapNative](#oh_pixelmapnative) \* [OH_PixelmapNativeHandle](#oh_pixelmapnativehandle) | Defines a struct for the pointer to an **OH_PixelmapNative** object. | 91| typedef struct [ArkUI_AnimateOption](#arkui_animateoption) [ArkUI_AnimateOption](#arkui_animateoption) | Defines a struct for the animation configuration. | 92| typedef struct ArkUI_Curve \* [ArkUI_CurveHandle](#arkui_curvehandle) | Defines a struct for the pointer to an interpolation curve. | 93| typedef struct [ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) [ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) | Defines a struct for the keyframe animation parameter object. | 94| typedef struct [ArkUI_AnimatorOption](#arkui_animatoroption) [ArkUI_AnimatorOption](#arkui_animatoroption) | Defines the animator parameter object. | 95| typedef struct ArkUI_Animator \* [ArkUI_AnimatorHandle](#arkui_animatorhandle) | Defines a struct for the pointer to an animator object. | 96| typedef struct [ArkUI_TransitionEffect](#arkui_transitioneffect) [ArkUI_TransitionEffect](#arkui_transitioneffect) | Defines a struct for the transition effect. | 97| typedef bool(\* [ArkUI_OnWillDismissEvent](#arkui_onwilldismissevent)) (int32_t reason) | Defines a pointer to the callback invoked when the dialog box is closed. | 98| typedef struct [ArkUI_DialogDismissEvent](#arkui_dialogdismissevent) [ArkUI_DialogDismissEvent](#arkui_dialogdismissevent) | Defines a struct for a dialog box dismiss event. | 99| typedef uint32_t [ArkUI_GestureEventActionTypeMask](#arkui_gestureeventactiontypemask) | Defines a set of gesture event types. | 100| typedef uint32_t [ArkUI_GestureDirectionMask](#arkui_gesturedirectionmask) | Defines a set of gesture directions. | 101| typedef ArkUI_GestureRecognizer \* [ArkUI_GestureRecognizerHandle](#arkui_gesturerecognizerhandle) | Defines the gesture recognizer handle. | 102| typedef [ArkUI_GestureRecognizerHandle](#arkui_gesturerecognizerhandle) \* [ArkUI_GestureRecognizerHandleArray](#arkui_gesturerecognizerhandlearray) | Defines the gesture recognizer handle array. | 103| 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. | 104| typedef struct [ArkUI_ParallelInnerGestureEvent](#arkui_parallelinnergestureevent) [ArkUI_ParallelInnerGestureEvent](#arkui_parallelinnergestureevent) | Defines a parallel internal gesture event. | 105| typedef void(\* [ArkUI_GestureRecognizerDestructNotifyCallback](#arkui_gesturerecognizerdestructnotifycallback)) (ArkUI_GestureRecognizer \*recognizer, void \*userData) | Defines a callback function for notifying gesture recognizer destruction. | 106| typedef struct [ArkUI_NodeEvent](#arkui_nodeevent-12) [ArkUI_NodeEvent](#arkui_nodeevent-12) | Defines the common structure of a component event. | 107| typedef struct [ArkUI_NodeCustomEvent](#arkui_nodecustomevent) [ArkUI_NodeCustomEvent](#arkui_nodecustomevent) | Defines the common structure of a custom component event. | 108| typedef struct ArkUI_NodeAdapter \* [ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) | Defines the component adapter, which is used for lazy loading of elements of scrollable components. | 109| typedef struct [ArkUI_NodeAdapterEvent](#arkui_nodeadapterevent) [ArkUI_NodeAdapterEvent](#arkui_nodeadapterevent) | Defines the component adapter event. | 110| typedef struct [ArkUI_NodeContentEvent](#arkui_nodecontentevent) [ArkUI_NodeContentEvent](#arkui_nodecontentevent) | Defines the common structure type of a NodeContent event. | 111| typedef void(\* [ArkUI_NodeContentCallback](#arkui_nodecontentcallback)) ([ArkUI_NodeContentEvent](#arkui_nodecontentevent) \*event) | Defines the callback for the NodeContent event. | 112| typedef struct [ArkUI_LayoutConstraint](#arkui_layoutconstraint) [ArkUI_LayoutConstraint](#arkui_layoutconstraint) | Defines the size constraints of a component during component layout. | 113| typedef struct [ArkUI_DrawContext](#arkui_drawcontext) [ArkUI_DrawContext](#arkui_drawcontext) | Defines the component drawing context. | 114| typedef struct ArkUI_Node \* [ArkUI_NodeHandle](#arkui_nodehandle) | Defines the pointer to the ArkUI native component object. | 115| typedef struct ArkUI_NativeDialog \* [ArkUI_NativeDialogHandle](#arkui_nativedialoghandle) | Defines the handle to the custom dialog box controller of ArkUI on the native side. | 116| typedef struct [ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) [ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) | Defines the water flow section configuration. | 117| typedef struct [ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) [ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) | Defines the item configuration for **ListItemSwipeActionOption**. | 118| typedef struct [ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption) [ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption) | Defines the configuration for **ListItemSwipeActionOption**. | 119| typedef struct [ArkUI_Context](#arkui_context) \* [ArkUI_ContextHandle](#arkui_contexthandle-12) | Defines the handle to the ArkUI native UI context. | 120| typedef struct ArkUI_NodeContent \* [ArkUI_NodeContentHandle](#arkui_nodecontenthandle) | Defines the handle to the ArkUI NodeContent instance on the native side. | 121| typedef struct [ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) [ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) | Defines the alignment rule in the relative container. | 122| typedef struct [ArkUI_GuidelineOption](#arkui_guidelineoption) [ArkUI_GuidelineOption](#arkui_guidelineoption) | Defines the ID, direction, and position of a guideline. | 123| typedef struct [ArkUI_BarrierOption](#arkui_barrieroption) [ArkUI_BarrierOption](#arkui_barrieroption) | Defines the ID, direction, and referenced component of a barrier. | 124| typedef struct [ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) [ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) | Defines the image frame information. | 125| typedef struct [ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) [ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) | Defines the **ChildrenMainSize** information of the **List** component. | 126| typedef struct [ArkUI_AccessibilityState](#arkui_accessibilitystate) [ArkUI_AccessibilityState](#arkui_accessibilitystate) | Defines a struct for the component accessibility state. | 127| typedef struct [ArkUI_AccessibilityValue](#arkui_accessibilityvalue) [ArkUI_AccessibilityValue](#arkui_accessibilityvalue) | Defines a struct for the component accessibility value. | 128| typedef struct [ArkUI_SystemFontStyleEvent](#arkui_systemfontstyleevent) [ArkUI_SystemFontStyleEvent](#arkui_systemfontstyleevent) | Defines a struct for the system font style event. | 129| typedef struct [ArkUI_CustomSpanMeasureInfo](#arkui_customspanmeasureinfo) [ArkUI_CustomSpanMeasureInfo](#arkui_customspanmeasureinfo) | Defines a struct for the measurement information of a custom span. | 130| typedef struct [ArkUI_CustomSpanMetrics](#arkui_customspanmetrics) [ArkUI_CustomSpanMetrics](#arkui_customspanmetrics) | Defines a struct for the measurement metrics of a custom span. | 131| typedef struct [ArkUI_CustomSpanDrawInfo](#arkui_customspandrawinfo) [ArkUI_CustomSpanDrawInfo](#arkui_customspandrawinfo) | Defines a struct for the drawing information of a custom span. | 132| typedef struct [ArkUI_SwiperIndicator](#arkui_swiperindicator) [ArkUI_SwiperIndicator](#arkui_swiperindicator) | Defines the navigation point indicator style of the **Swiper** component. | 133| 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. | 134| typedef struct [ArkUI_StyledString](#arkui_styledstring) [ArkUI_StyledString](#arkui_styledstring) | Defines a struct for the styled string object supported by the text component. | 135 136 137### Enums 138 139| Name| Description| 140| -------- | -------- | 141| [ArkUI_DragResult](#arkui_dragresult) { ARKUI_DRAG_RESULT_SUCCESSFUL, 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. | 142| [ArkUI_DropProposal](#arkui_dropproposal) { ARKUI_DROP_PROPOSAL_COPY, ARKUI_DROP_PROPOSAL_MOVE } | Defines an enum for data processing modes used when data is dropped, which affects the display of the badge. | 143| [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. | 144| [ArkUI_DragPreviewScaleMode](#arkui_dragpreviewscalemode) { ARKUI_DRAG_PREVIEW_SCALE_AUTO, ARKUI_DRAG_PREVIEW_SCALE_DISABLED } | Defines an enum for drag preview scale modes. | 145| [ArkUI_DragStatus](#arkui_dragstatus) { ArkUI_DRAG_STATUS_UNKNOWN, ArkUI_DRAG_STATUS_STARTED, ArkUI_DRAG_STATUS_ENDED } | Enumerates dragging states. | 146| [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. | 147| [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. | 148| [ArkUI_GesturePriority](#arkui_gesturepriority) { NORMAL = 0, PRIORITY = 1, PARALLEL = 2 } | Enumerates gesture event modes. | 149| [ArkUI_GroupGestureMode](#arkui_groupgesturemode) { SEQUENTIAL_GROUP = 0, PARALLEL_GROUP = 1, EXCLUSIVE_GROUP = 2 } | Enumerates gesture group modes. | 150| [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. | 151| [ArkUI_GestureMask](#arkui_gesturemask) { NORMAL_GESTURE_MASK = 0, IGNORE_INTERNAL_GESTURE_MASK } | Enumerates gesture masking modes. | 152| [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. | 153| [ArkUI_GestureInterruptResult](#arkui_gestureinterruptresult) { GESTURE_INTERRUPT_RESULT_CONTINUE = 0, GESTURE_INTERRUPT_RESULT_REJECT } | Enumerates gesture interruption results. | 154| [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. | 155| [ArkUI_NativeAPIVariantKind](#arkui_nativeapivariantkind) { ARKUI_NATIVE_NODE, ARKUI_NATIVE_DIALOG, ARKUI_NATIVE_GESTURE, ARKUI_NATIVE_ANIMATE } | Defines the native API types. | 156| [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. | 157| [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. | 158| [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. | 159| [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. | 160| [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. | 161| [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_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_TYPEY_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_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,<br/>NODE_BUTTON_LABEL = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_BUTTON, NODE_BUTTON_TYPE, NODE_PROGRESS_VALUE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_PROGRESS, NODE_PROGRESS_TOTAL,<br/>NODE_PROGRESS_COLOR, NODE_PROGRESS_TYPE, 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_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_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_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_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_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,<br/>NODE_RADIO_CHECKED = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_RADIO, NODE_RADIO_STYLE, NODE_RADIO_VALUE, NODE_RADIO_GROUP,<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_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,<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_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_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,<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. | 162| [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_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_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_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, 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_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_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. | 163| [ArkUI_NodeDirtyFlag](#arkui_nodedirtyflag) { NODE_NEED_MEASURE = 1, NODE_NEED_LAYOUT, NODE_NEED_RENDER } | Enumerates the dirty area flags passed in the **::markDirty** API. | 164| [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. | 165| [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. | 166| [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. | 167| [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. | 168| [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. | 169| [ArkUI_FontStyle](#arkui_fontstyle) { ARKUI_FONT_STYLE_NORMAL = 0, ARKUI_FONT_STYLE_ITALIC } | Enumerates the font styles. | 170| [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. | 171| [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. | 172| [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. | 173| [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. | 174| [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. | 175| [ArkUI_CancelButtonStyle](#arkui_cancelbuttonstyle) { ARKUI_CANCELBUTTON_STYLE_CONSTANT = 0, ARKUI_CANCELBUTTON_STYLE_INVISIBLE, ARKUI_CANCELBUTTON_STYLE_INPUT } | Enumerates the styles of the Cancel button. | 176| [ArkUI_XComponentType](#arkui_xcomponenttype) { ARKUI_XCOMPONENT_TYPE_SURFACE = 0, ARKUI_XCOMPONENT_TYPE_TEXTURE = 2 } | Enumerates the XComponent types. | 177| [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. | 178| [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. | 179| [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. | 180| [ArkUI_TextCase](#arkui_textcase) { ARKUI_TEXT_CASE_NORMAL = 0, ARKUI_TEXT_CASE_LOWER, ARKUI_TEXT_CASE_UPPER } | Enumerates the text cases. | 181| [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. | 182| [ArkUI_ShadowType](#arkui_shadowtype) { ARKUI_SHADOW_TYPE_COLOR = 0, ARKUI_SHADOW_TYPE_BLUR } | Enumerates the shadow types. | 183| [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. | 184| [ArkUI_AccessibilityCheckedState](#arkui_accessibilitycheckedstate) { ARKUI_ACCESSIBILITY_UNCHECKED = 0, ARKUI_ACCESSIBILITY_CHECKED } | Enumerates the accessibility check box states. | 185| [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. | 186| [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. | 187| [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. | 188| [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. | 189| [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. | 190| [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. | 191| [ArkUI_Axis](#arkui_axis) { ARKUI_AXIS_VERTICAL = 0, ARKUI_AXIS_HORIZONTAL } | Enumerates the scroll directions. | 192| [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. | 193| [ArkUI_BorderStyle](#arkui_borderstyle) { ARKUI_BORDER_STYLE_SOLID = 0, ARKUI_BORDER_STYLE_DASHED, ARKUI_BORDER_STYLE_DOTTED } | Enumerates the border styles. | 194| [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. | 195| [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. | 196| [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. | 197| [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 point indicator. | 198| [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. | 199| [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. | 200| [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. | 201| [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. | 202| [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. | 203| [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 the nested scrolling modes. | 204| [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. | 205| [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. | 206| [ArkUI_ScrollState](#arkui_scrollstate) { ARKUI_SCROLL_STATE_IDLE = 0, ARKUI_SCROLL_STATE_SCROLL, ARKUI_SCROLL_STATE_FLING } | Enumerates the scrolling states. | 207| [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. | 208| [ArkUI_SliderDirection](#arkui_sliderdirection) { ARKUI_SLIDER_DIRECTION_VERTICAL = 0, ARKUI_SLIDER_DIRECTION_HORIZONTAL } | Enumerates the scroll directions of the slider. | 209| [ArkUI_SliderStyle](#arkui_sliderstyle) { ARKUI_SLIDER_STYLE_OUT_SET = 0, ARKUI_SLIDER_STYLE_IN_SET, ARKUI_SLIDER_STYLE_NONE } | Enumerates the slider styles. | 210| [ArkUI_CheckboxShape](#arkui_checkboxshape) { ArkUI_CHECKBOX_SHAPE_CIRCLE = 0, ArkUI_CHECKBOX_SHAPE_ROUNDED_SQUARE } | Enumerates the shapes of the check box. | 211| [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. | 212| [ArkUI_ImageSize](#arkui_imagesize) { ARKUI_IMAGE_SIZE_AUTO = 0, ARKUI_IMAGE_SIZE_COVER, ARKUI_IMAGE_SIZE_CONTAIN } | Defines the image size. | 213| [ArkUI_AdaptiveColor](#arkui_adaptivecolor) { ARKUI_ADAPTIVE_COLOR_DEFAULT = 0, ARKUI_ADAPTIVE_COLOR_AVERAGE } | Enumerates the adaptive color modes. | 214| [ArkUI_ColorMode](#arkui_colormode) { ARKUI_COLOR_MODE_SYSTEM = 0, ARKUI_COLOR_MODE_LIGHT, ARKUI_COLOR_MODE_DARK } | Enumerates the color modes. | 215| [ArkUI_SystemColorMode](#arkui_systemcolormode) { ARKUI_SYSTEM_COLOR_MODE_LIGHT = 0, ARKUI_SYSTEM_COLOR_MODE_DARK } | Enumerates the system color modes. | 216| [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. | 217| [ArkUI_VerticalAlignment](#arkui_verticalalignment) { ARKUI_VERTICAL_ALIGNMENT_TOP = 0, ARKUI_VERTICAL_ALIGNMENT_CENTER, ARKUI_VERTICAL_ALIGNMENT_BOTTOM } | Enumerates the vertical alignment modes. | 218| [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. | 219| [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. | 220| [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. | 221| [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. | 222| [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. | 223| [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. | 224| [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. | 225| [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. | 226| [ArkUI_ColorStrategy](#arkui_colorstrategy) { ARKUI_COLOR_STRATEGY_INVERT = 0, ARKUI_COLOR_STRATEGY_AVERAGE, ARKUI_COLOR_STRATEGY_PRIMARY } | Enumerates the foreground colors. | 227| [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. | 228| [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. | 229| [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. | 230| [ArkUI_Visibility](#arkui_visibility) { ARKUI_VISIBILITY_VISIBLE = 0, ARKUI_VISIBILITY_HIDDEN, ARKUI_VISIBILITY_NONE } | Enumerates the visibility values. | 231| [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. | 232| [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. | 233| [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. | 234| [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. | 235| [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. | 236| [ArkUI_WordBreak](#arkui_wordbreak) { ARKUI_WORD_BREAK_NORMAL = 0, ARKUI_WORD_BREAK_BREAK_ALL, ARKUI_WORD_BREAK_BREAK_WORD } | Enumerates the word break rules. | 237| [ArkUI_EllipsisMode](#arkui_ellipsismode) { ARKUI_ELLIPSIS_MODE_START = 0, ARKUI_ELLIPSIS_MODE_CENTER, ARKUI_ELLIPSIS_MODE_END } | Enumerates the ellipsis positions. | 238| [ArkUI_ImageRenderMode](#arkui_imagerendermode) { ARKUI_IMAGE_RENDER_MODE_ORIGINAL = 0, ARKUI_IMAGE_RENDER_MODE_TEMPLATE } | Enumerates the image rendering modes. | 239| [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. | 240| [ArkUI_FinishCallbackType](#arkui_finishcallbacktype) { ARKUI_FINISH_CALLBACK_REMOVED = 0, ARKUI_FINISH_CALLBACK_LOGICALLY } | Enumerates the animation **onFinish** callback types. | 241| [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. | 242| [ArkUI_BlendApplyType](#arkui_blendapplytype) { BLEND_APPLY_TYPE_FAST = 0, BLEND_APPLY_TYPE_OFFSCREEN } | Defines how the specified blend mode is applied. | 243| [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. | 244| [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>} | Enumerates the autofill types. | 245| [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. | 246| [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. | 247| [ArkUI_TextInputStyle](#arkui_textinputstyle) { ARKUI_TEXTINPUT_STYLE_DEFAULT = 0, ARKUI_TEXTINPUT_STYLE_INLINE } | Enumerates the text input styles. | 248| [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. | 249| [ArkUI_ButtonType](#arkui_buttontype) { ARKUI_BUTTON_TYPE_NORMAL = 0, ARKUI_BUTTON_TYPE_CAPSULE, ARKUI_BUTTON_TYPE_CIRCLE } | Enumerates the button types. | 250| [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>} | | 251| [ArkUI_ThemeColorMode](#arkui_themecolormode) { ARKUI_THEME_COLOR_MODE_SYSTEM = 0, ARKUI_THEME_COLOR_MODE_LIGHT, ARKUI_THEME_COLOR_MODE_DARK } | | 252| [ArkUI_SwiperIndicatorType](#arkui_swiperindicatortype) { ARKUI_SWIPER_INDICATOR_TYPE_DOT, ARKUI_SWIPER_INDICATOR_TYPE_DIGIT } | Enumerates the navigation point indicator types of the **Swiper** component. | 253| [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. | 254| [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. | 255| [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. | 256| [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. | 257| [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. | 258| [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. | 259| [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. | 260| [ArkUI_ErrorCode](#arkui_errorcode) {<br>ARKUI_ERROR_CODE_NO_ERROR = 0, ARKUI_ERROR_CODE_PARAM_INVALID = 401, 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_NON_SCROLLABLE_CONTAINER = 180001, ARKUI_ERROR_CODE_BUFFER_SIZE_NOT_ENOUGH = 180002, ARKUI_ERROR_CODE_INVALID_STYLED_STRING = 180101<br>} | Enumerates the error codes. | 261| [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. | 262| [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. | 263| [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. | 264| [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>} | Enumerates the **NavDestination** component states. | 265| [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. | 266 267### Functions 268 269| Name| Description| 270| -------- | -------- | 271| [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. | 272| [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. | 273| 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. | 274| int32_t [OH_ArkUI_DragEvent_SetSuggestedDropOperation](#oh_arkui_dragevent_setsuggesteddropoperation) ([ArkUI_DragEvent](#arkui_dragevent) \*event, [ArkUI_DropProposal](#arkui_dropproposal) proposal) | Sets the data processing mode. | 275| 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. | 276| 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. | 277| 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. | 278| int32_t [OH_ArkUI_DragEvent_GetDataTypesCount](#oh_arkui_dragevent_getdatatypescount) ([ArkUI_DragEvent](#arkui_dragevent) \*event, int32_t \*count) | Obtains the number of drag data types from a drag event. | 279| 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. | 280| 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. | 281| 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. | 282| 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. | 283| 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. | 284| 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. | 285| 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. | 286| 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. | 287| 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. | 288| 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. | 289| float [OH_ArkUI_DragEvent_GetVelocityX](#oh_arkui_dragevent_getvelocityx) ([ArkUI_DragEvent](#arkui_dragevent) \*event) | Obtains the dragging velocity along the x-axis. | 290| float [OH_ArkUI_DragEvent_GetVelocityY](#oh_arkui_dragevent_getvelocityy) ([ArkUI_DragEvent](#arkui_dragevent) \*event) | Obtains the dragging velocity along the y-axis. | 291| float [OH_ArkUI_DragEvent_GetVelocity](#oh_arkui_dragevent_getvelocity) ([ArkUI_DragEvent](#arkui_dragevent) \*event) | Obtains the dragging velocity along the main axis. | 292| int32_t [OH_ArkUI_DragEvent_GetModifierKeyStates](#oh_arkui_dragevent_getmodifierkeystates) ([ArkUI_DragEvent](#arkui_dragevent) \*event, int64_t \*keys) | Obtains the pressed status of modifier keys from a drag event. | 293| 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. | 294| 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. | 295| 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). | 296| 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). | 297| 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). | 298| int32_t [OH_ArkUI_SetNodeDraggable](#oh_arkui_setnodedraggable) ([ArkUI_NodeHandle](#arkui_nodehandle) node, bool enabled) | Sets whether the component is draggable. | 299| 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. | 300| [ArkUI_DragPreviewOption](#arkui_dragpreviewoption) \* [OH_ArkUI_CreateDragPreviewOption](#oh_arkui_createdragpreviewoption) (void) | Creates an **ArkUI_DragPreviewOption** object. | 301| void [OH_ArkUI_DragPreviewOption_Dispose](#oh_arkui_dragpreviewoption_dispose) ([ArkUI_DragPreviewOption](#arkui_dragpreviewoption) \*option) | Disposes of an **ArkUI_DragPreviewOption** object. | 302| 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. | 303| 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. | 304| 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. | 305| 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. | 306| 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. | 307| 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. | 308| 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. | 309| [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. | 310| [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. | 311| void [OH_ArkUI_DragAction_Dispose](#oh_arkui_dragaction_dispose) ([ArkUI_DragAction](#arkui_dragaction) \*dragAction) | Disposes of an **ArkUI_DragAction** object. | 312| 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. | 313| 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. | 314| 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). | 315| 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). | 316| int32_t [OH_ArkUI_DragAction_SetData](#oh_arkui_dragaction_setdata) ([ArkUI_DragAction](#arkui_dragaction) \*dragAction, [OH_UdmfData](#oh_udmfdata) \*data) | Sets the drag data. | 317| 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. | 318| 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. | 319| void [OH_ArkUI_DragAction_UnregisterStatusListener](#oh_arkui_dragaction_unregisterstatuslistener) ([ArkUI_DragAction](#arkui_dragaction) \*dragAction) | Unregisters a drag status listener. | 320| [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. | 321| [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. | 322| int32_t [OH_ArkUI_StartDrag](#oh_arkui_startdrag) ([ArkUI_DragAction](#arkui_dragaction) \*dragAction) | Initiates a drag action through the specified **DragAction** object. | 323| [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. | 324| [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. | 325| void [OH_ArkUI_DrawableDescriptor_Dispose](#oh_arkui_drawabledescriptor_dispose) ([ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) \*drawableDescriptor) | Disposes of the pointer to a **DrawableDescriptor** object. | 326| [OH_PixelmapNativeHandle](#oh_pixelmapnativehandle) [OH_ArkUI_DrawableDescriptor_GetStaticPixelMap](#oh_arkui_drawabledescriptor_getstaticpixelmap) ([ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) \*drawableDescriptor) | Obtains the pointer to a **PixelMap** object. | 327| [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. | 328| 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. | 329| 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. | 330| 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. | 331| 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. | 332| 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. | 333| [ArkUI_AnimateOption](#arkui_animateoption) \* [OH_ArkUI_AnimateOption_Create](#oh_arkui_animateoption_create) () | Creates an animation configuration. | 334| void [OH_ArkUI_AnimateOption_Dispose](#oh_arkui_animateoption_dispose) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | Destroys an animation configuration. | 335| int32_t [OH_ArkUI_AnimateOption_GetDuration](#oh_arkui_animateoption_getduration) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | Obtains the animation duration, in milliseconds. | 336| float [OH_ArkUI_AnimateOption_GetTempo](#oh_arkui_animateoption_gettempo) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | Obtains the playback speed of an animation. | 337| [ArkUI_AnimationCurve](#arkui_animationcurve) [OH_ArkUI_AnimateOption_GetCurve](#oh_arkui_animateoption_getcurve) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | Obtains an animation curve. | 338| int32_t [OH_ArkUI_AnimateOption_GetDelay](#oh_arkui_animateoption_getdelay) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | Obtains the animation delay, in milliseconds. | 339| 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. | 340| [ArkUI_AnimationPlayMode](#arkui_animationplaymode) [OH_ArkUI_AnimateOption_GetPlayMode](#oh_arkui_animateoption_getplaymode) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | Obtains the playback mode of an animation. | 341| [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. | 342| void [OH_ArkUI_AnimateOption_SetDuration](#oh_arkui_animateoption_setduration) ([ArkUI_AnimateOption](#arkui_animateoption) \*option, int32_t value) | Sets the animation duration. | 343| void [OH_ArkUI_AnimateOption_SetTempo](#oh_arkui_animateoption_settempo) ([ArkUI_AnimateOption](#arkui_animateoption) \*option, float value) | Sets the playback speed of an animation. | 344| void [OH_ArkUI_AnimateOption_SetCurve](#oh_arkui_animateoption_setcurve) ([ArkUI_AnimateOption](#arkui_animateoption) \*option, [ArkUI_AnimationCurve](#arkui_animationcurve) value) | Animation curve. | 345| void [OH_ArkUI_AnimateOption_SetDelay](#oh_arkui_animateoption_setdelay) ([ArkUI_AnimateOption](#arkui_animateoption) \*option, int32_t value) | Sets the animation delay. | 346| 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. | 347| 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. | 348| 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. | 349| 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. | 350| [ArkUI_CurveHandle](#arkui_curvehandle) [OH_ArkUI_AnimateOption_GetICurve](#oh_arkui_animateoption_geticurve) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | Obtains the animation curve of an animation. | 351| [ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) \* [OH_ArkUI_KeyframeAnimateOption_Create](#oh_arkui_keyframeanimateoption_create) (int32_t size) | Obtains the keyframe animation parameters. | 352| void [OH_ArkUI_KeyframeAnimateOption_Dispose](#oh_arkui_keyframeanimateoption_dispose) ([ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) \*option) | Destroys a keyframe animation parameter object. | 353| 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. | 354| 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. | 355| 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. | 356| 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. | 357| 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. | 358| 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. | 359| int32_t [OH_ArkUI_KeyframeAnimateOption_GetDelay](#oh_arkui_keyframeanimateoption_getdelay) ([ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) \*option) | Obtains the overall delay of a keyframe animation | 360| 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. | 361| 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. | 362| [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. | 363| [ArkUI_AnimatorOption](#arkui_animatoroption) \* [OH_ArkUI_AnimatorOption_Create](#oh_arkui_animatoroption_create) (int32_t keyframeSize) | Creates an animator parameter object. | 364| void [OH_ArkUI_AnimatorOption_Dispose](#oh_arkui_animatoroption_dispose) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | Destroys an animator parameter object. | 365| 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. | 366| 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. | 367| 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. | 368| 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. | 369| int32_t [OH_ArkUI_AnimatorOption_SetDirection](#oh_arkui_animatoroption_setdirection) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, [ArkUI_AnimationDirection](#arkui_animationdirection) value) | Sets the playback direction. | 370| 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. | 371| 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. | 372| 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. | 373| 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. | 374| 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. | 375| 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. | 376| int32_t [OH_ArkUI_AnimatorOption_GetDuration](#oh_arkui_animatoroption_getduration) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | Obtains the duration for playing an animation. | 377| int32_t [OH_ArkUI_AnimatorOption_GetDelay](#oh_arkui_animatoroption_getdelay) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | Obtains the delay for playing an animation. | 378| 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. | 379| [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. | 380| [ArkUI_AnimationDirection](#arkui_animationdirection) [OH_ArkUI_AnimatorOption_GetDirection](#oh_arkui_animatoroption_getdirection) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | Obtains the playback direction of an animation. | 381| [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. | 382| float [OH_ArkUI_AnimatorOption_GetBegin](#oh_arkui_animatoroption_getbegin) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | Obtains the interpolation start point of an animation. | 383| float [OH_ArkUI_AnimatorOption_GetEnd](#oh_arkui_animatoroption_getend) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | Obtains the interpolation end point of an animation. | 384| [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. | 385| float [OH_ArkUI_AnimatorOption_GetKeyframeTime](#oh_arkui_animatoroption_getkeyframetime) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, int32_t index) | Obtains the keyframe time of an animation. | 386| float [OH_ArkUI_AnimatorOption_GetKeyframeValue](#oh_arkui_animatoroption_getkeyframevalue) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, int32_t index) | Obtains the keyframe value of an animation. | 387| [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. | 388| void \* [OH_ArkUI_AnimatorEvent_GetUserData](#oh_arkui_animatorevent_getuserdata) (ArkUI_AnimatorEvent \*event) | Obtains the custom object in an animation event object. | 389| void \* [OH_ArkUI_AnimatorOnFrameEvent_GetUserData](#oh_arkui_animatoronframeevent_getuserdata) (ArkUI_AnimatorOnFrameEvent \*event) | Obtains the custom object in an animation event object. | 390| float [OH_ArkUI_AnimatorOnFrameEvent_GetValue](#oh_arkui_animatoronframeevent_getvalue) (ArkUI_AnimatorOnFrameEvent \*event) | Obtains the current progress in an animation event object. | 391| 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. | 392| 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. | 393| 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. | 394| 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. | 395| int32_t [OH_ArkUI_Animator_ResetAnimatorOption](#oh_arkui_animator_resetanimatoroption) ([ArkUI_AnimatorHandle](#arkui_animatorhandle) animator, [ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | Resets an animator configuration. | 396| int32_t [OH_ArkUI_Animator_Play](#oh_arkui_animator_play) ([ArkUI_AnimatorHandle](#arkui_animatorhandle) animator) | Starts the animation of an animator. | 397| int32_t [OH_ArkUI_Animator_Finish](#oh_arkui_animator_finish) ([ArkUI_AnimatorHandle](#arkui_animatorhandle) animator) | Ends the animation of an animator. | 398| int32_t [OH_ArkUI_Animator_Pause](#oh_arkui_animator_pause) ([ArkUI_AnimatorHandle](#arkui_animatorhandle) animator) | Pauses the animation of an animator. | 399| int32_t [OH_ArkUI_Animator_Cancel](#oh_arkui_animator_cancel) ([ArkUI_AnimatorHandle](#arkui_animatorhandle) animator) | Cancels the animation of an animator. | 400| int32_t [OH_ArkUI_Animator_Reverse](#oh_arkui_animator_reverse) ([ArkUI_AnimatorHandle](#arkui_animatorhandle) animator) | Plays this animation in reverse order. | 401| [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. | 402| [ArkUI_CurveHandle](#arkui_curvehandle) [OH_ArkUI_Curve_CreateStepsCurve](#oh_arkui_curve_createstepscurve) (int32_t count, bool end) | Creates a step curve. | 403| [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. | 404| [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**. | 405| [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. | 406| [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**. | 407| [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. | 408| [ArkUI_CurveHandle](#arkui_curvehandle) [OH_ArkUI_Curve_CreateCustomCurve](#oh_arkui_curve_createcustomcurve) (void \*userData, float(\*interpolate)(float fraction, void \*userdata)) | Creates a custom curve. | 409| void [OH_ArkUI_Curve_DisposeCurve](#oh_arkui_curve_disposecurve) ([ArkUI_CurveHandle](#arkui_curvehandle) curveHandle) | Disposes of a custom curve. | 410| [ArkUI_TransitionEffect](#arkui_transitioneffect) \* [OH_ArkUI_CreateOpacityTransitionEffect](#oh_arkui_createopacitytransitioneffect) (float opacity) | Creates an opacity object for component transition. | 411| [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. | 412| [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. | 413| [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. | 414| [ArkUI_TransitionEffect](#arkui_transitioneffect) \* [OH_ArkUI_CreateMovementTransitionEffect](#oh_arkui_createmovementtransitioneffect) ([ArkUI_TransitionEdge](#arkui_transitionedge) move) | Creates a movement object for component transition. | 415| [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. | 416| void [OH_ArkUI_TransitionEffect_Dispose](#oh_arkui_transitioneffect_dispose) ([ArkUI_TransitionEffect](#arkui_transitioneffect) \*option) | Disposes of a transition effect. | 417| 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. | 418| 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. | 419| 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. | 420| 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. | 421| 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. | 422| 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. | 423| ArkUI_GestureRecognizer \* [OH_ArkUI_GestureInterruptInfo_GetRecognizer](#oh_arkui_gestureinterruptinfo_getrecognizer) (const ArkUI_GestureInterruptInfo \*event) | Obtains the pointer to interrupted gesture recognizer. | 424| ArkUI_GestureEvent \* [OH_ArkUI_GestureInterruptInfo_GetGestureEvent](#oh_arkui_gestureinterruptinfo_getgestureevent) (const ArkUI_GestureInterruptInfo \*event) | Obtains the pointer to the interrupted gesture event. | 425| int32_t [OH_ArkUI_GestureInterruptInfo_GetSystemRecognizerType](#oh_arkui_gestureinterruptinfo_getsystemrecognizertype) (const ArkUI_GestureInterruptInfo \*event) | Obtains the type of the system gesture to trigger. | 426| [ArkUI_GestureEventActionType](#arkui_gestureeventactiontype) [OH_ArkUI_GestureEvent_GetActionType](#oh_arkui_gestureevent_getactiontype) (const ArkUI_GestureEvent \*event) | Obtains the gesture event type. | 427| [ArkUI_NodeHandle](#arkui_nodehandle) [OH_ArkUI_GestureEvent_GetResponseNode](#oh_arkui_gestureevent_getresponsenode) (ArkUI_GestureEvent \*event) | Obtains the node that responds to the gesture. | 428| 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. | 429| 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. | 430| float [OH_ArkUI_PanGesture_GetVelocity](#oh_arkui_pangesture_getvelocity) (const ArkUI_GestureEvent \*event) | Obtains the velocity of a pan gesture along the main axis. | 431| float [OH_ArkUI_PanGesture_GetVelocityX](#oh_arkui_pangesture_getvelocityx) (const ArkUI_GestureEvent \*event) | Obtains the velocity of a pan gesture along the x-axis. | 432| float [OH_ArkUI_PanGesture_GetVelocityY](#oh_arkui_pangesture_getvelocityy) (const ArkUI_GestureEvent \*event) | Obtains the velocity of a pan gesture along the y-axis. | 433| 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. | 434| 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. | 435| float [OH_ArkUI_SwipeGesture_GetAngle](#oh_arkui_swipegesture_getangle) (const ArkUI_GestureEvent \*event) | Obtains the angle information of the swipe gesture. | 436| 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. | 437| float [OH_ArkUI_RotationGesture_GetAngle](#oh_arkui_rotationgesture_getangle) (const ArkUI_GestureEvent \*event) | Obtains the angle information of a rotation gesture. | 438| float [OH_ArkUI_PinchGesture_GetScale](#oh_arkui_pinchgesture_getscale) (const ArkUI_GestureEvent \*event) | Obtains the scale ratio of a pinch gesture. | 439| 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. | 440| 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. | 441| [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. | 442| 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. | 443| int32_t [OH_ArkUI_SetGestureRecognizerEnabled](#oh_arkui_setgesturerecognizerenabled) (ArkUI_GestureRecognizer \*recognizer, bool enabled) | Sets the enabled state of a gesture recognizer. | 444| bool [OH_ArkUI_GetGestureRecognizerEnabled](#oh_arkui_getgesturerecognizerenabled) (ArkUI_GestureRecognizer \*recognizer) | Obtains the enabled state of a gesture recognizer. | 445| int32_t [OH_ArkUI_GetGestureRecognizerState](#oh_arkui_getgesturerecognizerstate) (ArkUI_GestureRecognizer \*recognizer, [ArkUI_GestureRecognizerState](#arkui_gesturerecognizerstate) \*state) | Obtains the state of a gesture recognizer. | 446| int32_t [OH_ArkUI_GetGestureEventTargetInfo](#oh_arkui_getgestureeventtargetinfo) (ArkUI_GestureRecognizer \*recognizer, [ArkUI_GestureEventTargetInfo](#arkui_gestureeventtargetinfo) \*\*info) | Obtains the information about a gesture event target. | 447| 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. | 448| 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. | 449| int32_t [OH_ArkUI_GetPanGestureDirectionMask](#oh_arkui_getpangesturedirectionmask) (ArkUI_GestureRecognizer \*recognizer, [ArkUI_GestureDirectionMask](#arkui_gesturedirectionmask) \*directionMask) | Obtains the direction of a pan gesture. | 450| bool [OH_ArkUI_IsBuiltInGesture](#oh_arkui_isbuiltingesture) (ArkUI_GestureRecognizer \*recognizer) | Obtains whether a gesture is a built-in gesture. | 451| 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. | 452| 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. | 453| bool [OH_ArkUI_IsGestureRecognizerValid](#oh_arkui_isgesturerecognizervalid) (ArkUI_GestureRecognizer \*recognizer) | Obtains whether a gesture recognizer is valid. | 454| void \* [OH_ArkUI_ParallelInnerGestureEvent_GetUserData](#oh_arkui_parallelinnergestureevent_getuserdata) ([ArkUI_ParallelInnerGestureEvent](#arkui_parallelinnergestureevent) \*event) | Obtains custom data in the parallel internal gesture event. | 455| 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. | 456| 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. | 457| 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. | 458| void \* [OH_ArkUI_QueryModuleInterfaceByName](#oh_arkui_querymoduleinterfacebyname) ([ArkUI_NativeAPIVariantKind](#arkui_nativeapivariantkind) type, const char \*structName) | Obtains the native API set of a specified type. | 459| [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. | 460| 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. | 461| 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. | 462| [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. | 463| 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. | 464| [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. | 465| 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. | 466| 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. | 467| [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. | 468| int32_t [OH_ArkUI_NodeEvent_GetTargetId](#oh_arkui_nodeevent_gettargetid) ([ArkUI_NodeEvent](#arkui_nodeevent-12) \*event) | Obtains the custom ID of a component event. | 469| [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. | 470| [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. | 471| [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. | 472| [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. | 473| void \* [OH_ArkUI_NodeEvent_GetUserData](#oh_arkui_nodeevent_getuserdata) ([ArkUI_NodeEvent](#arkui_nodeevent-12) \*event) | Obtains the custom data in a component event. | 474| 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. | 475| 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. | 476| 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. | 477| [ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) [OH_ArkUI_NodeAdapter_Create](#oh_arkui_nodeadapter_create) () | Creates a component adapter. | 478| void [OH_ArkUI_NodeAdapter_Dispose](#oh_arkui_nodeadapter_dispose) ([ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) handle) | Destroys a component adapter. | 479| 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. | 480| 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. | 481| 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. | 482| void [OH_ArkUI_NodeAdapter_UnregisterEventReceiver](#oh_arkui_nodeadapter_unregistereventreceiver) ([ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) handle) | Unregisters an event callback for the specified adapter. | 483| int32_t [OH_ArkUI_NodeAdapter_ReloadAllItems](#oh_arkui_nodeadapter_reloadallitems) ([ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) handle) | Instructs the specified adapter to reload all elements. | 484| 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. | 485| 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. | 486| 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. | 487| 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. | 488| 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. | 489| 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. | 490| [ArkUI_NodeAdapterEventType](#arkui_nodeadaptereventtype) [OH_ArkUI_NodeAdapterEvent_GetType](#oh_arkui_nodeadapterevent_gettype) ([ArkUI_NodeAdapterEvent](#arkui_nodeadapterevent) \*event) | Obtains the event type. | 491| [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. | 492| 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. | 493| [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. | 494| 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. | 495| 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. | 496| [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. | 497| [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. | 498| [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. | 499| int32_t [OH_ArkUI_NodeCustomEvent_GetEventTargetId](#oh_arkui_nodecustomevent_geteventtargetid) ([ArkUI_NodeCustomEvent](#arkui_nodecustomevent) \*event) | Obtains the ID of a custom component event. | 500| void \* [OH_ArkUI_NodeCustomEvent_GetUserData](#oh_arkui_nodecustomevent_getuserdata) ([ArkUI_NodeCustomEvent](#arkui_nodecustomevent) \*event) | Obtains custom event parameters through a custom component event. | 501| [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. | 502| [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. | 503| 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. | 504| 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. | 505| 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. | 506| 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. | 507| [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. | 508| [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. | 509| 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. | 510| void \* [OH_ArkUI_NodeContent_GetUserData](#oh_arkui_nodecontent_getuserdata) ([ArkUI_NodeContentHandle](#arkui_nodecontenthandle) content) | Obtains the custom data saved on the specified NodeContent object. | 511| 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. | 512| 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. | 513| 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. | 514| 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. | 515| 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. | 516| 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. | 517| 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. | 518| 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. | 519| 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. | 520| 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. | 521| 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. | 522| 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. | 523| [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. | 524| 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. | 525| [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. | 526| 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. | 527| int32_t [OH_ArkUI_NodeUtils_GetNodeType](#oh_arkui_nodeutils_getnodetype) ([ArkUI_NodeHandle](#arkui_nodehandle) node) | Obtains the type of the specified node. | 528| 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. | 529| [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. | 530| 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. | 531| void [OH_ArkUI_UnregisterSystemColorModeChangeEvent](#oh_arkui_unregistersystemcolormodechangeevent) ([ArkUI_NodeHandle](#arkui_nodehandle) node) | Unregisters the event listener for system color mode changes. | 532| 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. | 533| void [OH_ArkUI_UnregisterSystemFontStyleChangeEvent](#oh_arkui_unregistersystemfontstylechangeevent) ([ArkUI_NodeHandle](#arkui_nodehandle) node) | Unregisters the event listener for system font style changes. | 534| 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. | 535| 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. | 536| 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. | 537| 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. | 538| 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. | 539| 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. | 540| 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. | 541| [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. | 542| [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. | 543| [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. | 544| [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. | 545| [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. | 546| [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. | 547| [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. | 548| 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. | 549| [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. | 550| [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. | 551| [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. | 552| [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. | 553| [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. | 554| [ArkUI_LayoutConstraint](#arkui_layoutconstraint) \* [OH_ArkUI_LayoutConstraint_Create](#oh_arkui_layoutconstraint_create) () | Creates a size constraint. | 555| [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. | 556| void \* [OH_ArkUI_LayoutConstraint_Dispose](#oh_arkui_layoutconstraint_dispose) ([ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint) | Disposes of the pointer to a size constraint. | 557| 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. | 558| 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. | 559| 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. | 560| 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. | 561| 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. | 562| 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. | 563| void [OH_ArkUI_LayoutConstraint_SetMaxWidth](#oh_arkui_layoutconstraint_setmaxwidth) ([ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint, int32_t value) | Sets the maximum width. | 564| void [OH_ArkUI_LayoutConstraint_SetMinWidth](#oh_arkui_layoutconstraint_setminwidth) ([ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint, int32_t value) | Sets the minimum width. | 565| void [OH_ArkUI_LayoutConstraint_SetMaxHeight](#oh_arkui_layoutconstraint_setmaxheight) ([ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint, int32_t value) | Sets the maximum height. | 566| void [OH_ArkUI_LayoutConstraint_SetMinHeight](#oh_arkui_layoutconstraint_setminheight) ([ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint, int32_t value) | Sets the minimum height. | 567| void [OH_ArkUI_LayoutConstraint_SetPercentReferenceWidth](#oh_arkui_layoutconstraint_setpercentreferencewidth) ([ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint, int32_t value) | Sets the width percentage reference. | 568| void [OH_ArkUI_LayoutConstraint_SetPercentReferenceHeight](#oh_arkui_layoutconstraint_setpercentreferenceheight) ([ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint, int32_t value) | Sets the height percentage reference. | 569| 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. | 570| [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. | 571| [ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \* [OH_ArkUI_WaterFlowSectionOption_Create](#oh_arkui_waterflowsectionoption_create) () | Creates a water flow section configuration. | 572| void [OH_ArkUI_WaterFlowSectionOption_Dispose](#oh_arkui_waterflowsectionoption_dispose) ([ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \*option) | Disposes of the pointer to a water flow section configuration. | 573| 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. | 574| 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. | 575| 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. | 576| 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. | 577| 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. | 578| 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. | 579| 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. | 580| 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. | 581| 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. | 582| 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. | 583| 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. | 584| [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. | 585| 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. | 586| 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. | 587| [ArkUI_GuidelineOption](#arkui_guidelineoption) \* [OH_ArkUI_GuidelineOption_Create](#oh_arkui_guidelineoption_create) (int32_t size) | Creates a guideline configuration for this **RelativeContainer** component. | 588| void [OH_ArkUI_GuidelineOption_Dispose](#oh_arkui_guidelineoption_dispose) ([ArkUI_GuidelineOption](#arkui_guidelineoption) \*guideline) | Disposes of a guideline configuration. | 589| 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. | 590| 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. | 591| 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. | 592| 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. | 593| const char \* [OH_ArkUI_GuidelineOption_GetId](#oh_arkui_guidelineoption_getid) ([ArkUI_GuidelineOption](#arkui_guidelineoption) \*guideline, int32_t index) | Obtains the ID of a guideline. | 594| [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. | 595| 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. | 596| 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. | 597| [ArkUI_BarrierOption](#arkui_barrieroption) \* [OH_ArkUI_BarrierOption_Create](#oh_arkui_barrieroption_create) (int32_t size) | Creates a barrier configuration for this **RelativeContainer** component. | 598| void [OH_ArkUI_BarrierOption_Dispose](#oh_arkui_barrieroption_dispose) ([ArkUI_BarrierOption](#arkui_barrieroption) \*barrierStyle) | Disposes of a barrier configuration. | 599| 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. | 600| 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. | 601| 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. | 602| const char \* [OH_ArkUI_BarrierOption_GetId](#oh_arkui_barrieroption_getid) ([ArkUI_BarrierOption](#arkui_barrieroption) \*barrierStyle, int32_t index) | Obtains the ID of a barrier. | 603| [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. | 604| 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. | 605| 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. | 606| [ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \* [OH_ArkUI_AlignmentRuleOption_Create](#oh_arkui_alignmentruleoption_create) () | Creates an alignment rule configuration for this **RelativeContainer** component. | 607| void [OH_ArkUI_AlignmentRuleOption_Dispose](#oh_arkui_alignmentruleoption_dispose) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Disposes of an alignment rule configuration of this **RelativeContainer** component. | 608| 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. | 609| 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. | 610| 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. | 611| 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. | 612| 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. | 613| 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. | 614| 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. | 615| 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. | 616| const char \* [OH_ArkUI_AlignmentRuleOption_GetStartId](#oh_arkui_alignmentruleoption_getstartid) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the ID in the left alignment parameters. | 617| [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. | 618| const char \* [OH_ArkUI_AlignmentRuleOption_GetEndId](#oh_arkui_alignmentruleoption_getendid) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the ID in the right alignment parameters. | 619| [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. | 620| const char \* [OH_ArkUI_AlignmentRuleOption_GetCenterIdHorizontal](#oh_arkui_alignmentruleoption_getcenteridhorizontal) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the ID in horizontal center alignment parameters. | 621| [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. | 622| const char \* [OH_ArkUI_AlignmentRuleOption_GetTopId](#oh_arkui_alignmentruleoption_gettopid) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the ID in top alignment parameters. | 623| [ArkUI_VerticalAlignment](#arkui_verticalalignment) [OH_ArkUI_AlignmentRuleOption_GetTopAlignment](#oh_arkui_alignmentruleoption_gettopalignment) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the ID in top alignment parameters. | 624| const char \* [OH_ArkUI_AlignmentRuleOption_GetBottomId](#oh_arkui_alignmentruleoption_getbottomid) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the ID in bottom alignment parameters. | 625| [ArkUI_VerticalAlignment](#arkui_verticalalignment) [OH_ArkUI_AlignmentRuleOption_GetBottomAlignment](#oh_arkui_alignmentruleoption_getbottomalignment) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the ID in bottom alignment parameters. | 626| const char \* [OH_ArkUI_AlignmentRuleOption_GetCenterIdVertical](#oh_arkui_alignmentruleoption_getcenteridvertical) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the ID in vertical center alignment parameters. | 627| [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. | 628| float [OH_ArkUI_AlignmentRuleOption_GetBiasHorizontal](#oh_arkui_alignmentruleoption_getbiashorizontal) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the bias value in the horizontal direction. | 629| float [OH_ArkUI_AlignmentRuleOption_GetBiasVertical](#oh_arkui_alignmentruleoption_getbiasvertical) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the bias value in the vertical direction. | 630| [ArkUI_SwiperIndicator](#arkui_swiperindicator) \* [OH_ArkUI_SwiperIndicator_Create](#oh_arkui_swiperindicator_create) ([ArkUI_SwiperIndicatorType](#arkui_swiperindicatortype) type) | Creates a navigation point indicator for this **Swiper** component. | 631| void [OH_ArkUI_SwiperIndicator_Dispose](#oh_arkui_swiperindicator_dispose) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | Disposes of the navigation point indicator of this **Swiper** component. | 632| void [OH_ArkUI_SwiperIndicator_SetStartPosition](#oh_arkui_swiperindicator_setstartposition) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, float value) | Sets the distance between the navigation point indicator and the left edge of the **Swiper** component. | 633| float [OH_ArkUI_SwiperIndicator_GetStartPosition](#oh_arkui_swiperindicator_getstartposition) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | Obtains the distance between a navigation point indicator and the left edge of the **Swiper** component. | 634| void [OH_ArkUI_SwiperIndicator_SetTopPosition](#oh_arkui_swiperindicator_settopposition) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, float value) | Sets the distance between the navigation point indicator and the top edge of the **Swiper** component. | 635| float [OH_ArkUI_SwiperIndicator_GetTopPosition](#oh_arkui_swiperindicator_gettopposition) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | Obtains the distance between the navigation point indicator and the top edge of the **Swiper** component. | 636| void [OH_ArkUI_SwiperIndicator_SetEndPosition](#oh_arkui_swiperindicator_setendposition) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, float value) | Sets the distance between the navigation point indicator and the right edge of the **Swiper** component. | 637| float [OH_ArkUI_SwiperIndicator_GetEndPosition](#oh_arkui_swiperindicator_getendposition) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | Obtains the distance between the navigation point indicator and the right edge of the **Swiper** component. | 638| void [OH_ArkUI_SwiperIndicator_SetBottomPosition](#oh_arkui_swiperindicator_setbottomposition) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, float value) | Sets the distance between the navigation point indicator and the bottom edge of the **Swiper** component. | 639| float [OH_ArkUI_SwiperIndicator_GetBottomPosition](#oh_arkui_swiperindicator_getbottomposition) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | Obtains the distance between the navigation point indicator and the bottom edge of the **Swiper** component. | 640| void [OH_ArkUI_SwiperIndicator_SetItemWidth](#oh_arkui_swiperindicator_setitemwidth) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, float value) | Sets the width of a navigation point indicator of the dot style for the **Swiper** component. | 641| float [OH_ArkUI_SwiperIndicator_GetItemWidth](#oh_arkui_swiperindicator_getitemwidth) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | Obtains the width of a navigation point indicator of the dot style of the **Swiper** component. | 642| void [OH_ArkUI_SwiperIndicator_SetItemHeight](#oh_arkui_swiperindicator_setitemheight) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, float value) | Sets the height of a navigation point indicator of the dot style for the **Swiper** component. | 643| float [OH_ArkUI_SwiperIndicator_GetItemHeight](#oh_arkui_swiperindicator_getitemheight) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | Obtains the height of a navigation point indicator of the dot style of the **Swiper** component. | 644| void [OH_ArkUI_SwiperIndicator_SetSelectedItemWidth](#oh_arkui_swiperindicator_setselecteditemwidth) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, float value) | Sets the width of the selected navigation point indicator of the dot style for the **Swiper** component. | 645| float [OH_ArkUI_SwiperIndicator_GetSelectedItemWidth](#oh_arkui_swiperindicator_getselecteditemwidth) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | Obtains the width of the selected navigation point indicator of the dot style of the **Swiper** component. | 646| void [OH_ArkUI_SwiperIndicator_SetSelectedItemHeight](#oh_arkui_swiperindicator_setselecteditemheight) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, float value) | Sets the height of the selected navigation point indicator of the dot style for the **Swiper** component. | 647| float [OH_ArkUI_SwiperIndicator_GetSelectedItemHeight](#oh_arkui_swiperindicator_getselecteditemheight) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | Obtains the height of the selected navigation point indicator of the dot style of the **Swiper** component. | 648| 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 navigation point indicator of the dot style for the **Swiper** component. | 649| int32_t [OH_ArkUI_SwiperIndicator_GetMask](#oh_arkui_swiperindicator_getmask) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | Obtains whether the mask is enabled for a navigation point indicator of the dot style of the **Swiper** component. | 650| void [OH_ArkUI_SwiperIndicator_SetColor](#oh_arkui_swiperindicator_setcolor) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, uint32_t color) | Sets the color of a navigation point indicator of the dot style for the **Swiper** component. | 651| uint32_t [OH_ArkUI_SwiperIndicator_GetColor](#oh_arkui_swiperindicator_getcolor) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | Obtains the color of a navigation point indicator of the dot style of the **Swiper** component. | 652| void [OH_ArkUI_SwiperIndicator_SetSelectedColor](#oh_arkui_swiperindicator_setselectedcolor) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator, uint32_t selectedColor) | Sets the color of the selected navigation point indicator of the dot style for the **Swiper** component. | 653| uint32_t [OH_ArkUI_SwiperIndicator_GetSelectedColor](#oh_arkui_swiperindicator_getselectedcolor) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | Obtains the color of the selected navigation point indicator of the dot style of the **Swiper** component. | 654| 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 navigation point indicator of the dot style. | 655| int32_t [OH_ArkUI_SwiperIndicator_GetMaxDisplayCount](#oh_arkui_swiperindicator_getmaxdisplaycount) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | Obtains the maximum number of points for the navigation point indicator. | 656| [ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \* [OH_ArkUI_ListItemSwipeActionItem_Create](#oh_arkui_listitemswipeactionitem_create) () | Creates a **ListItemSwipeActionItem** instance. | 657| void [OH_ArkUI_ListItemSwipeActionItem_Dispose](#oh_arkui_listitemswipeactionitem_dispose) ([ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item) | Disposes of a **ListItemSwipeActionItem** instance. | 658| 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. | 659| 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. | 660| float [OH_ArkUI_ListItemSwipeActionItem_GetActionAreaDistance](#oh_arkui_listitemswipeactionitem_getactionareadistance) ([ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item) | Obtains the swipe distance threshold for deleting the list item. | 661| 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. | 662| 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. | 663| 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. | 664| 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. | 665| 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. | 666| 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. | 667| 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. | 668| 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. | 669| [ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption) \* [OH_ArkUI_ListItemSwipeActionOption_Create](#oh_arkui_listitemswipeactionoption_create) () | Creates a **ListItemSwipeActionOption** instance. | 670| void [OH_ArkUI_ListItemSwipeActionOption_Dispose](#oh_arkui_listitemswipeactionoption_dispose) ([ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption) \*option) | Disposes of a **ListItemSwipeActionOption** instance. | 671| 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. | 672| 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. | 673| 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. | 674| 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. | 675| 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. | 676| 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. | 677| [ArkUI_AccessibilityState](#arkui_accessibilitystate) \* [OH_ArkUI_AccessibilityState_Create](#oh_arkui_accessibilitystate_create) (void) | Creates an accessibility state. | 678| void [OH_ArkUI_AccessibilityState_Dispose](#oh_arkui_accessibilitystate_dispose) ([ArkUI_AccessibilityState](#arkui_accessibilitystate) \*state) | Disposes of the pointer to an accessibility state. | 679| void [OH_ArkUI_AccessibilityState_SetDisabled](#oh_arkui_accessibilitystate_setdisabled) ([ArkUI_AccessibilityState](#arkui_accessibilitystate) \*state, int32_t isDisabled) | Sets whether an accessibility state is disabled. | 680| int32_t [OH_ArkUI_AccessibilityState_IsDisabled](#oh_arkui_accessibilitystate_isdisabled) ([ArkUI_AccessibilityState](#arkui_accessibilitystate) \*state) | Obtains whether an accessibility state is disabled. | 681| void [OH_ArkUI_AccessibilityState_SetSelected](#oh_arkui_accessibilitystate_setselected) ([ArkUI_AccessibilityState](#arkui_accessibilitystate) \*state, int32_t isSelected) | Sets whether an accessibility state is selected. | 682| int32_t [OH_ArkUI_AccessibilityState_IsSelected](#oh_arkui_accessibilitystate_isselected) ([ArkUI_AccessibilityState](#arkui_accessibilitystate) \*state) | Obtains whether an accessibility state is selected. | 683| 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. | 684| int32_t [OH_ArkUI_AccessibilityState_GetCheckedState](#oh_arkui_accessibilitystate_getcheckedstate) ([ArkUI_AccessibilityState](#arkui_accessibilitystate) \*state) | Obtains the check box state of an accessibility state. | 685| [ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \* [OH_ArkUI_AccessibilityValue_Create](#oh_arkui_accessibilityvalue_create) (void) | Creates an **AccessibilityValue** instance. | 686| void [OH_ArkUI_AccessibilityValue_Dispose](#oh_arkui_accessibilityvalue_dispose) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value) | Disposes of the pointer to an **AccessibilityValue** instance. | 687| void [OH_ArkUI_AccessibilityValue_SetMin](#oh_arkui_accessibilityvalue_setmin) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value, int32_t min) | Sets the minimum accessibility value. | 688| int32_t [OH_ArkUI_AccessibilityValue_GetMin](#oh_arkui_accessibilityvalue_getmin) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value) | Obtains the minimum accessibility value. | 689| void [OH_ArkUI_AccessibilityValue_SetMax](#oh_arkui_accessibilityvalue_setmax) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value, int32_t max) | Sets the maximum accessibility value. | 690| int32_t [OH_ArkUI_AccessibilityValue_GetMax](#oh_arkui_accessibilityvalue_getmax) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value) | Obtains the maximum accessibility value. | 691| void [OH_ArkUI_AccessibilityValue_SetCurrent](#oh_arkui_accessibilityvalue_setcurrent) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value, int32_t current) | Sets the current accessibility value. | 692| int32_t [OH_ArkUI_AccessibilityValue_GetCurrent](#oh_arkui_accessibilityvalue_getcurrent) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value) | Obtains the current accessibility value. | 693| 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. | 694| const char \* [OH_ArkUI_AccessibilityValue_GetText](#oh_arkui_accessibilityvalue_gettext) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value) | Obtains the text description of an **AccessibilityValue** instance. | 695| [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. | 696| [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. | 697| void [OH_ArkUI_ImageAnimatorFrameInfo_Dispose](#oh_arkui_imageanimatorframeinfo_dispose) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo) | Disposes of the pointer to an image frame information object. | 698| void [OH_ArkUI_ImageAnimatorFrameInfo_SetWidth](#oh_arkui_imageanimatorframeinfo_setwidth) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo, int32_t width) | Sets the image width. | 699| int32_t [OH_ArkUI_ImageAnimatorFrameInfo_GetWidth](#oh_arkui_imageanimatorframeinfo_getwidth) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo) | Obtains the image width. | 700| void [OH_ArkUI_ImageAnimatorFrameInfo_SetHeight](#oh_arkui_imageanimatorframeinfo_setheight) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo, int32_t height) | Sets the image height. | 701| int32_t [OH_ArkUI_ImageAnimatorFrameInfo_GetHeight](#oh_arkui_imageanimatorframeinfo_getheight) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo) | Obtains the image height. | 702| 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. | 703| 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. | 704| 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. | 705| 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. | 706| void [OH_ArkUI_ImageAnimatorFrameInfo_SetDuration](#oh_arkui_imageanimatorframeinfo_setduration) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo, int32_t duration) | Sets the playback duration of an image. | 707| int32_t [OH_ArkUI_ImageAnimatorFrameInfo_GetDuration](#oh_arkui_imageanimatorframeinfo_getduration) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo) | Obtains the playback duration of an image. | 708| [ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) \* [OH_ArkUI_ListChildrenMainSizeOption_Create](#oh_arkui_listchildrenmainsizeoption_create) () | Creates a **ListChildrenMainSize** instance. | 709| void [OH_ArkUI_ListChildrenMainSizeOption_Dispose](#oh_arkui_listchildrenmainsizeoption_dispose) ([ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) \*option) | Disposes of a **ListChildrenMainSize** instance. | 710| 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. | 711| float [OH_ArkUI_ListChildrenMainSizeOption_GetDefaultMainSize](#oh_arkui_listchildrenmainsizeoption_getdefaultmainsize) ([ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) \*option) | Obtains the default size in a **ListChildrenMainSize** instance. | 712| 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. | 713| 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. | 714| 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. | 715| float [OH_ArkUI_ListChildrenMainSizeOption_GetMainSize](#oh_arkui_listchildrenmainsizeoption_getmainsize) ([ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) \*option, int32_t index) | Obtains the values of a **ChildrenMainSizeOption** array. | 716| [ArkUI_CustomSpanMeasureInfo](#arkui_customspanmeasureinfo) \* [OH_ArkUI_CustomSpanMeasureInfo_Create](#oh_arkui_customspanmeasureinfo_create) (void) | Creates measurement information for this custom span. | 717| void [OH_ArkUI_CustomSpanMeasureInfo_Dispose](#oh_arkui_customspanmeasureinfo_dispose) ([ArkUI_CustomSpanMeasureInfo](#arkui_customspanmeasureinfo) \*info) | Disposes of measurement information of a custom span. | 718| 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. | 719| [ArkUI_CustomSpanMetrics](#arkui_customspanmetrics) \* [OH_ArkUI_CustomSpanMetrics_Create](#oh_arkui_customspanmetrics_create) (void) | Creates measurement metrics for this custom span. | 720| void [OH_ArkUI_CustomSpanMetrics_Dispose](#oh_arkui_customspanmetrics_dispose) ([ArkUI_CustomSpanMetrics](#arkui_customspanmetrics) \*metrics) | Disposes of measurement metrics of this custom span. | 721| int32_t [OH_ArkUI_CustomSpanMetrics_SetWidth](#oh_arkui_customspanmetrics_setwidth) ([ArkUI_CustomSpanMetrics](#arkui_customspanmetrics) \*metrics, float width) | Sets the width for a custom span. | 722| int32_t [OH_ArkUI_CustomSpanMetrics_SetHeight](#oh_arkui_customspanmetrics_setheight) ([ArkUI_CustomSpanMetrics](#arkui_customspanmetrics) \*metrics, float height) | Sets the height for a custom span. | 723| [ArkUI_CustomSpanDrawInfo](#arkui_customspandrawinfo) \* [OH_ArkUI_CustomSpanDrawInfo_Create](#oh_arkui_customspandrawinfo_create) (void) | Creates drawing information for this custom span. | 724| void [OH_ArkUI_CustomSpanDrawInfo_Dispose](#oh_arkui_customspandrawinfo_dispose) ([ArkUI_CustomSpanDrawInfo](#arkui_customspandrawinfo) \*info) | Disposes of drawing information for this custom span. | 725| 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. | 726| 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. | 727| 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. | 728| 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. | 729| void [OH_ArkUI_CustomProperty_Destroy](#oh_arkui_customproperty_destroy) (ArkUI_CustomProperty \*handle) | Destroys a **CustomProperty** instance. | 730| const char \* [OH_ArkUI_CustomProperty_GetStringValue](#oh_arkui_customproperty_getstringvalue) (ArkUI_CustomProperty \*handle) | Obtains the value of a custom property. | 731| void [OH_ArkUI_ActiveChildrenInfo_Destroy](#oh_arkui_activechildreninfo_destroy) (ArkUI_ActiveChildrenInfo \*handle) | Destroys an **ActiveChildrenInfo** instance. | 732| [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. | 733| int32_t [OH_ArkUI_ActiveChildrenInfo_GetCount](#oh_arkui_activechildreninfo_getcount) (ArkUI_ActiveChildrenInfo \*handle) | Obtains the number of nodes in the specified **ActiveChildrenInfo** instance. | 734| [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. | 735| 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. | 736| 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. | 737| void [OH_ArkUI_StyledString_AddText](#oh_arkui_styledstring_addtext) ([ArkUI_StyledString](#arkui_styledstring) \*handle, const char \*content) | Adds text for a styled string. | 738| 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. | 739| 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. | 740| void [OH_ArkUI_StyledString_AddPlaceholder](#oh_arkui_styledstring_addplaceholder) ([ArkUI_StyledString](#arkui_styledstring) \*handle, OH_Drawing_PlaceholderSpan \*placeholder) | Adds a placeholder. | 741| [ArkUI_StyledString_Descriptor](#arkui_styledstring_descriptor) \* [OH_ArkUI_StyledString_Descriptor_Create](#oh_arkui_styledstring_descriptor_create) (void) | Creates an **ArkUI_StyledString_Descriptor** object. | 742| 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. | 743| 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. | 744| 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. | 745| const char \* [OH_ArkUI_ConvertToHtml](#oh_arkui_converttohtml) ([ArkUI_StyledString_Descriptor](#arkui_styledstring_descriptor) \*descriptor) | Converts styled string information into HTML. | 746 747 748## Macro Description 749 750 751### OH_ArkUI_GetModuleInterface 752 753``` 754#define OH_ArkUI_GetModuleInterface( nativeAPIVariantKind, structType, structPtr ) 755``` 756**Value:** 757``` 758 do { \ 759 void* anyNativeAPI = OH_ArkUI_QueryModuleInterfaceByName(nativeAPIVariantKind, #structType); \ 760 if (anyNativeAPI) { \ 761 structPtr = (structType*)(anyNativeAPI); \ 762 } \ 763 } while (0) 764#include<arkui/native_interface.h> 765#include<arkui/native_node.h> 766 767ArkUI_NativeNodeAPI_1* nativeNodeApi = nullptr; 768OH_ArkUI_GetModuleInterface(ARKUI_NATIVE_NODE, ArkUI_NativeNodeAPI_1, nativeNodeApi); 769``` 770**Description** 771 772Obtains the macro function corresponding to a struct pointer based on the struct type. 773 774**Since**: 12 775 776 777## Type Description 778 779 780### ArkUI_AccessibilityState 781 782``` 783typedef struct ArkUI_AccessibilityState ArkUI_AccessibilityState 784``` 785**Description** 786 787Defines a struct for the component accessibility state. 788 789**Since**: 12 790 791 792### ArkUI_AccessibilityValue 793 794``` 795typedef struct ArkUI_AccessibilityValue ArkUI_AccessibilityValue 796``` 797**Description** 798 799Defines a struct for the component accessibility value. 800 801**Since**: 12 802 803 804### ArkUI_AlignmentRuleOption 805 806``` 807typedef struct ArkUI_AlignmentRuleOption ArkUI_AlignmentRuleOption 808``` 809**Description** 810 811Defines the alignment rule in the relative container. 812 813**Since**: 12 814 815 816### ArkUI_AnimateOption 817 818``` 819typedef struct ArkUI_AnimateOption ArkUI_AnimateOption 820``` 821**Description** 822 823Defines a struct for the animation configuration. 824 825**Since**: 12 826 827 828### ArkUI_AnimatorHandle 829 830``` 831typedef struct ArkUI_Animator* ArkUI_AnimatorHandle 832``` 833**Description** 834 835Defines a struct for the pointer to an animator object. 836 837**Since**: 12 838 839 840### ArkUI_AnimatorOption 841 842``` 843typedef struct ArkUI_AnimatorOption ArkUI_AnimatorOption 844``` 845**Description** 846 847Defines the animator parameter object. 848 849**Since**: 12 850 851 852### ArkUI_BarrierOption 853 854``` 855typedef struct ArkUI_BarrierOption ArkUI_BarrierOption 856``` 857**Description** 858 859Defines the ID, direction, and referenced component of a barrier. 860 861**Since**: 12 862 863 864### ArkUI_Context 865 866``` 867typedef struct ArkUI_Context ArkUI_Context 868``` 869**Description** 870 871Defines a struct for a UI context object. 872 873**Since**: 12 874 875 876### ArkUI_ContextHandle [1/2] 877 878``` 879typedef struct ArkUI_Context* ArkUI_ContextHandle 880``` 881**Description** 882 883Defines a struct for the handle to the ArkUI native UI context. 884 885**Since**: 12 886 887 888### ArkUI_ContextHandle [2/2] 889 890``` 891typedef struct ArkUI_Context* ArkUI_ContextHandle 892``` 893**Description** 894 895Defines the handle to the ArkUI native UI context. 896 897**Since**: 12 898 899 900### ArkUI_CurveHandle 901 902``` 903typedef struct ArkUI_Curve* ArkUI_CurveHandle 904``` 905**Description** 906 907Defines a struct for the pointer to an interpolation curve. 908 909**Since**: 12 910 911 912### ArkUI_CustomSpanDrawInfo 913 914``` 915typedef struct ArkUI_CustomSpanDrawInfo ArkUI_CustomSpanDrawInfo 916``` 917**Description** 918 919Defines a struct for the drawing information of a custom span. 920 921**Since**: 12 922 923 924### ArkUI_CustomSpanMeasureInfo 925 926``` 927typedef struct ArkUI_CustomSpanMeasureInfo ArkUI_CustomSpanMeasureInfo 928``` 929**Description** 930 931Defines a struct for the measurement information of a custom span. 932 933**Since**: 12 934 935 936### ArkUI_CustomSpanMetrics 937 938``` 939typedef struct ArkUI_CustomSpanMetrics ArkUI_CustomSpanMetrics 940``` 941**Description** 942 943Defines a struct for the measurement metrics of a custom span. 944 945**Since**: 12 946 947### ArkUI_DialogDismissEvent 948 949``` 950typedef struct ArkUI_DialogDismissEvent ArkUI_DialogDismissEvent 951``` 952**Description** 953 954Defines a struct for a dialog box dismiss event. 955 956**Since**: 12 957 958 959### ArkUI_DragAction 960 961``` 962typedef struct ArkUI_DragAction ArkUI_DragAction 963``` 964**Description** 965 966Defines a struct for a drag action. 967 968**Since**: 12 969 970 971### ArkUI_DragAndDropInfo 972 973``` 974typedef struct ArkUI_DragAndDropInfo ArkUI_DragAndDropInfo 975``` 976**Description** 977 978Defines a struct for drag and drop information returned through a drag status listener. 979 980**Since**: 12 981 982 983### ArkUI_DragEvent 984 985``` 986typedef struct ArkUI_DragEvent ArkUI_DragEvent 987``` 988**Description** 989 990Defines a struct for a drag event. 991 992**Since**: 12 993 994 995### ArkUI_DragPreviewOption 996 997``` 998typedef struct ArkUI_DragPreviewOption ArkUI_DragPreviewOption 999``` 1000**Description** 1001 1002Defines a struct for custom drag preview options. 1003 1004**Since**: 12 1005 1006 1007### ArkUI_DrawableDescriptor 1008 1009``` 1010typedef struct ArkUI_DrawableDescriptor ArkUI_DrawableDescriptor 1011``` 1012**Description** 1013 1014Defines a struct for the **DrawableDescriptor** object. 1015 1016**Since**: 12 1017 1018 1019### ArkUI_DrawContext 1020 1021``` 1022typedef struct ArkUI_DrawContext ArkUI_DrawContext 1023``` 1024**Description** 1025 1026Defines the component drawing context. 1027 1028**Since**: 12 1029 1030 1031### ArkUI_GestureDirectionMask 1032 1033``` 1034typedef uint32_t ArkUI_GestureDirectionMask 1035``` 1036**Description** 1037 1038Defines a set of gesture directions. 1039 1040**Since**: 12 1041 1042 1043### ArkUI_GestureEventActionTypeMask 1044 1045``` 1046typedef uint32_t ArkUI_GestureEventActionTypeMask 1047``` 1048**Description** 1049 1050Defines a set of gesture event types. 1051 1052Example: **ArkUI_GestureEventActionTypeMask actions = GESTURE_EVENT_ACTION_ACCEPT | GESTURE_EVENT_ACTION_UPDATE** 1053 1054**Since**: 12 1055 1056 1057### ArkUI_GestureEventTargetInfo 1058 1059``` 1060typedef struct ArkUI_GestureEventTargetInfo ArkUI_GestureEventTargetInfo 1061``` 1062**Description** 1063 1064Defines a struct for a **GestureEventTargetInfo** object that provides information about a gesture event target. 1065 1066**Since**: 12 1067 1068 1069### ArkUI_GestureRecognizerDestructNotifyCallback 1070 1071``` 1072typedef void(* ArkUI_GestureRecognizerDestructNotifyCallback) (ArkUI_GestureRecognizer *recognizer, void *userData) 1073``` 1074**Description** 1075 1076Defines a callback function for notifying gesture recognizer destruction. 1077 1078**Since**: 12 1079 1080 1081### ArkUI_GestureRecognizerHandle 1082 1083``` 1084typedef ArkUI_GestureRecognizer* ArkUI_GestureRecognizerHandle 1085``` 1086**Description** 1087 1088Defines the gesture recognizer handle. 1089 1090**Since**: 12 1091 1092 1093### ArkUI_GestureRecognizerHandleArray 1094 1095``` 1096typedef ArkUI_GestureRecognizerHandle* ArkUI_GestureRecognizerHandleArray 1097``` 1098**Description** 1099 1100Defines the gesture recognizer handle array. 1101 1102**Since**: 12 1103 1104 1105### ArkUI_GuidelineOption 1106 1107``` 1108typedef struct ArkUI_GuidelineOption ArkUI_GuidelineOption 1109``` 1110**Description** 1111 1112Defines the ID, direction, and position of a guideline. 1113 1114**Since**: 12 1115 1116 1117### ArkUI_ImageAnimatorFrameInfo 1118 1119``` 1120typedef struct ArkUI_ImageAnimatorFrameInfo ArkUI_ImageAnimatorFrameInfo 1121``` 1122**Description** 1123 1124Defines the image frame information. 1125 1126**Since**: 12 1127 1128 1129### ArkUI_KeyframeAnimateOption 1130 1131``` 1132typedef struct ArkUI_KeyframeAnimateOption ArkUI_KeyframeAnimateOption 1133``` 1134**Description** 1135 1136Defines a struct for the keyframe animation parameter object. 1137 1138**Since**: 12 1139 1140 1141### ArkUI_LayoutConstraint 1142 1143``` 1144typedef struct ArkUI_LayoutConstraint ArkUI_LayoutConstraint 1145``` 1146**Description** 1147 1148Defines the size constraints of a component during component layout. 1149 1150**Since**: 12 1151 1152 1153### ArkUI_ListChildrenMainSize 1154 1155``` 1156typedef struct ArkUI_ListChildrenMainSize ArkUI_ListChildrenMainSize 1157``` 1158**Description** 1159 1160Defines the **ChildrenMainSize** information of the **List** component. 1161 1162**Since**: 12 1163 1164 1165### ArkUI_ListItemSwipeActionItem 1166 1167``` 1168typedef struct ArkUI_ListItemSwipeActionItem ArkUI_ListItemSwipeActionItem 1169``` 1170**Description** 1171 1172Defines the item configuration for **ListItemSwipeActionOption**. 1173 1174**Since**: 12 1175 1176 1177### ArkUI_ListItemSwipeActionOption 1178 1179``` 1180typedef struct ArkUI_ListItemSwipeActionOption ArkUI_ListItemSwipeActionOption 1181``` 1182**Description** 1183 1184Defines the configuration for **ListItemSwipeActionOption**. 1185 1186**Since**: 12 1187 1188 1189### ArkUI_NativeDialogHandle 1190 1191``` 1192typedef struct ArkUI_NativeDialog* ArkUI_NativeDialogHandle 1193``` 1194**Description** 1195 1196Defines the handle to the custom dialog box controller of ArkUI on the native side. 1197 1198**Since**: 12 1199 1200 1201### ArkUI_NodeAdapterEvent 1202 1203``` 1204typedef struct ArkUI_NodeAdapterEvent ArkUI_NodeAdapterEvent 1205``` 1206**Description** 1207 1208Defines the component adapter event. 1209 1210**Since**: 12 1211 1212 1213### ArkUI_NodeAdapterHandle 1214 1215``` 1216typedef struct ArkUI_NodeAdapter* ArkUI_NodeAdapterHandle 1217``` 1218**Description** 1219 1220Defines the component adapter, which is used for lazy loading of elements of scrollable components. 1221 1222**Since**: 12 1223 1224 1225### ArkUI_NodeContentCallback 1226 1227``` 1228typedef void(* ArkUI_NodeContentCallback) (ArkUI_NodeContentEvent *event) 1229``` 1230**Description** 1231 1232Defines the callback for the NodeContent event. 1233 1234**Since**: 12 1235 1236 1237### ArkUI_NodeContentEvent 1238 1239``` 1240typedef struct ArkUI_NodeContentEvent ArkUI_NodeContentEvent 1241``` 1242**Description** 1243 1244Defines the common structure type of a NodeContent event. 1245 1246**Since**: 12 1247 1248 1249### ArkUI_NodeContentHandle 1250 1251``` 1252typedef struct ArkUI_NodeContent* ArkUI_NodeContentHandle 1253``` 1254**Description** 1255 1256Defines the handle to the ArkUI NodeContent instance on the native side. 1257 1258**Since**: 12 1259 1260 1261### ArkUI_NodeCustomEvent 1262 1263``` 1264typedef struct ArkUI_NodeCustomEvent ArkUI_NodeCustomEvent 1265``` 1266**Description** 1267 1268Defines the common structure of a custom component event. 1269 1270**Since**: 12 1271 1272 1273### ArkUI_NodeEvent [1/2] 1274 1275``` 1276typedef struct ArkUI_NodeEvent ArkUI_NodeEvent 1277``` 1278**Description** 1279 1280Defines a struct for a component event. 1281 1282**Since**: 12 1283 1284 1285### ArkUI_NodeEvent [2/2] 1286 1287``` 1288typedef struct ArkUI_NodeEventArkUI_NodeEvent 1289``` 1290**Description** 1291 1292Defines the common structure of a component event. 1293 1294**Since**: 12 1295 1296 1297### ArkUI_NodeHandle 1298 1299``` 1300typedef struct ArkUI_Node* ArkUI_NodeHandle 1301``` 1302**Description** 1303 1304Defines the pointer to the ArkUI native component object. 1305 1306**Since**: 12 1307 1308 1309### ArkUI_OnWillDismissEvent 1310 1311``` 1312typedef bool(* ArkUI_OnWillDismissEvent) (int32_t reason) 1313``` 1314**Description** 1315 1316Defines a pointer to the callback invoked when the dialog box is closed. 1317 1318**Since**: 12 1319 1320 1321### ArkUI_ParallelInnerGestureEvent 1322 1323``` 1324typedef struct ArkUI_ParallelInnerGestureEvent ArkUI_ParallelInnerGestureEvent 1325``` 1326**Description** 1327 1328Defines a parallel internal gesture event. 1329 1330**Since**: 12 1331 1332 1333### ArkUI_StyledString 1334 1335``` 1336typedef struct ArkUI_StyledString ArkUI_StyledString 1337``` 1338**Description** 1339 1340Defines a struct for the styled string object supported by the text component. 1341 1342**Since**: 12 1343 1344 1345### ArkUI_StyledString_Descriptor 1346 1347``` 1348typedef struct ArkUI_StyledString_Descriptor ArkUI_StyledString_Descriptor 1349``` 1350**Description** 1351 1352Defines a struct for the styled string descriptor object supported by the text component. 1353 1354**Since**: 14 1355 1356 1357### ArkUI_SwiperIndicator 1358 1359``` 1360typedef struct ArkUI_SwiperIndicator ArkUI_SwiperIndicator 1361``` 1362**Description** 1363 1364Defines the navigation point indicator style of the **Swiper** component. 1365 1366**Since**: 12 1367 1368 1369### ArkUI_SystemFontStyleEvent 1370 1371``` 1372typedef struct ArkUI_SystemFontStyleEvent ArkUI_SystemFontStyleEvent 1373``` 1374**Description** 1375 1376Defines a struct for the system font style event. 1377 1378**Since**: 12 1379 1380 1381### ArkUI_TransitionEffect 1382 1383``` 1384typedef struct ArkUI_TransitionEffect ArkUI_TransitionEffect 1385``` 1386**Description** 1387 1388Defines a struct for the transition effect. 1389 1390**Since**: 12 1391 1392 1393### ArkUI_WaterFlowSectionOption 1394 1395``` 1396typedef struct ArkUI_WaterFlowSectionOption ArkUI_WaterFlowSectionOption 1397``` 1398**Description** 1399 1400Defines the water flow section configuration. 1401 1402**Since**: 12 1403 1404 1405### OH_PixelmapNative 1406 1407``` 1408typedef struct OH_PixelmapNative OH_PixelmapNative 1409``` 1410**Description** 1411 1412Defines the **Pixelmap** struct, which is used to perform operations related to a pixel map. 1413 1414**Since**: 12 1415 1416 1417### OH_PixelmapNativeHandle 1418 1419``` 1420typedef struct OH_PixelmapNative* OH_PixelmapNativeHandle 1421``` 1422**Description** 1423 1424Defines a struct for the pointer to an **OH_PixelmapNative** object. 1425 1426**Since**: 12 1427 1428 1429### OH_UdmfData 1430 1431``` 1432typedef struct OH_UdmfData OH_UdmfData 1433``` 1434**Description** 1435 1436Defines a struct for UDMF unified data. 1437 1438**Since**: 12 1439 1440 1441## Enum Description 1442 1443 1444### ArkUI_AccessibilityActionType 1445 1446``` 1447enum ArkUI_AccessibilityActionType 1448``` 1449**Description** 1450 1451Defines an enum for the accessibility action types. 1452 1453**Since**: 12 1454 1455| Enum| Description| 1456| -------- | -------- | 1457| ARKUI_ACCESSIBILITY_ACTION_CLICK | Tapping. | 1458| ARKUI_ACCESSIBILITY_ACTION_LONG_CLICK | Long press. | 1459| ARKUI_ACCESSIBILITY_ACTION_CUT | Cut. | 1460| ARKUI_ACCESSIBILITY_ACTION_COPY | Copy. | 1461| ARKUI_ACCESSIBILITY_ACTION_PASTE | Paste. | 1462 1463 1464### ArkUI_AccessibilityCheckedState 1465 1466``` 1467enum ArkUI_AccessibilityCheckedState 1468``` 1469**Description** 1470 1471Enumerates the accessibility check box states. 1472 1473**Since**: 12 1474 1475| Enum| Description| 1476| -------- | -------- | 1477| ARKUI_ACCESSIBILITY_UNCHECKED | The check box is not selected. | 1478| ARKUI_ACCESSIBILITY_CHECKED | The check box is selected. | 1479 1480 1481### ArkUI_AccessibilityMode 1482 1483``` 1484enum ArkUI_AccessibilityMode 1485``` 1486**Description** 1487 1488Enumerates the accessibility modes. 1489 1490**Since**: 12 1491 1492| Enum| Description| 1493| -------- | -------- | 1494| ARKUI_ACCESSIBILITY_MODE_AUTO | The mode is automatically set to enabled or disabled based on the component. | 1495| ARKUI_ACCESSIBILITY_MODE_ENABLED | The component can be identified by the accessibility service. | 1496| ARKUI_ACCESSIBILITY_MODE_DISABLED | The component cannot be identified by the accessibility service. | 1497| ARKUI_ACCESSIBILITY_MODE_DISABLED_FOR_DESCENDANTS | The component and all its child components cannot be identified by the accessibility service. | 1498 1499 1500### ArkUI_AdaptiveColor 1501 1502``` 1503enum ArkUI_AdaptiveColor 1504``` 1505**Description** 1506 1507Enumerates the adaptive color modes. 1508 1509**Since**: 12 1510 1511| Enum| Description| 1512| -------- | -------- | 1513| ARKUI_ADAPTIVE_COLOR_DEFAULT | Adaptive color mode is not used. | 1514| ARKUI_ADAPTIVE_COLOR_AVERAGE | Adaptive color mode is used. | 1515 1516 1517### ArkUI_Alignment 1518 1519``` 1520enum ArkUI_Alignment 1521``` 1522**Description** 1523 1524Enumerates the alignment modes. 1525 1526**Since**: 12 1527 1528| Enum| Description| 1529| -------- | -------- | 1530| ARKUI_ALIGNMENT_TOP_START | Top start. | 1531| ARKUI_ALIGNMENT_TOP | Top center. | 1532| ARKUI_ALIGNMENT_TOP_END | Top end. | 1533| ARKUI_ALIGNMENT_START | Vertically centered start. | 1534| ARKUI_ALIGNMENT_CENTER | Horizontally and vertically centered. | 1535| ARKUI_ALIGNMENT_END | Vertically centered end. | 1536| ARKUI_ALIGNMENT_BOTTOM_START | Bottom start. | 1537| ARKUI_ALIGNMENT_BOTTOM | Horizontally centered on the bottom. | 1538| ARKUI_ALIGNMENT_BOTTOM_END | Bottom end. | 1539 1540 1541### ArkUI_AnimationCurve 1542 1543``` 1544enum ArkUI_AnimationCurve 1545``` 1546**Description** 1547 1548Enumerates the animation curves. 1549 1550**Since**: 12 1551 1552| Enum| Description| 1553| -------- | -------- | 1554| ARKUI_CURVE_LINEAR | The animation speed keeps unchanged. | 1555| ARKUI_CURVE_EASE | The animation starts slowly, accelerates, and then slows down towards the end. | 1556| ARKUI_CURVE_EASE_IN | The animation starts at a low speed and then picks up speed until the end. | 1557| ARKUI_CURVE_EASE_OUT | The animation ends at a low speed. | 1558| ARKUI_CURVE_EASE_IN_OUT | The animation starts and ends at a low speed. | 1559| ARKUI_CURVE_FAST_OUT_SLOW_IN | The animation uses the standard curve | 1560| ARKUI_CURVE_LINEAR_OUT_SLOW_IN | The animation uses the deceleration curve. | 1561| ARKUI_CURVE_FAST_OUT_LINEAR_IN | The animation uses the acceleration curve. | 1562| ARKUI_CURVE_EXTREME_DECELERATION | The animation uses the extreme deceleration curve. | 1563| ARKUI_CURVE_SHARP | The animation uses the sharp curve. | 1564| ARKUI_CURVE_RHYTHM | The animation uses the rhythm curve. | 1565| ARKUI_CURVE_SMOOTH | The animation uses the smooth curve. | 1566| ARKUI_CURVE_FRICTION | The animation uses the friction curve | 1567 1568 1569### ArkUI_AnimationDirection 1570 1571``` 1572enum ArkUI_AnimationDirection 1573``` 1574**Description** 1575 1576Enumerates the animation playback modes. 1577 1578**Since**: 12 1579 1580| Enum| Description| 1581| -------- | -------- | 1582| ARKUI_ANIMATION_DIRECTION_NORMAL | The animation plays in forward loop mode. | 1583| ARKUI_ANIMATION_DIRECTION_REVERSE | The animation plays in reverse loop mode. | 1584| 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. | 1585| 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. | 1586 1587 1588### ArkUI_AnimationFill 1589 1590``` 1591enum ArkUI_AnimationFill 1592``` 1593**Description** 1594 1595Enumerates the state of the animated target after the animation is executed. 1596 1597**Since**: 12 1598 1599| Enum| Description| 1600| -------- | -------- | 1601| ARKUI_ANIMATION_FILL_NONE | No style is applied to the target before or after the animation is executed. | 1602| 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. | 1603| ARKUI_ANIMATION_FILL_BACKWARDS | The animation uses the value defined in the first key frame during the duration defined by **animation-delay**. | 1604| ARKUI_ANIMATION_FILL_BOTH | The animation follows the **forwards** and **backwards** rules. | 1605 1606 1607### ArkUI_AnimationFillMode 1608 1609``` 1610enum ArkUI_AnimationFillMode 1611``` 1612**Description** 1613 1614Enumerates the states before and after execution of the frame-by-frame animation. 1615 1616**Since**: 12 1617 1618| Enum| Description| 1619| -------- | -------- | 1620| 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. | 1621| ARKUI_ANIMATION_FILL_MODE_FORWARDS | The target component retains the state set by the last keyframe encountered during execution of the animation. | 1622| 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**. | 1623| ARKUI_ANIMATION_FILL_MODE_BOTH | The animation follows the rules for both **Forwards** and **Backwards**, extending the animation attributes in both directions. | 1624 1625 1626### ArkUI_AnimationPlayMode 1627 1628``` 1629enum ArkUI_AnimationPlayMode 1630``` 1631**Description** 1632 1633Enumerates the animation playback modes. 1634 1635**Since**: 12 1636 1637| Enum| Description| 1638| -------- | -------- | 1639| ARKUI_ANIMATION_PLAY_MODE_NORMAL | The animation is played forwards. | 1640| ARKUI_ANIMATION_PLAY_MODE_REVERSE | The animation is played backwards. | 1641| 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...). | 1642| 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...). | 1643 1644 1645### ArkUI_AnimationStatus 1646 1647``` 1648enum ArkUI_AnimationStatus 1649``` 1650**Description** 1651 1652Enumerates the playback states of the frame-by-frame animation. 1653 1654**Since**: 12 1655 1656| Enum| Description| 1657| -------- | -------- | 1658| ARKUI_ANIMATION_STATUS_INITIAL | The animation is in the initial state. | 1659| ARKUI_ANIMATION_STATUS_RUNNING | The animation is being played. | 1660| ARKUI_ANIMATION_STATUS_PAUSED | The animation is paused. | 1661| ARKUI_ANIMATION_STATUS_STOPPED | The animation is stopped. | 1662 1663 1664### ArkUI_Axis 1665 1666``` 1667enum ArkUI_Axis 1668``` 1669**Description** 1670 1671Enumerates the scroll directions. 1672 1673**Since**: 12 1674 1675| Enum| Description| 1676| -------- | -------- | 1677| ARKUI_AXIS_VERTICAL | Only vertical scrolling is supported. | 1678| ARKUI_AXIS_HORIZONTAL | Only horizontal scrolling is supported. | 1679 1680 1681### ArkUI_BarrierDirection 1682 1683``` 1684enum ArkUI_BarrierDirection 1685``` 1686**Description** 1687 1688Enumerates the barrier directions. 1689 1690**Since**: 12 1691 1692| Enum| Description| 1693| -------- | -------- | 1694| ARKUI_BARRIER_DIRECTION_START | The barrier is on the left side of all the referenced components specified by referencedId. | 1695| ARKUI_BARRIER_DIRECTION_END | The barrier is on the right side of all the referenced components specified by referencedId. | 1696| ARKUI_BARRIER_DIRECTION_TOP | The barrier is at the top of all the referenced components specified by referencedId. | 1697| ARKUI_BARRIER_DIRECTION_BOTTOM | The barrier is at the bottom of all the referenced components specified by referencedId. | 1698 1699 1700### ArkUI_BlendApplyType 1701 1702``` 1703enum ArkUI_BlendApplyType 1704``` 1705**Description** 1706 1707Defines how the specified blend mode is applied. 1708 1709**Since**: 12 1710 1711| Enum| Description| 1712| -------- | -------- | 1713| BLEND_APPLY_TYPE_FAST | The content of the view is blended in sequence on the target image. | 1714| 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. | 1715 1716 1717### ArkUI_BlendMode 1718 1719``` 1720enum ArkUI_BlendMode 1721``` 1722**Description** 1723 1724Enumerates the blend modes. 1725 1726**Since**: 12 1727 1728| Enum| Description| 1729| -------- | -------- | 1730| ARKUI_BLEND_MODE_NONE | The top image is superimposed on the bottom image without any blending. | 1731| ARKUI_BLEND_MODE_CLEAR | The target pixels covered by the source pixels are erased by being turned to completely transparent. | 1732| ARKUI_BLEND_MODE_SRC | r = s: Only the source pixels are displayed. | 1733| ARKUI_BLEND_MODE_DST | r = d: Only the target pixels are displayed. | 1734| ARKUI_BLEND_MODE_SRC_OVER | r = s + (1 - sa) \d: The source pixels are blended based on opacity and cover the target pixels. | 1735| ARKUI_BLEND_MODE_DST_OVER | r = d + (1 - da) *\ s: The target pixels are blended based on opacity and cover on the source pixels. | 1736| ARKUI_BLEND_MODE_SRC_IN | r = s \* da: Only the part of the source pixels that overlap with the target pixels is displayed. | 1737| ARKUI_BLEND_MODE_DST_IN | r = d \* sa: Only the part of the target pixels that overlap with the source pixels is displayed. | 1738| 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. | 1739| 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. | 1740| 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. | 1741| 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. | 1742| 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. | 1743| ARKUI_BLEND_MODE_PLUS | r = min(s + d, 1): New pixels resulting from adding the source pixels to the target pixels are displayed. | 1744| ARKUI_BLEND_MODE_MODULATE | r = s \* d: New pixels resulting from multiplying the source pixels with the target pixels are displayed. | 1745| 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. | 1746| ARKUI_BLEND_MODE_OVERLAY | The MULTIPLY or SCREEN mode is used based on the target pixels. | 1747| ARKUI_BLEND_MODE_DARKEN | rc = s + d - max(s \da, d \sa), ra = kSrcOver: When two colors overlap, whichever is darker is used. | 1748| ARKUI_BLEND_MODE_LIGHTEN | rc = s + d - min(s \da, d \sa), ra = kSrcOver: The darker of the pixels (source and target) is used. | 1749| ARKUI_BLEND_MODE_COLOR_DODGE | The colors of the target pixels are lightened to reflect the source pixels. | 1750| ARKUI_BLEND_MODE_COLOR_BURN | The colors of the target pixels are darkened to reflect the source pixels. | 1751| ARKUI_BLEND_MODE_HARD_LIGHT | The MULTIPLY or SCREEN mode is used, depending on the source pixels. | 1752| ARKUI_BLEND_MODE_SOFT_LIGHT | The LIGHTEN or DARKEN mode is used, depending on the source pixels. | 1753| 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. | 1754| ARKUI_BLEND_MODE_EXCLUSION | rc = s + d - two(s \* d), ra = kSrcOver: The final pixel is similar to **DIFFERENCE**, but with less contrast. | 1755| 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.| 1756| 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. | 1757| 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. | 1758| 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. | 1759| 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. | 1760 1761 1762### ArkUI_BlurStyle 1763 1764``` 1765enum ArkUI_BlurStyle 1766``` 1767**Description** 1768 1769Enumerates the blur styles. 1770 1771**Since**: 12 1772 1773| Enum| Description| 1774| -------- | -------- | 1775| ARKUI_BLUR_STYLE_THIN | Thin material. | 1776| ARKUI_BLUR_STYLE_REGULAR | Regular material. | 1777| ARKUI_BLUR_STYLE_THICK | Thick material. | 1778| ARKUI_BLUR_STYLE_BACKGROUND_THIN | Material that creates the minimum depth of field effect. | 1779| ARKUI_BLUR_STYLE_BACKGROUND_REGULAR | Material that creates a medium shallow depth of field effect. | 1780| ARKUI_BLUR_STYLE_BACKGROUND_THICK | Material that creates a high shallow depth of field effect. | 1781| ARKUI_BLUR_STYLE_BACKGROUND_ULTRA_THICK | Material that creates the maximum depth of field effect. | 1782| ARKUI_BLUR_STYLE_NONE | No blur. | 1783| ARKUI_BLUR_STYLE_COMPONENT_ULTRA_THIN | Component ultra-thin material. | 1784| ARKUI_BLUR_STYLE_COMPONENT_THIN | Component thin material. | 1785| ARKUI_BLUR_STYLE_COMPONENT_REGULAR | Component regular material. | 1786| ARKUI_BLUR_STYLE_COMPONENT_THICK | Component thick material. | 1787| ARKUI_BLUR_STYLE_COMPONENT_ULTRA_THICK | Component ultra-thick material. | 1788 1789 1790### ArkUI_BorderStyle 1791 1792``` 1793enum ArkUI_BorderStyle 1794``` 1795**Description** 1796 1797Enumerates the border styles. 1798 1799**Since**: 12 1800 1801| Enum| Description| 1802| -------- | -------- | 1803| ARKUI_BORDER_STYLE_SOLID | Solid border. | 1804| ARKUI_BORDER_STYLE_DASHED | Dashed border. | 1805| ARKUI_BORDER_STYLE_DOTTED | Dotted border. | 1806 1807 1808### ArkUI_ButtonType 1809 1810``` 1811enum ArkUI_ButtonType 1812``` 1813**Description** 1814 1815Enumerates the button types. 1816 1817**Since**: 12 1818 1819| Enum| Description| 1820| -------- | -------- | 1821| ARKUI_BUTTON_TYPE_NORMAL | Normal button (without rounded corners by default). | 1822| ARKUI_BUTTON_TYPE_CAPSULE | Capsule-type button (the round corner is half of the height by default). | 1823| ARKUI_BUTTON_TYPE_CIRCLE | Circle button. | 1824 1825 1826### ArkUI_CalendarAlignment 1827 1828``` 1829enum ArkUI_CalendarAlignment 1830``` 1831**Description** 1832 1833Enumerates the alignment modes between the calendar picker and the entry component. 1834 1835**Since**: 12 1836 1837| Enum| Description| 1838| -------- | -------- | 1839| ARKUI_CALENDAR_ALIGNMENT_START | Left aligned. | 1840| ARKUI_CALENDAR_ALIGNMENT_CENTER | Center aligned. | 1841| ARKUI_CALENDAR_ALIGNMENT_END | Right aligned. | 1842 1843 1844### ArkUI_CancelButtonStyle 1845 1846``` 1847enum ArkUI_CancelButtonStyle 1848``` 1849**Description** 1850 1851Enumerates the styles of the Cancel button. 1852 1853**Since**: 12 1854 1855| Enum| Description| 1856| -------- | -------- | 1857| ARKUI_CANCELBUTTON_STYLE_CONSTANT | The Cancel button is always displayed. | 1858| ARKUI_CANCELBUTTON_STYLE_INVISIBLE | The Cancel button is always hidden. | 1859| ARKUI_CANCELBUTTON_STYLE_INPUT | The Cancel button is displayed when there is text input. | 1860 1861 1862### ArkUI_CheckboxShape 1863 1864``` 1865enum ArkUI_CheckboxShape 1866``` 1867**Description** 1868 1869Enumerates the shapes of the check box. 1870 1871**Since**: 12 1872 1873| Enum| Description| 1874| -------- | -------- | 1875| ArkUI_CHECKBOX_SHAPE_CIRCLE | Circle. | 1876| ArkUI_CHECKBOX_SHAPE_ROUNDED_SQUARE | Rounded square. | 1877 1878 1879### ArkUI_ClipType 1880 1881``` 1882enum ArkUI_ClipType 1883``` 1884**Description** 1885 1886Enumerates the clipping region types. 1887 1888**Since**: 12 1889 1890| Enum| Description| 1891| -------- | -------- | 1892| ARKUI_CLIP_TYPE_RECTANGLE | Rectangle. | 1893| ARKUI_CLIP_TYPE_CIRCLE | **(circle)** | 1894| ARKUI_CLIP_TYPE_ELLIPSE | Ellipse. | 1895| ARKUI_CLIP_TYPE_PATH | Path Type | 1896 1897 1898### ArkUI_ColorMode 1899 1900``` 1901enum ArkUI_ColorMode 1902``` 1903**Description** 1904 1905Enumerates the color modes. 1906 1907**Since**: 12 1908 1909| Enum| Description| 1910| -------- | -------- | 1911| ARKUI_COLOR_MODE_SYSTEM | Following the system color mode. | 1912| ARKUI_COLOR_MODE_LIGHT | Light color mode. | 1913| ARKUI_COLOR_MODE_DARK | Dark color mode. | 1914 1915 1916### ArkUI_ColorStrategy 1917 1918``` 1919enum ArkUI_ColorStrategy 1920``` 1921**Description** 1922 1923Enumerates the foreground colors. 1924 1925**Since**: 12 1926 1927| Enum| Description| 1928| -------- | -------- | 1929| ARKUI_COLOR_STRATEGY_INVERT | The foreground colors are the inverse of the component background colors. | 1930| ARKUI_COLOR_STRATEGY_AVERAGE | The shadow colors of the component are the average color obtained from the component background shadow area. | 1931| ARKUI_COLOR_STRATEGY_PRIMARY | The shadow colors of the component are the primary color obtained from the component background shadow area. | 1932 1933 1934### ArkUI_CopyOptions 1935 1936``` 1937enum ArkUI_CopyOptions 1938``` 1939**Description** 1940 1941Enumerates the text copy and paste modes. 1942 1943**Since**: 12 1944 1945| Enum| Description| 1946| -------- | -------- | 1947| ARKUI_COPY_OPTIONS_NONE | Copy is not allowed. | 1948| ARKUI_COPY_OPTIONS_IN_APP | Intra-application copy is allowed. | 1949| ARKUI_COPY_OPTIONS_LOCAL_DEVICE | Intra-device copy is allowed. | 1950| ARKUI_COPY_OPTIONS_CROSS_DEVICE | Cross-device copy is allowed. | 1951 1952 1953### ArkUI_Direction 1954 1955``` 1956enum ArkUI_Direction 1957``` 1958**Description** 1959 1960Enumerates the modes in which components are laid out along the main axis of the container. 1961 1962**Since**: 12 1963 1964| Enum| Description| 1965| -------- | -------- | 1966| ARKUI_DIRECTION_LTR | Components are arranged from left to right. | 1967| ARKUI_DIRECTION_RTL | Components are arranged from right to left. | 1968| ARKUI_DIRECTION_AUTO | The default layout direction is used. | 1969 1970 1971### ArkUI_DismissReason 1972 1973``` 1974enum ArkUI_DismissReason 1975``` 1976**Description** 1977 1978Enumerates the actions for triggering closure of the dialog box. 1979 1980**Since**: 12 1981 1982| Enum| Description| 1983| -------- | -------- | 1984| DIALOG_DISMISS_BACK_PRESS | Touching the system-defined Back button or pressing the Esc key. | 1985| DIALOG_DISMISS_TOUCH_OUTSIDE | Touching the mask. | 1986| DIALOG_DISMISS_CLOSE_BUTTON | Touching the Close button. | 1987| DIALOG_DISMISS_SLIDE_DOWN | Sliding down. | 1988 1989 1990### ArkUI_DragPreviewScaleMode 1991 1992``` 1993enum ArkUI_DragPreviewScaleMode 1994``` 1995**Description** 1996 1997Defines an enum for drag preview scale modes. 1998 1999**Since**: 12 2000 2001| Enum| Description| 2002| -------- | -------- | 2003| 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. | 2004| ARKUI_DRAG_PREVIEW_SCALE_DISABLED | The system does not scale the drag preview. | 2005 2006 2007### ArkUI_DragResult 2008 2009``` 2010enum ArkUI_DragResult 2011``` 2012**Description** 2013 2014Defines 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. 2015 2016**Since**: 12 2017 2018| Enum| Description| 2019| -------- | -------- | 2020| ARKUI_DRAG_RESULT_SUCCESSFUL | The drag and drop operation succeeded. | 2021| ARKUI_DRAG_RESULT_FAILED | The drag and drop operation failed. | 2022| ARKUI_DRAG_RESULT_CANCELED | The drag and drop operation was canceled. | 2023 2024 2025### ArkUI_DragStatus 2026 2027``` 2028enum ArkUI_DragStatus 2029``` 2030**Description** 2031 2032Enumerates dragging states. 2033 2034**Since**: 12 2035 2036| Enum| Description| 2037| -------- | -------- | 2038| ArkUI_DRAG_STATUS_UNKNOWN | Unknown. | 2039| ArkUI_DRAG_STATUS_STARTED | Started. | 2040| ArkUI_DRAG_STATUS_ENDED | Ended. | 2041 2042 2043### ArkUI_DropProposal 2044 2045``` 2046enum ArkUI_DropProposal 2047``` 2048**Description** 2049 2050Defines an enum for data processing modes used when data is dropped, which affects the display of the badge. 2051 2052**Since**: 12 2053 2054| Enum| Description| 2055| -------- | -------- | 2056| ARKUI_DROP_PROPOSAL_COPY | Copy. | 2057| ARKUI_DROP_PROPOSAL_MOVE | Cut. | 2058 2059 2060### ArkUI_EdgeEffect 2061 2062``` 2063enum ArkUI_EdgeEffect 2064``` 2065**Description** 2066 2067Enumerates the effects used at the edges of the component when the boundary of the scrollable content is reached. 2068 2069**Since**: 12 2070 2071| Enum| Description| 2072| -------- | -------- | 2073| 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. | 2074| ARKUI_EDGE_EFFECT_FADE | Fade effect. When at one of the edges, the component produces a fade effect. | 2075| ARKUI_EDGE_EFFECT_NONE | No effect when the component is at one of the edges. | 2076 2077 2078### ArkUI_EffectEdge 2079 2080``` 2081enum ArkUI_EffectEdge 2082``` 2083**Description** 2084 2085Enumerates the edges for which the effect takes effect when the boundary of the scrollable content is reached. 2086 2087**Since**: 17 2088 2089| Enum| Description| 2090| -------- | -------- | 2091| ARKUI_EFFECT_EDGE_START | Start edge. | 2092| ARKUI_EFFECT_EDGE_END | End edge. | 2093 2094 2095### ArkUI_EllipsisMode 2096 2097``` 2098enum ArkUI_EllipsisMode 2099``` 2100**Description** 2101 2102Enumerates the ellipsis positions. 2103 2104**Since**: 12 2105 2106| Enum| Description| 2107| -------- | -------- | 2108| ARKUI_ELLIPSIS_MODE_START | An ellipsis is used at the start of the line of text. | 2109| ARKUI_ELLIPSIS_MODE_CENTER | An ellipsis is used at the center of the line of text. | 2110| ARKUI_ELLIPSIS_MODE_END | An ellipsis is used at the end of the line of text. | 2111 2112 2113### ArkUI_EnterKeyType 2114 2115``` 2116enum ArkUI_EnterKeyType 2117``` 2118**Description** 2119 2120Enumerates the types of the Enter key for a single-line text box. 2121 2122**Since**: 12 2123 2124| Enum| Description| 2125| -------- | -------- | 2126| ARKUI_ENTER_KEY_TYPE_GO | The Enter key is labeled "Go." | 2127| ARKUI_ENTER_KEY_TYPE_SEARCH | The Enter key is labeled "Search." | 2128| ARKUI_ENTER_KEY_TYPE_SEND | The Enter key is labeled "Send." | 2129| ARKUI_ENTER_KEY_TYPE_NEXT | The Enter key is labeled "Next." | 2130| ARKUI_ENTER_KEY_TYPE_DONE | The Enter key is labeled "Done." | 2131| ARKUI_ENTER_KEY_TYPE_PREVIOUS | The Enter key is labeled "Previous." | 2132| ARKUI_ENTER_KEY_TYPE_NEW_LINE | The Enter key is labeled "Return." | 2133 2134 2135### ArkUI_ErrorCode 2136 2137``` 2138enum ArkUI_ErrorCode 2139``` 2140**Description** 2141 2142Defines an enum for the error codes. 2143 2144**Since**: 12 2145 2146| Enum| Description| 2147| -------- | -------- | 2148| ARKUI_ERROR_CODE_NO_ERROR | No error. | 2149| ARKUI_ERROR_CODE_PARAM_INVALID | Parameter error. | 2150| ARKUI_ERROR_CODE_ATTRIBUTE_OR_EVENT_NOT_SUPPORTED | The component does not support specific attributes or events. | 2151| ARKUI_ERROR_CODE_NOT_SUPPROTED_FOR_ARKTS_NODE | The specific operation is not allowed on the node created by ArkTS. | 2152| ARKUI_ERROR_CODE_NODE_ADAPTER_NONE_HOST | The adapter for lazy loading is not bound to the component. | 2153| ARKUI_ERROR_CODE_NODE_ADAPTER_EXIST_IN_HOST | The adapter already exists. | 2154| ARKUI_ERROR_CODE_NODE_ADAPTER_CHILD_NODE_EXIST | Failed to add the adapter because the corresponding node already has a subnode. | 2155| ARKUI_ERROR_CODE_NODE_EVENT_PARAM_INDEX_OUT_OF_RANGE | The parameter length in the parameter event exceeds the limit. | 2156| ARKUI_ERROR_CODE_NODE_EVENT_PARAM_INVALID | The data does not exist in the component event. | 2157| ARKUI_ERROR_CODE_NODE_EVENT_NO_RETURN | The component event does not support return values. | 2158| ARKUI_ERROR_CODE_NODE_INDEX_INVALID | Invalid index. | 2159| ARKUI_ERROR_CODE_GET_INFO_FAILED | Failed to obtain the route navigation information. | 2160| ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR | Buffer size error. | 2161| ARKUI_ERROR_CODE_NON_SCROLLABLE_CONTAINER | The component is not a scrollable container. | 2162| ARKUI_ERROR_CODE_BUFFER_SIZE_NOT_ENOUGH | The buffer is not large enough. | 2163| ARKUI_ERROR_CODE_INVALID_STYLED_STRING | Invalid styled string. | 2164 2165 2166### ArkUI_FinishCallbackType 2167 2168``` 2169enum ArkUI_FinishCallbackType 2170``` 2171**Description** 2172 2173Enumerates the animation **onFinish** callback types. 2174 2175**Since**: 12 2176 2177| Enum| Description| 2178| -------- | -------- | 2179| ARKUI_FINISH_CALLBACK_REMOVED | The callback is invoked when the entire animation is removed once it has finished. | 2180| 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. | 2181 2182 2183### ArkUI_FlexAlignment 2184 2185``` 2186enum ArkUI_FlexAlignment 2187``` 2188**Description** 2189 2190Enumerates the vertical alignment modes. 2191 2192**Since**: 12 2193 2194| Enum| Description| 2195| -------- | -------- | 2196| ARKUI_FLEX_ALIGNMENT_START | The child components are aligned with the start edge of the main axis. | 2197| ARKUI_FLEX_ALIGNMENT_CENTER | The child components are aligned in the center of the main axis. | 2198| ARKUI_FLEX_ALIGNMENT_END | The child components are aligned with the end edge of the main axis. | 2199| 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. | 2200| 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. | 2201| 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. | 2202 2203 2204### ArkUI_FlexDirection 2205 2206``` 2207enum ArkUI_FlexDirection 2208``` 2209**Description** 2210 2211Enumerates the directions of the main axis in the flex container. 2212 2213**Since**: 12 2214 2215| Enum| Description| 2216| -------- | -------- | 2217| ARKUI_FLEX_DIRECTION_ROW | The child components are arranged in the same direction as the main axis runs along the rows. | 2218| ARKUI_FLEX_DIRECTION_COLUMN | The child components are arranged in the same direction as the main axis runs down the columns. | 2219| ARKUI_FLEX_DIRECTION_ROW_REVERSE | The child components are arranged opposite to the **ROW** direction. | 2220| ARKUI_FLEX_DIRECTION_COLUMN_REVERSE | The child components are arranged opposite to the **COLUMN** direction. | 2221 2222 2223### ArkUI_FlexWrap 2224 2225``` 2226enum ArkUI_FlexWrap 2227``` 2228**Description** 2229 2230Defines whether the flex container has a single line or multiple lines. 2231 2232**Since**: 12 2233 2234| Enum| Description| 2235| -------- | -------- | 2236| ARKUI_FLEX_WRAP_NO_WRAP | The child components in the flex container are arranged in a single line, and they cannot overflow. | 2237| ARKUI_FLEX_WRAP_WRAP | The child components in the flex container are arranged in multiple lines, and they may overflow. | 2238| ARKUI_FLEX_WRAP_WRAP_REVERSE | The child components in the flex container are reversely arranged in multiple lines, and they may overflow. | 2239 2240 2241### ArkUI_FontStyle 2242 2243``` 2244enum ArkUI_FontStyle 2245``` 2246**Description** 2247 2248Enumerates the font styles. 2249 2250**Since**: 12 2251 2252| Enum| Description| 2253| -------- | -------- | 2254| ARKUI_FONT_STYLE_NORMAL | Standard font style. | 2255| ARKUI_FONT_STYLE_ITALIC | Italic font style. | 2256 2257 2258### ArkUI_FontWeight 2259 2260``` 2261enum ArkUI_FontWeight 2262``` 2263**Description** 2264 2265Enumerates the font weights. 2266 2267**Since**: 12 2268 2269| Enum| Description| 2270| -------- | -------- | 2271| ARKUI_FONT_WEIGHT_W100 | 100 | 2272| ARKUI_FONT_WEIGHT_W200 | 200 | 2273| ARKUI_FONT_WEIGHT_W300 | 300 | 2274| ARKUI_FONT_WEIGHT_W400 | 400 | 2275| ARKUI_FONT_WEIGHT_W500 | 500 | 2276| ARKUI_FONT_WEIGHT_W600 | 600 | 2277| ARKUI_FONT_WEIGHT_W700 | 700 | 2278| ARKUI_FONT_WEIGHT_W800 | 800 | 2279| ARKUI_FONT_WEIGHT_W900 | 900 | 2280| ARKUI_FONT_WEIGHT_BOLD | The font weight is bold. | 2281| ARKUI_FONT_WEIGHT_NORMAL | The font weight is normal. | 2282| ARKUI_FONT_WEIGHT_BOLDER | The font weight is bolder. | 2283| ARKUI_FONT_WEIGHT_LIGHTER | The font weight is lighter. | 2284| ARKUI_FONT_WEIGHT_MEDIUM | The font weight is medium. | 2285| ARKUI_FONT_WEIGHT_REGULAR | The font weight is normal. | 2286 2287### ArkUI_GestureDirection 2288 2289``` 2290enum ArkUI_GestureDirection 2291``` 2292**Description** 2293 2294Enumerates gesture directions. 2295 2296**Since**: 12 2297 2298| Enum| Description| 2299| -------- | -------- | 2300| GESTURE_DIRECTION_ALL | All directions. | 2301| GESTURE_DIRECTION_HORIZONTAL | Horizontal direction. | 2302| GESTURE_DIRECTION_VERTICAL | Vertical direction. | 2303| GESTURE_DIRECTION_LEFT | Leftward. | 2304| GESTURE_DIRECTION_RIGHT | Rightward. | 2305| GESTURE_DIRECTION_UP | Upward. | 2306| GESTURE_DIRECTION_DOWN | Downward. | 2307| GESTURE_DIRECTION_NONE | None. | 2308 2309 2310### ArkUI_GestureEventActionType 2311 2312``` 2313enum ArkUI_GestureEventActionType 2314``` 2315**Description** 2316 2317Enumerates gesture event types. 2318 2319**Since**: 12 2320 2321| Enum| Description| 2322| -------- | -------- | 2323| GESTURE_EVENT_ACTION_ACCEPT | Triggered. | 2324| GESTURE_EVENT_ACTION_UPDATE | Updated. | 2325| GESTURE_EVENT_ACTION_END | Ended. | 2326| GESTURE_EVENT_ACTION_CANCEL | Canceled. | 2327 2328 2329### ArkUI_GestureInterruptResult 2330 2331``` 2332enum ArkUI_GestureInterruptResult 2333``` 2334**Description** 2335 2336Enumerates gesture interruption results. 2337 2338**Since**: 12 2339 2340| Enum| Description| 2341| -------- | -------- | 2342| GESTURE_INTERRUPT_RESULT_CONTINUE | The gesture recognition process continues. | 2343| GESTURE_INTERRUPT_RESULT_REJECT | The gesture recognition process is paused. | 2344 2345 2346### ArkUI_GestureMask 2347 2348``` 2349enum ArkUI_GestureMask 2350``` 2351**Description** 2352 2353Enumerates gesture masking modes. 2354 2355**Since**: 12 2356 2357| Enum| Description| 2358| -------- | -------- | 2359| NORMAL_GESTURE_MASK | The gestures of child components are enabled and recognized based on the default gesture recognition sequence. | 2360| IGNORE_INTERNAL_GESTURE_MASK | The gestures of child components are disabled, including the built-in gestures. | 2361 2362 2363### ArkUI_GesturePriority 2364 2365``` 2366enum ArkUI_GesturePriority 2367``` 2368**Description** 2369 2370Enumerates gesture event modes. 2371 2372**Since**: 12 2373 2374| Enum| Description| 2375| -------- | -------- | 2376| NORMAL | Normal. | 2377| PRIORITY | High-priority. | 2378| PARALLEL | Parallel. | 2379 2380 2381### ArkUI_GestureRecognizerState 2382 2383``` 2384enum ArkUI_GestureRecognizerState 2385``` 2386**Description** 2387 2388Enumerates the gesture recognizer states. 2389 2390**Since**: 12 2391 2392| Enum| Description| 2393| -------- | -------- | 2394| ARKUI_GESTURE_RECOGNIZER_STATE_REDAY | Prepared. | 2395| ARKUI_GESTURE_RECOGNIZER_STATE_DETECTING | Check status. | 2396| ARKUI_GESTURE_RECOGNIZER_STATE_PENDING | Waiting | 2397| ARKUI_GESTURE_RECOGNIZER_STATE_BLOCKED | Blocked. | 2398| ARKUI_GESTURE_RECOGNIZER_STATE_SUCCESSFUL | (Success status) | 2399| ARKUI_GESTURE_RECOGNIZER_STATE_FAILED | Failed. | 2400 2401 2402### ArkUI_GestureRecognizerType 2403 2404``` 2405enum ArkUI_GestureRecognizerType 2406``` 2407**Description** 2408 2409Enumerates gesture recognizer types. 2410 2411**Since**: 12 2412 2413| Enum| Description| 2414| -------- | -------- | 2415| TAP_GESTURE | Tap. | 2416| LONG_PRESS_GESTURE | Long press gesture. | 2417| PAN_GESTURE | Pan gesture. | 2418| PINCH_GESTURE | Pinch gesture. | 2419| ROTATION_GESTURE | Rotation gesture. | 2420| SWIPE_GESTURE | Swipe gesture. | 2421| GROUP_GESTURE | A group of gestures. | 2422 2423 2424### ArkUI_GroupGestureMode 2425 2426``` 2427enum ArkUI_GroupGestureMode 2428``` 2429**Description** 2430 2431Enumerates gesture group modes. 2432 2433**Since**: 12 2434 2435| Enum| Description| 2436| -------- | -------- | 2437| 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. | 2438| 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. | 2439| EXCLUSIVE_GROUP | Exclusive recognition. Registered gestures are identified concurrently. If one gesture is successfully recognized, gesture recognition ends. | 2440 2441 2442### ArkUI_HitTestMode 2443 2444``` 2445enum ArkUI_HitTestMode 2446``` 2447**Description** 2448 2449Enumerates the hit test modes. 2450 2451**Since**: 12 2452 2453| Enum| Description| 2454| -------- | -------- | 2455| 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. | 2456| 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. | 2457| 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. | 2458| ARKUI_HIT_TEST_MODE_NONE | The node does not respond to the hit test of a touch event. | 2459 2460 2461### ArkUI_HorizontalAlignment 2462 2463``` 2464enum ArkUI_HorizontalAlignment 2465``` 2466**Description** 2467 2468Enumerates the alignment mode in the horizontal direction. 2469 2470**Since**: 12 2471 2472| Enum| Description| 2473| -------- | -------- | 2474| ARKUI_HORIZONTAL_ALIGNMENT_START | Aligned with the start edge in the same direction as the language in use. | 2475| ARKUI_HORIZONTAL_ALIGNMENT_CENTER | Aligned with the center. This is the default alignment mode. | 2476| ARKUI_HORIZONTAL_ALIGNMENT_END | Aligned with the end edge in the same direction as the language in use. | 2477 2478 2479### ArkUI_ImageInterpolation 2480 2481``` 2482enum ArkUI_ImageInterpolation 2483``` 2484**Description** 2485 2486Enumerates the image interpolation effects. 2487 2488**Since**: 12 2489 2490| Enum| Description| 2491| -------- | -------- | 2492| ARKUI_IMAGE_INTERPOLATION_NONE | No image interpolation. | 2493| ARKUI_IMAGE_INTERPOLATION_LOW | Low quality interpolation. | 2494| ARKUI_IMAGE_INTERPOLATION_MEDIUM | Medium quality interpolation. | 2495| ARKUI_IMAGE_INTERPOLATION_HIGH | High quality interpolation. This mode produces scaled images of the highest possible quality. | 2496 2497 2498### ArkUI_ImageRenderMode 2499 2500``` 2501enum ArkUI_ImageRenderMode 2502``` 2503**Description** 2504 2505Enumerates the image rendering modes. 2506 2507**Since**: 12 2508 2509| Enum| Description| 2510| -------- | -------- | 2511| ARKUI_IMAGE_RENDER_MODE_ORIGINAL | Render image pixels as they are in the original source image. | 2512| ARKUI_IMAGE_RENDER_MODE_TEMPLATE | Render image pixels to create a monochrome template image. | 2513 2514 2515### ArkUI_ImageRepeat 2516 2517``` 2518enum ArkUI_ImageRepeat 2519``` 2520**Description** 2521 2522Enumerates the image repeat patterns. 2523 2524**Since**: 12 2525 2526| Enum| Description| 2527| -------- | -------- | 2528| ARKUI_IMAGE_REPEAT_NONE | The image is not repeatedly drawn. | 2529| ARKUI_IMAGE_REPEAT_X | The image is repeatedly drawn only along the x-axis. | 2530| ARKUI_IMAGE_REPEAT_Y | The image is repeatedly drawn only along the y-axis. | 2531| ARKUI_IMAGE_REPEAT_XY | The image is repeatedly drawn along both axes. | 2532 2533 2534### ArkUI_ImageSize 2535 2536``` 2537enum ArkUI_ImageSize 2538``` 2539**Description** 2540 2541Defines the image size. 2542 2543**Since**: 12 2544 2545| Enum| Description| 2546| -------- | -------- | 2547| ARKUI_IMAGE_SIZE_AUTO | The original image aspect ratio is retained. | 2548| 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. | 2549| ARKUI_IMAGE_SIZE_CONTAIN | The image is scaled with its aspect ratio retained for the content to be completely displayed within the display boundaries. | 2550 2551 2552### ArkUI_ImageSpanAlignment 2553 2554``` 2555enum ArkUI_ImageSpanAlignment 2556``` 2557**Description** 2558 2559Enumerates the alignment mode of the image with the text. 2560 2561**Since**: 12 2562 2563| Enum| Description| 2564| -------- | -------- | 2565| ARKUI_IMAGE_SPAN_ALIGNMENT_BASELINE | The image is bottom aligned with the text baseline. | 2566| ARKUI_IMAGE_SPAN_ALIGNMENT_BOTTOM | The image is bottom aligned with the text. | 2567| ARKUI_IMAGE_SPAN_ALIGNMENT_CENTER | The image is centered aligned with the text. | 2568| ARKUI_IMAGE_SPAN_ALIGNMENT_TOP | The image is top aligned with the text. | 2569 2570 2571### ArkUI_ItemAlignment 2572 2573``` 2574enum ArkUI_ItemAlignment 2575``` 2576**Description** 2577 2578Enumerates the modes in which components are laid out along the cross axis of the container. 2579 2580**Since**: 12 2581 2582| Enum| Description| 2583| -------- | -------- | 2584| ARKUI_ITEM_ALIGNMENT_AUTO | The default configuration of the flex container is used. | 2585| ARKUI_ITEM_ALIGNMENT_START | The items in the flex container are aligned with the cross-start edge. | 2586| ARKUI_ITEM_ALIGNMENT_CENTER | The items in the flex container are centered along the cross axis. | 2587| ARKUI_ITEM_ALIGNMENT_END | The items in the flex container are aligned with the cross-end edge. | 2588| ARKUI_ITEM_ALIGNMENT_STRETCH | The items in the flex container are stretched and padded along the cross axis. | 2589| 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. | 2590 2591 2592### ArkUI_KeyCode 2593 2594``` 2595enum ArkUI_KeyCode 2596``` 2597**Description** 2598 2599Enumerates the key codes for key events. 2600 2601**Since**: 14 2602 2603| Enum| Description| 2604| -------- | -------- | 2605| ARKUI_KEYCODE_UNKNOWN | Unknown key. | 2606| ARKUI_KEYCODE_FN | Function (Fn) key. | 2607| ARKUI_KEYCODE_VOLUME_UP | Volume Up key. | 2608| ARKUI_KEYCODE_VOLUME_DOWN | Volume Down key. | 2609| ARKUI_KEYCODE_POWER | Power key. | 2610| ARKUI_KEYCODE_CAMERA | Camera key. | 2611| ARKUI_KEYCODE_VOLUME_MUTE | Speaker Mute key. | 2612| ARKUI_KEYCODE_MUTE | Mute key. | 2613| ARKUI_KEYCODE_BRIGHTNESS_UP | Brightness Up key. | 2614| ARKUI_KEYCODE_BRIGHTNESS_DOWN | Brightness Down key. | 2615| ARKUI_KEYCODE_0 | Key 0. | 2616| ARKUI_KEYCODE_1 | Key 1. | 2617| ARKUI_KEYCODE_2 | Key 2. | 2618| ARKUI_KEYCODE_3 | Key 3. | 2619| ARKUI_KEYCODE_4 | Key 4. | 2620| ARKUI_KEYCODE_5 | Key 5. | 2621| ARKUI_KEYCODE_6 | Key 6. | 2622| ARKUI_KEYCODE_7 | Key 7. | 2623| ARKUI_KEYCODE_8 | Key 8. | 2624| ARKUI_KEYCODE_9 | Key 9. | 2625| ARKUI_KEYCODE_STAR | Key *. | 2626| ARKUI_KEYCODE_POUND | Key #. | 2627| ARKUI_KEYCODE_DPAD_UP | Up key on D-pad. | 2628| ARKUI_KEYCODE_DPAD_DOWN | Down key on D-pad. | 2629| ARKUI_KEYCODE_DPAD_LEFT | Left key on D-pad. | 2630| ARKUI_KEYCODE_DPAD_RIGHT | Right key on D-pad. | 2631| ARKUI_KEYCODE_DPAD_CENTER | Center key on D-pad. | 2632| ARKUI_KEYCODE_A | Key A. | 2633| ARKUI_KEYCODE_B | Key B. | 2634| ARKUI_KEYCODE_C | Key C. | 2635| ARKUI_KEYCODE_D | Key D. | 2636| ARKUI_KEYCODE_E | Key E. | 2637| ARKUI_KEYCODE_F | Key F. | 2638| ARKUI_KEYCODE_G | Key G. | 2639| ARKUI_KEYCODE_H | Key H. | 2640| ARKUI_KEYCODE_I | Key I. | 2641| ARKUI_KEYCODE_J | Key J. | 2642| ARKUI_KEYCODE_K | Key K. | 2643| ARKUI_KEYCODE_L | Key L. | 2644| ARKUI_KEYCODE_M | Key M. | 2645| ARKUI_KEYCODE_N | Key N. | 2646| ARKUI_KEYCODE_O | Key O. | 2647| ARKUI_KEYCODE_P | Key P. | 2648| ARKUI_KEYCODE_Q | Key R. | 2649| ARKUI_KEYCODE_R | Key R. | 2650| ARKUI_KEYCODE_S | Key S. | 2651| ARKUI_KEYCODE_T | Key T. | 2652| ARKUI_KEYCODE_U | Key U. | 2653| ARKUI_KEYCODE_V | Key V. | 2654| ARKUI_KEYCODE_W | Key W. | 2655| ARKUI_KEYCODE_X | Key X. | 2656| ARKUI_KEYCODE_Y | Key Y. | 2657| ARKUI_KEYCODE_Z | Key Z. | 2658| ARKUI_KEYCODE_COMMA | Key ,. | 2659| ARKUI_KEYCODE_PERIOD | Key .. | 2660| ARKUI_KEYCODE_ALT_LEFT | Left Alt key. | 2661| ARKUI_KEYCODE_ALT_RIGHT | Right Alt key. | 2662| ARKUI_KEYCODE_SHIFT_LEFT | Left Shift key. | 2663| ARKUI_KEYCODE_SHIFT_RIGHT | Right Shift key. | 2664| ARKUI_KEYCODE_TAB | Tab key. | 2665| ARKUI_KEYCODE_SPACE | Space key. | 2666| ARKUI_KEYCODE_SYM | Symbol key. | 2667| ARKUI_KEYCODE_EXPLORER | Explorer key, which is used to start the explorer application. | 2668| ARKUI_KEYCODE_ENVELOPE | Email key, which is used to start the email application. | 2669| ARKUI_KEYCODE_ENTER | Enter key. | 2670| ARKUI_KEYCODE_DEL | Delete key. | 2671| ARKUI_KEYCODE_GRAVE | Key `. | 2672| ARKUI_KEYCODE_MINUS | Key -. | 2673| ARKUI_KEYCODE_EQUALS | Key =. | 2674| ARKUI_KEYCODE_LEFT_BRACKET | Key [. | 2675| ARKUI_KEYCODE_RIGHT_BRACKET | Key ]. | 2676| ARKUI_KEYCODE_BACKSLASH | Key \. | 2677| ARKUI_KEYCODE_SEMICOLON | Key ;. | 2678| ARKUI_KEYCODE_APOSTROPHE | Key '. | 2679| ARKUI_KEYCODE_SLASH | Key /. | 2680| ARKUI_KEYCODE_AT | Key @. | 2681| ARKUI_KEYCODE_PLUS | Key +. | 2682| ARKUI_KEYCODE_MENU | Menu key. | 2683| ARKUI_KEYCODE_PAGE_UP | Page Up key. | 2684| ARKUI_KEYCODE_PAGE_DOWN | Page Down key. | 2685| ARKUI_KEYCODE_ESCAPE | ESC key. | 2686| ARKUI_KEYCODE_FORWARD_DEL | Forward Delete key. | 2687| ARKUI_KEYCODE_CTRL_LEFT | Left Ctrl key. | 2688| ARKUI_KEYCODE_CTRL_RIGHT | Right Ctrl key. | 2689| ARKUI_KEYCODE_CAPS_LOCK | Caps Lock key. | 2690| ARKUI_KEYCODE_SCROLL_LOCK | Scroll Lock key. | 2691| ARKUI_KEYCODE_META_LEFT | Left Meta key. | 2692| ARKUI_KEYCODE_META_RIGHT | Right Meta key. | 2693| ARKUI_KEYCODE_FUNCTION | Function key. | 2694| ARKUI_KEYCODE_SYSRQ | System Request/Print Screen key. | 2695| ARKUI_KEYCODE_BREAK | Break/Pause key. | 2696| ARKUI_KEYCODE_MOVE_HOME | Move to Home key. | 2697| ARKUI_KEYCODE_MOVE_END | Move to End key. | 2698| ARKUI_KEYCODE_INSERT | Insert key. | 2699| ARKUI_KEYCODE_FORWARD | Forward key. | 2700| ARKUI_KEYCODE_MEDIA_PLAY | Play key. | 2701| ARKUI_KEYCODE_MEDIA_PAUSE | Pause key. | 2702| ARKUI_KEYCODE_MEDIA_CLOSE | Close key. | 2703| ARKUI_KEYCODE_MEDIA_EJECT | Eject key. | 2704| ARKUI_KEYCODE_MEDIA_RECORD | Record key. | 2705| ARKUI_KEYCODE_F1 | F1 key. | 2706| ARKUI_KEYCODE_F2 | F2 key. | 2707| ARKUI_KEYCODE_F3 | F3 key. | 2708| ARKUI_KEYCODE_F4 | F4 key. | 2709| ARKUI_KEYCODE_F5 | F5 key. | 2710| ARKUI_KEYCODE_F6 | F6 key. | 2711| ARKUI_KEYCODE_F7 | F7 key. | 2712| ARKUI_KEYCODE_F8 | F8 key. | 2713| ARKUI_KEYCODE_F9 | F9 key. | 2714| ARKUI_KEYCODE_F10 | F10 key. | 2715| ARKUI_KEYCODE_F11 | F11 key. | 2716| ARKUI_KEYCODE_F12 | F12 key. | 2717| ARKUI_KEYCODE_NUM_LOCK | Number Lock key. | 2718| ARKUI_KEYCODE_NUMPAD_0 | Key 0 on numeric keypad. | 2719| ARKUI_KEYCODE_NUMPAD_1 | Key 1 on numeric keypad. | 2720| ARKUI_KEYCODE_NUMPAD_2 | Key 2 on numeric keypad. | 2721| ARKUI_KEYCODE_NUMPAD_3 | Key 3 on numeric keypad. | 2722| ARKUI_KEYCODE_NUMPAD_4 | Key 4 on numeric keypad. | 2723| ARKUI_KEYCODE_NUMPAD_5 | Key 5 on numeric keypad. | 2724| ARKUI_KEYCODE_NUMPAD_6 | Key 6 on numeric keypad. | 2725| ARKUI_KEYCODE_NUMPAD_7 | Key 7 on numeric keypad. | 2726| ARKUI_KEYCODE_NUMPAD_8 | Key 8 on numeric keypad. | 2727| ARKUI_KEYCODE_NUMPAD_9 | Key 9 on numeric keypad. | 2728| ARKUI_KEYCODE_NUMPAD_DIVIDE | Key / on numeric keypad. | 2729| ARKUI_KEYCODE_NUMPAD_MULTIPLY | Key * on numeric keypad. | 2730| ARKUI_KEYCODE_NUMPAD_SUBTRACT | Key - on numeric keypad. | 2731| ARKUI_KEYCODE_NUMPAD_ADD | Key + on numeric keypad. | 2732| ARKUI_KEYCODE_NUMPAD_DOT | Key . on numeric keypad. | 2733| ARKUI_KEYCODE_NUMPAD_COMMA | Key , on numeric keypad. | 2734| ARKUI_KEYCODE_NUMPAD_ENTER | Enter key on numeric keypad. | 2735| ARKUI_KEYCODE_NUMPAD_EQUALS | Key = on numeric keypad. | 2736| ARKUI_KEYCODE_NUMPAD_LEFT_PAREN | Key ( on numeric keypad. | 2737| ARKUI_KEYCODE_NUMPAD_RIGHT_PAREN | Key ) on numeric keypad. | 2738 2739 2740### ArkUI_KeyEventType 2741 2742``` 2743enum ArkUI_KeyEventType 2744``` 2745**Description** 2746 2747Type of a key. 2748 2749**Since**: 14 2750 2751| Enum| Description| 2752| -------- | -------- | 2753| ARKUI_KEY_EVENT_UNKNOWN | Unknown. | 2754| ARKUI_KEY_EVENT_DOWN | Pressing of a key. | 2755| ARKUI_KEY_EVENT_UP | Release of a key. | 2756| ARKUI_KEY_EVENT_LONG_PRESS | Long press of a key. | 2757| ARKUI_KEY_EVENT_CLICK | Click of a key. | 2758 2759 2760### ArkUI_KeyIntension 2761 2762``` 2763enum ArkUI_KeyIntension 2764``` 2765**Description** 2766 2767Enumerates the key intentions. 2768 2769**Since**: 14 2770 2771| Enum| Description| 2772| -------- | -------- | 2773| ARKUI_KEY_INTENSION_UNKNOWN | Unknown intention. | 2774| ARKUI_KEY_INTENSION_UP | Upward. | 2775| ARKUI_KEY_INTENSION_DOWN | Downward. | 2776| ARKUI_KEY_INTENSION_LEFT | Leftward. | 2777| ARKUI_KEY_INTENSION_RIGHT | Rightward. | 2778| ARKUI_KEY_INTENSION_SELECT | Select. | 2779| ARKUI_KEY_INTENSION_ESCAPE | | 2780| ARKUI_KEY_INTENSION_BACK | Back. | 2781| ARKUI_KEY_INTENSION_FORWARD | Forward. | 2782| ARKUI_KEY_INTENSION_MENU | Menu. | 2783| ARKUI_KEY_INTENSION_HOME | Home. | 2784| ARKUI_KEY_INTENSION_PAGE_UP | Page up. | 2785| ARKUI_KEY_INTENSION_PAGE_DOWN | Page down. | 2786| ARKUI_KEY_INTENSION_ZOOM_OUT | Zoom out. | 2787| ARKUI_KEY_INTENSION_ZOOM_IN | Zoom in. | 2788| ARKUI_KEY_INTENTION_MEDIA_PLAY_PAUSE | Play. | 2789| ARKUI_KEY_INTENTION_MEDIA_FAST_FORWARD | Fast-forward. | 2790| ARKUI_KEY_INTENTION_MEDIA_FAST_PLAYBACK | Fast playback. | 2791| ARKUI_KEY_INTENTION_MEDIA_NEXT | Play next. | 2792| ARKUI_KEY_INTENTION_MEDIA_PREVIOUS | Play previous. | 2793| ARKUI_KEY_INTENTION_MEDIA_MUTE | Mute. | 2794| ARKUI_KEY_INTENTION_VOLUME_UP | Volume up. | 2795| ARKUI_KEY_INTENTION_VOLUME_DOWN | Volume down. | 2796| ARKUI_KEY_INTENTION_CALL | Answer a call. | 2797| ARKUI_KEY_INTENTION_CAMERA | Camera. | 2798 2799 2800### ArkUI_KeySourceType 2801 2802``` 2803enum ArkUI_KeySourceType 2804``` 2805**Description** 2806 2807Enumerates the types of input devices that trigger key events. 2808 2809**Since**: 14 2810 2811| Enum| Description| 2812| -------- | -------- | 2813| ARKUI_KEY_SOURCE_UNKNOWN | Unknown type. | 2814| ARKUI_KEY_SOURCE_TYPE_MOUSE | Mouse. | 2815| ARKUI_KEY_SOURCE_TYPE_KEYBOARD | Keyboard. | 2816| ARKUI_KEY_SOURCE_TYPE_JOYSTICK | Joystick. | 2817 2818 2819### ArkUI_LengthMetricUnit 2820 2821``` 2822enum ArkUI_LengthMetricUnit 2823``` 2824**Description** 2825 2826Enumerates the component units. 2827 2828**Since**: 12 2829 2830| Enum| Description| 2831| -------- | -------- | 2832| ARKUI_LENGTH_METRIC_UNIT_DEFAULT | Default, which is fp for fonts and vp for non-fonts. | 2833| ARKUI_LENGTH_METRIC_UNIT_PX | px. | 2834| ARKUI_LENGTH_METRIC_UNIT_VP | vp. | 2835| ARKUI_LENGTH_METRIC_UNIT_FP | fp. | 2836 2837 2838### ArkUI_LinearGradientDirection 2839 2840``` 2841enum ArkUI_LinearGradientDirection 2842``` 2843**Description** 2844 2845Enumerates the gradient directions. 2846 2847**Since**: 12 2848 2849| Enum| Description| 2850| -------- | -------- | 2851| ARKUI_LINEAR_GRADIENT_DIRECTION_LEFT | From right to left. | 2852| ARKUI_LINEAR_GRADIENT_DIRECTION_TOP | From bottom to top. | 2853| ARKUI_LINEAR_GRADIENT_DIRECTION_RIGHT | From left to right. | 2854| ARKUI_LINEAR_GRADIENT_DIRECTION_BOTTOM | From top to bottom. | 2855| ARKUI_LINEAR_GRADIENT_DIRECTION_LEFT_TOP | From lower right to upper left. | 2856| ARKUI_LINEAR_GRADIENT_DIRECTION_LEFT_BOTTOM | From upper right to lower left. | 2857| ARKUI_LINEAR_GRADIENT_DIRECTION_RIGHT_TOP | From lower left to upper right. | 2858| ARKUI_LINEAR_GRADIENT_DIRECTION_RIGHT_BOTTOM | From upper left to lower right. | 2859| ARKUI_LINEAR_GRADIENT_DIRECTION_NONE | No gradient. | 2860| ARKUI_LINEAR_GRADIENT_DIRECTION_CUSTOM | Custom direction. | 2861 2862 2863### ArkUI_ListItemAlignment 2864 2865``` 2866enum ArkUI_ListItemAlignment 2867``` 2868**Description** 2869 2870Enumerates the alignment modes of items along the cross axis. 2871 2872**Since**: 12 2873 2874| Enum| Description| 2875| -------- | -------- | 2876| ARKUI_LIST_ITEM_ALIGNMENT_START | The list items are packed toward the start edge of the **List** component along the cross axis. | 2877| ARKUI_LIST_ITEM_ALIGNMENT_CENTER | The list items are centered in the **List** component along the cross axis. | 2878| ARKUI_LIST_ITEM_ALIGNMENT_END | The list items are packed toward the end edge of the **List** component along the cross axis. | 2879 2880 2881### ArkUI_ListItemSwipeActionState 2882 2883``` 2884enum ArkUI_ListItemSwipeActionState 2885``` 2886**Description** 2887 2888Enumerates the swipe action item states of list items. 2889 2890**Since**: 12 2891 2892| Enum| Description| 2893| -------- | -------- | 2894| 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. | 2895| 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. | 2896| ARKUI_LIST_ITEM_SWIPE_ACTION_STATE_ACTIONING | In-action state. The list item is in this state when it enters the delete area. | 2897 2898 2899### ArkUI_ListItemSwipeEdgeEffect 2900 2901``` 2902enum ArkUI_ListItemSwipeEdgeEffect 2903``` 2904**Description** 2905 2906Enumerates the swipe action item edge effects of list items. 2907 2908**Since**: 12 2909 2910| Enum| Description| 2911| -------- | -------- | 2912| 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. | 2913| ARKUI_LIST_ITEM_SWIPE_EDGE_EFFECT_NONE | The list item cannot scroll beyond the edge of the list. | 2914 2915 2916### ArkUI_MaskType 2917 2918``` 2919enum ArkUI_MaskType 2920``` 2921**Description** 2922 2923Enumerates the mask types. 2924 2925**Since**: 12 2926 2927| Enum| Description| 2928| -------- | -------- | 2929| ARKUI_MASK_TYPE_RECTANGLE | Rectangle. | 2930| ARKUI_MASK_TYPE_CIRCLE | **(circle)** | 2931| ARKUI_MASK_TYPE_ELLIPSE | Ellipse. | 2932| ARKUI_MASK_TYPE_PATH | Path Type | 2933| ARKUI_MASK_TYPE_PROGRESS | Progress indicator. | 2934 2935 2936### ArkUI_NativeAPIVariantKind 2937 2938``` 2939enum ArkUI_NativeAPIVariantKind 2940``` 2941**Description** 2942 2943Defines the native API types. 2944 2945**Since**: 12 2946 2947| Enum| Description| 2948| -------- | -------- | 2949| ARKUI_NATIVE_NODE | API related to UI components. For details, see the struct definition in <arkui/native_node.h>. | 2950| ARKUI_NATIVE_DIALOG | API related to dialog boxes. For details, see the struct definition in <arkui/native_dialog.h>. | 2951| ARKUI_NATIVE_GESTURE | API related to gestures. For details, see the struct definition in <arkui/native_gesture.h>. | 2952| ARKUI_NATIVE_ANIMATE | API related to animations. For details, see the struct definition in <arkui/native_animate.h>. | 2953 2954 2955### ArkUI_NavDestinationState 2956 2957``` 2958enum ArkUI_NavDestinationState 2959``` 2960**Description** 2961 2962Defines an enum for the **NavDestination** component states. 2963 2964**Since**: 12 2965 2966| Enum| Description| 2967| -------- | -------- | 2968| ARKUI_NAV_DESTINATION_STATE_ON_SHOW | The **NavDestination** component is displayed. | 2969| ARKUI_NAV_DESTINATION_STATE_ON_HIDE | The **NavDestination** component is hidden. | 2970| ARKUI_NAV_DESTINATION_STATE_ON_APPEAR | The **NavDestination** component is mounted to the component tree. | 2971| ARKUI_NAV_DESTINATION_STATE_ON_DISAPPEAR | The **NavDestination** component is unmounted from the component tree. | 2972| ARKUI_NAV_DESTINATION_STATE_ON_WILL_SHOW | The **NavDestination** is about to be displayed. | 2973| ARKUI_NAV_DESTINATION_STATE_ON_WILL_HIDE | The **NavDestination** is about to be hidden. | 2974| ARKUI_NAV_DESTINATION_STATE_ON_WILL_APPEAR | The **NavDestination** is about to be mounted to the component tree. | 2975| ARKUI_NAV_DESTINATION_STATE_ON_WILL_DISAPPEAR | The **NavDestination** component is about to be unmounted from the component tree. | 2976| ARKUI_NAV_DESTINATION_STATE_ON_BACK_PRESS | The back button is pressed for the **NavDestination** component. | 2977 2978 2979### ArkUI_NodeAdapterEventType 2980 2981``` 2982enum ArkUI_NodeAdapterEventType 2983``` 2984**Description** 2985 2986Enumerates node adapter events. 2987 2988**Since**: 12 2989 2990| Enum| Description| 2991| -------- | -------- | 2992| NODE_ADAPTER_EVENT_WILL_ATTACH_TO_NODE | This event occurs when the component is attached to the adapter. | 2993| NODE_ADAPTER_EVENT_WILL_DETACH_FROM_NODE | This event occurs when the component is detached from the adapter. | 2994| NODE_ADAPTER_EVENT_ON_GET_NODE_ID | This event occurs when the adapter obtains the unique ID of the new element to add. | 2995| NODE_ADAPTER_EVENT_ON_ADD_NODE_TO_ADAPTER | This event occurs when the adapter obtains the content of the new element to add. | 2996| NODE_ADAPTER_EVENT_ON_REMOVE_NODE_FROM_ADAPTER | This event occurs when the adapter removes an element. | 2997 2998 2999### ArkUI_NodeAttributeType 3000 3001``` 3002enum ArkUI_NodeAttributeType 3003``` 3004**Description** 3005 3006Defines the ArkUI style attributes that can be set on the native side. 3007 3008**Since**: 12 3009 3010| Enum| Description| 3011| -------- | -------- | 3012| 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.| 3013| 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.| 3014| 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.| 3015| 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.| 3016| 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.| 3017| 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.| 3018| 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. | 3019| 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.| 3020| 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.| 3021| 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.| 3022| 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.| 3023| 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.| 3024| 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.| 3025| 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.| 3026| 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.| 3027| 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).| 3028| 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.| 3029| 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.| 3030| 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.| 3031| 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**.| 3032| 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.| 3033| 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.| 3034| 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**.| 3035| 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.| 3036| 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.| 3037| 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.| 3038| 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**.| 3039| 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.| 3040| 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).| 3041| 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.| 3042| 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.| 3043| 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).| 3044| 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.| 3045| 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.| 3046| 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.| 3047| 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.| 3048| 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.| 3049| 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.| 3050| 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.| 3051| 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.| 3052| 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.| 3053| 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.| 3054| 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.| 3055| 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.| 3056| 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.| 3057| 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.| 3058| 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**.| 3059| 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**.| 3060| 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.| 3061| 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.| 3062| 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.| 3063| 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.| 3064| 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).| 3065| 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.| 3066| 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.| 3067| 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.| 3068| 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.| 3069| 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.| 3070| 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**.| 3071| 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.| 3072| 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.| 3073| 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.| 3074| 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**.| 3075| 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.| 3076| 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).| 3077| 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.| 3078| 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.| 3079| 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.| 3080| 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.| 3081| 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.| 3082| 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.| 3083| 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. | 3084| 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. | 3085| 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. | 3086| 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. | 3087| 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.| 3088| 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).| 3089| 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.| 3090| 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**.| 3091| 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.| 3092| 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.| 3093| 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**.| 3094| 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].| 3095| 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. | 3096| 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.| 3097| 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.| 3098| 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.| 3099| 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.| 3100| 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).| 3101| 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).| 3102| 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).| 3103| 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).| 3104| 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> | 3105| 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> | 3106| 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).| 3107| 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.| 3108| 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.| 3109| 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.| 3110| 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.| 3111| 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.| 3112| 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.| 3113| 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.| 3114| 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).| 3115| 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).| 3116| 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.| 3117| 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).| 3118| 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.| 3119| 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.| 3120| 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.| 3121| 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).| 3122| 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} | 3123| 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 (,).| 3124| 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).| 3125| 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.| 3126| 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.| 3127| 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.| 3128| 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.| 3129| 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**.| 3130| 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).| 3131| 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.| 3132| 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).| 3133| 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).| 3134| 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. | 3135| 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 (,).| 3136| 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.| 3137| 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).| 3138| 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.| 3139| 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).| 3140| 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.| 3141| 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).| 3142| 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.| 3143| 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.| 3144| 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.| 3145| 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.| 3146| 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.| 3147| 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).| 3148| 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.| 3149| 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).| 3150| 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.| 3151| 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.| 3152| 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.| 3153| 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**.| 3154| 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.| 3155| 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).| 3156| 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.| 3157| 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).| 3158| 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.| 3159| 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.| 3160| 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.| 3161| 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.| 3162| 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.| 3163| 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.| 3164| 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.| 3165| 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.| 3166| 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.| 3167| 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.| 3168| 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.| 3169| 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. | 3170| 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.| 3171| 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.| 3172| 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.| 3173| 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).| 3174| 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.| 3175| 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 (,).| 3176| 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.| 3177| 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).| 3178| 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.| 3179| 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.| 3180| 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.| 3181| 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.| 3182| 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. | 3183| 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. | 3184| 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.| 3185| 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).| 3186| 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.| 3187| 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.| 3188| 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.| 3189| 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).| 3190| 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.| 3191| 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.| 3192| 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.| 3193| 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.| 3194| 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.| 3195| 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.| 3196| 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).| 3197| 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.| 3198| 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.| 3199| 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.| 3200| 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.| 3201| 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.| 3202| 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.| 3203| 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 (,).| 3204| 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.| 3205| 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.| 3206| 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).| 3207| 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**.| 3208| 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.| 3209| 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.| 3210| 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.| 3211| 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.| 3212| 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).| 3213| 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.| 3214| 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.| 3215| 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.| 3216| 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.| 3217| 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. | 3218| 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.| 3219| 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).| 3220| 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.| 3221| 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.| 3222| 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.| 3223| 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.| 3224| 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.| 3225| 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.| 3226| 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.| 3227| 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).| 3228| 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.| 3229| 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**.| 3230| 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**.| 3231| 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**.| 3232| 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).| 3233| 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.| 3234| 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).| 3235| 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. | 3236| 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.| 3237| 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.| 3238| 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.| 3239| 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.| 3240| 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"**.| 3241| 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"**.| 3242| 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"**.| 3243| 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.| 3244| 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.| 3245| 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"**.| 3246| 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"**.| 3247| 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"**.| 3248| 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).| 3249| 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.| 3250| 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 (;).| 3251| 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"**.| 3252| 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"**.| 3253| 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"**.| 3254| 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.| 3255| 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.| 3256| 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.| 3257| 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.| 3258| 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.| 3259| 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.| 3260| 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).| 3261| 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**.| 3262| 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**.| 3263| 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**.| 3264| 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.| 3265| 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.| 3266| 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.| 3267| 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.| 3268| 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.| 3269| 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].| 3270| 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).| 3271| 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.| 3272| 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).| 3273| 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. | 3274| 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.| 3275| 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**.| 3276| 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.| 3277| 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. | 3278| 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).| 3279| 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).| 3280| 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.| 3281| 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.| 3282| 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).| 3283| 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 | 3284| 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.| 3285| 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.| 3286| 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.| 3287| 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).| 3288| 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.| 3289| 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).| 3290| 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.| 3291| 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.| 3292| 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.| 3293| 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.| 3294| 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 | 3295| 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 | 3296| 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).| 3297| 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).| 3298| 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.| 3299| 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.| 3300| 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>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.| 3301| 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**.| 3302| 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**.| 3303| 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**.| 3304| 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**.| 3305| 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.| 3306| 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**.| 3307| 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**.| 3308| NODE_SWIPER_SHOW_INDICATOR | Defines whether to enable the navigation point 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 point indicator. The value **1** means to enable the navigation point 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 point indicator. The value **1** means to enable the navigation point indicator, and **0** means the opposite. The default value is **1**.| 3309| 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.| 3310| 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**.| 3311| 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**.| 3312| 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.| 3313| 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.| 3314| 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>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: number of elements to display per page.| 3315| 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 per page.<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.| 3316| 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**.| 3317| NODE_SWIPER_SHOW_DISPLAY_ARROW | Defines whether to show the arrow when the mouse pointer hovers over the navigation point 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: 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>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**.| 3318| 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).| 3319| 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.| 3320| 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>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.| 3321| 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.| 3322| 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.| 3323| 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: The parameter type is [ArkUI_SwiperIndicator](#arkui_swiperindicator).<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: The parameter type is [ArkUI_SwiperIndicator](#arkui_swiperindicator).| 3324| 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).| 3325| 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.| 3326| NODE_SWIPER_INDICATOR_INTERACTIVE | Sets whether the navigation point 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 point indicator is interactive. The default value **true** means that the navigation point indicator is interactive.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether the navigation point indicator is interactive.| 3327| 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 | 3328| 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.| 3329| 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.| 3330| 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.| 3331| 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.| 3332| 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: **ArkUI_ListChildrenMainSize** object.| 3333| 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).| 3334| 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).| 3335| 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).| 3336| 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).| 3337| 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.| 3338| 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.| 3339| 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**.| 3340| 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.| 3341| 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.| 3342| 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.| 3343| 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**.| 3344| 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.| 3345| 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.| 3346| 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.| 3347| 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.| 3348| 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.| 3349| 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.| 3350| 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.| 3351| 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).| 3352| 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**.| 3353| 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. | 3354| 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**.| 3355| 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.| 3356| 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.| 3357| 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.| 3358| 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.| 3359| 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.| 3360| 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.| 3361| 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. | 3362| 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**. | 3363| 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).| 3364| 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**.| 3365| 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.| 3366| NODE_IMAGE_ANIMATOR_FIXED_SIZE | Sets 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.| 3367| 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**.| 3368| NODE_IMAGE_ANIMATOR_ITERATION | Sets the number of times that the 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. | 3369 3370 3371### ArkUI_NodeContentEventType 3372 3373``` 3374enum ArkUI_NodeContentEventType 3375``` 3376**Description** 3377 3378Defines the NodeContent event type. 3379 3380**Since**: 12 3381 3382| Enum| Description| 3383| -------- | -------- | 3384| NODE_CONTENT_EVENT_ON_ATTACH_TO_WINDOW | Attach event. | 3385| NODE_CONTENT_EVENT_ON_DETACH_FROM_WINDOW | Detach event. | 3386 3387 3388### ArkUI_NodeCustomEventType 3389 3390``` 3391enum ArkUI_NodeCustomEventType 3392``` 3393**Description** 3394 3395Enumerates the custom component event types. 3396 3397**Since**: 12 3398 3399| Enum| Description| 3400| -------- | -------- | 3401| ARKUI_NODE_CUSTOM_EVENT_ON_MEASURE | Measure. | 3402| ARKUI_NODE_CUSTOM_EVENT_ON_LAYOUT | Layout. | 3403| ARKUI_NODE_CUSTOM_EVENT_ON_DRAW | Draw. | 3404| ARKUI_NODE_CUSTOM_EVENT_ON_FOREGROUND_DRAW | Foreground. | 3405| ARKUI_NODE_CUSTOM_EVENT_ON_OVERLAY_DRAW | Overlay. | 3406 3407 3408### ArkUI_NodeDirtyFlag 3409 3410``` 3411enum ArkUI_NodeDirtyFlag 3412``` 3413**Description** 3414 3415Enumerates the dirty area flags passed in the **::markDirty** API. 3416 3417**Since**: 12 3418 3419| Enum| Description| 3420| -------- | -------- | 3421| NODE_NEED_MEASURE | Recalculate the size.<br>When this type of flag is specified, re-layout is triggered by default.| 3422| NODE_NEED_LAYOUT | Re-layout. | 3423| NODE_NEED_RENDER | Re-rendering. | 3424 3425 3426### ArkUI_NodeEventType 3427 3428``` 3429enum ArkUI_NodeEventType 3430``` 3431**Description** 3432 3433Enumerates the event types supported by the NativeNode component. 3434 3435**Since**: 12 3436 3437| Enum| Description| 3438| -------- | -------- | 3439| 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).| 3440| 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.| 3441| 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.| 3442| 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.| 3443| 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.| 3444| 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.| 3445| 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.| 3446| 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).| 3447| 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.| 3448| 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.| 3449| 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).| 3450| 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.| 3451| 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.| 3452| 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).| 3453| 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).| 3454| 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.| 3455| 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.| 3456| 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.| 3457| 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.| 3458| 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.| 3459| 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.| 3460| 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 | 3461| 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 | 3462| 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.| 3463| 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.| 3464| 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.| 3465| 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.| 3466| 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:.| 3467| 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.| 3468| 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.| 3469| NODE_TEXT_INPUT_ON_SUBMIT | Called when the Enter key of the text 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.| 3470| 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.| 3471| 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.| 3472| 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.| 3473| 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.| 3474| 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.| 3475| 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.| 3476| 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.| 3477| 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**.| 3478| 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**.| 3479| 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**.| 3480| 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**.| 3481| 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.| 3482| 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.| 3483| 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.| 3484| 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.| 3485| 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.| 3486| 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.| 3487| 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.| 3488| 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.| 3489| 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**.| 3490| 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**.| 3491| 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**.| 3492| 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**.| 3493| 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| 3494| 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.| 3495| 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.| 3496| 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.| 3497| 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.| 3498| 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.| 3499| 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.| 3500| 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.| 3501| 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.| 3502| 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.| 3503| 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.| 3504| 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.| 3505| 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.| 3506| 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.| 3507| 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.| 3508| 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.| 3509| 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.| 3510| 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.| 3511| 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.| 3512| 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.| 3513| 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).| 3514| 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.| 3515| 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.| 3516| 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.| 3517| 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.| 3518| 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.| 3519| 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.| 3520| 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.| 3521| 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.| 3522| 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.| 3523| 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.| 3524| 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.| 3525| 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.| 3526| 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:.| 3527| 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:.| 3528 3529 3530### ArkUI_NodeType 3531 3532``` 3533enum ArkUI_NodeType 3534``` 3535**Description** 3536 3537Enumerates ArkUI component types that can be created on the native side. 3538 3539**Since**: 12 3540 3541| Enum| Description| 3542| -------- | -------- | 3543| ARKUI_NODE_CUSTOM | Custom node. | 3544| ARKUI_NODE_TEXT | Text to insert. | 3545| ARKUI_NODE_SPAN | Text span. | 3546| ARKUI_NODE_IMAGE_SPAN | Image span. | 3547| ARKUI_NODE_IMAGE | Image. | 3548| ARKUI_NODE_TOGGLE | Toggle. | 3549| ARKUI_NODE_LOADING_PROGRESS | Loading icon. | 3550| ARKUI_NODE_TEXT_INPUT | Single-line text input. | 3551| ARKUI_NODE_TEXT_AREA | Multi-line text input. | 3552| ARKUI_NODE_BUTTON | Icon. | 3553| ARKUI_NODE_PROGRESS | Progress indicator. | 3554| ARKUI_NODE_CHECKBOX | Check box. | 3555| ARKUI_NODE_XCOMPONENT | XComponent. | 3556| ARKUI_NODE_DATE_PICKER | Date picker. | 3557| ARKUI_NODE_TIME_PICKER | Time picker. | 3558| ARKUI_NODE_TEXT_PICKER | Text picker. | 3559| ARKUI_NODE_CALENDAR_PICKER | Calendar picker. | 3560| ARKUI_NODE_SLIDER | Slider. | 3561| ARKUI_NODE_RADIO | Radio button. | 3562| ARKUI_NODE_IMAGE_ANIMATOR | Frame animation component. | 3563| ARKUI_NODE_STACK | Stack container. | 3564| ARKUI_NODE_SWIPER | Swiper. | 3565| ARKUI_NODE_SCROLL | Scrolling container. | 3566| ARKUI_NODE_LIST | List. | 3567| ARKUI_NODE_LIST_ITEM | List item. | 3568| ARKUI_NODE_LIST_ITEM_GROUP | List item group. | 3569| ARKUI_NODE_COLUMN | Column container. | 3570| ARKUI_NODE_ROW | Row container. | 3571| ARKUI_NODE_FLEX | Flex container. | 3572| ARKUI_NODE_REFRESH | Refresh component. | 3573| ARKUI_NODE_WATER_FLOW | Water flow container. | 3574| ARKUI_NODE_FLOW_ITEM | Water flow item. | 3575| ARKUI_NODE_RELATIVE_CONTAINER | Relative layout component. | 3576| ARKUI_NODE_GRID | Grid. | 3577| ARKUI_NODE_GRID_ITEM | Grid item. | 3578| ARKUI_NODE_CUSTOM_SPAN | Custom span. | 3579 3580 3581### ArkUI_ObjectFit 3582 3583``` 3584enum ArkUI_ObjectFit 3585``` 3586**Description** 3587 3588Enumerates the image filling effects. ImageSpanAlignment 3589 3590**Since**: 12 3591 3592| Enum| Description| 3593| -------- | -------- | 3594| ARKUI_OBJECT_FIT_CONTAIN | The image is scaled with its aspect ratio retained for the content to be completely displayed within the display boundaries. | 3595| 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. | 3596| ARKUI_OBJECT_FIT_AUTO | The image is scaled automatically to fit the display area. | 3597| ARKUI_OBJECT_FIT_FILL | The image is scaled to fill the display area, and its aspect ratio is not retained. | 3598| 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. | 3599| ARKUI_OBJECT_FIT_NONE | The original size is retained. | 3600| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_TOP_START | Not resized, the image is aligned with the start edge of the top of the container. | 3601| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_TOP | Not resized, the image is horizontally centered at the top of the container. | 3602| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_TOP_END | Not resized, the image is aligned with the end edge at the top of the container. | 3603| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_START | Not resized, the image is vertically centered on the start edge of the container. | 3604| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_CENTER | Not resized, the image is horizontally and vertically centered in the container. | 3605| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_END | Not resized, the image is vertically centered on the end edge of the container. | 3606| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_BOTTOM_START | Not resized, the image is aligned with the start edge at the bottom of the container. | 3607| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_BOTTOM | Not resized, the image is horizontally centered at the bottom of the container. | 3608| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_BOTTOM_END | Not resized, the image is aligned with the end edge at the bottom of the container. | 3609### ArkUI_PageFlipMode 3610 3611``` 3612enum ArkUI_PageFlipMode 3613``` 3614**Description** 3615 3616Enumerates the page flipping modes using the mouse wheel for the <b>Swiper</b> component. 3617 3618**Since**: 14 3619 3620| Enum| Description| 3621| -------- | -------- | 3622| 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. | 3623| ARKUI_PAGE_FLIP_MODE_SINGLE | The system does not respond to other mouse wheel events until the page flipping animation ends. | 3624 3625 3626### ArkUI_PreDragStatus 3627 3628``` 3629enum ArkUI_PreDragStatus 3630``` 3631**Description** 3632 3633Defines an enum for interaction states prior to a drop and drop operation. 3634 3635**Since**: 12 3636 3637| Enum| Description| 3638| -------- | -------- | 3639| ARKUI_PRE_DRAG_STATUS_UNKNOWN | Unknown. | 3640| ARKUI_PRE_DRAG_STATUS_ACTION_DETECTING | A drag gesture is being detected. | 3641| ARKUI_PRE_DRAG_STATUS_READY_TO_TRIGGER_DRAG | The component is ready to be dragged. | 3642| ARKUI_PRE_DRAG_STATUS_PREVIEW_LIFT_STARTED | A lift animation is started. | 3643| ARKUI_PRE_DRAG_STATUS_PREVIEW_LIFT_FINISHED | A lift animation is finished. | 3644| ARKUI_PRE_DRAG_STATUS_PREVIEW_LANDING_STARTED | A drop animation is started. | 3645| ARKUI_PRE_DRAG_STATUS_PREVIEW_LANDING_FINISHED | A drop animation is finished. | 3646| ARKUI_PRE_DRAG_STATUS_CANCELED_BEFORE_DRAG | A drop animation is terminated. | 3647 3648 3649### ArkUI_ProgressType 3650 3651``` 3652enum ArkUI_ProgressType 3653``` 3654**Description** 3655 3656Enumerates the styles of the progress indicator. 3657 3658**Since**: 12 3659 3660| Enum| Description| 3661| -------- | -------- | 3662| ARKUI_PROGRESS_TYPE_LINEAR | Linear type. | 3663| ARKUI_PROGRESS_TYPE_RING | Indeterminate ring style. | 3664| ARKUI_PROGRESS_TYPE_ECLIPSE | Eclipse style. | 3665| ARKUI_PROGRESS_TYPE_SCALE_RING | Determinate ring style. | 3666| ARKUI_PROGRESS_TYPE_CAPSULE | Capsule style. | 3667 3668 3669### ArkUI_RelativeLayoutChainStyle 3670 3671``` 3672enum ArkUI_RelativeLayoutChainStyle 3673``` 3674**Description** 3675 3676Enumerates the chain styles. 3677 3678**Since**: 12 3679 3680| Enum| Description| 3681| -------- | -------- | 3682| ARKUI_RELATIVE_LAYOUT_CHAIN_STYLE_SPREAD | Child components are evenly distributed among constraint anchors. | 3683| ARKUI_RELATIVE_LAYOUT_CHAIN_STYLE_SPREAD_INSIDE | All child components except the first and last ones are evenly distributed among constraint anchors. | 3684| ARKUI_RELATIVE_LAYOUT_CHAIN_STYLE_PACKED | There is no gap between child components in the chain. | 3685 3686 3687### ArkUI_RenderFit 3688 3689``` 3690enum ArkUI_RenderFit 3691``` 3692 3693| Enum| Description| 3694| -------- | -------- | 3695| ARKUI_RENDER_FIT_CENTER | The component's content stays at the final size and always aligned with the center of the component. | 3696| ARKUI_RENDER_FIT_TOP | The component's content stays at the final size and always aligned with the top center of the component. | 3697| ARKUI_RENDER_FIT_BOTTOM | The component's content stays at the final size and always aligned with the bottom center of the component. | 3698| ARKUI_RENDER_FIT_LEFT | The component's content stays at the final size and always aligned with the left of the component. | 3699| ARKUI_RENDER_FIT_RIGHT | The component's content stays at the final size and always aligned with the right of the component. | 3700| 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. | 3701| 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. | 3702| 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. | 3703| 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. | 3704| 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. | 3705| 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. | 3706| 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. | 3707| 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. | 3708| 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. | 3709| 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. | 3710| 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. | 3711 3712 3713### ArkUI_RouterPageState 3714 3715``` 3716enum ArkUI_RouterPageState 3717``` 3718**Description** 3719 3720Enumerates the states of a page during routing. 3721 3722**Since**: 12 3723 3724| Enum| Description| 3725| -------- | -------- | 3726| ARKUI_ROUTER_PAGE_STATE_ON_WILL_APPEAR | The page is about to be displayed. | 3727| ARKUI_ROUTER_PAGE_STATE_ON_WILL_DISAPPEAR | The page is about to be destroyed. | 3728| ARKUI_ROUTER_PAGE_STATE_ON_SHOW | The page is displayed. | 3729| ARKUI_ROUTER_PAGE_STATE_ON_HIDE | The page is hidden. | 3730| ARKUI_ROUTER_PAGE_STATE_ON_BACK_PRESS | The back button is pressed for the page. | 3731 3732 3733### ArkUI_SafeAreaEdge 3734 3735``` 3736enum ArkUI_SafeAreaEdge 3737``` 3738**Description** 3739 3740Enumerates the edges for expanding the safe area. 3741 3742**Since**: 12 3743 3744| Enum| Description| 3745| -------- | -------- | 3746| ARKUI_SAFE_AREA_EDGE_TOP | Top edge. | 3747| ARKUI_SAFE_AREA_EDGE_BOTTOM | Bottom edge. | 3748| ARKUI_SAFE_AREA_EDGE_START | Start edge. | 3749| ARKUI_SAFE_AREA_EDGE_END | End edge. | 3750 3751 3752### ArkUI_SafeAreaType 3753 3754``` 3755enum ArkUI_SafeAreaType 3756``` 3757**Description** 3758 3759Enumerates the types of expanded safe areas. 3760 3761**Since**: 12 3762 3763| Enum| Description| 3764| -------- | -------- | 3765| ARKUI_SAFE_AREA_TYPE_SYSTEM | Default non-safe area of the system, including the status bar and navigation bar. | 3766| ARKUI_SAFE_AREA_TYPE_CUTOUT | Non-safe area of the device, for example, the notch area. | 3767| ARKUI_SAFE_AREA_TYPE_KEYBOARD | Soft keyboard area. | 3768 3769 3770### ArkUI_ScrollAlignment 3771 3772``` 3773enum ArkUI_ScrollAlignment 3774``` 3775**Description** 3776 3777Defines how the list item to scroll to is aligned with the container. 3778 3779**Since**: 12 3780 3781| Enum| Description| 3782| -------- | -------- | 3783| ARKUI_SCROLL_ALIGNMENT_START | The start edge of the list item is flush with the start edge of the container. | 3784| ARKUI_SCROLL_ALIGNMENT_CENTER | The list item is centered along the main axis of the list. | 3785| ARKUI_SCROLL_ALIGNMENT_END | The end edge of the list item Aligns the tail of an item with that of a container. | 3786| 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. | 3787 3788### ArkUI_ScrollBarDisplayMode 3789 3790``` 3791enum ArkUI_ScrollBarDisplayMode 3792``` 3793**Description** 3794 3795Enumerates the scrollbar display modes. 3796 3797**Since**: 12 3798 3799| Enum| Description| 3800| -------- | -------- | 3801| ARKUI_SCROLL_BAR_DISPLAY_MODE_OFF | Not displayed. | 3802| ARKUI_SCROLL_BAR_DISPLAY_MODE_AUTO | Displayed when the screen is touched and hidden after 2s. | 3803| ARKUI_SCROLL_BAR_DISPLAY_MODE_ON | Always displayed. | 3804 3805 3806### ArkUI_ScrollDirection 3807 3808``` 3809enum ArkUI_ScrollDirection 3810``` 3811**Description** 3812 3813Enumerates the scroll directions of scrollable components. 3814 3815**Since**: 12 3816 3817| Enum| Description| 3818| -------- | -------- | 3819| ARKUI_SCROLL_DIRECTION_VERTICAL | Only vertical scrolling is supported. | 3820| ARKUI_SCROLL_DIRECTION_HORIZONTAL | Only horizontal scrolling is supported. | 3821| ARKUI_SCROLL_DIRECTION_NONE | Scrolling is forbidden. | 3822 3823 3824### ArkUI_ScrollEdge 3825 3826``` 3827enum ArkUI_ScrollEdge 3828``` 3829**Description** 3830 3831Defines the edge to which the component scrolls. 3832 3833**Since**: 12 3834 3835| Enum| Description| 3836| -------- | -------- | 3837| ARKUI_SCROLL_EDGE_TOP | Top edge in the vertical direction. | 3838| ARKUI_SCROLL_EDGE_BOTTOM | Bottom edge in the vertical direction. | 3839| ARKUI_SCROLL_EDGE_START | Start position in the horizontal direction. | 3840| ARKUI_SCROLL_EDGE_END | End position in the horizontal direction. | 3841 3842 3843### ArkUI_ScrollNestedMode 3844 3845``` 3846enum ArkUI_ScrollNestedMode 3847``` 3848**Description** 3849 3850Enumerates nested scrolling options. 3851 3852**Since**: 12 3853 3854| Enum| Description| 3855| -------- | -------- | 3856| 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. | 3857| 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. | 3858| 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. | 3859| 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. | 3860 3861 3862### ArkUI_ScrollSnapAlign 3863 3864``` 3865enum ArkUI_ScrollSnapAlign 3866``` 3867**Description** 3868 3869Enumerates the alignment modes of list items when scrolling ends. 3870 3871**Since**: 12 3872 3873| Enum| Description| 3874| -------- | -------- | 3875| ARKUI_SCROLL_SNAP_ALIGN_NONE | No alignment. This is the default value. | 3876| ARKUI_SCROLL_SNAP_ALIGN_START | The first item in the view is aligned at the start of the list. | 3877| ARKUI_SCROLL_SNAP_ALIGN_CENTER | The middle items in the view are aligned in the center of the list. | 3878| ARKUI_SCROLL_SNAP_ALIGN_END | The last item in the view is aligned at the end of the list. | 3879 3880 3881### ArkUI_ScrollSource 3882 3883``` 3884enum ArkUI_ScrollSource 3885``` 3886**Description** 3887 3888Enumerates the scrolling sources. 3889 3890**Since**: 12 3891 3892| Enum| Description| 3893| -------- | -------- | 3894| ARKUI_SCROLL_SOURCE_DRAG | Drag your finger. | 3895| ARKUI_SCROLL_SOURCE_FLING | Inertia scrolling after finger dragging. | 3896| ARKUI_SCROLL_SOURCE_EDGE_EFFECT | Executes the EdgeEffect.Spring edge special effect when the boundary is crossed. | 3897| ARKUI_SCROLL_SOURCE_OTHER_USER_INPUT | User input other than dragging, such as mouse wheel and keyboard events. | 3898| ARKUI_SCROLL_SOURCE_SCROLL_BAR | Scrollbar dragging | 3899| ARKUI_SCROLL_SOURCE_SCROLL_BAR_FLING | Inertial scrolling after the scroll bar is dragged. | 3900| ARKUI_SCROLL_SOURCE_SCROLLER | Scrolling by the scroll controller (without animation). | 3901| ARKUI_SCROLL_SOURCE_ANIMATION | Scrolling by the scroll controller (with animation). | 3902 3903 3904### ArkUI_ScrollState 3905 3906``` 3907enum ArkUI_ScrollState 3908``` 3909**Description** 3910 3911Enumerates the scrolling states. 3912 3913**Since**: 12 3914 3915| Enum| Description| 3916| -------- | -------- | 3917| 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. | 3918| ARKUI_SCROLL_STATE_SCROLL | Scrolling. The container enters this state when the user drags the container to scroll. | 3919| 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. | 3920 3921 3922### ArkUI_ShadowStyle 3923 3924``` 3925enum ArkUI_ShadowStyle 3926``` 3927**Description** 3928 3929Enumerated value of the shadow effect. 3930 3931**Since**: 12 3932 3933| Enum| Description| 3934| -------- | -------- | 3935| ARKUI_SHADOW_STYLE_OUTER_DEFAULT_XS | Mini shadow. | 3936| ARKUI_SHADOW_STYLE_OUTER_DEFAULT_SM | Small shadow. | 3937| ARKUI_SHADOW_STYLE_OUTER_DEFAULT_MD | Medium shadow. | 3938| ARKUI_SHADOW_STYLE_OUTER_DEFAULT_LG | Large shadow. | 3939| ARKUI_SHADOW_STYLE_OUTER_FLOATING_SM | Floating small shadow. | 3940| ARKUI_SHADOW_STYLE_OUTER_FLOATING_MD | Floating medium shadow. | 3941 3942 3943### ArkUI_ShadowType 3944 3945``` 3946enum ArkUI_ShadowType 3947``` 3948**Description** 3949 3950Defines the enumerated values of the shadow type. 3951 3952**Since**: 12 3953 3954| Enum| Description| 3955| -------- | -------- | 3956| ARKUI_SHADOW_TYPE_COLOR | Color. | 3957| ARKUI_SHADOW_TYPE_BLUR | Blur. | 3958 3959 3960### ArkUI_ShapeType 3961 3962``` 3963enum ArkUI_ShapeType 3964``` 3965**Description** 3966 3967Enumerates custom shape types. 3968 3969**Since**: 12 3970 3971| Enum| Description| 3972| -------- | -------- | 3973| ARKUI_SHAPE_TYPE_RECTANGLE | Rectangle. | 3974| ARKUI_SHAPE_TYPE_CIRCLE | **(circle)** | 3975| ARKUI_SHAPE_TYPE_ELLIPSE | Ellipse. | 3976| ARKUI_SHAPE_TYPE_PATH | Path Type | 3977 3978 3979### ArkUI_SliderBlockStyle 3980 3981``` 3982enum ArkUI_SliderBlockStyle 3983``` 3984**Description** 3985 3986Enumerates the styles of the slider in the block direction. 3987 3988**Since**: 12 3989 3990| Enum| Description| 3991| -------- | -------- | 3992| ARKUI_SLIDER_BLOCK_STYLE_DEFAULT | Round slider. | 3993| ARKUI_SLIDER_BLOCK_STYLE_IMAGE | Slider with an image background. | 3994| ARKUI_SLIDER_BLOCK_STYLE_SHAPE | Slider in a custom shape. | 3995 3996 3997### ArkUI_SliderDirection 3998 3999``` 4000enum ArkUI_SliderDirection 4001``` 4002**Description** 4003 4004Enumerates the scroll directions of the slider. 4005 4006**Since**: 12 4007 4008| Enum| Description| 4009| -------- | -------- | 4010| ARKUI_SLIDER_DIRECTION_VERTICAL | Vertical direction. | 4011| ARKUI_SLIDER_DIRECTION_HORIZONTAL | Horizontal direction. | 4012 4013 4014### ArkUI_SliderStyle 4015 4016``` 4017enum ArkUI_SliderStyle 4018``` 4019**Description** 4020 4021Enumerates the slider styles. 4022 4023**Since**: 12 4024 4025| Enum| Description| 4026| -------- | -------- | 4027| ARKUI_SLIDER_STYLE_OUT_SET | The slider is on the slider rail. | 4028| ARKUI_SLIDER_STYLE_IN_SET | The slider is in the slider rail. | 4029| ARKUI_SLIDER_STYLE_NONE | There is no thumb. | 4030 4031 4032### ArkUI_StickyStyle 4033 4034``` 4035enum ArkUI_StickyStyle 4036``` 4037**Description** 4038 4039Enumerates the modes for pinning the header to the top or the footer to the bottom. 4040 4041**Since**: 12 4042 4043| Enum| Description| 4044| -------- | -------- | 4045| 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. | 4046| 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. | 4047| 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. | 4048| ARKUI_STICKY_STYLE_BOTH | In the list item group, the footer is pinned to the bottom, and the header is pinned to the top. | 4049 4050 4051### ArkUI_SwiperArrow 4052 4053``` 4054enum ArkUI_SwiperArrow 4055``` 4056**Description** 4057 4058Enumerates arrow styles of the navigation point indicator. 4059 4060**Since**: 12 4061 4062| Enum| Description| 4063| -------- | -------- | 4064| ARKUI_SWIPER_ARROW_HIDE | The arrow is not displayed for the navigation point indicator. | 4065| ARKUI_SWIPER_ARROW_SHOW | The arrow is displayed for the navigation point indicator. | 4066| ARKUI_SWIPER_ARROW_SHOW_ON_HOVER | The arrow is displayed only when the mouse pointer hovers over the navigation point indicator. | 4067 4068 4069### ArkUI_SwiperDisplayModeType 4070 4071``` 4072enum ArkUI_SwiperDisplayModeType 4073``` 4074**Description** 4075 4076Enumerates the modes in which elements are displayed along the main axis of the **Swiper** component. 4077 4078**Since**: 12 4079 4080| Enum| Description| 4081| -------- | -------- | 4082| ARKUI_SWIPER_DISPLAY_MODE_STRETCH | The slide width of the **Swiper** component is equal to the width of the component. | 4083| 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. | 4084 4085 4086### ArkUI_SwiperIndicatorType 4087 4088``` 4089enum ArkUI_SwiperIndicatorType 4090``` 4091**Description** 4092 4093Enumerates the navigation point indicator types of the **Swiper** component. 4094 4095**Since**: 12 4096 4097| Enum| Description| 4098| -------- | -------- | 4099| ARKUI_SWIPER_INDICATOR_TYPE_DOT | Dot type. | 4100| ARKUI_SWIPER_INDICATOR_TYPE_DIGIT | Digit type. | 4101 4102 4103### ArkUI_SwiperNestedScrollMode 4104 4105``` 4106enum ArkUI_SwiperNestedScrollMode 4107``` 4108**Description** 4109 4110Enumerates the nested scrolling mode of the **Swiper** component and its parent container. 4111 4112**Since**: 12 4113 4114| Enum| Description| 4115| -------- | -------- | 4116| 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. | 4117| 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. | 4118 4119 4120### ArkUI_SystemColorMode 4121 4122``` 4123enum ArkUI_SystemColorMode 4124``` 4125**Description** 4126 4127Enumerates the system color modes. 4128 4129**Since**: 12 4130 4131| Enum| Description| 4132| -------- | -------- | 4133| ARKUI_SYSTEM_COLOR_MODE_LIGHT | Light mode. | 4134| ARKUI_SYSTEM_COLOR_MODE_DARK | Dark mode. | 4135 4136 4137### ArkUI_TextAlignment 4138 4139``` 4140enum ArkUI_TextAlignment 4141``` 4142**Description** 4143 4144Enumerates the text alignment mode. 4145 4146**Since**: 12 4147 4148| Enum| Description| 4149| -------- | -------- | 4150| ARKUI_TEXT_ALIGNMENT_START | Aligned with the start. | 4151| ARKUI_TEXT_ALIGNMENT_CENTER | Horizontally centered. | 4152| ARKUI_TEXT_ALIGNMENT_END | Aligned with the end. | 4153| ARKUI_TEXT_ALIGNMENT_JUSTIFY | Aligned with both margins. | 4154 4155 4156### ArkUI_TextAreaType 4157 4158``` 4159enum ArkUI_TextAreaType 4160``` 4161**Description** 4162 4163Enumerates the text box types. 4164 4165**Since**: 12 4166 4167| Enum| Description| 4168| -------- | -------- | 4169| ARKUI_TEXTAREA_TYPE_NORMAL | Normal input mode. | 4170| ARKUI_TEXTAREA_TYPE_NUMBER | Number input mode. | 4171| ARKUI_TEXTAREA_TYPE_PHONE_NUMBER | Phone number input mode. | 4172| ARKUI_TEXTAREA_TYPE_EMAIL | Email address input mode. | 4173 4174 4175### ArkUI_TextCase 4176 4177``` 4178enum ArkUI_TextCase 4179``` 4180**Description** 4181 4182Defines the enumerated values of text case. 4183 4184**Since**: 12 4185 4186| Enum| Description| 4187| -------- | -------- | 4188| ARKUI_TEXT_CASE_NORMAL | The original case of the text is retained. | 4189| ARKUI_TEXT_CASE_LOWER | All letters in the text are in lowercase. | 4190| ARKUI_TEXT_CASE_UPPER | All letters in the text are in uppercase. | 4191 4192 4193### ArkUI_TextCopyOptions 4194 4195``` 4196enum ArkUI_TextCopyOptions 4197``` 4198**Description** 4199 4200Enumerates copy options, which define whether copy and paste is allowed for text content. 4201 4202**Since**: 12 4203 4204| Enum| Description| 4205| -------- | -------- | 4206| ARKUI_TEXT_COPY_OPTIONS_NONE | Copy is not allowed. | 4207| ARKUI_TEXT_COPY_OPTIONS_IN_APP | Intra-application copy is allowed. | 4208| ARKUI_TEXT_COPY_OPTIONS_LOCAL_DEVICE | Intra-device copy is allowed. | 4209| ARKUI_TEXT_COPY_OPTIONS_CROSS_DEVICE | Cross-device copy is allowed. | 4210 4211 4212### ArkUI_TextDataDetectorType 4213 4214``` 4215enum ArkUI_TextDataDetectorType 4216``` 4217**Description** 4218 4219Enumerates the entity types of text recognition. 4220 4221**Since**: 12 4222 4223| Enum| Description| 4224| -------- | -------- | 4225| ARKUI_TEXT_DATA_DETECTOR_TYPE_PHONE_NUMBER | Phone number. | 4226| ARKUI_TEXT_DATA_DETECTOR_TYPE_URL | Link. | 4227| ARKUI_TEXT_DATA_DETECTOR_TYPE_EMAIL | Email | 4228| ARKUI_TEXT_DATA_DETECTOR_TYPE_ADDRESS | Network address. | 4229 4230 4231### ArkUI_TextDecorationStyle 4232 4233``` 4234enum ArkUI_TextDecorationStyle 4235``` 4236**Description** 4237 4238Enumerates the text decoration styles. 4239 4240**Since**: 12 4241 4242| Enum| Description| 4243| -------- | -------- | 4244| ARKUI_TEXT_DECORATION_STYLE_SOLID | Single solid line. | 4245| ARKUI_TEXT_DECORATION_STYLE_DOUBLE | Double solid line. | 4246| ARKUI_TEXT_DECORATION_STYLE_DOTTED | Dotted line. | 4247| ARKUI_TEXT_DECORATION_STYLE_DASHED | Dashed style. | 4248| ARKUI_TEXT_DECORATION_STYLE_WAVY | Wavy line. | 4249 4250 4251### ArkUI_TextDecorationType 4252 4253``` 4254enum ArkUI_TextDecorationType 4255``` 4256**Description** 4257 4258Enumerates the text decoration types. 4259 4260**Since**: 12 4261 4262| Enum| Description| 4263| -------- | -------- | 4264| ARKUI_TEXT_DECORATION_TYPE_NONE | No text decoration. | 4265| ARKUI_TEXT_DECORATION_TYPE_UNDERLINE | Line under the text. | 4266| ARKUI_TEXT_DECORATION_TYPE_OVERLINE | Line over the text. | 4267| ARKUI_TEXT_DECORATION_TYPE_LINE_THROUGH | Line through the text. | 4268 4269 4270### ArkUI_TextHeightAdaptivePolicy 4271 4272``` 4273enum ArkUI_TextHeightAdaptivePolicy 4274``` 4275**Description** 4276 4277Defines how the adaptive height is determined for the text. 4278 4279**Since**: 12 4280 4281| Enum| Description| 4282| -------- | -------- | 4283| ARKUI_TEXT_HEIGHT_ADAPTIVE_POLICY_MAX_LINES_FIRST | Prioritize the **maxLines** settings. | 4284| ARKUI_TEXT_HEIGHT_ADAPTIVE_POLICY_MIN_FONT_SIZE_FIRST | Prioritize the **minFontSize** settings. | 4285| ARKUI_TEXT_HEIGHT_ADAPTIVE_POLICY_LAYOUT_CONSTRAINT_FIRST | Prioritize the layout constraint settings in terms of height. | 4286 4287 4288### ArkUI_TextInputContentType 4289 4290``` 4291enum ArkUI_TextInputContentType 4292``` 4293**Description** 4294 4295Enumerates the autofill types. 4296 4297**Since**: 12 4298 4299| Enum| Description| 4300| -------- | -------- | 4301| ARKUI_TEXTINPUT_CONTENT_TYPE_USER_NAME | Username. Password Vault, when enabled, can automatically save and fill in usernames. | 4302| ARKUI_TEXTINPUT_CONTENT_TYPE_PASSWORD | Password. Password Vault, when enabled, can automatically save and fill in passwords. | 4303| ARKUI_TEXTINPUT_CONTENT_TYPE_NEW_PASSWORD | New password. Password Vault, when enabled, can automatically generate a new password. | 4304| 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. | 4305| ARKUI_TEXTINPUT_CONTENT_TYPE_HOUSE_NUMBER | House number. The scenario-based autofill feature, when enabled, can automatically save and fill in house numbers. | 4306| 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. | 4307| ARKUI_TEXTINPUT_CONTENT_TYPE_CITY_ADDRESS | City. The scenario-based autofill feature, when enabled, can automatically save and fill in cities. | 4308| ARKUI_TEXTINPUT_CONTENT_TYPE_PROVINCE_ADDRESS | Province. The scenario-based autofill feature, when enabled, can automatically save and fill in provinces. | 4309| ARKUI_TEXTINPUT_CONTENT_TYPE_COUNTRY_ADDRESS | Country. The scenario-based autofill feature, when enabled, can automatically save and fill in countries. | 4310| ARKUI_TEXTINPUT_CONTENT_TYPE_PERSON_FULL_NAME | Full name. The scenario-based autofill feature, when enabled, can automatically save and fill in full names. | 4311| ARKUI_TEXTINPUT_CONTENT_TYPE_PERSON_LAST_NAME | Last name. The scenario-based autofill feature, when enabled, can automatically save and fill in last names. | 4312| ARKUI_TEXTINPUT_CONTENT_TYPE_PERSON_FIRST_NAME | First name. The scenario-based autofill feature, when enabled, can automatically save and fill in first names. | 4313| ARKUI_TEXTINPUT_CONTENT_TYPE_PHONE_NUMBER | Phone number. The scenario-based autofill feature, when enabled, can automatically save and fill in phone numbers. | 4314| ARKUI_TEXTINPUT_CONTENT_TYPE_PHONE_COUNTRY_CODE | Country code. The scenario-based autofill feature, when enabled, can automatically save and fill in country codes. | 4315| 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. | 4316| ARKUI_TEXTINPUT_CONTENT_EMAIL_ADDRESS | Email address. The scenario-based autofill feature, when enabled, can automatically save and fill in email addresses. | 4317| 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. | 4318| 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. | 4319| ARKUI_TEXTINPUT_CONTENT_TYPE_NICKNAME | Nickname. The scenario-based autofill feature, when enabled, can automatically save and fill in nicknames. | 4320| 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. | 4321| ARKUI_TEXTINPUT_CONTENT_TYPE_FORMAT_ADDRESS | Standard address. The scenario-based autofill feature, when enabled, can automatically save and fill in standard addresses. | 4322 4323 4324### ArkUI_TextInputStyle 4325 4326``` 4327enum ArkUI_TextInputStyle 4328``` 4329**Description** 4330 4331Enumerates the text input styles. 4332 4333**Since**: 12 4334 4335| Enum| Description| 4336| -------- | -------- | 4337| 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. | 4338| ARKUI_TEXTINPUT_STYLE_INLINE | Inline input style. The background height of the selected text is the same as the height of the text box. | 4339 4340 4341### ArkUI_TextInputType 4342 4343``` 4344enum ArkUI_TextInputType 4345``` 4346**Description** 4347 4348Enumerates the text input types. 4349 4350**Since**: 12 4351 4352| Enum| Description| 4353| -------- | -------- | 4354| ARKUI_TEXTINPUT_TYPE_NORMAL | Normal input mode. | 4355| ARKUI_TEXTINPUT_TYPE_NUMBER | Number input mode. | 4356| ARKUI_TEXTINPUT_TYPE_PHONE_NUMBER | Phone number input mode. | 4357| ARKUI_TEXTINPUT_TYPE_EMAIL | Email address input mode. | 4358| ARKUI_TEXTINPUT_TYPE_PASSWORD | Password input mode. | 4359| ARKUI_TEXTINPUT_TYPE_NUMBER_PASSWORD | Numeric password input mode. | 4360| ARKUI_TEXTINPUT_TYPE_SCREEN_LOCK_PASSWORD | Lock screen password input mode. | 4361| ARKUI_TEXTINPUT_TYPE_USER_NAME | Username input mode. | 4362| ARKUI_TEXTINPUT_TYPE_NEW_PASSWORD | New password input mode. | 4363| ARKUI_TEXTINPUT_TYPE_NUMBER_DECIMAL | Number input mode with a decimal point. | 4364 4365 4366### ArkUI_TextOverflow 4367 4368``` 4369enum ArkUI_TextOverflow 4370``` 4371**Description** 4372 4373Enumerates the display modes when the text is too long. 4374 4375**Since**: 12 4376 4377| Enum| Description| 4378| -------- | -------- | 4379| ARKUI_TEXT_OVERFLOW_NONE | Extra-long text is not clipped. | 4380| ARKUI_TEXT_OVERFLOW_CLIP | Extra-long text is clipped. | 4381| ARKUI_TEXT_OVERFLOW_ELLIPSIS | An ellipsis (...) is used to represent text overflow. | 4382| ARKUI_TEXT_OVERFLOW_MARQUEE | Text continuously scrolls when text overflow occurs. | 4383 4384 4385### ArkUI_TextPickerRangeType 4386 4387``` 4388enum ArkUI_TextPickerRangeType 4389``` 4390**Description** 4391 4392Enumerates the types of the text picker. 4393 4394**Since**: 12 4395 4396| Enum| Description| 4397| -------- | -------- | 4398| ARKUI_TEXTPICKER_RANGETYPE_SINGLE | Single-column text picker. | 4399| ARKUI_TEXTPICKER_RANGETYPE_MULTI | Multi-column text picker. | 4400| ARKUI_TEXTPICKER_RANGETYPE_RANGE_CONTENT | Single-column text picker with image resources. | 4401| ARKUI_TEXTPICKER_RANGETYPE_CASCADE_RANGE_CONTENT | Interconnected multi-column text picker. | 4402 4403 4404### ArkUI_ThemeColorMode 4405 4406``` 4407enum ArkUI_ThemeColorMode 4408``` 4409 4410| Enum| Description| 4411| -------- | -------- | 4412| ARKUI_THEME_COLOR_MODE_SYSTEM | Following the system color mode. | 4413| ARKUI_THEME_COLOR_MODE_LIGHT | Light color mode. | 4414| ARKUI_THEME_COLOR_MODE_DARK | Dark color mode. | 4415 4416 4417### ArkUI_TransitionEdge 4418 4419``` 4420enum ArkUI_TransitionEdge 4421``` 4422**Description** 4423 4424Enumerates the slide-in and slide-out positions of the component from the screen edge during transition. 4425 4426**Since**: 12 4427 4428| Enum| Description| 4429| -------- | -------- | 4430| ARKUI_TRANSITION_EDGE_TOP | Top edge of the window. | 4431| ARKUI_TRANSITION_EDGE_BOTTOM | Bottom edge of the window. | 4432| ARKUI_TRANSITION_EDGE_START | Left edge of the window. | 4433| ARKUI_TRANSITION_EDGE_END | Right edge of the window. | 4434 4435 4436### ArkUI_VerticalAlignment 4437 4438``` 4439enum ArkUI_VerticalAlignment 4440``` 4441**Description** 4442 4443Enumerates the vertical alignment modes. 4444 4445**Since**: 12 4446 4447| Enum| Description| 4448| -------- | -------- | 4449| ARKUI_VERTICAL_ALIGNMENT_TOP | Top aligned. | 4450| ARKUI_VERTICAL_ALIGNMENT_CENTER | Aligned with the center. This is the default alignment mode. | 4451| ARKUI_VERTICAL_ALIGNMENT_BOTTOM | Bottom aligned. | 4452 4453 4454### ArkUI_Visibility 4455 4456``` 4457enum ArkUI_Visibility 4458``` 4459**Description** 4460 4461Enumerates the visibility values. 4462 4463**Since**: 12 4464 4465| Enum| Description| 4466| -------- | -------- | 4467| ARKUI_VISIBILITY_VISIBLE | Display | 4468| ARKUI_VISIBILITY_HIDDEN | The component is hidden, and a placeholder is used for it in the layout. | 4469| ARKUI_VISIBILITY_NONE | The component is hidden. It is not involved in the layout, and no placeholder is used for it. | 4470 4471 4472### ArkUI_WordBreak 4473 4474``` 4475enum ArkUI_WordBreak 4476``` 4477**Description** 4478 4479Enumerates the word break rules. 4480 4481**Since**: 12 4482 4483| Enum| Description| 4484| -------- | -------- | 4485| 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). | 4486| 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**. | 4487| 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**. | 4488 4489 4490### ArkUI_XComponentType 4491 4492``` 4493enum ArkUI_XComponentType 4494``` 4495**Description** 4496 4497Defines the enumerated values of the XComponent type. 4498 4499**Since**: 12 4500 4501| Enum| Description| 4502| -------- | -------- | 4503| ARKUI_XCOMPONENT_TYPE_SURFACE | The custom content of EGL/OpenGL ES and media data is displayed individually on the screen. | 4504| ARKUI_XCOMPONENT_TYPE_TEXTURE | The custom content of EGL/OpenGL ES and media data is grouped and displayed together with content of the component. | 4505 4506 4507## Function Description 4508 4509 4510### OH_ArkUI_AccessibilityState_Create() 4511 4512``` 4513ArkUI_AccessibilityState* OH_ArkUI_AccessibilityState_Create (void ) 4514``` 4515**Description** 4516 4517Creates an accessibility state. 4518 4519**Since**: 12 4520 4521**Returns** 4522 4523Returns 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. 4524 4525 4526### OH_ArkUI_AccessibilityState_Dispose() 4527 4528``` 4529void OH_ArkUI_AccessibilityState_Dispose (ArkUI_AccessibilityState * state) 4530``` 4531**Description** 4532 4533Disposes of the pointer to an accessibility state. 4534 4535**Since**: 12 4536 4537**Parameters** 4538 4539| Name| Description| 4540| -------- | -------- | 4541| state | Pointer to an accessibility state object. | 4542 4543 4544### OH_ArkUI_AccessibilityState_GetCheckedState() 4545 4546``` 4547int32_t OH_ArkUI_AccessibilityState_GetCheckedState (ArkUI_AccessibilityState * state) 4548``` 4549**Description** 4550 4551Obtains the check box state of an accessibility state. 4552 4553**Since**: 12 4554 4555**Parameters** 4556 4557| Name| Description| 4558| -------- | -------- | 4559| state | Pointer to an accessibility state object. | 4560 4561**Returns** 4562 4563Returns 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. 4564 4565 4566### OH_ArkUI_AccessibilityState_IsDisabled() 4567 4568``` 4569int32_t OH_ArkUI_AccessibilityState_IsDisabled (ArkUI_AccessibilityState * state) 4570``` 4571**Description** 4572 4573Obtains whether an accessibility state is disabled. 4574 4575**Since**: 12 4576 4577**Parameters** 4578 4579| Name| Description| 4580| -------- | -------- | 4581| state | Pointer to an accessibility state object. | 4582 4583**Returns** 4584 4585Returns 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. 4586 4587 4588### OH_ArkUI_AccessibilityState_IsSelected() 4589 4590``` 4591int32_t OH_ArkUI_AccessibilityState_IsSelected (ArkUI_AccessibilityState * state) 4592``` 4593**Description** 4594 4595Obtains whether an accessibility state is selected. 4596 4597**Since**: 12 4598 4599**Parameters** 4600 4601| Name| Description| 4602| -------- | -------- | 4603| state | Pointer to an accessibility state object. | 4604 4605**Returns** 4606 4607Returns 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. 4608 4609 4610### OH_ArkUI_AccessibilityState_SetCheckedState() 4611 4612``` 4613void OH_ArkUI_AccessibilityState_SetCheckedState (ArkUI_AccessibilityState * state, int32_t checkedState ) 4614``` 4615**Description** 4616 4617Sets the check box state of an accessibility state. 4618 4619**Since**: 12 4620 4621**Parameters** 4622 4623| Name| Description| 4624| -------- | -------- | 4625| state | Pointer to an accessibility state object. | 4626| checkedState | Check box status. The parameter type is [ArkUI_AccessibilityCheckedState](#arkui_accessibilitycheckedstate). The default value is **ARKUI_ACCESSIBILITY_UNCHECKED**. | 4627 4628 4629### OH_ArkUI_AccessibilityState_SetDisabled() 4630 4631``` 4632void OH_ArkUI_AccessibilityState_SetDisabled (ArkUI_AccessibilityState * state, int32_t isDisabled ) 4633``` 4634**Description** 4635 4636Sets whether an accessibility state is disabled. 4637 4638**Since**: 12 4639 4640**Parameters** 4641 4642| Name| Description| 4643| -------- | -------- | 4644| state | Pointer to an accessibility state object. | 4645| 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**. | 4646 4647 4648### OH_ArkUI_AccessibilityState_SetSelected() 4649 4650``` 4651void OH_ArkUI_AccessibilityState_SetSelected (ArkUI_AccessibilityState * state, int32_t isSelected ) 4652``` 4653**Description** 4654 4655Sets whether an accessibility state is selected. 4656 4657**Since**: 12 4658 4659**Parameters** 4660 4661| Name| Description| 4662| -------- | -------- | 4663| state | Pointer to an accessibility state object. | 4664| 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**. | 4665 4666 4667### OH_ArkUI_AccessibilityValue_Create() 4668 4669``` 4670ArkUI_AccessibilityValue* OH_ArkUI_AccessibilityValue_Create (void ) 4671``` 4672**Description** 4673 4674Creates an **AccessibilityValue** instance. 4675 4676**Since**: 12 4677 4678**Returns** 4679 4680Returns the pointer to the created **AccessibilityValue** instance. 4681 4682 4683### OH_ArkUI_AccessibilityValue_Dispose() 4684 4685``` 4686void OH_ArkUI_AccessibilityValue_Dispose (ArkUI_AccessibilityValue * value) 4687``` 4688**Description** 4689 4690Disposes of the pointer to an **AccessibilityValue** instance. 4691 4692**Since**: 12 4693 4694**Parameters** 4695 4696| Name| Description| 4697| -------- | -------- | 4698| state | Pointer to an **AccessibilityValue** instance. | 4699 4700 4701### OH_ArkUI_AccessibilityValue_GetCurrent() 4702 4703``` 4704int32_t OH_ArkUI_AccessibilityValue_GetCurrent (ArkUI_AccessibilityValue * value) 4705``` 4706**Description** 4707 4708Obtains the current accessibility value. 4709 4710**Since**: 12 4711 4712**Parameters** 4713 4714| Name| Description| 4715| -------- | -------- | 4716| value | Pointer to an **AccessibilityValue** instance. | 4717 4718**Returns** 4719 4720Returns the current value based on the range component. The default value is **-1**. If a parameter error occurs, **-1** is returned. 4721 4722 4723### OH_ArkUI_AccessibilityValue_GetMax() 4724 4725``` 4726int32_t OH_ArkUI_AccessibilityValue_GetMax (ArkUI_AccessibilityValue * value) 4727``` 4728**Description** 4729 4730Obtains the maximum accessibility value. 4731 4732**Since**: 12 4733 4734**Parameters** 4735 4736| Name| Description| 4737| -------- | -------- | 4738| value | Pointer to an **AccessibilityValue** instance. | 4739 4740**Returns** 4741 4742Returns the maximum value based on the range component. The default value is **-1**. If a parameter error occurs, **-1** is returned. 4743 4744 4745### OH_ArkUI_AccessibilityValue_GetMin() 4746 4747``` 4748int32_t OH_ArkUI_AccessibilityValue_GetMin (ArkUI_AccessibilityValue * value) 4749``` 4750**Description** 4751 4752Obtains the minimum accessibility value. 4753 4754**Since**: 12 4755 4756**Parameters** 4757 4758| Name| Description| 4759| -------- | -------- | 4760| value | Pointer to an **AccessibilityValue** instance. | 4761 4762**Returns** 4763 4764Returns the minimum value based on the range component. The default value is **-1**. If a parameter error occurs, **-1** is returned. 4765 4766 4767### OH_ArkUI_AccessibilityValue_GetText() 4768 4769``` 4770const char* OH_ArkUI_AccessibilityValue_GetText (ArkUI_AccessibilityValue * value) 4771``` 4772**Description** 4773 4774Obtains the text description of an **AccessibilityValue** instance. 4775 4776**Since**: 12 4777 4778**Parameters** 4779 4780| Name| Description| 4781| -------- | -------- | 4782| value | Pointer to an **AccessibilityValue** instance. | 4783 4784**Returns** 4785 4786Returns the text description. The default value is an empty string. If a parameter error occurs, a null pointer is returned. 4787 4788 4789### OH_ArkUI_AccessibilityValue_SetCurrent() 4790 4791``` 4792void OH_ArkUI_AccessibilityValue_SetCurrent (ArkUI_AccessibilityValue * value, int32_t current ) 4793``` 4794**Description** 4795 4796Sets the current accessibility value. 4797 4798**Since**: 12 4799 4800**Parameters** 4801 4802| Name| Description| 4803| -------- | -------- | 4804| value | Pointer to an **AccessibilityValue** instance. | 4805| current | Current value based on the range component. The default value is **-1**. | 4806 4807 4808### OH_ArkUI_AccessibilityValue_SetMax() 4809 4810``` 4811void OH_ArkUI_AccessibilityValue_SetMax (ArkUI_AccessibilityValue * value, int32_t max ) 4812``` 4813**Description** 4814 4815Sets the maximum accessibility value. 4816 4817**Since**: 12 4818 4819**Parameters** 4820 4821| Name| Description| 4822| -------- | -------- | 4823| value | Pointer to an **AccessibilityValue** instance. | 4824| max | Maximum value based on the range component. The default value is **-1**. | 4825 4826 4827### OH_ArkUI_AccessibilityValue_SetMin() 4828 4829``` 4830void OH_ArkUI_AccessibilityValue_SetMin (ArkUI_AccessibilityValue * value, int32_t min ) 4831``` 4832**Description** 4833 4834Sets the minimum accessibility value. 4835 4836**Since**: 12 4837 4838**Parameters** 4839 4840| Name| Description| 4841| -------- | -------- | 4842| value | Pointer to an **AccessibilityValue** instance. | 4843| min | Minimum value based on the range component. The default value is **-1**. | 4844 4845 4846### OH_ArkUI_AccessibilityValue_SetText() 4847 4848``` 4849void OH_ArkUI_AccessibilityValue_SetText (ArkUI_AccessibilityValue * value, const char * text ) 4850``` 4851**Description** 4852 4853Sets the text description of an **AccessibilityValue** instance. 4854 4855**Since**: 12 4856 4857**Parameters** 4858 4859| Name| Description| 4860| -------- | -------- | 4861| value | Pointer to an **AccessibilityValue** instance. | 4862| text | Text description. The default value is an empty string. | 4863 4864 4865### OH_ArkUI_ActiveChildrenInfo_Destroy() 4866 4867``` 4868void OH_ArkUI_ActiveChildrenInfo_Destroy (ArkUI_ActiveChildrenInfo * handle) 4869``` 4870**Description** 4871 4872Destroys an **ActiveChildrenInfo** instance. 4873 4874**Since**: 14 4875 4876**Parameters** 4877 4878| Name| Description| 4879| -------- | -------- | 4880| handle | **ActiveChildrenInfo** instance to destroy. | 4881 4882 4883### OH_ArkUI_ActiveChildrenInfo_GetCount() 4884 4885``` 4886int32_t OH_ArkUI_ActiveChildrenInfo_GetCount (ArkUI_ActiveChildrenInfo * handle) 4887``` 4888**Description** 4889 4890Obtains the number of nodes in the specified **ActiveChildrenInfo** instance. 4891 4892**Since**: 14 4893 4894**Parameters** 4895 4896| Name| Description| 4897| -------- | -------- | 4898| handle | **ActiveChildrenInfo** instance from which to obtain the information. | 4899 4900 4901### OH_ArkUI_ActiveChildrenInfo_GetNodeByIndex() 4902 4903``` 4904ArkUI_NodeHandle OH_ArkUI_ActiveChildrenInfo_GetNodeByIndex (ArkUI_ActiveChildrenInfo * handle, int32_t index ) 4905``` 4906**Description** 4907 4908Obtains the child node at the specified index in the specified **ActiveChildrenInfo** instance. 4909 4910**Since**: 14 4911 4912**Parameters** 4913 4914| Name| Description| 4915| -------- | -------- | 4916| handle | **ActiveChildrenInfo** instance from which to obtain the information. | 4917 4918 4919### OH_ArkUI_AlignmentRuleOption_Create() 4920 4921``` 4922ArkUI_AlignmentRuleOption* OH_ArkUI_AlignmentRuleOption_Create () 4923``` 4924**Description** 4925 4926Creates an alignment rule configuration for this **RelativeContainer** component. 4927 4928**Since**: 12 4929 4930**Returns** 4931 4932Alignment rule information. 4933 4934 4935### OH_ArkUI_AlignmentRuleOption_Dispose() 4936 4937``` 4938void OH_ArkUI_AlignmentRuleOption_Dispose (ArkUI_AlignmentRuleOption * option) 4939``` 4940**Description** 4941 4942Disposes of an alignment rule configuration of this **RelativeContainer** component. 4943 4944**Since**: 12 4945 4946**Parameters** 4947 4948| Name| Description| 4949| -------- | -------- | 4950| option | Pointer to an alignment rule configuration. | 4951 4952 4953### OH_ArkUI_AlignmentRuleOption_GetBiasHorizontal() 4954 4955``` 4956float OH_ArkUI_AlignmentRuleOption_GetBiasHorizontal (ArkUI_AlignmentRuleOption * option) 4957``` 4958**Description** 4959 4960Obtains the bias value in the horizontal direction. 4961 4962**Since**: 12 4963 4964**Parameters** 4965 4966| Name| Description| 4967| -------- | -------- | 4968| option | Pointer to an alignment rule configuration. | 4969 4970**Returns** 4971 4972Bias value in the horizontal direction. 4973 4974 4975### OH_ArkUI_AlignmentRuleOption_GetBiasVertical() 4976 4977``` 4978float OH_ArkUI_AlignmentRuleOption_GetBiasVertical (ArkUI_AlignmentRuleOption * option) 4979``` 4980**Description** 4981 4982Obtains the bias value in the vertical direction. 4983 4984**Since**: 12 4985 4986**Parameters** 4987 4988| Name| Description| 4989| -------- | -------- | 4990| option | Pointer to an alignment rule configuration. | 4991 4992**Returns** 4993 4994Returns the bias value in the vertical direction. 4995 4996 4997### OH_ArkUI_AlignmentRuleOption_GetBottomAlignment() 4998 4999``` 5000ArkUI_VerticalAlignment OH_ArkUI_AlignmentRuleOption_GetBottomAlignment (ArkUI_AlignmentRuleOption * option) 5001``` 5002**Description** 5003 5004Obtains the alignment mode in bottom alignment parameters. 5005 5006**Since**: 12 5007 5008**Parameters** 5009 5010| Name| Description| 5011| -------- | -------- | 5012| option | Pointer to an alignment rule configuration. | 5013 5014**Returns** 5015 5016Returns the alignment mode in bottom alignment parameters. 5017 5018 5019### OH_ArkUI_AlignmentRuleOption_GetBottomId() 5020 5021``` 5022const char* OH_ArkUI_AlignmentRuleOption_GetBottomId (ArkUI_AlignmentRuleOption * option) 5023``` 5024**Description** 5025 5026Obtains the ID in bottom alignment parameters. 5027 5028**Since**: 12 5029 5030**Parameters** 5031 5032| Name| Description| 5033| -------- | -------- | 5034| option | Pointer to an alignment rule configuration. | 5035 5036**Returns** 5037 5038Returns the ID in bottom alignment parameters. 5039 5040 5041### OH_ArkUI_AlignmentRuleOption_GetCenterAlignmentHorizontal() 5042 5043``` 5044ArkUI_HorizontalAlignment OH_ArkUI_AlignmentRuleOption_GetCenterAlignmentHorizontal (ArkUI_AlignmentRuleOption * option) 5045``` 5046**Description** 5047 5048Obtains the alignment mode in horizontal center alignment parameters. 5049 5050**Since**: 12 5051 5052**Parameters** 5053 5054| Name| Description| 5055| -------- | -------- | 5056| option | Pointer to an alignment rule configuration. | 5057 5058**Returns** 5059 5060Returns the alignment mode in horizontal center alignment parameters. 5061 5062### OH_ArkUI_AlignmentRuleOption_GetCenterAlignmentVertical() 5063 5064``` 5065ArkUI_VerticalAlignment OH_ArkUI_AlignmentRuleOption_GetCenterAlignmentVertical (ArkUI_AlignmentRuleOption * option) 5066``` 5067**Description** 5068 5069Obtains the alignment mode in vertical center alignment parameters. 5070 5071**Since**: 12 5072 5073**Parameters** 5074 5075| Name| Description| 5076| -------- | -------- | 5077| option | Pointer to an alignment rule configuration. | 5078 5079**Returns** 5080 5081Returns the alignment mode in vertical center alignment parameters. 5082 5083 5084### OH_ArkUI_AlignmentRuleOption_GetCenterIdHorizontal() 5085 5086``` 5087const char* OH_ArkUI_AlignmentRuleOption_GetCenterIdHorizontal (ArkUI_AlignmentRuleOption * option) 5088``` 5089**Description** 5090 5091Obtains the alignment mode in horizontal center alignment parameters. 5092 5093**Since**: 12 5094 5095**Parameters** 5096 5097| Name| Description| 5098| -------- | -------- | 5099| option | Pointer to an alignment rule configuration. | 5100 5101**Returns** 5102 5103Returns the alignment mode in horizontal center alignment parameters. 5104 5105 5106### OH_ArkUI_AlignmentRuleOption_GetCenterIdVertical() 5107 5108``` 5109const char* OH_ArkUI_AlignmentRuleOption_GetCenterIdVertical (ArkUI_AlignmentRuleOption * option) 5110``` 5111**Description** 5112 5113Obtains the ID in vertical center alignment parameters. 5114 5115**Since**: 12 5116 5117**Parameters** 5118 5119| Name| Description| 5120| -------- | -------- | 5121| option | Pointer to an alignment rule configuration. | 5122 5123**Returns** 5124 5125Returns the ID in vertical center alignment parameters. 5126 5127 5128### OH_ArkUI_AlignmentRuleOption_GetEndAlignment() 5129 5130``` 5131ArkUI_HorizontalAlignment OH_ArkUI_AlignmentRuleOption_GetEndAlignment (ArkUI_AlignmentRuleOption * option) 5132``` 5133**Description** 5134 5135Obtains the alignment mode in the right alignment parameters. 5136 5137**Since**: 12 5138 5139**Parameters** 5140 5141| Name| Description| 5142| -------- | -------- | 5143| option | Pointer to an alignment rule configuration. | 5144 5145**Returns** 5146 5147Returns the alignment mode in the right alignment parameters. 5148 5149 5150### OH_ArkUI_AlignmentRuleOption_GetEndId() 5151 5152``` 5153const char* OH_ArkUI_AlignmentRuleOption_GetEndId (ArkUI_AlignmentRuleOption * option) 5154``` 5155**Description** 5156 5157Obtains the ID in the right alignment parameters. 5158 5159**Since**: 12 5160 5161**Parameters** 5162 5163| Name| Description| 5164| -------- | -------- | 5165| option | Pointer to an alignment rule configuration. | 5166 5167**Returns** 5168 5169Returns the ID in the right alignment parameters. 5170 5171 5172### OH_ArkUI_AlignmentRuleOption_GetStartAlignment() 5173 5174``` 5175ArkUI_HorizontalAlignment OH_ArkUI_AlignmentRuleOption_GetStartAlignment (ArkUI_AlignmentRuleOption * option) 5176``` 5177**Description** 5178 5179Obtains the alignment mode in left alignment parameters. 5180 5181**Since**: 12 5182 5183**Parameters** 5184 5185| Name| Description| 5186| -------- | -------- | 5187| option | Pointer to an alignment rule configuration. | 5188 5189**Returns** 5190 5191Returns the alignment mode in left alignment parameters. 5192 5193 5194### OH_ArkUI_AlignmentRuleOption_GetStartId() 5195 5196``` 5197const char* OH_ArkUI_AlignmentRuleOption_GetStartId (ArkUI_AlignmentRuleOption * option) 5198``` 5199**Description** 5200 5201Obtains the ID in the left alignment parameters. 5202 5203**Since**: 12 5204 5205**Parameters** 5206 5207| Name| Description| 5208| -------- | -------- | 5209| option | Pointer to an alignment rule configuration. | 5210 5211**Returns** 5212 5213Returns the ID in left alignment parameters. 5214 5215 5216### OH_ArkUI_AlignmentRuleOption_GetTopAlignment() 5217 5218``` 5219ArkUI_VerticalAlignment OH_ArkUI_AlignmentRuleOption_GetTopAlignment (ArkUI_AlignmentRuleOption * option) 5220``` 5221**Description** 5222 5223Obtains the alignment mode in top alignment parameters. 5224 5225**Since**: 12 5226 5227**Parameters** 5228 5229| Name| Description| 5230| -------- | -------- | 5231| option | Pointer to an alignment rule configuration. | 5232 5233**Returns** 5234 5235Returns the alignment mode in top alignment parameters. 5236 5237 5238### OH_ArkUI_AlignmentRuleOption_GetTopId() 5239 5240``` 5241const char* OH_ArkUI_AlignmentRuleOption_GetTopId (ArkUI_AlignmentRuleOption * option) 5242``` 5243**Description** 5244 5245Obtains the ID in top alignment parameters. 5246 5247**Since**: 12 5248 5249**Parameters** 5250 5251| Name| Description| 5252| -------- | -------- | 5253| option | Pointer to an alignment rule configuration. | 5254 5255**Returns** 5256 5257Returns the ID in top alignment parameters. 5258 5259 5260### OH_ArkUI_AlignmentRuleOption_SetBiasHorizontal() 5261 5262``` 5263void OH_ArkUI_AlignmentRuleOption_SetBiasHorizontal (ArkUI_AlignmentRuleOption * option, float horizontal ) 5264``` 5265**Description** 5266 5267Sets the bias value of the component in the horizontal direction under the anchor constraints. 5268 5269**Since**: 12 5270 5271**Parameters** 5272 5273| Name| Description| 5274| -------- | -------- | 5275| option | Pointer to an alignment rule configuration. | 5276| horizontal | Bias value in the horizontal direction. | 5277 5278 5279### OH_ArkUI_AlignmentRuleOption_SetBiasVertical() 5280 5281``` 5282void OH_ArkUI_AlignmentRuleOption_SetBiasVertical (ArkUI_AlignmentRuleOption * option, float vertical ) 5283``` 5284**Description** 5285 5286Sets the bias value of the component in the vertical direction under the anchor constraints. 5287 5288**Since**: 12 5289 5290**Parameters** 5291 5292| Name| Description| 5293| -------- | -------- | 5294| option | Pointer to an alignment rule configuration. | 5295| horizontal | Bias value in the vertical direction. | 5296 5297 5298### OH_ArkUI_AlignmentRuleOption_SetBottom() 5299 5300``` 5301void OH_ArkUI_AlignmentRuleOption_SetBottom (ArkUI_AlignmentRuleOption * option, const char * id, ArkUI_VerticalAlignment alignment ) 5302``` 5303**Description** 5304 5305Sets the bottom alignment parameters. 5306 5307**Since**: 12 5308 5309**Parameters** 5310 5311| Name| Description| 5312| -------- | -------- | 5313| option | Pointer to an alignment rule configuration. | 5314| id | ID of the anchor component. | 5315| value | Alignment mode relative to the anchor component. | 5316 5317 5318### OH_ArkUI_AlignmentRuleOption_SetCenterHorizontal() 5319 5320``` 5321void OH_ArkUI_AlignmentRuleOption_SetCenterHorizontal (ArkUI_AlignmentRuleOption * option, const char * id, ArkUI_HorizontalAlignment alignment ) 5322``` 5323**Description** 5324 5325Sets the horizontal center alignment parameters. 5326 5327**Since**: 12 5328 5329**Parameters** 5330 5331| Name| Description| 5332| -------- | -------- | 5333| option | Pointer to an alignment rule configuration. | 5334| id | ID of the anchor component. | 5335| value | Alignment mode relative to the anchor component. | 5336 5337 5338### OH_ArkUI_AlignmentRuleOption_SetCenterVertical() 5339 5340``` 5341void OH_ArkUI_AlignmentRuleOption_SetCenterVertical (ArkUI_AlignmentRuleOption * option, const char * id, ArkUI_VerticalAlignment alignment ) 5342``` 5343**Description** 5344 5345Sets the vertical center alignment parameters. 5346 5347**Since**: 12 5348 5349**Parameters** 5350 5351| Name| Description| 5352| -------- | -------- | 5353| option | Pointer to an alignment rule configuration. | 5354| id | ID of the anchor component. | 5355| value | Alignment mode relative to the anchor component. | 5356 5357 5358### OH_ArkUI_AlignmentRuleOption_SetEnd() 5359 5360``` 5361void OH_ArkUI_AlignmentRuleOption_SetEnd (ArkUI_AlignmentRuleOption * option, const char * id, ArkUI_HorizontalAlignment alignment ) 5362``` 5363**Description** 5364 5365Sets the right alignment parameters. 5366 5367**Since**: 12 5368 5369**Parameters** 5370 5371| Name| Description| 5372| -------- | -------- | 5373| option | Pointer to an alignment rule configuration. | 5374| id | ID of the anchor component. | 5375| value | Alignment mode relative to the anchor component. | 5376 5377 5378### OH_ArkUI_AlignmentRuleOption_SetStart() 5379 5380``` 5381void OH_ArkUI_AlignmentRuleOption_SetStart (ArkUI_AlignmentRuleOption * option, const char * id, ArkUI_HorizontalAlignment alignment ) 5382``` 5383**Description** 5384 5385Sets the left alignment parameters. 5386 5387**Since**: 12 5388 5389**Parameters** 5390 5391| Name| Description| 5392| -------- | -------- | 5393| option | Pointer to an alignment rule configuration. | 5394| id | ID of the anchor component. | 5395| value | Alignment mode relative to the anchor component. | 5396 5397 5398### OH_ArkUI_AlignmentRuleOption_SetTop() 5399 5400``` 5401void OH_ArkUI_AlignmentRuleOption_SetTop (ArkUI_AlignmentRuleOption * option, const char * id, ArkUI_VerticalAlignment alignment ) 5402``` 5403**Description** 5404 5405Sets the top alignment parameters. 5406 5407**Since**: 12 5408 5409**Parameters** 5410 5411| Name| Description| 5412| -------- | -------- | 5413| option | Pointer to an alignment rule configuration. | 5414| id | ID of the anchor component. | 5415| value | Alignment mode relative to the anchor component. | 5416 5417 5418### OH_ArkUI_AllowNodeAllDropDataTypes() 5419 5420``` 5421int32_t OH_ArkUI_AllowNodeAllDropDataTypes (ArkUI_NodeHandle node) 5422``` 5423**Description** 5424 5425Configures the specified component to allow any data types. This API resets the settings configured through [OH_ArkUI_SetNodeAllowedDropDataTypes](#oh_arkui_setnodealloweddropdatatypes). 5426 5427**Since**: 12 5428 5429**Parameters** 5430 5431| Name| Description| 5432| -------- | -------- | 5433| node | Pointer to a component node. | 5434 5435**Returns** 5436 5437Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 5438 5439 5440### OH_ArkUI_AnimateOption_Create() 5441 5442``` 5443ArkUI_AnimateOption* OH_ArkUI_AnimateOption_Create () 5444``` 5445**Description** 5446 5447Creates an animation configuration. 5448 5449**Since**: 12 5450 5451**Returns** 5452 5453Returns the pointer to the created animation configuration. 5454 5455 5456### OH_ArkUI_AnimateOption_Dispose() 5457 5458``` 5459void OH_ArkUI_AnimateOption_Dispose (ArkUI_AnimateOption * option) 5460``` 5461**Description** 5462 5463Disposes of an animation configuration. 5464 5465**Since**: 12 5466 5467 5468### OH_ArkUI_AnimateOption_GetCurve() 5469 5470``` 5471ArkUI_AnimationCurve OH_ArkUI_AnimateOption_GetCurve (ArkUI_AnimateOption * option) 5472``` 5473**Description** 5474 5475Obtains an animation curve. 5476 5477**Since**: 12 5478 5479**Parameters** 5480 5481| Name| Description| 5482| -------- | -------- | 5483| option | Pointer to an animation configuration. | 5484 5485**Returns** 5486 5487Returns the animation curve. 5488 5489 5490### OH_ArkUI_AnimateOption_GetDelay() 5491 5492``` 5493int32_t OH_ArkUI_AnimateOption_GetDelay (ArkUI_AnimateOption * option) 5494``` 5495**Description** 5496 5497Obtains the animation delay, in milliseconds. 5498 5499**Since**: 12 5500 5501**Parameters** 5502 5503| Name| Description| 5504| -------- | -------- | 5505| option | Pointer to an animation configuration. | 5506 5507**Returns** 5508 5509Returns the animation delay. 5510 5511 5512### OH_ArkUI_AnimateOption_GetDuration() 5513 5514``` 5515int32_t OH_ArkUI_AnimateOption_GetDuration (ArkUI_AnimateOption * option) 5516``` 5517**Description** 5518 5519Obtains the animation duration, in milliseconds. 5520 5521**Since**: 12 5522 5523**Parameters** 5524 5525| Name| Description| 5526| -------- | -------- | 5527| option | Pointer to an animation configuration. | 5528 5529**Returns** 5530 5531Returns the animation duration. 5532 5533 5534### OH_ArkUI_AnimateOption_GetExpectedFrameRateRange() 5535 5536``` 5537ArkUI_ExpectedFrameRateRange* OH_ArkUI_AnimateOption_GetExpectedFrameRateRange (ArkUI_AnimateOption * option) 5538``` 5539**Description** 5540 5541Obtains the expected frame rate range of an animation. 5542 5543**Since**: 12 5544 5545**Parameters** 5546 5547| Name| Description| 5548| -------- | -------- | 5549| option | Pointer to an animation configuration. | 5550 5551**Returns** 5552 5553Returns the expected frame rate range. 5554 5555 5556### OH_ArkUI_AnimateOption_GetICurve() 5557 5558``` 5559ArkUI_CurveHandle OH_ArkUI_AnimateOption_GetICurve (ArkUI_AnimateOption * option) 5560``` 5561**Description** 5562 5563Obtains the animation curve of an animation. 5564 5565**Since**: 12 5566 5567**Parameters** 5568 5569| Name| Description| 5570| -------- | -------- | 5571| option | Pointer to an animation configuration. | 5572 5573**Returns** 5574 5575Returns the animation curve of the specified animation. 5576 5577 5578### OH_ArkUI_AnimateOption_GetIterations() 5579 5580``` 5581int32_t OH_ArkUI_AnimateOption_GetIterations (ArkUI_AnimateOption * option) 5582``` 5583**Description** 5584 5585Obtains the number of times that an animation is played. 5586 5587**Since**: 12 5588 5589**Parameters** 5590 5591| Name| Description| 5592| -------- | -------- | 5593| option | Pointer to an animation configuration. | 5594 5595**Returns** 5596 5597Returns the number of times that the animation is played. 5598 5599 5600### OH_ArkUI_AnimateOption_GetPlayMode() 5601 5602``` 5603ArkUI_AnimationPlayMode OH_ArkUI_AnimateOption_GetPlayMode (ArkUI_AnimateOption * option) 5604``` 5605**Description** 5606 5607Obtains the playback mode of an animation. 5608 5609**Since**: 12 5610 5611**Parameters** 5612 5613| Name| Description| 5614| -------- | -------- | 5615| option | Pointer to an animation configuration. | 5616 5617**Returns** 5618 5619Returns the animation playback mode. 5620 5621 5622### OH_ArkUI_AnimateOption_GetTempo() 5623 5624``` 5625float OH_ArkUI_AnimateOption_GetTempo (ArkUI_AnimateOption * option) 5626``` 5627**Description** 5628 5629Obtains the playback speed of an animation. 5630 5631**Since**: 12 5632 5633**Parameters** 5634 5635| Name| Description| 5636| -------- | -------- | 5637| option | Pointer to an animation configuration. | 5638 5639**Returns** 5640 5641Animation playback speed. 5642 5643 5644### OH_ArkUI_AnimateOption_SetCurve() 5645 5646``` 5647void OH_ArkUI_AnimateOption_SetCurve (ArkUI_AnimateOption * option, ArkUI_AnimationCurve value ) 5648``` 5649**Description** 5650 5651Sets the animation curve. 5652 5653**Since**: 12 5654 5655**Parameters** 5656 5657| Name| Description| 5658| -------- | -------- | 5659| option | Pointer to an animation configuration. | 5660| value | Animation curve. Default value: **ARKUI_CURVE_LINEAR**. | 5661 5662 5663### OH_ArkUI_AnimateOption_SetDelay() 5664 5665``` 5666void OH_ArkUI_AnimateOption_SetDelay (ArkUI_AnimateOption * option, int32_t value ) 5667``` 5668**Description** 5669 5670Sets the animation delay. 5671 5672**Since**: 12 5673 5674**Parameters** 5675 5676| Name| Description| 5677| -------- | -------- | 5678| option | Pointer to an animation configuration. | 5679| value | Delay of animation playback. | 5680 5681 5682### OH_ArkUI_AnimateOption_SetDuration() 5683 5684``` 5685void OH_ArkUI_AnimateOption_SetDuration (ArkUI_AnimateOption * option, int32_t value ) 5686``` 5687**Description** 5688 5689Sets the animation duration. 5690 5691**Since**: 12 5692 5693**Parameters** 5694 5695| Name| Description| 5696| -------- | -------- | 5697| option | Pointer to an animation configuration. | 5698| value | Duration, in milliseconds. | 5699 5700 5701### OH_ArkUI_AnimateOption_SetExpectedFrameRateRange() 5702 5703``` 5704void OH_ArkUI_AnimateOption_SetExpectedFrameRateRange (ArkUI_AnimateOption * option, ArkUI_ExpectedFrameRateRange * value ) 5705``` 5706**Description** 5707 5708Sets the expected frame rate range of the animation. 5709 5710**Since**: 12 5711 5712**Parameters** 5713 5714| Name| Description| 5715| -------- | -------- | 5716| option | Pointer to an animation configuration. | 5717| value | Expected frame rate range of the animation. | 5718 5719 5720### OH_ArkUI_AnimateOption_SetICurve() 5721 5722``` 5723void OH_ArkUI_AnimateOption_SetICurve (ArkUI_AnimateOption * option, ArkUI_CurveHandle value ) 5724``` 5725**Description** 5726 5727Sets the animation curve for an animation. 5728 5729**Since**: 12 5730 5731**Parameters** 5732 5733| Name| Description| 5734| -------- | -------- | 5735| option | Pointer to an animation configuration. | 5736| value | Animation curve settings. | 5737 5738**NOTE** 5739 5740This API is preferred over the value set by **OH_ArkUI_AnimateOption_SetCurve**. 5741 5742 5743### OH_ArkUI_AnimateOption_SetIterations() 5744 5745``` 5746void OH_ArkUI_AnimateOption_SetIterations (ArkUI_AnimateOption * option, int32_t value ) 5747``` 5748**Description** 5749 5750Sets the number of times that an animation is played. 5751 5752**Since**: 12 5753 5754**Parameters** 5755 5756| Name| Description| 5757| -------- | -------- | 5758| option | Pointer to an animation configuration. | 5759| value | Number of times that the animation is played. | 5760 5761 5762### OH_ArkUI_AnimateOption_SetPlayMode() 5763 5764``` 5765void OH_ArkUI_AnimateOption_SetPlayMode (ArkUI_AnimateOption * option, ArkUI_AnimationPlayMode value ) 5766``` 5767**Description** 5768 5769Sets the playback mode for an animation. 5770 5771**Since**: 12 5772 5773**Parameters** 5774 5775| Name| Description| 5776| -------- | -------- | 5777| option | Pointer to an animation configuration. | 5778| value | Animation playback mode. | 5779 5780 5781### OH_ArkUI_AnimateOption_SetTempo() 5782 5783``` 5784void OH_ArkUI_AnimateOption_SetTempo (ArkUI_AnimateOption * option, float value ) 5785``` 5786**Description** 5787 5788Sets the playback speed of an animation. 5789 5790**Since**: 12 5791 5792**Parameters** 5793 5794| Name| Description| 5795| -------- | -------- | 5796| option | Pointer to an animation configuration. | 5797| value | Animation playback speed. | 5798 5799 5800### OH_ArkUI_Animator_Cancel() 5801 5802``` 5803int32_t OH_ArkUI_Animator_Cancel (ArkUI_AnimatorHandle animator) 5804``` 5805**Description** 5806 5807Cancels the animation of an animator. 5808 5809**Parameters** 5810 5811| Name| Description| 5812| -------- | -------- | 5813| animator | Animator object. | 5814 5815**Returns** 5816 5817Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 5818 5819 5820### OH_ArkUI_Animator_Finish() 5821 5822``` 5823int32_t OH_ArkUI_Animator_Finish (ArkUI_AnimatorHandle animator) 5824``` 5825**Description** 5826 5827Ends the animation of an animator. 5828 5829**Parameters** 5830 5831| Name| Description| 5832| -------- | -------- | 5833| animator | Animator object. | 5834 5835**Returns** 5836 5837Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 5838 5839 5840### OH_ArkUI_Animator_Pause() 5841 5842``` 5843int32_t OH_ArkUI_Animator_Pause (ArkUI_AnimatorHandle animator) 5844``` 5845**Description** 5846 5847Pauses the animation of an animator. 5848 5849**Parameters** 5850 5851| Name| Description| 5852| -------- | -------- | 5853| animator | Animator object. | 5854 5855**Returns** 5856 5857Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 5858 5859 5860### OH_ArkUI_Animator_Play() 5861 5862``` 5863int32_t OH_ArkUI_Animator_Play (ArkUI_AnimatorHandle animator) 5864``` 5865**Description** 5866 5867Starts the animation of an animator. 5868 5869**Parameters** 5870 5871| Name| Description| 5872| -------- | -------- | 5873| animator | Animator object. | 5874 5875**Returns** 5876 5877Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 5878 5879 5880### OH_ArkUI_Animator_ResetAnimatorOption() 5881 5882``` 5883int32_t OH_ArkUI_Animator_ResetAnimatorOption (ArkUI_AnimatorHandle animator, ArkUI_AnimatorOption * option ) 5884``` 5885**Description** 5886 5887Resets an animator configuration. 5888 5889**Parameters** 5890 5891| Name| Description| 5892| -------- | -------- | 5893| animator | Animator object. | 5894| option | Pointer to an animation configuration. | 5895 5896**Returns** 5897 5898Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 5899 5900 5901### OH_ArkUI_Animator_Reverse() 5902 5903``` 5904int32_t OH_ArkUI_Animator_Reverse (ArkUI_AnimatorHandle animator) 5905``` 5906**Description** 5907 5908Plays the animation of an animator in reverse order. 5909 5910**Parameters** 5911 5912| Name| Description| 5913| -------- | -------- | 5914| animator | Animator object. | 5915 5916**Returns** 5917 5918Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 5919 5920 5921### OH_ArkUI_AnimatorEvent_GetUserData() 5922 5923``` 5924void* OH_ArkUI_AnimatorEvent_GetUserData (ArkUI_AnimatorEvent * event) 5925``` 5926**Description** 5927 5928Obtains the custom object in an animation event object. 5929 5930**Since**: 12 5931 5932**Parameters** 5933 5934| Name| Description| 5935| -------- | -------- | 5936| event | Animation event object. | 5937 5938**Returns** 5939 5940Returns the custom object. 5941 5942 5943### OH_ArkUI_AnimatorOnFrameEvent_GetUserData() 5944 5945``` 5946void* OH_ArkUI_AnimatorOnFrameEvent_GetUserData (ArkUI_AnimatorOnFrameEvent * event) 5947``` 5948**Description** 5949 5950Obtains the custom object in an animation event object. 5951 5952**Since**: 12 5953 5954**Parameters** 5955 5956| Name| Description| 5957| -------- | -------- | 5958| event | Animation event object. | 5959 5960**Returns** 5961 5962Returns the custom object. 5963 5964 5965### OH_ArkUI_AnimatorOnFrameEvent_GetValue() 5966 5967``` 5968float OH_ArkUI_AnimatorOnFrameEvent_GetValue (ArkUI_AnimatorOnFrameEvent * event) 5969``` 5970**Description** 5971 5972Obtains the current progress in an animation event object. 5973 5974**Since**: 12 5975 5976**Parameters** 5977 5978| Name| Description| 5979| -------- | -------- | 5980| event | Animation event object. | 5981 5982**Returns** 5983 5984Returns the animation progress. 5985 5986 5987### OH_ArkUI_AnimatorOption_Create() 5988 5989``` 5990ArkUI_AnimatorOption* OH_ArkUI_AnimatorOption_Create (int32_t keyframeSize) 5991``` 5992**Description** 5993 5994Creates an animator parameter object. 5995 5996**Since**: 12 5997 5998**Parameters** 5999 6000| Name| Description| 6001| -------- | -------- | 6002| keyframeSize | Number of keyframes. | 6003 6004**NOTE** 6005 6006If 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. 6007 6008**Returns** 6009 6010Returns the pointer to the animator parameter object. 6011 6012 6013### OH_ArkUI_AnimatorOption_Dispose() 6014 6015``` 6016void OH_ArkUI_AnimatorOption_Dispose (ArkUI_AnimatorOption * option) 6017``` 6018**Description** 6019 6020Disposes of an **AnimatorOption** object. 6021 6022**Since**: 12 6023 6024 6025### OH_ArkUI_AnimatorOption_GetBegin() 6026 6027``` 6028float OH_ArkUI_AnimatorOption_GetBegin (ArkUI_AnimatorOption * option) 6029``` 6030**Description** 6031 6032Obtains the interpolation start point of an animation. 6033 6034**Since**: 12 6035 6036**Parameters** 6037 6038| Name| Description| 6039| -------- | -------- | 6040| option | Pointer to an animation configuration. | 6041 6042**Returns** 6043 6044Returns the start point of the animation interpolation. 6045 6046 6047### OH_ArkUI_AnimatorOption_GetCurve() 6048 6049``` 6050ArkUI_CurveHandle OH_ArkUI_AnimatorOption_GetCurve (ArkUI_AnimatorOption * option) 6051``` 6052**Description** 6053 6054Obtains the interpolation curve of the animation of an animator. 6055 6056**Since**: 12 6057 6058**Parameters** 6059 6060| Name| Description| 6061| -------- | -------- | 6062| option | Pointer to an animation configuration. | 6063 6064**Returns** 6065 6066Returns the interpolation curve of the animation. 6067 6068 6069### OH_ArkUI_AnimatorOption_GetDelay() 6070 6071``` 6072int32_t OH_ArkUI_AnimatorOption_GetDelay (ArkUI_AnimatorOption * option) 6073``` 6074**Description** 6075 6076Obtains the delay for playing an animation. 6077 6078**Since**: 12 6079 6080**Parameters** 6081 6082| Name| Description| 6083| -------- | -------- | 6084| option | Pointer to an animation configuration. | 6085 6086**Returns** 6087 6088Returns the delay for playing the animation, in milliseconds. 6089 6090 6091### OH_ArkUI_AnimatorOption_GetDirection() 6092 6093``` 6094ArkUI_AnimationDirection OH_ArkUI_AnimatorOption_GetDirection (ArkUI_AnimatorOption * option) 6095``` 6096**Description** 6097 6098Obtains the playback direction of an animation. 6099 6100**Since**: 12 6101 6102**Parameters** 6103 6104| Name| Description| 6105| -------- | -------- | 6106| option | Pointer to an animation configuration. | 6107 6108**Returns** 6109 6110Returns the animation playback direction. 6111 6112 6113### OH_ArkUI_AnimatorOption_GetDuration() 6114 6115``` 6116int32_t OH_ArkUI_AnimatorOption_GetDuration (ArkUI_AnimatorOption * option) 6117``` 6118**Description** 6119 6120Obtains the duration for playing an animation. 6121 6122**Since**: 12 6123 6124**Parameters** 6125 6126| Name| Description| 6127| -------- | -------- | 6128| option | Pointer to an animation configuration. | 6129 6130**Returns** 6131 6132Returns the duration for playing the animation, in milliseconds. 6133 6134 6135### OH_ArkUI_AnimatorOption_GetEnd() 6136 6137``` 6138float OH_ArkUI_AnimatorOption_GetEnd (ArkUI_AnimatorOption * option) 6139``` 6140**Description** 6141 6142Obtains the interpolation end point of an animation. 6143 6144**Since**: 12 6145 6146**Parameters** 6147 6148| Name| Description| 6149| -------- | -------- | 6150| option | Pointer to an animation configuration. | 6151 6152**Returns** 6153 6154Returns the interpolation end point of the animation. 6155 6156 6157### OH_ArkUI_AnimatorOption_GetExpectedFrameRateRange() 6158 6159``` 6160ArkUI_ExpectedFrameRateRange* OH_ArkUI_AnimatorOption_GetExpectedFrameRateRange (ArkUI_AnimatorOption * option) 6161``` 6162**Description** 6163 6164Obtains the expected frame rate range of an animation. 6165 6166**Since**: 12 6167 6168**Parameters** 6169 6170| Name| Description| 6171| -------- | -------- | 6172| option | Pointer to an animation configuration. | 6173 6174**Returns** 6175 6176Returns the pointer to the expected frame rate range object. 6177 6178 6179### OH_ArkUI_AnimatorOption_GetFill() 6180 6181``` 6182ArkUI_AnimationFill OH_ArkUI_AnimatorOption_GetFill (ArkUI_AnimatorOption * option) 6183``` 6184**Description** 6185 6186Obtains whether the animator animation is restored to the initial state after being executed. 6187 6188**Since**: 12 6189 6190**Parameters** 6191 6192| Name| Description| 6193| -------- | -------- | 6194| option | Pointer to an animation configuration. | 6195 6196**Returns** 6197 6198Returns whether the animator animation is restored to the initial state after being executed. 6199 6200 6201### OH_ArkUI_AnimatorOption_GetIterations() 6202 6203``` 6204int32_t OH_ArkUI_AnimatorOption_GetIterations (ArkUI_AnimatorOption * option) 6205``` 6206**Description** 6207 6208Obtains the number of times that an animation is played. 6209 6210**Since**: 12 6211 6212**Parameters** 6213 6214| Name| Description| 6215| -------- | -------- | 6216| option | Pointer to an **AnimatorOption** object. | 6217 6218**Returns** 6219 6220Number of times that the animation is played. 6221 6222### OH_ArkUI_AnimatorOption_GetKeyframeCurve() 6223 6224``` 6225ArkUI_CurveHandle OH_ArkUI_AnimatorOption_GetKeyframeCurve (ArkUI_AnimatorOption * option, int32_t index ) 6226``` 6227**Description** 6228 6229Obtains the interpolation curve for a keyframe in the animation of an animator. 6230 6231**Since**: 12 6232 6233**Parameters** 6234 6235| Name| Description| 6236| -------- | -------- | 6237| option | Pointer to an **AnimatorOption** object. | 6238| index | Keyframe index. | 6239 6240**Returns** 6241 6242Returns the interpolation curve. 6243 6244 6245### OH_ArkUI_AnimatorOption_GetKeyframeTime() 6246 6247``` 6248float OH_ArkUI_AnimatorOption_GetKeyframeTime (ArkUI_AnimatorOption * option, int32_t index ) 6249``` 6250**Description** 6251 6252Obtains the keyframe time of an animation. 6253 6254**Since**: 12 6255 6256**Parameters** 6257 6258| Name| Description| 6259| -------- | -------- | 6260| option | Pointer to an **AnimatorOption** object. | 6261| index | Keyframe index. | 6262 6263**Returns** 6264 6265Keyframe time. 6266 6267 6268### OH_ArkUI_AnimatorOption_GetKeyframeValue() 6269 6270``` 6271float OH_ArkUI_AnimatorOption_GetKeyframeValue (ArkUI_AnimatorOption * option, int32_t index ) 6272``` 6273**Description** 6274 6275Obtains the keyframe value of an animation. 6276 6277**Since**: 12 6278 6279**Parameters** 6280 6281| Name| Description| 6282| -------- | -------- | 6283| option | Pointer to an **AnimatorOption** object. | 6284| index | Keyframe index. | 6285 6286**Returns** 6287 6288Keyframe value. 6289 6290 6291### OH_ArkUI_AnimatorOption_RegisterOnCancelCallback() 6292 6293``` 6294int32_t OH_ArkUI_AnimatorOption_RegisterOnCancelCallback (ArkUI_AnimatorOption * option, void * userData, void(*)(ArkUI_AnimatorEvent *event) callback ) 6295``` 6296**Description** 6297 6298Sets the callback invoked when the animation playback is canceled. 6299 6300**Parameters** 6301 6302| Name| Description| 6303| -------- | -------- | 6304| option | Pointer to an animation configuration. | 6305| userData | Custom parameter. | 6306| callback | Callback used to return the result. | 6307 6308**Returns** 6309 6310Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6311 6312 6313### OH_ArkUI_AnimatorOption_RegisterOnFinishCallback() 6314 6315``` 6316int32_t OH_ArkUI_AnimatorOption_RegisterOnFinishCallback (ArkUI_AnimatorOption * option, void * userData, void(*)(ArkUI_AnimatorEvent *event) callback ) 6317``` 6318**Description** 6319 6320Sets the callback invoked when the animation playback is complete. 6321 6322**Parameters** 6323 6324| Name| Description| 6325| -------- | -------- | 6326| option | Pointer to an animation configuration. | 6327| userData | Custom parameter. | 6328| callback | Callback used to return the result. | 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_AnimatorOption_RegisterOnFrameCallback() 6336 6337``` 6338int32_t OH_ArkUI_AnimatorOption_RegisterOnFrameCallback (ArkUI_AnimatorOption * option, void * userData, void(*)(ArkUI_AnimatorOnFrameEvent *event) callback ) 6339``` 6340**Description** 6341 6342Sets the callback invoked when the animator receives a frame. 6343 6344**Parameters** 6345 6346| Name| Description| 6347| -------- | -------- | 6348| option | Pointer to an animation configuration. | 6349| userData | Custom parameter. | 6350| callback | Callback used to return the result. | 6351 6352**Returns** 6353 6354Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6355 6356 6357### OH_ArkUI_AnimatorOption_RegisterOnRepeatCallback() 6358 6359``` 6360int32_t OH_ArkUI_AnimatorOption_RegisterOnRepeatCallback (ArkUI_AnimatorOption * option, void * userData, void(*)(ArkUI_AnimatorEvent *event) callback ) 6361``` 6362**Description** 6363 6364Sets the callback invoked when the animation playback is repeated. 6365 6366**Parameters** 6367 6368| Name| Description| 6369| -------- | -------- | 6370| option | Pointer to an animation configuration. | 6371| userData | Custom parameter. | 6372| callback | Callback used to return the result. | 6373 6374**Returns** 6375 6376Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6377 6378 6379### OH_ArkUI_AnimatorOption_SetBegin() 6380 6381``` 6382int32_t OH_ArkUI_AnimatorOption_SetBegin (ArkUI_AnimatorOption * option, float value ) 6383``` 6384**Description** 6385 6386Sets the interpolation start point for the animation of an animator. 6387 6388**Parameters** 6389 6390| Name| Description| 6391| -------- | -------- | 6392| option | Pointer to an **AnimatorOption** object. | 6393| value | Start point of the animation interpolation. | 6394 6395**NOTE** 6396 6397This API does not take effect when the animation is a keyframe animation. 6398 6399**Returns** 6400 6401Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6402 6403 6404### OH_ArkUI_AnimatorOption_SetCurve() 6405 6406``` 6407int32_t OH_ArkUI_AnimatorOption_SetCurve (ArkUI_AnimatorOption * option, ArkUI_CurveHandle value ) 6408``` 6409**Description** 6410 6411Sets the interpolation curve for the animation of an animator. 6412 6413**Parameters** 6414 6415| Name| Description| 6416| -------- | -------- | 6417| option | Pointer to an **AnimatorOption** object. | 6418| value | Interpolation curve of the animation. Default value: **ARKUI_CURVE_LINEAR**. | 6419 6420**NOTE** 6421 6422The **springCurve**, **springMotion**, **responsiveSpringMotion**, and **interpolatingSpring customCurve** curves are not supported. 6423 6424**Returns** 6425 6426Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6427 6428 6429### OH_ArkUI_AnimatorOption_SetDelay() 6430 6431``` 6432int32_t OH_ArkUI_AnimatorOption_SetDelay (ArkUI_AnimatorOption * option, int32_t value ) 6433``` 6434**Description** 6435 6436Sets the delay of animation playback, in milliseconds. 6437 6438**Parameters** 6439 6440| Name| Description| 6441| -------- | -------- | 6442| option | Pointer to an **AnimatorOption** object. | 6443| value | Animation delay, in milliseconds. | 6444 6445**Returns** 6446 6447Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6448 6449 6450### OH_ArkUI_AnimatorOption_SetDirection() 6451 6452``` 6453int32_t OH_ArkUI_AnimatorOption_SetDirection (ArkUI_AnimatorOption * option, ArkUI_AnimationDirection value ) 6454``` 6455**Description** 6456 6457Sets the playback direction. 6458 6459**Parameters** 6460 6461| Name| Description| 6462| -------- | -------- | 6463| option | Pointer to an **AnimatorOption** object. | 6464| value | Animation playback direction. | 6465 6466**Returns** 6467 6468Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6469 6470 6471### OH_ArkUI_AnimatorOption_SetDuration() 6472 6473``` 6474int32_t OH_ArkUI_AnimatorOption_SetDuration (ArkUI_AnimatorOption * option, int32_t value ) 6475``` 6476**Description** 6477 6478Sets the duration of an animation, in milliseconds. 6479 6480**Parameters** 6481 6482| Name| Description| 6483| -------- | -------- | 6484| option | Pointer to an **AnimatorOption** object. | 6485| value | Duration for playing the animation, in milliseconds. | 6486 6487**Returns** 6488 6489Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6490 6491 6492### OH_ArkUI_AnimatorOption_SetEnd() 6493 6494``` 6495int32_t OH_ArkUI_AnimatorOption_SetEnd (ArkUI_AnimatorOption * option, float value ) 6496``` 6497**Description** 6498 6499Sets the interpolation end point for the animation of an animator. 6500 6501**Parameters** 6502 6503| Name| Description| 6504| -------- | -------- | 6505| option | Pointer to an **AnimatorOption** object. | 6506| value | End point of animation interpolation. | 6507 6508**NOTE** 6509 6510This API does not take effect when the animation is a keyframe animation. 6511 6512**Returns** 6513 6514Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6515 6516 6517### OH_ArkUI_AnimatorOption_SetExpectedFrameRateRange() 6518 6519``` 6520int32_t OH_ArkUI_AnimatorOption_SetExpectedFrameRateRange (ArkUI_AnimatorOption * option, ArkUI_ExpectedFrameRateRange * value ) 6521``` 6522**Description** 6523 6524Sets the expected frame rate range of an animation. 6525 6526**Parameters** 6527 6528| Name| Description| 6529| -------- | -------- | 6530| option | Pointer to an **AnimatorOption** object. | 6531| value | Expected frame rate range. | 6532 6533**Returns** 6534 6535Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6536 6537 6538### OH_ArkUI_AnimatorOption_SetFill() 6539 6540``` 6541int32_t OH_ArkUI_AnimatorOption_SetFill (ArkUI_AnimatorOption * option, ArkUI_AnimationFill value ) 6542``` 6543**Description** 6544 6545Sets whether the animator animation is restored to the initial state after being executed. 6546 6547**Parameters** 6548 6549| Name| Description| 6550| -------- | -------- | 6551| option | Pointer to an **AnimatorOption** object. | 6552| value | Whether to restore the animation to the initial state after the animation is executed. | 6553 6554**Returns** 6555 6556Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6557 6558 6559### OH_ArkUI_AnimatorOption_SetIterations() 6560 6561``` 6562int32_t OH_ArkUI_AnimatorOption_SetIterations (ArkUI_AnimatorOption * option, int32_t value ) 6563``` 6564**Description** 6565 6566Sets 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. 6567 6568**Parameters** 6569 6570| Name| Description| 6571| -------- | -------- | 6572| option | Pointer to an **AnimatorOption** object. | 6573| value | Number of times that the animation is played. | 6574 6575**NOTE** 6576 6577If this parameter is set to a negative value other than **-1**, the value is invalid. In this case, the animation is played once. 6578 6579**Returns** 6580 6581Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6582 6583 6584### OH_ArkUI_AnimatorOption_SetKeyframe() 6585 6586``` 6587int32_t OH_ArkUI_AnimatorOption_SetKeyframe (ArkUI_AnimatorOption * option, float time, float value, int32_t index ) 6588``` 6589**Description** 6590 6591Sets the keyframe parameters of an animation. 6592 6593**Parameters** 6594 6595| Name| Description| 6596| -------- | -------- | 6597| option | Pointer to an **AnimatorOption** object. | 6598| time | Keyframe time. Value range: [0, 1]. The value must be in ascending order. | 6599| value | Keyframe value. | 6600| index | Keyframe index. | 6601 6602**Returns** 6603 6604Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6605 6606 6607### OH_ArkUI_AnimatorOption_SetKeyframeCurve() 6608 6609``` 6610int32_t OH_ArkUI_AnimatorOption_SetKeyframeCurve (ArkUI_AnimatorOption * option, ArkUI_CurveHandle value, int32_t index ) 6611``` 6612**Description** 6613 6614Sets the keyframe curve type for the animation of an animator. 6615 6616**Parameters** 6617 6618| Name| Description| 6619| -------- | -------- | 6620| option | Pointer to an **AnimatorOption** object. | 6621| value | Animation interpolation curve. | 6622| index | Keyframe index. | 6623 6624**NOTE** 6625 6626The **springCurve**, **springMotion**, **responsiveSpringMotion**, and **interpolatingSpring customCurve** curves are not supported. 6627 6628**Returns** 6629 6630Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6631 6632 6633### OH_ArkUI_BarrierOption_Create() 6634 6635``` 6636ArkUI_BarrierOption* OH_ArkUI_BarrierOption_Create (int32_t size) 6637``` 6638**Description** 6639 6640Creates a barrier configuration for this **RelativeContainer** component. 6641 6642**Since**: 12 6643 6644**Parameters** 6645 6646| Name| Description| 6647| -------- | -------- | 6648| size | Number of barriers. | 6649 6650**Returns** 6651 6652Returns the barrier configuration. 6653 6654 6655### OH_ArkUI_BarrierOption_Dispose() 6656 6657``` 6658void OH_ArkUI_BarrierOption_Dispose (ArkUI_BarrierOption * barrierStyle) 6659``` 6660**Description** 6661 6662Disposes of a barrier configuration. 6663 6664**Since**: 12 6665 6666**Parameters** 6667 6668| Name| Description| 6669| -------- | -------- | 6670| barrierStyle | Pointer to a barrier configuration. | 6671 6672 6673### OH_ArkUI_BarrierOption_GetDirection() 6674 6675``` 6676ArkUI_BarrierDirection OH_ArkUI_BarrierOption_GetDirection (ArkUI_BarrierOption * barrierStyle, int32_t index ) 6677``` 6678**Description** 6679 6680Obtains the direction of a barrier. 6681 6682**Since**: 12 6683 6684**Parameters** 6685 6686| Name| Description| 6687| -------- | -------- | 6688| barrierStyle | Pointer to a barrier configuration. | 6689| index | Index of the barrier. | 6690 6691**Returns** 6692 6693Returns the direction of the barrier. 6694 6695 6696### OH_ArkUI_BarrierOption_GetId() 6697 6698``` 6699const char* OH_ArkUI_BarrierOption_GetId (ArkUI_BarrierOption * barrierStyle, int32_t index ) 6700``` 6701**Description** 6702 6703Obtains the ID of a barrier. 6704 6705**Since**: 12 6706 6707**Parameters** 6708 6709| Name| Description| 6710| -------- | -------- | 6711| barrierStyle | Pointer to a barrier configuration. | 6712| index | Index of the barrier. | 6713 6714**Returns** 6715 6716Returns the ID of the barrier. 6717 6718 6719### OH_ArkUI_BarrierOption_GetReferencedId() 6720 6721``` 6722const char* OH_ArkUI_BarrierOption_GetReferencedId (ArkUI_BarrierOption * barrierStyle, int32_t index, int32_t referencedIndex ) 6723``` 6724**Description** 6725 6726Obtains the referenced components of a barrier. 6727 6728**Since**: 12 6729 6730**Parameters** 6731 6732| Name| Description| 6733| -------- | -------- | 6734| barrierStyle | Pointer to a barrier configuration. | 6735| index | Index of the barrier. | 6736| referencedIndex | Index of the referenced component ID. | 6737 6738**Returns** 6739 6740Returns the referenced components of the barrier. 6741 6742 6743### OH_ArkUI_BarrierOption_GetReferencedIdSize() 6744 6745``` 6746int32_t OH_ArkUI_BarrierOption_GetReferencedIdSize (ArkUI_BarrierOption * barrierStyle, int32_t index ) 6747``` 6748**Description** 6749 6750Obtains the number of referenced components of a barrier. 6751 6752**Since**: 12 6753 6754**Parameters** 6755 6756| Name| Description| 6757| -------- | -------- | 6758| barrierStyle | Pointer to a barrier configuration. | 6759| index | Index of the barrier. | 6760 6761**Returns** 6762 6763Returns the number of referenced components of the barrier. 6764 6765 6766### OH_ArkUI_BarrierOption_SetDirection() 6767 6768``` 6769void OH_ArkUI_BarrierOption_SetDirection (ArkUI_BarrierOption * barrierStyle, ArkUI_BarrierDirection value, int32_t index ) 6770``` 6771**Description** 6772 6773Sets the direction of a barrier. 6774 6775**Since**: 12 6776 6777**Parameters** 6778 6779| Name| Description| 6780| -------- | -------- | 6781| barrierStyle | Pointer to a barrier configuration. | 6782| value | Direction. | 6783| index | Index of the barrier. | 6784 6785 6786### OH_ArkUI_BarrierOption_SetId() 6787 6788``` 6789void OH_ArkUI_BarrierOption_SetId (ArkUI_BarrierOption * barrierStyle, const char * value, int32_t index ) 6790``` 6791**Description** 6792 6793Sets the ID of a barrier. 6794 6795**Since**: 12 6796 6797**Parameters** 6798 6799| Name| Description| 6800| -------- | -------- | 6801| barrierStyle | Pointer to a barrier configuration. | 6802| value | ID of the barrier, which must be unique and cannot be the same as the name of any component in the container. | 6803| index | Index of the barrier. | 6804 6805 6806### OH_ArkUI_BarrierOption_SetReferencedId() 6807 6808``` 6809void OH_ArkUI_BarrierOption_SetReferencedId (ArkUI_BarrierOption * barrierStyle, const char * value, int32_t index ) 6810``` 6811**Description** 6812 6813Sets the referenced components of a barrier. 6814 6815**Since**: 12 6816 6817**Parameters** 6818 6819| Name| Description| 6820| -------- | -------- | 6821| barrierStyle | Pointer to a barrier configuration. | 6822| value | Referenced component IDs. | 6823| index | Index of the barrier. | 6824 6825 6826### OH_ArkUI_ConvertToHtml() 6827 6828``` 6829const char* OH_ArkUI_ConvertToHtml (ArkUI_StyledString_Descriptor * descriptor) 6830``` 6831**Description** 6832 6833Converts styled string information into HTML. 6834 6835**Since**: 14 6836 6837**Parameters** 6838 6839| Name| Description| 6840| -------- | -------- | 6841| descriptor | Pointer to an **ArkUI_StyledString_Descriptor** object. | 6842 6843**Returns** 6844 6845Returns 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. 6846 6847 6848### OH_ArkUI_CreateAsymmetricTransitionEffect() 6849 6850``` 6851ArkUI_TransitionEffect* OH_ArkUI_CreateAsymmetricTransitionEffect (ArkUI_TransitionEffect * appear, ArkUI_TransitionEffect * disappear ) 6852``` 6853**Description** 6854 6855Creates an asymmetric transition effect. 6856 6857**Since**: 12 6858 6859**Parameters** 6860 6861| Name| Description| 6862| -------- | -------- | 6863| appear | Transition effect for appearance. | 6864| disappear | Transition effect for disappearance. | 6865 6866**NOTE** 6867 6868If the **asymmetric** function is not used for constructing **TransitionEffect**, the transition effect takes effect for both appearance and disappearance of the component. 6869 6870**Returns** 6871 6872Returns the asymmetric transition effect; returns **NULL** if a parameter error occurs. 6873 6874 6875### OH_ArkUI_CreateDragActionWithContext() 6876 6877``` 6878ArkUI_DragAction* OH_ArkUI_CreateDragActionWithContext (ArkUI_ContextHandle uiContext) 6879``` 6880**Description** 6881 6882Creates a drag action object for the specified UI instance. 6883 6884**Since**: 12 6885 6886**Parameters** 6887 6888| Name| Description| 6889| -------- | -------- | 6890| uiContext | Pointer to the UI instance object. | 6891 6892**Returns** 6893 6894Returns the pointer to the created drag action object; returns null if the operation fails. 6895 6896 6897### OH_ArkUI_CreateDragActionWithNode() 6898 6899``` 6900ArkUI_DragAction* OH_ArkUI_CreateDragActionWithNode (ArkUI_NodeHandle node) 6901``` 6902**Description** 6903 6904Creates 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. 6905 6906**Since**: 12 6907 6908**Parameters** 6909 6910| Name| Description| 6911| -------- | -------- | 6912| node | Pointer to a component node. | 6913 6914**Returns** 6915 6916Returns the pointer to the created drag action object; returns null if the operation fails. 6917 6918 6919### OH_ArkUI_CreateDragPreviewOption() 6920 6921``` 6922ArkUI_DragPreviewOption* OH_ArkUI_CreateDragPreviewOption (void ) 6923``` 6924**Description** 6925 6926Creates an **ArkUI_DragPreviewOption** object. 6927 6928**Since**: 12 6929 6930**Returns** 6931 6932ArkUI_DragPreviewOption object. 6933 6934 6935### OH_ArkUI_CreateMovementTransitionEffect() 6936 6937``` 6938ArkUI_TransitionEffect* OH_ArkUI_CreateMovementTransitionEffect (ArkUI_TransitionEdge move) 6939``` 6940**Description** 6941 6942Creates a movement object for component transition. 6943 6944**Since**: 12 6945 6946**Parameters** 6947 6948| Name| Description| 6949| -------- | -------- | 6950| move | Panning type. | 6951 6952**Returns** 6953 6954Returns the movement object created for component transition; returns **NULL** if a parameter error occurs. 6955 6956 6957### OH_ArkUI_CreateOpacityTransitionEffect() 6958 6959``` 6960ArkUI_TransitionEffect* OH_ArkUI_CreateOpacityTransitionEffect (float opacity) 6961``` 6962**Description** 6963 6964Creates an opacity object for component transition. 6965 6966**Since**: 12 6967 6968**Parameters** 6969 6970| Name| Description| 6971| -------- | -------- | 6972| opacity | Opacity. The value range is [0, 1]. | 6973 6974**NOTE** 6975 6976If 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. 6977 6978**Returns** 6979 6980Returns the created opacity object for component transition. 6981 6982 6983### OH_ArkUI_CreateRotationTransitionEffect() 6984 6985``` 6986ArkUI_TransitionEffect* OH_ArkUI_CreateRotationTransitionEffect (ArkUI_RotationOptions * rotate) 6987``` 6988**Description** 6989 6990Creates a rotation object for component transition. 6991 6992**Since**: 12 6993 6994**Parameters** 6995 6996| Name| Description| 6997| -------- | -------- | 6998| rotate | Rotation parameter object during component transition. | 6999 7000**Returns** 7001 7002Returns the rotation object created for component transition; returns **NULL** if a parameter error occurs. 7003 7004 7005### OH_ArkUI_CreateScaleTransitionEffect() 7006 7007``` 7008ArkUI_TransitionEffect* OH_ArkUI_CreateScaleTransitionEffect (ArkUI_ScaleOptions * scale) 7009``` 7010**Description** 7011 7012Creates a scaling transition effect object. 7013 7014**Since**: 12 7015 7016**Parameters** 7017 7018| Name| Description| 7019| -------- | -------- | 7020| scale | Scaling settings for component transition. | 7021 7022**Returns** 7023 7024Returns the created scaling transition effect object; returns **NULL** if a parameter error occurs. 7025 7026 7027### OH_ArkUI_CreateTranslationTransitionEffect() 7028 7029``` 7030ArkUI_TransitionEffect* OH_ArkUI_CreateTranslationTransitionEffect (ArkUI_TranslationOptions * translate) 7031``` 7032**Description** 7033 7034Creates a translation transition effect object. 7035 7036**Since**: 12 7037 7038**Parameters** 7039 7040| Name| Description| 7041| -------- | -------- | 7042| translate | Translation settings for component transition. | 7043 7044**Returns** 7045 7046Returns the created translation transition effect object; returns **NULL** if a parameter error occurs. 7047 7048 7049### OH_ArkUI_Curve_CreateCubicBezierCurve() 7050 7051``` 7052ArkUI_CurveHandle OH_ArkUI_Curve_CreateCubicBezierCurve (float x1, float y1, float x2, float y2 ) 7053``` 7054**Description** 7055 7056Creates a cubic Bezier curve. 7057 7058**Parameters** 7059 7060| Name| Description| 7061| -------- | -------- | 7062| 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**. | 7063| y1 | Y coordinate of the first point on the Bezier curve. | 7064| 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**. | 7065| y2 | Y coordinate of the second point on the Bezier curve. | 7066 7067**Returns** 7068 7069Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 7070 7071 7072### OH_ArkUI_Curve_CreateCurveByType() 7073 7074``` 7075ArkUI_CurveHandle OH_ArkUI_Curve_CreateCurveByType (ArkUI_AnimationCurve curve) 7076``` 7077**Description** 7078 7079Implements initialization for the interpolation curve, which is used to create an interpolation curve based on the input parameter. 7080 7081**Parameters** 7082 7083| Name| Description| 7084| -------- | -------- | 7085| curve | Curve type. | 7086 7087**Returns** 7088 7089Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 7090 7091 7092### OH_ArkUI_Curve_CreateCustomCurve() 7093 7094``` 7095ArkUI_CurveHandle OH_ArkUI_Curve_CreateCustomCurve (void * userData, float(*)(float fraction, void *userdata) interpolate ) 7096``` 7097**Description** 7098 7099Creates a custom curve. 7100 7101**Parameters** 7102 7103| Name| Description| 7104| -------- | -------- | 7105| userData | Custom data. | 7106| 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. | 7107 7108**Returns** 7109 7110Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 7111 7112 7113### OH_ArkUI_Curve_CreateInterpolatingSpring() 7114 7115``` 7116ArkUI_CurveHandle OH_ArkUI_Curve_CreateInterpolatingSpring (float velocity, float mass, float stiffness, float damping ) 7117``` 7118**Description** 7119 7120Creates an interpolating spring curve animated from 0 to 1. The actual animation value is calculated based on the curve. 7121 7122**Parameters** 7123 7124| Name| Description| 7125| -------- | -------- | 7126| 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. | 7127| 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. | 7128| 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. | 7129| 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. | 7130 7131**NOTE** 7132 7133The animation duration is subject to the curve parameters, rather than the **duration** parameter in **animation** or **animateTo**. 7134 7135**Returns** 7136 7137Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 7138 7139 7140### OH_ArkUI_Curve_CreateResponsiveSpringMotion() 7141 7142``` 7143ArkUI_CurveHandle OH_ArkUI_Curve_CreateResponsiveSpringMotion (float response, float dampingFraction, float overlapDuration ) 7144``` 7145**Description** 7146 7147Creates 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**. 7148 7149**Parameters** 7150 7151| Name| Description| 7152| -------- | -------- | 7153| response | Duration of one complete oscillation. | 7154| 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. | 7155| 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. | 7156 7157**NOTE** 7158 7159The animation duration is subject to the curve parameters, rather than the **duration** parameter in **animation** or **animateTo**. 7160 7161**Returns** 7162 7163Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 7164 7165 7166### OH_ArkUI_Curve_CreateSpringCurve() 7167 7168``` 7169ArkUI_CurveHandle OH_ArkUI_Curve_CreateSpringCurve (float velocity, float mass, float stiffness, float damping ) 7170``` 7171**Description** 7172 7173Creates 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**. 7174 7175**Parameters** 7176 7177| Name| Description| 7178| -------- | -------- | 7179| 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. | 7180| 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. | 7181| 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. | 7182| 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. | 7183 7184**Returns** 7185 7186Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 7187 7188 7189### OH_ArkUI_Curve_CreateSpringMotion() 7190 7191``` 7192ArkUI_CurveHandle OH_ArkUI_Curve_CreateSpringMotion (float response, float dampingFraction, float overlapDuration ) 7193``` 7194**Description** 7195 7196Creates 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. 7197 7198**Parameters** 7199 7200| Name| Description| 7201| -------- | -------- | 7202| response | Duration of one complete oscillation. | 7203| 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. | 7204| 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. | 7205 7206**NOTE** 7207 7208The animation duration is subject to the curve parameters, rather than the **duration** parameter in **animation** or **animateTo**. 7209 7210**Returns** 7211 7212Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 7213 7214 7215### OH_ArkUI_Curve_CreateStepsCurve() 7216 7217``` 7218ArkUI_CurveHandle OH_ArkUI_Curve_CreateStepsCurve (int32_t count, bool end ) 7219``` 7220**Description** 7221 7222Creates a step curve. 7223 7224**Parameters** 7225 7226| Name| Description| 7227| -------- | -------- | 7228| count | Number of tiers. The value must be a positive integer. Value range: [1, +∞). | 7229| 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. | 7230 7231**Returns** 7232 7233Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 7234 7235 7236### OH_ArkUI_Curve_DisposeCurve() 7237 7238``` 7239void OH_ArkUI_Curve_DisposeCurve (ArkUI_CurveHandle curveHandle) 7240``` 7241**Description** 7242 7243Disposes of a custom curve. 7244 7245**Parameters** 7246 7247| Name| Description| 7248| -------- | -------- | 7249| curve | Returns the pointer to the interpolation object of the curve; | 7250 7251 7252### OH_ArkUI_CustomProperty_Destroy() 7253 7254``` 7255void OH_ArkUI_CustomProperty_Destroy (ArkUI_CustomProperty * handle) 7256``` 7257**Description** 7258 7259Destroys a **CustomProperty** instance. 7260 7261**Since**: 14 7262 7263**Parameters** 7264 7265| Name| Description| 7266| -------- | -------- | 7267| handle | **CustomProperty** instance to destroy. | 7268 7269 7270### OH_ArkUI_CustomProperty_GetStringValue() 7271 7272``` 7273const char* OH_ArkUI_CustomProperty_GetStringValue (ArkUI_CustomProperty * handle) 7274``` 7275**Description** 7276 7277Obtains the value of a custom property. 7278 7279**Since**: 14 7280 7281**Parameters** 7282 7283| Name| Description| 7284| -------- | -------- | 7285| handle | Pointer to the custom property object. | 7286 7287**Returns** 7288 7289Value of the custom property. 7290 7291 7292### OH_ArkUI_CustomSpanDrawInfo_Create() 7293 7294``` 7295ArkUI_CustomSpanDrawInfo* OH_ArkUI_CustomSpanDrawInfo_Create (void ) 7296``` 7297**Description** 7298 7299Creates drawing information for this custom span. 7300 7301**Since**: 12 7302 7303**Returns** 7304 7305Returns a **CustomSpanDrawInfo** instance. If a null pointer is returned, the memory may be insufficient. 7306 7307 7308### OH_ArkUI_CustomSpanDrawInfo_Dispose() 7309 7310``` 7311void OH_ArkUI_CustomSpanDrawInfo_Dispose (ArkUI_CustomSpanDrawInfo * info) 7312``` 7313**Description** 7314 7315Disposes of drawing information for this custom span. 7316 7317**Since**: 12 7318 7319**Parameters** 7320 7321| Name| Description| 7322| -------- | -------- | 7323| info | Pointer to the drawing information of a custom span. | 7324 7325 7326### OH_ArkUI_CustomSpanDrawInfo_GetBaseline() 7327 7328``` 7329float OH_ArkUI_CustomSpanDrawInfo_GetBaseline (ArkUI_CustomSpanDrawInfo * info) 7330``` 7331**Description** 7332 7333Obtains the baseline offset of the custom span relative to the mounted component. 7334 7335**Since**: 12 7336 7337**Parameters** 7338 7339| Name| Description| 7340| -------- | -------- | 7341| info | Pointer to the drawing information of a custom span. | 7342 7343**Returns** 7344 7345Returns the baseline offset. If a parameter error occurs, **0.0f** is returned. A possible cause is that mandatory parameters are left unspecified. 7346 7347 7348### OH_ArkUI_CustomSpanDrawInfo_GetLineBottom() 7349 7350``` 7351float OH_ArkUI_CustomSpanDrawInfo_GetLineBottom (ArkUI_CustomSpanDrawInfo * info) 7352``` 7353**Description** 7354 7355Obtains the bottom margin of the custom span relative to the mounted component. 7356 7357**Since**: 12 7358 7359**Parameters** 7360 7361| Name| Description| 7362| -------- | -------- | 7363| info | Pointer to the drawing information of a custom span. | 7364 7365**Returns** 7366 7367Returns the bottom margin. If a parameter error occurs, **0.0f** is returned. A possible cause is that mandatory parameters are left unspecified. 7368 7369 7370### OH_ArkUI_CustomSpanDrawInfo_GetLineTop() 7371 7372``` 7373float OH_ArkUI_CustomSpanDrawInfo_GetLineTop (ArkUI_CustomSpanDrawInfo * info) 7374``` 7375**Description** 7376 7377Obtains the top margin of the custom span relative to the mounted component. 7378 7379**Since**: 12 7380 7381**Parameters** 7382 7383| Name| Description| 7384| -------- | -------- | 7385| info | Pointer to the drawing information of a custom span. | 7386 7387**Returns** 7388 7389Returns the top margin. If a parameter error occurs, **0.0f** is returned. A possible cause is that mandatory parameters are left unspecified. 7390 7391 7392### OH_ArkUI_CustomSpanDrawInfo_GetXOffset() 7393 7394``` 7395float OH_ArkUI_CustomSpanDrawInfo_GetXOffset (ArkUI_CustomSpanDrawInfo * info) 7396``` 7397**Description** 7398 7399Obtains the x-axis offset of the custom span relative to the mounted component. 7400 7401**Since**: 12 7402 7403**Parameters** 7404 7405| Name| Description| 7406| -------- | -------- | 7407| info | Pointer to the drawing information of a custom span. | 7408 7409**Returns** 7410 7411Returns the x-axis offset. If a parameter error occurs, **0.0f** is returned. A possible cause is that mandatory parameters are left unspecified. 7412 7413 7414### OH_ArkUI_CustomSpanMeasureInfo_Create() 7415 7416``` 7417ArkUI_CustomSpanMeasureInfo* OH_ArkUI_CustomSpanMeasureInfo_Create (void ) 7418``` 7419**Description** 7420 7421Creates measurement information for this custom span. 7422 7423**Since**: 12 7424 7425**Returns** 7426 7427Returns a **CustomSpanMeasureInfo** instance. If a null pointer is returned, the memory may be insufficient. 7428 7429 7430### OH_ArkUI_CustomSpanMeasureInfo_Dispose() 7431 7432``` 7433void OH_ArkUI_CustomSpanMeasureInfo_Dispose (ArkUI_CustomSpanMeasureInfo * info) 7434``` 7435**Description** 7436 7437Disposes of measurement information of a custom span. 7438 7439**Since**: 12 7440 7441**Parameters** 7442 7443| Name| Description| 7444| -------- | -------- | 7445| info | Pointer to the measurement information of a custom span. | 7446 7447 7448### OH_ArkUI_CustomSpanMeasureInfo_GetFontSize() 7449 7450``` 7451float OH_ArkUI_CustomSpanMeasureInfo_GetFontSize (ArkUI_CustomSpanMeasureInfo * info) 7452``` 7453**Description** 7454 7455Obtains the font size of the parent text node of a custom span. 7456 7457**Since**: 12 7458 7459**Parameters** 7460 7461| Name| Description| 7462| -------- | -------- | 7463| info | Pointer to the measurement information of a custom span. | 7464 7465**Returns** 7466 7467Returns 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. 7468 7469 7470### OH_ArkUI_CustomSpanMetrics_Create() 7471 7472``` 7473ArkUI_CustomSpanMetrics* OH_ArkUI_CustomSpanMetrics_Create (void ) 7474``` 7475**Description** 7476 7477Creates measurement metrics for this custom span. 7478 7479**Since**: 12 7480 7481**Returns** 7482 7483Returns a **CustomSpanMetrics** instance. If a null pointer is returned, the memory may be insufficient. 7484 7485 7486### OH_ArkUI_CustomSpanMetrics_Dispose() 7487 7488``` 7489void OH_ArkUI_CustomSpanMetrics_Dispose (ArkUI_CustomSpanMetrics * metrics) 7490``` 7491**Description** 7492 7493Disposes of measurement metrics of this custom span. 7494 7495**Since**: 12 7496 7497**Parameters** 7498 7499| Name| Description| 7500| -------- | -------- | 7501| metrics | Returns a **CustomSpanMetrics** instance. | 7502 7503 7504### OH_ArkUI_CustomSpanMetrics_SetHeight() 7505 7506``` 7507int32_t OH_ArkUI_CustomSpanMetrics_SetHeight (ArkUI_CustomSpanMetrics * metrics, float height ) 7508``` 7509**Description** 7510 7511Sets the height for a custom span. 7512 7513**Since**: 12 7514 7515**Parameters** 7516 7517| Name| Description| 7518| -------- | -------- | 7519| metrics | Returns a **CustomSpanMetrics** instance. | 7520| height | Height, in vp. | 7521 7522**Returns** 7523 7524Returns **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. 7525 7526 7527### OH_ArkUI_CustomSpanMetrics_SetWidth() 7528 7529``` 7530int32_t OH_ArkUI_CustomSpanMetrics_SetWidth (ArkUI_CustomSpanMetrics * metrics, float width ) 7531``` 7532**Description** 7533 7534Sets the width for a custom span. 7535 7536**Since**: 12 7537 7538**Parameters** 7539 7540| Name| Description| 7541| -------- | -------- | 7542| metrics | Returns a **CustomSpanMetrics** instance. | 7543| width | Width, in vp. | 7544 7545**Returns** 7546 7547Returns **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. 7548 7549 7550### OH_ArkUI_DialogDismissEvent_GetDismissReason() 7551 7552``` 7553int32_t OH_ArkUI_DialogDismissEvent_GetDismissReason (ArkUI_DialogDismissEvent * event) 7554``` 7555**Description** 7556 7557Obtains the dismissal reason from a dialog box dismiss event object. 7558 7559**Since**: 12 7560 7561**Parameters** 7562 7563| Name| Description| 7564| -------- | -------- | 7565| event | Pointer to a dialog box dismiss event object.| 7566 7567**Returns** 7568 7569Returns 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. 7570 7571### OH_ArkUI_DialogDismissEvent_GetUserData() 7572 7573``` 7574void* OH_ArkUI_DialogDismissEvent_GetUserData (ArkUI_DialogDismissEvent * event) 7575``` 7576**Description** 7577 7578Obtains the pointer to user data in a dialog box dismiss event object. 7579 7580**Since**: 12 7581 7582**Parameters** 7583 7584| Name| Description| 7585| -------- | -------- | 7586| event | Pointer to a dialog box dismiss event object.| 7587 7588**Returns** 7589 7590Returns the pointer to user data. 7591 7592 7593### OH_ArkUI_DialogDismissEvent_SetShouldBlockDismiss() 7594 7595``` 7596void OH_ArkUI_DialogDismissEvent_SetShouldBlockDismiss (ArkUI_DialogDismissEvent * event, bool shouldBlockDismiss ) 7597``` 7598**Description** 7599 7600Sets whether to block the system behavior of dismissing a dialog box. 7601 7602**Since**: 12 7603 7604**Parameters** 7605 7606| Name| Description| 7607| -------- | -------- | 7608| event | Pointer to a dialog box dismiss event object. | 7609| 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. | 7610 7611 7612### OH_ArkUI_DisallowNodeAnyDropDataTypes() 7613 7614``` 7615int32_t OH_ArkUI_DisallowNodeAnyDropDataTypes (ArkUI_NodeHandle node) 7616``` 7617**Description** 7618 7619The configuration component is not allowed to accept any data type. This interface resets the data type configured through [OH_ArkUI_SetNodeAllowedDropDataTypes](#oh_arkui_setnodealloweddropdatatypes). 7620 7621**Since**: 12 7622 7623**Parameters** 7624 7625| Name| Description| 7626| -------- | -------- | 7627| node | Pointer to a component node. | 7628 7629**Returns** 7630 7631Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7632 7633 7634### OH_ArkUI_DragAction_Dispose() 7635 7636``` 7637void OH_ArkUI_DragAction_Dispose (ArkUI_DragAction * dragAction) 7638``` 7639**Description** 7640 7641Disposes of an **ArkUI_DragAction** object. 7642 7643**Since**: 12 7644 7645**Parameters** 7646 7647| Name| Description| 7648| -------- | -------- | 7649| dragAction | Pointer to the target drag action object. | 7650 7651 7652### OH_ArkUI_DragAction_RegisterStatusListener() 7653 7654``` 7655int32_t OH_ArkUI_DragAction_RegisterStatusListener (ArkUI_DragAction * dragAction, void * userData, void(*)(ArkUI_DragAndDropInfo *dragAndDropInfo, void *userData) listener ) 7656``` 7657**Description** 7658 7659Registers a drag status listener. This listener can be used to check whether the data is successfully received and processed. 7660 7661**Since**: 12 7662 7663**Parameters** 7664 7665| Name| Description| 7666| -------- | -------- | 7667| dragAction | Pointer to the target drag action object. | 7668| userData | Custom user data. | 7669| 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. | 7670 7671**Returns** 7672 7673Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7674 7675 7676### OH_ArkUI_DragAction_SetData() 7677 7678``` 7679int32_t OH_ArkUI_DragAction_SetData (ArkUI_DragAction * dragAction, OH_UdmfData * data ) 7680``` 7681**Description** 7682 7683Sets the drag data. 7684 7685**Since**: 12 7686 7687**Parameters** 7688 7689| Name| Description| 7690| -------- | -------- | 7691| dragAction | Pointer to the target drag action object. | 7692| data | Drag data. | 7693 7694**Returns** 7695 7696Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7697 7698 7699### OH_ArkUI_DragAction_SetDragPreviewOption() 7700 7701``` 7702int32_t OH_ArkUI_DragAction_SetDragPreviewOption (ArkUI_DragAction * dragAction, ArkUI_DragPreviewOption * option ) 7703``` 7704**Description** 7705 7706Sets an **ArkUI_DragPreviewOption** object for the specified drag action object. 7707 7708**Since**: 12 7709 7710**Parameters** 7711 7712| Name| Description| 7713| -------- | -------- | 7714| dragAction | Pointer to the target drag action object. | 7715| option | Custom parameters. | 7716 7717**Returns** 7718 7719Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7720 7721 7722### OH_ArkUI_DragAction_SetPixelMaps() 7723 7724``` 7725int32_t OH_ArkUI_DragAction_SetPixelMaps (ArkUI_DragAction * dragAction, OH_PixelmapNative * pixelmapArray[], int32_t size ) 7726``` 7727**Description** 7728 7729Sets the drag previews for a drag action. 7730 7731**Since**: 12 7732 7733**Parameters** 7734 7735| Name| Description| 7736| -------- | -------- | 7737| dragAction | Pointer to the target drag action object. | 7738| pixelmapArray | Drag the bitmap array of the follower map. | 7739| size | Number of drag-and-drop images. | 7740 7741**Returns** 7742 7743Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7744 7745 7746### OH_ArkUI_DragAction_SetPointerId() 7747 7748``` 7749int32_t OH_ArkUI_DragAction_SetPointerId (ArkUI_DragAction * dragAction, int32_t pointer ) 7750``` 7751**Description** 7752 7753Sets 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. 7754 7755**Since**: 12 7756 7757**Parameters** 7758 7759| Name| Description| 7760| -------- | -------- | 7761| dragAction | Pointer to the target drag action object. | 7762| pointer | Pointer ID. The value ranges from 0 to 9. | 7763 7764**Returns** 7765 7766Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7767 7768 7769### OH_ArkUI_DragAction_SetTouchPointX() 7770 7771``` 7772int32_t OH_ArkUI_DragAction_SetTouchPointX (ArkUI_DragAction * dragAction, float x ) 7773``` 7774**Description** 7775 7776Sets the touch point relative to the upper left corner of the first drag preview (pixel map). 7777 7778**Since**: 12 7779 7780**Parameters** 7781 7782| Name| Description| 7783| -------- | -------- | 7784| dragAction | Pointer to the target drag action object. | 7785| x | X value of the hand point coordinate. | 7786 7787**Returns** 7788 7789Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7790 7791 7792### OH_ArkUI_DragAction_SetTouchPointY() 7793 7794``` 7795int32_t OH_ArkUI_DragAction_SetTouchPointY (ArkUI_DragAction * dragAction, float y ) 7796``` 7797**Description** 7798 7799Sets the touch point relative to the upper left corner of the first drag preview (pixel map). 7800 7801**Since**: 12 7802 7803**Parameters** 7804 7805| Name| Description| 7806| -------- | -------- | 7807| dragAction | Pointer to the target drag action object. | 7808| y | Y value of the hand point coordinate. | 7809 7810**Returns** 7811 7812Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7813 7814 7815### OH_ArkUI_DragAction_UnregisterStatusListener() 7816 7817``` 7818void OH_ArkUI_DragAction_UnregisterStatusListener (ArkUI_DragAction * dragAction) 7819``` 7820**Description** 7821 7822Unregisters a drag status listener. 7823 7824**Since**: 12 7825 7826**Parameters** 7827 7828| Name| Description| 7829| -------- | -------- | 7830| dragAction | Pointer to the target drag action object. | 7831 7832 7833### OH_ArkUI_DragAndDropInfo_GetDragEvent() 7834 7835``` 7836ArkUI_DragEvent* OH_ArkUI_DragAndDropInfo_GetDragEvent (ArkUI_DragAndDropInfo * dragAndDropInfo) 7837``` 7838**Description** 7839 7840Obtains a drag event based on the specified drag and drop information. The drag event can then be used to obtain the drag result. 7841 7842**Since**: 12 7843 7844**Parameters** 7845 7846| Name| Description| 7847| -------- | -------- | 7848| dragAndDropInfo | Drag-related information returned by the drag status listener. | 7849 7850**Returns** 7851 7852Returns an **ArkUI_DragEvent** object; returns null if an error occurs. 7853 7854 7855### OH_ArkUI_DragAndDropInfo_GetDragStatus() 7856 7857``` 7858ArkUI_DragStatus OH_ArkUI_DragAndDropInfo_GetDragStatus (ArkUI_DragAndDropInfo * dragAndDropInfo) 7859``` 7860**Description** 7861 7862Obtains the drag status of a drag action. 7863 7864**Since**: 12 7865 7866**Parameters** 7867 7868| Name| Description| 7869| -------- | -------- | 7870| dragAndDropInfo | Drag-related information returned by the drag status listener. | 7871 7872**Returns** 7873 7874Returns an **ArkUI_DragStatus** object; returns **ArkUI_DRAG_STATUS_UNKNOWN** if an error occurs. 7875 7876 7877### OH_ArkUI_DragEvent_DisableDefaultDropAnimation() 7878 7879``` 7880int32_t OH_ArkUI_DragEvent_DisableDefaultDropAnimation (ArkUI_DragEvent * event, bool disable ) 7881``` 7882**Description** 7883 7884Sets whether to disable the default drop animation, which is enabled by default. Use this API to apply a custom drop animation. 7885 7886**Since**: 12 7887 7888**Parameters** 7889 7890| Name| Description| 7891| -------- | -------- | 7892| event | Pointer to an **ArkUI_DragEvent** object. | 7893| disable | Whether to disable the default drop animation. The value **true** means to disable the default drop animation, and **false** means the opposite. | 7894 7895**Returns** 7896 7897Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7898 7899 7900### OH_ArkUI_DragEvent_GetDataTypes() 7901 7902``` 7903int32_t OH_ArkUI_DragEvent_GetDataTypes (ArkUI_DragEvent * event, char ** result[], int32_t length ) 7904``` 7905**Description** 7906 7907Obtains the type list of drag data types from a drag event. 7908 7909**Since**: 12 7910 7911**Parameters** 7912 7913| Name| Description| 7914| -------- | -------- | 7915| event | Pointer to an **ArkUI_DragEvent** object. | 7916| char | \*\*result[] Returns the type list of the dragged data. You need to create a string array first. | 7917| length | The total length of the array must be greater than or equal to the number obtained by using [OH_ArkUI_DragEvent_GetDataTypesCount](#oh_arkui_dragevent_getdatatypescount). | 7918 7919**Returns** 7920 7921Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7922 7923 7924### OH_ArkUI_DragEvent_GetDataTypesCount() 7925 7926``` 7927int32_t OH_ArkUI_DragEvent_GetDataTypesCount (ArkUI_DragEvent * event, int32_t * count ) 7928``` 7929**Description** 7930 7931Obtains the number of drag data types from a drag event. 7932 7933**Since**: 12 7934 7935**Parameters** 7936 7937| Name| Description| 7938| -------- | -------- | 7939| event | Pointer to an **ArkUI_DragEvent** object. | 7940| count | Output parameter, which returns the number of types of dragged data. | 7941 7942**Returns** 7943 7944Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7945 7946 7947### OH_ArkUI_DragEvent_GetDragResult() 7948 7949``` 7950int32_t OH_ArkUI_DragEvent_GetDragResult (ArkUI_DragEvent * event, ArkUI_DragResult * result ) 7951``` 7952**Description** 7953 7954Obtains the drag and drop result from the drag event. 7955 7956**Since**: 12 7957 7958**Parameters** 7959 7960| Name| Description| 7961| -------- | -------- | 7962| event | Pointer to an **ArkUI_DragEvent** object. | 7963| result | Output parameter, which returns the drag result corresponding to the drag event. | 7964 7965**Returns** 7966 7967Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7968 7969 7970### OH_ArkUI_DragEvent_GetModifierKeyStates() 7971 7972``` 7973int32_t OH_ArkUI_DragEvent_GetModifierKeyStates (ArkUI_DragEvent * event, int64_t * keys ) 7974``` 7975**Description** 7976 7977Obtains the pressed status of modifier keys from a drag event. 7978 7979**Since**: 12 7980 7981**Parameters** 7982 7983| Name| Description| 7984| -------- | -------- | 7985| event | Pointer to an **ArkUI_DragEvent** object. | 7986| keys | Returns the modifier key combination that is currently pressed. The application can determine the modifier key combination through bitwise operations. | 7987 7988**Returns** 7989 7990Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7991 7992 7993### OH_ArkUI_DragEvent_GetPreviewRectHeight() 7994 7995``` 7996float OH_ArkUI_DragEvent_GetPreviewRectHeight (ArkUI_DragEvent * event) 7997``` 7998**Description** 7999 8000Obtains the height of a drag preview from a drag event. 8001 8002**Since**: 12 8003 8004**Parameters** 8005 8006| Name| Description| 8007| -------- | -------- | 8008| event | Pointer to an **ArkUI_DragEvent** object. | 8009 8010**Returns** 8011 8012Returns the height of the drag preview, in px; returns the default value **0** if the input parameter is invalid. 8013 8014 8015### OH_ArkUI_DragEvent_GetPreviewRectWidth() 8016 8017``` 8018float OH_ArkUI_DragEvent_GetPreviewRectWidth (ArkUI_DragEvent * event) 8019``` 8020**Description** 8021 8022Obtains the width of a drag preview from a drag event. 8023 8024**Since**: 12 8025 8026**Parameters** 8027 8028| Name| Description| 8029| -------- | -------- | 8030| event | Pointer to an **ArkUI_DragEvent** object. | 8031 8032**Returns** 8033 8034Returns the width of the drag preview, in px; returns the default value **0** if the input parameter is invalid. 8035 8036 8037### OH_ArkUI_DragEvent_GetPreviewTouchPointX() 8038 8039``` 8040float OH_ArkUI_DragEvent_GetPreviewTouchPointX (ArkUI_DragEvent * event) 8041``` 8042**Description** 8043 8044Obtains the X coordinate of the touch point for a drag preview from a drag event. 8045 8046**Since**: 12 8047 8048**Parameters** 8049 8050| Name| Description| 8051| -------- | -------- | 8052| event | Pointer to an **ArkUI_DragEvent** object. | 8053 8054**Returns** 8055 8056Returns the X coordinate of the touch point, in px; returns the default value **0** if the input parameter is invalid. 8057 8058 8059### OH_ArkUI_DragEvent_GetPreviewTouchPointY() 8060 8061``` 8062float OH_ArkUI_DragEvent_GetPreviewTouchPointY (ArkUI_DragEvent * event) 8063``` 8064**Description** 8065 8066Obtains the Y coordinate of the touch point for a drag preview from a drag event. 8067 8068**Since**: 12 8069 8070**Parameters** 8071 8072| Name| Description| 8073| -------- | -------- | 8074| event | ArkUI_DragEvent event pointer. The unit is PX. If the input parameter is invalid, the default value 0 is returned. | 8075 8076**Returns** 8077 8078float returns the y-axis coordinate of the drag and hand point. 8079 8080 8081### OH_ArkUI_DragEvent_GetTouchPointXToDisplay() 8082 8083``` 8084float OH_ArkUI_DragEvent_GetTouchPointXToDisplay (ArkUI_DragEvent * event) 8085``` 8086**Description** 8087 8088Obtains the X coordinate of the touch point relative to the display from a drag event. 8089 8090**Since**: 12 8091 8092**Parameters** 8093 8094| Name| Description| 8095| -------- | -------- | 8096| event | Pointer to an **ArkUI_DragEvent** object. | 8097 8098**Returns** 8099 8100Returns the X coordinate of the touch point relative to the display, in px; returns the default value **0** if the input parameter is invalid. 8101 8102 8103### OH_ArkUI_DragEvent_GetTouchPointXToWindow() 8104 8105``` 8106float OH_ArkUI_DragEvent_GetTouchPointXToWindow (ArkUI_DragEvent * event) 8107``` 8108**Description** 8109 8110Obtains the X coordinate of the touch point relative to the window from a drag event. 8111 8112**Since**: 12 8113 8114**Parameters** 8115 8116| Name| Description| 8117| -------- | -------- | 8118| event | Pointer to an **ArkUI_DragEvent** object. | 8119 8120**Returns** 8121 8122Returns the X coordinate of the touch point relative to the window, in px; returns the default value **0** if the input parameter is invalid. 8123 8124 8125### OH_ArkUI_DragEvent_GetTouchPointYToDisplay() 8126 8127``` 8128float OH_ArkUI_DragEvent_GetTouchPointYToDisplay (ArkUI_DragEvent * event) 8129``` 8130**Description** 8131 8132Obtains the Y coordinate of the touch point relative to the display from a drag event. 8133 8134**Since**: 12 8135 8136**Parameters** 8137 8138| Name| Description| 8139| -------- | -------- | 8140| event | Pointer to an **ArkUI_DragEvent** object. | 8141 8142**Returns** 8143 8144Returns the Y coordinate of the touch point relative to the display, in px; returns the default value **0** if the input parameter is invalid. 8145 8146 8147### OH_ArkUI_DragEvent_GetTouchPointYToWindow() 8148 8149``` 8150float OH_ArkUI_DragEvent_GetTouchPointYToWindow (ArkUI_DragEvent * event) 8151``` 8152**Description** 8153 8154Obtains the Y coordinate of the touch point relative to the window from a drag event. 8155 8156**Since**: 12 8157 8158**Parameters** 8159 8160| Name| Description| 8161| -------- | -------- | 8162| event | Pointer to an **ArkUI_DragEvent** object. | 8163 8164**Returns** 8165 8166Returns the Y coordinate of the touch point relative to the window, in px; returns the default value **0** if the input parameter is invalid. 8167 8168 8169### OH_ArkUI_DragEvent_GetUdmfData() 8170 8171``` 8172int32_t OH_ArkUI_DragEvent_GetUdmfData (ArkUI_DragEvent * event, OH_UdmfData * data ) 8173``` 8174**Description** 8175 8176Obtain the default drag-and-drop data from ArkUI_DragEvent. 8177 8178**Since**: 12 8179 8180**Parameters** 8181 8182| Name| Description| 8183| -------- | -------- | 8184| event | Pointer to an **ArkUI_DragEvent** object. | 8185| 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. | 8186 8187**Returns** 8188 8189Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 8190 8191 8192### OH_ArkUI_DragEvent_GetVelocity() 8193 8194``` 8195float OH_ArkUI_DragEvent_GetVelocity (ArkUI_DragEvent * event) 8196``` 8197**Description** 8198 8199Obtains the dragging velocity along the main axis. 8200 8201**Since**: 12 8202 8203**Parameters** 8204 8205| Name| Description| 8206| -------- | -------- | 8207| event | Pointer to an **ArkUI_DragEvent** object. | 8208 8209**Returns** 8210 8211Returns the dragging velocity along the main axis, in px; returns the default value **0** if the input parameter is invalid. 8212 8213 8214### OH_ArkUI_DragEvent_GetVelocityX() 8215 8216``` 8217float OH_ArkUI_DragEvent_GetVelocityX (ArkUI_DragEvent * event) 8218``` 8219**Description** 8220 8221Obtains the dragging velocity along the x-axis. 8222 8223**Since**: 12 8224 8225**Parameters** 8226 8227| Name| Description| 8228| -------- | -------- | 8229| event | Pointer to an **ArkUI_DragEvent** object. | 8230 8231**Returns** 8232 8233Returns the dragging velocity along the x-axis, in px; returns the default value **0** if the input parameter is invalid. 8234 8235 8236### OH_ArkUI_DragEvent_GetVelocityY() 8237 8238``` 8239float OH_ArkUI_DragEvent_GetVelocityY (ArkUI_DragEvent * event) 8240``` 8241**Description** 8242 8243Obtains the dragging velocity along the y-axis. 8244 8245**Since**: 12 8246 8247**Parameters** 8248 8249| Name| Description| 8250| -------- | -------- | 8251| event | Pointer to an **ArkUI_DragEvent** object. | 8252 8253**Returns** 8254 8255Returns the dragging velocity along the y-axis, in px; returns the default value **0** if the input parameter is invalid. 8256 8257 8258### OH_ArkUI_DragEvent_SetData() 8259 8260``` 8261int32_t OH_ArkUI_DragEvent_SetData (ArkUI_DragEvent * event, OH_UdmfData * data ) 8262``` 8263**Description** 8264 8265Sets drag data for a drag event. 8266 8267**Since**: 12 8268 8269**Parameters** 8270 8271| Name| Description| 8272| -------- | -------- | 8273| event | Pointer to an **ArkUI_DragEvent** object. | 8274| data | Drag data. | 8275 8276**Returns** 8277 8278Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 8279 8280 8281### OH_ArkUI_DragEvent_SetDragResult() 8282 8283``` 8284int32_t OH_ArkUI_DragEvent_SetDragResult (ArkUI_DragEvent * event, ArkUI_DragResult result ) 8285``` 8286**Description** 8287 8288Sets the result for a drag event. 8289 8290**Since**: 12 8291 8292**Parameters** 8293 8294| Name| Description| 8295| -------- | -------- | 8296| event | Pointer to an **ArkUI_DragEvent** object. | 8297| result | Drag the data processing result. | 8298 8299**Returns** 8300 8301Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 8302 8303 8304### OH_ArkUI_DragEvent_SetSuggestedDropOperation() 8305 8306``` 8307int32_t OH_ArkUI_DragEvent_SetSuggestedDropOperation (ArkUI_DragEvent * event, ArkUI_DropProposal proposal ) 8308``` 8309**Description** 8310 8311Sets the data processing mode. 8312 8313**Since**: 12 8314 8315**Parameters** 8316 8317| Name| Description| 8318| -------- | -------- | 8319| proposal | Recommended data processing mode | 8320| proposal | Type of the badge display status. | 8321 8322**Returns** 8323 8324Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 8325 8326 8327### OH_ArkUI_DragPreviewOption_Dispose() 8328 8329``` 8330void OH_ArkUI_DragPreviewOption_Dispose (ArkUI_DragPreviewOption * option) 8331``` 8332**Description** 8333 8334Disposes of an **ArkUI_DragPreviewOption** object. 8335 8336**Since**: 12 8337 8338**Parameters** 8339 8340| Name| Description| 8341| -------- | -------- | 8342| option | Custom parameters. | 8343 8344 8345### OH_ArkUI_DragPreviewOption_SetBadgeNumber() 8346 8347``` 8348int32_t OH_ArkUI_DragPreviewOption_SetBadgeNumber (ArkUI_DragPreviewOption * option, uint32_t forcedNumber ) 8349``` 8350**Description** 8351 8352Sets the count on the badge. The settings will overwrite the value in the **SetDragPreviewNumberBadgeEnabled** API. 8353 8354**Since**: 12 8355 8356**Parameters** 8357 8358| Name| Description| 8359| -------- | -------- | 8360| option | Custom parameters. | 8361| forcedNumber | Number of corner marks. | 8362 8363**Returns** 8364 8365Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 8366 8367 8368### OH_ArkUI_DragPreviewOption_SetDefaultAnimationBeforeLiftingEnabled() 8369 8370``` 8371int32_t OH_ArkUI_DragPreviewOption_SetDefaultAnimationBeforeLiftingEnabled (ArkUI_DragPreviewOption * option, bool enabled ) 8372``` 8373**Description** 8374 8375Sets whether to enable the default animation on a click or touch. 8376 8377**Since**: 12 8378 8379**Parameters** 8380 8381| Name| Description| 8382| -------- | -------- | 8383| option | Custom parameters. | 8384| enabled | Whether to enable the default click effect. | 8385 8386**Returns** 8387 8388Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 8389 8390 8391### OH_ArkUI_DragPreviewOption_SetDefaultRadiusEnabled() 8392 8393``` 8394int32_t OH_ArkUI_DragPreviewOption_SetDefaultRadiusEnabled (ArkUI_DragPreviewOption * option, bool enabled ) 8395``` 8396**Description** 8397 8398Sets whether to enable the default corner radius effect for an **ArkUI_DragPreviewOption** object. The effect is enabled by default. 8399 8400**Since**: 12 8401 8402**Parameters** 8403 8404| Name| Description| 8405| -------- | -------- | 8406| option | Custom parameters. | 8407| enabled | Whether to enable the default corner radius effect. | 8408 8409**Returns** 8410 8411Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 8412 8413 8414### OH_ArkUI_DragPreviewOption_SetDefaultShadowEnabled() 8415 8416``` 8417int32_t OH_ArkUI_DragPreviewOption_SetDefaultShadowEnabled (ArkUI_DragPreviewOption * option, bool enabled ) 8418``` 8419**Description** 8420 8421Sets whether to enable the default shadow effect for an **ArkUI_DragPreviewOption** object. The effect is enabled by default. 8422 8423**Since**: 12 8424 8425**Parameters** 8426 8427| Name| Description| 8428| -------- | -------- | 8429| option | Custom parameters. | 8430| enabled | Whether to enable the default shadow effect. | 8431 8432**Returns** 8433 8434Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 8435 8436 8437### OH_ArkUI_DragPreviewOption_SetNumberBadgeEnabled() 8438 8439``` 8440int32_t OH_ArkUI_DragPreviewOption_SetNumberBadgeEnabled (ArkUI_DragPreviewOption * option, bool enabled ) 8441``` 8442**Description** 8443 8444Sets 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. 8445 8446**Since**: 12 8447 8448**Parameters** 8449 8450| Name| Description| 8451| -------- | -------- | 8452| option | Custom parameters. | 8453| enabled | Whether to enable the badge. | 8454 8455**Returns** 8456 8457Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 8458 8459 8460### OH_ArkUI_DragPreviewOption_SetScaleMode() 8461 8462``` 8463int32_t OH_ArkUI_DragPreviewOption_SetScaleMode (ArkUI_DragPreviewOption * option, ArkUI_DragPreviewScaleMode scaleMode ) 8464``` 8465**Description** 8466 8467Sets the scale mode for an **ArkUI_DragPreviewOption** object. 8468 8469**Since**: 12 8470 8471**Parameters** 8472 8473| Name| Description| 8474| -------- | -------- | 8475| option | Custom parameters. | 8476| scaleMode | Scale mode to set. | 8477 8478**Returns** 8479 8480Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 8481 8482 8483### OH_ArkUI_DrawableDescriptor_CreateFromAnimatedPixelMap() 8484 8485``` 8486ArkUI_DrawableDescriptor* OH_ArkUI_DrawableDescriptor_CreateFromAnimatedPixelMap (OH_PixelmapNativeHandle * array, int32_t size ) 8487``` 8488**Description** 8489 8490Creates a **DrawableDescriptor** object from an array of **PixelMap** objects. 8491 8492**Since**: 12 8493 8494**Parameters** 8495 8496| Name| Description| 8497| -------- | -------- | 8498| array | Pointer to the array of **PixelMap** objects. | 8499| size | Size of the **PixelMap** object array. | 8500 8501**Returns** 8502 8503Returns the pointer to the created **DrawableDescriptor** object. 8504 8505 8506### OH_ArkUI_DrawableDescriptor_CreateFromPixelMap() 8507 8508``` 8509ArkUI_DrawableDescriptor* OH_ArkUI_DrawableDescriptor_CreateFromPixelMap (OH_PixelmapNativeHandle pixelMap) 8510``` 8511**Description** 8512 8513Creates a **DrawableDescriptor** object from a **PixelMap** object. 8514 8515**Since**: 12 8516 8517**Parameters** 8518 8519| Name| Description| 8520| -------- | -------- | 8521| pixelMap | Pointer to the **PixelMap** object. | 8522 8523**Returns** 8524 8525Returns the pointer to the created **DrawableDescriptor** object. 8526 8527 8528### OH_ArkUI_DrawableDescriptor_Dispose() 8529 8530``` 8531void OH_ArkUI_DrawableDescriptor_Dispose (ArkUI_DrawableDescriptor * drawableDescriptor) 8532``` 8533**Description** 8534 8535Disposes of the pointer to a **DrawableDescriptor** object. 8536 8537**Since**: 12 8538 8539**Parameters** 8540 8541| Name| Description| 8542| -------- | -------- | 8543| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 8544 8545 8546### OH_ArkUI_DrawableDescriptor_GetAnimatedPixelMapArray() 8547 8548``` 8549OH_PixelmapNativeHandle* OH_ArkUI_DrawableDescriptor_GetAnimatedPixelMapArray (ArkUI_DrawableDescriptor * drawableDescriptor) 8550``` 8551**Description** 8552 8553Obtains an array of **PixelMap** objects for playing an animation. 8554 8555**Since**: 12 8556 8557**Parameters** 8558 8559| Name| Description| 8560| -------- | -------- | 8561| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 8562 8563**Returns** 8564 8565Pointer to the PixelMap image array. 8566 8567 8568### OH_ArkUI_DrawableDescriptor_GetAnimatedPixelMapArraySize() 8569 8570``` 8571int32_t OH_ArkUI_DrawableDescriptor_GetAnimatedPixelMapArraySize (ArkUI_DrawableDescriptor * drawableDescriptor) 8572``` 8573**Description** 8574 8575Obtains an array of **PixelMap** objects for playing an animation. 8576 8577**Since**: 12 8578 8579**Parameters** 8580 8581| Name| Description| 8582| -------- | -------- | 8583| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 8584 8585**Returns** 8586 8587Size of the PixelMap image array. 8588 8589 8590### OH_ArkUI_DrawableDescriptor_GetAnimationDuration() 8591 8592``` 8593int32_t OH_ArkUI_DrawableDescriptor_GetAnimationDuration (ArkUI_DrawableDescriptor * drawableDescriptor) 8594``` 8595**Description** 8596 8597Obtains the total playback duration of a PixelMap image array. 8598 8599**Since**: 12 8600 8601**Parameters** 8602 8603| Name| Description| 8604| -------- | -------- | 8605| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 8606 8607**Returns** 8608 8609Total playback duration, in milliseconds. 8610 8611 8612### OH_ArkUI_DrawableDescriptor_GetAnimationIteration() 8613 8614``` 8615int32_t OH_ArkUI_DrawableDescriptor_GetAnimationIteration (ArkUI_DrawableDescriptor * drawableDescriptor) 8616``` 8617**Description** 8618 8619Obtains the number of times that a **PixelMap** object array is played. 8620 8621**Since**: 12 8622 8623**Parameters** 8624 8625| Name| Description| 8626| -------- | -------- | 8627| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 8628 8629**Returns** 8630 8631Returns the number of playback times. 8632 8633 8634### OH_ArkUI_DrawableDescriptor_GetStaticPixelMap() 8635 8636``` 8637OH_PixelmapNativeHandle OH_ArkUI_DrawableDescriptor_GetStaticPixelMap (ArkUI_DrawableDescriptor * drawableDescriptor) 8638``` 8639**Description** 8640 8641Obtains the pointer to a **PixelMap** object. 8642 8643**Since**: 12 8644 8645**Parameters** 8646 8647| Name| Description| 8648| -------- | -------- | 8649| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 8650 8651**Returns** 8652 8653Pointer to the PixelMap object. 8654 8655 8656### OH_ArkUI_DrawableDescriptor_SetAnimationDuration() 8657 8658``` 8659void OH_ArkUI_DrawableDescriptor_SetAnimationDuration (ArkUI_DrawableDescriptor * drawableDescriptor, int32_t duration ) 8660``` 8661**Description** 8662 8663Sets the total playback duration of a PixelMap image array. 8664 8665**Since**: 12 8666 8667**Parameters** 8668 8669| Name| Description| 8670| -------- | -------- | 8671| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 8672| duration | Total playback duration, in milliseconds. | 8673 8674 8675### OH_ArkUI_DrawableDescriptor_SetAnimationIteration() 8676 8677``` 8678void OH_ArkUI_DrawableDescriptor_SetAnimationIteration (ArkUI_DrawableDescriptor * drawableDescriptor, int32_t iteration ) 8679``` 8680**Description** 8681 8682Sets the number of times that a pixel map image array is played. 8683 8684**Since**: 12 8685 8686**Parameters** 8687 8688| Name| Description| 8689| -------- | -------- | 8690| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 8691| iterations | Number of playback times. | 8692 8693 8694### OH_ArkUI_DrawContext_GetCanvas() 8695 8696``` 8697void* OH_ArkUI_DrawContext_GetCanvas (ArkUI_DrawContext * context) 8698``` 8699**Description** 8700 8701Obtains the drawing canvas pointer, which can be converted into the OH_Drawing_Canvas pointer of the graphics library for drawing. 8702 8703**Since**: 12 8704 8705**Parameters** 8706 8707| Name| Description| 8708| -------- | -------- | 8709| context | Drawing context. | 8710 8711**Returns** 8712 8713Returns the pointer to the canvas for drawing. 8714 8715 8716### OH_ArkUI_DrawContext_GetSize() 8717 8718``` 8719ArkUI_IntSize OH_ArkUI_DrawContext_GetSize (ArkUI_DrawContext * context) 8720``` 8721**Description** 8722 8723Obtains the size of a drawing area. 8724 8725**Since**: 12 8726 8727**Parameters** 8728 8729| Name| Description| 8730| -------- | -------- | 8731| context | Drawing context. | 8732 8733**Returns** 8734 8735Returns the size of the drawing area. 8736 8737 8738### OH_ArkUI_GestureEvent_GetActionType() 8739 8740``` 8741ArkUI_GestureEventActionType OH_ArkUI_GestureEvent_GetActionType (const ArkUI_GestureEvent * event) 8742``` 8743**Description** 8744 8745Obtains the gesture event type. 8746 8747**Since**: 12 8748 8749**Parameters** 8750 8751| Name| Description| 8752| -------- | -------- | 8753| event | Gesture event. | 8754 8755**Returns** 8756 8757Returns the gesture event type. 8758 8759 8760### OH_ArkUI_GestureEvent_GetNode() 8761 8762``` 8763ArkUI_NodeHandle OH_ArkUI_GestureEvent_GetNode (const ArkUI_GestureEvent * event) 8764``` 8765**Description** 8766 8767Obtains the ArkUI component to which the gesture is bound. 8768 8769**Since**: 12 8770 8771**Parameters** 8772 8773| Name| Description| 8774| -------- | -------- | 8775| event | Gesture event. | 8776 8777**Returns** 8778 8779Returns the ArkUI component. 8780 8781 8782### OH_ArkUI_GestureEvent_GetRawInputEvent() 8783 8784``` 8785const ArkUI_UIInputEvent* OH_ArkUI_GestureEvent_GetRawInputEvent (const ArkUI_GestureEvent * event) 8786``` 8787**Description** 8788 8789Obtains gesture input. 8790 8791**Since**: 12 8792 8793**Parameters** 8794 8795| Name| Description| 8796| -------- | -------- | 8797| event | Gesture event. | 8798 8799**Returns** 8800 8801Returns the pointer to the input event of the gesture event. 8802 8803 8804### OH_ArkUI_GestureEvent_GetResponseNode() 8805 8806``` 8807ArkUI_NodeHandle OH_ArkUI_GestureEvent_GetResponseNode (ArkUI_GestureEvent * event) 8808``` 8809**Description** 8810 8811Obtains the node that responds to the gesture. 8812 8813**Since**: 12 8814 8815**Parameters** 8816 8817| Name| Description| 8818| -------- | -------- | 8819| event | Gesture event. | 8820 8821**Returns** 8822 8823Returns the pointer to the node if the node exists; returns **NULL** otherwise. 8824 8825 8826### OH_ArkUI_GestureEventTargetInfo_IsScrollBegin() 8827 8828``` 8829int32_t OH_ArkUI_GestureEventTargetInfo_IsScrollBegin (ArkUI_GestureEventTargetInfo * info, bool * ret ) 8830``` 8831**Description** 8832 8833Obtains whether this scroll container is scrolled to the top. 8834 8835**Since**: 12 8836 8837**Parameters** 8838 8839| Name| Description| 8840| -------- | -------- | 8841| info | Gesture event target information. | 8842| ret | Obtains whether this scroll container is scrolled to the top. | 8843 8844**Returns** 8845 8846Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. Returns **180001** if the component is not a scroll container. 8847 8848 8849### OH_ArkUI_GestureEventTargetInfo_IsScrollEnd() 8850 8851``` 8852int32_t OH_ArkUI_GestureEventTargetInfo_IsScrollEnd (ArkUI_GestureEventTargetInfo * info, bool * ret ) 8853``` 8854**Description** 8855 8856Obtains whether this scroll container is scrolled to the bottom. 8857 8858**Since**: 12 8859 8860**Parameters** 8861 8862| Name| Description| 8863| -------- | -------- | 8864| info | Gesture event target information. | 8865| ret | Obtains whether this scroll container is scrolled to the bottom. | 8866 8867**Returns** 8868 8869Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. Returns **180001** if the component is not a scroll container. 8870 8871 8872### OH_ArkUI_GestureInterruptInfo_GetGestureEvent() 8873 8874``` 8875ArkUI_GestureEvent* OH_ArkUI_GestureInterruptInfo_GetGestureEvent (const ArkUI_GestureInterruptInfo * event) 8876``` 8877**Description** 8878 8879Obtains the pointer to the interrupted gesture event. 8880 8881**Since**: 12 8882 8883**Parameters** 8884 8885| Name| Description| 8886| -------- | -------- | 8887| event | Interrupt callback event. | 8888 8889**Returns** 8890 8891Returns the pointer to the interrupted gesture event. 8892 8893 8894### OH_ArkUI_GestureInterruptInfo_GetRecognizer() 8895 8896``` 8897ArkUI_GestureRecognizer* OH_ArkUI_GestureInterruptInfo_GetRecognizer (const ArkUI_GestureInterruptInfo * event) 8898``` 8899**Description** 8900 8901Returns the pointer to interrupted gesture recognizer. 8902 8903**Since**: 12 8904 8905**Parameters** 8906 8907| Name| Description| 8908| -------- | -------- | 8909| event | Interrupt callback event. | 8910 8911**Returns** 8912 8913Pointer to the interrupted gesture. 8914 8915 8916### OH_ArkUI_GestureInterruptInfo_GetSystemFlag() 8917 8918``` 8919bool OH_ArkUI_GestureInterruptInfo_GetSystemFlag (const ArkUI_GestureInterruptInfo * event) 8920``` 8921**Description** 8922 8923Checks whether a gesture is a built-in gesture of the component. 8924 8925**Since**: 12 8926 8927**Parameters** 8928 8929| Name| Description| 8930| -------- | -------- | 8931| event | Gesture interrupt callback event. | 8932 8933**Returns** 8934 8935true: built-in gestures; false: non-built-in gestures. 8936 8937 8938### OH_ArkUI_GestureInterruptInfo_GetSystemRecognizerType() 8939 8940``` 8941int32_t OH_ArkUI_GestureInterruptInfo_GetSystemRecognizerType (const ArkUI_GestureInterruptInfo * event) 8942``` 8943**Description** 8944 8945Obtains the type of the system gesture to trigger. 8946 8947**Since**: 12 8948 8949**Parameters** 8950 8951| Name| Description| 8952| -------- | -------- | 8953| event | Interrupt callback event. | 8954 8955**Returns** 8956 8957Returns the type of the system gesture to trigger. If the gesture to trigger is not a system gesture, **-1** is returned. 8958 8959 8960### OH_ArkUI_GetContextByNode() 8961 8962``` 8963ArkUI_ContextHandle OH_ArkUI_GetContextByNode (ArkUI_NodeHandle node) 8964``` 8965**Description** 8966 8967Obtains the pointer to the UI context object of the specified node. 8968 8969**Since**: 12 8970 8971**Parameters** 8972 8973| Name| Description| 8974| -------- | -------- | 8975| node | Specified node. | 8976 8977**Returns** 8978 8979Returns the pointer to the UI context object. 8980 8981 8982### OH_ArkUI_GetContextFromNapiValue() 8983 8984``` 8985int32_t OH_ArkUI_GetContextFromNapiValue (napi_env env, napi_value value, ArkUI_ContextHandle * context ) 8986``` 8987**Description** 8988 8989Obtains a **UIContext** object on the ArkTS side and maps it to an **ArkUI_ContextHandle** object on the native side. 8990 8991**Since**: 12 8992 8993**Parameters** 8994 8995| Name| Description| 8996| -------- | -------- | 8997| env | Pointer to the NAPI environment. | 8998| value | Context object created on the ArkTS side. | 8999| context | ArkUI_ContextHandle pointer. | 9000 9001**Returns** 9002 9003Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9004 9005 9006### OH_ArkUI_GetDrawableDescriptorFromNapiValue() 9007 9008``` 9009int32_t OH_ArkUI_GetDrawableDescriptorFromNapiValue (napi_env env, napi_value value, ArkUI_DrawableDescriptor ** drawableDescriptor ) 9010``` 9011**Description** 9012 9013Maps a **DrawableDescriptor** object on the ArkTS side to an **ArkUI_DrawableDescriptor** object on the native side. 9014 9015**Since**: 12 9016 9017**Parameters** 9018 9019| Name| Description| 9020| -------- | -------- | 9021| env | Pointer to the NAPI environment. | 9022| value | **DrawableDescriptor** object created on the ArkTS side. | 9023| drawableDescriptor | Object that receives the pointer to the **ArkUI_DrawableDescriptor** object. | 9024 9025**Returns** 9026 9027Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9028 9029 9030### OH_ArkUI_GetDrawableDescriptorFromResourceNapiValue() 9031 9032``` 9033int32_t OH_ArkUI_GetDrawableDescriptorFromResourceNapiValue (napi_env env, napi_value value, ArkUI_DrawableDescriptor ** drawableDescriptor ) 9034``` 9035**Description** 9036 9037Maps an $r resource object on the ArkTS side to an **ArkUI_DrawableDescriptor** object on the native side. 9038 9039**Since**: 12 9040 9041**Parameters** 9042 9043| Name| Description| 9044| -------- | -------- | 9045| env | Pointer to the NAPI environment. | 9046| value | $r resource object created on ArkTS. | 9047| drawableDescriptor | Object that receives the pointer to the **ArkUI_DrawableDescriptor** object. | 9048 9049**Returns** 9050 9051Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9052 9053 9054### OH_ArkUI_GetGestureBindNodeId() 9055 9056``` 9057int32_t OH_ArkUI_GetGestureBindNodeId (ArkUI_GestureRecognizer * recognizer, char * nodeId, int32_t size, int32_t * result ) 9058``` 9059**Description** 9060 9061Obtains the ID of the component linked to a gesture recognizer. 9062 9063**Since**: 12 9064 9065**Parameters** 9066 9067| Name| Description| 9068| -------- | -------- | 9069| recognizer | Pointer to the gesture recognizer. | 9070| nodeId | ID of a component. | 9071| size | Size of the storage area. | 9072| result | Length of the string to be copied. | 9073 9074**Returns** 9075 9076Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. Returns **180002** if the buffer is not large enough. 9077 9078 9079### OH_ArkUI_GetGestureEventTargetInfo() 9080 9081``` 9082int32_t OH_ArkUI_GetGestureEventTargetInfo (ArkUI_GestureRecognizer * recognizer, ArkUI_GestureEventTargetInfo ** info ) 9083``` 9084**Description** 9085 9086Obtains the information about a gesture event target. 9087 9088**Since**: 12 9089 9090**Parameters** 9091 9092| Name| Description| 9093| -------- | -------- | 9094| recognizer | Pointer to the gesture recognizer. | 9095| info | Gesture event target information. | 9096 9097**Returns** 9098 9099Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 9100 9101 9102### OH_ArkUI_GetGestureRecognizerEnabled() 9103 9104``` 9105bool OH_ArkUI_GetGestureRecognizerEnabled (ArkUI_GestureRecognizer * recognizer) 9106``` 9107**Description** 9108 9109Obtains the enabled state of a gesture recognizer. 9110 9111**Since**: 12 9112 9113**Parameters** 9114 9115| Name| Description| 9116| -------- | -------- | 9117| recognizer | Pointer to the gesture recognizer. | 9118 9119**Returns** 9120 9121**true**: enabled false: disabled 9122 9123 9124### OH_ArkUI_GetGestureRecognizerState() 9125 9126``` 9127int32_t OH_ArkUI_GetGestureRecognizerState (ArkUI_GestureRecognizer * recognizer, ArkUI_GestureRecognizerState * state ) 9128``` 9129**Description** 9130 9131Obtains the state of a gesture recognizer. 9132 9133**Since**: 12 9134 9135**Parameters** 9136 9137| Name| Description| 9138| -------- | -------- | 9139| recognizer | Pointer to the gesture recognizer. | 9140| state | Status of the gesture recognizer. | 9141 9142**Returns** 9143 9144Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 9145 9146 9147### OH_ArkUI_GetGestureTag() 9148 9149``` 9150int32_t OH_ArkUI_GetGestureTag (ArkUI_GestureRecognizer * recognizer, char * buffer, int32_t bufferSize, int32_t * result ) 9151``` 9152**Description** 9153 9154Obtains the mark of the gesture recognizer. 9155 9156**Since**: 12 9157 9158**Parameters** 9159 9160| Name| Description| 9161| -------- | -------- | 9162| recognizer | Pointer to the gesture recognizer. | 9163| buffer | Storage zone | 9164| bufferSize | Size of the storage area. | 9165| result | Length of the string to be copied. | 9166 9167**Returns** 9168 9169Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. Returns **180002** if the buffer is not large enough. 9170 9171 9172### OH_ArkUI_GetNavDestinationId() 9173 9174``` 9175ArkUI_ErrorCode OH_ArkUI_GetNavDestinationId (ArkUI_NodeHandle node, char * buffer, int32_t bufferSize, int32_t * writeLength ) 9176``` 9177**Description** 9178 9179Obtains the ID of the **NavDestination** component where the specified node is located. 9180 9181**Since**: 12 9182 9183**Parameters** 9184 9185| Name| Description| 9186| -------- | -------- | 9187| node | Specified node. | 9188| buffer | buffer. NavDestinationID is written to this memory area. | 9189| bufferSize | Pointer to the buffer size. | 9190| 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. | 9191 9192**Returns** 9193 9194Returns **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. 9195 9196 9197### OH_ArkUI_GetNavDestinationIndex() 9198 9199``` 9200ArkUI_ErrorCode OH_ArkUI_GetNavDestinationIndex (ArkUI_NodeHandle node, int32_t * index ) 9201``` 9202**Description** 9203 9204Obtains the index of the **NavDestination** component where the specified node is located in the navigation stack. 9205 9206**Since**: 12 9207 9208**Parameters** 9209 9210| Name| Description| 9211| -------- | -------- | 9212| node | Specified node. | 9213| index | Returns the index, starting from 0. | 9214 9215**Returns** 9216 9217Returns **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. 9218 9219 9220### OH_ArkUI_GetNavDestinationName() 9221 9222``` 9223ArkUI_ErrorCode OH_ArkUI_GetNavDestinationName (ArkUI_NodeHandle node, char * buffer, int32_t bufferSize, int32_t * writeLength ) 9224``` 9225**Description** 9226 9227Obtains the name of the **NavDestination** component where the specified node is located. 9228 9229**Since**: 12 9230 9231**Parameters** 9232 9233| Name| Description| 9234| -------- | -------- | 9235| node | Specified node. | 9236| buffer | Buffer. The queried NavDestination name is written to this memory area. | 9237| bufferSize | Pointer to the buffer size. | 9238| 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. | 9239 9240**Returns** 9241 9242Returns **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. 9243 9244 9245### OH_ArkUI_GetNavDestinationNameByIndex() 9246 9247``` 9248ArkUI_ErrorCode OH_ArkUI_GetNavDestinationNameByIndex (ArkUI_NodeHandle node, int32_t index, char * buffer, int32_t bufferSize, int32_t * writeLength ) 9249``` 9250**Description** 9251 9252Obtains 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. 9253 9254**Since**: 12 9255 9256**Parameters** 9257 9258| Name| Description| 9259| -------- | -------- | 9260| node | Specified node. | 9261| index | Index of the queried NavDestination in the stack. | 9262| buffer | Buffer. The name of the queried page is written to this memory area. | 9263| bufferSize | Pointer to the buffer size. | 9264| 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. | 9265 9266**Returns** 9267 9268Returns **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. 9269 9270 9271### OH_ArkUI_GetNavDestinationParam() 9272 9273``` 9274napi_value OH_ArkUI_GetNavDestinationParam (ArkUI_NodeHandle node) 9275``` 9276**Description** 9277 9278Obtains the parameters of the **NavDestination** component where the specified node is located. 9279 9280**Since**: 12 9281 9282**Parameters** 9283 9284| Name| Description| 9285| -------- | -------- | 9286| node | Specified node. | 9287 9288**Returns** 9289 9290Parameter object. 9291 9292 9293### OH_ArkUI_GetNavDestinationState() 9294 9295``` 9296ArkUI_ErrorCode OH_ArkUI_GetNavDestinationState (ArkUI_NodeHandle node, ArkUI_NavDestinationState * state ) 9297``` 9298**Description** 9299 9300Obtains the state of the **NavDestination** component where the specified node is located. 9301 9302**Since**: 12 9303 9304**Parameters** 9305 9306| Name| Description| 9307| -------- | -------- | 9308| node | Specified node. | 9309| state | The status value of NavDestination is written back to this parameter. | 9310 9311**Returns** 9312 9313The 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. 9314 9315 9316### OH_ArkUI_GetNavigationId() 9317 9318``` 9319ArkUI_ErrorCode OH_ArkUI_GetNavigationId (ArkUI_NodeHandle node, char * buffer, int32_t bufferSize, int32_t * writeLength ) 9320``` 9321**Description** 9322 9323Obtains the ID of the **Navigation** component where the specified node is located. 9324 9325**Since**: 12 9326 9327**Parameters** 9328 9329| Name| Description| 9330| -------- | -------- | 9331| node | Specified node. | 9332| buffer | buffer. The NavigationID is written to this memory area. | 9333| bufferSize | Pointer to the buffer size. | 9334| 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. | 9335 9336**Returns** 9337 9338Returns **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. 9339 9340 9341### OH_ArkUI_GetNavStackLength() 9342 9343``` 9344ArkUI_ErrorCode OH_ArkUI_GetNavStackLength (ArkUI_NodeHandle node, int32_t * length ) 9345``` 9346**Description** 9347 9348Obtains the length of the navigation stack where the specified node is located. 9349 9350**Since**: 12 9351 9352**Parameters** 9353 9354| Name| Description| 9355| -------- | -------- | 9356| node | Specified node. | 9357| length | Length of the stack. The result, if obtained successfully, is written back to this parameter. | 9358 9359**Returns** 9360 9361Returns **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. 9362 9363 9364### OH_ArkUI_GetNodeContentFromNapiValue() 9365 9366``` 9367int32_t OH_ArkUI_GetNodeContentFromNapiValue (napi_env env, napi_value value, ArkUI_NodeContentHandle * content ) 9368``` 9369**Description** 9370 9371Obtains a **NodeContent** object on the ArkTS side and maps it to an **ArkUI_NodeContentHandle** object on the native side. 9372 9373**Since**: 12 9374 9375**Parameters** 9376 9377| Name| Description| 9378| -------- | -------- | 9379| env | Pointer to the NAPI environment. | 9380| value | NodeContent object created on ArkTS. | 9381| context | ArkUI_NodeContentHandle pointer. | 9382 9383**Returns** 9384 9385Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9386 9387 9388### OH_ArkUI_GetNodeHandleFromNapiValue() 9389 9390``` 9391int32_t OH_ArkUI_GetNodeHandleFromNapiValue (napi_env env, napi_value frameNode, ArkUI_NodeHandle * handle ) 9392``` 9393**Description** 9394 9395Obtains a **FrameNode** object on the ArkTS side and maps it to an **ArkUI_NodeHandle** object on the native side. 9396 9397**Since**: 12 9398 9399**Parameters** 9400 9401| Name| Description| 9402| -------- | -------- | 9403| env | Pointer to the NAPI environment. | 9404| frameNode | FrameNode object created on the ArkTS side. | 9405| handle | **ArkUI_NodeHandle** pointer. | 9406 9407**Returns** 9408 9409Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9410 9411### OH_ArkUI_GetPanGestureDirectionMask() 9412 9413``` 9414int32_t OH_ArkUI_GetPanGestureDirectionMask (ArkUI_GestureRecognizer * recognizer, ArkUI_GestureDirectionMask * directionMask ) 9415``` 9416**Description** 9417 9418Obtains the direction of a pan gesture. 9419 9420**Since**: 12 9421 9422**Parameters** 9423 9424| Name| Description| 9425| -------- | -------- | 9426| recognizer | Pointer to the gesture recognizer. | 9427| directionMask | Sliding direction of the sliding gesture. | 9428 9429**Returns** 9430 9431Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 9432 9433 9434### OH_ArkUI_GetResponseRecognizersFromInterruptInfo() 9435 9436``` 9437int32_t OH_ArkUI_GetResponseRecognizersFromInterruptInfo (const ArkUI_GestureInterruptInfo * event, ArkUI_GestureRecognizerHandleArray * responseChain, int32_t * count ) 9438``` 9439**Description** 9440 9441Obtains information about a gesture response chain. 9442 9443**Since**: 12 9444 9445**Parameters** 9446 9447| Name| Description| 9448| -------- | -------- | 9449| event | Gesture interrupt callback event. | 9450| responseChain | Gesture recognizer on the response chain component. | 9451| count | Number of gesture recognizers on the response chain component. | 9452 9453**Returns** 9454 9455Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 9456 9457 9458### OH_ArkUI_GetRouterPageId() 9459 9460``` 9461ArkUI_ErrorCode OH_ArkUI_GetRouterPageId (ArkUI_NodeHandle node, char * buffer, int32_t bufferSize, int32_t * writeLength ) 9462``` 9463**Description** 9464 9465Obtains the ID of the page where the specified node is located. 9466 9467**Since**: 12 9468 9469**Parameters** 9470 9471| Name| Description| 9472| -------- | -------- | 9473| node | Specified node. | 9474| buffer | buffer. Page Id is written to this memory area. | 9475| bufferSize | Pointer to the buffer size. | 9476| 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. | 9477 9478**Returns** 9479 9480Returns **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. 9481 9482 9483### OH_ArkUI_GetRouterPageIndex() 9484 9485``` 9486ArkUI_ErrorCode OH_ArkUI_GetRouterPageIndex (ArkUI_NodeHandle node, int32_t * index ) 9487``` 9488**Description** 9489 9490Obtains the index of the page where the specified node is located in the page stack for routing. 9491 9492**Since**: 12 9493 9494**Parameters** 9495 9496| Name| Description| 9497| -------- | -------- | 9498| node | Specified node. | 9499| index | Returns the index, starting from 1. | 9500 9501**Returns** 9502 9503Returns **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. 9504 9505 9506### OH_ArkUI_GetRouterPageName() 9507 9508``` 9509ArkUI_ErrorCode OH_ArkUI_GetRouterPageName (ArkUI_NodeHandle node, char * buffer, int32_t bufferSize, int32_t * writeLength ) 9510``` 9511**Description** 9512 9513Obtains the name of the page where the specified node is located. 9514 9515**Since**: 12 9516 9517**Parameters** 9518 9519| Name| Description| 9520| -------- | -------- | 9521| node | Specified node. | 9522| buffer | Buffer. The page name is written to this memory area. | 9523| bufferSize | Pointer to the buffer size. | 9524| 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. | 9525 9526**Returns** 9527 9528Returns **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. 9529 9530 9531### OH_ArkUI_GetRouterPagePath() 9532 9533``` 9534ArkUI_ErrorCode OH_ArkUI_GetRouterPagePath (ArkUI_NodeHandle node, char * buffer, int32_t bufferSize, int32_t * writeLength ) 9535``` 9536**Description** 9537 9538Obtains the path to the page where the specified node is located. 9539 9540**Since**: 12 9541 9542**Parameters** 9543 9544| Name| Description| 9545| -------- | -------- | 9546| node | Specified node. | 9547| buffer | buffer. Page Path is written to this memory area. | 9548| bufferSize | Pointer to the buffer size. | 9549| 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. | 9550 9551**Returns** 9552 9553Returns **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. 9554 9555 9556### OH_ArkUI_GetRouterPageState() 9557 9558``` 9559ArkUI_ErrorCode OH_ArkUI_GetRouterPageState (ArkUI_NodeHandle node, ArkUI_RouterPageState * state ) 9560``` 9561**Description** 9562 9563Obtains the state of the page where the specified node is located. 9564 9565**Since**: 12 9566 9567**Parameters** 9568 9569| Name| Description| 9570| -------- | -------- | 9571| node | Specified node. | 9572| state | The status value of Router Page is written back to this parameter. | 9573 9574**Returns** 9575 9576The error code ARKUI_ERROR_CODE_NO_ERROR is returned. The ARKUI_ERROR_CODE_GET_INFO_FAILED fails to query information. 9577 9578 9579### OH_ArkUI_GuidelineOption_Create() 9580 9581``` 9582ArkUI_GuidelineOption* OH_ArkUI_GuidelineOption_Create (int32_t size) 9583``` 9584**Description** 9585 9586Creates a guideline configuration for this **RelativeContainer**. 9587 9588**Since**: 12 9589 9590**Parameters** 9591 9592| Name| Description| 9593| -------- | -------- | 9594| size | Number of guidelines. | 9595 9596**Returns** 9597 9598Returns the guideline configuration. 9599 9600 9601### OH_ArkUI_GuidelineOption_Dispose() 9602 9603``` 9604void OH_ArkUI_GuidelineOption_Dispose (ArkUI_GuidelineOption * guideline) 9605``` 9606**Description** 9607 9608Destroys auxiliary line information. 9609 9610**Since**: 12 9611 9612**Parameters** 9613 9614| Name| Description| 9615| -------- | -------- | 9616| guideline | Pointer to a guideline configuration. | 9617 9618 9619### OH_ArkUI_GuidelineOption_GetDirection() 9620 9621``` 9622ArkUI_Axis OH_ArkUI_GuidelineOption_GetDirection (ArkUI_GuidelineOption * guideline, int32_t index ) 9623``` 9624**Description** 9625 9626Obtains the direction of a guideline. 9627 9628**Since**: 12 9629 9630**Parameters** 9631 9632| Name| Description| 9633| -------- | -------- | 9634| guideline | Pointer to a guideline configuration. | 9635| index | Index of the guideline. | 9636 9637**Returns** 9638 9639Returns the direction of the guideline. 9640 9641 9642### OH_ArkUI_GuidelineOption_GetId() 9643 9644``` 9645const char* OH_ArkUI_GuidelineOption_GetId (ArkUI_GuidelineOption * guideline, int32_t index ) 9646``` 9647**Description** 9648 9649Obtains the ID of a guideline. 9650 9651**Since**: 12 9652 9653**Parameters** 9654 9655| Name| Description| 9656| -------- | -------- | 9657| guideline | Pointer to a guideline configuration. | 9658| index | Index of the guideline. | 9659 9660**Returns** 9661 9662Returns the ID of the guideline. 9663 9664 9665### OH_ArkUI_GuidelineOption_GetPositionEnd() 9666 9667``` 9668float OH_ArkUI_GuidelineOption_GetPositionEnd (ArkUI_GuidelineOption * guideline, int32_t index ) 9669``` 9670**Description** 9671 9672Obtains the distance between a guideline and the right or bottom of the container. 9673 9674**Since**: 12 9675 9676**Parameters** 9677 9678| Name| Description| 9679| -------- | -------- | 9680| guideline | Pointer to a guideline configuration. | 9681| index | Index of the guideline. | 9682 9683**Returns** 9684 9685Distance between the guideline and the right or bottom of the container. 9686 9687 9688### OH_ArkUI_GuidelineOption_GetPositionStart() 9689 9690``` 9691float OH_ArkUI_GuidelineOption_GetPositionStart (ArkUI_GuidelineOption * guideline, int32_t index ) 9692``` 9693**Description** 9694 9695Obtains the distance between a guideline and the left or top of the container. 9696 9697**Since**: 12 9698 9699**Parameters** 9700 9701| Name| Description| 9702| -------- | -------- | 9703| guideline | Pointer to a guideline configuration. | 9704| index | Index of the guideline. | 9705 9706**Returns** 9707 9708Distance between the guideline and the left or top of the container. 9709 9710 9711### OH_ArkUI_GuidelineOption_SetDirection() 9712 9713``` 9714void OH_ArkUI_GuidelineOption_SetDirection (ArkUI_GuidelineOption * guideline, ArkUI_Axis value, int32_t index ) 9715``` 9716**Description** 9717 9718Sets the direction of a guideline. 9719 9720**Since**: 12 9721 9722**Parameters** 9723 9724| Name| Description| 9725| -------- | -------- | 9726| guideline | Pointer to a guideline configuration. | 9727| value | Direction. | 9728| index | Index of the guideline. | 9729 9730 9731### OH_ArkUI_GuidelineOption_SetId() 9732 9733``` 9734void OH_ArkUI_GuidelineOption_SetId (ArkUI_GuidelineOption * guideline, const char * value, int32_t index ) 9735``` 9736**Description** 9737 9738Sets the ID of a guideline. 9739 9740**Since**: 12 9741 9742**Parameters** 9743 9744| Name| Description| 9745| -------- | -------- | 9746| guideline | Pointer to a guideline configuration. | 9747| value | ID of the guideline, which must be unique and cannot be the same as the name of any component in the container. | 9748| index | Index of the guideline. | 9749 9750 9751### OH_ArkUI_GuidelineOption_SetPositionEnd() 9752 9753``` 9754void OH_ArkUI_GuidelineOption_SetPositionEnd (ArkUI_GuidelineOption * guideline, float value, int32_t index ) 9755``` 9756**Description** 9757 9758Sets the distance between a guideline and the right or bottom of the container. 9759 9760**Since**: 12 9761 9762**Parameters** 9763 9764| Name| Description| 9765| -------- | -------- | 9766| guideline | Pointer to a guideline configuration. | 9767| value | Distance between the guideline and the right or bottom of the container. | 9768| index | Index of the guideline. | 9769 9770 9771### OH_ArkUI_GuidelineOption_SetPositionStart() 9772 9773``` 9774void OH_ArkUI_GuidelineOption_SetPositionStart (ArkUI_GuidelineOption * guideline, float value, int32_t index ) 9775``` 9776**Description** 9777 9778Sets the distance between a guideline and the left or top of the container. 9779 9780**Since**: 12 9781 9782**Parameters** 9783 9784| Name| Description| 9785| -------- | -------- | 9786| guideline | Pointer to a guideline configuration. | 9787| value | Distance between the guideline and the left or top of the container. | 9788| index | Index of the guideline. | 9789 9790 9791### OH_ArkUI_ImageAnimatorFrameInfo_CreateFromDrawableDescriptor() 9792 9793``` 9794ArkUI_ImageAnimatorFrameInfo* OH_ArkUI_ImageAnimatorFrameInfo_CreateFromDrawableDescriptor (ArkUI_DrawableDescriptor * drawable) 9795``` 9796**Description** 9797 9798Creates an image frame information object based on a **DrawableDescriptor** object, with the image format being Resource or PixelMap. 9799 9800**Since**: 12 9801 9802**Parameters** 9803 9804| Name| Description| 9805| -------- | -------- | 9806| drawable | Pointer to an **ArkUI_DrawableDescriptor** object created using Resource or PixelMap. | 9807 9808**Returns** 9809 9810Returns the pointer to the created frame image object. 9811 9812 9813### OH_ArkUI_ImageAnimatorFrameInfo_CreateFromString() 9814 9815``` 9816ArkUI_ImageAnimatorFrameInfo* OH_ArkUI_ImageAnimatorFrameInfo_CreateFromString (char * src) 9817``` 9818**Description** 9819 9820Creates an image frame information object based on an image path, with the image format being SVG, PNG, or JPG. 9821 9822**Since**: 12 9823 9824**Parameters** 9825 9826| Name| Description| 9827| -------- | -------- | 9828| src | Image path. | 9829 9830**Returns** 9831 9832Returns the pointer to the created frame image object. 9833 9834 9835### OH_ArkUI_ImageAnimatorFrameInfo_Dispose() 9836 9837``` 9838void OH_ArkUI_ImageAnimatorFrameInfo_Dispose (ArkUI_ImageAnimatorFrameInfo * imageInfo) 9839``` 9840**Description** 9841 9842Disposes of the pointer to an image frame information object. 9843 9844**Since**: 12 9845 9846**Parameters** 9847 9848| Name| Description| 9849| -------- | -------- | 9850| imageInfo | Pointer to the frame image object. | 9851 9852 9853### OH_ArkUI_ImageAnimatorFrameInfo_GetDuration() 9854 9855``` 9856int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetDuration (ArkUI_ImageAnimatorFrameInfo * imageInfo) 9857``` 9858**Description** 9859 9860Obtains the playback duration of an image. 9861 9862**Since**: 12 9863 9864**Parameters** 9865 9866| Name| Description| 9867| -------- | -------- | 9868| imageInfo | Pointer to the frame image object. | 9869 9870**Returns** 9871 9872Returns the playback duration of the image, in milliseconds. If **imageInfo** is a null pointer, **0** is returned. 9873 9874 9875### OH_ArkUI_ImageAnimatorFrameInfo_GetHeight() 9876 9877``` 9878int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetHeight (ArkUI_ImageAnimatorFrameInfo * imageInfo) 9879``` 9880**Description** 9881 9882Obtains the image height. 9883 9884**Since**: 12 9885 9886**Parameters** 9887 9888| Name| Description| 9889| -------- | -------- | 9890| imageInfo | Pointer to the frame image object. | 9891 9892**Returns** 9893 9894Returns the image height, in PX. If **imageInfo** is a null pointer, **0** is returned. 9895 9896 9897### OH_ArkUI_ImageAnimatorFrameInfo_GetLeft() 9898 9899``` 9900int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetLeft (ArkUI_ImageAnimatorFrameInfo * imageInfo) 9901``` 9902**Description** 9903 9904Obtains the horizontal coordinate of an image relative to the upper left corner of the component. 9905 9906**Since**: 12 9907 9908**Parameters** 9909 9910| Name| Description| 9911| -------- | -------- | 9912| imageInfo | Pointer to the frame image object. | 9913 9914**Returns** 9915 9916Returns 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. 9917 9918 9919### OH_ArkUI_ImageAnimatorFrameInfo_GetTop() 9920 9921``` 9922int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetTop (ArkUI_ImageAnimatorFrameInfo * imageInfo) 9923``` 9924**Description** 9925 9926Obtains the vertical coordinate of an image relative to the upper left corner of the component. 9927 9928**Since**: 12 9929 9930**Parameters** 9931 9932| Name| Description| 9933| -------- | -------- | 9934| imageInfo | Pointer to the frame image object. | 9935 9936**Returns** 9937 9938Returns 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. 9939 9940 9941### OH_ArkUI_ImageAnimatorFrameInfo_GetWidth() 9942 9943``` 9944int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetWidth (ArkUI_ImageAnimatorFrameInfo * imageInfo) 9945``` 9946**Description** 9947 9948Obtains the image width. 9949 9950**Since**: 12 9951 9952**Parameters** 9953 9954| Name| Description| 9955| -------- | -------- | 9956| imageInfo | Pointer to the frame image object. | 9957 9958**Returns** 9959 9960Returns the image width, in PX. If **imageInfo** is a null pointer, **0** is returned. 9961 9962 9963### OH_ArkUI_ImageAnimatorFrameInfo_SetDuration() 9964 9965``` 9966void OH_ArkUI_ImageAnimatorFrameInfo_SetDuration (ArkUI_ImageAnimatorFrameInfo * imageInfo, int32_t duration ) 9967``` 9968**Description** 9969 9970Sets the playback duration of an image. 9971 9972**Since**: 12 9973 9974**Parameters** 9975 9976| Name| Description| 9977| -------- | -------- | 9978| imageInfo | Pointer to the frame image object. | 9979| duration | Playback duration of an image, in milliseconds. | 9980 9981 9982### OH_ArkUI_ImageAnimatorFrameInfo_SetHeight() 9983 9984``` 9985void OH_ArkUI_ImageAnimatorFrameInfo_SetHeight (ArkUI_ImageAnimatorFrameInfo * imageInfo, int32_t height ) 9986``` 9987**Description** 9988 9989Sets the image height. 9990 9991**Since**: 12 9992 9993**Parameters** 9994 9995| Name| Description| 9996| -------- | -------- | 9997| imageInfo | Pointer to the frame image object. | 9998| height | Image height, in px. | 9999 10000 10001### OH_ArkUI_ImageAnimatorFrameInfo_SetLeft() 10002 10003``` 10004void OH_ArkUI_ImageAnimatorFrameInfo_SetLeft (ArkUI_ImageAnimatorFrameInfo * imageInfo, int32_t left ) 10005``` 10006**Description** 10007 10008Sets the horizontal coordinate of an image relative to the upper left corner of the component. 10009 10010**Since**: 12 10011 10012**Parameters** 10013 10014| Name| Description| 10015| -------- | -------- | 10016| imageInfo | Pointer to the frame image object. | 10017| left | Horizontal coordinate of the image relative to the upper left corner of the component, in px. | 10018 10019 10020### OH_ArkUI_ImageAnimatorFrameInfo_SetTop() 10021 10022``` 10023void OH_ArkUI_ImageAnimatorFrameInfo_SetTop (ArkUI_ImageAnimatorFrameInfo * imageInfo, int32_t top ) 10024``` 10025**Description** 10026 10027Sets the vertical coordinate of an image relative to the upper left corner of the component. 10028 10029**Since**: 12 10030 10031**Parameters** 10032 10033| Name| Description| 10034| -------- | -------- | 10035| imageInfo | Pointer to the frame image object. | 10036| top | Vertical coordinate of the image relative to the upper left corner of the component, in px. | 10037 10038 10039### OH_ArkUI_ImageAnimatorFrameInfo_SetWidth() 10040 10041``` 10042void OH_ArkUI_ImageAnimatorFrameInfo_SetWidth (ArkUI_ImageAnimatorFrameInfo * imageInfo, int32_t width ) 10043``` 10044**Description** 10045 10046Sets the image width. 10047 10048**Since**: 12 10049 10050**Parameters** 10051 10052| Name| Description| 10053| -------- | -------- | 10054| imageInfo | Pointer to the frame image object. | 10055| width | Image width, in px. | 10056 10057 10058### OH_ArkUI_IsBuiltInGesture() 10059 10060``` 10061bool OH_ArkUI_IsBuiltInGesture (ArkUI_GestureRecognizer * recognizer) 10062``` 10063**Description** 10064 10065Obtains whether a gesture is a built-in gesture. 10066 10067**Since**: 12 10068 10069**Parameters** 10070 10071| Name| Description| 10072| -------- | -------- | 10073| recognizer | Pointer to the gesture recognizer. | 10074 10075**Returns** 10076 10077true: built-in gestures. false: The gesture is not a built-in gesture. 10078 10079 10080### OH_ArkUI_IsGestureRecognizerValid() 10081 10082``` 10083bool OH_ArkUI_IsGestureRecognizerValid (ArkUI_GestureRecognizer * recognizer) 10084``` 10085**Description** 10086 10087Obtains whether a gesture recognizer is valid. 10088 10089**Since**: 12 10090 10091**Parameters** 10092 10093| Name| Description| 10094| -------- | -------- | 10095| recognizer | Pointer to the gesture recognizer. | 10096 10097**Returns** 10098 10099true: The gesture recognizer is valid. Returns **false** if the gesture recognizer is invalid. 10100 10101 10102### OH_ArkUI_KeyEvent_GetKeyCode() 10103 10104``` 10105int32_t OH_ArkUI_KeyEvent_GetKeyCode (const ArkUI_UIInputEvent * event) 10106``` 10107**Description** 10108 10109Obtains the key code from a key event. 10110 10111**Since**: 14 10112 10113**Parameters** 10114 10115| Name| Description| 10116| -------- | -------- | 10117| event | Pointer to an **ArkUI_UIInputEvent** object. | 10118 10119**Returns** 10120 10121Key code. 10122 10123 10124### OH_ArkUI_KeyEvent_GetKeyIntensionCode() 10125 10126``` 10127ArkUI_KeyIntension OH_ArkUI_KeyEvent_GetKeyIntensionCode (const ArkUI_UIInputEvent * event) 10128``` 10129**Description** 10130 10131Obtains the intention code associated with a key event. 10132 10133**Since**: 14 10134 10135**Parameters** 10136 10137| Name| Description| 10138| -------- | -------- | 10139| event | Pointer to an **ArkUI_UIInputEvent** object. | 10140 10141**Returns** 10142 10143Returns the intention code associated with the key event. 10144 10145 10146### OH_ArkUI_KeyEvent_GetKeySource() 10147 10148``` 10149ArkUI_KeySourceType OH_ArkUI_KeyEvent_GetKeySource (const ArkUI_UIInputEvent * event) 10150``` 10151**Description** 10152 10153Obtains the type of input device that triggers a key event. 10154 10155**Since**: 14 10156 10157**Parameters** 10158 10159| Name| Description| 10160| -------- | -------- | 10161| event | Pointer to an **ArkUI_UIInputEvent** object. | 10162 10163**Returns** 10164 10165Returns the device type. 10166 10167 10168### OH_ArkUI_KeyEvent_GetKeyText() 10169 10170``` 10171const char* OH_ArkUI_KeyEvent_GetKeyText (const ArkUI_UIInputEvent * event) 10172``` 10173**Description** 10174 10175Obtains the key value from a key event. 10176 10177**Since**: 14 10178 10179**Parameters** 10180 10181| Name| Description| 10182| -------- | -------- | 10183| event | Pointer to an **ArkUI_UIInputEvent** object. | 10184 10185**Returns** 10186 10187Key value. 10188 10189 10190### OH_ArkUI_KeyEvent_GetType() 10191 10192``` 10193ArkUI_KeyEventType OH_ArkUI_KeyEvent_GetType (const ArkUI_UIInputEvent * event) 10194``` 10195**Description** 10196 10197Obtains the type of a key event. 10198 10199**Since**: 14 10200 10201**Parameters** 10202 10203| Name| Description| 10204| -------- | -------- | 10205| event | Pointer to an **ArkUI_UIInputEvent** object. | 10206 10207**Returns** 10208 10209Returns the key event type. 10210 10211 10212### OH_ArkUI_KeyEvent_GetUnicode() 10213 10214``` 10215uint32_t OH_ArkUI_KeyEvent_GetUnicode (const ArkUI_UIInputEvent * event) 10216``` 10217**Description** 10218 10219Obtains 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. 10220 10221**Since**: 14 10222 10223**Parameters** 10224 10225| Name| Description| 10226| -------- | -------- | 10227| event | Pointer to an **ArkUI_UIInputEvent** object. | 10228 10229**Returns** 10230 10231Returns the Unicode value. 10232 10233 10234### OH_ArkUI_KeyEvent_SetConsumed() 10235 10236``` 10237void OH_ArkUI_KeyEvent_SetConsumed (const ArkUI_UIInputEvent * event, bool isConsumed ) 10238``` 10239**Description** 10240 10241Sets whether a key event is consumed in the key event callback. 10242 10243**Since**: 14 10244 10245**Parameters** 10246 10247| Name| Description| 10248| -------- | -------- | 10249| event | Pointer to an **ArkUI_UIInputEvent** object. | 10250| isConsumed | Whether the event is consumed. | 10251 10252 10253### OH_ArkUI_KeyEvent_StopPropagation() 10254 10255``` 10256void OH_ArkUI_KeyEvent_StopPropagation (const ArkUI_UIInputEvent * event, bool stopPropagation ) 10257``` 10258**Description** 10259 10260Stops the event from bubbling upwards or downwards. 10261 10262**Since**: 14 10263 10264**Parameters** 10265 10266| Name| Description| 10267| -------- | -------- | 10268| event | Pointer to an **ArkUI_UIInputEvent** object. | 10269| stopPropagation | Whether to stop event propagation. | 10270 10271 10272### OH_ArkUI_KeyframeAnimateOption_Create() 10273 10274``` 10275ArkUI_KeyframeAnimateOption* OH_ArkUI_KeyframeAnimateOption_Create (int32_t size) 10276``` 10277**Description** 10278 10279Obtains the keyframe animation parameters. 10280 10281**Since**: 12 10282 10283**Parameters** 10284 10285| Name| Description| 10286| -------- | -------- | 10287| size | Number of key frame animation states. | 10288 10289**Returns** 10290 10291Returns the keyframe animation parameter object; returns **NULL** if the value of **size** is less than 0. 10292 10293 10294### OH_ArkUI_KeyframeAnimateOption_Dispose() 10295 10296``` 10297void OH_ArkUI_KeyframeAnimateOption_Dispose (ArkUI_KeyframeAnimateOption * option) 10298``` 10299**Description** 10300 10301Destroys a keyframe animation parameter object. 10302 10303**Since**: 12 10304 10305**Parameters** 10306 10307| Name| Description| 10308| -------- | -------- | 10309| option | Returns the keyframe animation parameter object; | 10310 10311 10312### OH_ArkUI_KeyframeAnimateOption_GetCurve() 10313 10314``` 10315ArkUI_CurveHandle OH_ArkUI_KeyframeAnimateOption_GetCurve (ArkUI_KeyframeAnimateOption * option, int32_t index ) 10316``` 10317**Description** 10318 10319Obtains the animation curve of a specific state in a keyframe animation. 10320 10321**Since**: 12 10322 10323**Parameters** 10324 10325| Name| Description| 10326| -------- | -------- | 10327| option | Keyframe animation parameters. | 10328| index | Status index. | 10329 10330**Returns** 10331 10332Returns the animation curve. 10333 10334 10335### OH_ArkUI_KeyframeAnimateOption_GetDelay() 10336 10337``` 10338int32_t OH_ArkUI_KeyframeAnimateOption_GetDelay (ArkUI_KeyframeAnimateOption * option) 10339``` 10340**Description** 10341 10342Obtains the overall delay of a keyframe animation 10343 10344**Since**: 12 10345 10346**Parameters** 10347 10348| Name| Description| 10349| -------- | -------- | 10350| option | Keyframe animation parameters. | 10351 10352**Returns** 10353 10354Returns the overall delay. 10355 10356 10357### OH_ArkUI_KeyframeAnimateOption_GetDuration() 10358 10359``` 10360int32_t OH_ArkUI_KeyframeAnimateOption_GetDuration (ArkUI_KeyframeAnimateOption * option, int32_t index ) 10361``` 10362**Description** 10363 10364Obtains the duration of a specific state in a keyframe animation. 10365 10366**Since**: 12 10367 10368**Parameters** 10369 10370| Name| Description| 10371| -------- | -------- | 10372| option | Keyframe animation parameters. | 10373| index | Status index. | 10374 10375**Returns** 10376 10377Duration, in milliseconds. 10378 10379 10380### OH_ArkUI_KeyframeAnimateOption_GetIterations() 10381 10382``` 10383int32_t OH_ArkUI_KeyframeAnimateOption_GetIterations (ArkUI_KeyframeAnimateOption * option) 10384``` 10385**Description** 10386 10387Obtains the number of times that a keyframe animation is played. 10388 10389**Since**: 12 10390 10391**Parameters** 10392 10393| Name| Description| 10394| -------- | -------- | 10395| option | Keyframe animation parameters. | 10396 10397**Returns** 10398 10399Number of times that the animation is played. 10400 10401 10402### OH_ArkUI_KeyframeAnimateOption_RegisterOnEventCallback() 10403 10404``` 10405int32_t OH_ArkUI_KeyframeAnimateOption_RegisterOnEventCallback (ArkUI_KeyframeAnimateOption * option, void * userData, void(*)(void *userData) event, int32_t index ) 10406``` 10407**Description** 10408 10409Sets 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. 10410 10411**Parameters** 10412 10413| Name| Description| 10414| -------- | -------- | 10415| option | Keyframe animation parameters. | 10416| event | Closure function. | 10417| userData | Pointer to a custom object. | 10418| index | Status index. | 10419 10420**Returns** 10421 10422Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 10423 10424 10425### OH_ArkUI_KeyframeAnimateOption_RegisterOnFinishCallback() 10426 10427``` 10428int32_t OH_ArkUI_KeyframeAnimateOption_RegisterOnFinishCallback (ArkUI_KeyframeAnimateOption * option, void * userData, void(*)(void *userData) onFinish ) 10429``` 10430**Description** 10431 10432Sets 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. 10433 10434**Parameters** 10435 10436| Name| Description| 10437| -------- | -------- | 10438| option | Keyframe animation parameters. | 10439| userData | Pointer to a custom object. | 10440| onFinish | Callback used to return the result. | 10441 10442**Returns** 10443 10444Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 10445 10446 10447### OH_ArkUI_KeyframeAnimateOption_SetCurve() 10448 10449``` 10450int32_t OH_ArkUI_KeyframeAnimateOption_SetCurve (ArkUI_KeyframeAnimateOption * option, ArkUI_CurveHandle value, int32_t index ) 10451``` 10452**Description** 10453 10454Sets the animation curve for a specific keyframe in a keyframe animation. 10455 10456**Parameters** 10457 10458| Name| Description| 10459| -------- | -------- | 10460| option | Keyframe animation parameters. | 10461| value | Animation curve used by the key frame. Default value: **EASE_IN_OUT**. | 10462| index | Status index. | 10463 10464**NOTE** 10465 10466Because the **springMotion**, **responsiveSpringMotion**, and **interpolatingSpring** curves do not have effective duration settings, they are not supported. 10467 10468**Returns** 10469 10470Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 10471 10472 10473### OH_ArkUI_KeyframeAnimateOption_SetDelay() 10474 10475``` 10476int32_t OH_ArkUI_KeyframeAnimateOption_SetDelay (ArkUI_KeyframeAnimateOption * option, int32_t value ) 10477``` 10478**Description** 10479 10480Sets the overall delay of a keyframe animation, in milliseconds. By default, the keyframe animation is played without delay. 10481 10482**Parameters** 10483 10484| Name| Description| 10485| -------- | -------- | 10486| option | Keyframe animation parameters. | 10487| value | Delay time, in milliseconds. | 10488 10489**Returns** 10490 10491Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 10492 10493 10494### OH_ArkUI_KeyframeAnimateOption_SetDuration() 10495 10496``` 10497int32_t OH_ArkUI_KeyframeAnimateOption_SetDuration (ArkUI_KeyframeAnimateOption * option, int32_t value, int32_t index ) 10498``` 10499**Description** 10500 10501Sets the duration of a keyframe animation, in milliseconds. 10502 10503**Parameters** 10504 10505| Name| Description| 10506| -------- | -------- | 10507| option | Keyframe animation parameters. | 10508| value | Duration, in milliseconds. | 10509| index | Status index. | 10510 10511**Returns** 10512 10513Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 10514 10515 10516### OH_ArkUI_KeyframeAnimateOption_SetIterations() 10517 10518``` 10519int32_t OH_ArkUI_KeyframeAnimateOption_SetIterations (ArkUI_KeyframeAnimateOption * option, int32_t value ) 10520``` 10521**Description** 10522 10523Sets 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. 10524 10525**Parameters** 10526 10527| Name| Description| 10528| -------- | -------- | 10529| option | Keyframe animation parameters. | 10530| value | Number of times that the animation is played. | 10531 10532**Returns** 10533 10534Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 10535 10536 10537### OH_ArkUI_LayoutConstraint_Copy() 10538 10539``` 10540ArkUI_LayoutConstraint* OH_ArkUI_LayoutConstraint_Copy (const ArkUI_LayoutConstraint * Constraint) 10541``` 10542**Description** 10543 10544Constraint size deep copy. 10545 10546**Since**: 12 10547 10548**Parameters** 10549 10550| Name| Description| 10551| -------- | -------- | 10552| Constraint | Size constraint. | 10553 10554**Returns** 10555 10556Pointer to the new constraint size. 10557 10558 10559### OH_ArkUI_LayoutConstraint_Create() 10560 10561``` 10562ArkUI_LayoutConstraint* OH_ArkUI_LayoutConstraint_Create () 10563``` 10564**Description** 10565 10566Create a constraint size. 10567 10568**Since**: 12 10569 10570 10571### OH_ArkUI_LayoutConstraint_Dispose() 10572 10573``` 10574void* OH_ArkUI_LayoutConstraint_Dispose (ArkUI_LayoutConstraint * Constraint) 10575``` 10576**Description** 10577 10578Pointer to the size of the destruction constraint. 10579 10580**Since**: 12 10581 10582**Parameters** 10583 10584| Name| Description| 10585| -------- | -------- | 10586| Constraint | Size constraint. | 10587 10588 10589### OH_ArkUI_LayoutConstraint_GetMaxHeight() 10590 10591``` 10592int32_t OH_ArkUI_LayoutConstraint_GetMaxHeight (const ArkUI_LayoutConstraint * Constraint) 10593``` 10594**Description** 10595 10596Obtains the maximum height for a size constraint, in px. 10597 10598**Since**: 12 10599 10600**Parameters** 10601 10602| Name| Description| 10603| -------- | -------- | 10604| Constraint | Size constraint. | 10605 10606**Returns** 10607 10608Maximum height. 10609 10610 10611### OH_ArkUI_LayoutConstraint_GetMaxWidth() 10612 10613``` 10614int32_t OH_ArkUI_LayoutConstraint_GetMaxWidth (const ArkUI_LayoutConstraint * Constraint) 10615``` 10616**Description** 10617 10618Obtains the maximum width for a size constraint, in px. 10619 10620**Since**: 12 10621 10622**Parameters** 10623 10624| Name| Description| 10625| -------- | -------- | 10626| Constraint | Size constraint. | 10627 10628**Returns** 10629 10630Maximum width. 10631 10632 10633### OH_ArkUI_LayoutConstraint_GetMinHeight() 10634 10635``` 10636int32_t OH_ArkUI_LayoutConstraint_GetMinHeight (const ArkUI_LayoutConstraint * Constraint) 10637``` 10638**Description** 10639 10640Obtains the minimum height for a size constraint, in px. 10641 10642**Since**: 12 10643 10644**Parameters** 10645 10646| Name| Description| 10647| -------- | -------- | 10648| Constraint | Size constraint. | 10649 10650**Returns** 10651 10652Minimum Height 10653 10654 10655### OH_ArkUI_LayoutConstraint_GetMinWidth() 10656 10657``` 10658int32_t OH_ArkUI_LayoutConstraint_GetMinWidth (const ArkUI_LayoutConstraint * Constraint) 10659``` 10660**Description** 10661 10662Obtains the minimum width for a size constraint, in px. 10663 10664**Since**: 12 10665 10666**Parameters** 10667 10668| Name| Description| 10669| -------- | -------- | 10670| Constraint | Size constraint. | 10671 10672**Returns** 10673 10674Minimum Width 10675 10676 10677### OH_ArkUI_LayoutConstraint_GetPercentReferenceHeight() 10678 10679``` 10680int32_t OH_ArkUI_LayoutConstraint_GetPercentReferenceHeight (const ArkUI_LayoutConstraint * Constraint) 10681``` 10682**Description** 10683 10684Obtains the height percentage reference for a size constraint, in px. 10685 10686**Since**: 12 10687 10688**Parameters** 10689 10690| Name| Description| 10691| -------- | -------- | 10692| Constraint | Size constraint. | 10693 10694**Returns** 10695 10696Height percentage benchmark. 10697 10698 10699### OH_ArkUI_LayoutConstraint_GetPercentReferenceWidth() 10700 10701``` 10702int32_t OH_ArkUI_LayoutConstraint_GetPercentReferenceWidth (const ArkUI_LayoutConstraint * Constraint) 10703``` 10704**Description** 10705 10706Obtains the width percentage reference for a size constraint, in px. 10707 10708**Since**: 12 10709 10710**Parameters** 10711 10712| Name| Description| 10713| -------- | -------- | 10714| Constraint | Size constraint. | 10715 10716**Returns** 10717 10718Width percentage reference. 10719 10720 10721### OH_ArkUI_LayoutConstraint_SetMaxHeight() 10722 10723``` 10724void OH_ArkUI_LayoutConstraint_SetMaxHeight (ArkUI_LayoutConstraint * Constraint, int32_t value ) 10725``` 10726**Description** 10727 10728Sets the maximum height. 10729 10730**Since**: 12 10731 10732**Parameters** 10733 10734| Name| Description| 10735| -------- | -------- | 10736| Constraint | Size constraint. | 10737| value | Maximum height, in pixels. | 10738 10739 10740### OH_ArkUI_LayoutConstraint_SetMaxWidth() 10741 10742``` 10743void OH_ArkUI_LayoutConstraint_SetMaxWidth (ArkUI_LayoutConstraint * Constraint, int32_t value ) 10744``` 10745**Description** 10746 10747Sets the maximum width. 10748 10749**Since**: 12 10750 10751**Parameters** 10752 10753| Name| Description| 10754| -------- | -------- | 10755| Constraint | Size constraint. | 10756| value | Maximum width, in pixels. | 10757 10758 10759### OH_ArkUI_LayoutConstraint_SetMinHeight() 10760 10761``` 10762void OH_ArkUI_LayoutConstraint_SetMinHeight (ArkUI_LayoutConstraint * Constraint, int32_t value ) 10763``` 10764**Description** 10765 10766Sets the minimum height. 10767 10768**Since**: 12 10769 10770**Parameters** 10771 10772| Name| Description| 10773| -------- | -------- | 10774| Constraint | Size constraint. | 10775| value | Minimum height, in pixels. | 10776 10777 10778### OH_ArkUI_LayoutConstraint_SetMinWidth() 10779 10780``` 10781void OH_ArkUI_LayoutConstraint_SetMinWidth (ArkUI_LayoutConstraint * Constraint, int32_t value ) 10782``` 10783**Description** 10784 10785Sets the minimum width. 10786 10787**Since**: 12 10788 10789**Parameters** 10790 10791| Name| Description| 10792| -------- | -------- | 10793| Constraint | Size constraint. | 10794| value | Minimum width, in pixels. | 10795 10796 10797### OH_ArkUI_LayoutConstraint_SetPercentReferenceHeight() 10798 10799``` 10800void OH_ArkUI_LayoutConstraint_SetPercentReferenceHeight (ArkUI_LayoutConstraint * Constraint, int32_t value ) 10801``` 10802**Description** 10803 10804Sets the height percentage reference. 10805 10806**Since**: 12 10807 10808**Parameters** 10809 10810| Name| Description| 10811| -------- | -------- | 10812| Constraint | Size constraint. | 10813| value | Height percentage base, in px. | 10814 10815 10816### OH_ArkUI_LayoutConstraint_SetPercentReferenceWidth() 10817 10818``` 10819void OH_ArkUI_LayoutConstraint_SetPercentReferenceWidth (ArkUI_LayoutConstraint * Constraint, int32_t value ) 10820``` 10821**Description** 10822 10823Sets the width percentage reference. 10824 10825**Since**: 12 10826 10827**Parameters** 10828 10829| Name| Description| 10830| -------- | -------- | 10831| Constraint | Size constraint. | 10832| value | Width percentage benchmark, in px. | 10833 10834 10835### OH_ArkUI_List_CloseAllSwipeActions() 10836 10837``` 10838int32_t OH_ArkUI_List_CloseAllSwipeActions (ArkUI_NodeHandle node, void * userData, void(*)(void *userData) onFinish ) 10839``` 10840**Description** 10841 10842Collapse the expanded ListItem. 10843 10844**Since**: 12 10845 10846**Parameters** 10847 10848| Name| Description| 10849| -------- | -------- | 10850| node | Node object for which an event needs to be registered. | 10851| userData | Custom event parameter, which is passed in the callback when the event is triggered. | 10852| onFinish | Callback triggered after the collapse animation is complete. | 10853 10854**Returns** 10855 10856Returns **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. 10857 10858 10859### OH_ArkUI_ListChildrenMainSizeOption_Create() 10860 10861``` 10862ArkUI_ListChildrenMainSize* OH_ArkUI_ListChildrenMainSizeOption_Create () 10863``` 10864**Description** 10865 10866Creates a **ListChildrenMainSize** instance. 10867 10868**Since**: 12 10869 10870**Returns** 10871 10872Returns the created **ListChildrenMainSize** instance. 10873 10874 10875### OH_ArkUI_ListChildrenMainSizeOption_Dispose() 10876 10877``` 10878void OH_ArkUI_ListChildrenMainSizeOption_Dispose (ArkUI_ListChildrenMainSize * option) 10879``` 10880**Description** 10881 10882Destroys a ListChildrenMainSize instance. 10883 10884**Since**: 12 10885 10886**Parameters** 10887 10888| Name| Description| 10889| -------- | -------- | 10890| option | ListChildrenMainSize instance to be destroyed. | 10891 10892 10893### OH_ArkUI_ListChildrenMainSizeOption_GetDefaultMainSize() 10894 10895``` 10896float OH_ArkUI_ListChildrenMainSizeOption_GetDefaultMainSize (ArkUI_ListChildrenMainSize * option) 10897``` 10898**Description** 10899 10900Obtains the default size in a **ListChildrenMainSize** instance. 10901 10902**Since**: 12 10903 10904**Parameters** 10905 10906| Name| Description| 10907| -------- | -------- | 10908| option | **ListChildrenMainSize** instance. | 10909 10910**Returns** 10911 10912Returns the default size, in vp. The default value is **0**. If **option** is a null pointer, **-1** is returned. 10913 10914 10915### OH_ArkUI_ListChildrenMainSizeOption_GetMainSize() 10916 10917``` 10918float OH_ArkUI_ListChildrenMainSizeOption_GetMainSize (ArkUI_ListChildrenMainSize * option, int32_t index ) 10919``` 10920**Description** 10921 10922Obtains the value of the **ChildrenMainSizeOption** array of the **List** component. 10923 10924**Since**: 12 10925 10926**Parameters** 10927 10928| Name| Description| 10929| -------- | -------- | 10930| option | **ListChildrenMainSize** instance. | 10931| index | Subscript position of the value to be obtained. | 10932 10933**Returns** 10934 10935Value of the specific position of the array. If a parameter error occurs, **-1** is returned. 10936 10937 10938### OH_ArkUI_ListChildrenMainSizeOption_Resize() 10939 10940``` 10941void OH_ArkUI_ListChildrenMainSizeOption_Resize (ArkUI_ListChildrenMainSize * option, int32_t totalSize ) 10942``` 10943**Description** 10944 10945Resets the array size of ChildrenMainSizeOption of the List component. 10946 10947**Since**: 12 10948 10949**Parameters** 10950 10951| Name| Description| 10952| -------- | -------- | 10953| option | **ListChildrenMainSize** instance. | 10954| totalSize | Array size. | 10955 10956 10957### OH_ArkUI_ListChildrenMainSizeOption_SetDefaultMainSize() 10958 10959``` 10960int32_t OH_ArkUI_ListChildrenMainSizeOption_SetDefaultMainSize (ArkUI_ListChildrenMainSize * option, float defaultMainSize ) 10961``` 10962**Description** 10963 10964Sets the default size in a **ListChildrenMainSize** instance. 10965 10966**Since**: 12 10967 10968**Parameters** 10969 10970| Name| Description| 10971| -------- | -------- | 10972| option | **ListChildrenMainSize** instance. | 10973| defaultMainSize | Default size of a list item in a list. The unit is vp. | 10974 10975**Returns** 10976 10977Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 10978 10979 10980### OH_ArkUI_ListChildrenMainSizeOption_Splice() 10981 10982``` 10983int32_t OH_ArkUI_ListChildrenMainSizeOption_Splice (ArkUI_ListChildrenMainSize * option, int32_t index, int32_t deleteCount, int32_t addCount ) 10984``` 10985**Description** 10986 10987The size of the ChildrenMainSizeOption array of the List component is adjusted. 10988 10989**Since**: 12 10990 10991**Parameters** 10992 10993| Name| Description| 10994| -------- | -------- | 10995| option | **ListChildrenMainSize** instance. | 10996| index | Start position of the array whose MainSize is to be modified. | 10997| deleteCount | Number of MainSize arrays to be deleted starting from index. | 10998| addCount | Number of MainSize arrays to be added starting from index. | 10999 11000**Returns** 11001 11002Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11003 11004 11005### OH_ArkUI_ListChildrenMainSizeOption_UpdateSize() 11006 11007``` 11008int32_t OH_ArkUI_ListChildrenMainSizeOption_UpdateSize (ArkUI_ListChildrenMainSize * option, int32_t index, float mainSize ) 11009``` 11010**Description** 11011 11012Updates the values in a **ChildrenMainSizeOption** array of a **List** component. 11013 11014**Since**: 12 11015 11016**Parameters** 11017 11018| Name| Description| 11019| -------- | -------- | 11020| option | **ListChildrenMainSize** instance. | 11021| index | Index at which to start changing the values in the array. | 11022| mainSize | New size value to set at the specified index. | 11023 11024**Returns** 11025 11026Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11027 11028 11029### OH_ArkUI_ListItemSwipeActionItem_Create() 11030 11031``` 11032ArkUI_ListItemSwipeActionItem* OH_ArkUI_ListItemSwipeActionItem_Create () 11033``` 11034**Description** 11035 11036Creates a **ListItemSwipeActionItem** instance. 11037 11038**Since**: 12 11039 11040**Returns** 11041 11042Returns the created **ListItemSwipeActionItem** instance. 11043 11044 11045### OH_ArkUI_ListItemSwipeActionItem_Dispose() 11046 11047``` 11048void OH_ArkUI_ListItemSwipeActionItem_Dispose (ArkUI_ListItemSwipeActionItem * item) 11049``` 11050**Description** 11051 11052Disposes of a **ListItemSwipeActionItem** instance. 11053 11054**Since**: 12 11055 11056**Parameters** 11057 11058| Name| Description| 11059| -------- | -------- | 11060| item | **ListItemSwipeActionItem** instance to dispose of. | 11061 11062 11063### OH_ArkUI_ListItemSwipeActionItem_GetActionAreaDistance() 11064 11065``` 11066float OH_ArkUI_ListItemSwipeActionItem_GetActionAreaDistance (ArkUI_ListItemSwipeActionItem * item) 11067``` 11068**Description** 11069 11070Obtains the swipe distance threshold for deleting the list item. 11071 11072**Since**: 12 11073 11074**Parameters** 11075 11076| Name| Description| 11077| -------- | -------- | 11078| item | Target **ListItemSwipeActionItem** instance. | 11079 11080**Returns** 11081 11082Returns the swipe distance threshold for deleting the list item. Return **0** if an error occurs. 11083 11084 11085### OH_ArkUI_ListItemSwipeActionItem_SetActionAreaDistance() 11086 11087``` 11088void OH_ArkUI_ListItemSwipeActionItem_SetActionAreaDistance (ArkUI_ListItemSwipeActionItem * item, float distance ) 11089``` 11090**Description** 11091 11092Swipe distance threshold for deleting the list item. 11093 11094**Since**: 12 11095 11096**Parameters** 11097 11098| Name| Description| 11099| -------- | -------- | 11100| item | Target **ListItemSwipeActionItem** instance. | 11101| distance | Returns the swipe distance threshold for deleting the list item. | 11102 11103 11104### OH_ArkUI_ListItemSwipeActionItem_SetContent() 11105 11106``` 11107void OH_ArkUI_ListItemSwipeActionItem_SetContent (ArkUI_ListItemSwipeActionItem * item, ArkUI_NodeHandle node ) 11108``` 11109**Description** 11110 11111Sets the layout content of ListItemSwipeActionItem. 11112 11113**Since**: 12 11114 11115**Parameters** 11116 11117| Name| Description| 11118| -------- | -------- | 11119| item | Target **ListItemSwipeActionItem** instance. | 11120| node | Layout information | 11121 11122 11123### OH_ArkUI_ListItemSwipeActionItem_SetOnAction() 11124 11125``` 11126void OH_ArkUI_ListItemSwipeActionItem_SetOnAction (ArkUI_ListItemSwipeActionItem * item, void(*)() callback ) 11127``` 11128**Description** 11129 11130Sets the callback invoked when the list item is deleted while in the delete area. 11131 11132**Since**: 12 11133 11134**Parameters** 11135 11136| Name| Description| 11137| -------- | -------- | 11138| item | Target **ListItemSwipeActionItem** instance. | 11139| callback | Callback to invoke when an event of the specified type occurs. | 11140 11141 11142### OH_ArkUI_ListItemSwipeActionItem_SetOnActionWithUserData() 11143 11144``` 11145void OH_ArkUI_ListItemSwipeActionItem_SetOnActionWithUserData (ArkUI_ListItemSwipeActionItem * item, void * userData, void(*)(void *userData) callback ) 11146``` 11147**Description** 11148 11149Sets the callback invoked when the list item is deleted while in the delete area. 11150 11151**Since**: 12 11152 11153**Parameters** 11154 11155| Name| Description| 11156| -------- | -------- | 11157| item | Target **ListItemSwipeActionItem** instance. | 11158| userData | Custom data. | 11159| callback | Callback to invoke when an event of the specified type occurs. | 11160 11161 11162### OH_ArkUI_ListItemSwipeActionItem_SetOnEnterActionArea() 11163 11164``` 11165void OH_ArkUI_ListItemSwipeActionItem_SetOnEnterActionArea (ArkUI_ListItemSwipeActionItem * item, void(*)() callback ) 11166``` 11167**Description** 11168 11169Sets the callback invoked each time the list item enters the delete area. 11170 11171**Since**: 12 11172 11173**Parameters** 11174 11175| Name| Description| 11176| -------- | -------- | 11177| item | Target **ListItemSwipeActionItem** instance. | 11178| callback | Callback to invoke when an event of the specified type occurs. | 11179 11180 11181### OH_ArkUI_ListItemSwipeActionItem_SetOnEnterActionAreaWithUserData() 11182 11183``` 11184void OH_ArkUI_ListItemSwipeActionItem_SetOnEnterActionAreaWithUserData (ArkUI_ListItemSwipeActionItem * item, void * userData, void(*)(void *userData) callback ) 11185``` 11186**Description** 11187 11188Sets the callback invoked each time the list item enters the delete area. 11189 11190**Since**: 12 11191 11192**Parameters** 11193 11194| Name| Description| 11195| -------- | -------- | 11196| item | Target **ListItemSwipeActionItem** instance. | 11197| userData | Custom data. | 11198| callback | Callback to invoke when an event of the specified type occurs. | 11199 11200 11201### OH_ArkUI_ListItemSwipeActionItem_SetOnExitActionArea() 11202 11203``` 11204void OH_ArkUI_ListItemSwipeActionItem_SetOnExitActionArea (ArkUI_ListItemSwipeActionItem * item, void(*)() callback ) 11205``` 11206**Description** 11207 11208Sets the callback invoked each time the list item exits the delete area. 11209 11210**Since**: 12 11211 11212**Parameters** 11213 11214| Name| Description| 11215| -------- | -------- | 11216| item | Target **ListItemSwipeActionItem** instance. | 11217| callback | Callback to invoke when an event of the specified type occurs. | 11218 11219 11220### OH_ArkUI_ListItemSwipeActionItem_SetOnExitActionAreaWithUserData() 11221 11222``` 11223void OH_ArkUI_ListItemSwipeActionItem_SetOnExitActionAreaWithUserData (ArkUI_ListItemSwipeActionItem * item, void * userData, void(*)(void *userData) callback ) 11224``` 11225**Description** 11226 11227Sets the callback invoked each time the list item exits the delete area. 11228 11229**Since**: 12 11230 11231**Parameters** 11232 11233| Name| Description| 11234| -------- | -------- | 11235| item | Target **ListItemSwipeActionItem** instance. | 11236| userData | Custom data. | 11237| callback | Callback to invoke when an event of the specified type occurs. | 11238 11239### OH_ArkUI_ListItemSwipeActionItem_SetOnStateChange() 11240 11241``` 11242void OH_ArkUI_ListItemSwipeActionItem_SetOnStateChange (ArkUI_ListItemSwipeActionItem * item, void(*)(ArkUI_ListItemSwipeActionState swipeActionState) callback ) 11243``` 11244**Description** 11245 11246Sets the callback invoked when the swipe state of the list item changes. 11247 11248**Since**: 12 11249 11250**Parameters** 11251 11252| Name| Description| 11253| -------- | -------- | 11254| item | Target **ListItemSwipeActionItem** instance. | 11255| callback | Status after the callback event swipeActionState changes. | 11256 11257 11258### OH_ArkUI_ListItemSwipeActionItem_SetOnStateChangeWithUserData() 11259 11260``` 11261void OH_ArkUI_ListItemSwipeActionItem_SetOnStateChangeWithUserData (ArkUI_ListItemSwipeActionItem * item, void * userData, void(*)(ArkUI_ListItemSwipeActionState swipeActionState, void *userData) callback ) 11262``` 11263**Description** 11264 11265Sets the callback invoked when the swipe state of the list item changes. 11266 11267**Since**: 12 11268 11269**Parameters** 11270 11271| Name| Description| 11272| -------- | -------- | 11273| item | Target **ListItemSwipeActionItem** instance. | 11274| userData | Custom data. | 11275| callback | Status after the callback event swipeActionState changes. | 11276 11277 11278### OH_ArkUI_ListItemSwipeActionOption_Create() 11279 11280``` 11281ArkUI_ListItemSwipeActionOption* OH_ArkUI_ListItemSwipeActionOption_Create () 11282``` 11283**Description** 11284 11285Creates a **ListItemSwipeActionOption** instance. 11286 11287**Since**: 12 11288 11289**Returns** 11290 11291ListItemSwipeActionOption configuration item instance. 11292 11293 11294### OH_ArkUI_ListItemSwipeActionOption_Dispose() 11295 11296``` 11297void OH_ArkUI_ListItemSwipeActionOption_Dispose (ArkUI_ListItemSwipeActionOption * option) 11298``` 11299**Description** 11300 11301Destroys a ListItemSwipeActionOption instance. 11302 11303**Since**: 12 11304 11305**Parameters** 11306 11307| Name| Description| 11308| -------- | -------- | 11309| option | ListItemSwipeActionOption instance to destroy. | 11310 11311 11312### OH_ArkUI_ListItemSwipeActionOption_GetEdgeEffect() 11313 11314``` 11315int32_t OH_ArkUI_ListItemSwipeActionOption_GetEdgeEffect (ArkUI_ListItemSwipeActionOption * option) 11316``` 11317**Description** 11318 11319Obtains the sliding effect. 11320 11321**Since**: 12 11322 11323**Parameters** 11324 11325| Name| Description| 11326| -------- | -------- | 11327| option | Target **ListItemSwipeActionItem** instance. | 11328 11329**Returns** 11330 11331Scroll effect. The default return value is **ARKUI_LIST_ITEM_SWIPE_EDGE_EFFECT_SPRING**. 11332 11333 11334### OH_ArkUI_ListItemSwipeActionOption_SetEdgeEffect() 11335 11336``` 11337void OH_ArkUI_ListItemSwipeActionOption_SetEdgeEffect (ArkUI_ListItemSwipeActionOption * option, ArkUI_ListItemSwipeEdgeEffect edgeEffect ) 11338``` 11339**Description** 11340 11341Sets the sliding effect. 11342 11343**Since**: 12 11344 11345**Parameters** 11346 11347| Name| Description| 11348| -------- | -------- | 11349| option | Target **ListItemSwipeActionItem** instance. | 11350| edgeEffect | Scroll effect. | 11351 11352 11353### OH_ArkUI_ListItemSwipeActionOption_SetEnd() 11354 11355``` 11356void OH_ArkUI_ListItemSwipeActionOption_SetEnd (ArkUI_ListItemSwipeActionOption * option, ArkUI_ListItemSwipeActionItem * item ) 11357``` 11358**Description** 11359 11360Sets the layout content for the right edge (for a vertical layout) or bottom edge (for a horizontal layout) of a **ListItemSwipeActionItem** instance. 11361 11362**Since**: 12 11363 11364**Parameters** 11365 11366| Name| Description| 11367| -------- | -------- | 11368| option | Target **ListItemSwipeActionItem** instance. | 11369| builder | Layout information | 11370 11371 11372### OH_ArkUI_ListItemSwipeActionOption_SetOnOffsetChange() 11373 11374``` 11375void OH_ArkUI_ListItemSwipeActionOption_SetOnOffsetChange (ArkUI_ListItemSwipeActionOption * option, void(*)(float offset) callback ) 11376``` 11377**Description** 11378 11379Sets the callback invoked when the scroll offset changes. 11380 11381**Since**: 12 11382 11383**Parameters** 11384 11385| Name| Description| 11386| -------- | -------- | 11387| option | Target **ListItemSwipeActionItem** instance. | 11388| callback | Sliding offset of the callback event offset. | 11389 11390 11391### OH_ArkUI_ListItemSwipeActionOption_SetOnOffsetChangeWithUserData() 11392 11393``` 11394void OH_ArkUI_ListItemSwipeActionOption_SetOnOffsetChangeWithUserData (ArkUI_ListItemSwipeActionOption * option, void * userData, void(*)(float offset, void *userData) callback ) 11395``` 11396**Description** 11397 11398Sets the callback invoked when the scroll offset changes. 11399 11400**Since**: 12 11401 11402**Parameters** 11403 11404| Name| Description| 11405| -------- | -------- | 11406| option | Target **ListItemSwipeActionItem** instance. | 11407| userData | Custom data. | 11408| callback | Sliding offset of the callback event offset. | 11409 11410 11411### OH_ArkUI_ListItemSwipeActionOption_SetStart() 11412 11413``` 11414void OH_ArkUI_ListItemSwipeActionOption_SetStart (ArkUI_ListItemSwipeActionOption * option, ArkUI_ListItemSwipeActionItem * item ) 11415``` 11416**Description** 11417 11418Sets the layout content for the left edge (for a vertical layout) or top edge (for a horizontal layout) of a **ListItemSwipeActionItem** instance. 11419 11420**Since**: 12 11421 11422**Parameters** 11423 11424| Name| Description| 11425| -------- | -------- | 11426| option | Target **ListItemSwipeActionItem** instance. | 11427| builder | Layout information | 11428 11429 11430### OH_ArkUI_LongPress_GetRepeatCount() 11431 11432``` 11433int32_t OH_ArkUI_LongPress_GetRepeatCount (const ArkUI_GestureEvent * event) 11434``` 11435**Description** 11436 11437Obtains the number of times that a long press gesture is triggered periodically. 11438 11439**Since**: 12 11440 11441**Parameters** 11442 11443| Name| Description| 11444| -------- | -------- | 11445| event | Gesture event. | 11446 11447**Returns** 11448 11449Returns the number of times that the long press gesture is triggered periodically. 11450 11451 11452### OH_ArkUI_MarshallStyledStringDescriptor() 11453 11454``` 11455int32_t OH_ArkUI_MarshallStyledStringDescriptor (uint8_t * buffer, size_t * bufferSize, ArkUI_StyledString_Descriptor * descriptor ) 11456``` 11457**Description** 11458 11459Serializes the styled string information into a byte array. 11460 11461**Since**: 14 11462 11463**Parameters** 11464 11465| Name| Description| 11466| -------- | -------- | 11467| buffer | Byte array where the serialized data will be stored. | 11468| bufferSize | Length of the byte array. | 11469| descriptor | Pointer to an **ArkUI_StyledString_Descriptor** object. | 11470 11471**Returns** 11472 11473Returns **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. 11474 11475 11476### OH_ArkUI_NodeAdapter_Create() 11477 11478``` 11479ArkUI_NodeAdapterHandle OH_ArkUI_NodeAdapter_Create () 11480``` 11481**Description** 11482 11483Creates a component adapter. 11484 11485**Since**: 12 11486 11487 11488### OH_ArkUI_NodeAdapter_Dispose() 11489 11490``` 11491void OH_ArkUI_NodeAdapter_Dispose (ArkUI_NodeAdapterHandle handle) 11492``` 11493**Description** 11494 11495Destroys a component adapter. 11496 11497**Since**: 12 11498 11499**Parameters** 11500 11501| Name| Description| 11502| -------- | -------- | 11503| handle | Component adapter object. | 11504 11505 11506### OH_ArkUI_NodeAdapter_GetAllItems() 11507 11508``` 11509int32_t OH_ArkUI_NodeAdapter_GetAllItems (ArkUI_NodeAdapterHandle handle, ArkUI_NodeHandle ** items, uint32_t * size ) 11510``` 11511**Description** 11512 11513Obtains all elements stored in the specified adapter. 11514 11515When 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. 11516 11517**Since**: 12 11518 11519**Parameters** 11520 11521| Name| Description| 11522| -------- | -------- | 11523| handle | Component adapter object. | 11524| items | Array of nodes in the adapter. | 11525| size | Number of elements. | 11526 11527**Returns** 11528 11529Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11530 11531 11532### OH_ArkUI_NodeAdapter_GetTotalNodeCount() 11533 11534``` 11535uint32_t OH_ArkUI_NodeAdapter_GetTotalNodeCount (ArkUI_NodeAdapterHandle handle) 11536``` 11537**Description** 11538 11539Obtains the total number of elements in the Adapter. 11540 11541**Since**: 12 11542 11543**Parameters** 11544 11545| Name| Description| 11546| -------- | -------- | 11547| handle | Component adapter object. | 11548 11549**Returns** 11550 11551Total number of elements in the Adapter. 11552 11553 11554### OH_ArkUI_NodeAdapter_InsertItem() 11555 11556``` 11557int32_t OH_ArkUI_NodeAdapter_InsertItem (ArkUI_NodeAdapterHandle handle, uint32_t startPosition, uint32_t itemCount ) 11558``` 11559**Description** 11560 11561Instructs the specified adapter to insert certain elements. 11562 11563**Since**: 12 11564 11565**Parameters** 11566 11567| Name| Description| 11568| -------- | -------- | 11569| handle | Component adapter object. | 11570| startPosition | Start position for inserting an element. | 11571| itemCount | Number of inserted elements. | 11572 11573**Returns** 11574 11575Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11576 11577 11578### OH_ArkUI_NodeAdapter_MoveItem() 11579 11580``` 11581int32_t OH_ArkUI_NodeAdapter_MoveItem (ArkUI_NodeAdapterHandle handle, uint32_t from, uint32_t to ) 11582``` 11583**Description** 11584 11585Instructs the specified adapter to move certain elements. 11586 11587**Since**: 12 11588 11589**Parameters** 11590 11591| Name| Description| 11592| -------- | -------- | 11593| handle | Component adapter object. | 11594| from | Start position of the element shift. | 11595| to | End position of the element shift. | 11596 11597**Returns** 11598 11599Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11600 11601 11602### OH_ArkUI_NodeAdapter_RegisterEventReceiver() 11603 11604``` 11605int32_t OH_ArkUI_NodeAdapter_RegisterEventReceiver (ArkUI_NodeAdapterHandle handle, void * userData, void(*)(ArkUI_NodeAdapterEvent *event) receiver ) 11606``` 11607**Description** 11608 11609Registers callback events related to the Adapter. 11610 11611**Since**: 12 11612 11613**Parameters** 11614 11615| Name| Description| 11616| -------- | -------- | 11617| handle | Component adapter object. | 11618| userData | Custom data. | 11619| receiver | Event receiving callback. | 11620 11621**Returns** 11622 11623Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11624 11625 11626### OH_ArkUI_NodeAdapter_ReloadAllItems() 11627 11628``` 11629int32_t OH_ArkUI_NodeAdapter_ReloadAllItems (ArkUI_NodeAdapterHandle handle) 11630``` 11631**Description** 11632 11633Instructs the specified adapter to reload all elements. 11634 11635**Since**: 12 11636 11637**Parameters** 11638 11639| Name| Description| 11640| -------- | -------- | 11641| handle | Component adapter object. | 11642 11643**Returns** 11644 11645Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11646 11647 11648### OH_ArkUI_NodeAdapter_ReloadItem() 11649 11650``` 11651int32_t OH_ArkUI_NodeAdapter_ReloadItem (ArkUI_NodeAdapterHandle handle, uint32_t startPosition, uint32_t itemCount ) 11652``` 11653**Description** 11654 11655Instructs the specified adapter to reload certain elements. 11656 11657**Since**: 12 11658 11659**Parameters** 11660 11661| Name| Description| 11662| -------- | -------- | 11663| handle | Component adapter object. | 11664| startPosition | Start position of an element change. | 11665| itemCount | Number of changed elements. | 11666 11667**Returns** 11668 11669Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11670 11671 11672### OH_ArkUI_NodeAdapter_RemoveItem() 11673 11674``` 11675int32_t OH_ArkUI_NodeAdapter_RemoveItem (ArkUI_NodeAdapterHandle handle, uint32_t startPosition, uint32_t itemCount ) 11676``` 11677**Description** 11678 11679Instructs the specified adapter to remove certain elements. 11680 11681**Since**: 12 11682 11683**Parameters** 11684 11685| Name| Description| 11686| -------- | -------- | 11687| handle | Component adapter object. | 11688| startPosition | Start position for deleting an element. | 11689| itemCount | Number of deleted elements. | 11690 11691**Returns** 11692 11693Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11694 11695 11696### OH_ArkUI_NodeAdapter_SetTotalNodeCount() 11697 11698``` 11699int32_t OH_ArkUI_NodeAdapter_SetTotalNodeCount (ArkUI_NodeAdapterHandle handle, uint32_t size ) 11700``` 11701**Description** 11702 11703Sets the total number of elements in the specified adapter. 11704 11705**Since**: 12 11706 11707**Parameters** 11708 11709| Name| Description| 11710| -------- | -------- | 11711| handle | Component adapter object. | 11712| size | Number of elements. | 11713 11714**Returns** 11715 11716Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11717 11718 11719### OH_ArkUI_NodeAdapter_UnregisterEventReceiver() 11720 11721``` 11722void OH_ArkUI_NodeAdapter_UnregisterEventReceiver (ArkUI_NodeAdapterHandle handle) 11723``` 11724**Description** 11725 11726Deregisters Adapter-related callback events. 11727 11728**Since**: 12 11729 11730**Parameters** 11731 11732| Name| Description| 11733| -------- | -------- | 11734| handle | Component adapter object. | 11735 11736 11737### OH_ArkUI_NodeAdapterEvent_GetHostNode() 11738 11739``` 11740ArkUI_NodeHandle OH_ArkUI_NodeAdapterEvent_GetHostNode (ArkUI_NodeAdapterEvent * event) 11741``` 11742**Description** 11743 11744Obtains the scrolling class container node that uses the adapter. 11745 11746**Since**: 12 11747 11748**Parameters** 11749 11750| Name| Description| 11751| -------- | -------- | 11752| event | Adapter event object. | 11753 11754**Returns** 11755 11756Returns the scrollable container node that uses the specified adapter. 11757 11758 11759### OH_ArkUI_NodeAdapterEvent_GetItemIndex() 11760 11761``` 11762uint32_t OH_ArkUI_NodeAdapterEvent_GetItemIndex (ArkUI_NodeAdapterEvent * event) 11763``` 11764**Description** 11765 11766Sequence number of the element to be operated when the adapter event is obtained. 11767 11768**Since**: 12 11769 11770**Parameters** 11771 11772| Name| Description| 11773| -------- | -------- | 11774| event | Adapter event object. | 11775 11776**Returns** 11777 11778Sequence number of an element. 11779 11780 11781### OH_ArkUI_NodeAdapterEvent_GetRemovedNode() 11782 11783``` 11784ArkUI_NodeHandle OH_ArkUI_NodeAdapterEvent_GetRemovedNode (ArkUI_NodeAdapterEvent * event) 11785``` 11786**Description** 11787 11788Obtains the element to be destroyed in the event to be destroyed. 11789 11790**Since**: 12 11791 11792**Parameters** 11793 11794| Name| Description| 11795| -------- | -------- | 11796| event | Adapter event object. | 11797 11798**Returns** 11799 11800Element to be destroyed. 11801 11802 11803### OH_ArkUI_NodeAdapterEvent_GetType() 11804 11805``` 11806ArkUI_NodeAdapterEventType OH_ArkUI_NodeAdapterEvent_GetType (ArkUI_NodeAdapterEvent * event) 11807``` 11808**Description** 11809 11810Obtains the event type. 11811 11812**Since**: 12 11813 11814**Parameters** 11815 11816| Name| Description| 11817| -------- | -------- | 11818| event | Adapter event object. | 11819 11820**Returns** 11821 11822Represents an event type. 11823 11824 11825### OH_ArkUI_NodeAdapterEvent_GetUserData() 11826 11827``` 11828void* OH_ArkUI_NodeAdapterEvent_GetUserData (ArkUI_NodeAdapterEvent * event) 11829``` 11830**Description** 11831 11832Obtains the custom data passed in during registration of the specified event. 11833 11834**Since**: 12 11835 11836**Parameters** 11837 11838| Name| Description| 11839| -------- | -------- | 11840| event | Adapter event object. | 11841 11842 11843### OH_ArkUI_NodeAdapterEvent_SetItem() 11844 11845``` 11846int32_t OH_ArkUI_NodeAdapterEvent_SetItem (ArkUI_NodeAdapterEvent * event, ArkUI_NodeHandle node ) 11847``` 11848**Description** 11849 11850Sets the component to be added to the specified adapter. 11851 11852**Since**: 12 11853 11854**Parameters** 11855 11856| Name| Description| 11857| -------- | -------- | 11858| event | Adapter event object. | 11859| node | Component to be added. | 11860 11861**Returns** 11862 11863Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11864 11865 11866### OH_ArkUI_NodeAdapterEvent_SetNodeId() 11867 11868``` 11869int32_t OH_ArkUI_NodeAdapterEvent_SetNodeId (ArkUI_NodeAdapterEvent * event, int32_t id ) 11870``` 11871**Description** 11872 11873Sets the generated component ID. 11874 11875**Since**: 12 11876 11877**Parameters** 11878 11879| Name| Description| 11880| -------- | -------- | 11881| event | Adapter event object. | 11882| id | Sets the returned component ID. | 11883 11884**Returns** 11885 11886Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11887 11888 11889### OH_ArkUI_NodeContent_AddNode() 11890 11891``` 11892int32_t OH_ArkUI_NodeContent_AddNode (ArkUI_NodeContentHandle content, ArkUI_NodeHandle node ) 11893``` 11894**Description** 11895 11896Adds an ArkUI component node to the specified NodeContent object. 11897 11898**Since**: 12 11899 11900**Parameters** 11901 11902| Name| Description| 11903| -------- | -------- | 11904| content | NodeContent object to which a node is to be added. | 11905| node | Node to be added. | 11906 11907**Returns** 11908 11909Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11910 11911 11912### OH_ArkUI_NodeContent_GetUserData() 11913 11914``` 11915void* OH_ArkUI_NodeContent_GetUserData (ArkUI_NodeContentHandle content) 11916``` 11917**Description** 11918 11919Obtains the user-defined data saved on the NodeContent object. 11920 11921**Since**: 12 11922 11923**Parameters** 11924 11925| Name| Description| 11926| -------- | -------- | 11927| content | NodeContent object whose user-defined data needs to be saved. | 11928 11929**Returns** 11930 11931Custom data. 11932 11933 11934### OH_ArkUI_NodeContent_InsertNode() 11935 11936``` 11937int32_t OH_ArkUI_NodeContent_InsertNode (ArkUI_NodeContentHandle content, ArkUI_NodeHandle node, int32_t position ) 11938``` 11939**Description** 11940 11941Inserts an ArkUI component node into a specific location of the corresponding NodeContent object. 11942 11943**Since**: 12 11944 11945**Parameters** 11946 11947| Name| Description| 11948| -------- | -------- | 11949| content | NodeContent object of the node to be inserted. | 11950| node | Node to be inserted. | 11951| position | Start time for an asset to be inserted, | 11952 11953**Returns** 11954 11955Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11956 11957 11958### OH_ArkUI_NodeContent_RegisterCallback() 11959 11960``` 11961int32_t OH_ArkUI_NodeContent_RegisterCallback (ArkUI_NodeContentHandle content, ArkUI_NodeContentCallback callback ) 11962``` 11963**Description** 11964 11965Registers the NodeContent event function. 11966 11967**Since**: 12 11968 11969**Parameters** 11970 11971| Name| Description| 11972| -------- | -------- | 11973| content | NodeContent object for which an event needs to be registered. | 11974| callback | Callback to be executed when the event is triggered. | 11975 11976**Returns** 11977 11978Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11979 11980 11981### OH_ArkUI_NodeContent_RemoveNode() 11982 11983``` 11984int32_t OH_ArkUI_NodeContent_RemoveNode (ArkUI_NodeContentHandle content, ArkUI_NodeHandle node ) 11985``` 11986**Description** 11987 11988Removes an ArkUI component node from the specified NodeContent object. 11989 11990**Since**: 12 11991 11992**Parameters** 11993 11994| Name| Description| 11995| -------- | -------- | 11996| content | NodeContent object of the node to be deleted. | 11997| node | Node to be deleted. | 11998 11999**Returns** 12000 12001Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12002 12003 12004### OH_ArkUI_NodeContent_SetUserData() 12005 12006``` 12007int32_t OH_ArkUI_NodeContent_SetUserData (ArkUI_NodeContentHandle content, void * userData ) 12008``` 12009**Description** 12010 12011Saves user-defined data on the NodeContent object. 12012 12013**Since**: 12 12014 12015**Parameters** 12016 12017| Name| Description| 12018| -------- | -------- | 12019| content | NodeContent object whose user-defined data needs to be saved. | 12020| userData | User-defined data to be saved. | 12021 12022**Returns** 12023 12024Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12025 12026 12027### OH_ArkUI_NodeContentEvent_GetEventType() 12028 12029``` 12030ArkUI_NodeContentEventType OH_ArkUI_NodeContentEvent_GetEventType (ArkUI_NodeContentEvent * event) 12031``` 12032**Description** 12033 12034Obtains the type of the specified NodeContent event. 12035 12036**Since**: 12 12037 12038**Parameters** 12039 12040| Name| Description| 12041| -------- | -------- | 12042| event | Pointer to the NodeContent event. | 12043 12044**Returns** 12045 12046NodeContent event type. 12047 12048 12049### OH_ArkUI_NodeContentEvent_GetNodeContentHandle() 12050 12051``` 12052ArkUI_NodeContentHandle OH_ArkUI_NodeContentEvent_GetNodeContentHandle (ArkUI_NodeContentEvent * event) 12053``` 12054**Description** 12055 12056Obtains the object that triggers the specified NodeContent event. 12057 12058**Since**: 12 12059 12060**Parameters** 12061 12062| Name| Description| 12063| -------- | -------- | 12064| event | Pointer to the NodeContent event. | 12065 12066**Returns** 12067 12068Returns the NodeContent object that triggers the event. 12069 12070 12071### OH_ArkUI_NodeCustomEvent_GetCustomSpanDrawInfo() 12072 12073``` 12074int32_t OH_ArkUI_NodeCustomEvent_GetCustomSpanDrawInfo (ArkUI_NodeCustomEvent * event, ArkUI_CustomSpanDrawInfo * info ) 12075``` 12076**Description** 12077 12078Obtains the drawing information of a custom span through a custom component event. 12079 12080**Since**: 12 12081 12082**Parameters** 12083 12084| Name| Description| 12085| -------- | -------- | 12086| event | Pointer to the custom component event. | 12087| info | Drawing information to obtain. | 12088 12089**Returns** 12090 12091Returns **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. 12092 12093 12094### OH_ArkUI_NodeCustomEvent_GetCustomSpanMeasureInfo() 12095 12096``` 12097int32_t OH_ArkUI_NodeCustomEvent_GetCustomSpanMeasureInfo (ArkUI_NodeCustomEvent * event, ArkUI_CustomSpanMeasureInfo * info ) 12098``` 12099**Description** 12100 12101Obtains the measurement information of a custom span through a custom component event. 12102 12103**Since**: 12 12104 12105**Parameters** 12106 12107| Name| Description| 12108| -------- | -------- | 12109| event | Pointer to the custom component event. | 12110| info | Measurement information to obtain. | 12111 12112**Returns** 12113 12114Returns **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. 12115 12116 12117### OH_ArkUI_NodeCustomEvent_GetDrawContextInDraw() 12118 12119``` 12120ArkUI_DrawContext* OH_ArkUI_NodeCustomEvent_GetDrawContextInDraw (ArkUI_NodeCustomEvent * event) 12121``` 12122**Description** 12123 12124Obtains the drawing context through a custom component event. 12125 12126**Since**: 12 12127 12128**Parameters** 12129 12130| Name| Description| 12131| -------- | -------- | 12132| event | Pointer to the custom component event. | 12133 12134**Returns** 12135 12136Returns the drawing context. 12137 12138 12139### OH_ArkUI_NodeCustomEvent_GetEventTargetId() 12140 12141``` 12142int32_t OH_ArkUI_NodeCustomEvent_GetEventTargetId (ArkUI_NodeCustomEvent * event) 12143``` 12144**Description** 12145 12146Obtains the ID of a custom component event. 12147 12148**Since**: 12 12149 12150**Parameters** 12151 12152| Name| Description| 12153| -------- | -------- | 12154| event | Pointer to the custom component event. | 12155 12156**Returns** 12157 12158Returns the custom event ID. 12159 12160 12161### OH_ArkUI_NodeCustomEvent_GetEventType() 12162 12163``` 12164ArkUI_NodeCustomEventType OH_ArkUI_NodeCustomEvent_GetEventType (ArkUI_NodeCustomEvent * event) 12165``` 12166**Description** 12167 12168Obtains the event type through a custom component event. 12169 12170**Since**: 12 12171 12172**Parameters** 12173 12174| Name| Description| 12175| -------- | -------- | 12176| event | Pointer to the custom component event. | 12177 12178**Returns** 12179 12180Returns the type of the custom component event. 12181 12182 12183### OH_ArkUI_NodeCustomEvent_GetLayoutConstraintInMeasure() 12184 12185``` 12186ArkUI_LayoutConstraint* OH_ArkUI_NodeCustomEvent_GetLayoutConstraintInMeasure (ArkUI_NodeCustomEvent * event) 12187``` 12188**Description** 12189 12190Obtains the size constraint for measurement through a custom component event. 12191 12192**Since**: 12 12193 12194**Parameters** 12195 12196| Name| Description| 12197| -------- | -------- | 12198| event | Pointer to the custom component event. | 12199 12200**Returns** 12201 12202Pointer to the constraint size. 12203 12204 12205### OH_ArkUI_NodeCustomEvent_GetNodeHandle() 12206 12207``` 12208ArkUI_NodeHandle OH_ArkUI_NodeCustomEvent_GetNodeHandle (ArkUI_NodeCustomEvent * event) 12209``` 12210**Description** 12211 12212Obtains a component object through a custom component event. 12213 12214**Since**: 12 12215 12216**Parameters** 12217 12218| Name| Description| 12219| -------- | -------- | 12220| event | Pointer to the custom component event. | 12221 12222**Returns** 12223 12224Returns the obtained component object. 12225 12226 12227### OH_ArkUI_NodeCustomEvent_GetPositionInLayout() 12228 12229``` 12230ArkUI_IntOffset OH_ArkUI_NodeCustomEvent_GetPositionInLayout (ArkUI_NodeCustomEvent * event) 12231``` 12232**Description** 12233 12234Obtains the expected position of a component relative to its parent component in the layout phase through a custom component event. 12235 12236**Since**: 12 12237 12238**Parameters** 12239 12240| Name| Description| 12241| -------- | -------- | 12242| event | Pointer to the custom component event. | 12243 12244**Returns** 12245 12246Returns the expected position relative to the parent component. 12247 12248 12249### OH_ArkUI_NodeCustomEvent_GetUserData() 12250 12251``` 12252void* OH_ArkUI_NodeCustomEvent_GetUserData (ArkUI_NodeCustomEvent * event) 12253``` 12254**Description** 12255 12256Obtains custom event parameters through a custom component event. 12257 12258**Since**: 12 12259 12260**Parameters** 12261 12262| Name| Description| 12263| -------- | -------- | 12264| event | Pointer to the custom component event. | 12265 12266**Returns** 12267 12268Returns the custom event parameters. 12269 12270 12271### OH_ArkUI_NodeCustomEvent_SetCustomSpanMetrics() 12272 12273``` 12274int32_t OH_ArkUI_NodeCustomEvent_SetCustomSpanMetrics (ArkUI_NodeCustomEvent * event, ArkUI_CustomSpanMetrics * metrics ) 12275``` 12276**Description** 12277 12278Sets the measurement metrics of a custom span through a custom component event. 12279 12280**Since**: 12 12281 12282**Parameters** 12283 12284| Name| Description| 12285| -------- | -------- | 12286| event | Pointer to the custom component event. | 12287| metrics | Measurement metrics to set. | 12288 12289**Returns** 12290 12291Returns **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. 12292 12293 12294### OH_ArkUI_NodeEvent_GetDragEvent() 12295 12296``` 12297ArkUI_DragEvent* OH_ArkUI_NodeEvent_GetDragEvent (ArkUI_NodeEvent * nodeEvent) 12298``` 12299**Description** 12300 12301Obtains an **ArkUI_DragEvent** object from the specified **ArkUI_DragEvent** object. 12302 12303**Since**: 12 12304 12305**Parameters** 12306 12307| Name| Description| 12308| -------- | -------- | 12309| node | Pointer to an **ArkUI_NodeEvent** object. | 12310 12311**Returns** 12312 12313Returns the pointer to an **ArkUI_DragEvent** object; returns null if the parameter passed in is invalid or is not a drag-related event. 12314 12315 12316### OH_ArkUI_NodeEvent_GetEventType() 12317 12318``` 12319ArkUI_NodeEventType OH_ArkUI_NodeEvent_GetEventType (ArkUI_NodeEvent * event) 12320``` 12321**Description** 12322 12323Obtains the type of a component event. 12324 12325**Since**: 12 12326 12327**Parameters** 12328 12329| Name| Description| 12330| -------- | -------- | 12331| event | Pointer to the component event. | 12332 12333**Returns** 12334 12335Returns the type of the component event. 12336 12337 12338### OH_ArkUI_NodeEvent_GetInputEvent() 12339 12340``` 12341ArkUI_UIInputEvent* OH_ArkUI_NodeEvent_GetInputEvent (ArkUI_NodeEvent * event) 12342``` 12343**Description** 12344 12345Obtains input event (for example, touch event) data for a component event. 12346 12347**Since**: 12 12348 12349**Parameters** 12350 12351| Name| Description| 12352| -------- | -------- | 12353| event | Pointer to the component event. | 12354 12355**Returns** 12356 12357Returns the pointer to the input event data. 12358 12359 12360### OH_ArkUI_NodeEvent_GetNodeComponentEvent() 12361 12362``` 12363ArkUI_NodeComponentEvent* OH_ArkUI_NodeEvent_GetNodeComponentEvent (ArkUI_NodeEvent * event) 12364``` 12365**Description** 12366 12367Obtains the numerical data in a component event. 12368 12369**Since**: 12 12370 12371**Parameters** 12372 12373| Name| Description| 12374| -------- | -------- | 12375| event | Pointer to the component event. | 12376 12377**Returns** 12378 12379Returns the pointer to the numerical data. 12380 12381 12382### OH_ArkUI_NodeEvent_GetNodeHandle() 12383 12384``` 12385ArkUI_NodeHandle OH_ArkUI_NodeEvent_GetNodeHandle (ArkUI_NodeEvent * event) 12386``` 12387**Description** 12388 12389Obtains the component object that triggers an event. 12390 12391**Since**: 12 12392 12393**Parameters** 12394 12395| Name| Description| 12396| -------- | -------- | 12397| event | Pointer to the component event. | 12398 12399**Returns** 12400 12401Component object that triggers the event. 12402 12403 12404### OH_ArkUI_NodeEvent_GetNumberValue() 12405 12406``` 12407int32_t OH_ArkUI_NodeEvent_GetNumberValue (ArkUI_NodeEvent * event, int32_t index, ArkUI_NumberValue * value ) 12408``` 12409**Description** 12410 12411Obtains the numeric-type parameter of a component event. 12412 12413**Since**: 12 12414 12415**Parameters** 12416 12417| Name| Description| 12418| -------- | -------- | 12419| event | Pointer to the component event. | 12420| index | Return value index. | 12421| value | Return value. | 12422 12423**Returns** 12424 12425Returns **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. 12426 12427 12428### OH_ArkUI_NodeEvent_GetPreDragStatus() 12429 12430``` 12431ArkUI_PreDragStatus OH_ArkUI_NodeEvent_GetPreDragStatus (ArkUI_NodeEvent * nodeEvent) 12432``` 12433**Description** 12434 12435Obtains the state prior to a drop and drop operation. 12436 12437**Since**: 12 12438 12439**Parameters** 12440 12441| Name| Description| 12442| -------- | -------- | 12443| node | ArkUI_NodeEvent node object. | 12444 12445**Returns** 12446 12447Returns the state prior to the drop and drop operation. 12448 12449 12450### OH_ArkUI_NodeEvent_GetStringAsyncEvent() 12451 12452``` 12453ArkUI_StringAsyncEvent* OH_ArkUI_NodeEvent_GetStringAsyncEvent (ArkUI_NodeEvent * event) 12454``` 12455**Description** 12456 12457Obtains the string data in a component event. 12458 12459**Since**: 12 12460 12461**Parameters** 12462 12463| Name| Description| 12464| -------- | -------- | 12465| event | Pointer to the component event. | 12466 12467**Returns** 12468 12469ArkUI_StringAsyncEvent\Pointer to string data. 12470 12471 12472### OH_ArkUI_NodeEvent_GetStringValue() 12473 12474``` 12475int32_t OH_ArkUI_NodeEvent_GetStringValue (ArkUI_NodeEvent * event, int32_t index, char ** string, int32_t * stringSize ) 12476``` 12477**Description** 12478 12479Obtains 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. 12480 12481**Since**: 12 12482 12483**Parameters** 12484 12485| Name| Description| 12486| -------- | -------- | 12487| event | Pointer to the component event. | 12488| index | Return value index. | 12489| string | Pointer to the string array. | 12490| stringSize | Length of the string array. | 12491 12492**Returns** 12493 12494Returns **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. 12495 12496 12497### OH_ArkUI_NodeEvent_GetTargetId() 12498 12499``` 12500int32_t OH_ArkUI_NodeEvent_GetTargetId (ArkUI_NodeEvent * event) 12501``` 12502**Description** 12503 12504Obtains the custom ID of a component event. 12505 12506The 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. 12507 12508**Since**: 12 12509 12510**Parameters** 12511 12512| Name| Description| 12513| -------- | -------- | 12514| event | Pointer to the component event. | 12515 12516**Returns** 12517 12518Returns the custom ID of the component event. 12519 12520 12521### OH_ArkUI_NodeEvent_GetUserData() 12522 12523``` 12524void* OH_ArkUI_NodeEvent_GetUserData (ArkUI_NodeEvent * event) 12525``` 12526**Description** 12527 12528Obtains the custom data in a component event. 12529 12530This parameter is passed in **registerNodeEvent** and can be applied to the service logic when the event is triggered. 12531 12532**Since**: 12 12533 12534**Parameters** 12535 12536| Name| Description| 12537| -------- | -------- | 12538| event | Pointer to the component event. | 12539 12540**Returns** 12541 12542Returns the pointer to user data. 12543 12544 12545### OH_ArkUI_NodeEvent_SetReturnNumberValue() 12546 12547``` 12548int32_t OH_ArkUI_NodeEvent_SetReturnNumberValue (ArkUI_NodeEvent * event, ArkUI_NumberValue * value, int32_t size ) 12549``` 12550**Description** 12551 12552Sets the return value for a component event. 12553 12554**Since**: 12 12555 12556**Parameters** 12557 12558| Name| Description| 12559| -------- | -------- | 12560| event | Pointer to the component event. | 12561| value | Event numeric type array. | 12562| size | Size of the array. | 12563 12564**Returns** 12565 12566Returns **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. 12567 12568 12569### OH_ArkUI_NodeUtils_AddCustomProperty() 12570 12571``` 12572void OH_ArkUI_NodeUtils_AddCustomProperty (ArkUI_NodeHandle node, const char * name, const char * value ) 12573``` 12574**Description** 12575 12576Sets a custom property for a component. This API takes effect only in the main thread. 12577 12578**Since**: 13 12579 12580**Parameters** 12581 12582| Name| Description| 12583| -------- | -------- | 12584| node | **ArkUI_NodeHandle** pointer. | 12585| name | Name of the custom property. A null pointer is not allowed. | 12586| value | Value of the custom property. A null pointer is not allowed. | 12587 12588 12589### OH_ArkUI_NodeUtils_GetActiveChildrenInfo() 12590 12591``` 12592int32_t OH_ArkUI_NodeUtils_GetActiveChildrenInfo (ArkUI_NodeHandle head, ArkUI_ActiveChildrenInfo ** handle ) 12593``` 12594**Description** 12595 12596Obtains all active child nodes of the specified node. Spans are not counted as child nodes. 12597 12598**Since**: 14 12599 12600**Parameters** 12601 12602| Name| Description| 12603| -------- | -------- | 12604| head | Node for which to obtain the child nodes. | 12605| handle | Pointer to the struct containing information about the child nodes of the head node. | 12606 12607**Returns** 12608 12609Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12610 12611 12612### OH_ArkUI_NodeUtils_GetCurrentPageRootNode() 12613 12614``` 12615ArkUI_NodeHandle OH_ArkUI_NodeUtils_GetCurrentPageRootNode (ArkUI_NodeHandle node) 12616``` 12617**Description** 12618 12619Obtains the root node of the current page. 12620 12621**Since**: 14 12622 12623**Parameters** 12624 12625| Name| Description| 12626| -------- | -------- | 12627| node | Target node. | 12628 12629**Returns** 12630 12631Returns the pointer to the root node if the node exists; returns **NULL** otherwise. 12632 12633 12634### OH_ArkUI_NodeUtils_GetCustomProperty() 12635 12636``` 12637int32_t OH_ArkUI_NodeUtils_GetCustomProperty (ArkUI_NodeHandle node, const char * name, ArkUI_CustomProperty ** handle ) 12638``` 12639**Description** 12640 12641Obtains the value of a custom property of the specified component. 12642 12643**Since**: 14 12644 12645**Parameters** 12646 12647| Name| Description| 12648| -------- | -------- | 12649| node | **ArkUI_NodeHandle** pointer. | 12650| name | Name of the custom property. | 12651| handle | Pointer to the struct that receives the custom property corresponding to the key parameter name. | 12652 12653**Returns** 12654 12655Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12656 12657 12658### OH_ArkUI_NodeUtils_GetLayoutPosition() 12659 12660``` 12661int32_t OH_ArkUI_NodeUtils_GetLayoutPosition (ArkUI_NodeHandle node, ArkUI_IntOffset * localOffset ) 12662``` 12663**Description** 12664 12665Obtains 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. 12666 12667**Since**: 12 12668 12669**Parameters** 12670 12671| Name| Description| 12672| -------- | -------- | 12673| node | **ArkUI_NodeHandle** pointer. | 12674| localOffset | Offset of the component handle relative to the parent component, in pixels. | 12675 12676**Returns** 12677 12678Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12679 12680 12681### OH_ArkUI_NodeUtils_GetLayoutPositionInScreen() 12682 12683``` 12684int32_t OH_ArkUI_NodeUtils_GetLayoutPositionInScreen (ArkUI_NodeHandle node, ArkUI_IntOffset * screenOffset ) 12685``` 12686**Description** 12687 12688Obtains the position of the component's layout area relative to the screen. The relative position does not count in transformation attributes, such as translate. 12689 12690**Since**: 12 12691 12692**Parameters** 12693 12694| Name| Description| 12695| -------- | -------- | 12696| node | **ArkUI_NodeHandle** pointer. | 12697| screenOffset | Offset of the component handle relative to the screen, in pixels. | 12698 12699**Returns** 12700 12701Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12702 12703 12704### OH_ArkUI_NodeUtils_GetLayoutPositionInWindow() 12705 12706``` 12707int32_t OH_ArkUI_NodeUtils_GetLayoutPositionInWindow (ArkUI_NodeHandle node, ArkUI_IntOffset * globalOffset ) 12708``` 12709**Description** 12710 12711Obtains the position of the component's layout area relative to the window. The relative position does not count in transformation attributes, such as translate. 12712 12713**Since**: 12 12714 12715**Parameters** 12716 12717| Name| Description| 12718| -------- | -------- | 12719| node | **ArkUI_NodeHandle** pointer. | 12720| globalOffset | Offset of the component handle relative to the window, in pixels. | 12721 12722**Returns** 12723 12724Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12725 12726 12727### OH_ArkUI_NodeUtils_GetLayoutSize() 12728 12729``` 12730int32_t OH_ArkUI_NodeUtils_GetLayoutSize (ArkUI_NodeHandle node, ArkUI_IntSize * size ) 12731``` 12732**Description** 12733 12734Obtains the layout area size of a component. The size does not count in transformation attributes, such as scale. 12735 12736**Since**: 12 12737 12738**Parameters** 12739 12740| Name| Description| 12741| -------- | -------- | 12742| node | **ArkUI_NodeHandle** pointer. | 12743| size | Size of the layout area, in px. | 12744 12745**Returns** 12746 12747Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12748 12749 12750### OH_ArkUI_NodeUtils_GetNodeType() 12751 12752``` 12753int32_t OH_ArkUI_NodeUtils_GetNodeType (ArkUI_NodeHandle node) 12754``` 12755**Description** 12756 12757Obtains the type of the specified node. 12758 12759**Since**: 14 12760 12761**Parameters** 12762 12763| Name| Description| 12764| -------- | -------- | 12765| node | Target node. | 12766 12767**Returns** 12768 12769Returns 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). 12770 12771 12772### OH_ArkUI_NodeUtils_GetParentInPageTree() 12773 12774``` 12775ArkUI_NodeHandle OH_ArkUI_NodeUtils_GetParentInPageTree (ArkUI_NodeHandle node) 12776``` 12777**Description** 12778 12779Obtains the parent node, which can be a component node created with ArkTS. 12780 12781**Since**: 14 12782 12783**Parameters** 12784 12785| Name| Description| 12786| -------- | -------- | 12787| node | Target node. | 12788 12789**Returns** 12790 12791Returns the pointer to the component if the component exists; returns **NULL** otherwise. 12792 12793 12794### OH_ArkUI_NodeUtils_GetPositionWithTranslateInScreen() 12795 12796``` 12797int32_t OH_ArkUI_NodeUtils_GetPositionWithTranslateInScreen (ArkUI_NodeHandle node, ArkUI_IntOffset * translateOffset ) 12798``` 12799**Description** 12800 12801Obtains the position of a component on the screen, including the translate attribute. 12802 12803**Since**: 12 12804 12805**Parameters** 12806 12807| Name| Description| 12808| -------- | -------- | 12809| node | **ArkUI_NodeHandle** pointer. | 12810| translateOffset | Accumulated offset of the component, its parent component, and its ancestor node, in px. | 12811 12812**Returns** 12813 12814Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12815 12816 12817### OH_ArkUI_NodeUtils_GetPositionWithTranslateInWindow() 12818 12819``` 12820int32_t OH_ArkUI_NodeUtils_GetPositionWithTranslateInWindow (ArkUI_NodeHandle node, ArkUI_IntOffset * translateOffset ) 12821``` 12822**Description** 12823 12824Obtains the position of a component in the window, including the translate attribute. 12825 12826**Since**: 12 12827 12828**Parameters** 12829 12830| Name| Description| 12831| -------- | -------- | 12832| node | **ArkUI_NodeHandle** pointer. | 12833| translateOffset | Accumulated offset of the component, its parent component, and its ancestor node, in px. | 12834 12835**Returns** 12836 12837Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12838 12839 12840### OH_ArkUI_NodeUtils_IsCreatedByNDK() 12841 12842``` 12843bool OH_ArkUI_NodeUtils_IsCreatedByNDK (ArkUI_NodeHandle node) 12844``` 12845**Description** 12846 12847Checks whether the specified component is created with the C API. 12848 12849**Since**: 14 12850 12851**Parameters** 12852 12853| Name| Description| 12854| -------- | -------- | 12855| node | Target node. | 12856 12857**Returns** 12858 12859Returns 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. 12860 12861 12862### OH_ArkUI_NodeUtils_RemoveCustomProperty() 12863 12864``` 12865void OH_ArkUI_NodeUtils_RemoveCustomProperty (ArkUI_NodeHandle node, const char * name ) 12866``` 12867**Description** 12868 12869Removes a custom property that has been set for the specified component. 12870 12871**Since**: 13 12872 12873**Parameters** 12874 12875| Name| Description| 12876| -------- | -------- | 12877| node | **ArkUI_NodeHandle** pointer. | 12878| name | Name of the custom property. | 12879 12880 12881### OH_ArkUI_PanGesture_GetOffsetX() 12882 12883``` 12884float OH_ArkUI_PanGesture_GetOffsetX (const ArkUI_GestureEvent * event) 12885``` 12886**Description** 12887 12888Obtains the relative offset of a pan gesture along the x-axis. 12889 12890**Since**: 12 12891 12892**Parameters** 12893 12894| Name| Description| 12895| -------- | -------- | 12896| event | Gesture event. | 12897 12898**Returns** 12899 12900Returns the relative offset of the gesture along the x-axis, in px. 12901 12902 12903### OH_ArkUI_PanGesture_GetOffsetY() 12904 12905``` 12906float OH_ArkUI_PanGesture_GetOffsetY (const ArkUI_GestureEvent * event) 12907``` 12908**Description** 12909 12910Obtains the relative offset of a pan gesture along the y-axis. 12911 12912**Since**: 12 12913 12914**Parameters** 12915 12916| Name| Description| 12917| -------- | -------- | 12918| event | Gesture event. | 12919 12920**Returns** 12921 12922Returns the relative offset of the gesture along the y-axis, in px. 12923 12924 12925### OH_ArkUI_PanGesture_GetVelocity() 12926 12927``` 12928float OH_ArkUI_PanGesture_GetVelocity (const ArkUI_GestureEvent * event) 12929``` 12930**Description** 12931 12932Obtains the velocity of a pan gesture along the main axis. 12933 12934**Since**: 12 12935 12936**Parameters** 12937 12938| Name| Description| 12939| -------- | -------- | 12940| event | Gesture event. | 12941 12942**Returns** 12943 12944Returns 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. 12945 12946 12947### OH_ArkUI_PanGesture_GetVelocityX() 12948 12949``` 12950float OH_ArkUI_PanGesture_GetVelocityX (const ArkUI_GestureEvent * event) 12951``` 12952**Description** 12953 12954Obtains the velocity of a pan gesture along the x-axis. 12955 12956**Since**: 12 12957 12958**Parameters** 12959 12960| Name| Description| 12961| -------- | -------- | 12962| event | Gesture event. | 12963 12964**Returns** 12965 12966Returns the velocity of the pan gesture along the x-axis, in px/s. 12967 12968 12969### OH_ArkUI_PanGesture_GetVelocityY() 12970 12971``` 12972float OH_ArkUI_PanGesture_GetVelocityY (const ArkUI_GestureEvent * event) 12973``` 12974**Description** 12975 12976Obtains the velocity of a pan gesture along the y-axis. 12977 12978**Since**: 12 12979 12980**Parameters** 12981 12982| Name| Description| 12983| -------- | -------- | 12984| event | Gesture event. | 12985 12986**Returns** 12987 12988Returns the velocity of the pan gesture along the y-axis, in px/s. 12989 12990 12991### OH_ArkUI_ParallelInnerGestureEvent_GetConflictRecognizers() 12992 12993``` 12994int32_t OH_ArkUI_ParallelInnerGestureEvent_GetConflictRecognizers (ArkUI_ParallelInnerGestureEvent * event, ArkUI_GestureRecognizerHandleArray * array, int32_t * size ) 12995``` 12996**Description** 12997 12998Obtains the conflicting gesture recognizers in a parallel internal gesture event. 12999 13000**Since**: 12 13001 13002**Parameters** 13003 13004| Name| Description| 13005| -------- | -------- | 13006| event | Parallel internal gesture event. | 13007| array | Array of conflicting gesture recognizers. | 13008| size | Size of the conflicting gesture recognizer array. | 13009 13010**Returns** 13011 13012Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 13013 13014 13015### OH_ArkUI_ParallelInnerGestureEvent_GetCurrentRecognizer() 13016 13017``` 13018ArkUI_GestureRecognizer* OH_ArkUI_ParallelInnerGestureEvent_GetCurrentRecognizer (ArkUI_ParallelInnerGestureEvent * event) 13019``` 13020**Description** 13021 13022Obtains the current gesture recognizer in a parallel internal gesture event. 13023 13024**Since**: 12 13025 13026**Parameters** 13027 13028| Name| Description| 13029| -------- | -------- | 13030| event | Parallel internal gesture event. | 13031 13032**Returns** 13033 13034Returns the pointer to the current gesture recognizer. 13035 13036 13037### OH_ArkUI_ParallelInnerGestureEvent_GetUserData() 13038 13039``` 13040void* OH_ArkUI_ParallelInnerGestureEvent_GetUserData (ArkUI_ParallelInnerGestureEvent * event) 13041``` 13042**Description** 13043 13044Obtains custom data in the parallel internal gesture event. 13045 13046**Since**: 12 13047 13048**Parameters** 13049 13050| Name| Description| 13051| -------- | -------- | 13052| event | Parallel internal gesture event. | 13053 13054**Returns** 13055 13056Returns the pointer to custom data. 13057 13058 13059### OH_ArkUI_PinchGesture_GetCenterX() 13060 13061``` 13062float OH_ArkUI_PinchGesture_GetCenterX (const ArkUI_GestureEvent * event) 13063``` 13064**Description** 13065 13066Obtains the X coordinate of the center of the pinch gesture, in vp, relative to the upper left corner of the current component. 13067 13068**Since**: 12 13069 13070**Parameters** 13071 13072| Name| Description| 13073| -------- | -------- | 13074| event | Gesture event. | 13075 13076**Returns** 13077Returns the X coordinate of the center of the pinch gesture, in vp, relative to the upper left corner of the current component. 13078 13079 13080### OH_ArkUI_PinchGesture_GetCenterY() 13081 13082``` 13083float OH_ArkUI_PinchGesture_GetCenterY (const ArkUI_GestureEvent * event) 13084``` 13085**Description** 13086 13087Obtains the Y coordinate of the center of the pinch gesture, in vp, relative to the upper left corner of the current component. 13088 13089**Since**: 12 13090 13091**Parameters** 13092 13093| Name| Description| 13094| -------- | -------- | 13095| event | Gesture event. | 13096 13097**Returns** 13098 13099Returns the Y coordinate of the center of the pinch gesture, in vp, relative to the upper left corner of the current component. 13100 13101 13102### OH_ArkUI_PinchGesture_GetScale() 13103 13104``` 13105float OH_ArkUI_PinchGesture_GetScale (const ArkUI_GestureEvent * event) 13106``` 13107**Description** 13108 13109Obtains the scale ratio of a pinch gesture. 13110 13111**Since**: 12 13112 13113**Parameters** 13114 13115| Name| Description| 13116| -------- | -------- | 13117| event | Gesture event. | 13118 13119**Returns** 13120 13121Scale. 13122 13123 13124### OH_ArkUI_QueryModuleInterfaceByName() 13125 13126``` 13127void* OH_ArkUI_QueryModuleInterfaceByName (ArkUI_NativeAPIVariantKind type, const char * structName ) 13128``` 13129**Description** 13130 13131Obtains the native API set of a specified type. 13132 13133**Since**: 12 13134 13135**Parameters** 13136 13137| Name| Description| 13138| -------- | -------- | 13139| type | Type of the native API set provided by ArkUI, for example, **ARKUI_NATIVE_NODE** or **ARKUI_NATIVE_GESTURE**. | 13140| sturctName | Name of a native struct defined in the corresponding header file, for example, **ArkUI_NativeNodeAPI_1** in <arkui/native_node.h>. | 13141 13142**Returns** 13143 13144Returns 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); } 13145 13146 13147### OH_ArkUI_RegisterSystemColorModeChangeEvent() 13148 13149``` 13150int32_t OH_ArkUI_RegisterSystemColorModeChangeEvent (ArkUI_NodeHandle node, void * userData, void(*)(ArkUI_SystemColorMode colorMode, void *userData) onColorModeChange ) 13151``` 13152**Description** 13153 13154Registers an event listener for system color mode changes. A single component can only register one callback for system color mode changes. 13155 13156**Since**: 12 13157 13158**Parameters** 13159 13160| Name| Description| 13161| -------- | -------- | 13162| node | Specified node. | 13163| userData | Custom event parameter, which is passed in the callback when the event is triggered. | 13164| onColorModeChange | Callback to be executed when the event is triggered. | 13165 13166**Returns** 13167 13168Returns **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. 13169 13170 13171### OH_ArkUI_RegisterSystemFontStyleChangeEvent() 13172 13173``` 13174int32_t OH_ArkUI_RegisterSystemFontStyleChangeEvent (ArkUI_NodeHandle node, void * userData, void(*)(ArkUI_SystemFontStyleEvent *event, void *userData) onFontStyleChange ) 13175``` 13176**Description** 13177 13178Registers an event listener for system font style changes. A single component can only register one callback for system font style changes. 13179 13180**Since**: 12 13181 13182**Parameters** 13183 13184| Name| Description| 13185| -------- | -------- | 13186| node | Specified node. | 13187| userData | Custom event parameter, which is passed in the callback when the event is triggered. | 13188| onFontStyleChange | Callback to be executed when the event is triggered. | 13189 13190**Returns** 13191 13192Returns **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. 13193 13194 13195### OH_ArkUI_RotationGesture_GetAngle() 13196 13197``` 13198float OH_ArkUI_RotationGesture_GetAngle (const ArkUI_GestureEvent * event) 13199``` 13200**Description** 13201 13202Obtains the angle information of a rotation gesture. 13203 13204**Since**: 12 13205 13206**Parameters** 13207 13208| Name| Description| 13209| -------- | -------- | 13210| event | Gesture event. | 13211 13212**Returns** 13213 13214Rotation angle. 13215 13216 13217### OH_ArkUI_SetArkUIGestureRecognizerDisposeNotify() 13218 13219``` 13220int32_t OH_ArkUI_SetArkUIGestureRecognizerDisposeNotify (ArkUI_GestureRecognizer * recognizer, ArkUI_GestureRecognizerDestructNotifyCallback callback, void * userData ) 13221``` 13222**Description** 13223 13224Sets a callback function for notifying gesture recognizer destruction. 13225 13226**Parameters** 13227 13228| Name| Description| 13229| -------- | -------- | 13230| recognizer | Pointer to the gesture recognizer. | 13231| callback | Callback function for notifying gesture recognizer destruction. | 13232| userData | Custom data. | 13233 13234**Returns** 13235 13236Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 13237 13238 13239### OH_ArkUI_SetDragEventStrictReportWithContext() 13240 13241``` 13242int32_t OH_ArkUI_SetDragEventStrictReportWithContext (ArkUI_ContextHandle uiContext, bool enabled ) 13243``` 13244**Description** 13245 13246Sets 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. 13247 13248**Since**: 12 13249 13250**Parameters** 13251 13252| Name| Description| 13253| -------- | -------- | 13254| uiContext | Pointer to the UI instance. | 13255| enabled | Whether to enable strict reporting on drag events. | 13256 13257**Returns** 13258 13259Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13260 13261 13262### OH_ArkUI_SetDragEventStrictReportWithNode() 13263 13264``` 13265int32_t OH_ArkUI_SetDragEventStrictReportWithNode (ArkUI_NodeHandle node, bool enabled ) 13266``` 13267**Description** 13268 13269Sets 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. 13270 13271**Since**: 12 13272 13273**Parameters** 13274 13275| Name| Description| 13276| -------- | -------- | 13277| node | Pointer to a component node. | 13278| enabled | Whether to enable strict reporting on drag events. | 13279 13280**Returns** 13281 13282Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13283 13284 13285### OH_ArkUI_SetGestureRecognizerEnabled() 13286 13287``` 13288int32_t OH_ArkUI_SetGestureRecognizerEnabled (ArkUI_GestureRecognizer * recognizer, bool enabled ) 13289``` 13290**Description** 13291 13292Sets the enabled state of a gesture recognizer. 13293 13294**Since**: 12 13295 13296**Parameters** 13297 13298| Name| Description| 13299| -------- | -------- | 13300| recognizer | Pointer to the gesture recognizer. | 13301| enabled | Whether to enable notification. | 13302 13303**Returns** 13304 13305Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 13306 13307 13308### OH_ArkUI_SetNodeAllowedDropDataTypes() 13309 13310``` 13311int32_t OH_ArkUI_SetNodeAllowedDropDataTypes (ArkUI_NodeHandle node, const char * typesArray[], int32_t count ) 13312``` 13313**Description** 13314 13315Sets 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). 13316 13317**Since**: 12 13318 13319**Parameters** 13320 13321| Name| Description| 13322| -------- | -------- | 13323| node | Pointer to a component node. | 13324| typesArray | Array of data types that can fall into. | 13325| count | Length of an array. | 13326 13327**Returns** 13328 13329Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13330 13331 13332### OH_ArkUI_SetNodeDraggable() 13333 13334``` 13335int32_t OH_ArkUI_SetNodeDraggable (ArkUI_NodeHandle node, bool enabled ) 13336``` 13337**Description** 13338 13339Sets whether the component is draggable. 13340 13341**Since**: 12 13342 13343**Parameters** 13344 13345| Name| Description| 13346| -------- | -------- | 13347| node | Pointer to a component node. | 13348| bool | Whether the component is draggable. | 13349 13350**Returns** 13351 13352Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13353 13354 13355### OH_ArkUI_SetNodeDragPreview() 13356 13357``` 13358int32_t OH_ArkUI_SetNodeDragPreview (ArkUI_NodeHandle node, OH_PixelmapNative * preview ) 13359``` 13360**Description** 13361 13362Sets a custom drag preview for the specified component. 13363 13364**Since**: 12 13365 13366**Parameters** 13367 13368| Name| Description| 13369| -------- | -------- | 13370| node | Pointer to the target component node. | 13371| preview | Custom drag preview, which is a pixel map. | 13372 13373**Returns** 13374 13375Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13376 13377 13378### OH_ArkUI_SetNodeDragPreviewOption() 13379 13380``` 13381int32_t OH_ArkUI_SetNodeDragPreviewOption (ArkUI_NodeHandle node, ArkUI_DragPreviewOption * option ) 13382``` 13383**Description** 13384 13385Sets an **ArkUI_DragPreviewOption** object for the specified component. 13386 13387**Since**: 12 13388 13389**Parameters** 13390 13391| Name| Description| 13392| -------- | -------- | 13393| node | Pointer to a component node. | 13394| option | Custom parameters. | 13395 13396**Returns** 13397 13398Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13399 13400 13401### OH_ArkUI_StartDrag() 13402 13403``` 13404int32_t OH_ArkUI_StartDrag (ArkUI_DragAction * dragAction) 13405``` 13406**Description** 13407 13408Initiates a drag action through the specified drag action object. 13409 13410**Since**: 12 13411 13412**Parameters** 13413 13414| Name| Description| 13415| -------- | -------- | 13416| dragAction | Drag action object. | 13417 13418**Returns** 13419 13420Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13421 13422 13423### OH_ArkUI_StyledString_AddPlaceholder() 13424 13425``` 13426void OH_ArkUI_StyledString_AddPlaceholder (ArkUI_StyledString * handle, OH_Drawing_PlaceholderSpan * placeholder ) 13427``` 13428**Description** 13429 13430Adds a placeholder. 13431 13432**Since**: 12 13433 13434**Parameters** 13435 13436| Name| Description| 13437| -------- | -------- | 13438| handle | Pointer to an **ArkUI_StyledString** object. | 13439| placeholder | Pointer to an **OH_Drawing_PlaceholderSpan** object. | 13440 13441 13442### OH_ArkUI_StyledString_AddText() 13443 13444``` 13445void OH_ArkUI_StyledString_AddText (ArkUI_StyledString * handle, const char * content ) 13446``` 13447**Description** 13448 13449Sets the text content based on the current format string style. 13450 13451**Since**: 12 13452 13453**Parameters** 13454 13455| Name| Description| 13456| -------- | -------- | 13457| handle | Pointer to an **ArkUI_StyledString** object. | 13458| content | Pointer to the text content. | 13459 13460 13461### OH_ArkUI_StyledString_Create() 13462 13463``` 13464ArkUI_StyledString* OH_ArkUI_StyledString_Create (OH_Drawing_TypographyStyle * style, OH_Drawing_FontCollection * collection ) 13465``` 13466**Description** 13467 13468Creates an **ArkUI_StyledString** object. 13469 13470**Since**: 12 13471 13472**Parameters** 13473 13474| Name| Description| 13475| -------- | -------- | 13476| style | Pointer to an **OH_Drawing_TypographyStyle** object, which is obtained by calling **OH_Drawing_CreateTypographyStyle**. | 13477| collection | Pointer to an **OH_Drawing_FontCollection** object, which is obtained by calling **OH_Drawing_CreateFontCollection**. | 13478 13479**Returns** 13480 13481Returns 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. 13482 13483 13484### OH_ArkUI_StyledString_CreateTypography() 13485 13486``` 13487OH_Drawing_Typography* OH_ArkUI_StyledString_CreateTypography (ArkUI_StyledString * handle) 13488``` 13489**Description** 13490 13491Creates an **OH_Drawing_Typography** object based on an **ArkUI_StyledString** object. 13492 13493**Since**: 12 13494 13495**Parameters** 13496 13497| Name| Description| 13498| -------- | -------- | 13499| handle | Pointer to an **ArkUI_StyledString** object. | 13500 13501**Returns** 13502 13503Returns 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. 13504 13505 13506### OH_ArkUI_StyledString_Descriptor_Create() 13507 13508``` 13509ArkUI_StyledString_Descriptor* OH_ArkUI_StyledString_Descriptor_Create (void ) 13510``` 13511**Description** 13512 13513Creates an **ArkUI_StyledString_Descriptor** object. 13514 13515**Since**: 14 13516 13517**Returns** 13518 13519Pointer to an **ArkUI_StyledString_Descriptor** object. 13520 13521 13522### OH_ArkUI_StyledString_Descriptor_Destroy() 13523 13524``` 13525void OH_ArkUI_StyledString_Descriptor_Destroy (ArkUI_StyledString_Descriptor * descriptor) 13526``` 13527**Description** 13528 13529Destroys an **ArkUI_StyledString_Descriptor** object and reclaims the memory occupied by the object. 13530 13531**Since**: 14 13532 13533**Parameters** 13534 13535| Name| Description| 13536| -------- | -------- | 13537| descriptor | Pointer to an **ArkUI_StyledString_Descriptor** object. | 13538 13539 13540### OH_ArkUI_StyledString_Destroy() 13541 13542``` 13543void OH_ArkUI_StyledString_Destroy (ArkUI_StyledString * handle) 13544``` 13545**Description** 13546 13547Destroys an **OH_Drawing_TextStyle** object and reclaims the memory occupied by the object. 13548 13549**Since**: 12 13550 13551**Parameters** 13552 13553| Name| Description| 13554| -------- | -------- | 13555| handle | Pointer to an **ArkUI_StyledString** object. | 13556 13557 13558### OH_ArkUI_StyledString_PopTextStyle() 13559 13560``` 13561void OH_ArkUI_StyledString_PopTextStyle (ArkUI_StyledString * handle) 13562``` 13563**Description** 13564 13565Removes the top style from the current formatted string object. 13566 13567**Since**: 12 13568 13569**Parameters** 13570 13571| Name| Description| 13572| -------- | -------- | 13573| handle | Pointer to an **ArkUI_StyledString** object. | 13574 13575 13576### OH_ArkUI_StyledString_PushTextStyle() 13577 13578``` 13579void OH_ArkUI_StyledString_PushTextStyle (ArkUI_StyledString * handle, OH_Drawing_TextStyle * style ) 13580``` 13581**Description** 13582 13583Sets the new typesetting style to the top of the current format string style stack. 13584 13585**Since**: 12 13586 13587**Parameters** 13588 13589| Name| Description| 13590| -------- | -------- | 13591| handle | Pointer to an **ArkUI_StyledString** object. | 13592| style | Pointer to an **OH_Drawing_TextStyle** object. | 13593 13594 13595### OH_ArkUI_SwipeGesture_GetAngle() 13596 13597``` 13598float OH_ArkUI_SwipeGesture_GetAngle (const ArkUI_GestureEvent * event) 13599``` 13600**Description** 13601 13602Obtains the angle information of the swipe gesture. 13603 13604**Since**: 12 13605 13606**Parameters** 13607 13608| Name| Description| 13609| -------- | -------- | 13610| event | Gesture event. | 13611 13612**Returns** 13613 13614Returns the angle of the swipe gesture, which is the result obtained based on the aforementioned formula. 13615 13616 13617### OH_ArkUI_SwipeGesture_GetVelocity() 13618 13619``` 13620float OH_ArkUI_SwipeGesture_GetVelocity (const ArkUI_GestureEvent * event) 13621``` 13622**Description** 13623 13624Obtains the average velocity of all fingers used in the swipe gesture. 13625 13626**Since**: 12 13627 13628**Parameters** 13629 13630| Name| Description| 13631| -------- | -------- | 13632| event | Gesture event. | 13633 13634**Returns** 13635 13636Returns the average velocity of all fingers used in the swipe gesture, in px/s. 13637 13638 13639### OH_ArkUI_SwiperIndicator_Create() 13640 13641``` 13642ArkUI_SwiperIndicator* OH_ArkUI_SwiperIndicator_Create (ArkUI_SwiperIndicatorType type) 13643``` 13644**Description** 13645 13646Creates a navigation indicator for the Swiper component. 13647 13648**Since**: 12 13649 13650**Parameters** 13651 13652| Name| Description| 13653| -------- | -------- | 13654| type | Type of the navigation indicator. | 13655 13656**Returns** 13657 13658Returns the pointer to the navigation point indicator. 13659 13660 13661### OH_ArkUI_SwiperIndicator_Dispose() 13662 13663``` 13664void OH_ArkUI_SwiperIndicator_Dispose (ArkUI_SwiperIndicator * indicator) 13665``` 13666**Description** 13667 13668Disposes of the navigation point indicator of this **Swiper** component. 13669 13670**Since**: 12 13671 13672**Parameters** 13673 13674| Name| Description| 13675| -------- | -------- | 13676| indicator | Returns the pointer to the navigation point indicator. | 13677 13678 13679### OH_ArkUI_SwiperIndicator_GetBottomPosition() 13680 13681``` 13682float OH_ArkUI_SwiperIndicator_GetBottomPosition (ArkUI_SwiperIndicator * indicator) 13683``` 13684**Description** 13685 13686Obtains the distance between the navigation point indicator and the bottom edge of the **Swiper** component. 13687 13688**Since**: 12 13689 13690**Parameters** 13691 13692| Name| Description| 13693| -------- | -------- | 13694| indicator | Returns the pointer to the navigation point indicator. | 13695 13696**Returns** 13697 13698Returns the distance between a navigation point indicator and the bottom edge of the **Swiper** component. 13699 13700 13701### OH_ArkUI_SwiperIndicator_GetColor() 13702 13703``` 13704uint32_t OH_ArkUI_SwiperIndicator_GetColor (ArkUI_SwiperIndicator * indicator) 13705``` 13706**Description** 13707 13708Obtains the color of a navigation point indicator of the dot style of the **Swiper** component. 13709 13710**Since**: 12 13711 13712**Parameters** 13713 13714| Name| Description| 13715| -------- | -------- | 13716| indicator | Returns the pointer to the navigation point indicator. | 13717 13718**Returns** 13719 13720Returns the color, in 0xARGB format. For example, 0xFFFF0000 indicates red. 13721 13722 13723### OH_ArkUI_SwiperIndicator_GetEndPosition() 13724 13725``` 13726float OH_ArkUI_SwiperIndicator_GetEndPosition (ArkUI_SwiperIndicator * indicator) 13727``` 13728**Description** 13729 13730Obtains the distance between a navigation point indicator and the right edge of the **Swiper** component. 13731 13732**Since**: 12 13733 13734**Parameters** 13735 13736| Name| Description| 13737| -------- | -------- | 13738| indicator | Returns the pointer to the navigation point indicator. | 13739 13740**Returns** 13741 13742Returns the distance between the navigation point indicator and the right edge of the **Swiper** component. 13743 13744 13745### OH_ArkUI_SwiperIndicator_GetItemHeight() 13746 13747``` 13748float OH_ArkUI_SwiperIndicator_GetItemHeight (ArkUI_SwiperIndicator * indicator) 13749``` 13750**Description** 13751 13752Obtains the height of a navigation point indicator of the dot style of the **Swiper** component. 13753 13754**Since**: 12 13755 13756**Parameters** 13757 13758| Name| Description| 13759| -------- | -------- | 13760| indicator | Returns the pointer to the navigation point indicator. | 13761 13762**Returns** 13763 13764Returns the height of the navigation point indicator of the dot style. 13765 13766 13767### OH_ArkUI_SwiperIndicator_GetItemWidth() 13768 13769``` 13770float OH_ArkUI_SwiperIndicator_GetItemWidth (ArkUI_SwiperIndicator * indicator) 13771``` 13772**Description** 13773 13774Obtains the width of a navigation point indicator of the dot style of the **Swiper** component. 13775 13776**Since**: 12 13777 13778**Parameters** 13779 13780| Name| Description| 13781| -------- | -------- | 13782| indicator | Returns the pointer to the navigation point indicator. | 13783 13784**Returns** 13785 13786Returns the width of the navigation point indicator of the dot style. 13787 13788 13789### OH_ArkUI_SwiperIndicator_GetMask() 13790 13791``` 13792int32_t OH_ArkUI_SwiperIndicator_GetMask (ArkUI_SwiperIndicator * indicator) 13793``` 13794**Description** 13795 13796Obtains whether the mask is enabled for a navigation point indicator of the dot style of the **Swiper** component. 13797 13798**Since**: 12 13799 13800**Parameters** 13801 13802| Name| Description| 13803| -------- | -------- | 13804| indicator | Returns the pointer to the navigation point indicator. | 13805 13806**Returns** 13807 13808Returns **1** if the mask is enabled; returns **0** otherwise. 13809 13810 13811### OH_ArkUI_SwiperIndicator_GetMaxDisplayCount() 13812 13813``` 13814int32_t OH_ArkUI_SwiperIndicator_GetMaxDisplayCount (ArkUI_SwiperIndicator * indicator) 13815``` 13816**Description** 13817 13818Obtains the maximum number of dots for the navigation point indicator of the dot style. 13819 13820**Since**: 12 13821 13822**Parameters** 13823 13824| Name| Description| 13825| -------- | -------- | 13826| indicator | Pointer to the navigation point indicator. | 13827 13828**Returns** 13829 13830Returns the maximum number of dots. The value ranges from 6 to 9. 13831 13832 13833### OH_ArkUI_SwiperIndicator_GetSelectedColor() 13834 13835``` 13836uint32_t OH_ArkUI_SwiperIndicator_GetSelectedColor (ArkUI_SwiperIndicator * indicator) 13837``` 13838**Description** 13839 13840Obtains the color of the selected navigation point indicator of the dot style of the **Swiper** component. 13841 13842**Since**: 12 13843 13844**Parameters** 13845 13846| Name| Description| 13847| -------- | -------- | 13848| indicator | Returns the pointer to the navigation point indicator. | 13849 13850**Returns** 13851 13852Returns the color, in 0xARGB format. For example, 0xFFFF0000 indicates red. 13853 13854 13855### OH_ArkUI_SwiperIndicator_GetSelectedItemHeight() 13856 13857``` 13858float OH_ArkUI_SwiperIndicator_GetSelectedItemHeight (ArkUI_SwiperIndicator * indicator) 13859``` 13860**Description** 13861 13862Obtains the height of the selected navigation point indicator of the dot style of the **Swiper** component. 13863 13864**Since**: 12 13865 13866**Parameters** 13867 13868| Name| Description| 13869| -------- | -------- | 13870| indicator | Returns the pointer to the navigation point indicator. | 13871 13872**Returns** 13873 13874Returns the height of the navigation point indicator of the dot style. 13875 13876 13877### OH_ArkUI_SwiperIndicator_GetSelectedItemWidth() 13878 13879``` 13880float OH_ArkUI_SwiperIndicator_GetSelectedItemWidth (ArkUI_SwiperIndicator * indicator) 13881``` 13882**Description** 13883 13884Obtains the width of the selected navigation point indicator of the dot style of the **Swiper** component. 13885 13886**Since**: 12 13887 13888**Parameters** 13889 13890| Name| Description| 13891| -------- | -------- | 13892| indicator | Returns the pointer to the navigation point indicator. | 13893 13894**Returns** 13895 13896Returns the width of the navigation point indicator of the dot style. 13897 13898 13899### OH_ArkUI_SwiperIndicator_GetStartPosition() 13900 13901``` 13902float OH_ArkUI_SwiperIndicator_GetStartPosition (ArkUI_SwiperIndicator * indicator) 13903``` 13904**Description** 13905 13906Obtains the distance between a navigation point indicator and the left edge of the **Swiper** component. 13907 13908**Since**: 12 13909 13910**Parameters** 13911 13912| Name| Description| 13913| -------- | -------- | 13914| indicator | Returns the pointer to the navigation point indicator. | 13915 13916**Returns** 13917 13918Returns the distance between the navigation point indicator and the left edge of the **Swiper** component. 13919 13920 13921### OH_ArkUI_SwiperIndicator_GetTopPosition() 13922 13923``` 13924float OH_ArkUI_SwiperIndicator_GetTopPosition (ArkUI_SwiperIndicator * indicator) 13925``` 13926**Description** 13927 13928Obtains the distance between the navigation point indicator and the top edge of the **Swiper** component. 13929 13930**Since**: 12 13931 13932**Parameters** 13933 13934| Name| Description| 13935| -------- | -------- | 13936| indicator | Returns the pointer to the navigation point indicator. | 13937 13938**Returns** 13939 13940Returns the distance between a navigation point indicator and the top edge of the **Swiper** component. 13941 13942 13943### OH_ArkUI_SwiperIndicator_SetBottomPosition() 13944 13945``` 13946void OH_ArkUI_SwiperIndicator_SetBottomPosition (ArkUI_SwiperIndicator * indicator, float value ) 13947``` 13948**Description** 13949 13950Sets the distance between the navigation point indicator and the bottom edge of the **Swiper** component. 13951 13952**Since**: 12 13953 13954**Parameters** 13955 13956| Name| Description| 13957| -------- | -------- | 13958| indicator | Pointer to a navigation point indicator. | 13959| value | Distance between a navigation point indicator and the bottom edge of the **Swiper** component. | 13960 13961 13962### OH_ArkUI_SwiperIndicator_SetColor() 13963 13964``` 13965void OH_ArkUI_SwiperIndicator_SetColor (ArkUI_SwiperIndicator * indicator, uint32_t color ) 13966``` 13967**Description** 13968 13969Sets the color of a navigation point indicator of the dot style for the **Swiper** component. 13970 13971**Since**: 12 13972 13973**Parameters** 13974 13975| Name| Description| 13976| -------- | -------- | 13977| indicator | Returns the pointer to the navigation point indicator. | 13978| color | Color, in 0xARGB format. For example, 0xFFFF0000 indicates red. | 13979 13980 13981### OH_ArkUI_SwiperIndicator_SetEndPosition() 13982 13983``` 13984void OH_ArkUI_SwiperIndicator_SetEndPosition (ArkUI_SwiperIndicator * indicator, float value ) 13985``` 13986**Description** 13987 13988Distance between the navigation point indicator and the left edge of the **Swiper** component. 13989 13990**Since**: 12 13991 13992**Parameters** 13993 13994| Name| Description| 13995| -------- | -------- | 13996| indicator | Returns the pointer to the navigation point indicator. | 13997| value | Returns the distance between the navigation point indicator and the right edge of the **Swiper** component. | 13998 13999 14000### OH_ArkUI_SwiperIndicator_SetItemHeight() 14001 14002``` 14003void OH_ArkUI_SwiperIndicator_SetItemHeight (ArkUI_SwiperIndicator * indicator, float value ) 14004``` 14005**Description** 14006 14007Sets the height of a navigation point indicator of the dot style for the **Swiper** component. 14008 14009**Since**: 12 14010 14011**Parameters** 14012 14013| Name| Description| 14014| -------- | -------- | 14015| indicator | Returns the pointer to the navigation point indicator. | 14016| value | Returns the height of the navigation point indicator of the dot style. | 14017 14018 14019### OH_ArkUI_SwiperIndicator_SetItemWidth() 14020 14021``` 14022void OH_ArkUI_SwiperIndicator_SetItemWidth (ArkUI_SwiperIndicator * indicator, float value ) 14023``` 14024**Description** 14025 14026Sets the width of a navigation point indicator of the dot style for the **Swiper** component. 14027 14028**Since**: 12 14029 14030**Parameters** 14031 14032| Name| Description| 14033| -------- | -------- | 14034| indicator | Returns the pointer to the navigation point indicator. | 14035| value | Returns the width of the navigation point indicator of the dot style. | 14036 14037 14038### OH_ArkUI_SwiperIndicator_SetMask() 14039 14040``` 14041void OH_ArkUI_SwiperIndicator_SetMask (ArkUI_SwiperIndicator * indicator, int32_t mask ) 14042``` 14043**Description** 14044 14045Sets whether to enable the mask for a navigation point indicator of the dot style for the **Swiper** component. 14046 14047**Since**: 12 14048 14049**Parameters** 14050 14051| Name| Description| 14052| -------- | -------- | 14053| indicator | Pointer to a navigation point indicator. | 14054| mask | Whether to enable the mask. The value **1** means to enable the mask, and **0** means the opposite. | 14055 14056 14057### OH_ArkUI_SwiperIndicator_SetMaxDisplayCount() 14058 14059``` 14060int32_t OH_ArkUI_SwiperIndicator_SetMaxDisplayCount (ArkUI_SwiperIndicator * indicator, int32_t maxDisplayCount ) 14061``` 14062**Description** 14063 14064Sets the maximum number of dots for the navigation point indicator of the dot style. 14065 14066**Since**: 12 14067 14068**Parameters** 14069 14070| Name| Description| 14071| -------- | -------- | 14072| indicator | Pointer to a navigation point indicator. | 14073| maxDisplayCount | Maximum number of navigation points. The value ranges from 6 to 9. | 14074 14075**Returns** 14076 14077Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if **maxDisplayCount** is set to an invalid value. 14078 14079 14080### OH_ArkUI_SwiperIndicator_SetSelectedColor() 14081 14082``` 14083void OH_ArkUI_SwiperIndicator_SetSelectedColor (ArkUI_SwiperIndicator * indicator, uint32_t selectedColor ) 14084``` 14085**Description** 14086 14087Sets the color of the selected navigation point indicator of the dot style for the **Swiper** component. 14088 14089**Since**: 12 14090 14091**Parameters** 14092 14093| Name| Description| 14094| -------- | -------- | 14095| indicator | Pointer to a navigation point indicator. | 14096| selectedColor | Color, in 0xARGB format. For example, 0xFFFF0000 indicates red. | 14097 14098 14099### OH_ArkUI_SwiperIndicator_SetSelectedItemHeight() 14100 14101``` 14102void OH_ArkUI_SwiperIndicator_SetSelectedItemHeight (ArkUI_SwiperIndicator * indicator, float value ) 14103``` 14104**Description** 14105 14106Sets the height of the selected navigation point indicator of the dot style for the **Swiper** component. 14107 14108**Since**: 12 14109 14110**Parameters** 14111 14112| Name| Description| 14113| -------- | -------- | 14114| indicator | Pointer to a navigation point indicator. | 14115| value | Height of the navigation point indicator of the dot style. | 14116 14117 14118### OH_ArkUI_SwiperIndicator_SetSelectedItemWidth() 14119 14120``` 14121void OH_ArkUI_SwiperIndicator_SetSelectedItemWidth (ArkUI_SwiperIndicator * indicator, float value ) 14122``` 14123**Description** 14124 14125Sets the width of the selected navigation point indicator of the dot style for the **Swiper** component. 14126 14127**Since**: 12 14128 14129**Parameters** 14130 14131| Name| Description| 14132| -------- | -------- | 14133| indicator | Pointer to a navigation point indicator. | 14134| value | Width of the navigation point indicator of the dot style. | 14135 14136 14137### OH_ArkUI_SwiperIndicator_SetStartPosition() 14138 14139``` 14140void OH_ArkUI_SwiperIndicator_SetStartPosition (ArkUI_SwiperIndicator * indicator, float value ) 14141``` 14142**Description** 14143 14144Sets the distance between the navigation point indicator and the left edge of the **Swiper** component. 14145 14146**Since**: 12 14147 14148**Parameters** 14149 14150| Name| Description| 14151| -------- | -------- | 14152| indicator | Pointer to a navigation point indicator. | 14153| value | Distance between the navigation point indicator and the left edge of the **Swiper** component. | 14154 14155 14156### OH_ArkUI_SwiperIndicator_SetTopPosition() 14157 14158``` 14159void OH_ArkUI_SwiperIndicator_SetTopPosition (ArkUI_SwiperIndicator * indicator, float value ) 14160``` 14161**Description** 14162 14163Sets the distance between the navigation point indicator and the top edge of the **Swiper** component. 14164 14165**Since**: 12 14166 14167**Parameters** 14168 14169| Name| Description| 14170| -------- | -------- | 14171| indicator | Pointer to a navigation point indicator. | 14172| value | Distance between a navigation point indicator and the top edge of the **Swiper** component. | 14173 14174 14175### OH_ArkUI_SystemFontStyleEvent_GetFontSizeScale() 14176 14177``` 14178float OH_ArkUI_SystemFontStyleEvent_GetFontSizeScale (const ArkUI_SystemFontStyleEvent * event) 14179``` 14180**Description** 14181 14182Obtains the font size scale from the system font style change event. 14183 14184**Since**: 12 14185 14186**Parameters** 14187 14188| Name| Description| 14189| -------- | -------- | 14190| event | Pointer to the current system font style change event. | 14191 14192**Returns** 14193 14194Returns the font size scale after the change. Default value: **1.0**. 14195 14196 14197### OH_ArkUI_SystemFontStyleEvent_GetFontWeightScale() 14198 14199``` 14200float OH_ArkUI_SystemFontStyleEvent_GetFontWeightScale (const ArkUI_SystemFontStyleEvent * event) 14201``` 14202**Description** 14203 14204Obtains the font weight scale from the system font style change event. 14205 14206**Since**: 12 14207 14208**Parameters** 14209 14210| Name| Description| 14211| -------- | -------- | 14212| event | Pointer to the current system font style change event. | 14213 14214**Returns** 14215 14216Returns the font weight scale after the change. Default value: **1.0**. 14217 14218 14219### OH_ArkUI_TransitionEffect_Combine() 14220 14221``` 14222int32_t OH_ArkUI_TransitionEffect_Combine (ArkUI_TransitionEffect * option, ArkUI_TransitionEffect * combine ) 14223``` 14224**Description** 14225 14226Sets a combination of transition effects. 14227 14228**Since**: 12 14229 14230**Parameters** 14231 14232| Name| Description| 14233| -------- | -------- | 14234| option | Transition effect options. | 14235| combine | Combination of transition effects. | 14236 14237**Returns** 14238 14239Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 14240 14241 14242### OH_ArkUI_TransitionEffect_Dispose() 14243 14244``` 14245void OH_ArkUI_TransitionEffect_Dispose (ArkUI_TransitionEffect * option) 14246``` 14247**Description** 14248 14249Destroys a transition effect object. 14250 14251**Since**: 12 14252 14253**Parameters** 14254 14255| Name| Description| 14256| -------- | -------- | 14257| option | Transition effect object. | 14258 14259 14260### OH_ArkUI_TransitionEffect_SetAnimation() 14261 14262``` 14263int32_t OH_ArkUI_TransitionEffect_SetAnimation (ArkUI_TransitionEffect * option, ArkUI_AnimateOption * animation ) 14264``` 14265**Description** 14266 14267Sets transition effect animation settings. 14268 14269**Since**: 12 14270 14271**Parameters** 14272 14273| Name| Description| 14274| -------- | -------- | 14275| option | Transition effect options. | 14276| animation | Animation settings. | 14277 14278**NOTE** 14279 14280If **combine** is used for combining transition effects, the animation settings of a transition effect are applicable to the one following it. 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_UnmarshallStyledStringDescriptor() 14288 14289``` 14290int32_t OH_ArkUI_UnmarshallStyledStringDescriptor (uint8_t * buffer, size_t bufferSize, ArkUI_StyledString_Descriptor * descriptor, size_t * resultSize ) 14291``` 14292**Description** 14293 14294Deserializes a byte array containing styled string information into a styled string. 14295 14296**Since**: 14 14297 14298**Parameters** 14299 14300| Name| Description| 14301| -------- | -------- | 14302| buffer | Byte array to be deserialized. | 14303| bufferSize | Length of the byte array. | 14304| descriptor | Pointer to an **ArkUI_StyledString_Descriptor** object. | 14305| resultSize | Actual length of the resulting byte array after deserialization. | 14306 14307**Returns** 14308 14309Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 14310 14311 14312### OH_ArkUI_UnregisterSystemColorModeChangeEvent() 14313 14314``` 14315void OH_ArkUI_UnregisterSystemColorModeChangeEvent (ArkUI_NodeHandle node) 14316``` 14317**Description** 14318 14319Unregisters the event listener for system color mode changes. 14320 14321**Since**: 12 14322 14323**Parameters** 14324 14325| Name| Description| 14326| -------- | -------- | 14327| node | Specified node. | 14328 14329 14330### OH_ArkUI_UnregisterSystemFontStyleChangeEvent() 14331 14332``` 14333void OH_ArkUI_UnregisterSystemFontStyleChangeEvent (ArkUI_NodeHandle node) 14334``` 14335**Description** 14336 14337Unregisters the event listener for system font style changes. 14338 14339**Since**: 12 14340 14341**Parameters** 14342 14343| Name| Description| 14344| -------- | -------- | 14345| node | Specified node. | 14346 14347 14348### OH_ArkUI_WaterFlowSectionOption_Create() 14349 14350``` 14351ArkUI_WaterFlowSectionOption* OH_ArkUI_WaterFlowSectionOption_Create () 14352``` 14353**Description** 14354 14355Creates a water flow section configuration. 14356 14357**Since**: 12 14358 14359**Returns** 14360 14361Return the pointer to the created water flow section configuration. 14362 14363 14364### OH_ArkUI_WaterFlowSectionOption_Dispose() 14365 14366``` 14367void OH_ArkUI_WaterFlowSectionOption_Dispose (ArkUI_WaterFlowSectionOption * option) 14368``` 14369**Description** 14370 14371Disposes of the pointer to a water flow section configuration. 14372 14373**Since**: 12 14374 14375**Parameters** 14376 14377| Name| Description| 14378| -------- | -------- | 14379| option | Pointer to a water flow section configuration. | 14380 14381 14382### OH_ArkUI_WaterFlowSectionOption_GetColumnGap() 14383 14384``` 14385float OH_ArkUI_WaterFlowSectionOption_GetColumnGap (ArkUI_WaterFlowSectionOption * option, int32_t index ) 14386``` 14387**Description** 14388 14389Obtains the gap between columns in the water flow section that matches the specified index. 14390 14391**Since**: 12 14392 14393**Parameters** 14394 14395| Name| Description| 14396| -------- | -------- | 14397| option | Pointer to a water flow section configuration. | 14398| index | Index of the target water flow section. | 14399 14400**Returns** 14401 14402Returns the gap between columns. 14403 14404 14405### OH_ArkUI_WaterFlowSectionOption_GetCrossCount() 14406 14407``` 14408int32_t OH_ArkUI_WaterFlowSectionOption_GetCrossCount (ArkUI_WaterFlowSectionOption * option, int32_t index ) 14409``` 14410**Description** 14411 14412Obtains the number of columns (in a vertical layout) or rows (in a horizontal layout) of a water flow. 14413 14414**Since**: 12 14415 14416**Parameters** 14417 14418| Name| Description| 14419| -------- | -------- | 14420| option | Pointer to a water flow section configuration. | 14421| index | Index of the target water flow section. | 14422 14423**Returns** 14424 14425Returns the number of columns (in a vertical layout) or rows (in a horizontal layout) of a water flow. 14426 14427 14428### OH_ArkUI_WaterFlowSectionOption_GetItemCount() 14429 14430``` 14431int32_t OH_ArkUI_WaterFlowSectionOption_GetItemCount (ArkUI_WaterFlowSectionOption * option, int32_t index ) 14432``` 14433**Description** 14434 14435Obtains the number of items in the water flow section that matches the specified index. 14436 14437**Since**: 12 14438 14439**Parameters** 14440 14441| Name| Description| 14442| -------- | -------- | 14443| option | Pointer to a water flow section configuration. | 14444| index | Index of the target water flow section. | 14445 14446**Returns** 14447 14448Returns the number of items in the water flow section. 14449 14450 14451### OH_ArkUI_WaterFlowSectionOption_GetMargin() 14452 14453``` 14454ArkUI_Margin OH_ArkUI_WaterFlowSectionOption_GetMargin (ArkUI_WaterFlowSectionOption * option, int32_t index ) 14455``` 14456**Description** 14457 14458Obtains the margins of the water flow section that matches the specified index. 14459 14460**Since**: 12 14461 14462**Parameters** 14463 14464| Name| Description| 14465| -------- | -------- | 14466| option | Pointer to a water flow section configuration. | 14467| index | Index of the target water flow section. | 14468 14469**Returns** 14470 14471Returns the margins. 14472 14473 14474### OH_ArkUI_WaterFlowSectionOption_GetRowGap() 14475 14476``` 14477float OH_ArkUI_WaterFlowSectionOption_GetRowGap (ArkUI_WaterFlowSectionOption * option, int32_t index ) 14478``` 14479**Description** 14480 14481Obtains the gap between rows in the water flow section that matches the specified index. 14482 14483**Since**: 12 14484 14485**Parameters** 14486 14487| Name| Description| 14488| -------- | -------- | 14489| option | Pointer to a water flow section configuration. | 14490| index | Index of the target water flow section. | 14491 14492**Returns** 14493 14494Returns the gap between rows. 14495 14496 14497### OH_ArkUI_WaterFlowSectionOption_GetSize() 14498 14499``` 14500int32_t OH_ArkUI_WaterFlowSectionOption_GetSize (ArkUI_WaterFlowSectionOption * option) 14501``` 14502**Description** 14503 14504Sets the array length for a water flow section configuration. 14505 14506**Since**: 12 14507 14508**Parameters** 14509 14510| Name| Description| 14511| -------- | -------- | 14512| option | Pointer to a water flow section configuration. | 14513 14514**Returns** 14515 14516Returns 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. 14517 14518 14519### OH_ArkUI_WaterFlowSectionOption_RegisterGetItemMainSizeCallbackByIndex() 14520 14521``` 14522void OH_ArkUI_WaterFlowSectionOption_RegisterGetItemMainSizeCallbackByIndex (ArkUI_WaterFlowSectionOption * option, int32_t index, float(*)(int32_t itemIndex) callback ) 14523``` 14524**Description** 14525 14526Obtains the main axis size of a specified item based on **flowItemIndex** through a water flow section configuration. 14527 14528**Since**: 12 14529 14530**Parameters** 14531 14532| Name| Description| 14533| -------- | -------- | 14534| option | Pointer to a water flow section configuration. | 14535| index | Index of the target water flow section. | 14536| callback | Callback used to return the result. | 14537 14538 14539### OH_ArkUI_WaterFlowSectionOption_RegisterGetItemMainSizeCallbackByIndexWithUserData() 14540 14541``` 14542void OH_ArkUI_WaterFlowSectionOption_RegisterGetItemMainSizeCallbackByIndexWithUserData (ArkUI_WaterFlowSectionOption * option, int32_t index, void * userData, float(*)(int32_t itemIndex, void *userData) callback ) 14543``` 14544**Description** 14545 14546Obtains the main axis size of a specified item based on **flowItemIndex** through a water flow section configuration. 14547 14548**Since**: 12 14549 14550**Parameters** 14551 14552| Name| Description| 14553| -------- | -------- | 14554| option | Pointer to a water flow section configuration. | 14555| index | Index of the target water flow section. | 14556| userData | Custom data of the water flow item. | 14557| callback | Callback used to return the result. | 14558 14559 14560### OH_ArkUI_WaterFlowSectionOption_SetColumnGap() 14561 14562``` 14563void OH_ArkUI_WaterFlowSectionOption_SetColumnGap (ArkUI_WaterFlowSectionOption * , int32_t index, float columnGap ) 14564``` 14565**Description** 14566 14567Sets the gap between columns in the specified water flow section. 14568 14569**Since**: 12 14570 14571**Parameters** 14572 14573| Name| Description| 14574| -------- | -------- | 14575| option | Pointer to a water flow section configuration. | 14576| index | Index of the target water flow section. | 14577| columnGap | Gap between columns. | 14578 14579 14580### OH_ArkUI_WaterFlowSectionOption_SetCrossCount() 14581 14582``` 14583void OH_ArkUI_WaterFlowSectionOption_SetCrossCount (ArkUI_WaterFlowSectionOption * option, int32_t index, int32_t crossCount ) 14584``` 14585**Description** 14586 14587Sets the number of columns (in a vertical layout) or rows (in a horizontal layout) of a water flow. 14588 14589**Since**: 12 14590 14591**Parameters** 14592 14593| Name| Description| 14594| -------- | -------- | 14595| option | Pointer to a water flow section configuration. | 14596| index | Index of the target water flow section. | 14597| crossCount | Number of columns or rows, depending on the layout direction. | 14598 14599 14600### OH_ArkUI_WaterFlowSectionOption_SetItemCount() 14601 14602``` 14603void OH_ArkUI_WaterFlowSectionOption_SetItemCount (ArkUI_WaterFlowSectionOption * option, int32_t index, int32_t itemCount ) 14604``` 14605**Description** 14606 14607Sets the number of items in a water flow section. 14608 14609**Since**: 12 14610 14611**Parameters** 14612 14613| Name| Description| 14614| -------- | -------- | 14615| option | Pointer to a water flow section configuration. | 14616| index | Index of the target water flow section. | 14617| itemCount | Number of items in the water flow section. | 14618 14619 14620### OH_ArkUI_WaterFlowSectionOption_SetMargin() 14621 14622``` 14623void OH_ArkUI_WaterFlowSectionOption_SetMargin (ArkUI_WaterFlowSectionOption * option, int32_t index, float marginTop, float marginRight, float marginBottom, float marginLeft ) 14624``` 14625**Description** 14626 14627Sets the margins for the specified water flow section. 14628 14629**Since**: 12 14630 14631**Parameters** 14632 14633| Name| Description| 14634| -------- | -------- | 14635| option | Pointer to a water flow section configuration. | 14636| index | Index of the target water flow section. | 14637| marginTop | Top margin of the water flow section. | 14638| marginRight | Right margin of the water flow section. | 14639| marginBottom | Bottom margin of the water flow section. | 14640| marginLeft | Left margin of the water flow section. | 14641 14642 14643### OH_ArkUI_WaterFlowSectionOption_SetRowGap() 14644 14645``` 14646void OH_ArkUI_WaterFlowSectionOption_SetRowGap (ArkUI_WaterFlowSectionOption * option, int32_t index, float rowGap ) 14647``` 14648**Description** 14649 14650Sets the gap between rows in the specified water flow section. 14651 14652**Since**: 12 14653 14654**Parameters** 14655 14656| Name| Description| 14657| -------- | -------- | 14658| option | Pointer to a water flow section configuration. | 14659| index | Index of the target water flow section. | 14660| rowGap | Gap between rows to set. | 14661 14662 14663### OH_ArkUI_WaterFlowSectionOption_SetSize() 14664 14665``` 14666void OH_ArkUI_WaterFlowSectionOption_SetSize (ArkUI_WaterFlowSectionOption * option, int32_t size ) 14667``` 14668**Description** 14669 14670Sets the array length for a water flow section configuration. 14671 14672**Since**: 12 14673 14674**Parameters** 14675 14676| Name| Description| 14677| -------- | -------- | 14678| option | Pointer to a water flow section configuration. | 14679| size | Size of the array. | 14680
