1# ArkUI_NativeModule 2 3 4## Overview 5 6Provides drag and drop APIs of ArkUI on the native side. 7 8Provides the APIs of ArkUI to register gesture callbacks on the native side. 9 10Provides animation callbacks of ArkUI on the native side. 11 12Provides UI capabilities of ArkUI on the native side, such as UI component creation and destruction, tree node operations, attribute setting, and event listening. 13 14**Since**: 12 15 16 17## Summary 18 19 20### Files 21 22| Name| Description| 23| -------- | -------- | 24| [drag_and_drop.h](drag__and__drop_8h.md) | Declares the APIs of **NativeDrag**.<br> **Library**: libace_ndk.z.so| 25| [drawable_descriptor.h](drawable__descriptor_8h.md) | Declares the APIs of **NativeDrawableDescriptor**.<br> **Library**: libace_ndk.z.so| 26| [native_animate.h](native__animate_8h.md) | Declares a set of animation APIs of ArkUI on the native side.<br> **Library**: libace_ndk.z.so| 27| [native_dialog.h](native__dialog_8h.md) | Declares a set of custom dialog box APIs of ArkUI on the native side.<br> **Library**: libace_ndk.z.so| 28| [native_gesture.h](native__gesture_8h.md) | Declares the APIs of **NativeGesture**.<br> **Library**: libace_ndk.z.so| 29| [native_interface.h](native__interface_8h.md) | Declares a unified entry for the native module APIs.<br> **Library**: libace_ndk.z.so| 30| [native_node.h](native__node_8h.md) | Declares the APIs of **NativeNode**.<br> **Library**: libace_ndk.z.so| 31| [native_node_napi.h](native__node__napi_8h.md) | Declares the functions used to convert FrameNodes on the ArkTS side into NodeHandles.<br> **Library**: libace_ndk.z.so| 32| [native_type.h](native__type_8h.md) | Defines the common types for the native module.<br> **Library**: libace_ndk.z.so| 33| [styled_string.h](styled__string_8h.md) | Declares styled string APIs of ArkUI on the native side.<br> **Library**: libace_ndk.z.so| 34 35 36### Structs 37 38| Name| Description| 39| -------- | -------- | 40| struct [ArkUI_ExpectedFrameRateRange](_ark_u_i___expected_frame_rate_range.md) | Defines a struct for the expected frame rate range of the animation. | 41| struct [ArkUI_AnimateCompleteCallback](_ark_u_i___animate_complete_callback.md) | Defines a struct for the callback type for when the animation playback is complete. | 42| 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. | 43| 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. | 44| struct [ArkUI_NativeGestureAPI_1](_ark_u_i___native_gesture_a_p_i__1.md) | Defines a struct for the gesture APIs. | 45| struct [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) | Defines the general input parameter structure of the **setAttribute** function. | 46| struct [ArkUI_NodeComponentEvent](_ark_u_i___node_component_event.md) | Defines a struct for the parameter type of the component callback event. | 47| struct [ArkUI_StringAsyncEvent](_ark_u_i___string_async_event.md) | Defines the string type parameter used by the component callback event. | 48| 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. | 49| struct [ArkUI_ContextCallback](_ark_u_i___context_callback.md) | Defines event callback. | 50| union [ArkUI_NumberValue](union_ark_u_i___number_value.md) | Provides the number types of ArkUI in the native code. | 51| 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. | 52| 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. | 53| struct [ArkUI_ColorStop](_ark_u_i___color_stop.md) | Defines a gradient color stop. | 54| struct [ArkUI_Rect](_ark_u_i___rect.md) | Defines a mask area. | 55| struct [ArkUI_IntSize](_ark_u_i___int_size.md) | Describes the width and height of a component. | 56| struct [ArkUI_IntOffset](_ark_u_i___int_offset.md) | Describes the position of a component. | 57| struct [ArkUI_Margin](_ark_u_i___margin.md) | Describes the margins of a component. | 58| struct [ArkUI_TranslationOptions](_ark_u_i___translation_options.md) | Defines the translation options for component transition. | 59| struct [ArkUI_ScaleOptions](_ark_u_i___scale_options.md) | Defines the scaling options for component transition. | 60| struct [ArkUI_RotationOptions](_ark_u_i___rotation_options.md) | Defines the rotation options for component transition. | 61 62 63### Macros 64 65| Name| Description| 66| -------- | -------- | 67| [OH_ArkUI_GetModuleInterface](#oh_arkui_getmoduleinterface)(nativeAPIVariantKind, structType, structPtr) | Obtains the macro function corresponding to a struct pointer based on the struct type. | 68| **MAX_NODE_SCOPE_NUM** | 1000 | 69| **MAX_COMPONENT_EVENT_ARG_NUM** | 12 | 70 71 72### Types 73 74| Name| Description| 75| -------- | -------- | 76| typedef struct [ArkUI_NodeEvent](#arkui_nodeevent-12) [ArkUI_NodeEvent](#arkui_nodeevent-12) | Defines a struct for a component event. | 77| typedef struct [ArkUI_Context](#arkui_context) [ArkUI_Context](#arkui_context) | Defines a struct for a UI context object. | 78| typedef struct [ArkUI_Context](#arkui_context) \* [ArkUI_ContextHandle](#arkui_contexthandle-12) | Defines a struct for the handle to the ArkUI native UI context. | 79| typedef struct [ArkUI_DragEvent](#arkui_dragevent) [ArkUI_DragEvent](#arkui_dragevent) | Defines a struct for a drag event. | 80| typedef struct [ArkUI_DragPreviewOption](#arkui_dragpreviewoption) [ArkUI_DragPreviewOption](#arkui_dragpreviewoption) | Defines a struct for custom drag preview options. | 81| typedef struct [ArkUI_DragAction](#arkui_dragaction) [ArkUI_DragAction](#arkui_dragaction) | Defines a struct for a drag action. | 82| typedef struct [ArkUI_DragAndDropInfo](#arkui_draganddropinfo) [ArkUI_DragAndDropInfo](#arkui_draganddropinfo) | Defines a struct for drag and drop information returned through a drag status listener. | 83| typedef struct [OH_UdmfData](#oh_udmfdata) [OH_UdmfData](#oh_udmfdata) | Defines a struct for UDMF unified data. | 84| 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. | 85| typedef struct [ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) [ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) | Defines a struct for the **DrawableDescriptor** object. | 86| typedef struct [OH_PixelmapNative](#oh_pixelmapnative) \* [OH_PixelmapNativeHandle](#oh_pixelmapnativehandle) | Defines a struct for the pointer to an **OH_PixelmapNative** object. | 87| typedef struct [ArkUI_AnimateOption](#arkui_animateoption) [ArkUI_AnimateOption](#arkui_animateoption) | Defines a struct for the animation configuration. | 88| typedef struct ArkUI_Curve \* [ArkUI_CurveHandle](#arkui_curvehandle) | Defines a struct for the pointer to an interpolation curve. | 89| typedef struct [ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) [ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) | Defines a struct for the keyframe animation parameter object. | 90| typedef struct [ArkUI_AnimatorOption](#arkui_animatoroption) [ArkUI_AnimatorOption](#arkui_animatoroption) | Defines the animator parameter object. | 91| typedef struct ArkUI_Animator \* [ArkUI_AnimatorHandle](#arkui_animatorhandle) | Defines a struct for the pointer to an animator object. | 92| typedef struct [ArkUI_TransitionEffect](#arkui_transitioneffect) [ArkUI_TransitionEffect](#arkui_transitioneffect) | Defines a struct for the transition effect. | 93| typedef bool(\* [ArkUI_OnWillDismissEvent](#arkui_onwilldismissevent)) (int32_t reason) | Defines a pointer to the callback invoked when the dialog box is closed. | 94| typedef struct [ArkUI_DialogDismissEvent](#arkui_dialogdismissevent) [ArkUI_DialogDismissEvent](#arkui_dialogdismissevent) | Defines a struct for a dialog box dismiss event. | 95| typedef uint32_t [ArkUI_GestureEventActionTypeMask](#arkui_gestureeventactiontypemask) | Defines a set of gesture event types. | 96| typedef uint32_t [ArkUI_GestureDirectionMask](#arkui_gesturedirectionmask) | Defines a set of gesture directions. | 97| typedef ArkUI_GestureRecognizer \* [ArkUI_GestureRecognizerHandle](#arkui_gesturerecognizerhandle) | Defines the gesture recognizer handle. | 98| typedef [ArkUI_GestureRecognizerHandle](#arkui_gesturerecognizerhandle) \* [ArkUI_GestureRecognizerHandleArray](#arkui_gesturerecognizerhandlearray) | Defines the gesture recognizer handle array. | 99| 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. | 100| typedef struct [ArkUI_ParallelInnerGestureEvent](#arkui_parallelinnergestureevent) [ArkUI_ParallelInnerGestureEvent](#arkui_parallelinnergestureevent) | Defines a parallel internal gesture event. | 101| typedef void(\* [ArkUI_GestureRecognizerDestructNotifyCallback](#arkui_gesturerecognizerdestructnotifycallback)) (ArkUI_GestureRecognizer \*recognizer, void \*userData) | Defines a callback function for notifying gesture recognizer destruction. | 102| typedef struct [ArkUI_NodeEvent](#arkui_nodeevent-12) [ArkUI_NodeEvent](#arkui_nodeevent-12) | Defines the common structure of a component event. | 103| typedef struct [ArkUI_NodeCustomEvent](#arkui_nodecustomevent) [ArkUI_NodeCustomEvent](#arkui_nodecustomevent) | Defines the common structure of a custom component event. | 104| typedef struct ArkUI_NodeAdapter \* [ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) | Defines the component adapter, which is used for lazy loading of elements of scrollable components. | 105| typedef struct [ArkUI_NodeAdapterEvent](#arkui_nodeadapterevent) [ArkUI_NodeAdapterEvent](#arkui_nodeadapterevent) | Defines the component adapter event. | 106| typedef struct [ArkUI_NodeContentEvent](#arkui_nodecontentevent) [ArkUI_NodeContentEvent](#arkui_nodecontentevent) | Defines the common structure type of a NodeContent event. | 107| typedef void(\* [ArkUI_NodeContentCallback](#arkui_nodecontentcallback)) ([ArkUI_NodeContentEvent](#arkui_nodecontentevent) \*event) | Defines the callback for the NodeContent event. | 108| typedef struct [ArkUI_LayoutConstraint](#arkui_layoutconstraint) [ArkUI_LayoutConstraint](#arkui_layoutconstraint) | Defines the size constraints of a component during component layout. | 109| typedef struct [ArkUI_DrawContext](#arkui_drawcontext) [ArkUI_DrawContext](#arkui_drawcontext) | Defines the component drawing context. | 110| typedef struct ArkUI_Node \* [ArkUI_NodeHandle](#arkui_nodehandle) | Defines the pointer to the ArkUI native component object. | 111| typedef struct ArkUI_NativeDialog \* [ArkUI_NativeDialogHandle](#arkui_nativedialoghandle) | Defines the handle to the custom dialog box controller of ArkUI on the native side. | 112| typedef struct [ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) [ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) | Defines the water flow section configuration. | 113| typedef struct [ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) [ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) | Defines the item configuration for **ListItemSwipeActionOption**. | 114| typedef struct [ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption) [ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption) | Defines the configuration for **ListItemSwipeActionOption**. | 115| typedef struct [ArkUI_Context](#arkui_context) \* [ArkUI_ContextHandle](#arkui_contexthandle-12) | Defines the handle to the ArkUI native UI context. | 116| typedef struct ArkUI_NodeContent \* [ArkUI_NodeContentHandle](#arkui_nodecontenthandle) | Defines the handle to the ArkUI NodeContent instance on the native side. | 117| typedef struct [ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) [ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) | Defines the alignment rule in the relative container. | 118| typedef struct [ArkUI_GuidelineOption](#arkui_guidelineoption) [ArkUI_GuidelineOption](#arkui_guidelineoption) | Defines the ID, direction, and position of a guideline. | 119| typedef struct [ArkUI_BarrierOption](#arkui_barrieroption) [ArkUI_BarrierOption](#arkui_barrieroption) | Defines the ID, direction, and referenced component of a barrier. | 120| typedef struct [ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) [ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) | Defines the image frame information. | 121| typedef struct [ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) [ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) | Defines the **ChildrenMainSize** information of the **List** component. | 122| typedef struct [ArkUI_AccessibilityState](#arkui_accessibilitystate) [ArkUI_AccessibilityState](#arkui_accessibilitystate) | Defines a struct for the component accessibility state. | 123| typedef struct [ArkUI_AccessibilityValue](#arkui_accessibilityvalue) [ArkUI_AccessibilityValue](#arkui_accessibilityvalue) | Defines a struct for the component accessibility value. | 124| typedef struct [ArkUI_SystemFontStyleEvent](#arkui_systemfontstyleevent) [ArkUI_SystemFontStyleEvent](#arkui_systemfontstyleevent) | Defines a struct for the system font style event. | 125| typedef struct [ArkUI_CustomSpanMeasureInfo](#arkui_customspanmeasureinfo) [ArkUI_CustomSpanMeasureInfo](#arkui_customspanmeasureinfo) | Defines a struct for the measurement information of a custom span. | 126| typedef struct [ArkUI_CustomSpanMetrics](#arkui_customspanmetrics) [ArkUI_CustomSpanMetrics](#arkui_customspanmetrics) | Defines a struct for the measurement metrics of a custom span. | 127| typedef struct [ArkUI_CustomSpanDrawInfo](#arkui_customspandrawinfo) [ArkUI_CustomSpanDrawInfo](#arkui_customspandrawinfo) | Defines a struct for the drawing information of a custom span. | 128| typedef struct [ArkUI_SwiperIndicator](#arkui_swiperindicator) [ArkUI_SwiperIndicator](#arkui_swiperindicator) | Defines the navigation point indicator style of the **Swiper** component. | 129| 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. | 130| typedef struct [ArkUI_StyledString](#arkui_styledstring) [ArkUI_StyledString](#arkui_styledstring) | Defines a struct for the styled string object supported by the text component. | 131 132 133### Enums 134 135| Name| Description| 136| -------- | -------- | 137| [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. | 138| [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. | 139| [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. | 140| [ArkUI_DragPreviewScaleMode](#arkui_dragpreviewscalemode) { ARKUI_DRAG_PREVIEW_SCALE_AUTO, ARKUI_DRAG_PREVIEW_SCALE_DISABLED } | Defines an enum for drag preview scale modes. | 141| [ArkUI_DragStatus](#arkui_dragstatus) { ArkUI_DRAG_STATUS_UNKNOWN, ArkUI_DRAG_STATUS_STARTED, ArkUI_DRAG_STATUS_ENDED } | Enumerates dragging states. | 142| [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. | 143| [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. | 144| [ArkUI_GesturePriority](#arkui_gesturepriority) { NORMAL = 0, PRIORITY = 1, PARALLEL = 2 } | Enumerates gesture event modes. | 145| [ArkUI_GroupGestureMode](#arkui_groupgesturemode) { SEQUENTIAL_GROUP = 0, PARALLEL_GROUP = 1, EXCLUSIVE_GROUP = 2 } | Enumerates gesture group modes. | 146| [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. | 147| [ArkUI_GestureMask](#arkui_gesturemask) { NORMAL_GESTURE_MASK = 0, IGNORE_INTERNAL_GESTURE_MASK } | Enumerates gesture masking modes. | 148| [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. | 149| [ArkUI_GestureInterruptResult](#arkui_gestureinterruptresult) { GESTURE_INTERRUPT_RESULT_CONTINUE = 0, GESTURE_INTERRUPT_RESULT_REJECT } | Enumerates gesture interruption results. | 150| [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. | 151| [ArkUI_NativeAPIVariantKind](#arkui_nativeapivariantkind) { ARKUI_NATIVE_NODE, ARKUI_NATIVE_DIALOG, ARKUI_NATIVE_GESTURE, ARKUI_NATIVE_ANIMATE } | Defines the native API types. | 152| [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_STACK = MAX_NODE_SCOPE_NUM, ARKUI_NODE_SWIPER, ARKUI_NODE_SCROLL, ARKUI_NODE_LIST,<br>ARKUI_NODE_LIST_ITEM, ARKUI_NODE_LIST_ITEM_GROUP, ARKUI_NODE_COLUMN, ARKUI_NODE_ROW,<br>ARKUI_NODE_FLEX, ARKUI_NODE_REFRESH, ARKUI_NODE_WATER_FLOW, ARKUI_NODE_FLOW_ITEM,<br>ARKUI_NODE_RELATIVE_CONTAINER, ARKUI_NODE_GRID, ARKUI_NODE_GRID_ITEM, ARKUI_NODE_CUSTOM_SPAN<br>} | Enumerates ArkUI component types that can be created on the native side. | 153| [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,<br>NODE_CLICK_DISTANCE = 96, NODE_TEXT_CONTENT = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_TEXT, NODE_FONT_COLOR, NODE_FONT_SIZE,<br>NODE_FONT_STYLE, NODE_FONT_WEIGHT, NODE_TEXT_LINE_HEIGHT, NODE_TEXT_DECORATION,<br>NODE_TEXT_CASE, NODE_TEXT_LETTER_SPACING, NODE_TEXT_MAX_LINES, NODE_TEXT_ALIGN,<br>NODE_TEXT_OVERFLOW, NODE_FONT_FAMILY, NODE_TEXT_COPY_OPTION, NODE_TEXT_BASELINE_OFFSET,<br>NODE_TEXT_TEXT_SHADOW, NODE_TEXT_MIN_FONT_SIZE, NODE_TEXT_MAX_FONT_SIZE, NODE_TEXT_FONT,<br>NODE_TEXT_HEIGHT_ADAPTIVE_POLICY, NODE_TEXT_INDENT, NODE_TEXT_WORD_BREAK, NODE_TEXT_ELLIPSIS_MODE,<br>NODE_TEXT_LINE_SPACING, NODE_FONT_FEATURE, NODE_TEXT_ENABLE_DATA_DETECTOR, NODE_TEXT_ENABLE_DATA_DETECTOR_CONFIG,<br>NODE_TEXT_SELECTED_BACKGROUND_COLOR, NODE_TEXT_CONTENT_WITH_STYLED_STRING, NODE_TEXT_HALF_LEADING = 1029, NODE_SPAN_CONTENT = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_SPAN,<br>NODE_SPAN_TEXT_BACKGROUND_STYLE, NODE_SPAN_BASELINE_OFFSET, NODE_IMAGE_SPAN_SRC = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_IMAGE_SPAN, NODE_IMAGE_SPAN_VERTICAL_ALIGNMENT,<br>NODE_IMAGE_SPAN_ALT, NODE_IMAGE_SPAN_BASELINE_OFFSET = 3003, NODE_IMAGE_SRC = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_IMAGE, NODE_IMAGE_OBJECT_FIT,<br>NODE_IMAGE_INTERPOLATION, NODE_IMAGE_OBJECT_REPEAT, NODE_IMAGE_COLOR_FILTER, NODE_IMAGE_AUTO_RESIZE,<br>NODE_IMAGE_ALT, NODE_IMAGE_DRAGGABLE, NODE_IMAGE_RENDER_MODE, NODE_IMAGE_FIT_ORIGINAL_SIZE,<br>NODE_IMAGE_FILL_COLOR, NODE_IMAGE_RESIZABLE, NODE_TOGGLE_SELECTED_COLOR = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_TOGGLE, NODE_TOGGLE_SWITCH_POINT_COLOR,<br>NODE_TOGGLE_VALUE, NODE_TOGGLE_UNSELECTED_COLOR, NODE_LOADING_PROGRESS_COLOR = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_LOADING_PROGRESS, NODE_LOADING_PROGRESS_ENABLE_LOADING,<br>NODE_TEXT_INPUT_PLACEHOLDER = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_TEXT_INPUT, NODE_TEXT_INPUT_TEXT, NODE_TEXT_INPUT_CARET_COLOR, NODE_TEXT_INPUT_CARET_STYLE,<br>NODE_TEXT_INPUT_SHOW_UNDERLINE, NODE_TEXT_INPUT_MAX_LENGTH, NODE_TEXT_INPUT_ENTER_KEY_TYPE, NODE_TEXT_INPUT_PLACEHOLDER_COLOR,<br>NODE_TEXT_INPUT_PLACEHOLDER_FONT, NODE_TEXT_INPUT_ENABLE_KEYBOARD_ON_FOCUS, NODE_TEXT_INPUT_TYPE, NODE_TEXT_INPUT_SELECTED_BACKGROUND_COLOR,<br>NODE_TEXT_INPUT_SHOW_PASSWORD_ICON, NODE_TEXT_INPUT_EDITING, NODE_TEXT_INPUT_CANCEL_BUTTON, NODE_TEXT_INPUT_TEXT_SELECTION,<br>NODE_TEXT_INPUT_UNDERLINE_COLOR, NODE_TEXT_INPUT_ENABLE_AUTO_FILL, NODE_TEXT_INPUT_CONTENT_TYPE, NODE_TEXT_INPUT_PASSWORD_RULES,<br>NODE_TEXT_INPUT_SELECT_ALL, NODE_TEXT_INPUT_INPUT_FILTER, NODE_TEXT_INPUT_STYLE, NODE_TEXT_INPUT_CARET_OFFSET,<br>NODE_TEXT_INPUT_CONTENT_RECT, NODE_TEXT_INPUT_CONTENT_LINE_COUNT, NODE_TEXT_INPUT_SELECTION_MENU_HIDDEN, NODE_TEXT_INPUT_BLUR_ON_SUBMIT,<br>NODE_TEXT_INPUT_CUSTOM_KEYBOARD, NODE_TEXT_INPUT_WORD_BREAK, NODE_TEXT_INPUT_NUMBER_OF_LINES, NODE_TEXT_INPUT_SHOW_KEYBOARD_ON_FOCUS,<br>NODE_TEXT_AREA_PLACEHOLDER = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_TEXT_AREA, NODE_TEXT_AREA_TEXT, NODE_TEXT_AREA_MAX_LENGTH, NODE_TEXT_AREA_PLACEHOLDER_COLOR,<br>NODE_TEXT_AREA_PLACEHOLDER_FONT, NODE_TEXT_AREA_CARET_COLOR, NODE_TEXT_AREA_EDITING, NODE_TEXT_AREA_TYPE,<br>NODE_TEXT_AREA_SHOW_COUNTER, NODE_TEXT_AREA_SELECTION_MENU_HIDDEN, NODE_TEXT_AREA_BLUR_ON_SUBMIT, NODE_TEXT_AREA_INPUT_FILTER,<br>NODE_TEXT_AREA_SELECTED_BACKGROUND_COLOR, NODE_TEXT_AREA_ENTER_KEY_TYPE, NODE_TEXT_AREA_ENABLE_KEYBOARD_ON_FOCUS, NODE_TEXT_AREA_CARET_OFFSET,<br>NODE_TEXT_AREA_CONTENT_RECT, NODE_TEXT_AREA_CONTENT_LINE_COUNT, NODE_TEXT_AREA_TEXT_SELECTION, NODE_TEXT_AREA_ENABLE_AUTO_FILL,<br>NODE_TEXT_AREA_CONTENT_TYPE, NODE_TEXT_AREA_NUMBER_OF_LINES, NODE_TEXT_AREA_SHOW_KEYBOARD_ON_FOCUS, NODE_BUTTON_LABEL = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_BUTTON,<br>NODE_BUTTON_TYPE, NODE_PROGRESS_VALUE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_PROGRESS, NODE_PROGRESS_TOTAL, NODE_PROGRESS_COLOR,<br>NODE_PROGRESS_TYPE, NODE_CHECKBOX_SELECT = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_CHECKBOX, NODE_CHECKBOX_SELECT_COLOR, NODE_CHECKBOX_UNSELECT_COLOR,<br>NODE_CHECKBOX_MARK, NODE_CHECKBOX_SHAPE, NODE_XCOMPONENT_ID = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_XCOMPONENT, NODE_XCOMPONENT_TYPE,<br>NODE_XCOMPONENT_SURFACE_SIZE, NODE_DATE_PICKER_LUNAR = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_DATE_PICKER, NODE_DATE_PICKER_START, NODE_DATE_PICKER_END,<br>NODE_DATE_PICKER_SELECTED, NODE_DATE_PICKER_DISAPPEAR_TEXT_STYLE, NODE_DATE_PICKER_TEXT_STYLE, NODE_DATE_PICKER_SELECTED_TEXT_STYLE,<br>NODE_TIME_PICKER_SELECTED = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_TIME_PICKER, NODE_TIME_PICKER_USE_MILITARY_TIME, NODE_TIME_PICKER_DISAPPEAR_TEXT_STYLE, NODE_TIME_PICKER_TEXT_STYLE,<br>NODE_TIME_PICKER_SELECTED_TEXT_STYLE, NODE_TEXT_PICKER_OPTION_RANGE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_TEXT_PICKER, NODE_TEXT_PICKER_OPTION_SELECTED, NODE_TEXT_PICKER_OPTION_VALUE,<br>NODE_TEXT_PICKER_DISAPPEAR_TEXT_STYLE, NODE_TEXT_PICKER_TEXT_STYLE, NODE_TEXT_PICKER_SELECTED_TEXT_STYLE, NODE_TEXT_PICKER_SELECTED_INDEX,<br>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, NODE_CALENDAR_PICKER_SELECTED_DATE,<br>NODE_CALENDAR_PICKER_EDGE_ALIGNMENT, NODE_CALENDAR_PICKER_TEXT_STYLE, NODE_SLIDER_BLOCK_COLOR = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_SLIDER, NODE_SLIDER_TRACK_COLOR,<br>NODE_SLIDER_SELECTED_COLOR, NODE_SLIDER_SHOW_STEPS, NODE_SLIDER_BLOCK_STYLE, NODE_SLIDER_VALUE,<br>NODE_SLIDER_MIN_VALUE, NODE_SLIDER_MAX_VALUE, NODE_SLIDER_STEP, NODE_SLIDER_DIRECTION,<br>NODE_SLIDER_REVERSE, NODE_SLIDER_STYLE, NODE_SLIDER_TRACK_THICKNESS, NODE_RADIO_CHECKED = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_RADIO,<br>NODE_RADIO_STYLE, NODE_RADIO_VALUE, NODE_RADIO_GROUP, NODE_STACK_ALIGN_CONTENT = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_STACK,<br>NODE_SCROLL_BAR_DISPLAY_MODE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_SCROLL, NODE_SCROLL_BAR_WIDTH, NODE_SCROLL_BAR_COLOR, NODE_SCROLL_SCROLL_DIRECTION,<br>NODE_SCROLL_EDGE_EFFECT, NODE_SCROLL_ENABLE_SCROLL_INTERACTION, NODE_SCROLL_FRICTION, NODE_SCROLL_SNAP,<br>NODE_SCROLL_NESTED_SCROLL, NODE_SCROLL_OFFSET, NODE_SCROLL_EDGE, NODE_SCROLL_ENABLE_PAGING,<br>NODE_SCROLL_PAGE, NODE_SCROLL_BY, NODE_SCROLL_FLING, NODE_SCROLL_FADING_EDGE,<br>NODE_LIST_DIRECTION = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_LIST, NODE_LIST_STICKY, NODE_LIST_SPACE, NODE_LIST_NODE_ADAPTER,<br>NODE_LIST_CACHED_COUNT, NODE_LIST_SCROLL_TO_INDEX, NODE_LIST_ALIGN_LIST_ITEM, NODE_LIST_CHILDREN_MAIN_SIZE = 1003007,<br>NODE_LIST_INITIAL_INDEX = 1003008, NODE_LIST_DIVIDER = 1003009, NODE_SWIPER_LOOP = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_SWIPER, NODE_SWIPER_AUTO_PLAY,<br>NODE_SWIPER_SHOW_INDICATOR, NODE_SWIPER_INTERVAL, NODE_SWIPER_VERTICAL, NODE_SWIPER_DURATION,<br>NODE_SWIPER_CURVE, NODE_SWIPER_ITEM_SPACE, NODE_SWIPER_INDEX, NODE_SWIPER_DISPLAY_COUNT,<br>NODE_SWIPER_DISABLE_SWIPE, NODE_SWIPER_SHOW_DISPLAY_ARROW, NODE_SWIPER_EDGE_EFFECT_MODE, NODE_SWIPER_NODE_ADAPTER,<br>NODE_SWIPER_CACHED_COUNT, NODE_SWIPER_PREV_MARGIN, NODE_SWIPER_NEXT_MARGIN, NODE_SWIPER_INDICATOR,<br>NODE_SWIPER_NESTED_SCROLL, NODE_SWIPER_SWIPE_TO_INDEX, NODE_SWIPER_INDICATOR_INTERACTIVE, NODE_LIST_ITEM_SWIPE_ACTION = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_LIST_ITEM,<br>NODE_LIST_ITEM_GROUP_SET_HEADER = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_LIST_ITEM_GROUP, NODE_LIST_ITEM_GROUP_SET_FOOTER, NODE_LIST_ITEM_GROUP_SET_DIVIDER, NODE_LIST_ITEM_GROUP_CHILDREN_MAIN_SIZE = 1005003,<br>NODE_COLUMN_ALIGN_ITEMS = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_COLUMN, NODE_COLUMN_JUSTIFY_CONTENT, NODE_ROW_ALIGN_ITEMS = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_ROW, NODE_ROW_JUSTIFY_CONTENT,<br>NODE_FLEX_OPTION = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_FLEX, NODE_REFRESH_REFRESHING = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_REFRESH, NODE_REFRESH_CONTENT, NODE_REFRESH_PULL_DOWN_RATIO = 1009002,<br>NODE_REFRESH_OFFSET = 1009003, NODE_REFRESH_PULL_TO_REFRESH = 1009004, NODE_WATER_FLOW_LAYOUT_DIRECTION = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_WATER_FLOW, NODE_WATER_FLOW_COLUMN_TEMPLATE,<br>NODE_WATER_FLOW_ROW_TEMPLATE, NODE_WATER_FLOW_COLUMN_GAP, NODE_WATER_FLOW_ROW_GAP, NODE_WATER_FLOW_SECTION_OPTION,<br>NODE_WATER_FLOW_NODE_ADAPTER, NODE_WATER_FLOW_CACHED_COUNT, NODE_WATER_FLOW_FOOTER, NODE_WATER_FLOW_SCROLL_TO_INDEX,<br>NODE_WATER_FLOW_ITEM_CONSTRAINT_SIZE, 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,<br>NODE_GRID_ROW_TEMPLATE, NODE_GRID_COLUMN_GAP, NODE_GRID_ROW_GAP, NODE_GRID_NODE_ADAPTER,<br>NODE_GRID_CACHED_COUNT, NODE_IMAGE_ANIMATOR_IMAGES = ARKUI_NODE_IMAGE_ANIMATOR \* MAX_NODE_SCOPE_NUM, NODE_IMAGE_ANIMATOR_STATE, NODE_IMAGE_ANIMATOR_DURATION,<br>NODE_IMAGE_ANIMATOR_REVERSE, 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. | 154| [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_TEXT_ON_DETECT_RESULT_UPDATE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_TEXT, NODE_IMAGE_ON_COMPLETE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_IMAGE, NODE_IMAGE_ON_ERROR,<br>NODE_IMAGE_ON_SVG_PLAY_FINISH, NODE_IMAGE_ON_DOWNLOAD_PROGRESS, NODE_TOGGLE_ON_CHANGE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_TOGGLE, NODE_TEXT_INPUT_ON_CHANGE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_TEXT_INPUT,<br>NODE_TEXT_INPUT_ON_SUBMIT, NODE_TEXT_INPUT_ON_CUT, NODE_TEXT_INPUT_ON_PASTE, NODE_TEXT_INPUT_ON_TEXT_SELECTION_CHANGE,<br>NODE_TEXT_INPUT_ON_EDIT_CHANGE, NODE_TEXT_INPUT_ON_INPUT_FILTER_ERROR, NODE_TEXT_INPUT_ON_CONTENT_SCROLL, NODE_TEXT_INPUT_ON_CONTENT_SIZE_CHANGE,<br>NODE_TEXT_INPUT_ON_WILL_INSERT = 7009, NODE_TEXT_INPUT_ON_DID_INSERT = 7010, NODE_TEXT_INPUT_ON_WILL_DELETE = 7011, NODE_TEXT_INPUT_ON_DID_DELETE = 7012,<br>NODE_TEXT_AREA_ON_CHANGE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_TEXT_AREA, NODE_TEXT_AREA_ON_PASTE, NODE_TEXT_AREA_ON_TEXT_SELECTION_CHANGE, NODE_TEXT_AREA_ON_EDIT_CHANGE,<br>NODE_TEXT_AREA_ON_SUBMIT, NODE_TEXT_AREA_ON_INPUT_FILTER_ERROR, NODE_TEXT_AREA_ON_CONTENT_SCROLL, NODE_TEXT_AREA_ON_CONTENT_SIZE_CHANGE,<br>NODE_TEXT_AREA_ON_WILL_INSERT = 8008, NODE_TEXT_AREA_ON_DID_INSERT = 8009, NODE_TEXT_AREA_ON_WILL_DELETE = 8010, NODE_TEXT_AREA_ON_DID_DELETE = 8011,<br>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, 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,<br>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, 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,<br>NODE_IMAGE_ANIMATOR_EVENT_ON_PAUSE, NODE_IMAGE_ANIMATOR_EVENT_ON_REPEAT, NODE_IMAGE_ANIMATOR_EVENT_ON_CANCEL, NODE_IMAGE_ANIMATOR_EVENT_ON_FINISH,<br>NODE_SWIPER_EVENT_ON_CHANGE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_SWIPER, NODE_SWIPER_EVENT_ON_ANIMATION_START, NODE_SWIPER_EVENT_ON_ANIMATION_END, NODE_SWIPER_EVENT_ON_GESTURE_SWIPE,<br>NODE_SWIPER_EVENT_ON_CONTENT_DID_SCROLL, NODE_SCROLL_EVENT_ON_SCROLL = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_SCROLL, NODE_SCROLL_EVENT_ON_SCROLL_FRAME_BEGIN, NODE_SCROLL_EVENT_ON_WILL_SCROLL,<br>NODE_SCROLL_EVENT_ON_DID_SCROLL, NODE_SCROLL_EVENT_ON_SCROLL_START, NODE_SCROLL_EVENT_ON_SCROLL_STOP, NODE_SCROLL_EVENT_ON_SCROLL_EDGE,<br>NODE_SCROLL_EVENT_ON_REACH_START, NODE_SCROLL_EVENT_ON_REACH_END, NODE_LIST_ON_SCROLL_INDEX = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_LIST, NODE_LIST_ON_WILL_SCROLL,<br>NODE_LIST_ON_DID_SCROLL, NODE_REFRESH_STATE_CHANGE = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_REFRESH, NODE_REFRESH_ON_REFRESH, NODE_REFRESH_ON_OFFSET_CHANGE,<br>NODE_ON_WILL_SCROLL = MAX_NODE_SCOPE_NUM \* ARKUI_NODE_WATER_FLOW, NODE_WATER_FLOW_ON_DID_SCROLL, NODE_WATER_FLOW_ON_SCROLL_INDEX<br>} | Enumerates the event types supported by the NativeNode component. | 155| [ArkUI_NodeDirtyFlag](#arkui_nodedirtyflag) { NODE_NEED_MEASURE = 1, NODE_NEED_LAYOUT, NODE_NEED_RENDER } | Enumerates the dirty area flags passed in the **::markDirty** API. | 156| [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. | 157| [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. | 158| [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. | 159| [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. | 160| [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. | 161| [ArkUI_FontStyle](#arkui_fontstyle) { ARKUI_FONT_STYLE_NORMAL = 0, ARKUI_FONT_STYLE_ITALIC } | Enumerates the font styles. | 162| [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. | 163| [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. | 164| [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. | 165| [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. | 166| [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. | 167| [ArkUI_CancelButtonStyle](#arkui_cancelbuttonstyle) { ARKUI_CANCELBUTTON_STYLE_CONSTANT = 0, ARKUI_CANCELBUTTON_STYLE_INVISIBLE, ARKUI_CANCELBUTTON_STYLE_INPUT } | Enumerates the styles of the Cancel button. | 168| [ArkUI_XComponentType](#arkui_xcomponenttype) { ARKUI_XCOMPONENT_TYPE_SURFACE = 0, ARKUI_XCOMPONENT_TYPE_TEXTURE = 2 } |Enumerates the types of the XComponent type. | 169| [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. | 170| [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. | 171| [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. | 172| [ArkUI_TextCase](#arkui_textcase) { ARKUI_TEXT_CASE_NORMAL = 0, ARKUI_TEXT_CASE_LOWER, ARKUI_TEXT_CASE_UPPER } | Enumerates the text cases. | 173| [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. | 174| [ArkUI_ShadowType](#arkui_shadowtype) { ARKUI_SHADOW_TYPE_COLOR = 0, ARKUI_SHADOW_TYPE_BLUR } | Enumerates the shadow types. | 175| [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. | 176| [ArkUI_AccessibilityCheckedState](#arkui_accessibilitycheckedstate) { ARKUI_ACCESSIBILITY_UNCHECKED = 0, ARKUI_ACCESSIBILITY_CHECKED } | Enumerates the accessibility check box states. | 177| [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. | 178| [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. | 179| [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. | 180| [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. | 181| [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. | 182| [ArkUI_Axis](#arkui_axis) { ARKUI_AXIS_VERTICAL = 0, ARKUI_AXIS_HORIZONTAL } | Enumerates the scroll directions. | 183| [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. | 184| [ArkUI_BorderStyle](#arkui_borderstyle) { ARKUI_BORDER_STYLE_SOLID = 0, ARKUI_BORDER_STYLE_DASHED, ARKUI_BORDER_STYLE_DOTTED } | Enumerates the border styles. | 185| [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. | 186| [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. | 187| [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. | 188| [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. | 189| [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. | 190| [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. | 191| [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. | 192| [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. | 193| [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. | 194| [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. | 195| [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. | 196| [ArkUI_ScrollState](#arkui_scrollstate) { ARKUI_SCROLL_STATE_IDLE = 0, ARKUI_SCROLL_STATE_SCROLL, ARKUI_SCROLL_STATE_FLING } | Enumerates the scrolling states. | 197| [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. | 198| [ArkUI_SliderDirection](#arkui_sliderdirection) { ARKUI_SLIDER_DIRECTION_VERTICAL = 0, ARKUI_SLIDER_DIRECTION_HORIZONTAL } | Enumerates the scroll directions of the slider. | 199| [ArkUI_SliderStyle](#arkui_sliderstyle) { ARKUI_SLIDER_STYLE_OUT_SET = 0, ARKUI_SLIDER_STYLE_IN_SET, ARKUI_SLIDER_STYLE_NONE } | Enumerates the slider styles. | 200| [ArkUI_CheckboxShape](#arkui_checkboxshape) { ArkUI_CHECKBOX_SHAPE_CIRCLE = 0, ArkUI_CHECKBOX_SHAPE_ROUNDED_SQUARE } | Enumerates the shapes of the check box. | 201| [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. | 202| [ArkUI_ImageSize](#arkui_imagesize) { ARKUI_IMAGE_SIZE_AUTO = 0, ARKUI_IMAGE_SIZE_COVER, ARKUI_IMAGE_SIZE_CONTAIN } | Defines the image size. | 203| [ArkUI_AdaptiveColor](#arkui_adaptivecolor) { ARKUI_ADAPTIVE_COLOR_DEFAULT = 0, ARKUI_ADAPTIVE_COLOR_AVERAGE } | Enumerates the adaptive color modes. | 204| [ArkUI_ColorMode](#arkui_colormode) { ARKUI_COLOR_MODE_SYSTEM = 0, ARKUI_COLOR_MODE_LIGHT, ARKUI_COLOR_MODE_DARK } | Enumerates the color modes. | 205| [ArkUI_SystemColorMode](#arkui_systemcolormode) { ARKUI_SYSTEM_COLOR_MODE_LIGHT = 0, ARKUI_SYSTEM_COLOR_MODE_DARK } | Enumerates the system color modes. | 206| [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. | 207| [ArkUI_VerticalAlignment](#arkui_verticalalignment) { ARKUI_VERTICAL_ALIGNMENT_TOP = 0, ARKUI_VERTICAL_ALIGNMENT_CENTER, ARKUI_VERTICAL_ALIGNMENT_BOTTOM } | Enumerates the vertical alignment modes. | 208| [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. | 209| [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. | 210| [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. | 211| [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. | 212| [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. | 213| [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. | 214| [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. | 215| [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. | 216| [ArkUI_ColorStrategy](#arkui_colorstrategy) { ARKUI_COLOR_STRATEGY_INVERT = 0, ARKUI_COLOR_STRATEGY_AVERAGE, ARKUI_COLOR_STRATEGY_PRIMARY } | Enumerates the foreground colors. | 217| [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. | 218| [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. | 219| [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. | 220| [ArkUI_Visibility](#arkui_visibility) { ARKUI_VISIBILITY_VISIBLE = 0, ARKUI_VISIBILITY_HIDDEN, ARKUI_VISIBILITY_NONE } | Enumerates the visibility values. | 221| [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. | 222| [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. | 223| [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. | 224| [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. | 225| [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. | 226| [ArkUI_WordBreak](#arkui_wordbreak) { ARKUI_WORD_BREAK_NORMAL = 0, ARKUI_WORD_BREAK_BREAK_ALL, ARKUI_WORD_BREAK_BREAK_WORD } | Enumerates the word break rules. | 227| [ArkUI_EllipsisMode](#arkui_ellipsismode) { ARKUI_ELLIPSIS_MODE_START = 0, ARKUI_ELLIPSIS_MODE_CENTER, ARKUI_ELLIPSIS_MODE_END } | Enumerates the ellipsis positions. | 228| [ArkUI_ImageRenderMode](#arkui_imagerendermode) { ARKUI_IMAGE_RENDER_MODE_ORIGINAL = 0, ARKUI_IMAGE_RENDER_MODE_TEMPLATE } | Enumerates the image rendering modes. | 229| [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. | 230| [ArkUI_FinishCallbackType](#arkui_finishcallbacktype) { ARKUI_FINISH_CALLBACK_REMOVED = 0, ARKUI_FINISH_CALLBACK_LOGICALLY } | Enumerates the animation **onFinish** callback types. | 231| [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. | 232| [ArkUI_BlendApplyType](#arkui_blendapplytype) { BLEND_APPLY_TYPE_FAST = 0, BLEND_APPLY_TYPE_OFFSCREEN } | Defines how the specified blend mode is applied. | 233| [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. | 234| [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. | 235| [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. | 236| [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. | 237| [ArkUI_TextInputStyle](#arkui_textinputstyle) { ARKUI_TEXTINPUT_STYLE_DEFAULT = 0, ARKUI_TEXTINPUT_STYLE_INLINE } | Enumerates the text input styles. | 238| [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. | 239| [ArkUI_ButtonType](#arkui_buttontype) { ARKUI_BUTTON_TYPE_NORMAL = 0, ARKUI_BUTTON_TYPE_CAPSULE, ARKUI_BUTTON_TYPE_CIRCLE } | Enumerates the button types. | 240| [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>} | | 241| [ArkUI_ThemeColorMode](#arkui_themecolormode) { ARKUI_THEME_COLOR_MODE_SYSTEM = 0, ARKUI_THEME_COLOR_MODE_LIGHT, ARKUI_THEME_COLOR_MODE_DARK } | | 242| [ArkUI_SwiperIndicatorType](#arkui_swiperindicatortype) { ARKUI_SWIPER_INDICATOR_TYPE_DOT, ARKUI_SWIPER_INDICATOR_TYPE_DIGIT } | Enumerates the navigation point indicator types of the **Swiper** component. | 243| [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. | 244| [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. | 245| [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. | 246| [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. | 247| [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. | 248| [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. | 249| [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. | 250| [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>} | Defines an enum for the error codes. | 251| [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. | 252| [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. | 253| [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. | 254| [ArkUI_NavDestinationState](#arkui_navdestinationstate) {<br>ARKUI_NAV_DESTINATION_STATE_ON_SHOW = 0, ARKUI_NAV_DESTINATION_STATE_ON_HIDE = 1, ARKUI_NAV_DESTINATION_STATE_ON_APPEAR = 2, ARKUI_NAV_DESTINATION_STATE_ON_DISAPPEAR = 3,<br>ARKUI_NAV_DESTINATION_STATE_ON_WILL_SHOW = 4, ARKUI_NAV_DESTINATION_STATE_ON_WILL_HIDE = 5, ARKUI_NAV_DESTINATION_STATE_ON_WILL_APPEAR = 6, ARKUI_NAV_DESTINATION_STATE_ON_WILL_DISAPPEAR = 7,<br>ARKUI_NAV_DESTINATION_STATE_ON_BACK_PRESS = 100<br>} | Defines an enum for the **NavDestination** component states. | 255| [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. | 256 257### Functions 258 259| Name| Description| 260| -------- | -------- | 261| [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. | 262| [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. | 263| 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. | 264| 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. | 265| 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. | 266| 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. | 267| 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. | 268| 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. | 269| 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. | 270| 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. | 271| 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. | 272| 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. | 273| 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. | 274| 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. | 275| 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. | 276| 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. | 277| 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. | 278| 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. | 279| float [OH_ArkUI_DragEvent_GetVelocityX](#oh_arkui_dragevent_getvelocityx) ([ArkUI_DragEvent](#arkui_dragevent) \*event) | Obtains the dragging velocity along the x-axis. | 280| float [OH_ArkUI_DragEvent_GetVelocityY](#oh_arkui_dragevent_getvelocityy) ([ArkUI_DragEvent](#arkui_dragevent) \*event) | Obtains the dragging velocity along the y-axis. | 281| float [OH_ArkUI_DragEvent_GetVelocity](#oh_arkui_dragevent_getvelocity) ([ArkUI_DragEvent](#arkui_dragevent) \*event) | Obtains the dragging velocity along the main axis. | 282| 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. | 283| 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. | 284| 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. | 285| 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). | 286| 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). | 287| 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). | 288| int32_t [OH_ArkUI_SetNodeDraggable](#oh_arkui_setnodedraggable) ([ArkUI_NodeHandle](#arkui_nodehandle) node, bool enabled) | Sets whether the component is draggable. | 289| 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. | 290| [ArkUI_DragPreviewOption](#arkui_dragpreviewoption) \* [OH_ArkUI_CreateDragPreviewOption](#oh_arkui_createdragpreviewoption) (void) | Creates an **ArkUI_DragPreviewOption** object. | 291| void [OH_ArkUI_DragPreviewOption_Dispose](#oh_arkui_dragpreviewoption_dispose) ([ArkUI_DragPreviewOption](#arkui_dragpreviewoption) \*option) | Disposes of an **ArkUI_DragPreviewOption** object. | 292| 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. | 293| 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. | 294| 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. | 295| 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. | 296| 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. | 297| 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. | 298| 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. | 299| [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. | 300| [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. | 301| void [OH_ArkUI_DragAction_Dispose](#oh_arkui_dragaction_dispose) ([ArkUI_DragAction](#arkui_dragaction) \*dragAction) | Disposes of an **ArkUI_DragAction** object. | 302| 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. | 303| 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. | 304| 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). | 305| 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). | 306| int32_t [OH_ArkUI_DragAction_SetData](#oh_arkui_dragaction_setdata) ([ArkUI_DragAction](#arkui_dragaction) \*dragAction, [OH_UdmfData](#oh_udmfdata) \*data) | Sets the drag data. | 307| 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. | 308| 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. | 309| void [OH_ArkUI_DragAction_UnregisterStatusListener](#oh_arkui_dragaction_unregisterstatuslistener) ([ArkUI_DragAction](#arkui_dragaction) \*dragAction) | Unregisters a drag status listener. | 310| [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. | 311| [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. | 312| int32_t [OH_ArkUI_StartDrag](#oh_arkui_startdrag) ([ArkUI_DragAction](#arkui_dragaction) \*dragAction) | Initiates a drag action through the specified **DragAction** object. | 313| [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. | 314| [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. | 315| void [OH_ArkUI_DrawableDescriptor_Dispose](#oh_arkui_drawabledescriptor_dispose) ([ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) \*drawableDescriptor) | Disposes of the pointer to a **DrawableDescriptor** object. | 316| [OH_PixelmapNativeHandle](#oh_pixelmapnativehandle) [OH_ArkUI_DrawableDescriptor_GetStaticPixelMap](#oh_arkui_drawabledescriptor_getstaticpixelmap) ([ArkUI_DrawableDescriptor](#arkui_drawabledescriptor) \*drawableDescriptor) | Obtains the pointer to a **PixelMap** object. | 317| [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. | 318| 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. | 319| 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. | 320| 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. | 321| 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. | 322| 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. | 323| [ArkUI_AnimateOption](#arkui_animateoption) \* [OH_ArkUI_AnimateOption_Create](#oh_arkui_animateoption_create) () | Creates an animation configuration. | 324| void [OH_ArkUI_AnimateOption_Dispose](#oh_arkui_animateoption_dispose) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | Destroys an animation configuration. | 325| int32_t [OH_ArkUI_AnimateOption_GetDuration](#oh_arkui_animateoption_getduration) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | Obtains the animation duration, in milliseconds. | 326| float [OH_ArkUI_AnimateOption_GetTempo](#oh_arkui_animateoption_gettempo) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | Obtains the playback speed of an animation. | 327| [ArkUI_AnimationCurve](#arkui_animationcurve) [OH_ArkUI_AnimateOption_GetCurve](#oh_arkui_animateoption_getcurve) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | Obtains an animation curve. | 328| int32_t [OH_ArkUI_AnimateOption_GetDelay](#oh_arkui_animateoption_getdelay) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | Obtains the animation delay, in milliseconds. | 329| 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. | 330| [ArkUI_AnimationPlayMode](#arkui_animationplaymode) [OH_ArkUI_AnimateOption_GetPlayMode](#oh_arkui_animateoption_getplaymode) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | Obtains the playback mode of an animation. | 331| [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. | 332| void [OH_ArkUI_AnimateOption_SetDuration](#oh_arkui_animateoption_setduration) ([ArkUI_AnimateOption](#arkui_animateoption) \*option, int32_t value) | Sets the animation duration. | 333| void [OH_ArkUI_AnimateOption_SetTempo](#oh_arkui_animateoption_settempo) ([ArkUI_AnimateOption](#arkui_animateoption) \*option, float value) | Sets the playback speed of an animation. | 334| void [OH_ArkUI_AnimateOption_SetCurve](#oh_arkui_animateoption_setcurve) ([ArkUI_AnimateOption](#arkui_animateoption) \*option, [ArkUI_AnimationCurve](#arkui_animationcurve) value) | Animation curve. | 335| void [OH_ArkUI_AnimateOption_SetDelay](#oh_arkui_animateoption_setdelay) ([ArkUI_AnimateOption](#arkui_animateoption) \*option, int32_t value) | Sets the animation delay. | 336| 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. | 337| 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. | 338| 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. | 339| 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. | 340| [ArkUI_CurveHandle](#arkui_curvehandle) [OH_ArkUI_AnimateOption_GetICurve](#oh_arkui_animateoption_geticurve) ([ArkUI_AnimateOption](#arkui_animateoption) \*option) | Obtains the animation curve of an animation. | 341| [ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) \* [OH_ArkUI_KeyframeAnimateOption_Create](#oh_arkui_keyframeanimateoption_create) (int32_t size) | Obtains the keyframe animation parameters. | 342| void [OH_ArkUI_KeyframeAnimateOption_Dispose](#oh_arkui_keyframeanimateoption_dispose) ([ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) \*option) | Destroys a keyframe animation parameter object. | 343| 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. | 344| 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. | 345| 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. | 346| 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. | 347| 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. | 348| 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. | 349| int32_t [OH_ArkUI_KeyframeAnimateOption_GetDelay](#oh_arkui_keyframeanimateoption_getdelay) ([ArkUI_KeyframeAnimateOption](#arkui_keyframeanimateoption) \*option) | Obtains the overall delay of a keyframe animation | 350| 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. | 351| 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. | 352| [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. | 353| [ArkUI_AnimatorOption](#arkui_animatoroption) \* [OH_ArkUI_AnimatorOption_Create](#oh_arkui_animatoroption_create) (int32_t keyframeSize) | Creates an animator parameter object. | 354| void [OH_ArkUI_AnimatorOption_Dispose](#oh_arkui_animatoroption_dispose) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | Destroys an animator parameter object. | 355| 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. | 356| 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. | 357| 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. | 358| 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. | 359| int32_t [OH_ArkUI_AnimatorOption_SetDirection](#oh_arkui_animatoroption_setdirection) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, [ArkUI_AnimationDirection](#arkui_animationdirection) value) | Sets the playback direction. | 360| 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. | 361| 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. | 362| 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. | 363| 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. | 364| 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. | 365| 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. | 366| int32_t [OH_ArkUI_AnimatorOption_GetDuration](#oh_arkui_animatoroption_getduration) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | Obtains the duration for playing an animation. | 367| int32_t [OH_ArkUI_AnimatorOption_GetDelay](#oh_arkui_animatoroption_getdelay) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | Obtains the delay for playing an animation. | 368| 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. | 369| [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. | 370| [ArkUI_AnimationDirection](#arkui_animationdirection) [OH_ArkUI_AnimatorOption_GetDirection](#oh_arkui_animatoroption_getdirection) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | Obtains the playback direction of an animation. | 371| [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. | 372| float [OH_ArkUI_AnimatorOption_GetBegin](#oh_arkui_animatoroption_getbegin) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | Obtains the interpolation start point of an animation. | 373| float [OH_ArkUI_AnimatorOption_GetEnd](#oh_arkui_animatoroption_getend) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | Obtains the interpolation end point of an animation. | 374| [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. | 375| float [OH_ArkUI_AnimatorOption_GetKeyframeTime](#oh_arkui_animatoroption_getkeyframetime) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, int32_t index) | Obtains the keyframe time of an animation. | 376| float [OH_ArkUI_AnimatorOption_GetKeyframeValue](#oh_arkui_animatoroption_getkeyframevalue) ([ArkUI_AnimatorOption](#arkui_animatoroption) \*option, int32_t index) | Obtains the keyframe value of an animation. | 377| [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. | 378| void \* [OH_ArkUI_AnimatorEvent_GetUserData](#oh_arkui_animatorevent_getuserdata) (ArkUI_AnimatorEvent \*event) | Obtains the custom object in an animation event object. | 379| void \* [OH_ArkUI_AnimatorOnFrameEvent_GetUserData](#oh_arkui_animatoronframeevent_getuserdata) (ArkUI_AnimatorOnFrameEvent \*event) | Obtains the custom object in an animation event object. | 380| float [OH_ArkUI_AnimatorOnFrameEvent_GetValue](#oh_arkui_animatoronframeevent_getvalue) (ArkUI_AnimatorOnFrameEvent \*event) | Obtains the current progress in an animation event object. | 381| 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. | 382| 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. | 383| 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. | 384| 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. | 385| int32_t [OH_ArkUI_Animator_ResetAnimatorOption](#oh_arkui_animator_resetanimatoroption) ([ArkUI_AnimatorHandle](#arkui_animatorhandle) animator, [ArkUI_AnimatorOption](#arkui_animatoroption) \*option) | Resets an animator configuration. | 386| int32_t [OH_ArkUI_Animator_Play](#oh_arkui_animator_play) ([ArkUI_AnimatorHandle](#arkui_animatorhandle) animator) | Starts the animation of an animator. | 387| int32_t [OH_ArkUI_Animator_Finish](#oh_arkui_animator_finish) ([ArkUI_AnimatorHandle](#arkui_animatorhandle) animator) | Ends the animation of an animator. | 388| int32_t [OH_ArkUI_Animator_Pause](#oh_arkui_animator_pause) ([ArkUI_AnimatorHandle](#arkui_animatorhandle) animator) | Pauses the animation of an animator. | 389| int32_t [OH_ArkUI_Animator_Cancel](#oh_arkui_animator_cancel) ([ArkUI_AnimatorHandle](#arkui_animatorhandle) animator) | Cancels the animation of an animator. | 390| int32_t [OH_ArkUI_Animator_Reverse](#oh_arkui_animator_reverse) ([ArkUI_AnimatorHandle](#arkui_animatorhandle) animator) | Plays this animation in reverse order. | 391| [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. | 392| [ArkUI_CurveHandle](#arkui_curvehandle) [OH_ArkUI_Curve_CreateStepsCurve](#oh_arkui_curve_createstepscurve) (int32_t count, bool end) | Creates a step curve. | 393| [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. | 394| [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**. | 395| [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. | 396| [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**. | 397| [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. | 398| [ArkUI_CurveHandle](#arkui_curvehandle) [OH_ArkUI_Curve_CreateCustomCurve](#oh_arkui_curve_createcustomcurve) (void \*userData, float(\*interpolate)(float fraction, void \*userdata)) | Creates a custom curve. | 399| void [OH_ArkUI_Curve_DisposeCurve](#oh_arkui_curve_disposecurve) ([ArkUI_CurveHandle](#arkui_curvehandle) curveHandle) | Disposes of a custom curve. | 400| [ArkUI_TransitionEffect](#arkui_transitioneffect) \* [OH_ArkUI_CreateOpacityTransitionEffect](#oh_arkui_createopacitytransitioneffect) (float opacity) | Creates an opacity object for component transition. | 401| [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. | 402| [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. | 403| [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. | 404| [ArkUI_TransitionEffect](#arkui_transitioneffect) \* [OH_ArkUI_CreateMovementTransitionEffect](#oh_arkui_createmovementtransitioneffect) ([ArkUI_TransitionEdge](#arkui_transitionedge) move) | Creates a movement object for component transition. | 405| [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. | 406| void [OH_ArkUI_TransitionEffect_Dispose](#oh_arkui_transitioneffect_dispose) ([ArkUI_TransitionEffect](#arkui_transitioneffect) \*option) | Disposes of a transition effect. | 407| 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. | 408| 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. | 409| 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. | 410| 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. | 411| 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. | 412| 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. | 413| ArkUI_GestureRecognizer \* [OH_ArkUI_GestureInterruptInfo_GetRecognizer](#oh_arkui_gestureinterruptinfo_getrecognizer) (const ArkUI_GestureInterruptInfo \*event) | Obtains the pointer to interrupted gesture recognizer. | 414| ArkUI_GestureEvent \* [OH_ArkUI_GestureInterruptInfo_GetGestureEvent](#oh_arkui_gestureinterruptinfo_getgestureevent) (const ArkUI_GestureInterruptInfo \*event) | Obtains the pointer to the interrupted gesture event. | 415| int32_t [OH_ArkUI_GestureInterruptInfo_GetSystemRecognizerType](#oh_arkui_gestureinterruptinfo_getsystemrecognizertype) (const ArkUI_GestureInterruptInfo \*event) | Obtains the type of the system gesture to trigger. | 416| [ArkUI_GestureEventActionType](#arkui_gestureeventactiontype) [OH_ArkUI_GestureEvent_GetActionType](#oh_arkui_gestureevent_getactiontype) (const ArkUI_GestureEvent \*event) | Obtains the gesture event type. | 417| [ArkUI_NodeHandle](#arkui_nodehandle) [OH_ArkUI_GestureEvent_GetResponseNode](#oh_arkui_gestureevent_getresponsenode) (ArkUI_GestureEvent \*event) | Obtains the node that responds to the gesture. | 418| 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. | 419| 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. | 420| float [OH_ArkUI_PanGesture_GetVelocity](#oh_arkui_pangesture_getvelocity) (const ArkUI_GestureEvent \*event) | Obtains the velocity of a pan gesture along the main axis. | 421| float [OH_ArkUI_PanGesture_GetVelocityX](#oh_arkui_pangesture_getvelocityx) (const ArkUI_GestureEvent \*event) | Obtains the velocity of a pan gesture along the x-axis. | 422| float [OH_ArkUI_PanGesture_GetVelocityY](#oh_arkui_pangesture_getvelocityy) (const ArkUI_GestureEvent \*event) | Obtains the velocity of a pan gesture along the y-axis. | 423| 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. | 424| 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. | 425| float [OH_ArkUI_SwipeGesture_GetAngle](#oh_arkui_swipegesture_getangle) (const ArkUI_GestureEvent \*event) | Obtains the angle information of the swipe gesture. | 426| 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. | 427| float [OH_ArkUI_RotationGesture_GetAngle](#oh_arkui_rotationgesture_getangle) (const ArkUI_GestureEvent \*event) | Obtains the angle information of a rotation gesture. | 428| float [OH_ArkUI_PinchGesture_GetScale](#oh_arkui_pinchgesture_getscale) (const ArkUI_GestureEvent \*event) | Obtains the scale ratio of a pinch gesture. | 429| 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. | 430| 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. | 431| [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. | 432| 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. | 433| int32_t [OH_ArkUI_SetGestureRecognizerEnabled](#oh_arkui_setgesturerecognizerenabled) (ArkUI_GestureRecognizer \*recognizer, bool enabled) | Sets the enabled state of a gesture recognizer. | 434| bool [OH_ArkUI_GetGestureRecognizerEnabled](#oh_arkui_getgesturerecognizerenabled) (ArkUI_GestureRecognizer \*recognizer) | Obtains the enabled state of a gesture recognizer. | 435| int32_t [OH_ArkUI_GetGestureRecognizerState](#oh_arkui_getgesturerecognizerstate) (ArkUI_GestureRecognizer \*recognizer, [ArkUI_GestureRecognizerState](#arkui_gesturerecognizerstate) \*state) | Obtains the state of a gesture recognizer. | 436| int32_t [OH_ArkUI_GetGestureEventTargetInfo](#oh_arkui_getgestureeventtargetinfo) (ArkUI_GestureRecognizer \*recognizer, [ArkUI_GestureEventTargetInfo](#arkui_gestureeventtargetinfo) \*\*info) | Obtains the information about a gesture event target. | 437| 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. | 438| 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. | 439| int32_t [OH_ArkUI_GetPanGestureDirectionMask](#oh_arkui_getpangesturedirectionmask) (ArkUI_GestureRecognizer \*recognizer, [ArkUI_GestureDirectionMask](#arkui_gesturedirectionmask) \*directionMask) | Obtains the direction of a pan gesture. | 440| bool [OH_ArkUI_IsBuiltInGesture](#oh_arkui_isbuiltingesture) (ArkUI_GestureRecognizer \*recognizer) | Obtains whether a gesture is a built-in gesture. | 441| 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. | 442| 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. | 443| bool [OH_ArkUI_IsGestureRecognizerValid](#oh_arkui_isgesturerecognizervalid) (ArkUI_GestureRecognizer \*recognizer) | Obtains whether a gesture recognizer is valid. | 444| void \* [OH_ArkUI_ParallelInnerGestureEvent_GetUserData](#oh_arkui_parallelinnergestureevent_getuserdata) ([ArkUI_ParallelInnerGestureEvent](#arkui_parallelinnergestureevent) \*event) | Obtains custom data in the parallel internal gesture event. | 445| 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. | 446| 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. | 447| 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. | 448| void \* [OH_ArkUI_QueryModuleInterfaceByName](#oh_arkui_querymoduleinterfacebyname) ([ArkUI_NativeAPIVariantKind](#arkui_nativeapivariantkind) type, const char \*structName) | Obtains the native API set of a specified type. | 449| [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. | 450| int32_t [OH_ArkUI_NodeEvent_GetTargetId](#oh_arkui_nodeevent_gettargetid) ([ArkUI_NodeEvent](#arkui_nodeevent-12) \*event) | Obtains the custom ID of a component event. | 451| [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. | 452| [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. | 453| [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. | 454| [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. | 455| void \* [OH_ArkUI_NodeEvent_GetUserData](#oh_arkui_nodeevent_getuserdata) ([ArkUI_NodeEvent](#arkui_nodeevent-12) \*event) | Obtains the custom data in a component event. | 456| 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. | 457| 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. | 458| 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. | 459| [ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) [OH_ArkUI_NodeAdapter_Create](#oh_arkui_nodeadapter_create) () | Creates a component adapter. | 460| void [OH_ArkUI_NodeAdapter_Dispose](#oh_arkui_nodeadapter_dispose) ([ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) handle) | Destroys a component adapter. | 461| 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. | 462| 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. | 463| 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. | 464| void [OH_ArkUI_NodeAdapter_UnregisterEventReceiver](#oh_arkui_nodeadapter_unregistereventreceiver) ([ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) handle) | Unregisters an event callback for the specified adapter. | 465| int32_t [OH_ArkUI_NodeAdapter_ReloadAllItems](#oh_arkui_nodeadapter_reloadallitems) ([ArkUI_NodeAdapterHandle](#arkui_nodeadapterhandle) handle) | Instructs the specified adapter to reload all elements. | 466| 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. | 467| 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. | 468| 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. | 469| 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. | 470| 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. | 471| 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. | 472| [ArkUI_NodeAdapterEventType](#arkui_nodeadaptereventtype) [OH_ArkUI_NodeAdapterEvent_GetType](#oh_arkui_nodeadapterevent_gettype) ([ArkUI_NodeAdapterEvent](#arkui_nodeadapterevent) \*event) | Obtains the event type. | 473| [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. | 474| 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. | 475| [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. | 476| 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. | 477| 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. | 478| [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. | 479| [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. | 480| [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. | 481| int32_t [OH_ArkUI_NodeCustomEvent_GetEventTargetId](#oh_arkui_nodecustomevent_geteventtargetid) ([ArkUI_NodeCustomEvent](#arkui_nodecustomevent) \*event) | Obtains the ID of a custom component event. | 482| void \* [OH_ArkUI_NodeCustomEvent_GetUserData](#oh_arkui_nodecustomevent_getuserdata) ([ArkUI_NodeCustomEvent](#arkui_nodecustomevent) \*event) | Obtains custom event parameters through a custom component event. | 483| [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. | 484| [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. | 485| 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. | 486| 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. | 487| 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. | 488| 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. | 489| [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. | 490| [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. | 491| 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. | 492| void \* [OH_ArkUI_NodeContent_GetUserData](#oh_arkui_nodecontent_getuserdata) ([ArkUI_NodeContentHandle](#arkui_nodecontenthandle) content) | Obtains the custom data saved on the specified NodeContent object. | 493| 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. | 494| 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. | 495| 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. | 496| 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. | 497| 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. | 498| 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. | 499| 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. | 500| 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. | 501| 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. | 502| 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. | 503| 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. | 504| 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. | 505| [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. | 506| 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. | 507| void [OH_ArkUI_UnregisterSystemColorModeChangeEvent](#oh_arkui_unregistersystemcolormodechangeevent) ([ArkUI_NodeHandle](#arkui_nodehandle) node) | Unregisters the event listener for system color mode changes. | 508| 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. | 509| void [OH_ArkUI_UnregisterSystemFontStyleChangeEvent](#oh_arkui_unregistersystemfontstylechangeevent) ([ArkUI_NodeHandle](#arkui_nodehandle) node) | Unregisters the event listener for system font style changes. | 510| 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. | 511| 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. | 512| 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. | 513| 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. | 514| 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. | 515| 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. | 516| 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. | 517| [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. | 518| [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. | 519| [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. | 520| [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. | 521| [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. | 522| [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. | 523| [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. | 524| 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. | 525| [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. | 526| [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. | 527| [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. | 528| [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. | 529| [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. | 530| [ArkUI_LayoutConstraint](#arkui_layoutconstraint) \* [OH_ArkUI_LayoutConstraint_Create](#oh_arkui_layoutconstraint_create) () | Creates a size constraint. | 531| [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. | 532| void \* [OH_ArkUI_LayoutConstraint_Dispose](#oh_arkui_layoutconstraint_dispose) ([ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint) | Disposes of the pointer to a size constraint. | 533| 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. | 534| 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. | 535| 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. | 536| 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. | 537| 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. | 538| 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. | 539| void [OH_ArkUI_LayoutConstraint_SetMaxWidth](#oh_arkui_layoutconstraint_setmaxwidth) ([ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint, int32_t value) | Sets the maximum width. | 540| void [OH_ArkUI_LayoutConstraint_SetMinWidth](#oh_arkui_layoutconstraint_setminwidth) ([ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint, int32_t value) | Sets the minimum width. | 541| void [OH_ArkUI_LayoutConstraint_SetMaxHeight](#oh_arkui_layoutconstraint_setmaxheight) ([ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint, int32_t value) | Sets the maximum height. | 542| void [OH_ArkUI_LayoutConstraint_SetMinHeight](#oh_arkui_layoutconstraint_setminheight) ([ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint, int32_t value) | Sets the minimum height. | 543| void [OH_ArkUI_LayoutConstraint_SetPercentReferenceWidth](#oh_arkui_layoutconstraint_setpercentreferencewidth) ([ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint, int32_t value) | Sets the width percentage reference. | 544| void [OH_ArkUI_LayoutConstraint_SetPercentReferenceHeight](#oh_arkui_layoutconstraint_setpercentreferenceheight) ([ArkUI_LayoutConstraint](#arkui_layoutconstraint) \*Constraint, int32_t value) | Sets the height percentage reference. | 545| 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. | 546| [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. | 547| [ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \* [OH_ArkUI_WaterFlowSectionOption_Create](#oh_arkui_waterflowsectionoption_create) () | Creates a water flow section configuration. | 548| void [OH_ArkUI_WaterFlowSectionOption_Dispose](#oh_arkui_waterflowsectionoption_dispose) ([ArkUI_WaterFlowSectionOption](#arkui_waterflowsectionoption) \*option) | Disposes of the pointer to a water flow section configuration. | 549| 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. | 550| 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. | 551| 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. | 552| 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. | 553| 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. | 554| 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. | 555| 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. | 556| 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. | 557| 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. | 558| 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. | 559| 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. | 560| [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. | 561| 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. | 562| 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. | 563| [ArkUI_GuidelineOption](#arkui_guidelineoption) \* [OH_ArkUI_GuidelineOption_Create](#oh_arkui_guidelineoption_create) (int32_t size) | Creates a guideline configuration for this **RelativeContainer** component. | 564| void [OH_ArkUI_GuidelineOption_Dispose](#oh_arkui_guidelineoption_dispose) ([ArkUI_GuidelineOption](#arkui_guidelineoption) \*guideline) | Disposes of a guideline configuration. | 565| 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. | 566| 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. | 567| 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. | 568| 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. | 569| const char \* [OH_ArkUI_GuidelineOption_GetId](#oh_arkui_guidelineoption_getid) ([ArkUI_GuidelineOption](#arkui_guidelineoption) \*guideline, int32_t index) | Obtains the ID of a guideline. | 570| [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. | 571| 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. | 572| 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. | 573| [ArkUI_BarrierOption](#arkui_barrieroption) \* [OH_ArkUI_BarrierOption_Create](#oh_arkui_barrieroption_create) (int32_t size) | Creates a barrier configuration for this **RelativeContainer** component. | 574| void [OH_ArkUI_BarrierOption_Dispose](#oh_arkui_barrieroption_dispose) ([ArkUI_BarrierOption](#arkui_barrieroption) \*barrierStyle) | Disposes of a barrier configuration. | 575| 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. | 576| 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. | 577| 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. | 578| const char \* [OH_ArkUI_BarrierOption_GetId](#oh_arkui_barrieroption_getid) ([ArkUI_BarrierOption](#arkui_barrieroption) \*barrierStyle, int32_t index) | Obtains the ID of a barrier. | 579| [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. | 580| 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. | 581| 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. | 582| [ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \* [OH_ArkUI_AlignmentRuleOption_Create](#oh_arkui_alignmentruleoption_create) () | Creates an alignment rule configuration for this **RelativeContainer** component. | 583| void [OH_ArkUI_AlignmentRuleOption_Dispose](#oh_arkui_alignmentruleoption_dispose) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Disposes of an alignment rule configuration of this **RelativeContainer** component. | 584| 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. | 585| 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. | 586| 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. | 587| 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. | 588| 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. | 589| 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. | 590| 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. | 591| 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. | 592| const char \* [OH_ArkUI_AlignmentRuleOption_GetStartId](#oh_arkui_alignmentruleoption_getstartid) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the ID in the left alignment parameters. | 593| [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. | 594| const char \* [OH_ArkUI_AlignmentRuleOption_GetEndId](#oh_arkui_alignmentruleoption_getendid) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the ID in the right alignment parameters. | 595| [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. | 596| const char \* [OH_ArkUI_AlignmentRuleOption_GetCenterIdHorizontal](#oh_arkui_alignmentruleoption_getcenteridhorizontal) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the ID in horizontal center alignment parameters. | 597| [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. | 598| const char \* [OH_ArkUI_AlignmentRuleOption_GetTopId](#oh_arkui_alignmentruleoption_gettopid) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the ID in top alignment parameters. | 599| [ArkUI_VerticalAlignment](#arkui_verticalalignment) [OH_ArkUI_AlignmentRuleOption_GetTopAlignment](#oh_arkui_alignmentruleoption_gettopalignment) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the ID in top alignment parameters. | 600| const char \* [OH_ArkUI_AlignmentRuleOption_GetBottomId](#oh_arkui_alignmentruleoption_getbottomid) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the ID in bottom alignment parameters. | 601| [ArkUI_VerticalAlignment](#arkui_verticalalignment) [OH_ArkUI_AlignmentRuleOption_GetBottomAlignment](#oh_arkui_alignmentruleoption_getbottomalignment) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the ID in bottom alignment parameters. | 602| const char \* [OH_ArkUI_AlignmentRuleOption_GetCenterIdVertical](#oh_arkui_alignmentruleoption_getcenteridvertical) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the ID in vertical center alignment parameters. | 603| [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. | 604| float [OH_ArkUI_AlignmentRuleOption_GetBiasHorizontal](#oh_arkui_alignmentruleoption_getbiashorizontal) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the bias value in the horizontal direction. | 605| float [OH_ArkUI_AlignmentRuleOption_GetBiasVertical](#oh_arkui_alignmentruleoption_getbiasvertical) ([ArkUI_AlignmentRuleOption](#arkui_alignmentruleoption) \*option) | Obtains the bias value in the vertical direction. | 606| [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. | 607| void [OH_ArkUI_SwiperIndicator_Dispose](#oh_arkui_swiperindicator_dispose) ([ArkUI_SwiperIndicator](#arkui_swiperindicator) \*indicator) | Disposes of the navigation point indicator of this **Swiper** component. | 608| 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. | 609| 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. | 610| 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. | 611| 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. | 612| 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. | 613| 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. | 614| 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. | 615| 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. | 616| 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. | 617| 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. | 618| 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. | 619| 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. | 620| 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. | 621| 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. | 622| 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. | 623| 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. | 624| 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. | 625| 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. | 626| 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. | 627| 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. | 628| 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. | 629| 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. | 630| 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. | 631| 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. | 632| [ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \* [OH_ArkUI_ListItemSwipeActionItem_Create](#oh_arkui_listitemswipeactionitem_create) () | Creates a **ListItemSwipeActionItem** instance. | 633| void [OH_ArkUI_ListItemSwipeActionItem_Dispose](#oh_arkui_listitemswipeactionitem_dispose) ([ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item) | Disposes of a **ListItemSwipeActionItem** instance. | 634| 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. | 635| 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. | 636| float [OH_ArkUI_ListItemSwipeActionItem_GetActionAreaDistance](#oh_arkui_listitemswipeactionitem_getactionareadistance) ([ArkUI_ListItemSwipeActionItem](#arkui_listitemswipeactionitem) \*item) | Obtains the swipe distance threshold for deleting the list item. | 637| 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. | 638| 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. | 639| 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. | 640| 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. | 641| 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. | 642| 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. | 643| 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. | 644| 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. | 645| [ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption) \* [OH_ArkUI_ListItemSwipeActionOption_Create](#oh_arkui_listitemswipeactionoption_create) () | Creates a **ListItemSwipeActionOption** instance. | 646| void [OH_ArkUI_ListItemSwipeActionOption_Dispose](#oh_arkui_listitemswipeactionoption_dispose) ([ArkUI_ListItemSwipeActionOption](#arkui_listitemswipeactionoption) \*option) | Disposes of a **ListItemSwipeActionOption** instance. | 647| 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. | 648| 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. | 649| 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. | 650| 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. | 651| 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. | 652| 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. | 653| [ArkUI_AccessibilityState](#arkui_accessibilitystate) \* [OH_ArkUI_AccessibilityState_Create](#oh_arkui_accessibilitystate_create) (void) | Creates an accessibility state. | 654| void [OH_ArkUI_AccessibilityState_Dispose](#oh_arkui_accessibilitystate_dispose) ([ArkUI_AccessibilityState](#arkui_accessibilitystate) \*state) | Disposes of the pointer to an accessibility state. | 655| void [OH_ArkUI_AccessibilityState_SetDisabled](#oh_arkui_accessibilitystate_setdisabled) ([ArkUI_AccessibilityState](#arkui_accessibilitystate) \*state, int32_t isDisabled) | Sets whether an accessibility state is disabled. | 656| int32_t [OH_ArkUI_AccessibilityState_IsDisabled](#oh_arkui_accessibilitystate_isdisabled) ([ArkUI_AccessibilityState](#arkui_accessibilitystate) \*state) | Obtains whether an accessibility state is disabled. | 657| void [OH_ArkUI_AccessibilityState_SetSelected](#oh_arkui_accessibilitystate_setselected) ([ArkUI_AccessibilityState](#arkui_accessibilitystate) \*state, int32_t isSelected) | Sets whether an accessibility state is selected. | 658| int32_t [OH_ArkUI_AccessibilityState_IsSelected](#oh_arkui_accessibilitystate_isselected) ([ArkUI_AccessibilityState](#arkui_accessibilitystate) \*state) | Obtains whether an accessibility state is selected. | 659| 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. | 660| int32_t [OH_ArkUI_AccessibilityState_GetCheckedState](#oh_arkui_accessibilitystate_getcheckedstate) ([ArkUI_AccessibilityState](#arkui_accessibilitystate) \*state) | Obtains the check box state of an accessibility state. | 661| [ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \* [OH_ArkUI_AccessibilityValue_Create](#oh_arkui_accessibilityvalue_create) (void) | Creates an **AccessibilityValue** instance. | 662| void [OH_ArkUI_AccessibilityValue_Dispose](#oh_arkui_accessibilityvalue_dispose) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value) | Disposes of the pointer to an **AccessibilityValue** instance. | 663| void [OH_ArkUI_AccessibilityValue_SetMin](#oh_arkui_accessibilityvalue_setmin) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value, int32_t min) | Sets the minimum accessibility value. | 664| int32_t [OH_ArkUI_AccessibilityValue_GetMin](#oh_arkui_accessibilityvalue_getmin) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value) | Obtains the minimum accessibility value. | 665| void [OH_ArkUI_AccessibilityValue_SetMax](#oh_arkui_accessibilityvalue_setmax) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value, int32_t max) | Sets the maximum accessibility value. | 666| int32_t [OH_ArkUI_AccessibilityValue_GetMax](#oh_arkui_accessibilityvalue_getmax) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value) | Obtains the maximum accessibility value. | 667| void [OH_ArkUI_AccessibilityValue_SetCurrent](#oh_arkui_accessibilityvalue_setcurrent) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value, int32_t current) | Sets the current accessibility value. | 668| int32_t [OH_ArkUI_AccessibilityValue_GetCurrent](#oh_arkui_accessibilityvalue_getcurrent) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value) | Obtains the current accessibility value. | 669| 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. | 670| const char \* [OH_ArkUI_AccessibilityValue_GetText](#oh_arkui_accessibilityvalue_gettext) ([ArkUI_AccessibilityValue](#arkui_accessibilityvalue) \*value) | Obtains the text description of an **AccessibilityValue** instance. | 671| [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. | 672| [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. | 673| void [OH_ArkUI_ImageAnimatorFrameInfo_Dispose](#oh_arkui_imageanimatorframeinfo_dispose) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo) | Disposes of the pointer to an image frame information object. | 674| void [OH_ArkUI_ImageAnimatorFrameInfo_SetWidth](#oh_arkui_imageanimatorframeinfo_setwidth) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo, int32_t width) | Sets the image width. | 675| int32_t [OH_ArkUI_ImageAnimatorFrameInfo_GetWidth](#oh_arkui_imageanimatorframeinfo_getwidth) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo) | Obtains the image width. | 676| void [OH_ArkUI_ImageAnimatorFrameInfo_SetHeight](#oh_arkui_imageanimatorframeinfo_setheight) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo, int32_t height) | Sets the image height. | 677| int32_t [OH_ArkUI_ImageAnimatorFrameInfo_GetHeight](#oh_arkui_imageanimatorframeinfo_getheight) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo) | Obtains the image height. | 678| 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. | 679| 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. | 680| 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. | 681| 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. | 682| void [OH_ArkUI_ImageAnimatorFrameInfo_SetDuration](#oh_arkui_imageanimatorframeinfo_setduration) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo, int32_t duration) | Sets the playback duration of an image. | 683| int32_t [OH_ArkUI_ImageAnimatorFrameInfo_GetDuration](#oh_arkui_imageanimatorframeinfo_getduration) ([ArkUI_ImageAnimatorFrameInfo](#arkui_imageanimatorframeinfo) \*imageInfo) | Obtains the playback duration of an image. | 684| [ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) \* [OH_ArkUI_ListChildrenMainSizeOption_Create](#oh_arkui_listchildrenmainsizeoption_create) () | Creates a **ListChildrenMainSize** instance. | 685| void [OH_ArkUI_ListChildrenMainSizeOption_Dispose](#oh_arkui_listchildrenmainsizeoption_dispose) ([ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) \*option) | Disposes of a **ListChildrenMainSize** instance. | 686| 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. | 687| float [OH_ArkUI_ListChildrenMainSizeOption_GetDefaultMainSize](#oh_arkui_listchildrenmainsizeoption_getdefaultmainsize) ([ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) \*option) | Obtains the default size in a **ListChildrenMainSize** instance. | 688| 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. | 689| 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. | 690| 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. | 691| float [OH_ArkUI_ListChildrenMainSizeOption_GetMainSize](#oh_arkui_listchildrenmainsizeoption_getmainsize) ([ArkUI_ListChildrenMainSize](#arkui_listchildrenmainsize) \*option, int32_t index) | Obtains the values of a **ChildrenMainSizeOption** array. | 692| [ArkUI_CustomSpanMeasureInfo](#arkui_customspanmeasureinfo) \* [OH_ArkUI_CustomSpanMeasureInfo_Create](#oh_arkui_customspanmeasureinfo_create) (void) | Creates measurement information for this custom span. | 693| void [OH_ArkUI_CustomSpanMeasureInfo_Dispose](#oh_arkui_customspanmeasureinfo_dispose) ([ArkUI_CustomSpanMeasureInfo](#arkui_customspanmeasureinfo) \*info) | Disposes of measurement information of a custom span. | 694| 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. | 695| [ArkUI_CustomSpanMetrics](#arkui_customspanmetrics) \* [OH_ArkUI_CustomSpanMetrics_Create](#oh_arkui_customspanmetrics_create) (void) | Creates measurement metrics for this custom span. | 696| void [OH_ArkUI_CustomSpanMetrics_Dispose](#oh_arkui_customspanmetrics_dispose) ([ArkUI_CustomSpanMetrics](#arkui_customspanmetrics) \*metrics) | Disposes of measurement metrics of this custom span. | 697| int32_t [OH_ArkUI_CustomSpanMetrics_SetWidth](#oh_arkui_customspanmetrics_setwidth) ([ArkUI_CustomSpanMetrics](#arkui_customspanmetrics) \*metrics, float width) | Sets the width for a custom span. | 698| int32_t [OH_ArkUI_CustomSpanMetrics_SetHeight](#oh_arkui_customspanmetrics_setheight) ([ArkUI_CustomSpanMetrics](#arkui_customspanmetrics) \*metrics, float height) | Sets the height for a custom span. | 699| [ArkUI_CustomSpanDrawInfo](#arkui_customspandrawinfo) \* [OH_ArkUI_CustomSpanDrawInfo_Create](#oh_arkui_customspandrawinfo_create) (void) | Creates drawing information for this custom span. | 700| void [OH_ArkUI_CustomSpanDrawInfo_Dispose](#oh_arkui_customspandrawinfo_dispose) ([ArkUI_CustomSpanDrawInfo](#arkui_customspandrawinfo) \*info) | Disposes of drawing information for this custom span. | 701| 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. | 702| 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. | 703| 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. | 704| 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. | 705| [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. | 706| 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. | 707| 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. | 708| void [OH_ArkUI_StyledString_AddText](#oh_arkui_styledstring_addtext) ([ArkUI_StyledString](#arkui_styledstring) \*handle, const char \*content) | Adds text for a styled string. | 709| 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. | 710| 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. | 711| void [OH_ArkUI_StyledString_AddPlaceholder](#oh_arkui_styledstring_addplaceholder) ([ArkUI_StyledString](#arkui_styledstring) \*handle, OH_Drawing_PlaceholderSpan \*placeholder) | Adds a placeholder. | 712| [ArkUI_StyledString_Descriptor](#arkui_styledstring_descriptor) \* [OH_ArkUI_StyledString_Descriptor_Create](#oh_arkui_styledstring_descriptor_create) () | Creates an **ArkUI_StyledString_Descriptor** object. | 713| 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. | 714| int32_t [OH_ArkUI_UnmarshallStyledStringDescriptor](#oh_arkui_unmarshallstyledstringdescriptor) (uint8_t \*buffer, size_t \*bufferSize, [ArkUI_StyledString_Descriptor](#arkui_styledstring_descriptor) \*descriptor) | Deserializes a byte array containing styled string information into a styled string. | 715| 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. | 716| const char \* [OH_ArkUI_ConvertToHtml](#oh_arkui_converttohtml) ([ArkUI_StyledString_Descriptor](#arkui_styledstring_descriptor) \*descriptor) | Converts styled string information into HTML. | 717 718 719## Macro Description 720 721 722### OH_ArkUI_GetModuleInterface 723 724``` 725#define OH_ArkUI_GetModuleInterface( nativeAPIVariantKind, structType, structPtr ) 726``` 727**Value:** 728``` 729 do { \ 730 void* anyNativeAPI = OH_ArkUI_QueryModuleInterfaceByName(nativeAPIVariantKind, #structType); \ 731 if (anyNativeAPI) { \ 732 structPtr = (structType*)(anyNativeAPI); \ 733 } \ 734 } while (0) 735#include<arkui/native_interface.h> 736#include<arkui/native_node.h> 737 738ArkUI_NativeNodeAPI_1* nativeNodeApi = nullptr; 739OH_ArkUI_GetModuleInterface(ARKUI_NATIVE_NODE, ArkUI_NativeNodeAPI_1, nativeNodeApi); 740``` 741**Description** 742 743Obtains the macro function corresponding to a struct pointer based on the struct type. 744 745**Since**: 12 746 747 748## Type Description 749 750 751### ArkUI_AccessibilityState 752 753``` 754typedef struct ArkUI_AccessibilityState ArkUI_AccessibilityState 755``` 756**Description** 757 758Defines a struct for the component accessibility state. 759 760**Since**: 12 761 762 763### ArkUI_AccessibilityValue 764 765``` 766typedef struct ArkUI_AccessibilityValue ArkUI_AccessibilityValue 767``` 768**Description** 769 770Defines a struct for the component accessibility value. 771 772**Since**: 12 773 774 775### ArkUI_AlignmentRuleOption 776 777``` 778typedef struct ArkUI_AlignmentRuleOption ArkUI_AlignmentRuleOption 779``` 780**Description** 781 782Defines the alignment rule in the relative container. 783 784**Since**: 12 785 786 787### ArkUI_AnimateOption 788 789``` 790typedef struct ArkUI_AnimateOption ArkUI_AnimateOption 791``` 792**Description** 793 794Defines a struct for the animation configuration. 795 796**Since**: 12 797 798 799### ArkUI_AnimatorHandle 800 801``` 802typedef struct ArkUI_Animator* ArkUI_AnimatorHandle 803``` 804**Description** 805 806Defines a struct for the pointer to an animator object. 807 808**Since**: 12 809 810 811### ArkUI_AnimatorOption 812 813``` 814typedef struct ArkUI_AnimatorOption ArkUI_AnimatorOption 815``` 816**Description** 817 818Defines the animator parameter object. 819 820**Since**: 12 821 822 823### ArkUI_BarrierOption 824 825``` 826typedef struct ArkUI_BarrierOption ArkUI_BarrierOption 827``` 828**Description** 829 830Defines the ID, direction, and referenced component of a barrier. 831 832**Since**: 12 833 834 835### ArkUI_Context 836 837``` 838typedef struct ArkUI_Context ArkUI_Context 839``` 840**Description** 841 842Defines a struct for a UI context object. 843 844**Since**: 12 845 846 847### ArkUI_ContextHandle [1/2] 848 849``` 850typedef struct ArkUI_Context* ArkUI_ContextHandle 851``` 852**Description** 853 854Defines a struct for the handle to the ArkUI native UI context. 855 856**Since**: 12 857 858 859### ArkUI_ContextHandle [2/2] 860 861``` 862typedef struct ArkUI_Context* ArkUI_ContextHandle 863``` 864**Description** 865 866Defines the handle to the ArkUI native UI context. 867 868**Since**: 12 869 870 871### ArkUI_CurveHandle 872 873``` 874typedef struct ArkUI_Curve* ArkUI_CurveHandle 875``` 876**Description** 877 878Defines a struct for the pointer to an interpolation curve. 879 880**Since**: 12 881 882 883### ArkUI_CustomSpanDrawInfo 884 885``` 886typedef struct ArkUI_CustomSpanDrawInfo ArkUI_CustomSpanDrawInfo 887``` 888**Description** 889 890Defines a struct for the drawing information of a custom span. 891 892**Since**: 12 893 894 895### ArkUI_CustomSpanMeasureInfo 896 897``` 898typedef struct ArkUI_CustomSpanMeasureInfo ArkUI_CustomSpanMeasureInfo 899``` 900**Description** 901 902Defines a struct for the measurement information of a custom span. 903 904**Since**: 12 905 906 907### ArkUI_CustomSpanMetrics 908 909``` 910typedef struct ArkUI_CustomSpanMetrics ArkUI_CustomSpanMetrics 911``` 912**Description** 913 914Defines a struct for the measurement metrics of a custom span. 915 916**Since**: 12 917 918### ArkUI_DialogDismissEvent 919 920``` 921typedef struct ArkUI_DialogDismissEvent ArkUI_DialogDismissEvent 922``` 923**Description** 924 925Defines a struct for a dialog box dismiss event. 926 927**Since**: 12 928 929 930### ArkUI_DragAction 931 932``` 933typedef struct ArkUI_DragAction ArkUI_DragAction 934``` 935**Description** 936 937Defines a struct for a drag action. 938 939**Since**: 12 940 941 942### ArkUI_DragAndDropInfo 943 944``` 945typedef struct ArkUI_DragAndDropInfo ArkUI_DragAndDropInfo 946``` 947**Description** 948 949Defines a struct for drag and drop information returned through a drag status listener. 950 951**Since**: 12 952 953 954### ArkUI_DragEvent 955 956``` 957typedef struct ArkUI_DragEvent ArkUI_DragEvent 958``` 959**Description** 960 961Defines a struct for a drag event. 962 963**Since**: 12 964 965 966### ArkUI_DragPreviewOption 967 968``` 969typedef struct ArkUI_DragPreviewOption ArkUI_DragPreviewOption 970``` 971**Description** 972 973Defines a struct for custom drag preview options. 974 975**Since**: 12 976 977 978### ArkUI_DrawableDescriptor 979 980``` 981typedef struct ArkUI_DrawableDescriptor ArkUI_DrawableDescriptor 982``` 983**Description** 984 985Defines a struct for the **DrawableDescriptor** object. 986 987**Since**: 12 988 989 990### ArkUI_DrawContext 991 992``` 993typedef struct ArkUI_DrawContext ArkUI_DrawContext 994``` 995**Description** 996 997Defines the component drawing context. 998 999**Since**: 12 1000 1001 1002### ArkUI_GestureDirectionMask 1003 1004``` 1005typedef uint32_t ArkUI_GestureDirectionMask 1006``` 1007**Description** 1008 1009Defines a set of gesture directions. 1010 1011**Since**: 12 1012 1013 1014### ArkUI_GestureEventActionTypeMask 1015 1016``` 1017typedef uint32_t ArkUI_GestureEventActionTypeMask 1018``` 1019**Description** 1020 1021Defines a set of gesture event types. 1022 1023Example: **ArkUI_GestureEventActionTypeMask actions = GESTURE_EVENT_ACTION_ACCEPT | GESTURE_EVENT_ACTION_UPDATE** 1024 1025**Since**: 12 1026 1027 1028### ArkUI_GestureEventTargetInfo 1029 1030``` 1031typedef struct ArkUI_GestureEventTargetInfo ArkUI_GestureEventTargetInfo 1032``` 1033**Description** 1034 1035Defines a struct for a **GestureEventTargetInfo** object that provides information about a gesture event target. 1036 1037**Since**: 12 1038 1039 1040### ArkUI_GestureRecognizerDestructNotifyCallback 1041 1042``` 1043typedef void(* ArkUI_GestureRecognizerDestructNotifyCallback) (ArkUI_GestureRecognizer *recognizer, void *userData) 1044``` 1045**Description** 1046 1047Defines a callback function for notifying gesture recognizer destruction. 1048 1049**Since**: 12 1050 1051 1052### ArkUI_GestureRecognizerHandle 1053 1054``` 1055typedef ArkUI_GestureRecognizer* ArkUI_GestureRecognizerHandle 1056``` 1057**Description** 1058 1059Defines the gesture recognizer handle. 1060 1061**Since**: 12 1062 1063 1064### ArkUI_GestureRecognizerHandleArray 1065 1066``` 1067typedef ArkUI_GestureRecognizerHandle* ArkUI_GestureRecognizerHandleArray 1068``` 1069**Description** 1070 1071Defines the gesture recognizer handle array. 1072 1073**Since**: 12 1074 1075 1076### ArkUI_GuidelineOption 1077 1078``` 1079typedef struct ArkUI_GuidelineOption ArkUI_GuidelineOption 1080``` 1081**Description** 1082 1083Defines the ID, direction, and position of a guideline. 1084 1085**Since**: 12 1086 1087 1088### ArkUI_ImageAnimatorFrameInfo 1089 1090``` 1091typedef struct ArkUI_ImageAnimatorFrameInfo ArkUI_ImageAnimatorFrameInfo 1092``` 1093**Description** 1094 1095Defines the image frame information. 1096 1097**Since**: 12 1098 1099 1100### ArkUI_KeyframeAnimateOption 1101 1102``` 1103typedef struct ArkUI_KeyframeAnimateOption ArkUI_KeyframeAnimateOption 1104``` 1105**Description** 1106 1107Defines a struct for the keyframe animation parameter object. 1108 1109**Since**: 12 1110 1111 1112### ArkUI_LayoutConstraint 1113 1114``` 1115typedef struct ArkUI_LayoutConstraint ArkUI_LayoutConstraint 1116``` 1117**Description** 1118 1119Defines the size constraints of a component during component layout. 1120 1121**Since**: 12 1122 1123 1124### ArkUI_ListChildrenMainSize 1125 1126``` 1127typedef struct ArkUI_ListChildrenMainSize ArkUI_ListChildrenMainSize 1128``` 1129**Description** 1130 1131Defines the **ChildrenMainSize** information of the **List** component. 1132 1133**Since**: 12 1134 1135 1136### ArkUI_ListItemSwipeActionItem 1137 1138``` 1139typedef struct ArkUI_ListItemSwipeActionItem ArkUI_ListItemSwipeActionItem 1140``` 1141**Description** 1142 1143Defines the item configuration for **ListItemSwipeActionOption**. 1144 1145**Since**: 12 1146 1147 1148### ArkUI_ListItemSwipeActionOption 1149 1150``` 1151typedef struct ArkUI_ListItemSwipeActionOption ArkUI_ListItemSwipeActionOption 1152``` 1153**Description** 1154 1155Defines the configuration for **ListItemSwipeActionOption**. 1156 1157**Since**: 12 1158 1159 1160### ArkUI_NativeDialogHandle 1161 1162``` 1163typedef struct ArkUI_NativeDialog* ArkUI_NativeDialogHandle 1164``` 1165**Description** 1166 1167Defines the handle to the custom dialog box controller of ArkUI on the native side. 1168 1169**Since**: 12 1170 1171 1172### ArkUI_NodeAdapterEvent 1173 1174``` 1175typedef struct ArkUI_NodeAdapterEvent ArkUI_NodeAdapterEvent 1176``` 1177**Description** 1178 1179Defines the component adapter event. 1180 1181**Since**: 12 1182 1183 1184### ArkUI_NodeAdapterHandle 1185 1186``` 1187typedef struct ArkUI_NodeAdapter* ArkUI_NodeAdapterHandle 1188``` 1189**Description** 1190 1191Defines the component adapter, which is used for lazy loading of elements of scrollable components. 1192 1193**Since**: 12 1194 1195 1196### ArkUI_NodeContentCallback 1197 1198``` 1199typedef void(* ArkUI_NodeContentCallback) (ArkUI_NodeContentEvent *event) 1200``` 1201**Description** 1202 1203Defines the callback for the NodeContent event. 1204 1205**Since**: 12 1206 1207 1208### ArkUI_NodeContentEvent 1209 1210``` 1211typedef struct ArkUI_NodeContentEvent ArkUI_NodeContentEvent 1212``` 1213**Description** 1214 1215Defines the common structure type of a NodeContent event. 1216 1217**Since**: 12 1218 1219 1220### ArkUI_NodeContentHandle 1221 1222``` 1223typedef struct ArkUI_NodeContent* ArkUI_NodeContentHandle 1224``` 1225**Description** 1226 1227Defines the handle to the ArkUI NodeContent instance on the native side. 1228 1229**Since**: 12 1230 1231 1232### ArkUI_NodeCustomEvent 1233 1234``` 1235typedef struct ArkUI_NodeCustomEvent ArkUI_NodeCustomEvent 1236``` 1237**Description** 1238 1239Defines the common structure of a custom component event. 1240 1241**Since**: 12 1242 1243 1244### ArkUI_NodeEvent [1/2] 1245 1246``` 1247typedef struct ArkUI_NodeEvent ArkUI_NodeEvent 1248``` 1249**Description** 1250 1251Defines a struct for a component event. 1252 1253**Since**: 12 1254 1255 1256### ArkUI_NodeEvent [2/2] 1257 1258``` 1259typedef struct ArkUI_NodeEventArkUI_NodeEvent 1260``` 1261**Description** 1262 1263Defines the common structure of a component event. 1264 1265**Since**: 12 1266 1267 1268### ArkUI_NodeHandle 1269 1270``` 1271typedef struct ArkUI_Node* ArkUI_NodeHandle 1272``` 1273**Description** 1274 1275Defines the pointer to the ArkUI native component object. 1276 1277**Since**: 12 1278 1279 1280### ArkUI_OnWillDismissEvent 1281 1282``` 1283typedef bool(* ArkUI_OnWillDismissEvent) (int32_t reason) 1284``` 1285**Description** 1286 1287Defines a pointer to the callback invoked when the dialog box is closed. 1288 1289**Since**: 12 1290 1291 1292### ArkUI_ParallelInnerGestureEvent 1293 1294``` 1295typedef struct ArkUI_ParallelInnerGestureEvent ArkUI_ParallelInnerGestureEvent 1296``` 1297**Description** 1298 1299Defines a parallel internal gesture event. 1300 1301**Since**: 12 1302 1303 1304### ArkUI_StyledString 1305 1306``` 1307typedef struct ArkUI_StyledString ArkUI_StyledString 1308``` 1309**Description** 1310 1311Defines a struct for the styled string object supported by the text component. 1312 1313**Since**: 12 1314 1315 1316### ArkUI_StyledString_Descriptor 1317 1318``` 1319typedef struct ArkUI_StyledString_Descriptor ArkUI_StyledString_Descriptor 1320``` 1321**Description** 1322 1323Defines a struct for the styled string descriptor object supported by the text component. 1324 1325**Since**: 14 1326 1327 1328### ArkUI_SwiperIndicator 1329 1330``` 1331typedef struct ArkUI_SwiperIndicator ArkUI_SwiperIndicator 1332``` 1333**Description** 1334 1335Defines the navigation point indicator style of the **Swiper** component. 1336 1337**Since**: 12 1338 1339 1340### ArkUI_SystemFontStyleEvent 1341 1342``` 1343typedef struct ArkUI_SystemFontStyleEvent ArkUI_SystemFontStyleEvent 1344``` 1345**Description** 1346 1347Defines a struct for the system font style event. 1348 1349**Since**: 12 1350 1351 1352### ArkUI_TransitionEffect 1353 1354``` 1355typedef struct ArkUI_TransitionEffect ArkUI_TransitionEffect 1356``` 1357**Description** 1358 1359Defines a struct for the transition effect. 1360 1361**Since**: 12 1362 1363 1364### ArkUI_WaterFlowSectionOption 1365 1366``` 1367typedef struct ArkUI_WaterFlowSectionOption ArkUI_WaterFlowSectionOption 1368``` 1369**Description** 1370 1371Defines the water flow section configuration. 1372 1373**Since**: 12 1374 1375 1376### OH_PixelmapNative 1377 1378``` 1379typedef struct OH_PixelmapNative OH_PixelmapNative 1380``` 1381**Description** 1382 1383Defines the **Pixelmap** struct, which is used to perform operations related to a pixel map. 1384 1385**Since**: 12 1386 1387 1388### OH_PixelmapNativeHandle 1389 1390``` 1391typedef struct OH_PixelmapNative* OH_PixelmapNativeHandle 1392``` 1393**Description** 1394 1395Defines a struct for the pointer to an **OH_PixelmapNative** object. 1396 1397**Since**: 12 1398 1399 1400### OH_UdmfData 1401 1402``` 1403typedef struct OH_UdmfData OH_UdmfData 1404``` 1405**Description** 1406 1407Defines a struct for UDMF unified data. 1408 1409**Since**: 12 1410 1411 1412## Enum Description 1413 1414 1415### ArkUI_AccessibilityActionType 1416 1417``` 1418enum ArkUI_AccessibilityActionType 1419``` 1420**Description** 1421 1422Defines an enum for the accessibility action types. 1423 1424**Since**: 12 1425 1426| Enum| Description| 1427| -------- | -------- | 1428| ARKUI_ACCESSIBILITY_ACTION_CLICK | Tapping. | 1429| ARKUI_ACCESSIBILITY_ACTION_LONG_CLICK | Long press. | 1430| ARKUI_ACCESSIBILITY_ACTION_CUT | Cut. | 1431| ARKUI_ACCESSIBILITY_ACTION_COPY | Copy. | 1432| ARKUI_ACCESSIBILITY_ACTION_PASTE | Paste. | 1433 1434 1435### ArkUI_AccessibilityCheckedState 1436 1437``` 1438enum ArkUI_AccessibilityCheckedState 1439``` 1440**Description** 1441 1442Enumerates the accessibility check box states. 1443 1444**Since**: 12 1445 1446| Enum| Description| 1447| -------- | -------- | 1448| ARKUI_ACCESSIBILITY_UNCHECKED | The check box is not selected. | 1449| ARKUI_ACCESSIBILITY_CHECKED | The check box is selected. | 1450 1451 1452### ArkUI_AccessibilityMode 1453 1454``` 1455enum ArkUI_AccessibilityMode 1456``` 1457**Description** 1458 1459Enumerates the accessibility modes. 1460 1461**Since**: 12 1462 1463| Enum| Description| 1464| -------- | -------- | 1465| ARKUI_ACCESSIBILITY_MODE_AUTO | The mode is automatically set to enabled or disabled based on the component. | 1466| ARKUI_ACCESSIBILITY_MODE_ENABLED | The component can be identified by the accessibility service. | 1467| ARKUI_ACCESSIBILITY_MODE_DISABLED | The component cannot be identified by the accessibility service. | 1468| ARKUI_ACCESSIBILITY_MODE_DISABLED_FOR_DESCENDANTS | The component and all its child components cannot be identified by the accessibility service. | 1469 1470 1471### ArkUI_AdaptiveColor 1472 1473``` 1474enum ArkUI_AdaptiveColor 1475``` 1476**Description** 1477 1478Enumerates the adaptive color modes. 1479 1480**Since**: 12 1481 1482| Enum| Description| 1483| -------- | -------- | 1484| ARKUI_ADAPTIVE_COLOR_DEFAULT | Adaptive color mode is not used. | 1485| ARKUI_ADAPTIVE_COLOR_AVERAGE | Adaptive color mode is used. | 1486 1487 1488### ArkUI_Alignment 1489 1490``` 1491enum ArkUI_Alignment 1492``` 1493**Description** 1494 1495Enumerates the alignment modes. 1496 1497**Since**: 12 1498 1499| Enum| Description| 1500| -------- | -------- | 1501| ARKUI_ALIGNMENT_TOP_START | Top start. | 1502| ARKUI_ALIGNMENT_TOP | Top center. | 1503| ARKUI_ALIGNMENT_TOP_END | Top end. | 1504| ARKUI_ALIGNMENT_START | Vertically centered start. | 1505| ARKUI_ALIGNMENT_CENTER | Horizontally and vertically centered. | 1506| ARKUI_ALIGNMENT_END | Vertically centered end. | 1507| ARKUI_ALIGNMENT_BOTTOM_START | Bottom start. | 1508| ARKUI_ALIGNMENT_BOTTOM | Horizontally centered on the bottom. | 1509| ARKUI_ALIGNMENT_BOTTOM_END | Bottom end. | 1510 1511 1512### ArkUI_AnimationCurve 1513 1514``` 1515enum ArkUI_AnimationCurve 1516``` 1517**Description** 1518 1519Enumerates the animation curves. 1520 1521**Since**: 12 1522 1523| Enum| Description| 1524| -------- | -------- | 1525| ARKUI_CURVE_LINEAR | The animation speed keeps unchanged. | 1526| ARKUI_CURVE_EASE | The animation starts slowly, accelerates, and then slows down towards the end. | 1527| ARKUI_CURVE_EASE_IN | The animation starts at a low speed and then picks up speed until the end. | 1528| ARKUI_CURVE_EASE_OUT | The animation ends at a low speed. | 1529| ARKUI_CURVE_EASE_IN_OUT | The animation starts and ends at a low speed. | 1530| ARKUI_CURVE_FAST_OUT_SLOW_IN | The animation uses the standard curve | 1531| ARKUI_CURVE_LINEAR_OUT_SLOW_IN | The animation uses the deceleration curve. | 1532| ARKUI_CURVE_FAST_OUT_LINEAR_IN | The animation uses the acceleration curve. | 1533| ARKUI_CURVE_EXTREME_DECELERATION | The animation uses the extreme deceleration curve. | 1534| ARKUI_CURVE_SHARP | The animation uses the sharp curve. | 1535| ARKUI_CURVE_RHYTHM | The animation uses the rhythm curve. | 1536| ARKUI_CURVE_SMOOTH | The animation uses the smooth curve. | 1537| ARKUI_CURVE_FRICTION | The animation uses the friction curve | 1538 1539 1540### ArkUI_AnimationDirection 1541 1542``` 1543enum ArkUI_AnimationDirection 1544``` 1545**Description** 1546 1547Enumerates the animation playback modes. 1548 1549**Since**: 12 1550 1551| Enum| Description| 1552| -------- | -------- | 1553| ARKUI_ANIMATION_DIRECTION_NORMAL | The animation plays in forward loop mode. | 1554| ARKUI_ANIMATION_DIRECTION_REVERSE | The animation plays in reverse loop mode. | 1555| 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. | 1556| 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. | 1557 1558 1559### ArkUI_AnimationFill 1560 1561``` 1562enum ArkUI_AnimationFill 1563``` 1564**Description** 1565 1566Enumerates the state of the animated target after the animation is executed. 1567 1568**Since**: 12 1569 1570| Enum| Description| 1571| -------- | -------- | 1572| ARKUI_ANIMATION_FILL_NONE | No style is applied to the target before or after the animation is executed. | 1573| 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. | 1574| ARKUI_ANIMATION_FILL_BACKWARDS | The animation uses the value defined in the first key frame during the duration defined by **animation-delay**. | 1575| ARKUI_ANIMATION_FILL_BOTH | The animation follows the **forwards** and **backwards** rules. | 1576 1577 1578### ArkUI_AnimationFillMode 1579 1580``` 1581enum ArkUI_AnimationFillMode 1582``` 1583**Description** 1584 1585Enumerates the states before and after execution of the frame-by-frame animation. 1586 1587**Since**: 12 1588 1589| Enum| Description| 1590| -------- | -------- | 1591| 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. | 1592| ARKUI_ANIMATION_FILL_MODE_FORWARDS | The target component retains the state set by the last keyframe encountered during execution of the animation. | 1593| 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**. | 1594| ARKUI_ANIMATION_FILL_MODE_BOTH | The animation follows the rules for both **Forwards** and **Backwards**, extending the animation attributes in both directions. | 1595 1596 1597### ArkUI_AnimationPlayMode 1598 1599``` 1600enum ArkUI_AnimationPlayMode 1601``` 1602**Description** 1603 1604Enumerates the animation playback modes. 1605 1606**Since**: 12 1607 1608| Enum| Description| 1609| -------- | -------- | 1610| ARKUI_ANIMATION_PLAY_MODE_NORMAL | The animation is played forwards. | 1611| ARKUI_ANIMATION_PLAY_MODE_REVERSE | The animation is played backwards. | 1612| 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...). | 1613| 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...). | 1614 1615 1616### ArkUI_AnimationStatus 1617 1618``` 1619enum ArkUI_AnimationStatus 1620``` 1621**Description** 1622 1623Enumerates the playback states of the frame-by-frame animation. 1624 1625**Since**: 12 1626 1627| Enum| Description| 1628| -------- | -------- | 1629| ARKUI_ANIMATION_STATUS_INITIAL | The animation is in the initial state. | 1630| ARKUI_ANIMATION_STATUS_RUNNING | The animation is being played. | 1631| ARKUI_ANIMATION_STATUS_PAUSED | The animation is paused. | 1632| ARKUI_ANIMATION_STATUS_STOPPED | The animation is stopped. | 1633 1634 1635### ArkUI_Axis 1636 1637``` 1638enum ArkUI_Axis 1639``` 1640**Description** 1641 1642Enumerates the scroll directions. 1643 1644**Since**: 12 1645 1646| Enum| Description| 1647| -------- | -------- | 1648| ARKUI_AXIS_VERTICAL | Only vertical scrolling is supported. | 1649| ARKUI_AXIS_HORIZONTAL | Only horizontal scrolling is supported. | 1650 1651 1652### ArkUI_BarrierDirection 1653 1654``` 1655enum ArkUI_BarrierDirection 1656``` 1657**Description** 1658 1659Enumerates the barrier directions. 1660 1661**Since**: 12 1662 1663| Enum| Description| 1664| -------- | -------- | 1665| ARKUI_BARRIER_DIRECTION_START | The barrier is on the left side of all the referenced components specified by referencedId. | 1666| ARKUI_BARRIER_DIRECTION_END | The barrier is on the right side of all the referenced components specified by referencedId. | 1667| ARKUI_BARRIER_DIRECTION_TOP | The barrier is at the top of all the referenced components specified by referencedId. | 1668| ARKUI_BARRIER_DIRECTION_BOTTOM | The barrier is at the bottom of all the referenced components specified by referencedId. | 1669 1670 1671### ArkUI_BlendApplyType 1672 1673``` 1674enum ArkUI_BlendApplyType 1675``` 1676**Description** 1677 1678Defines how the specified blend mode is applied. 1679 1680**Since**: 12 1681 1682| Enum| Description| 1683| -------- | -------- | 1684| BLEND_APPLY_TYPE_FAST | The content of the view is blended in sequence on the target image. | 1685| 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. | 1686 1687 1688### ArkUI_BlendMode 1689 1690``` 1691enum ArkUI_BlendMode 1692``` 1693**Description** 1694 1695Enumerates the blend modes. 1696 1697**Since**: 12 1698 1699| Enum| Description| 1700| -------- | -------- | 1701| ARKUI_BLEND_MODE_NONE | The top image is superimposed on the bottom image without any blending. | 1702| ARKUI_BLEND_MODE_CLEAR | The target pixels covered by the source pixels are erased by being turned to completely transparent. | 1703| ARKUI_BLEND_MODE_SRC | r = s: Only the source pixels are displayed. | 1704| ARKUI_BLEND_MODE_DST | r = d: Only the target pixels are displayed. | 1705| ARKUI_BLEND_MODE_SRC_OVER | r = s + (1 - sa) \d: The source pixels are blended based on opacity and cover the target pixels. | 1706| ARKUI_BLEND_MODE_DST_OVER | r = d + (1 - da) *\ s: The target pixels are blended based on opacity and cover on the source pixels. | 1707| ARKUI_BLEND_MODE_SRC_IN | r = s \* da: Only the part of the source pixels that overlap with the target pixels is displayed. | 1708| ARKUI_BLEND_MODE_DST_IN | r = d \* sa: Only the part of the target pixels that overlap with the source pixels is displayed. | 1709| 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. | 1710| 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. | 1711| 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. | 1712| 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. | 1713| 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. | 1714| ARKUI_BLEND_MODE_PLUS | r = min(s + d, 1): New pixels resulting from adding the source pixels to the target pixels are displayed. | 1715| ARKUI_BLEND_MODE_MODULATE | r = s \* d: New pixels resulting from multiplying the source pixels with the target pixels are displayed. | 1716| 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. | 1717| ARKUI_BLEND_MODE_OVERLAY | The MULTIPLY or SCREEN mode is used based on the target pixels. | 1718| ARKUI_BLEND_MODE_DARKEN | rc = s + d - max(s \da, d \sa), ra = kSrcOver: When two colors overlap, whichever is darker is used. | 1719| ARKUI_BLEND_MODE_LIGHTEN | rc = s + d - min(s \da, d \sa), ra = kSrcOver: The darker of the pixels (source and target) is used. | 1720| ARKUI_BLEND_MODE_COLOR_DODGE | The colors of the target pixels are lightened to reflect the source pixels. | 1721| ARKUI_BLEND_MODE_COLOR_BURN | The colors of the target pixels are darkened to reflect the source pixels. | 1722| ARKUI_BLEND_MODE_HARD_LIGHT | The MULTIPLY or SCREEN mode is used, depending on the source pixels. | 1723| ARKUI_BLEND_MODE_SOFT_LIGHT | The LIGHTEN or DARKEN mode is used, depending on the source pixels. | 1724| 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. | 1725| ARKUI_BLEND_MODE_EXCLUSION | rc = s + d - two(s \* d), ra = kSrcOver: The final pixel is similar to **DIFFERENCE**, but with less contrast. | 1726| 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.| 1727| 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. | 1728| 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. | 1729| 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. | 1730| 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. | 1731 1732 1733### ArkUI_BlurStyle 1734 1735``` 1736enum ArkUI_BlurStyle 1737``` 1738**Description** 1739 1740Enumerates the blur styles. 1741 1742**Since**: 12 1743 1744| Enum| Description| 1745| -------- | -------- | 1746| ARKUI_BLUR_STYLE_THIN | Thin material. | 1747| ARKUI_BLUR_STYLE_REGULAR | Regular material. | 1748| ARKUI_BLUR_STYLE_THICK | Thick material. | 1749| ARKUI_BLUR_STYLE_BACKGROUND_THIN | Material that creates the minimum depth of field effect. | 1750| ARKUI_BLUR_STYLE_BACKGROUND_REGULAR | Material that creates a medium shallow depth of field effect. | 1751| ARKUI_BLUR_STYLE_BACKGROUND_THICK | Material that creates a high shallow depth of field effect. | 1752| ARKUI_BLUR_STYLE_BACKGROUND_ULTRA_THICK | Material that creates the maximum depth of field effect. | 1753| ARKUI_BLUR_STYLE_NONE | No blur. | 1754| ARKUI_BLUR_STYLE_COMPONENT_ULTRA_THIN | Component ultra-thin material. | 1755| ARKUI_BLUR_STYLE_COMPONENT_THIN | Component thin material. | 1756| ARKUI_BLUR_STYLE_COMPONENT_REGULAR | Component regular material. | 1757| ARKUI_BLUR_STYLE_COMPONENT_THICK | Component thick material. | 1758| ARKUI_BLUR_STYLE_COMPONENT_ULTRA_THICK | Component ultra-thick material. | 1759 1760 1761### ArkUI_BorderStyle 1762 1763``` 1764enum ArkUI_BorderStyle 1765``` 1766**Description** 1767 1768Enumerates the border styles. 1769 1770**Since**: 12 1771 1772| Enum| Description| 1773| -------- | -------- | 1774| ARKUI_BORDER_STYLE_SOLID | Solid border. | 1775| ARKUI_BORDER_STYLE_DASHED | Dashed border. | 1776| ARKUI_BORDER_STYLE_DOTTED | Dotted border. | 1777 1778 1779### ArkUI_ButtonType 1780 1781``` 1782enum ArkUI_ButtonType 1783``` 1784**Description** 1785 1786Enumerates the button types. 1787 1788**Since**: 12 1789 1790| Enum| Description| 1791| -------- | -------- | 1792| ARKUI_BUTTON_TYPE_NORMAL | Normal button (without rounded corners by default). | 1793| ARKUI_BUTTON_TYPE_CAPSULE | Capsule-type button (the round corner is half of the height by default). | 1794| ARKUI_BUTTON_TYPE_CIRCLE | Circle button. | 1795 1796 1797### ArkUI_CalendarAlignment 1798 1799``` 1800enum ArkUI_CalendarAlignment 1801``` 1802**Description** 1803 1804Enumerates the alignment modes between the calendar picker and the entry component. 1805 1806**Since**: 12 1807 1808| Enum| Description| 1809| -------- | -------- | 1810| ARKUI_CALENDAR_ALIGNMENT_START | Left aligned. | 1811| ARKUI_CALENDAR_ALIGNMENT_CENTER | Center aligned. | 1812| ARKUI_CALENDAR_ALIGNMENT_END | Right aligned. | 1813 1814 1815### ArkUI_CancelButtonStyle 1816 1817``` 1818enum ArkUI_CancelButtonStyle 1819``` 1820**Description** 1821 1822Enumerates the styles of the Cancel button. 1823 1824**Since**: 12 1825 1826| Enum| Description| 1827| -------- | -------- | 1828| ARKUI_CANCELBUTTON_STYLE_CONSTANT | The Cancel button is always displayed. | 1829| ARKUI_CANCELBUTTON_STYLE_INVISIBLE | The Cancel button is always hidden. | 1830| ARKUI_CANCELBUTTON_STYLE_INPUT | The Cancel button is displayed when there is text input. | 1831 1832 1833### ArkUI_CheckboxShape 1834 1835``` 1836enum ArkUI_CheckboxShape 1837``` 1838**Description** 1839 1840Enumerates the shapes of the check box. 1841 1842**Since**: 12 1843 1844| Enum| Description| 1845| -------- | -------- | 1846| ArkUI_CHECKBOX_SHAPE_CIRCLE | Circle. | 1847| ArkUI_CHECKBOX_SHAPE_ROUNDED_SQUARE | Rounded square. | 1848 1849 1850### ArkUI_ClipType 1851 1852``` 1853enum ArkUI_ClipType 1854``` 1855**Description** 1856 1857Enumerates the clipping region types. 1858 1859**Since**: 12 1860 1861| Enum| Description| 1862| -------- | -------- | 1863| ARKUI_CLIP_TYPE_RECTANGLE | Rectangle. | 1864| ARKUI_CLIP_TYPE_CIRCLE | **(circle)** | 1865| ARKUI_CLIP_TYPE_ELLIPSE | Ellipse. | 1866| ARKUI_CLIP_TYPE_PATH | Path Type | 1867 1868 1869### ArkUI_ColorMode 1870 1871``` 1872enum ArkUI_ColorMode 1873``` 1874**Description** 1875 1876Enumerates the color modes. 1877 1878**Since**: 12 1879 1880| Enum| Description| 1881| -------- | -------- | 1882| ARKUI_COLOR_MODE_SYSTEM | Following the system color mode. | 1883| ARKUI_COLOR_MODE_LIGHT | Light color mode. | 1884| ARKUI_COLOR_MODE_DARK | Dark color mode. | 1885 1886 1887### ArkUI_ColorStrategy 1888 1889``` 1890enum ArkUI_ColorStrategy 1891``` 1892**Description** 1893 1894Enumerates the foreground colors. 1895 1896**Since**: 12 1897 1898| Enum| Description| 1899| -------- | -------- | 1900| ARKUI_COLOR_STRATEGY_INVERT | The foreground colors are the inverse of the component background colors. | 1901| ARKUI_COLOR_STRATEGY_AVERAGE | The shadow colors of the component are the average color obtained from the component background shadow area. | 1902| ARKUI_COLOR_STRATEGY_PRIMARY | The shadow colors of the component are the primary color obtained from the component background shadow area. | 1903 1904 1905### ArkUI_CopyOptions 1906 1907``` 1908enum ArkUI_CopyOptions 1909``` 1910**Description** 1911 1912Enumerates the text copy and paste modes. 1913 1914**Since**: 12 1915 1916| Enum| Description| 1917| -------- | -------- | 1918| ARKUI_COPY_OPTIONS_NONE | Copy is not allowed. | 1919| ARKUI_COPY_OPTIONS_IN_APP | Intra-application copy is allowed. | 1920| ARKUI_COPY_OPTIONS_LOCAL_DEVICE | Intra-device copy is allowed. | 1921| ARKUI_COPY_OPTIONS_CROSS_DEVICE | Cross-device copy is allowed. | 1922 1923 1924### ArkUI_Direction 1925 1926``` 1927enum ArkUI_Direction 1928``` 1929**Description** 1930 1931Enumerates the modes in which components are laid out along the main axis of the container. 1932 1933**Since**: 12 1934 1935| Enum| Description| 1936| -------- | -------- | 1937| ARKUI_DIRECTION_LTR | Components are arranged from left to right. | 1938| ARKUI_DIRECTION_RTL | Components are arranged from right to left. | 1939| ARKUI_DIRECTION_AUTO | The default layout direction is used. | 1940 1941 1942### ArkUI_DismissReason 1943 1944``` 1945enum ArkUI_DismissReason 1946``` 1947**Description** 1948 1949Enumerates the actions for triggering closure of the dialog box. 1950 1951**Since**: 12 1952 1953| Enum| Description| 1954| -------- | -------- | 1955| DIALOG_DISMISS_BACK_PRESS | Touching the system-defined Back button or pressing the Esc key. | 1956| DIALOG_DISMISS_TOUCH_OUTSIDE | Touching the mask. | 1957| DIALOG_DISMISS_CLOSE_BUTTON | Touching the Close button. | 1958| DIALOG_DISMISS_SLIDE_DOWN | Sliding down. | 1959 1960 1961### ArkUI_DragPreviewScaleMode 1962 1963``` 1964enum ArkUI_DragPreviewScaleMode 1965``` 1966**Description** 1967 1968Defines an enum for drag preview scale modes. 1969 1970**Since**: 12 1971 1972| Enum| Description| 1973| -------- | -------- | 1974| 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. | 1975| ARKUI_DRAG_PREVIEW_SCALE_DISABLED | The system does not scale the drag preview. | 1976 1977 1978### ArkUI_DragResult 1979 1980``` 1981enum ArkUI_DragResult 1982``` 1983**Description** 1984 1985Defines 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. 1986 1987**Since**: 12 1988 1989| Enum| Description| 1990| -------- | -------- | 1991| ARKUI_DRAG_RESULT_SUCCESSFUL | The drag and drop operation succeeded. | 1992| ARKUI_DRAG_RESULT_FAILED | The drag and drop operation failed. | 1993| ARKUI_DRAG_RESULT_CANCELED | The drag and drop operation was canceled. | 1994 1995 1996### ArkUI_DragStatus 1997 1998``` 1999enum ArkUI_DragStatus 2000``` 2001**Description** 2002 2003Enumerates dragging states. 2004 2005**Since**: 12 2006 2007| Enum| Description| 2008| -------- | -------- | 2009| ArkUI_DRAG_STATUS_UNKNOWN | Unknown. | 2010| ArkUI_DRAG_STATUS_STARTED | Started. | 2011| ArkUI_DRAG_STATUS_ENDED | Ended. | 2012 2013 2014### ArkUI_DropProposal 2015 2016``` 2017enum ArkUI_DropProposal 2018``` 2019**Description** 2020 2021Defines an enum for data processing modes used when data is dropped, which affects the display of the badge. 2022 2023**Since**: 12 2024 2025| Enum| Description| 2026| -------- | -------- | 2027| ARKUI_DROP_PROPOSAL_COPY | Copy. | 2028| ARKUI_DROP_PROPOSAL_MOVE | Cut. | 2029 2030 2031### ArkUI_EdgeEffect 2032 2033``` 2034enum ArkUI_EdgeEffect 2035``` 2036**Description** 2037 2038Enumerates the effects used at the edges of the component when the boundary of the scrollable content is reached. 2039 2040**Since**: 12 2041 2042| Enum| Description| 2043| -------- | -------- | 2044| 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. | 2045| ARKUI_EDGE_EFFECT_FADE | Fade effect. When at one of the edges, the component produces a fade effect. | 2046| ARKUI_EDGE_EFFECT_NONE | No effect when the component is at one of the edges. | 2047 2048 2049### ArkUI_EllipsisMode 2050 2051``` 2052enum ArkUI_EllipsisMode 2053``` 2054**Description** 2055 2056Enumerates the ellipsis positions. 2057 2058**Since**: 12 2059 2060| Enum| Description| 2061| -------- | -------- | 2062| ARKUI_ELLIPSIS_MODE_START | An ellipsis is used at the start of the line of text. | 2063| ARKUI_ELLIPSIS_MODE_CENTER | An ellipsis is used at the center of the line of text. | 2064| ARKUI_ELLIPSIS_MODE_END | An ellipsis is used at the end of the line of text. | 2065 2066 2067### ArkUI_EnterKeyType 2068 2069``` 2070enum ArkUI_EnterKeyType 2071``` 2072**Description** 2073 2074Enumerates the types of the Enter key for a single-line text box. 2075 2076**Since**: 12 2077 2078| Enum| Description| 2079| -------- | -------- | 2080| ARKUI_ENTER_KEY_TYPE_GO | The Enter key is labeled "Go." | 2081| ARKUI_ENTER_KEY_TYPE_SEARCH | The Enter key is labeled "Search." | 2082| ARKUI_ENTER_KEY_TYPE_SEND | The Enter key is labeled "Send." | 2083| ARKUI_ENTER_KEY_TYPE_NEXT | The Enter key is labeled "Next." | 2084| ARKUI_ENTER_KEY_TYPE_DONE | The Enter key is labeled "Done." | 2085| ARKUI_ENTER_KEY_TYPE_PREVIOUS | The Enter key is labeled "Previous." | 2086| ARKUI_ENTER_KEY_TYPE_NEW_LINE | The Enter key is labeled "Return." | 2087 2088 2089### ArkUI_ErrorCode 2090 2091``` 2092enum ArkUI_ErrorCode 2093``` 2094**Description** 2095 2096Defines an enum for the error codes. 2097 2098**Since**: 12 2099 2100| Enum| Description| 2101| -------- | -------- | 2102| ARKUI_ERROR_CODE_NO_ERROR | No error. | 2103| ARKUI_ERROR_CODE_PARAM_INVALID | Parameter error. | 2104| ARKUI_ERROR_CODE_ATTRIBUTE_OR_EVENT_NOT_SUPPORTED | The component does not support specific attributes or events. | 2105| ARKUI_ERROR_CODE_NOT_SUPPROTED_FOR_ARKTS_NODE | The specific operation is not allowed on the node created by ArkTS. | 2106| ARKUI_ERROR_CODE_NODE_ADAPTER_NONE_HOST | The adapter for lazy loading is not bound to the component. | 2107| ARKUI_ERROR_CODE_NODE_ADAPTER_EXIST_IN_HOST | The adapter already exists. | 2108| ARKUI_ERROR_CODE_NODE_ADAPTER_CHILD_NODE_EXIST | Failed to add the adapter because the corresponding node already has a subnode. | 2109| ARKUI_ERROR_CODE_NODE_EVENT_PARAM_INDEX_OUT_OF_RANGE | The parameter length in the parameter event exceeds the limit. | 2110| ARKUI_ERROR_CODE_NODE_EVENT_PARAM_INVALID | The data does not exist in the component event. | 2111| ARKUI_ERROR_CODE_NODE_EVENT_NO_RETURN | The component event does not support return values. | 2112| ARKUI_ERROR_CODE_NODE_INDEX_INVALID | Invalid index. | 2113| ARKUI_ERROR_CODE_GET_INFO_FAILED | Failed to obtain the route navigation information. | 2114| ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR | Buffer size error. | 2115| ARKUI_ERROR_CODE_NON_SCROLLABLE_CONTAINER | The component is not a scrollable container. | 2116| ARKUI_ERROR_CODE_BUFFER_SIZE_NOT_ENOUGH | The buffer is not large enough. | 2117| ARKUI_ERROR_CODE_INVALID_STYLED_STRING | Invalid styled string. | 2118 2119 2120### ArkUI_FinishCallbackType 2121 2122``` 2123enum ArkUI_FinishCallbackType 2124``` 2125**Description** 2126 2127Enumerates the animation **onFinish** callback types. 2128 2129**Since**: 12 2130 2131| Enum| Description| 2132| -------- | -------- | 2133| ARKUI_FINISH_CALLBACK_REMOVED | The callback is invoked when the entire animation is removed once it has finished. | 2134| 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. | 2135 2136 2137### ArkUI_FlexAlignment 2138 2139``` 2140enum ArkUI_FlexAlignment 2141``` 2142**Description** 2143 2144Enumerates the vertical alignment modes. 2145 2146**Since**: 12 2147 2148| Enum| Description| 2149| -------- | -------- | 2150| ARKUI_FLEX_ALIGNMENT_START | The child components are aligned with the start edge of the main axis. | 2151| ARKUI_FLEX_ALIGNMENT_CENTER | The child components are aligned in the center of the main axis. | 2152| ARKUI_FLEX_ALIGNMENT_END | The child components are aligned with the end edge of the main axis. | 2153| 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. | 2154| 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. | 2155| 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. | 2156 2157 2158### ArkUI_FlexDirection 2159 2160``` 2161enum ArkUI_FlexDirection 2162``` 2163**Description** 2164 2165Enumerates the directions of the main axis in the flex container. 2166 2167**Since**: 12 2168 2169| Enum| Description| 2170| -------- | -------- | 2171| ARKUI_FLEX_DIRECTION_ROW | The child components are arranged in the same direction as the main axis runs along the rows. | 2172| ARKUI_FLEX_DIRECTION_COLUMN | The child components are arranged in the same direction as the main axis runs down the columns. | 2173| ARKUI_FLEX_DIRECTION_ROW_REVERSE | The child components are arranged opposite to the **ROW** direction. | 2174| ARKUI_FLEX_DIRECTION_COLUMN_REVERSE | The child components are arranged opposite to the **COLUMN** direction. | 2175 2176 2177### ArkUI_FlexWrap 2178 2179``` 2180enum ArkUI_FlexWrap 2181``` 2182**Description** 2183 2184Defines whether the flex container has a single line or multiple lines. 2185 2186**Since**: 12 2187 2188| Enum| Description| 2189| -------- | -------- | 2190| ARKUI_FLEX_WRAP_NO_WRAP | The child components in the flex container are arranged in a single line, and they cannot overflow. | 2191| ARKUI_FLEX_WRAP_WRAP | The child components in the flex container are arranged in multiple lines, and they may overflow. | 2192| ARKUI_FLEX_WRAP_WRAP_REVERSE | The child components in the flex container are reversely arranged in multiple lines, and they may overflow. | 2193 2194 2195### ArkUI_FontStyle 2196 2197``` 2198enum ArkUI_FontStyle 2199``` 2200**Description** 2201 2202Enumerates the font styles. 2203 2204**Since**: 12 2205 2206| Enum| Description| 2207| -------- | -------- | 2208| ARKUI_FONT_STYLE_NORMAL | Standard font style. | 2209| ARKUI_FONT_STYLE_ITALIC | Italic font style. | 2210 2211 2212### ArkUI_FontWeight 2213 2214``` 2215enum ArkUI_FontWeight 2216``` 2217**Description** 2218 2219Enumerates the font weights. 2220 2221**Since**: 12 2222 2223| Enum| Description| 2224| -------- | -------- | 2225| ARKUI_FONT_WEIGHT_W100 | 100 | 2226| ARKUI_FONT_WEIGHT_W200 | 200 | 2227| ARKUI_FONT_WEIGHT_W300 | 300 | 2228| ARKUI_FONT_WEIGHT_W400 | 400 | 2229| ARKUI_FONT_WEIGHT_W500 | 500 | 2230| ARKUI_FONT_WEIGHT_W600 | 600 | 2231| ARKUI_FONT_WEIGHT_W700 | 700 | 2232| ARKUI_FONT_WEIGHT_W800 | 800 | 2233| ARKUI_FONT_WEIGHT_W900 | 900 | 2234| ARKUI_FONT_WEIGHT_BOLD | The font weight is bold. | 2235| ARKUI_FONT_WEIGHT_NORMAL | The font weight is normal. | 2236| ARKUI_FONT_WEIGHT_BOLDER | The font weight is bolder. | 2237| ARKUI_FONT_WEIGHT_LIGHTER | The font weight is lighter. | 2238| ARKUI_FONT_WEIGHT_MEDIUM | The font weight is medium. | 2239| ARKUI_FONT_WEIGHT_REGULAR | The font weight is normal. | 2240 2241### ArkUI_GestureDirection 2242 2243``` 2244enum ArkUI_GestureDirection 2245``` 2246**Description** 2247 2248Enumerates gesture directions. 2249 2250**Since**: 12 2251 2252| Enum| Description| 2253| -------- | -------- | 2254| GESTURE_DIRECTION_ALL | All directions. | 2255| GESTURE_DIRECTION_HORIZONTAL | Horizontal direction. | 2256| GESTURE_DIRECTION_VERTICAL | Vertical direction. | 2257| GESTURE_DIRECTION_LEFT | Leftward. | 2258| GESTURE_DIRECTION_RIGHT | Rightward. | 2259| GESTURE_DIRECTION_UP | Upward. | 2260| GESTURE_DIRECTION_DOWN | Downward. | 2261| GESTURE_DIRECTION_NONE | None. | 2262 2263 2264### ArkUI_GestureEventActionType 2265 2266``` 2267enum ArkUI_GestureEventActionType 2268``` 2269**Description** 2270 2271Enumerates gesture event types. 2272 2273**Since**: 12 2274 2275| Enum| Description| 2276| -------- | -------- | 2277| GESTURE_EVENT_ACTION_ACCEPT | Triggered. | 2278| GESTURE_EVENT_ACTION_UPDATE | Updated. | 2279| GESTURE_EVENT_ACTION_END | Ended. | 2280| GESTURE_EVENT_ACTION_CANCEL | Canceled. | 2281 2282 2283### ArkUI_GestureInterruptResult 2284 2285``` 2286enum ArkUI_GestureInterruptResult 2287``` 2288**Description** 2289 2290Enumerates gesture interruption results. 2291 2292**Since**: 12 2293 2294| Enum| Description| 2295| -------- | -------- | 2296| GESTURE_INTERRUPT_RESULT_CONTINUE | The gesture recognition process continues. | 2297| GESTURE_INTERRUPT_RESULT_REJECT | The gesture recognition process is paused. | 2298 2299 2300### ArkUI_GestureMask 2301 2302``` 2303enum ArkUI_GestureMask 2304``` 2305**Description** 2306 2307Enumerates gesture masking modes. 2308 2309**Since**: 12 2310 2311| Enum| Description| 2312| -------- | -------- | 2313| NORMAL_GESTURE_MASK | The gestures of child components are enabled and recognized based on the default gesture recognition sequence. | 2314| IGNORE_INTERNAL_GESTURE_MASK | The gestures of child components are disabled, including the built-in gestures. | 2315 2316 2317### ArkUI_GesturePriority 2318 2319``` 2320enum ArkUI_GesturePriority 2321``` 2322**Description** 2323 2324Enumerates gesture event modes. 2325 2326**Since**: 12 2327 2328| Enum| Description| 2329| -------- | -------- | 2330| NORMAL | Normal. | 2331| PRIORITY | High-priority. | 2332| PARALLEL | Parallel. | 2333 2334 2335### ArkUI_GestureRecognizerState 2336 2337``` 2338enum ArkUI_GestureRecognizerState 2339``` 2340**Description** 2341 2342Enumerates the gesture recognizer states. 2343 2344**Since**: 12 2345 2346| Enum| Description| 2347| -------- | -------- | 2348| ARKUI_GESTURE_RECOGNIZER_STATE_REDAY | Prepared. | 2349| ARKUI_GESTURE_RECOGNIZER_STATE_DETECTING | Check status. | 2350| ARKUI_GESTURE_RECOGNIZER_STATE_PENDING | Waiting | 2351| ARKUI_GESTURE_RECOGNIZER_STATE_BLOCKED | Blocked. | 2352| ARKUI_GESTURE_RECOGNIZER_STATE_SUCCESSFUL | (Success status) | 2353| ARKUI_GESTURE_RECOGNIZER_STATE_FAILED | Failed. | 2354 2355 2356### ArkUI_GestureRecognizerType 2357 2358``` 2359enum ArkUI_GestureRecognizerType 2360``` 2361**Description** 2362 2363Enumerates gesture recognizer types. 2364 2365**Since**: 12 2366 2367| Enum| Description| 2368| -------- | -------- | 2369| TAP_GESTURE | Tap. | 2370| LONG_PRESS_GESTURE | Long press gesture. | 2371| PAN_GESTURE | Pan gesture. | 2372| PINCH_GESTURE | Pinch gesture. | 2373| ROTATION_GESTURE | Rotation gesture. | 2374| SWIPE_GESTURE | Swipe gesture. | 2375| GROUP_GESTURE | A group of gestures. | 2376 2377 2378### ArkUI_GroupGestureMode 2379 2380``` 2381enum ArkUI_GroupGestureMode 2382``` 2383**Description** 2384 2385Enumerates gesture group modes. 2386 2387**Since**: 12 2388 2389| Enum| Description| 2390| -------- | -------- | 2391| 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. | 2392| 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. | 2393| EXCLUSIVE_GROUP | Exclusive recognition. Registered gestures are identified concurrently. If one gesture is successfully recognized, gesture recognition ends. | 2394 2395 2396### ArkUI_HitTestMode 2397 2398``` 2399enum ArkUI_HitTestMode 2400``` 2401**Description** 2402 2403Enumerates the hit test modes. 2404 2405**Since**: 12 2406 2407| Enum| Description| 2408| -------- | -------- | 2409| 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. | 2410| 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. | 2411| 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. | 2412| ARKUI_HIT_TEST_MODE_NONE | The node does not respond to the hit test of a touch event. | 2413 2414 2415### ArkUI_HorizontalAlignment 2416 2417``` 2418enum ArkUI_HorizontalAlignment 2419``` 2420**Description** 2421 2422Enumerates the alignment mode in the horizontal direction. 2423 2424**Since**: 12 2425 2426| Enum| Description| 2427| -------- | -------- | 2428| ARKUI_HORIZONTAL_ALIGNMENT_START | Aligned with the start edge in the same direction as the language in use. | 2429| ARKUI_HORIZONTAL_ALIGNMENT_CENTER | Aligned with the center. This is the default alignment mode. | 2430| ARKUI_HORIZONTAL_ALIGNMENT_END | Aligned with the end edge in the same direction as the language in use. | 2431 2432 2433### ArkUI_ImageInterpolation 2434 2435``` 2436enum ArkUI_ImageInterpolation 2437``` 2438**Description** 2439 2440Enumerates the image interpolation effects. 2441 2442**Since**: 12 2443 2444| Enum| Description| 2445| -------- | -------- | 2446| ARKUI_IMAGE_INTERPOLATION_NONE | No image interpolation. | 2447| ARKUI_IMAGE_INTERPOLATION_LOW | Low quality interpolation. | 2448| ARKUI_IMAGE_INTERPOLATION_MEDIUM | Medium quality interpolation. | 2449| ARKUI_IMAGE_INTERPOLATION_HIGH | High quality interpolation. This mode produces scaled images of the highest possible quality. | 2450 2451 2452### ArkUI_ImageRenderMode 2453 2454``` 2455enum ArkUI_ImageRenderMode 2456``` 2457**Description** 2458 2459Enumerates the image rendering modes. 2460 2461**Since**: 12 2462 2463| Enum| Description| 2464| -------- | -------- | 2465| ARKUI_IMAGE_RENDER_MODE_ORIGINAL | Render image pixels as they are in the original source image. | 2466| ARKUI_IMAGE_RENDER_MODE_TEMPLATE | Render image pixels to create a monochrome template image. | 2467 2468 2469### ArkUI_ImageRepeat 2470 2471``` 2472enum ArkUI_ImageRepeat 2473``` 2474**Description** 2475 2476Enumerates the image repeat patterns. 2477 2478**Since**: 12 2479 2480| Enum| Description| 2481| -------- | -------- | 2482| ARKUI_IMAGE_REPEAT_NONE | The image is not repeatedly drawn. | 2483| ARKUI_IMAGE_REPEAT_X | The image is repeatedly drawn only along the x-axis. | 2484| ARKUI_IMAGE_REPEAT_Y | The image is repeatedly drawn only along the y-axis. | 2485| ARKUI_IMAGE_REPEAT_XY | The image is repeatedly drawn along both axes. | 2486 2487 2488### ArkUI_ImageSize 2489 2490``` 2491enum ArkUI_ImageSize 2492``` 2493**Description** 2494 2495Defines the image size. 2496 2497**Since**: 12 2498 2499| Enum| Description| 2500| -------- | -------- | 2501| ARKUI_IMAGE_SIZE_AUTO | The original image aspect ratio is retained. | 2502| 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. | 2503| ARKUI_IMAGE_SIZE_CONTAIN | The image is scaled with its aspect ratio retained for the content to be completely displayed within the display boundaries. | 2504 2505 2506### ArkUI_ImageSpanAlignment 2507 2508``` 2509enum ArkUI_ImageSpanAlignment 2510``` 2511**Description** 2512 2513Enumerates the alignment mode of the image with the text. 2514 2515**Since**: 12 2516 2517| Enum| Description| 2518| -------- | -------- | 2519| ARKUI_IMAGE_SPAN_ALIGNMENT_BASELINE | The image is bottom aligned with the text baseline. | 2520| ARKUI_IMAGE_SPAN_ALIGNMENT_BOTTOM | The image is bottom aligned with the text. | 2521| ARKUI_IMAGE_SPAN_ALIGNMENT_CENTER | The image is centered aligned with the text. | 2522| ARKUI_IMAGE_SPAN_ALIGNMENT_TOP | The image is top aligned with the text. | 2523 2524 2525### ArkUI_ItemAlignment 2526 2527``` 2528enum ArkUI_ItemAlignment 2529``` 2530**Description** 2531 2532Enumerates the modes in which components are laid out along the cross axis of the container. 2533 2534**Since**: 12 2535 2536| Enum| Description| 2537| -------- | -------- | 2538| ARKUI_ITEM_ALIGNMENT_AUTO | The default configuration of the flex container is used. | 2539| ARKUI_ITEM_ALIGNMENT_START | The items in the flex container are aligned with the cross-start edge. | 2540| ARKUI_ITEM_ALIGNMENT_CENTER | The items in the flex container are centered along the cross axis. | 2541| ARKUI_ITEM_ALIGNMENT_END | The items in the flex container are aligned with the cross-end edge. | 2542| ARKUI_ITEM_ALIGNMENT_STRETCH | The items in the flex container are stretched and padded along the cross axis. | 2543| 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. | 2544 2545 2546### ArkUI_LengthMetricUnit 2547 2548``` 2549enum ArkUI_LengthMetricUnit 2550``` 2551**Description** 2552 2553Enumerates the component units. 2554 2555**Since**: 12 2556 2557| Enum| Description| 2558| -------- | -------- | 2559| ARKUI_LENGTH_METRIC_UNIT_DEFAULT | Default, which is fp for fonts and vp for non-fonts. | 2560| ARKUI_LENGTH_METRIC_UNIT_PX | px. | 2561| ARKUI_LENGTH_METRIC_UNIT_VP | vp. | 2562| ARKUI_LENGTH_METRIC_UNIT_FP | fp. | 2563 2564 2565### ArkUI_LinearGradientDirection 2566 2567``` 2568enum ArkUI_LinearGradientDirection 2569``` 2570**Description** 2571 2572Enumerates the gradient directions. 2573 2574**Since**: 12 2575 2576| Enum| Description| 2577| -------- | -------- | 2578| ARKUI_LINEAR_GRADIENT_DIRECTION_LEFT | From right to left. | 2579| ARKUI_LINEAR_GRADIENT_DIRECTION_TOP | From bottom to top. | 2580| ARKUI_LINEAR_GRADIENT_DIRECTION_RIGHT | From left to right. | 2581| ARKUI_LINEAR_GRADIENT_DIRECTION_BOTTOM | From top to bottom. | 2582| ARKUI_LINEAR_GRADIENT_DIRECTION_LEFT_TOP | From lower right to upper left. | 2583| ARKUI_LINEAR_GRADIENT_DIRECTION_LEFT_BOTTOM | From upper right to lower left. | 2584| ARKUI_LINEAR_GRADIENT_DIRECTION_RIGHT_TOP | From lower left to upper right. | 2585| ARKUI_LINEAR_GRADIENT_DIRECTION_RIGHT_BOTTOM | From upper left to lower right. | 2586| ARKUI_LINEAR_GRADIENT_DIRECTION_NONE | No gradient. | 2587| ARKUI_LINEAR_GRADIENT_DIRECTION_CUSTOM | Custom direction. | 2588 2589 2590### ArkUI_ListItemAlignment 2591 2592``` 2593enum ArkUI_ListItemAlignment 2594``` 2595**Description** 2596 2597Enumerates the alignment modes of items along the cross axis. 2598 2599**Since**: 12 2600 2601| Enum| Description| 2602| -------- | -------- | 2603| ARKUI_LIST_ITEM_ALIGNMENT_START | The list items are packed toward the start edge of the **List** component along the cross axis. | 2604| ARKUI_LIST_ITEM_ALIGNMENT_CENTER | The list items are centered in the **List** component along the cross axis. | 2605| ARKUI_LIST_ITEM_ALIGNMENT_END | The list items are packed toward the end edge of the **List** component along the cross axis. | 2606 2607 2608### ArkUI_ListItemSwipeActionState 2609 2610``` 2611enum ArkUI_ListItemSwipeActionState 2612``` 2613**Description** 2614 2615Enumerates the swipe action item states of list items. 2616 2617**Since**: 12 2618 2619| Enum| Description| 2620| -------- | -------- | 2621| 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. | 2622| 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. | 2623| ARKUI_LIST_ITEM_SWIPE_ACTION_STATE_ACTIONING | In-action state. The list item is in this state when it enters the delete area. | 2624 2625 2626### ArkUI_ListItemSwipeEdgeEffect 2627 2628``` 2629enum ArkUI_ListItemSwipeEdgeEffect 2630``` 2631**Description** 2632 2633Enumerates the swipe action item edge effects of list items. 2634 2635**Since**: 12 2636 2637| Enum| Description| 2638| -------- | -------- | 2639| 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. | 2640| ARKUI_LIST_ITEM_SWIPE_EDGE_EFFECT_NONE | The list item cannot scroll beyond the edge of the list. | 2641 2642 2643### ArkUI_MaskType 2644 2645``` 2646enum ArkUI_MaskType 2647``` 2648**Description** 2649 2650Enumerates the mask types. 2651 2652**Since**: 12 2653 2654| Enum| Description| 2655| -------- | -------- | 2656| ARKUI_MASK_TYPE_RECTANGLE | Rectangle. | 2657| ARKUI_MASK_TYPE_CIRCLE | **(circle)** | 2658| ARKUI_MASK_TYPE_ELLIPSE | Ellipse. | 2659| ARKUI_MASK_TYPE_PATH | Path Type | 2660| ARKUI_MASK_TYPE_PROGRESS | Progress indicator. | 2661 2662 2663### ArkUI_NativeAPIVariantKind 2664 2665``` 2666enum ArkUI_NativeAPIVariantKind 2667``` 2668**Description** 2669 2670Defines the native API types. 2671 2672**Since**: 12 2673 2674| Enum| Description| 2675| -------- | -------- | 2676| ARKUI_NATIVE_NODE | API related to UI components. For details, see the struct definition in <arkui/native_node.h>. | 2677| ARKUI_NATIVE_DIALOG | API related to dialog boxes. For details, see the struct definition in <arkui/native_node.h>. | 2678| ARKUI_NATIVE_GESTURE | API related to gestures. For details, see the struct definition in <arkui/native_node.h>. | 2679| ARKUI_NATIVE_ANIMATE | API related to animations. For details, see the struct definition in <arkui/native_animate.h>. | 2680 2681 2682### ArkUI_NavDestinationState 2683 2684``` 2685enum ArkUI_NavDestinationState 2686``` 2687**Description** 2688 2689Defines an enum for the **NavDestination** component states. 2690 2691**Since**: 12 2692 2693| Enum| Description| 2694| -------- | -------- | 2695| ARKUI_NAV_DESTINATION_STATE_ON_SHOW | The **NavDestination** component is displayed. | 2696| ARKUI_NAV_DESTINATION_STATE_ON_HIDE | The **NavDestination** component is hidden. | 2697| ARKUI_NAV_DESTINATION_STATE_ON_APPEAR | The **NavDestination** component is mounted to the component tree. | 2698| ARKUI_NAV_DESTINATION_STATE_ON_DISAPPEAR | The **NavDestination** component is unmounted from the component tree. | 2699| ARKUI_NAV_DESTINATION_STATE_ON_WILL_SHOW | The **NavDestination** is about to be displayed. | 2700| ARKUI_NAV_DESTINATION_STATE_ON_WILL_HIDE | The **NavDestination** is about to be hidden. | 2701| ARKUI_NAV_DESTINATION_STATE_ON_WILL_APPEAR | The **NavDestination** is about to be mounted to the component tree. | 2702| ARKUI_NAV_DESTINATION_STATE_ON_WILL_DISAPPEAR | The **NavDestination** component is about to be unmounted from the component tree. | 2703| ARKUI_NAV_DESTINATION_STATE_ON_BACK_PRESS | The back button is pressed for the **NavDestination** component. | 2704 2705 2706### ArkUI_NodeAdapterEventType 2707 2708``` 2709enum ArkUI_NodeAdapterEventType 2710``` 2711**Description** 2712 2713Enumerates node adapter events. 2714 2715**Since**: 12 2716 2717| Enum| Description| 2718| -------- | -------- | 2719| NODE_ADAPTER_EVENT_WILL_ATTACH_TO_NODE | This event occurs when the component is attached to the adapter. | 2720| NODE_ADAPTER_EVENT_WILL_DETACH_FROM_NODE | This event occurs when the component is detached from the adapter. | 2721| NODE_ADAPTER_EVENT_ON_GET_NODE_ID | This event occurs when the adapter obtains the unique ID of the new element to add. | 2722| NODE_ADAPTER_EVENT_ON_ADD_NODE_TO_ADAPTER | This event occurs when the adapter obtains the content of the new element to add. | 2723| NODE_ADAPTER_EVENT_ON_REMOVE_NODE_FROM_ADAPTER | This event occurs when the adapter removes an element. | 2724 2725 2726### ArkUI_NodeAttributeType 2727 2728``` 2729enum ArkUI_NodeAttributeType 2730``` 2731**Description** 2732 2733Defines the ArkUI style attributes that can be set on the native side. 2734 2735**Since**: 12 2736 2737| Enum | Description | 2738| ------------------------------------------- | ------------------------------------------------------------ | 2739| 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.| 2740| 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.| 2741| 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.| 2742| 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.<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.<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.| 2743| 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.| 2744| 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.| 2745| 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. | 2746| 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.| 2747| 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.| 2748| 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.| 2749| 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.| 2750| 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.| 2751| 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.| 2752| 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. The larger the fuzzy radius, the more blurred the image. If the value is **0**, the image is not blurred. 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.| 2753| 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, the **angle** attribute does not take effect. 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: array of color stops, each of which consists of a color and its stop position. Invalid colors are automatically skipped. The parameter type is [ArkUI_ColorStop](_ark_u_i___color_stop.md).<br>**colors**: colors of the color stops.<br>**stops**: stop positions of the color stops.<br>**size**: number of colors.| 2754| 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).| 2755| 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.| 2756| 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.| 2757| 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.| 2758| 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**.| 2759| 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.| 2760| NODE_Z_INDEX | Defines the z-index attribute for the stack sequence. APIs are provided for setting, resetting, and obtaining the attribute value.<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.| 2761| 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**.| 2762| 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.| 2763| 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.| 2764| NODE_TRANSFORM | Defines the transform attribute, which can be used to translate, rotate, and scale images. APIs are provided for setting, resetting, and obtaining the attribute value.<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.| 2765| 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**.| 2766| 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.| 2767| 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).| 2768| 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.| 2769| NODE_BACKGROUND_IMAGE_SIZE | Defines the background image width and height. APIs are provided for setting, resetting, and obtaining the attribute value.<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.| 2770| NODE_BACKGROUND_IMAGE_SIZE_WITH_STYLE | Defines the background image size. APIs are provided for setting, resetting, and obtaining the attribute value.<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).| 2771| 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.| 2772| 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.| 2773| 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.| 2774| 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.| 2775| 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.| 2776| 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.| 2777| 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.| 2778| 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.| 2779| 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.| 2780| 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.| 2781| 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.| 2782| NODE_SWEEP_GRADIENT | Defines the sweep gradient effect. APIs are provided for setting, resetting, and obtaining the attribute value.<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.| 2783| NODE_RADIAL_GRADIENT | Defines the radial gradient effect. APIs are provided for setting, resetting, and obtaining the attribute value.<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.| 2784| 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.| 2785| NODE_BLEND_MODE | Blends the component's background with the content of the component's child node. APIs are provided for setting, resetting, and obtaining the attribute value.<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**.| 2786| NODE_DIRECTION | Sets the direction of the main axis. APIs are provided for setting, resetting, and obtaining the attribute value.<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**.| 2787| NODE_CONSTRAINT_SIZE | Defines the size constraints. APIs are provided for setting, resetting, and obtaining the attribute value.<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.| 2788| NODE_GRAY_SCALE | Defines the grayscale effect. APIs are provided for setting, resetting, and obtaining the attribute value.<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.| 2789| NODE_INVERT | Inverts the image. APIs are provided for setting, resetting, and obtaining the attribute value.<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.| 2790| NODE_SEPIA | Defines the sepia conversion ratio. APIs are provided for setting, resetting, and obtaining the attribute value.<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.| 2791| 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).| 2792| NODE_FOREGROUND_COLOR | Defines the border color attribute, which can be set, reset, and obtained as required through APIs.<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.| 2793| NODE_OFFSET | Defines the offset of the component's child relative to the component. APIs are provided for setting, resetting, and obtaining the attribute value.<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.| 2794| NODE_MARK_ANCHOR | Sets the anchor for locating the component's child. APIs are provided for setting, resetting, and obtaining the attribute value.<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.| 2795| 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. APIs are provided for setting, resetting, and obtaining the attribute value.<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.| 2796| NODE_ALIGN_RULES | Sets the alignment rules in the relative container. APIs are provided for setting, resetting, and obtaining the attribute value.<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.| 2797| NODE_ALIGN_SELF | Sets the alignment mode of the child components along the cross axis of the parent container. APIs are provided for setting, resetting, and obtaining the attribute value.<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**.| 2798| 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.| 2799| 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.| 2800| NODE_FLEX_BASIS | Sets the base size of the component. APIs are provided for setting, resetting, and obtaining the attribute value.<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.| 2801| NODE_ACCESSIBILITY_GROUP | Sets the accessibility group. APIs are provided for setting, resetting, and obtaining the attribute value.<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**.| 2802| NODE_ACCESSIBILITY_TEXT | Sets the accessibility text. APIs are provided for setting, resetting, and obtaining the attribute value.<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.| 2803| 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).| 2804| NODE_ACCESSIBILITY_DESCRIPTION | Sets the accessibility description. APIs are provided for setting, resetting, and obtaining the attribute value.<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.| 2805| 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.| 2806| 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.| 2807| 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.| 2808| 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.| 2809| 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.| 2810| 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. | 2811| 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. | 2812| 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. | 2813| 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. | 2814| 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.| 2815| 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).| 2816| 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.| 2817| 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**.| 2818| 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.| 2819| 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.| 2820| 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**.| 2821| 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].| 2822| 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. | 2823| 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.| 2824| 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.| 2825| 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.| 2826| 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.| 2827| 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).| 2828| 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).| 2829| 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).| 2830| 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).| 2831| 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> | 2832| 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> | 2833| 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).| 2834| 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.| 2835| 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.| 2836| 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.| 2837| 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.| 2838| 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.| 2839| 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).| 2840| 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).| 2841| 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.| 2842| 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).| 2843| 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.| 2844| 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.| 2845| NODE_TEXT_MAX_LINES | Sets the maximum number of lines in the text. APIs are provided for setting, resetting, and obtaining the attribute value.<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.| 2846| 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).| 2847| 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} | 2848| 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 (,).| 2849| 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).| 2850| 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.| 2851| 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.| 2852| 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.| 2853| 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.| 2854| 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**.| 2855| 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).| 2856| 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.| 2857| 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).| 2858| 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).| 2859| 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. | 2860| 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 (,).| 2861| 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.| 2862| 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).| 2863| 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.| 2864| 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).| 2865| 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.| 2866| 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.| 2867| 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.| 2868| 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.| 2869| 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.| 2870| 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.| 2871| 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).| 2872| 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.| 2873| 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).| 2874| 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.| 2875| 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.| 2876| 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.| 2877| 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**.| 2878| 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.| 2879| 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).| 2880| 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.| 2881| 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).| 2882| 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.| 2883| 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.| 2884| 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.| 2885| 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.| 2886| 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.| 2887| 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.| 2888| 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.| 2889| 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.| 2890| 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.| 2891| 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.| 2892| 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.| 2893| 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. | 2894| NODE_TEXT_INPUT_CARET_STYLE | Defines the caret style attribute. APIs are provided for setting, resetting, and obtaining the attribute value.<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.| 2895| 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.| 2896| 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.| 2897| 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).| 2898| 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.| 2899| 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 (,).| 2900| 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.| 2901| 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).| 2902| 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.| 2903| 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.| 2904| 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.| 2905| 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.| 2906| 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. | 2907| 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. | 2908| 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.| 2909| 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).| 2910| 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.| 2911| 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.| 2912| 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.| 2913| 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).| 2914| 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.| 2915| 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.| 2916| 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.| 2917| 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.| 2918| 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.| 2919| 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.| 2920| 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).| 2921| 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.| 2922| 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.| 2923| 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.| 2924| 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.| 2925| 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.| 2926| 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.| 2927| 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 (,).| 2928| 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.| 2929| 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.| 2930| 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).| 2931| 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**.| 2932| 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.| 2933| 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.| 2934| 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.| 2935| 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.| 2936| 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).| 2937| 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.| 2938| 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.| 2939| 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.| 2940| 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.| 2941| 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. | 2942| 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.| 2943| 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).| 2944| 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.| 2945| 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.| 2946| 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.| 2947| 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.| 2948| 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.| 2949| 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.| 2950| 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.| 2951| 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).| 2952| 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.| 2953| 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**.| 2954| 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**.| 2955| 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**.| 2956| 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).| 2957| 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.| 2958| 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).| 2959| 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. | 2960| 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.| 2961| 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.| 2962| 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.| 2963| 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.| 2964| 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"**.| 2965| 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"**.| 2966| 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"**.| 2967| 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.| 2968| 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.| 2969| 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"**.| 2970| 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"**.| 2971| 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"**.| 2972| 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).| 2973| 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.| 2974| 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 (;).| 2975| 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"**.| 2976| 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"**.| 2977| 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"**.| 2978| 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.| 2979| 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.| 2980| 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.| 2981| 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.| 2982| 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.| 2983| 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.| 2984| 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).| 2985| 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**.| 2986| 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**.| 2987| 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**.| 2988| 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.| 2989| 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.| 2990| 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.| 2991| 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.| 2992| 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.| 2993| 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].| 2994| 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).| 2995| 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.| 2996| 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).| 2997| 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. | 2998| 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.| 2999| 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**.| 3000| 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.| 3001| 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. | 3002| 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).| 3003| 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).| 3004| 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.| 3005| 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.| 3006| 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).| 3007| 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.| 3008| 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.| 3009| 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.| 3010| 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.| 3011| 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).| 3012| 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.| 3013| 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).| 3014| 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.| 3015| 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.| 3016| 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.| 3017| 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.| 3018| 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**: 14| 3019| 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).| 3020| 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).| 3021| 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.| 3022| 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.| 3023| 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.| 3024| 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**.| 3025| 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**.| 3026| 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**.| 3027| 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**.| 3028| 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.| 3029| 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**.| 3030| 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**.| 3031| 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**.| 3032| 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.| 3033| 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**.| 3034| 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**.| 3035| 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.| 3036| 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.| 3037| 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.| 3038| 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.| 3039| 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**.| 3040| 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**.| 3041| 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).| 3042| 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.| 3043| 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.| 3044| 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.| 3045| 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.| 3046| 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).| 3047| 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).| 3048| 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.| 3049| 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.| 3050| 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.| 3051| 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.| 3052| 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.| 3053| 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.| 3054| 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.| 3055| 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).| 3056| 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).| 3057| 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).| 3058| 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).| 3059| 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.| 3060| 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.| 3061| 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**.| 3062| 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.| 3063| 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.| 3064| 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.| 3065| 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**.| 3066| 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.| 3067| 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.| 3068| 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.| 3069| 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.| 3070| 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.| 3071| 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.| 3072| 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. | 3073| 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).| 3074| 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**.| 3075| 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. | 3076| 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**.| 3077| 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.| 3078| 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.| 3079| 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.| 3080| 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.| 3081| 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.| 3082| 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.| 3083| 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. | 3084| 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**. | 3085| 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).| 3086| 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**.| 3087| 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.| 3088| NODE_IMAGE_ANIMATOR_FIXED_SIZE | Whether the image size is fixed at the component size.<br> This attribute can be set, reset, and obtained as required through APIs.<br>Format of the [ArkUI_AttributeItem](_ark_u_i___attribute_item.md) parameter for setting the attribute:<br>.value[0].i32: whether the image size is the fixed at the component size. The value **1** indicates that the image size is fixed at the component size. The value **0** indicates that the width, height, top, and left attributes of each image must be set separately. The default value is **1**.<br>Format of the return value [ArkUI_AttributeItem](_ark_u_i___attribute_item.md):<br>.value[0].i32: whether the image size is the fixed at the component size. The value **1** indicates that the image size is fixed at the component size. The value **0** indicates that the width, height, top, and left attributes of each image must be set separately.| 3089| 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**.| 3090| NODE_IMAGE_ANIMATOR_ITERATION | 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.| 3091 3092 3093### ArkUI_NodeContentEventType 3094 3095``` 3096enum ArkUI_NodeContentEventType 3097``` 3098**Description** 3099 3100Defines the NodeContent event type. 3101 3102**Since**: 12 3103 3104| Enum| Description| 3105| -------- | -------- | 3106| NODE_CONTENT_EVENT_ON_ATTACH_TO_WINDOW | Attach event. | 3107| NODE_CONTENT_EVENT_ON_DETACH_FROM_WINDOW | Detach event. | 3108 3109 3110### ArkUI_NodeCustomEventType 3111 3112``` 3113enum ArkUI_NodeCustomEventType 3114``` 3115**Description** 3116 3117Enumerates the custom component event types. 3118 3119**Since**: 12 3120 3121| Enum| Description| 3122| -------- | -------- | 3123| ARKUI_NODE_CUSTOM_EVENT_ON_MEASURE | Measure. | 3124| ARKUI_NODE_CUSTOM_EVENT_ON_LAYOUT | Layout. | 3125| ARKUI_NODE_CUSTOM_EVENT_ON_DRAW | Draw. | 3126| ARKUI_NODE_CUSTOM_EVENT_ON_FOREGROUND_DRAW | Foreground. | 3127| ARKUI_NODE_CUSTOM_EVENT_ON_OVERLAY_DRAW | Overlay. | 3128 3129 3130### ArkUI_NodeDirtyFlag 3131 3132``` 3133enum ArkUI_NodeDirtyFlag 3134``` 3135**Description** 3136 3137Enumerates the dirty area flags passed in the **::markDirty** API. 3138 3139**Since**: 12 3140 3141| Enum| Description| 3142| -------- | -------- | 3143| NODE_NEED_MEASURE | Recalculate the size.<br>When this type of flag is specified, re-layout is triggered by default.| 3144| NODE_NEED_LAYOUT | Re-layout. | 3145| NODE_NEED_RENDER | Re-rendering. | 3146 3147 3148### ArkUI_NodeEventType 3149 3150``` 3151enum ArkUI_NodeEventType 3152``` 3153**Description** 3154 3155Enumerates the event types supported by the NativeNode component. 3156 3157**Since**: 12 3158 3159| Enum| Description| 3160| -------- | -------- | 3161| 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).| 3162| 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.| 3163| 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.| 3164| 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.| 3165| 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.| 3166| 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.| 3167| 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 clicked position relative to the upper left corner of the original area of the clicked element, in vp.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[1].f32: Y coordinate of the clicked position relative to the upper left corner of the original area of the clicked element, in vp.<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 clicked position relative to the upper left corner of the application window, in vp.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[5].f32: Y coordinate of the clicked position relative to the upper left corner of the application window, in vp.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[6].f32: X coordinate of the clicked position relative to the upper left corner of the application screen, in vp.<br>[ArkUI_NodeComponentEvent.data](_ark_u_i___node_component_event.md#data)[7].f32: Y coordinate of the clicked position relative to the upper left corner of the application screen, in vp.| 3168| 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).| 3169| 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.| 3170| 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.| 3171| 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).| 3172| 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.| 3173| 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.| 3174| 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).| 3175| 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).| 3176| 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.| 3177| 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.| 3178| 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.| 3179| 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.| 3180| 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.| 3181| 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.| 3182| 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. | 3183| 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.| 3184| 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.| 3185| 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.| 3186| 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:.| 3187| 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.| 3188| 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.| 3189| NODE_TEXT_INPUT_ON_SUBMIT | Called when the Enter key of the textInput 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.| 3190| 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.| 3191| 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.| 3192| 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.| 3193| 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.| 3194| 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.| 3195| 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.| 3196| 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.| 3197| 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**.| 3198| 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**.| 3199| 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**.| 3200| 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**.| 3201| 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.| 3202| 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>Condition for triggering this event: Touch and hold the internal area of the text box to display the clipboard, and touch the clipboard paste 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): text pasted.| 3203| NODE_TEXT_AREA_ON_TEXT_SELECTION_CHANGE | Called when the text selection position changes.<br>Condition for triggering this event: The position of the selected text 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.| 3204| 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.| 3205| 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.| 3206| 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.| 3207| 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.| 3208| 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.| 3209| 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**.| 3210| 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**.| 3211| 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**.| 3212| 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**.| 3213| 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| 3214| 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.| 3215| 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.| 3216| 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.| 3217| 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.| 3218| 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.| 3219| 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.| 3220| 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.| 3221| 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.| 3222| 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.| 3223| 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.| 3224| 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.| 3225| 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.| 3226| 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.| 3227| 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.| 3228| 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.| 3229| 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.| 3230| 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.| 3231| 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.| 3232| 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.| 3233| 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).| 3234| 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.| 3235| 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.| 3236| 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.| 3237| 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.| 3238| 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.| 3239| 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.| 3240| 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.| 3241| NODE_LIST_ON_DID_SCROLL | Called when the list scrolls.<br>**NOTE**<br>1. This event is triggered when scrolling is started by the scrollable component or other input settings, such as keyboard and mouse operations.<br>2. Scrolling can be initiated by calling the controller API.<br>3. The out-of-bounds bounce effect is supported.<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.| 3242| 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.| 3243| 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.| 3244| 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.| 3245| 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 scrollable component or other input settings, such as keyboard and mouse operations.<br>2. Scrolling can be initiated by calling the controller API.<br>3. The out-of-bounds bounce effect is supported.<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.| 3246| 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 scrollable component or other input settings, such as keyboard and mouse operations.<br>2. Scrolling can be initiated by calling the controller API.<br>3. The out-of-bounds bounce effect is supported.<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:.| 3247| 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:.| 3248 3249 3250### ArkUI_NodeType 3251 3252``` 3253enum ArkUI_NodeType 3254``` 3255**Description** 3256 3257Enumerates ArkUI component types that can be created on the native side. 3258 3259**Since**: 12 3260 3261| Enum| Description| 3262| -------- | -------- | 3263| ARKUI_NODE_CUSTOM | Custom node. | 3264| ARKUI_NODE_TEXT | Text to insert. | 3265| ARKUI_NODE_SPAN | Text span. | 3266| ARKUI_NODE_IMAGE_SPAN | Image span. | 3267| ARKUI_NODE_IMAGE | Image. | 3268| ARKUI_NODE_TOGGLE | Toggle. | 3269| ARKUI_NODE_LOADING_PROGRESS | Loading icon. | 3270| ARKUI_NODE_TEXT_INPUT | Single-line text input. | 3271| ARKUI_NODE_TEXT_AREA | Multi-line text input. | 3272| ARKUI_NODE_BUTTON | Icon. | 3273| ARKUI_NODE_PROGRESS | Progress indicator. | 3274| ARKUI_NODE_CHECKBOX | Check box | 3275| ARKUI_NODE_XCOMPONENT | XComponent. | 3276| ARKUI_NODE_DATE_PICKER | Date picker. | 3277| ARKUI_NODE_TIME_PICKER | Time picker. | 3278| ARKUI_NODE_TEXT_PICKER | Text picker. | 3279| ARKUI_NODE_CALENDAR_PICKER | Calendar picker. | 3280| ARKUI_NODE_SLIDER | Slider. | 3281| ARKUI_NODE_RADIO | Radio button. | 3282| ARKUI_NODE_IMAGE_ANIMATOR | Frame-by-frame animation component. | 3283| ARKUI_NODE_STACK | Stack container. | 3284| ARKUI_NODE_SWIPER | Swiper. | 3285| ARKUI_NODE_SCROLL | Scrolling container. | 3286| ARKUI_NODE_LIST | List. | 3287| ARKUI_NODE_LIST_ITEM | List item. | 3288| ARKUI_NODE_LIST_ITEM_GROUP | List item group. | 3289| ARKUI_NODE_COLUMN | Column container. | 3290| ARKUI_NODE_ROW | Row container. | 3291| ARKUI_NODE_FLEX | Flex container. | 3292| ARKUI_NODE_REFRESH | Refresh component. | 3293| ARKUI_NODE_WATER_FLOW | Water flow container. | 3294| ARKUI_NODE_FLOW_ITEM | Water flow item. | 3295| ARKUI_NODE_RELATIVE_CONTAINER | Relative layout component. | 3296| ARKUI_NODE_GRID | Grid. | 3297| ARKUI_NODE_GRID_ITEM | Grid item. | 3298| ARKUI_NODE_CUSTOM_SPAN | Custom span. | 3299 3300 3301### ArkUI_ObjectFit 3302 3303``` 3304enum ArkUI_ObjectFit 3305``` 3306**Description** 3307 3308Enumerates the image filling effects. ImageSpanAlignment 3309 3310**Since**: 12 3311 3312| Enum| Description| 3313| -------- | -------- | 3314| ARKUI_OBJECT_FIT_CONTAIN | The image is scaled with its aspect ratio retained for the content to be completely displayed within the display boundaries. | 3315| 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. | 3316| ARKUI_OBJECT_FIT_AUTO | The image is scaled automatically to fit the display area. | 3317| ARKUI_OBJECT_FIT_FILL | The image is scaled to fill the display area, and its aspect ratio is not retained. | 3318| 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. | 3319| ARKUI_OBJECT_FIT_NONE | The original size is retained. | 3320| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_TOP_START | Not resized, the image is aligned with the start edge of the top of the container. | 3321| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_TOP | Not resized, the image is horizontally centered at the top of the container. | 3322| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_TOP_END | Not resized, the image is aligned with the end edge at the top of the container. | 3323| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_START | Not resized, the image is vertically centered on the start edge of the container. | 3324| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_CENTER | Not resized, the image is horizontally and vertically centered in the container. | 3325| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_END | Not resized, the image is vertically centered on the end edge of the container. | 3326| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_BOTTOM_START | Not resized, the image is aligned with the start edge at the bottom of the container. | 3327| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_BOTTOM | Not resized, the image is horizontally centered at the bottom of the container. | 3328| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_BOTTOM_END | Not resized, the image is aligned with the end edge at the bottom of the container. | 3329 3330 3331### ArkUI_PreDragStatus 3332 3333``` 3334enum ArkUI_PreDragStatus 3335``` 3336**Description** 3337 3338Defines an enum for interaction states prior to a drop and drop operation. 3339 3340**Since**: 12 3341 3342| Enum| Description| 3343| -------- | -------- | 3344| ARKUI_PRE_DRAG_STATUS_UNKNOWN | Unknown. | 3345| ARKUI_PRE_DRAG_STATUS_ACTION_DETECTING | A drag gesture is being detected. | 3346| ARKUI_PRE_DRAG_STATUS_READY_TO_TRIGGER_DRAG | The component is ready to be dragged. | 3347| ARKUI_PRE_DRAG_STATUS_PREVIEW_LIFT_STARTED | A lift animation is started. | 3348| ARKUI_PRE_DRAG_STATUS_PREVIEW_LIFT_FINISHED | A lift animation is finished. | 3349| ARKUI_PRE_DRAG_STATUS_PREVIEW_LANDING_STARTED | A drop animation is started. | 3350| ARKUI_PRE_DRAG_STATUS_PREVIEW_LANDING_FINISHED | A drop animation is finished. | 3351| ARKUI_PRE_DRAG_STATUS_CANCELED_BEFORE_DRAG | A drop animation is terminated. | 3352 3353 3354### ArkUI_ProgressType 3355 3356``` 3357enum ArkUI_ProgressType 3358``` 3359**Description** 3360 3361Enumerates the styles of the progress indicator. 3362 3363**Since**: 12 3364 3365| Enum| Description| 3366| -------- | -------- | 3367| ARKUI_PROGRESS_TYPE_LINEAR | Linear type. | 3368| ARKUI_PROGRESS_TYPE_RING | Indeterminate ring style. | 3369| ARKUI_PROGRESS_TYPE_ECLIPSE | Eclipse style. | 3370| ARKUI_PROGRESS_TYPE_SCALE_RING | Determinate ring style. | 3371| ARKUI_PROGRESS_TYPE_CAPSULE | Capsule style. | 3372 3373 3374### ArkUI_RelativeLayoutChainStyle 3375 3376``` 3377enum ArkUI_RelativeLayoutChainStyle 3378``` 3379**Description** 3380 3381Enumerates the chain styles. 3382 3383**Since**: 12 3384 3385| Enum| Description| 3386| -------- | -------- | 3387| ARKUI_RELATIVE_LAYOUT_CHAIN_STYLE_SPREAD | Child components are evenly distributed among constraint anchors. | 3388| ARKUI_RELATIVE_LAYOUT_CHAIN_STYLE_SPREAD_INSIDE | All child components except the first and last ones are evenly distributed among constraint anchors. | 3389| ARKUI_RELATIVE_LAYOUT_CHAIN_STYLE_PACKED | There is no gap between child components in the chain. | 3390 3391 3392### ArkUI_RenderFit 3393 3394``` 3395enum ArkUI_RenderFit 3396``` 3397 3398| Enum| Description| 3399| -------- | -------- | 3400| ARKUI_RENDER_FIT_CENTER | The component's content stays at the final size and always aligned with the center of the component. | 3401| ARKUI_RENDER_FIT_TOP | The component's content stays at the final size and always aligned with the top center of the component. | 3402| ARKUI_RENDER_FIT_BOTTOM | The component's content stays at the final size and always aligned with the bottom center of the component. | 3403| ARKUI_RENDER_FIT_LEFT | The component's content stays at the final size and always aligned with the left of the component. | 3404| ARKUI_RENDER_FIT_RIGHT | The component's content stays at the final size and always aligned with the right of the component. | 3405| 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. | 3406| 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. | 3407| 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. | 3408| 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. | 3409| 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. | 3410| 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. | 3411| 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. | 3412| 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. | 3413| 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. | 3414| 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. | 3415| 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. | 3416 3417 3418### ArkUI_RouterPageState 3419 3420``` 3421enum ArkUI_RouterPageState 3422``` 3423**Description** 3424 3425Enumerates the states of a page during routing. 3426 3427**Since**: 12 3428 3429| Enum| Description| 3430| -------- | -------- | 3431| ARKUI_ROUTER_PAGE_STATE_ON_WILL_APPEAR | The page is about to be displayed. | 3432| ARKUI_ROUTER_PAGE_STATE_ON_WILL_DISAPPEAR | The page is about to be destroyed. | 3433| ARKUI_ROUTER_PAGE_STATE_ON_SHOW | The page is displayed. | 3434| ARKUI_ROUTER_PAGE_STATE_ON_HIDE | The page is hidden. | 3435| ARKUI_ROUTER_PAGE_STATE_ON_BACK_PRESS | The back button is pressed for the page. | 3436 3437 3438### ArkUI_SafeAreaEdge 3439 3440``` 3441enum ArkUI_SafeAreaEdge 3442``` 3443**Description** 3444 3445Enumerates the edges for expanding the safe area. 3446 3447**Since**: 12 3448 3449| Enum| Description| 3450| -------- | -------- | 3451| ARKUI_SAFE_AREA_EDGE_TOP | Top edge. | 3452| ARKUI_SAFE_AREA_EDGE_BOTTOM | Bottom edge. | 3453| ARKUI_SAFE_AREA_EDGE_START | Start edge. | 3454| ARKUI_SAFE_AREA_EDGE_END | End edge. | 3455 3456 3457### ArkUI_SafeAreaType 3458 3459``` 3460enum ArkUI_SafeAreaType 3461``` 3462**Description** 3463 3464Enumerates the types of expanded safe areas. 3465 3466**Since**: 12 3467 3468| Enum| Description| 3469| -------- | -------- | 3470| ARKUI_SAFE_AREA_TYPE_SYSTEM | Default non-safe area of the system, including the status bar and navigation bar. | 3471| ARKUI_SAFE_AREA_TYPE_CUTOUT | Non-safe area of the device, for example, the notch area. | 3472| ARKUI_SAFE_AREA_TYPE_KEYBOARD | Soft keyboard area. | 3473 3474 3475### ArkUI_ScrollAlignment 3476 3477``` 3478enum ArkUI_ScrollAlignment 3479``` 3480**Description** 3481 3482Defines how the list item to scroll to is aligned with the container. 3483 3484**Since**: 12 3485 3486| Enum| Description| 3487| -------- | -------- | 3488| ARKUI_SCROLL_ALIGNMENT_START | The start edge of the list item is flush with the start edge of the container. | 3489| ARKUI_SCROLL_ALIGNMENT_CENTER | The list item is centered along the main axis of the list. | 3490| ARKUI_SCROLL_ALIGNMENT_END | The end edge of the list item Aligns the tail of an item with that of a container. | 3491| 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. | 3492 3493### ArkUI_ScrollBarDisplayMode 3494 3495``` 3496enum ArkUI_ScrollBarDisplayMode 3497``` 3498**Description** 3499 3500Enumerates the scrollbar display modes. 3501 3502**Since**: 12 3503 3504| Enum| Description| 3505| -------- | -------- | 3506| ARKUI_SCROLL_BAR_DISPLAY_MODE_OFF | Not displayed. | 3507| ARKUI_SCROLL_BAR_DISPLAY_MODE_AUTO | Displayed when the screen is touched and hidden after 2s. | 3508| ARKUI_SCROLL_BAR_DISPLAY_MODE_ON | Always displayed. | 3509 3510 3511### ArkUI_ScrollDirection 3512 3513``` 3514enum ArkUI_ScrollDirection 3515``` 3516**Description** 3517 3518Enumerates the scroll directions of scrollable components. 3519 3520**Since**: 12 3521 3522| Enum| Description| 3523| -------- | -------- | 3524| ARKUI_SCROLL_DIRECTION_VERTICAL | Only vertical scrolling is supported. | 3525| ARKUI_SCROLL_DIRECTION_HORIZONTAL | Only horizontal scrolling is supported. | 3526| ARKUI_SCROLL_DIRECTION_NONE | Scrolling is forbidden. | 3527 3528 3529### ArkUI_ScrollEdge 3530 3531``` 3532enum ArkUI_ScrollEdge 3533``` 3534**Description** 3535 3536Defines the edge to which the component scrolls. 3537 3538**Since**: 12 3539 3540| Enum| Description| 3541| -------- | -------- | 3542| ARKUI_SCROLL_EDGE_TOP | Top edge in the vertical direction. | 3543| ARKUI_SCROLL_EDGE_BOTTOM | Bottom edge in the vertical direction. | 3544| ARKUI_SCROLL_EDGE_START | Start position in the horizontal direction. | 3545| ARKUI_SCROLL_EDGE_END | End position in the horizontal direction. | 3546 3547 3548### ArkUI_ScrollNestedMode 3549 3550``` 3551enum ArkUI_ScrollNestedMode 3552``` 3553**Description** 3554 3555Enumerates nested scrolling options. 3556 3557**Since**: 12 3558 3559| Enum| Description| 3560| -------- | -------- | 3561| 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. | 3562| 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. | 3563| 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. | 3564| 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. | 3565 3566 3567### ArkUI_ScrollSnapAlign 3568 3569``` 3570enum ArkUI_ScrollSnapAlign 3571``` 3572**Description** 3573 3574Enumerates the alignment modes of list items when scrolling ends. 3575 3576**Since**: 12 3577 3578| Enum| Description| 3579| -------- | -------- | 3580| ARKUI_SCROLL_SNAP_ALIGN_NONE | No alignment. This is the default value. | 3581| ARKUI_SCROLL_SNAP_ALIGN_START | The first item in the view is aligned at the start of the list. | 3582| ARKUI_SCROLL_SNAP_ALIGN_CENTER | The middle items in the view are aligned in the center of the list. | 3583| ARKUI_SCROLL_SNAP_ALIGN_END | The last item in the view is aligned at the end of the list. | 3584 3585 3586### ArkUI_ScrollSource 3587 3588``` 3589enum ArkUI_ScrollSource 3590``` 3591**Description** 3592 3593Enumerates the scrolling sources. 3594 3595**Since**: 12 3596 3597| Enum| Description| 3598| -------- | -------- | 3599| ARKUI_SCROLL_SOURCE_DRAG | Drag your finger. | 3600| ARKUI_SCROLL_SOURCE_FLING | Inertia scrolling after finger dragging. | 3601| ARKUI_SCROLL_SOURCE_EDGE_EFFECT | Executes the EdgeEffect.Spring edge special effect when the boundary is crossed. | 3602| ARKUI_SCROLL_SOURCE_OTHER_USER_INPUT | User input other than dragging, such as mouse wheel and keyboard events. | 3603| ARKUI_SCROLL_SOURCE_SCROLL_BAR | Scrollbar dragging | 3604| ARKUI_SCROLL_SOURCE_SCROLL_BAR_FLING | Inertial scrolling after the scroll bar is dragged. | 3605| ARKUI_SCROLL_SOURCE_SCROLLER | Scrolling by the scroll controller (without animation). | 3606| ARKUI_SCROLL_SOURCE_ANIMATION | Scrolling by the scroll controller (with animation). | 3607 3608 3609### ArkUI_ScrollState 3610 3611``` 3612enum ArkUI_ScrollState 3613``` 3614**Description** 3615 3616Enumerates the scrolling states. 3617 3618**Since**: 12 3619 3620| Enum| Description| 3621| -------- | -------- | 3622| 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. | 3623| ARKUI_SCROLL_STATE_SCROLL | Scrolling. The container enters this state when the user drags the container to scroll. | 3624| 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. | 3625 3626 3627### ArkUI_ShadowStyle 3628 3629``` 3630enum ArkUI_ShadowStyle 3631``` 3632**Description** 3633 3634Enumerated value of the shadow effect. 3635 3636**Since**: 12 3637 3638| Enum| Description| 3639| -------- | -------- | 3640| ARKUI_SHADOW_STYLE_OUTER_DEFAULT_XS | Mini shadow. | 3641| ARKUI_SHADOW_STYLE_OUTER_DEFAULT_SM | Small shadow. | 3642| ARKUI_SHADOW_STYLE_OUTER_DEFAULT_MD | Medium shadow. | 3643| ARKUI_SHADOW_STYLE_OUTER_DEFAULT_LG | Large shadow. | 3644| ARKUI_SHADOW_STYLE_OUTER_FLOATING_SM | Floating small shadow. | 3645| ARKUI_SHADOW_STYLE_OUTER_FLOATING_MD | Floating medium shadow. | 3646 3647 3648### ArkUI_ShadowType 3649 3650``` 3651enum ArkUI_ShadowType 3652``` 3653**Description** 3654 3655Defines the enumerated values of the shadow type. 3656 3657**Since**: 12 3658 3659| Enum| Description| 3660| -------- | -------- | 3661| ARKUI_SHADOW_TYPE_COLOR | Color. | 3662| ARKUI_SHADOW_TYPE_BLUR | Blur. | 3663 3664 3665### ArkUI_ShapeType 3666 3667``` 3668enum ArkUI_ShapeType 3669``` 3670**Description** 3671 3672Enumerates custom shape types. 3673 3674**Since**: 12 3675 3676| Enum| Description| 3677| -------- | -------- | 3678| ARKUI_SHAPE_TYPE_RECTANGLE | Rectangle. | 3679| ARKUI_SHAPE_TYPE_CIRCLE | **(circle)** | 3680| ARKUI_SHAPE_TYPE_ELLIPSE | Ellipse. | 3681| ARKUI_SHAPE_TYPE_PATH | Path Type | 3682 3683 3684### ArkUI_SliderBlockStyle 3685 3686``` 3687enum ArkUI_SliderBlockStyle 3688``` 3689**Description** 3690 3691Enumerates the styles of the slider in the block direction. 3692 3693**Since**: 12 3694 3695| Enum| Description| 3696| -------- | -------- | 3697| ARKUI_SLIDER_BLOCK_STYLE_DEFAULT | Round slider. | 3698| ARKUI_SLIDER_BLOCK_STYLE_IMAGE | Slider with an image background. | 3699| ARKUI_SLIDER_BLOCK_STYLE_SHAPE | Slider in a custom shape. | 3700 3701 3702### ArkUI_SliderDirection 3703 3704``` 3705enum ArkUI_SliderDirection 3706``` 3707**Description** 3708 3709Enumerates the scroll directions of the slider. 3710 3711**Since**: 12 3712 3713| Enum| Description| 3714| -------- | -------- | 3715| ARKUI_SLIDER_DIRECTION_VERTICAL | Vertical direction. | 3716| ARKUI_SLIDER_DIRECTION_HORIZONTAL | Horizontal direction. | 3717 3718 3719### ArkUI_SliderStyle 3720 3721``` 3722enum ArkUI_SliderStyle 3723``` 3724**Description** 3725 3726Enumerates the slider styles. 3727 3728**Since**: 12 3729 3730| Enum| Description| 3731| -------- | -------- | 3732| ARKUI_SLIDER_STYLE_OUT_SET | The slider is on the slider rail. | 3733| ARKUI_SLIDER_STYLE_IN_SET | The slider is in the slider rail. | 3734| ARKUI_SLIDER_STYLE_NONE | There is no thumb. | 3735 3736 3737### ArkUI_StickyStyle 3738 3739``` 3740enum ArkUI_StickyStyle 3741``` 3742**Description** 3743 3744Enumerates the modes for pinning the header to the top or the footer to the bottom. 3745 3746**Since**: 12 3747 3748| Enum| Description| 3749| -------- | -------- | 3750| 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. | 3751| 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. | 3752| 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. | 3753| ARKUI_STICKY_STYLE_BOTH | In the list item group, the footer is pinned to the bottom, and the header is pinned to the top. | 3754 3755 3756### ArkUI_SwiperArrow 3757 3758``` 3759enum ArkUI_SwiperArrow 3760``` 3761**Description** 3762 3763Enumerates arrow styles of the navigation point indicator. 3764 3765**Since**: 12 3766 3767| Enum| Description| 3768| -------- | -------- | 3769| ARKUI_SWIPER_ARROW_HIDE | The arrow is not displayed for the navigation point indicator. | 3770| ARKUI_SWIPER_ARROW_SHOW | The arrow is displayed for the navigation point indicator. | 3771| ARKUI_SWIPER_ARROW_SHOW_ON_HOVER | The arrow is displayed only when the mouse pointer hovers over the navigation point indicator. | 3772 3773 3774### ArkUI_SwiperDisplayModeType 3775 3776``` 3777enum ArkUI_SwiperDisplayModeType 3778``` 3779**Description** 3780 3781Enumerates the modes in which elements are displayed along the main axis of the **Swiper** component. 3782 3783**Since**: 12 3784 3785| Enum| Description| 3786| -------- | -------- | 3787| ARKUI_SWIPER_DISPLAY_MODE_STRETCH | The slide width of the **Swiper** component is equal to the width of the component. | 3788| 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. | 3789 3790 3791### ArkUI_SwiperIndicatorType 3792 3793``` 3794enum ArkUI_SwiperIndicatorType 3795``` 3796**Description** 3797 3798Enumerates the navigation point indicator types of the **Swiper** component. 3799 3800**Since**: 12 3801 3802| Enum| Description| 3803| -------- | -------- | 3804| ARKUI_SWIPER_INDICATOR_TYPE_DOT | Dot type. | 3805| ARKUI_SWIPER_INDICATOR_TYPE_DIGIT | Digit type. | 3806 3807 3808### ArkUI_SwiperNestedScrollMode 3809 3810``` 3811enum ArkUI_SwiperNestedScrollMode 3812``` 3813**Description** 3814 3815Enumerates the nested scrolling mode of the **Swiper** component and its parent container. 3816 3817**Since**: 12 3818 3819| Enum| Description| 3820| -------- | -------- | 3821| 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. | 3822| 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. | 3823 3824 3825### ArkUI_SystemColorMode 3826 3827``` 3828enum ArkUI_SystemColorMode 3829``` 3830**Description** 3831 3832Enumerates the system color modes. 3833 3834**Since**: 12 3835 3836| Enum| Description| 3837| -------- | -------- | 3838| ARKUI_SYSTEM_COLOR_MODE_LIGHT | Light mode. | 3839| ARKUI_SYSTEM_COLOR_MODE_DARK | Dark mode. | 3840 3841 3842### ArkUI_TextAlignment 3843 3844``` 3845enum ArkUI_TextAlignment 3846``` 3847**Description** 3848 3849Enumerates the text alignment mode. 3850 3851**Since**: 12 3852 3853| Enum| Description| 3854| -------- | -------- | 3855| ARKUI_TEXT_ALIGNMENT_START | Aligned with the start. | 3856| ARKUI_TEXT_ALIGNMENT_CENTER | Horizontally centered. | 3857| ARKUI_TEXT_ALIGNMENT_END | Aligned with the end. | 3858| ARKUI_TEXT_ALIGNMENT_JUSTIFY | Aligned with both margins. | 3859 3860 3861### ArkUI_TextAreaType 3862 3863``` 3864enum ArkUI_TextAreaType 3865``` 3866**Description** 3867 3868Enumerates the text box types. 3869 3870**Since**: 12 3871 3872| Enum| Description| 3873| -------- | -------- | 3874| ARKUI_TEXTAREA_TYPE_NORMAL | Normal input mode. | 3875| ARKUI_TEXTAREA_TYPE_NUMBER | Number input mode. | 3876| ARKUI_TEXTAREA_TYPE_PHONE_NUMBER | Phone number input mode. | 3877| ARKUI_TEXTAREA_TYPE_EMAIL | Email address input mode. | 3878 3879 3880### ArkUI_TextCase 3881 3882``` 3883enum ArkUI_TextCase 3884``` 3885**Description** 3886 3887Defines the enumerated values of text case. 3888 3889**Since**: 12 3890 3891| Enum| Description| 3892| -------- | -------- | 3893| ARKUI_TEXT_CASE_NORMAL | The original case of the text is retained. | 3894| ARKUI_TEXT_CASE_LOWER | All letters in the text are in lowercase. | 3895| ARKUI_TEXT_CASE_UPPER | All letters in the text are in uppercase. | 3896 3897 3898### ArkUI_TextCopyOptions 3899 3900``` 3901enum ArkUI_TextCopyOptions 3902``` 3903**Description** 3904 3905Enumerates copy options, which define whether copy and paste is allowed for text content. 3906 3907**Since**: 12 3908 3909| Enum| Description| 3910| -------- | -------- | 3911| ARKUI_TEXT_COPY_OPTIONS_NONE | Copy is not allowed. | 3912| ARKUI_TEXT_COPY_OPTIONS_IN_APP | Intra-application copy is allowed. | 3913| ARKUI_TEXT_COPY_OPTIONS_LOCAL_DEVICE | Intra-device copy is allowed. | 3914| ARKUI_TEXT_COPY_OPTIONS_CROSS_DEVICE | Cross-device copy is allowed. | 3915 3916 3917### ArkUI_TextDataDetectorType 3918 3919``` 3920enum ArkUI_TextDataDetectorType 3921``` 3922**Description** 3923 3924Enumerates the entity types of text recognition. 3925 3926**Since**: 12 3927 3928| Enum| Description| 3929| -------- | -------- | 3930| ARKUI_TEXT_DATA_DETECTOR_TYPE_PHONE_NUMBER | Phone number. | 3931| ARKUI_TEXT_DATA_DETECTOR_TYPE_URL | Link. | 3932| ARKUI_TEXT_DATA_DETECTOR_TYPE_EMAIL | Email | 3933| ARKUI_TEXT_DATA_DETECTOR_TYPE_ADDRESS | Network address. | 3934 3935 3936### ArkUI_TextDecorationStyle 3937 3938``` 3939enum ArkUI_TextDecorationStyle 3940``` 3941**Description** 3942 3943Enumerates the text decoration styles. 3944 3945**Since**: 12 3946 3947| Enum| Description| 3948| -------- | -------- | 3949| ARKUI_TEXT_DECORATION_STYLE_SOLID | Single solid line. | 3950| ARKUI_TEXT_DECORATION_STYLE_DOUBLE | Double solid line. | 3951| ARKUI_TEXT_DECORATION_STYLE_DOTTED | Dotted line. | 3952| ARKUI_TEXT_DECORATION_STYLE_DASHED | Dashed style. | 3953| ARKUI_TEXT_DECORATION_STYLE_WAVY | Wavy line. | 3954 3955 3956### ArkUI_TextDecorationType 3957 3958``` 3959enum ArkUI_TextDecorationType 3960``` 3961**Description** 3962 3963Enumerates the text decoration types. 3964 3965**Since**: 12 3966 3967| Enum| Description| 3968| -------- | -------- | 3969| ARKUI_TEXT_DECORATION_TYPE_NONE | No text decoration. | 3970| ARKUI_TEXT_DECORATION_TYPE_UNDERLINE | Line under the text. | 3971| ARKUI_TEXT_DECORATION_TYPE_OVERLINE | Line over the text. | 3972| ARKUI_TEXT_DECORATION_TYPE_LINE_THROUGH | Line through the text. | 3973 3974 3975### ArkUI_TextHeightAdaptivePolicy 3976 3977``` 3978enum ArkUI_TextHeightAdaptivePolicy 3979``` 3980**Description** 3981 3982Defines how the adaptive height is determined for the text. 3983 3984**Since**: 12 3985 3986| Enum| Description| 3987| -------- | -------- | 3988| ARKUI_TEXT_HEIGHT_ADAPTIVE_POLICY_MAX_LINES_FIRST | Prioritize the **maxLines** settings. | 3989| ARKUI_TEXT_HEIGHT_ADAPTIVE_POLICY_MIN_FONT_SIZE_FIRST | Prioritize the **minFontSize** settings. | 3990| ARKUI_TEXT_HEIGHT_ADAPTIVE_POLICY_LAYOUT_CONSTRAINT_FIRST | Prioritize the layout constraint settings in terms of height. | 3991 3992 3993### ArkUI_TextInputContentType 3994 3995``` 3996enum ArkUI_TextInputContentType 3997``` 3998**Description** 3999 4000Enumerates the autofill types. 4001 4002**Since**: 12 4003 4004| Enum| Description| 4005| -------- | -------- | 4006| ARKUI_TEXTINPUT_CONTENT_TYPE_USER_NAME | Username. Password Vault, when enabled, can automatically save and fill in usernames. | 4007| ARKUI_TEXTINPUT_CONTENT_TYPE_PASSWORD | Password. Password Vault, when enabled, can automatically save and fill in passwords. | 4008| ARKUI_TEXTINPUT_CONTENT_TYPE_NEW_PASSWORD | New password. Password Vault, when enabled, can automatically generate a new password. | 4009| 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. | 4010| ARKUI_TEXTINPUT_CONTENT_TYPE_HOUSE_NUMBER | House number. The scenario-based autofill feature, when enabled, can automatically save and fill in house numbers. | 4011| 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. | 4012| ARKUI_TEXTINPUT_CONTENT_TYPE_CITY_ADDRESS | City. The scenario-based autofill feature, when enabled, can automatically save and fill in cities. | 4013| ARKUI_TEXTINPUT_CONTENT_TYPE_PROVINCE_ADDRESS | Province. The scenario-based autofill feature, when enabled, can automatically save and fill in provinces. | 4014| ARKUI_TEXTINPUT_CONTENT_TYPE_COUNTRY_ADDRESS | Country. The scenario-based autofill feature, when enabled, can automatically save and fill in countries. | 4015| ARKUI_TEXTINPUT_CONTENT_TYPE_PERSON_FULL_NAME | Full name. The scenario-based autofill feature, when enabled, can automatically save and fill in full names. | 4016| ARKUI_TEXTINPUT_CONTENT_TYPE_PERSON_LAST_NAME | Last name. The scenario-based autofill feature, when enabled, can automatically save and fill in last names. | 4017| ARKUI_TEXTINPUT_CONTENT_TYPE_PERSON_FIRST_NAME | First name. The scenario-based autofill feature, when enabled, can automatically save and fill in first names. | 4018| ARKUI_TEXTINPUT_CONTENT_TYPE_PHONE_NUMBER | Phone number. The scenario-based autofill feature, when enabled, can automatically save and fill in phone numbers. | 4019| ARKUI_TEXTINPUT_CONTENT_TYPE_PHONE_COUNTRY_CODE | Country code. The scenario-based autofill feature, when enabled, can automatically save and fill in country codes. | 4020| 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. | 4021| ARKUI_TEXTINPUT_CONTENT_EMAIL_ADDRESS | Email address. The scenario-based autofill feature, when enabled, can automatically save and fill in email addresses. | 4022| 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. | 4023| 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. | 4024| ARKUI_TEXTINPUT_CONTENT_TYPE_NICKNAME | Nickname. The scenario-based autofill feature, when enabled, can automatically save and fill in nicknames. | 4025| 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. | 4026| ARKUI_TEXTINPUT_CONTENT_TYPE_FORMAT_ADDRESS | Standard address. The scenario-based autofill feature, when enabled, can automatically save and fill in standard addresses. | 4027 4028 4029### ArkUI_TextInputStyle 4030 4031``` 4032enum ArkUI_TextInputStyle 4033``` 4034**Description** 4035 4036Enumerates the text input styles. 4037 4038**Since**: 12 4039 4040| Enum| Description| 4041| -------- | -------- | 4042| 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. | 4043| ARKUI_TEXTINPUT_STYLE_INLINE | Inline input style. The background height of the selected text is the same as the height of the text box. | 4044 4045 4046### ArkUI_TextInputType 4047 4048``` 4049enum ArkUI_TextInputType 4050``` 4051**Description** 4052 4053Enumerates the text input types. 4054 4055**Since**: 12 4056 4057| Enum| Description| 4058| -------- | -------- | 4059| ARKUI_TEXTINPUT_TYPE_NORMAL | Normal input mode. | 4060| ARKUI_TEXTINPUT_TYPE_NUMBER | Number input mode. | 4061| ARKUI_TEXTINPUT_TYPE_PHONE_NUMBER | Phone number input mode. | 4062| ARKUI_TEXTINPUT_TYPE_EMAIL | Email address input mode. | 4063| ARKUI_TEXTINPUT_TYPE_PASSWORD | Password input mode. | 4064| ARKUI_TEXTINPUT_TYPE_NUMBER_PASSWORD | Numeric password input mode. | 4065| ARKUI_TEXTINPUT_TYPE_SCREEN_LOCK_PASSWORD | Lock screen password input mode. | 4066| ARKUI_TEXTINPUT_TYPE_USER_NAME | Username input mode. | 4067| ARKUI_TEXTINPUT_TYPE_NEW_PASSWORD | New password input mode. | 4068| ARKUI_TEXTINPUT_TYPE_NUMBER_DECIMAL | Number input mode with a decimal point. | 4069 4070 4071### ArkUI_TextOverflow 4072 4073``` 4074enum ArkUI_TextOverflow 4075``` 4076**Description** 4077 4078Enumerates the display modes when the text is too long. 4079 4080**Since**: 12 4081 4082| Enum| Description| 4083| -------- | -------- | 4084| ARKUI_TEXT_OVERFLOW_NONE | Extra-long text is not clipped. | 4085| ARKUI_TEXT_OVERFLOW_CLIP | Extra-long text is clipped. | 4086| ARKUI_TEXT_OVERFLOW_ELLIPSIS | An ellipsis (...) is used to represent text overflow. | 4087| ARKUI_TEXT_OVERFLOW_MARQUEE | Text continuously scrolls when text overflow occurs. | 4088 4089 4090### ArkUI_TextPickerRangeType 4091 4092``` 4093enum ArkUI_TextPickerRangeType 4094``` 4095**Description** 4096 4097Enumerates the types of the text picker. 4098 4099**Since**: 12 4100 4101| Enum| Description| 4102| -------- | -------- | 4103| ARKUI_TEXTPICKER_RANGETYPE_SINGLE | Single-column text picker. | 4104| ARKUI_TEXTPICKER_RANGETYPE_MULTI | Multi-column text picker. | 4105| ARKUI_TEXTPICKER_RANGETYPE_RANGE_CONTENT | Single-column text picker with image resources. | 4106| ARKUI_TEXTPICKER_RANGETYPE_CASCADE_RANGE_CONTENT | Interconnected multi-column text picker. | 4107 4108 4109### ArkUI_ThemeColorMode 4110 4111``` 4112enum ArkUI_ThemeColorMode 4113``` 4114 4115| Enum| Description| 4116| -------- | -------- | 4117| ARKUI_THEME_COLOR_MODE_SYSTEM | Following the system color mode. | 4118| ARKUI_THEME_COLOR_MODE_LIGHT | Light color mode. | 4119| ARKUI_THEME_COLOR_MODE_DARK | Dark color mode. | 4120 4121 4122### ArkUI_TransitionEdge 4123 4124``` 4125enum ArkUI_TransitionEdge 4126``` 4127**Description** 4128 4129Enumerates the slide-in and slide-out positions of the component from the screen edge during transition. 4130 4131**Since**: 12 4132 4133| Enum| Description| 4134| -------- | -------- | 4135| ARKUI_TRANSITION_EDGE_TOP | Top edge of the window. | 4136| ARKUI_TRANSITION_EDGE_BOTTOM | Bottom edge of the window. | 4137| ARKUI_TRANSITION_EDGE_START | Left edge of the window. | 4138| ARKUI_TRANSITION_EDGE_END | Right edge of the window. | 4139 4140 4141### ArkUI_VerticalAlignment 4142 4143``` 4144enum ArkUI_VerticalAlignment 4145``` 4146**Description** 4147 4148Enumerates the vertical alignment modes. 4149 4150**Since**: 12 4151 4152| Enum| Description| 4153| -------- | -------- | 4154| ARKUI_VERTICAL_ALIGNMENT_TOP | Top aligned. | 4155| ARKUI_VERTICAL_ALIGNMENT_CENTER | Aligned with the center. This is the default alignment mode. | 4156| ARKUI_VERTICAL_ALIGNMENT_BOTTOM | Bottom aligned. | 4157 4158 4159### ArkUI_Visibility 4160 4161``` 4162enum ArkUI_Visibility 4163``` 4164**Description** 4165 4166Enumerates the visibility values. 4167 4168**Since**: 12 4169 4170| Enum| Description| 4171| -------- | -------- | 4172| ARKUI_VISIBILITY_VISIBLE | Display | 4173| ARKUI_VISIBILITY_HIDDEN | The component is hidden, and a placeholder is used for it in the layout. | 4174| ARKUI_VISIBILITY_NONE | The component is hidden. It is not involved in the layout, and no placeholder is used for it. | 4175 4176 4177### ArkUI_WordBreak 4178 4179``` 4180enum ArkUI_WordBreak 4181``` 4182**Description** 4183 4184Enumerates the word break rules. 4185 4186**Since**: 12 4187 4188| Enum| Description| 4189| -------- | -------- | 4190| 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). | 4191| 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**. | 4192| 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**. | 4193 4194 4195### ArkUI_XComponentType 4196 4197``` 4198enum ArkUI_XComponentType 4199``` 4200**Description** 4201 4202Defines the enumerated values of the XComponent type. 4203 4204**Since**: 12 4205 4206| Enum| Description| 4207| -------- | -------- | 4208| ARKUI_XCOMPONENT_TYPE_SURFACE | The custom content of EGL/OpenGL ES and media data is displayed individually on the screen. | 4209| ARKUI_XCOMPONENT_TYPE_TEXTURE | The custom content of EGL/OpenGL ES and media data is grouped and displayed together with content of the component. | 4210 4211 4212## Function Description 4213 4214 4215### OH_ArkUI_AccessibilityState_Create() 4216 4217``` 4218ArkUI_AccessibilityState* OH_ArkUI_AccessibilityState_Create (void ) 4219``` 4220**Description** 4221 4222Creates an accessibility state. 4223 4224**Since**: 12 4225 4226**Returns** 4227 4228Returns 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. 4229 4230 4231### OH_ArkUI_AccessibilityState_Dispose() 4232 4233``` 4234void OH_ArkUI_AccessibilityState_Dispose (ArkUI_AccessibilityState * state) 4235``` 4236**Description** 4237 4238Disposes of the pointer to an accessibility state. 4239 4240**Since**: 12 4241 4242**Parameters** 4243 4244| Name| Description| 4245| -------- | -------- | 4246| state | Pointer to an accessibility state object. | 4247 4248 4249### OH_ArkUI_AccessibilityState_GetCheckedState() 4250 4251``` 4252int32_t OH_ArkUI_AccessibilityState_GetCheckedState (ArkUI_AccessibilityState * state) 4253``` 4254**Description** 4255 4256Obtains the check box state of an accessibility state. 4257 4258**Since**: 12 4259 4260**Parameters** 4261 4262| Name| Description| 4263| -------- | -------- | 4264| state | Pointer to an accessibility state object. | 4265 4266**Returns** 4267 4268Returns 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. 4269 4270 4271### OH_ArkUI_AccessibilityState_IsDisabled() 4272 4273``` 4274int32_t OH_ArkUI_AccessibilityState_IsDisabled (ArkUI_AccessibilityState * state) 4275``` 4276**Description** 4277 4278Obtains whether an accessibility state is disabled. 4279 4280**Since**: 12 4281 4282**Parameters** 4283 4284| Name| Description| 4285| -------- | -------- | 4286| state | Pointer to an accessibility state object. | 4287 4288**Returns** 4289 4290Returns 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. 4291 4292 4293### OH_ArkUI_AccessibilityState_IsSelected() 4294 4295``` 4296int32_t OH_ArkUI_AccessibilityState_IsSelected (ArkUI_AccessibilityState * state) 4297``` 4298**Description** 4299 4300Obtains whether an accessibility state is selected. 4301 4302**Since**: 12 4303 4304**Parameters** 4305 4306| Name| Description| 4307| -------- | -------- | 4308| state | Pointer to an accessibility state object. | 4309 4310**Returns** 4311 4312Returns 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. 4313 4314 4315### OH_ArkUI_AccessibilityState_SetCheckedState() 4316 4317``` 4318void OH_ArkUI_AccessibilityState_SetCheckedState (ArkUI_AccessibilityState * state, int32_t checkedState ) 4319``` 4320**Description** 4321 4322Sets the check box state of an accessibility state. 4323 4324**Since**: 12 4325 4326**Parameters** 4327 4328| Name| Description| 4329| -------- | -------- | 4330| state | Pointer to an accessibility state object. | 4331| checkedState | Check box status. The parameter type is [ArkUI_AccessibilityCheckedState](#arkui_accessibilitycheckedstate). The default value is **ARKUI_ACCESSIBILITY_UNCHECKED**. | 4332 4333 4334### OH_ArkUI_AccessibilityState_SetDisabled() 4335 4336``` 4337void OH_ArkUI_AccessibilityState_SetDisabled (ArkUI_AccessibilityState * state, int32_t isDisabled ) 4338``` 4339**Description** 4340 4341Sets whether an accessibility state is disabled. 4342 4343**Since**: 12 4344 4345**Parameters** 4346 4347| Name| Description| 4348| -------- | -------- | 4349| state | Pointer to an accessibility state object. | 4350| 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**. | 4351 4352 4353### OH_ArkUI_AccessibilityState_SetSelected() 4354 4355``` 4356void OH_ArkUI_AccessibilityState_SetSelected (ArkUI_AccessibilityState * state, int32_t isSelected ) 4357``` 4358**Description** 4359 4360Sets whether an accessibility state is selected. 4361 4362**Since**: 12 4363 4364**Parameters** 4365 4366| Name| Description| 4367| -------- | -------- | 4368| state | Pointer to an accessibility state object. | 4369| 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**. | 4370 4371 4372### OH_ArkUI_AccessibilityValue_Create() 4373 4374``` 4375ArkUI_AccessibilityValue* OH_ArkUI_AccessibilityValue_Create (void ) 4376``` 4377**Description** 4378 4379Creates an **AccessibilityValue** instance. 4380 4381**Since**: 12 4382 4383**Returns** 4384 4385Returns the pointer to the created **AccessibilityValue** instance. 4386 4387 4388### OH_ArkUI_AccessibilityValue_Dispose() 4389 4390``` 4391void OH_ArkUI_AccessibilityValue_Dispose (ArkUI_AccessibilityValue * value) 4392``` 4393**Description** 4394 4395Disposes of the pointer to an **AccessibilityValue** instance. 4396 4397**Since**: 12 4398 4399**Parameters** 4400 4401| Name| Description| 4402| -------- | -------- | 4403| state | Pointer to an **AccessibilityValue** instance. | 4404 4405 4406### OH_ArkUI_AccessibilityValue_GetCurrent() 4407 4408``` 4409int32_t OH_ArkUI_AccessibilityValue_GetCurrent (ArkUI_AccessibilityValue * value) 4410``` 4411**Description** 4412 4413Obtains the current accessibility value. 4414 4415**Since**: 12 4416 4417**Parameters** 4418 4419| Name| Description| 4420| -------- | -------- | 4421| value | Pointer to an **AccessibilityValue** instance. | 4422 4423**Returns** 4424 4425Returns the current value based on the range component. The default value is **-1**. If a parameter error occurs, **-1** is returned. 4426 4427 4428### OH_ArkUI_AccessibilityValue_GetMax() 4429 4430``` 4431int32_t OH_ArkUI_AccessibilityValue_GetMax (ArkUI_AccessibilityValue * value) 4432``` 4433**Description** 4434 4435Obtains the maximum accessibility value. 4436 4437**Since**: 12 4438 4439**Parameters** 4440 4441| Name| Description| 4442| -------- | -------- | 4443| value | Pointer to an **AccessibilityValue** instance. | 4444 4445**Returns** 4446 4447Returns the maximum value based on the range component. The default value is **-1**. If a parameter error occurs, **-1** is returned. 4448 4449 4450### OH_ArkUI_AccessibilityValue_GetMin() 4451 4452``` 4453int32_t OH_ArkUI_AccessibilityValue_GetMin (ArkUI_AccessibilityValue * value) 4454``` 4455**Description** 4456 4457Obtains the minimum accessibility value. 4458 4459**Since**: 12 4460 4461**Parameters** 4462 4463| Name| Description| 4464| -------- | -------- | 4465| value | Pointer to an **AccessibilityValue** instance. | 4466 4467**Returns** 4468 4469Returns the minimum value based on the range component. The default value is **-1**. If a parameter error occurs, **-1** is returned. 4470 4471 4472### OH_ArkUI_AccessibilityValue_GetText() 4473 4474``` 4475const char* OH_ArkUI_AccessibilityValue_GetText (ArkUI_AccessibilityValue * value) 4476``` 4477**Description** 4478 4479Obtains the text description of an **AccessibilityValue** instance. 4480 4481**Since**: 12 4482 4483**Parameters** 4484 4485| Name| Description| 4486| -------- | -------- | 4487| value | Pointer to an **AccessibilityValue** instance. | 4488 4489**Returns** 4490 4491Returns the text description. The default value is an empty string. If a parameter error occurs, a null pointer is returned. 4492 4493 4494### OH_ArkUI_AccessibilityValue_SetCurrent() 4495 4496``` 4497void OH_ArkUI_AccessibilityValue_SetCurrent (ArkUI_AccessibilityValue * value, int32_t current ) 4498``` 4499**Description** 4500 4501Sets the current accessibility value. 4502 4503**Since**: 12 4504 4505**Parameters** 4506 4507| Name| Description| 4508| -------- | -------- | 4509| value | Pointer to an **AccessibilityValue** instance. | 4510| current | Current value based on the range component. The default value is **-1**. | 4511 4512 4513### OH_ArkUI_AccessibilityValue_SetMax() 4514 4515``` 4516void OH_ArkUI_AccessibilityValue_SetMax (ArkUI_AccessibilityValue * value, int32_t max ) 4517``` 4518**Description** 4519 4520Sets the maximum accessibility value. 4521 4522**Since**: 12 4523 4524**Parameters** 4525 4526| Name| Description| 4527| -------- | -------- | 4528| value | Pointer to an **AccessibilityValue** instance. | 4529| max | Maximum value based on the range component. The default value is **-1**. | 4530 4531 4532### OH_ArkUI_AccessibilityValue_SetMin() 4533 4534``` 4535void OH_ArkUI_AccessibilityValue_SetMin (ArkUI_AccessibilityValue * value, int32_t min ) 4536``` 4537**Description** 4538 4539Sets the minimum accessibility value. 4540 4541**Since**: 12 4542 4543**Parameters** 4544 4545| Name| Description| 4546| -------- | -------- | 4547| value | Pointer to an **AccessibilityValue** instance. | 4548| min | Minimum value based on the range component. The default value is **-1**. | 4549 4550 4551### OH_ArkUI_AccessibilityValue_SetText() 4552 4553``` 4554void OH_ArkUI_AccessibilityValue_SetText (ArkUI_AccessibilityValue * value, const char * text ) 4555``` 4556**Description** 4557 4558Sets the text description of an **AccessibilityValue** instance. 4559 4560**Since**: 12 4561 4562**Parameters** 4563 4564| Name| Description| 4565| -------- | -------- | 4566| value | Pointer to an **AccessibilityValue** instance. | 4567| text | Text description. The default value is an empty string. | 4568 4569 4570### OH_ArkUI_AlignmentRuleOption_Create() 4571 4572``` 4573ArkUI_AlignmentRuleOption* OH_ArkUI_AlignmentRuleOption_Create () 4574``` 4575**Description** 4576 4577Creates an alignment rule configuration for this **RelativeContainer** component. 4578 4579**Since**: 12 4580 4581**Returns** 4582 4583Alignment rule information. 4584 4585 4586### OH_ArkUI_AlignmentRuleOption_Dispose() 4587 4588``` 4589void OH_ArkUI_AlignmentRuleOption_Dispose (ArkUI_AlignmentRuleOption * option) 4590``` 4591**Description** 4592 4593Disposes of an alignment rule configuration of this **RelativeContainer** component. 4594 4595**Since**: 12 4596 4597**Parameters** 4598 4599| Name| Description| 4600| -------- | -------- | 4601| option | Pointer to an alignment rule configuration. | 4602 4603 4604### OH_ArkUI_AlignmentRuleOption_GetBiasHorizontal() 4605 4606``` 4607float OH_ArkUI_AlignmentRuleOption_GetBiasHorizontal (ArkUI_AlignmentRuleOption * option) 4608``` 4609**Description** 4610 4611Obtains the bias value in the horizontal direction. 4612 4613**Since**: 12 4614 4615**Parameters** 4616 4617| Name| Description| 4618| -------- | -------- | 4619| option | Pointer to an alignment rule configuration. | 4620 4621**Returns** 4622 4623Bias value in the horizontal direction. 4624 4625 4626### OH_ArkUI_AlignmentRuleOption_GetBiasVertical() 4627 4628``` 4629float OH_ArkUI_AlignmentRuleOption_GetBiasVertical (ArkUI_AlignmentRuleOption * option) 4630``` 4631**Description** 4632 4633Obtains the bias value in the vertical direction. 4634 4635**Since**: 12 4636 4637**Parameters** 4638 4639| Name| Description| 4640| -------- | -------- | 4641| option | Pointer to an alignment rule configuration. | 4642 4643**Returns** 4644 4645Returns the bias value in the vertical direction. 4646 4647 4648### OH_ArkUI_AlignmentRuleOption_GetBottomAlignment() 4649 4650``` 4651ArkUI_VerticalAlignment OH_ArkUI_AlignmentRuleOption_GetBottomAlignment (ArkUI_AlignmentRuleOption * option) 4652``` 4653**Description** 4654 4655Obtains the alignment mode in bottom alignment parameters. 4656 4657**Since**: 12 4658 4659**Parameters** 4660 4661| Name| Description| 4662| -------- | -------- | 4663| option | Pointer to an alignment rule configuration. | 4664 4665**Returns** 4666 4667Returns the alignment mode in bottom alignment parameters. 4668 4669 4670### OH_ArkUI_AlignmentRuleOption_GetBottomId() 4671 4672``` 4673const char* OH_ArkUI_AlignmentRuleOption_GetBottomId (ArkUI_AlignmentRuleOption * option) 4674``` 4675**Description** 4676 4677Obtains the ID in bottom alignment parameters. 4678 4679**Since**: 12 4680 4681**Parameters** 4682 4683| Name| Description| 4684| -------- | -------- | 4685| option | Pointer to an alignment rule configuration. | 4686 4687**Returns** 4688 4689Returns the ID in bottom alignment parameters. 4690 4691 4692### OH_ArkUI_AlignmentRuleOption_GetCenterAlignmentHorizontal() 4693 4694``` 4695ArkUI_HorizontalAlignment OH_ArkUI_AlignmentRuleOption_GetCenterAlignmentHorizontal (ArkUI_AlignmentRuleOption * option) 4696``` 4697**Description** 4698 4699Obtains the alignment mode in horizontal center alignment parameters. 4700 4701**Since**: 12 4702 4703**Parameters** 4704 4705| Name| Description| 4706| -------- | -------- | 4707| option | Pointer to an alignment rule configuration. | 4708 4709**Returns** 4710 4711Returns the alignment mode in horizontal center alignment parameters. 4712 4713### OH_ArkUI_AlignmentRuleOption_GetCenterAlignmentVertical() 4714 4715``` 4716ArkUI_VerticalAlignment OH_ArkUI_AlignmentRuleOption_GetCenterAlignmentVertical (ArkUI_AlignmentRuleOption * option) 4717``` 4718**Description** 4719 4720Obtains the alignment mode in vertical center alignment parameters. 4721 4722**Since**: 12 4723 4724**Parameters** 4725 4726| Name| Description| 4727| -------- | -------- | 4728| option | Pointer to an alignment rule configuration. | 4729 4730**Returns** 4731 4732Returns the alignment mode in vertical center alignment parameters. 4733 4734 4735### OH_ArkUI_AlignmentRuleOption_GetCenterIdHorizontal() 4736 4737``` 4738const char* OH_ArkUI_AlignmentRuleOption_GetCenterIdHorizontal (ArkUI_AlignmentRuleOption * option) 4739``` 4740**Description** 4741 4742Obtains the alignment mode in horizontal center alignment parameters. 4743 4744**Since**: 12 4745 4746**Parameters** 4747 4748| Name| Description| 4749| -------- | -------- | 4750| option | Pointer to an alignment rule configuration. | 4751 4752**Returns** 4753 4754Returns the alignment mode in horizontal center alignment parameters. 4755 4756 4757### OH_ArkUI_AlignmentRuleOption_GetCenterIdVertical() 4758 4759``` 4760const char* OH_ArkUI_AlignmentRuleOption_GetCenterIdVertical (ArkUI_AlignmentRuleOption * option) 4761``` 4762**Description** 4763 4764Obtains the ID in vertical center alignment parameters. 4765 4766**Since**: 12 4767 4768**Parameters** 4769 4770| Name| Description| 4771| -------- | -------- | 4772| option | Pointer to an alignment rule configuration. | 4773 4774**Returns** 4775 4776Returns the ID in vertical center alignment parameters. 4777 4778 4779### OH_ArkUI_AlignmentRuleOption_GetEndAlignment() 4780 4781``` 4782ArkUI_HorizontalAlignment OH_ArkUI_AlignmentRuleOption_GetEndAlignment (ArkUI_AlignmentRuleOption * option) 4783``` 4784**Description** 4785 4786Obtains the alignment mode in the right alignment parameters. 4787 4788**Since**: 12 4789 4790**Parameters** 4791 4792| Name| Description| 4793| -------- | -------- | 4794| option | Pointer to an alignment rule configuration. | 4795 4796**Returns** 4797 4798Returns the alignment mode in the right alignment parameters. 4799 4800 4801### OH_ArkUI_AlignmentRuleOption_GetEndId() 4802 4803``` 4804const char* OH_ArkUI_AlignmentRuleOption_GetEndId (ArkUI_AlignmentRuleOption * option) 4805``` 4806**Description** 4807 4808Obtains the ID in the right alignment parameters. 4809 4810**Since**: 12 4811 4812**Parameters** 4813 4814| Name| Description| 4815| -------- | -------- | 4816| option | Pointer to an alignment rule configuration. | 4817 4818**Returns** 4819 4820Returns the ID in the right alignment parameters. 4821 4822 4823### OH_ArkUI_AlignmentRuleOption_GetStartAlignment() 4824 4825``` 4826ArkUI_HorizontalAlignment OH_ArkUI_AlignmentRuleOption_GetStartAlignment (ArkUI_AlignmentRuleOption * option) 4827``` 4828**Description** 4829 4830Obtains the alignment mode in left alignment parameters. 4831 4832**Since**: 12 4833 4834**Parameters** 4835 4836| Name| Description| 4837| -------- | -------- | 4838| option | Pointer to an alignment rule configuration. | 4839 4840**Returns** 4841 4842Returns the alignment mode in left alignment parameters. 4843 4844 4845### OH_ArkUI_AlignmentRuleOption_GetStartId() 4846 4847``` 4848const char* OH_ArkUI_AlignmentRuleOption_GetStartId (ArkUI_AlignmentRuleOption * option) 4849``` 4850**Description** 4851 4852Obtains the ID in the left alignment parameters. 4853 4854**Since**: 12 4855 4856**Parameters** 4857 4858| Name| Description| 4859| -------- | -------- | 4860| option | Pointer to an alignment rule configuration. | 4861 4862**Returns** 4863 4864Returns the ID in left alignment parameters. 4865 4866 4867### OH_ArkUI_AlignmentRuleOption_GetTopAlignment() 4868 4869``` 4870ArkUI_VerticalAlignment OH_ArkUI_AlignmentRuleOption_GetTopAlignment (ArkUI_AlignmentRuleOption * option) 4871``` 4872**Description** 4873 4874Obtains the alignment mode in top alignment parameters. 4875 4876**Since**: 12 4877 4878**Parameters** 4879 4880| Name| Description| 4881| -------- | -------- | 4882| option | Pointer to an alignment rule configuration. | 4883 4884**Returns** 4885 4886Returns the alignment mode in top alignment parameters. 4887 4888 4889### OH_ArkUI_AlignmentRuleOption_GetTopId() 4890 4891``` 4892const char* OH_ArkUI_AlignmentRuleOption_GetTopId (ArkUI_AlignmentRuleOption * option) 4893``` 4894**Description** 4895 4896Obtains the ID in top alignment parameters. 4897 4898**Since**: 12 4899 4900**Parameters** 4901 4902| Name| Description| 4903| -------- | -------- | 4904| option | Pointer to an alignment rule configuration. | 4905 4906**Returns** 4907 4908Returns the ID in top alignment parameters. 4909 4910 4911### OH_ArkUI_AlignmentRuleOption_SetBiasHorizontal() 4912 4913``` 4914void OH_ArkUI_AlignmentRuleOption_SetBiasHorizontal (ArkUI_AlignmentRuleOption * option, float horizontal ) 4915``` 4916**Description** 4917 4918Sets the bias value of the component in the horizontal direction under the anchor constraints. 4919 4920**Since**: 12 4921 4922**Parameters** 4923 4924| Name| Description| 4925| -------- | -------- | 4926| option | Pointer to an alignment rule configuration. | 4927| horizontal | Bias value in the horizontal direction. | 4928 4929 4930### OH_ArkUI_AlignmentRuleOption_SetBiasVertical() 4931 4932``` 4933void OH_ArkUI_AlignmentRuleOption_SetBiasVertical (ArkUI_AlignmentRuleOption * option, float vertical ) 4934``` 4935**Description** 4936 4937Sets the bias value of the component in the vertical direction under the anchor constraints. 4938 4939**Since**: 12 4940 4941**Parameters** 4942 4943| Name| Description| 4944| -------- | -------- | 4945| option | Pointer to an alignment rule configuration. | 4946| horizontal | Bias value in the vertical direction. | 4947 4948 4949### OH_ArkUI_AlignmentRuleOption_SetBottom() 4950 4951``` 4952void OH_ArkUI_AlignmentRuleOption_SetBottom (ArkUI_AlignmentRuleOption * option, const char * id, ArkUI_VerticalAlignment alignment ) 4953``` 4954**Description** 4955 4956Sets the bottom alignment parameters. 4957 4958**Since**: 12 4959 4960**Parameters** 4961 4962| Name| Description| 4963| -------- | -------- | 4964| option | Pointer to an alignment rule configuration. | 4965| id | ID of the anchor component. | 4966| value | Alignment mode relative to the anchor component. | 4967 4968 4969### OH_ArkUI_AlignmentRuleOption_SetCenterHorizontal() 4970 4971``` 4972void OH_ArkUI_AlignmentRuleOption_SetCenterHorizontal (ArkUI_AlignmentRuleOption * option, const char * id, ArkUI_HorizontalAlignment alignment ) 4973``` 4974**Description** 4975 4976Sets the horizontal center alignment parameters. 4977 4978**Since**: 12 4979 4980**Parameters** 4981 4982| Name| Description| 4983| -------- | -------- | 4984| option | Pointer to an alignment rule configuration. | 4985| id | ID of the anchor component. | 4986| value | Alignment mode relative to the anchor component. | 4987 4988 4989### OH_ArkUI_AlignmentRuleOption_SetCenterVertical() 4990 4991``` 4992void OH_ArkUI_AlignmentRuleOption_SetCenterVertical (ArkUI_AlignmentRuleOption * option, const char * id, ArkUI_VerticalAlignment alignment ) 4993``` 4994**Description** 4995 4996Sets the vertical center alignment parameters. 4997 4998**Since**: 12 4999 5000**Parameters** 5001 5002| Name| Description| 5003| -------- | -------- | 5004| option | Pointer to an alignment rule configuration. | 5005| id | ID of the anchor component. | 5006| value | Alignment mode relative to the anchor component. | 5007 5008 5009### OH_ArkUI_AlignmentRuleOption_SetEnd() 5010 5011``` 5012void OH_ArkUI_AlignmentRuleOption_SetEnd (ArkUI_AlignmentRuleOption * option, const char * id, ArkUI_HorizontalAlignment alignment ) 5013``` 5014**Description** 5015 5016Sets the right alignment parameters. 5017 5018**Since**: 12 5019 5020**Parameters** 5021 5022| Name| Description| 5023| -------- | -------- | 5024| option | Pointer to an alignment rule configuration. | 5025| id | ID of the anchor component. | 5026| value | Alignment mode relative to the anchor component. | 5027 5028 5029### OH_ArkUI_AlignmentRuleOption_SetStart() 5030 5031``` 5032void OH_ArkUI_AlignmentRuleOption_SetStart (ArkUI_AlignmentRuleOption * option, const char * id, ArkUI_HorizontalAlignment alignment ) 5033``` 5034**Description** 5035 5036Sets the left alignment parameters. 5037 5038**Since**: 12 5039 5040**Parameters** 5041 5042| Name| Description| 5043| -------- | -------- | 5044| option | Pointer to an alignment rule configuration. | 5045| id | ID of the anchor component. | 5046| value | Alignment mode relative to the anchor component. | 5047 5048 5049### OH_ArkUI_AlignmentRuleOption_SetTop() 5050 5051``` 5052void OH_ArkUI_AlignmentRuleOption_SetTop (ArkUI_AlignmentRuleOption * option, const char * id, ArkUI_VerticalAlignment alignment ) 5053``` 5054**Description** 5055 5056Sets the top alignment parameters. 5057 5058**Since**: 12 5059 5060**Parameters** 5061 5062| Name| Description| 5063| -------- | -------- | 5064| option | Pointer to an alignment rule configuration. | 5065| id | ID of the anchor component. | 5066| value | Alignment mode relative to the anchor component. | 5067 5068 5069### OH_ArkUI_AllowNodeAllDropDataTypes() 5070 5071``` 5072int32_t OH_ArkUI_AllowNodeAllDropDataTypes (ArkUI_NodeHandle node) 5073``` 5074**Description** 5075 5076Configures the specified component to allow any data types. This API resets the settings configured through [OH_ArkUI_SetNodeAllowedDropDataTypes](#oh_arkui_setnodealloweddropdatatypes). 5077 5078**Since**: 12 5079 5080**Parameters** 5081 5082| Name| Description| 5083| -------- | -------- | 5084| node | Pointer to a component node. | 5085 5086**Returns** 5087 5088Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 5089 5090 5091### OH_ArkUI_AnimateOption_Create() 5092 5093``` 5094ArkUI_AnimateOption* OH_ArkUI_AnimateOption_Create () 5095``` 5096**Description** 5097 5098Creates an animation configuration. 5099 5100**Since**: 12 5101 5102**Returns** 5103 5104Returns the pointer to the created animation configuration. 5105 5106 5107### OH_ArkUI_AnimateOption_Dispose() 5108 5109``` 5110void OH_ArkUI_AnimateOption_Dispose (ArkUI_AnimateOption * option) 5111``` 5112**Description** 5113 5114Disposes of an animation configuration. 5115 5116**Since**: 12 5117 5118 5119### OH_ArkUI_AnimateOption_GetCurve() 5120 5121``` 5122ArkUI_AnimationCurve OH_ArkUI_AnimateOption_GetCurve (ArkUI_AnimateOption * option) 5123``` 5124**Description** 5125 5126Obtains an animation curve. 5127 5128**Since**: 12 5129 5130**Parameters** 5131 5132| Name| Description| 5133| -------- | -------- | 5134| option | Pointer to an animation configuration. | 5135 5136**Returns** 5137 5138Returns the animation curve. 5139 5140 5141### OH_ArkUI_AnimateOption_GetDelay() 5142 5143``` 5144int32_t OH_ArkUI_AnimateOption_GetDelay (ArkUI_AnimateOption * option) 5145``` 5146**Description** 5147 5148Obtains the animation delay, in milliseconds. 5149 5150**Since**: 12 5151 5152**Parameters** 5153 5154| Name| Description| 5155| -------- | -------- | 5156| option | Pointer to an animation configuration. | 5157 5158**Returns** 5159 5160Returns the animation delay. 5161 5162 5163### OH_ArkUI_AnimateOption_GetDuration() 5164 5165``` 5166int32_t OH_ArkUI_AnimateOption_GetDuration (ArkUI_AnimateOption * option) 5167``` 5168**Description** 5169 5170Obtains the animation duration, in milliseconds. 5171 5172**Since**: 12 5173 5174**Parameters** 5175 5176| Name| Description| 5177| -------- | -------- | 5178| option | Pointer to an animation configuration. | 5179 5180**Returns** 5181 5182Returns the animation duration. 5183 5184 5185### OH_ArkUI_AnimateOption_GetExpectedFrameRateRange() 5186 5187``` 5188ArkUI_ExpectedFrameRateRange* OH_ArkUI_AnimateOption_GetExpectedFrameRateRange (ArkUI_AnimateOption * option) 5189``` 5190**Description** 5191 5192Obtains the expected frame rate range of an animation. 5193 5194**Since**: 12 5195 5196**Parameters** 5197 5198| Name| Description| 5199| -------- | -------- | 5200| option | Pointer to an animation configuration. | 5201 5202**Returns** 5203 5204Returns the expected frame rate range. 5205 5206 5207### OH_ArkUI_AnimateOption_GetICurve() 5208 5209``` 5210ArkUI_CurveHandle OH_ArkUI_AnimateOption_GetICurve (ArkUI_AnimateOption * option) 5211``` 5212**Description** 5213 5214Obtains the animation curve of an animation. 5215 5216**Since**: 12 5217 5218**Parameters** 5219 5220| Name| Description| 5221| -------- | -------- | 5222| option | Pointer to an animation configuration. | 5223 5224**Returns** 5225 5226Returns the animation curve of the specified animation. 5227 5228 5229### OH_ArkUI_AnimateOption_GetIterations() 5230 5231``` 5232int32_t OH_ArkUI_AnimateOption_GetIterations (ArkUI_AnimateOption * option) 5233``` 5234**Description** 5235 5236Obtains the number of times that an animation is played. 5237 5238**Since**: 12 5239 5240**Parameters** 5241 5242| Name| Description| 5243| -------- | -------- | 5244| option | Pointer to an animation configuration. | 5245 5246**Returns** 5247 5248Returns the number of times that the animation is played. 5249 5250 5251### OH_ArkUI_AnimateOption_GetPlayMode() 5252 5253``` 5254ArkUI_AnimationPlayMode OH_ArkUI_AnimateOption_GetPlayMode (ArkUI_AnimateOption * option) 5255``` 5256**Description** 5257 5258Obtains the playback mode of an animation. 5259 5260**Since**: 12 5261 5262**Parameters** 5263 5264| Name| Description| 5265| -------- | -------- | 5266| option | Pointer to an animation configuration. | 5267 5268**Returns** 5269 5270Returns the animation playback mode. 5271 5272 5273### OH_ArkUI_AnimateOption_GetTempo() 5274 5275``` 5276float OH_ArkUI_AnimateOption_GetTempo (ArkUI_AnimateOption * option) 5277``` 5278**Description** 5279 5280Obtains the playback speed of an animation. 5281 5282**Since**: 12 5283 5284**Parameters** 5285 5286| Name| Description| 5287| -------- | -------- | 5288| option | Pointer to an animation configuration. | 5289 5290**Returns** 5291 5292Animation playback speed. 5293 5294 5295### OH_ArkUI_AnimateOption_SetCurve() 5296 5297``` 5298void OH_ArkUI_AnimateOption_SetCurve (ArkUI_AnimateOption * option, ArkUI_AnimationCurve value ) 5299``` 5300**Description** 5301 5302Sets the animation curve. 5303 5304**Since**: 12 5305 5306**Parameters** 5307 5308| Name| Description| 5309| -------- | -------- | 5310| option | Pointer to an animation configuration. | 5311| value | Animation curve. Default value: **ARKUI_CURVE_LINEAR**. | 5312 5313 5314### OH_ArkUI_AnimateOption_SetDelay() 5315 5316``` 5317void OH_ArkUI_AnimateOption_SetDelay (ArkUI_AnimateOption * option, int32_t value ) 5318``` 5319**Description** 5320 5321Sets the animation delay. 5322 5323**Since**: 12 5324 5325**Parameters** 5326 5327| Name| Description| 5328| -------- | -------- | 5329| option | Pointer to an animation configuration. | 5330| value | Delay of animation playback. | 5331 5332 5333### OH_ArkUI_AnimateOption_SetDuration() 5334 5335``` 5336void OH_ArkUI_AnimateOption_SetDuration (ArkUI_AnimateOption * option, int32_t value ) 5337``` 5338**Description** 5339 5340Sets the animation duration. 5341 5342**Since**: 12 5343 5344**Parameters** 5345 5346| Name| Description| 5347| -------- | -------- | 5348| option | Pointer to an animation configuration. | 5349| value | Duration, in milliseconds. | 5350 5351 5352### OH_ArkUI_AnimateOption_SetExpectedFrameRateRange() 5353 5354``` 5355void OH_ArkUI_AnimateOption_SetExpectedFrameRateRange (ArkUI_AnimateOption * option, ArkUI_ExpectedFrameRateRange * value ) 5356``` 5357**Description** 5358 5359Sets the expected frame rate range of the animation. 5360 5361**Since**: 12 5362 5363**Parameters** 5364 5365| Name| Description| 5366| -------- | -------- | 5367| option | Pointer to an animation configuration. | 5368| value | Expected frame rate range of the animation. | 5369 5370 5371### OH_ArkUI_AnimateOption_SetICurve() 5372 5373``` 5374void OH_ArkUI_AnimateOption_SetICurve (ArkUI_AnimateOption * option, ArkUI_CurveHandle value ) 5375``` 5376**Description** 5377 5378Sets the animation curve for an animation. 5379 5380**Since**: 12 5381 5382**Parameters** 5383 5384| Name| Description| 5385| -------- | -------- | 5386| option | Pointer to an animation configuration. | 5387| value | Animation curve settings. | 5388 5389**NOTE** 5390 5391This API is preferred over the value set by **OH_ArkUI_AnimateOption_SetCurve**. 5392 5393 5394### OH_ArkUI_AnimateOption_SetIterations() 5395 5396``` 5397void OH_ArkUI_AnimateOption_SetIterations (ArkUI_AnimateOption * option, int32_t value ) 5398``` 5399**Description** 5400 5401Sets the number of times that an animation is played. 5402 5403**Since**: 12 5404 5405**Parameters** 5406 5407| Name| Description| 5408| -------- | -------- | 5409| option | Pointer to an animation configuration. | 5410| value | Number of times that the animation is played. | 5411 5412 5413### OH_ArkUI_AnimateOption_SetPlayMode() 5414 5415``` 5416void OH_ArkUI_AnimateOption_SetPlayMode (ArkUI_AnimateOption * option, ArkUI_AnimationPlayMode value ) 5417``` 5418**Description** 5419 5420Sets the playback mode for an animation. 5421 5422**Since**: 12 5423 5424**Parameters** 5425 5426| Name| Description| 5427| -------- | -------- | 5428| option | Pointer to an animation configuration. | 5429| value | Animation playback mode. | 5430 5431 5432### OH_ArkUI_AnimateOption_SetTempo() 5433 5434``` 5435void OH_ArkUI_AnimateOption_SetTempo (ArkUI_AnimateOption * option, float value ) 5436``` 5437**Description** 5438 5439Sets the playback speed of an animation. 5440 5441**Since**: 12 5442 5443**Parameters** 5444 5445| Name| Description| 5446| -------- | -------- | 5447| option | Pointer to an animation configuration. | 5448| value | Animation playback speed. | 5449 5450 5451### OH_ArkUI_Animator_Cancel() 5452 5453``` 5454int32_t OH_ArkUI_Animator_Cancel (ArkUI_AnimatorHandle animator) 5455``` 5456**Description** 5457 5458Cancels the animation of an animator. 5459 5460**Parameters** 5461 5462| Name| Description| 5463| -------- | -------- | 5464| animator | Animator object. | 5465 5466**Returns** 5467 5468Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 5469 5470 5471### OH_ArkUI_Animator_Finish() 5472 5473``` 5474int32_t OH_ArkUI_Animator_Finish (ArkUI_AnimatorHandle animator) 5475``` 5476**Description** 5477 5478Ends the animation of an animator. 5479 5480**Parameters** 5481 5482| Name| Description| 5483| -------- | -------- | 5484| animator | Animator object. | 5485 5486**Returns** 5487 5488Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 5489 5490 5491### OH_ArkUI_Animator_Pause() 5492 5493``` 5494int32_t OH_ArkUI_Animator_Pause (ArkUI_AnimatorHandle animator) 5495``` 5496**Description** 5497 5498Pauses the animation of an animator. 5499 5500**Parameters** 5501 5502| Name| Description| 5503| -------- | -------- | 5504| animator | Animator object. | 5505 5506**Returns** 5507 5508Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 5509 5510 5511### OH_ArkUI_Animator_Play() 5512 5513``` 5514int32_t OH_ArkUI_Animator_Play (ArkUI_AnimatorHandle animator) 5515``` 5516**Description** 5517 5518Starts the animation of an animator. 5519 5520**Parameters** 5521 5522| Name| Description| 5523| -------- | -------- | 5524| animator | Animator object. | 5525 5526**Returns** 5527 5528Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 5529 5530 5531### OH_ArkUI_Animator_ResetAnimatorOption() 5532 5533``` 5534int32_t OH_ArkUI_Animator_ResetAnimatorOption (ArkUI_AnimatorHandle animator, ArkUI_AnimatorOption * option ) 5535``` 5536**Description** 5537 5538Resets an animator configuration. 5539 5540**Parameters** 5541 5542| Name| Description| 5543| -------- | -------- | 5544| animator | Animator object. | 5545| option | Pointer to an animation configuration. | 5546 5547**Returns** 5548 5549Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 5550 5551 5552### OH_ArkUI_Animator_Reverse() 5553 5554``` 5555int32_t OH_ArkUI_Animator_Reverse (ArkUI_AnimatorHandle animator) 5556``` 5557**Description** 5558 5559Plays the animation of an animator in reverse order. 5560 5561**Parameters** 5562 5563| Name| Description| 5564| -------- | -------- | 5565| animator | Animator object. | 5566 5567**Returns** 5568 5569Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 5570 5571 5572### OH_ArkUI_AnimatorEvent_GetUserData() 5573 5574``` 5575void* OH_ArkUI_AnimatorEvent_GetUserData (ArkUI_AnimatorEvent * event) 5576``` 5577**Description** 5578 5579Obtains the custom object in an animation event object. 5580 5581**Since**: 12 5582 5583**Parameters** 5584 5585| Name| Description| 5586| -------- | -------- | 5587| event | Animation event object. | 5588 5589**Returns** 5590 5591Returns the custom object. 5592 5593 5594### OH_ArkUI_AnimatorOnFrameEvent_GetUserData() 5595 5596``` 5597void* OH_ArkUI_AnimatorOnFrameEvent_GetUserData (ArkUI_AnimatorOnFrameEvent * event) 5598``` 5599**Description** 5600 5601Obtains the custom object in an animation event object. 5602 5603**Since**: 12 5604 5605**Parameters** 5606 5607| Name| Description| 5608| -------- | -------- | 5609| event | Animation event object. | 5610 5611**Returns** 5612 5613Returns the custom object. 5614 5615 5616### OH_ArkUI_AnimatorOnFrameEvent_GetValue() 5617 5618``` 5619float OH_ArkUI_AnimatorOnFrameEvent_GetValue (ArkUI_AnimatorOnFrameEvent * event) 5620``` 5621**Description** 5622 5623Obtains the current progress in an animation event object. 5624 5625**Since**: 12 5626 5627**Parameters** 5628 5629| Name| Description| 5630| -------- | -------- | 5631| event | Animation event object. | 5632 5633**Returns** 5634 5635Returns the animation progress. 5636 5637 5638### OH_ArkUI_AnimatorOption_Create() 5639 5640``` 5641ArkUI_AnimatorOption* OH_ArkUI_AnimatorOption_Create (int32_t keyframeSize) 5642``` 5643**Description** 5644 5645Creates an animator parameter object. 5646 5647**Since**: 12 5648 5649**Parameters** 5650 5651| Name| Description| 5652| -------- | -------- | 5653| keyframeSize | Number of keyframes. | 5654 5655**NOTE** 5656 5657If 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. 5658 5659**Returns** 5660 5661Returns the pointer to the animator parameter object. 5662 5663 5664### OH_ArkUI_AnimatorOption_Dispose() 5665 5666``` 5667void OH_ArkUI_AnimatorOption_Dispose (ArkUI_AnimatorOption * option) 5668``` 5669**Description** 5670 5671Disposes of an **AnimatorOption** object. 5672 5673**Since**: 12 5674 5675 5676### OH_ArkUI_AnimatorOption_GetBegin() 5677 5678``` 5679float OH_ArkUI_AnimatorOption_GetBegin (ArkUI_AnimatorOption * option) 5680``` 5681**Description** 5682 5683Obtains the interpolation start point of an animation. 5684 5685**Since**: 12 5686 5687**Parameters** 5688 5689| Name| Description| 5690| -------- | -------- | 5691| option | Pointer to an animation configuration. | 5692 5693**Returns** 5694 5695Returns the start point of the animation interpolation. 5696 5697 5698### OH_ArkUI_AnimatorOption_GetCurve() 5699 5700``` 5701ArkUI_CurveHandle OH_ArkUI_AnimatorOption_GetCurve (ArkUI_AnimatorOption * option) 5702``` 5703**Description** 5704 5705Obtains the interpolation curve of the animation of an animator. 5706 5707**Since**: 12 5708 5709**Parameters** 5710 5711| Name| Description| 5712| -------- | -------- | 5713| option | Pointer to an animation configuration. | 5714 5715**Returns** 5716 5717Returns the interpolation curve of the animation. 5718 5719 5720### OH_ArkUI_AnimatorOption_GetDelay() 5721 5722``` 5723int32_t OH_ArkUI_AnimatorOption_GetDelay (ArkUI_AnimatorOption * option) 5724``` 5725**Description** 5726 5727Obtains the delay for playing an animation. 5728 5729**Since**: 12 5730 5731**Parameters** 5732 5733| Name| Description| 5734| -------- | -------- | 5735| option | Pointer to an animation configuration. | 5736 5737**Returns** 5738 5739Returns the delay for playing the animation, in milliseconds. 5740 5741 5742### OH_ArkUI_AnimatorOption_GetDirection() 5743 5744``` 5745ArkUI_AnimationDirection OH_ArkUI_AnimatorOption_GetDirection (ArkUI_AnimatorOption * option) 5746``` 5747**Description** 5748 5749Obtains the playback direction of an animation. 5750 5751**Since**: 12 5752 5753**Parameters** 5754 5755| Name| Description| 5756| -------- | -------- | 5757| option | Pointer to an animation configuration. | 5758 5759**Returns** 5760 5761Returns the animation playback direction. 5762 5763 5764### OH_ArkUI_AnimatorOption_GetDuration() 5765 5766``` 5767int32_t OH_ArkUI_AnimatorOption_GetDuration (ArkUI_AnimatorOption * option) 5768``` 5769**Description** 5770 5771Obtains the duration for playing an animation. 5772 5773**Since**: 12 5774 5775**Parameters** 5776 5777| Name| Description| 5778| -------- | -------- | 5779| option | Pointer to an animation configuration. | 5780 5781**Returns** 5782 5783Returns the duration for playing the animation, in milliseconds. 5784 5785 5786### OH_ArkUI_AnimatorOption_GetEnd() 5787 5788``` 5789float OH_ArkUI_AnimatorOption_GetEnd (ArkUI_AnimatorOption * option) 5790``` 5791**Description** 5792 5793Obtains the interpolation end point of an animation. 5794 5795**Since**: 12 5796 5797**Parameters** 5798 5799| Name| Description| 5800| -------- | -------- | 5801| option | Pointer to an animation configuration. | 5802 5803**Returns** 5804 5805Returns the interpolation end point of the animation. 5806 5807 5808### OH_ArkUI_AnimatorOption_GetExpectedFrameRateRange() 5809 5810``` 5811ArkUI_ExpectedFrameRateRange* OH_ArkUI_AnimatorOption_GetExpectedFrameRateRange (ArkUI_AnimatorOption * option) 5812``` 5813**Description** 5814 5815Obtains the expected frame rate range of an animation. 5816 5817**Since**: 12 5818 5819**Parameters** 5820 5821| Name| Description| 5822| -------- | -------- | 5823| option | Pointer to an animation configuration. | 5824 5825**Returns** 5826 5827Returns the pointer to the expected frame rate range object. 5828 5829 5830### OH_ArkUI_AnimatorOption_GetFill() 5831 5832``` 5833ArkUI_AnimationFill OH_ArkUI_AnimatorOption_GetFill (ArkUI_AnimatorOption * option) 5834``` 5835**Description** 5836 5837Obtains whether the animator animation is restored to the initial state after being executed. 5838 5839**Since**: 12 5840 5841**Parameters** 5842 5843| Name| Description| 5844| -------- | -------- | 5845| option | Pointer to an animation configuration. | 5846 5847**Returns** 5848 5849Returns whether the animator animation is restored to the initial state after being executed. 5850 5851 5852### OH_ArkUI_AnimatorOption_GetIterations() 5853 5854``` 5855int32_t OH_ArkUI_AnimatorOption_GetIterations (ArkUI_AnimatorOption * option) 5856``` 5857**Description** 5858 5859Obtains the number of times that an animation is played. 5860 5861**Since**: 12 5862 5863**Parameters** 5864 5865| Name| Description| 5866| -------- | -------- | 5867| option | Pointer to an **AnimatorOption** object. | 5868 5869**Returns** 5870 5871Number of times that the animation is played. 5872 5873### OH_ArkUI_AnimatorOption_GetKeyframeCurve() 5874 5875``` 5876ArkUI_CurveHandle OH_ArkUI_AnimatorOption_GetKeyframeCurve (ArkUI_AnimatorOption * option, int32_t index ) 5877``` 5878**Description** 5879 5880Obtains the interpolation curve for a keyframe in the animation of an animator. 5881 5882**Since**: 12 5883 5884**Parameters** 5885 5886| Name| Description| 5887| -------- | -------- | 5888| option | Pointer to an **AnimatorOption** object. | 5889| index | Keyframe index. | 5890 5891**Returns** 5892 5893Returns the interpolation curve. 5894 5895 5896### OH_ArkUI_AnimatorOption_GetKeyframeTime() 5897 5898``` 5899float OH_ArkUI_AnimatorOption_GetKeyframeTime (ArkUI_AnimatorOption * option, int32_t index ) 5900``` 5901**Description** 5902 5903Obtains the keyframe time of an animation. 5904 5905**Since**: 12 5906 5907**Parameters** 5908 5909| Name| Description| 5910| -------- | -------- | 5911| option | Pointer to an **AnimatorOption** object. | 5912| index | Keyframe index. | 5913 5914**Returns** 5915 5916Keyframe time. 5917 5918 5919### OH_ArkUI_AnimatorOption_GetKeyframeValue() 5920 5921``` 5922float OH_ArkUI_AnimatorOption_GetKeyframeValue (ArkUI_AnimatorOption * option, int32_t index ) 5923``` 5924**Description** 5925 5926Obtains the keyframe value of an animation. 5927 5928**Since**: 12 5929 5930**Parameters** 5931 5932| Name| Description| 5933| -------- | -------- | 5934| option | Pointer to an **AnimatorOption** object. | 5935| index | Keyframe index. | 5936 5937**Returns** 5938 5939Keyframe value. 5940 5941 5942### OH_ArkUI_AnimatorOption_RegisterOnCancelCallback() 5943 5944``` 5945int32_t OH_ArkUI_AnimatorOption_RegisterOnCancelCallback (ArkUI_AnimatorOption * option, void * userData, void(*)(ArkUI_AnimatorEvent *event) callback ) 5946``` 5947**Description** 5948 5949Sets the callback invoked when the animation playback is canceled. 5950 5951**Parameters** 5952 5953| Name| Description| 5954| -------- | -------- | 5955| option | Pointer to an animation configuration. | 5956| userData | Custom parameter. | 5957| callback | Callback used to return the result. | 5958 5959**Returns** 5960 5961Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 5962 5963 5964### OH_ArkUI_AnimatorOption_RegisterOnFinishCallback() 5965 5966``` 5967int32_t OH_ArkUI_AnimatorOption_RegisterOnFinishCallback (ArkUI_AnimatorOption * option, void * userData, void(*)(ArkUI_AnimatorEvent *event) callback ) 5968``` 5969**Description** 5970 5971Sets the callback invoked when the animation playback is complete. 5972 5973**Parameters** 5974 5975| Name| Description| 5976| -------- | -------- | 5977| option | Pointer to an animation configuration. | 5978| userData | Custom parameter. | 5979| callback | Callback used to return the result. | 5980 5981**Returns** 5982 5983Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 5984 5985 5986### OH_ArkUI_AnimatorOption_RegisterOnFrameCallback() 5987 5988``` 5989int32_t OH_ArkUI_AnimatorOption_RegisterOnFrameCallback (ArkUI_AnimatorOption * option, void * userData, void(*)(ArkUI_AnimatorOnFrameEvent *event) callback ) 5990``` 5991**Description** 5992 5993Sets the callback invoked when the animator receives a frame. 5994 5995**Parameters** 5996 5997| Name| Description| 5998| -------- | -------- | 5999| option | Pointer to an animation configuration. | 6000| userData | Custom parameter. | 6001| callback | Callback used to return the result. | 6002 6003**Returns** 6004 6005Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6006 6007 6008### OH_ArkUI_AnimatorOption_RegisterOnRepeatCallback() 6009 6010``` 6011int32_t OH_ArkUI_AnimatorOption_RegisterOnRepeatCallback (ArkUI_AnimatorOption * option, void * userData, void(*)(ArkUI_AnimatorEvent *event) callback ) 6012``` 6013**Description** 6014 6015Sets the callback invoked when the animation playback is repeated. 6016 6017**Parameters** 6018 6019| Name| Description| 6020| -------- | -------- | 6021| option | Pointer to an animation configuration. | 6022| userData | Custom parameter. | 6023| callback | Callback used to return the result. | 6024 6025**Returns** 6026 6027Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6028 6029 6030### OH_ArkUI_AnimatorOption_SetBegin() 6031 6032``` 6033int32_t OH_ArkUI_AnimatorOption_SetBegin (ArkUI_AnimatorOption * option, float value ) 6034``` 6035**Description** 6036 6037Sets the interpolation start point for the animation of an animator. 6038 6039**Parameters** 6040 6041| Name| Description| 6042| -------- | -------- | 6043| option | Pointer to an **AnimatorOption** object. | 6044| value | Start point of the animation interpolation. | 6045 6046**NOTE** 6047 6048This API does not take effect when the animation is a keyframe animation. 6049 6050**Returns** 6051 6052Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6053 6054 6055### OH_ArkUI_AnimatorOption_SetCurve() 6056 6057``` 6058int32_t OH_ArkUI_AnimatorOption_SetCurve (ArkUI_AnimatorOption * option, ArkUI_CurveHandle value ) 6059``` 6060**Description** 6061 6062Sets the interpolation curve for the animation of an animator. 6063 6064**Parameters** 6065 6066| Name| Description| 6067| -------- | -------- | 6068| option | Pointer to an **AnimatorOption** object. | 6069| value | Interpolation curve of the animation. Default value: **ARKUI_CURVE_LINEAR**. | 6070 6071**NOTE** 6072 6073The **springCurve**, **springMotion**, **responsiveSpringMotion**, and **interpolatingSpring customCurve** curves are not supported. 6074 6075**Returns** 6076 6077Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6078 6079 6080### OH_ArkUI_AnimatorOption_SetDelay() 6081 6082``` 6083int32_t OH_ArkUI_AnimatorOption_SetDelay (ArkUI_AnimatorOption * option, int32_t value ) 6084``` 6085**Description** 6086 6087Sets the delay of animation playback, in milliseconds. 6088 6089**Parameters** 6090 6091| Name| Description| 6092| -------- | -------- | 6093| option | Pointer to an **AnimatorOption** object. | 6094| value | Animation delay, in milliseconds. | 6095 6096**Returns** 6097 6098Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6099 6100 6101### OH_ArkUI_AnimatorOption_SetDirection() 6102 6103``` 6104int32_t OH_ArkUI_AnimatorOption_SetDirection (ArkUI_AnimatorOption * option, ArkUI_AnimationDirection value ) 6105``` 6106**Description** 6107 6108Sets the playback direction. 6109 6110**Parameters** 6111 6112| Name| Description| 6113| -------- | -------- | 6114| option | Pointer to an **AnimatorOption** object. | 6115| value | Animation playback direction. | 6116 6117**Returns** 6118 6119Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6120 6121 6122### OH_ArkUI_AnimatorOption_SetDuration() 6123 6124``` 6125int32_t OH_ArkUI_AnimatorOption_SetDuration (ArkUI_AnimatorOption * option, int32_t value ) 6126``` 6127**Description** 6128 6129Sets the duration of an animation, in milliseconds. 6130 6131**Parameters** 6132 6133| Name| Description| 6134| -------- | -------- | 6135| option | Pointer to an **AnimatorOption** object. | 6136| value | Duration for playing the animation, in milliseconds. | 6137 6138**Returns** 6139 6140Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6141 6142 6143### OH_ArkUI_AnimatorOption_SetEnd() 6144 6145``` 6146int32_t OH_ArkUI_AnimatorOption_SetEnd (ArkUI_AnimatorOption * option, float value ) 6147``` 6148**Description** 6149 6150Sets the interpolation end point for the animation of an animator. 6151 6152**Parameters** 6153 6154| Name| Description| 6155| -------- | -------- | 6156| option | Pointer to an **AnimatorOption** object. | 6157| value | End point of animation interpolation. | 6158 6159**NOTE** 6160 6161This API does not take effect when the animation is a keyframe animation. 6162 6163**Returns** 6164 6165Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6166 6167 6168### OH_ArkUI_AnimatorOption_SetExpectedFrameRateRange() 6169 6170``` 6171int32_t OH_ArkUI_AnimatorOption_SetExpectedFrameRateRange (ArkUI_AnimatorOption * option, ArkUI_ExpectedFrameRateRange * value ) 6172``` 6173**Description** 6174 6175Sets the expected frame rate range of an animation. 6176 6177**Parameters** 6178 6179| Name| Description| 6180| -------- | -------- | 6181| option | Pointer to an **AnimatorOption** object. | 6182| value | Expected frame rate range. | 6183 6184**Returns** 6185 6186Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6187 6188 6189### OH_ArkUI_AnimatorOption_SetFill() 6190 6191``` 6192int32_t OH_ArkUI_AnimatorOption_SetFill (ArkUI_AnimatorOption * option, ArkUI_AnimationFill value ) 6193``` 6194**Description** 6195 6196Sets whether the animator animation is restored to the initial state after being executed. 6197 6198**Parameters** 6199 6200| Name| Description| 6201| -------- | -------- | 6202| option | Pointer to an **AnimatorOption** object. | 6203| value | Whether to restore the animation to the initial state after the animation is executed. | 6204 6205**Returns** 6206 6207Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6208 6209 6210### OH_ArkUI_AnimatorOption_SetIterations() 6211 6212``` 6213int32_t OH_ArkUI_AnimatorOption_SetIterations (ArkUI_AnimatorOption * option, int32_t value ) 6214``` 6215**Description** 6216 6217Sets 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. 6218 6219**Parameters** 6220 6221| Name| Description| 6222| -------- | -------- | 6223| option | Pointer to an **AnimatorOption** object. | 6224| value | Number of times that the animation is played. | 6225 6226**NOTE** 6227 6228If this parameter is set to a negative value other than **-1**, the value is invalid. In this case, the animation is played once. 6229 6230**Returns** 6231 6232Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6233 6234 6235### OH_ArkUI_AnimatorOption_SetKeyframe() 6236 6237``` 6238int32_t OH_ArkUI_AnimatorOption_SetKeyframe (ArkUI_AnimatorOption * option, float time, float value, int32_t index ) 6239``` 6240**Description** 6241 6242Sets the keyframe parameters of an animation. 6243 6244**Parameters** 6245 6246| Name| Description| 6247| -------- | -------- | 6248| option | Pointer to an **AnimatorOption** object. | 6249| time | Keyframe time. Value range: [0, 1]. The value must be in ascending order. | 6250| value | Keyframe value. | 6251| index | Keyframe index. | 6252 6253**Returns** 6254 6255Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6256 6257 6258### OH_ArkUI_AnimatorOption_SetKeyframeCurve() 6259 6260``` 6261int32_t OH_ArkUI_AnimatorOption_SetKeyframeCurve (ArkUI_AnimatorOption * option, ArkUI_CurveHandle value, int32_t index ) 6262``` 6263**Description** 6264 6265Sets the keyframe curve type for the animation of an animator. 6266 6267**Parameters** 6268 6269| Name| Description| 6270| -------- | -------- | 6271| option | Pointer to an **AnimatorOption** object. | 6272| value | Animation interpolation curve. | 6273| index | Keyframe index. | 6274 6275**NOTE** 6276 6277The **springCurve**, **springMotion**, **responsiveSpringMotion**, and **interpolatingSpring customCurve** curves are not supported. 6278 6279**Returns** 6280 6281Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 6282 6283 6284### OH_ArkUI_BarrierOption_Create() 6285 6286``` 6287ArkUI_BarrierOption* OH_ArkUI_BarrierOption_Create (int32_t size) 6288``` 6289**Description** 6290 6291Creates a barrier configuration for this **RelativeContainer** component. 6292 6293**Since**: 12 6294 6295**Parameters** 6296 6297| Name| Description| 6298| -------- | -------- | 6299| size | Number of barriers. | 6300 6301**Returns** 6302 6303Returns the barrier configuration. 6304 6305 6306### OH_ArkUI_BarrierOption_Dispose() 6307 6308``` 6309void OH_ArkUI_BarrierOption_Dispose (ArkUI_BarrierOption * barrierStyle) 6310``` 6311**Description** 6312 6313Disposes of a barrier configuration. 6314 6315**Since**: 12 6316 6317**Parameters** 6318 6319| Name| Description| 6320| -------- | -------- | 6321| barrierStyle | Pointer to a barrier configuration. | 6322 6323 6324### OH_ArkUI_BarrierOption_GetDirection() 6325 6326``` 6327ArkUI_BarrierDirection OH_ArkUI_BarrierOption_GetDirection (ArkUI_BarrierOption * barrierStyle, int32_t index ) 6328``` 6329**Description** 6330 6331Obtains the direction of a barrier. 6332 6333**Since**: 12 6334 6335**Parameters** 6336 6337| Name| Description| 6338| -------- | -------- | 6339| barrierStyle | Pointer to a barrier configuration. | 6340| index | Index of the barrier. | 6341 6342**Returns** 6343 6344Returns the direction of the barrier. 6345 6346 6347### OH_ArkUI_BarrierOption_GetId() 6348 6349``` 6350const char* OH_ArkUI_BarrierOption_GetId (ArkUI_BarrierOption * barrierStyle, int32_t index ) 6351``` 6352**Description** 6353 6354Obtains the ID of a barrier. 6355 6356**Since**: 12 6357 6358**Parameters** 6359 6360| Name| Description| 6361| -------- | -------- | 6362| barrierStyle | Pointer to a barrier configuration. | 6363| index | Index of the barrier. | 6364 6365**Returns** 6366 6367Returns the ID of the barrier. 6368 6369 6370### OH_ArkUI_BarrierOption_GetReferencedId() 6371 6372``` 6373const char* OH_ArkUI_BarrierOption_GetReferencedId (ArkUI_BarrierOption * barrierStyle, int32_t index, int32_t referencedIndex ) 6374``` 6375**Description** 6376 6377Obtains the referenced components of a barrier. 6378 6379**Since**: 12 6380 6381**Parameters** 6382 6383| Name| Description| 6384| -------- | -------- | 6385| barrierStyle | Pointer to a barrier configuration. | 6386| index | Index of the barrier. | 6387| referencedIndex | Index of the referenced component ID. | 6388 6389**Returns** 6390 6391Returns the referenced components of the barrier. 6392 6393 6394### OH_ArkUI_BarrierOption_GetReferencedIdSize() 6395 6396``` 6397int32_t OH_ArkUI_BarrierOption_GetReferencedIdSize (ArkUI_BarrierOption * barrierStyle, int32_t index ) 6398``` 6399**Description** 6400 6401Obtains the number of referenced components of a barrier. 6402 6403**Since**: 12 6404 6405**Parameters** 6406 6407| Name| Description| 6408| -------- | -------- | 6409| barrierStyle | Pointer to a barrier configuration. | 6410| index | Index of the barrier. | 6411 6412**Returns** 6413 6414Returns the number of referenced components of the barrier. 6415 6416 6417### OH_ArkUI_BarrierOption_SetDirection() 6418 6419``` 6420void OH_ArkUI_BarrierOption_SetDirection (ArkUI_BarrierOption * barrierStyle, ArkUI_BarrierDirection value, int32_t index ) 6421``` 6422**Description** 6423 6424Sets the direction of a barrier. 6425 6426**Since**: 12 6427 6428**Parameters** 6429 6430| Name| Description| 6431| -------- | -------- | 6432| barrierStyle | Pointer to a barrier configuration. | 6433| value | Direction. | 6434| index | Index of the barrier. | 6435 6436 6437### OH_ArkUI_BarrierOption_SetId() 6438 6439``` 6440void OH_ArkUI_BarrierOption_SetId (ArkUI_BarrierOption * barrierStyle, const char * value, int32_t index ) 6441``` 6442**Description** 6443 6444Sets the ID of a barrier. 6445 6446**Since**: 12 6447 6448**Parameters** 6449 6450| Name| Description| 6451| -------- | -------- | 6452| barrierStyle | Pointer to a barrier configuration. | 6453| value | ID of the barrier, which must be unique and cannot be the same as the name of any component in the container. | 6454| index | Index of the barrier. | 6455 6456 6457### OH_ArkUI_BarrierOption_SetReferencedId() 6458 6459``` 6460void OH_ArkUI_BarrierOption_SetReferencedId (ArkUI_BarrierOption * barrierStyle, const char * value, int32_t index ) 6461``` 6462**Description** 6463 6464Sets the referenced components of a barrier. 6465 6466**Since**: 12 6467 6468**Parameters** 6469 6470| Name| Description| 6471| -------- | -------- | 6472| barrierStyle | Pointer to a barrier configuration. | 6473| value | Referenced component IDs. | 6474| index | Index of the barrier. | 6475 6476 6477### OH_ArkUI_ConvertToHtml() 6478 6479``` 6480const char* OH_ArkUI_ConvertToHtml (ArkUI_StyledString_Descriptor * descriptor) 6481``` 6482**Description** 6483 6484Converts styled string information into HTML. 6485 6486**Since**: 14 6487 6488**Parameters** 6489 6490| Name| Description| 6491| -------- | -------- | 6492| descriptor | Pointer to an **ArkUI_StyledString_Descriptor** object. | 6493 6494**Returns** 6495 6496Returns 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. 6497 6498 6499### OH_ArkUI_CreateAsymmetricTransitionEffect() 6500 6501``` 6502ArkUI_TransitionEffect* OH_ArkUI_CreateAsymmetricTransitionEffect (ArkUI_TransitionEffect * appear, ArkUI_TransitionEffect * disappear ) 6503``` 6504**Description** 6505 6506Creates an asymmetric transition effect. 6507 6508**Since**: 12 6509 6510**Parameters** 6511 6512| Name| Description| 6513| -------- | -------- | 6514| appear | Transition effect for appearance. | 6515| disappear | Transition effect for disappearance. | 6516 6517**NOTE** 6518 6519If the **asymmetric** function is not used for constructing **TransitionEffect**, the transition effect takes effect for both appearance and disappearance of the component. 6520 6521**Returns** 6522 6523Returns the asymmetric transition effect; returns **NULL** if a parameter error occurs. 6524 6525 6526### OH_ArkUI_CreateDragActionWithContext() 6527 6528``` 6529ArkUI_DragAction* OH_ArkUI_CreateDragActionWithContext (ArkUI_ContextHandle uiContext) 6530``` 6531**Description** 6532 6533Creates a drag action object for the specified UI instance. 6534 6535**Since**: 12 6536 6537**Parameters** 6538 6539| Name| Description| 6540| -------- | -------- | 6541| uiContext | Pointer to the UI instance object. | 6542 6543**Returns** 6544 6545Returns the pointer to the created drag action object; returns null if the operation fails. 6546 6547 6548### OH_ArkUI_CreateDragActionWithNode() 6549 6550``` 6551ArkUI_DragAction* OH_ArkUI_CreateDragActionWithNode (ArkUI_NodeHandle node) 6552``` 6553**Description** 6554 6555Creates 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. 6556 6557**Since**: 12 6558 6559**Parameters** 6560 6561| Name| Description| 6562| -------- | -------- | 6563| node | Pointer to a component node. | 6564 6565**Returns** 6566 6567Returns the pointer to the created drag action object; returns null if the operation fails. 6568 6569 6570### OH_ArkUI_CreateDragPreviewOption() 6571 6572``` 6573ArkUI_DragPreviewOption* OH_ArkUI_CreateDragPreviewOption (void ) 6574``` 6575**Description** 6576 6577Creates an **ArkUI_DragPreviewOption** object. 6578 6579**Since**: 12 6580 6581**Returns** 6582 6583ArkUI_DragPreviewOption object. 6584 6585 6586### OH_ArkUI_CreateMovementTransitionEffect() 6587 6588``` 6589ArkUI_TransitionEffect* OH_ArkUI_CreateMovementTransitionEffect (ArkUI_TransitionEdge move) 6590``` 6591**Description** 6592 6593Creates a movement object for component transition. 6594 6595**Since**: 12 6596 6597**Parameters** 6598 6599| Name| Description| 6600| -------- | -------- | 6601| move | Panning type. | 6602 6603**Returns** 6604 6605Returns the movement object created for component transition; returns **NULL** if a parameter error occurs. 6606 6607 6608### OH_ArkUI_CreateOpacityTransitionEffect() 6609 6610``` 6611ArkUI_TransitionEffect* OH_ArkUI_CreateOpacityTransitionEffect (float opacity) 6612``` 6613**Description** 6614 6615Creates an opacity object for component transition. 6616 6617**Since**: 12 6618 6619**Parameters** 6620 6621| Name| Description| 6622| -------- | -------- | 6623| opacity | Opacity. The value range is [0, 1]. | 6624 6625**NOTE** 6626 6627If 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. 6628 6629**Returns** 6630 6631Returns the created opacity object for component transition. 6632 6633 6634### OH_ArkUI_CreateRotationTransitionEffect() 6635 6636``` 6637ArkUI_TransitionEffect* OH_ArkUI_CreateRotationTransitionEffect (ArkUI_RotationOptions * rotate) 6638``` 6639**Description** 6640 6641Creates a rotation object for component transition. 6642 6643**Since**: 12 6644 6645**Parameters** 6646 6647| Name| Description| 6648| -------- | -------- | 6649| rotate | Rotation parameter object during component transition. | 6650 6651**Returns** 6652 6653Returns the rotation object created for component transition; returns **NULL** if a parameter error occurs. 6654 6655 6656### OH_ArkUI_CreateScaleTransitionEffect() 6657 6658``` 6659ArkUI_TransitionEffect* OH_ArkUI_CreateScaleTransitionEffect (ArkUI_ScaleOptions * scale) 6660``` 6661**Description** 6662 6663Creates a scaling transition effect object. 6664 6665**Since**: 12 6666 6667**Parameters** 6668 6669| Name| Description| 6670| -------- | -------- | 6671| scale | Scaling settings for component transition. | 6672 6673**Returns** 6674 6675Returns the created scaling transition effect object; returns **NULL** if a parameter error occurs. 6676 6677 6678### OH_ArkUI_CreateTranslationTransitionEffect() 6679 6680``` 6681ArkUI_TransitionEffect* OH_ArkUI_CreateTranslationTransitionEffect (ArkUI_TranslationOptions * translate) 6682``` 6683**Description** 6684 6685Creates a translation transition effect object. 6686 6687**Since**: 12 6688 6689**Parameters** 6690 6691| Name| Description| 6692| -------- | -------- | 6693| translate | Translation settings for component transition. | 6694 6695**Returns** 6696 6697Returns the created translation transition effect object; returns **NULL** if a parameter error occurs. 6698 6699 6700### OH_ArkUI_Curve_CreateCubicBezierCurve() 6701 6702``` 6703ArkUI_CurveHandle OH_ArkUI_Curve_CreateCubicBezierCurve (float x1, float y1, float x2, float y2 ) 6704``` 6705**Description** 6706 6707Creates a cubic Bezier curve. 6708 6709**Parameters** 6710 6711| Name| Description| 6712| -------- | -------- | 6713| 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**. | 6714| y1 | Y coordinate of the first point on the Bezier curve. | 6715| 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**. | 6716| y2 | Y coordinate of the second point on the Bezier curve. | 6717 6718**Returns** 6719 6720Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 6721 6722 6723### OH_ArkUI_Curve_CreateCurveByType() 6724 6725``` 6726ArkUI_CurveHandle OH_ArkUI_Curve_CreateCurveByType (ArkUI_AnimationCurve curve) 6727``` 6728**Description** 6729 6730Implements initialization for the interpolation curve, which is used to create an interpolation curve based on the input parameter. 6731 6732**Parameters** 6733 6734| Name| Description| 6735| -------- | -------- | 6736| curve | Curve type. | 6737 6738**Returns** 6739 6740Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 6741 6742 6743### OH_ArkUI_Curve_CreateCustomCurve() 6744 6745``` 6746ArkUI_CurveHandle OH_ArkUI_Curve_CreateCustomCurve (void * userData, float(*)(float fraction, void *userdata) interpolate ) 6747``` 6748**Description** 6749 6750Creates a custom curve. 6751 6752**Parameters** 6753 6754| Name| Description| 6755| -------- | -------- | 6756| userData | Custom data. | 6757| 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. | 6758 6759**Returns** 6760 6761Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 6762 6763 6764### OH_ArkUI_Curve_CreateInterpolatingSpring() 6765 6766``` 6767ArkUI_CurveHandle OH_ArkUI_Curve_CreateInterpolatingSpring (float velocity, float mass, float stiffness, float damping ) 6768``` 6769**Description** 6770 6771Creates an interpolating spring curve animated from 0 to 1. The actual animation value is calculated based on the curve. 6772 6773**Parameters** 6774 6775| Name| Description| 6776| -------- | -------- | 6777| 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. | 6778| 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. | 6779| 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. | 6780| 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. | 6781 6782**NOTE** 6783 6784The animation duration is subject to the curve parameters, rather than the **duration** parameter in **animation** or **animateTo**. 6785 6786**Returns** 6787 6788Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 6789 6790 6791### OH_ArkUI_Curve_CreateResponsiveSpringMotion() 6792 6793``` 6794ArkUI_CurveHandle OH_ArkUI_Curve_CreateResponsiveSpringMotion (float response, float dampingFraction, float overlapDuration ) 6795``` 6796**Description** 6797 6798Creates 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**. 6799 6800**Parameters** 6801 6802| Name| Description| 6803| -------- | -------- | 6804| response | Duration of one complete oscillation. | 6805| 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. | 6806| 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. | 6807 6808**NOTE** 6809 6810The animation duration is subject to the curve parameters, rather than the **duration** parameter in **animation** or **animateTo**. 6811 6812**Returns** 6813 6814Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 6815 6816 6817### OH_ArkUI_Curve_CreateSpringCurve() 6818 6819``` 6820ArkUI_CurveHandle OH_ArkUI_Curve_CreateSpringCurve (float velocity, float mass, float stiffness, float damping ) 6821``` 6822**Description** 6823 6824Creates 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**. 6825 6826**Parameters** 6827 6828| Name| Description| 6829| -------- | -------- | 6830| 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. | 6831| 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. | 6832| 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. | 6833| 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. | 6834 6835**Returns** 6836 6837Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 6838 6839 6840### OH_ArkUI_Curve_CreateSpringMotion() 6841 6842``` 6843ArkUI_CurveHandle OH_ArkUI_Curve_CreateSpringMotion (float response, float dampingFraction, float overlapDuration ) 6844``` 6845**Description** 6846 6847Creates 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. 6848 6849**Parameters** 6850 6851| Name| Description| 6852| -------- | -------- | 6853| response | Duration of one complete oscillation. | 6854| 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. | 6855| 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. | 6856 6857**NOTE** 6858 6859The animation duration is subject to the curve parameters, rather than the **duration** parameter in **animation** or **animateTo**. 6860 6861**Returns** 6862 6863Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 6864 6865 6866### OH_ArkUI_Curve_CreateStepsCurve() 6867 6868``` 6869ArkUI_CurveHandle OH_ArkUI_Curve_CreateStepsCurve (int32_t count, bool end ) 6870``` 6871**Description** 6872 6873Creates a step curve. 6874 6875**Parameters** 6876 6877| Name| Description| 6878| -------- | -------- | 6879| count | Number of tiers. The value must be a positive integer. Value range: [1, +∞). | 6880| 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. | 6881 6882**Returns** 6883 6884Returns the pointer to the interpolation object of the curve; returns **NULL** if a parameter error occurs. 6885 6886 6887### OH_ArkUI_Curve_DisposeCurve() 6888 6889``` 6890void OH_ArkUI_Curve_DisposeCurve (ArkUI_CurveHandle curveHandle) 6891``` 6892**Description** 6893 6894Disposes of a custom curve. 6895 6896**Parameters** 6897 6898| Name| Description| 6899| -------- | -------- | 6900| curve | Returns the pointer to the interpolation object of the curve; | 6901 6902 6903### OH_ArkUI_CustomSpanDrawInfo_Create() 6904 6905``` 6906ArkUI_CustomSpanDrawInfo* OH_ArkUI_CustomSpanDrawInfo_Create (void ) 6907``` 6908**Description** 6909 6910Creates drawing information for this custom span. 6911 6912**Since**: 12 6913 6914**Returns** 6915 6916Returns a **CustomSpanDrawInfo** instance. If a null pointer is returned, the memory may be insufficient. 6917 6918 6919### OH_ArkUI_CustomSpanDrawInfo_Dispose() 6920 6921``` 6922void OH_ArkUI_CustomSpanDrawInfo_Dispose (ArkUI_CustomSpanDrawInfo * info) 6923``` 6924**Description** 6925 6926Disposes of drawing information for this custom span. 6927 6928**Since**: 12 6929 6930**Parameters** 6931 6932| Name| Description| 6933| -------- | -------- | 6934| info | Pointer to the drawing information of a custom span. | 6935 6936 6937### OH_ArkUI_CustomSpanDrawInfo_GetBaseline() 6938 6939``` 6940float OH_ArkUI_CustomSpanDrawInfo_GetBaseline (ArkUI_CustomSpanDrawInfo * info) 6941``` 6942**Description** 6943 6944Obtains the baseline offset of the custom span relative to the mounted component. 6945 6946**Since**: 12 6947 6948**Parameters** 6949 6950| Name| Description| 6951| -------- | -------- | 6952| info | Pointer to the drawing information of a custom span. | 6953 6954**Returns** 6955 6956Returns the baseline offset. If a parameter error occurs, **0.0f** is returned. A possible cause is that mandatory parameters are left unspecified. 6957 6958 6959### OH_ArkUI_CustomSpanDrawInfo_GetLineBottom() 6960 6961``` 6962float OH_ArkUI_CustomSpanDrawInfo_GetLineBottom (ArkUI_CustomSpanDrawInfo * info) 6963``` 6964**Description** 6965 6966Obtains the bottom margin of the custom span relative to the mounted component. 6967 6968**Since**: 12 6969 6970**Parameters** 6971 6972| Name| Description| 6973| -------- | -------- | 6974| info | Pointer to the drawing information of a custom span. | 6975 6976**Returns** 6977 6978Returns the bottom margin. If a parameter error occurs, **0.0f** is returned. A possible cause is that mandatory parameters are left unspecified. 6979 6980 6981### OH_ArkUI_CustomSpanDrawInfo_GetLineTop() 6982 6983``` 6984float OH_ArkUI_CustomSpanDrawInfo_GetLineTop (ArkUI_CustomSpanDrawInfo * info) 6985``` 6986**Description** 6987 6988Obtains the top margin of the custom span relative to the mounted component. 6989 6990**Since**: 12 6991 6992**Parameters** 6993 6994| Name| Description| 6995| -------- | -------- | 6996| info | Pointer to the drawing information of a custom span. | 6997 6998**Returns** 6999 7000Returns the top margin. If a parameter error occurs, **0.0f** is returned. A possible cause is that mandatory parameters are left unspecified. 7001 7002 7003### OH_ArkUI_CustomSpanDrawInfo_GetXOffset() 7004 7005``` 7006float OH_ArkUI_CustomSpanDrawInfo_GetXOffset (ArkUI_CustomSpanDrawInfo * info) 7007``` 7008**Description** 7009 7010Obtains the x-axis offset of the custom span relative to the mounted component. 7011 7012**Since**: 12 7013 7014**Parameters** 7015 7016| Name| Description| 7017| -------- | -------- | 7018| info | Pointer to the drawing information of a custom span. | 7019 7020**Returns** 7021 7022Returns the x-axis offset. If a parameter error occurs, **0.0f** is returned. A possible cause is that mandatory parameters are left unspecified. 7023 7024 7025### OH_ArkUI_CustomSpanMeasureInfo_Create() 7026 7027``` 7028ArkUI_CustomSpanMeasureInfo* OH_ArkUI_CustomSpanMeasureInfo_Create (void ) 7029``` 7030**Description** 7031 7032Creates measurement information for this custom span. 7033 7034**Since**: 12 7035 7036**Returns** 7037 7038Returns a **CustomSpanMeasureInfo** instance. If a null pointer is returned, the memory may be insufficient. 7039 7040 7041### OH_ArkUI_CustomSpanMeasureInfo_Dispose() 7042 7043``` 7044void OH_ArkUI_CustomSpanMeasureInfo_Dispose (ArkUI_CustomSpanMeasureInfo * info) 7045``` 7046**Description** 7047 7048Disposes of measurement information of a custom span. 7049 7050**Since**: 12 7051 7052**Parameters** 7053 7054| Name| Description| 7055| -------- | -------- | 7056| info | Pointer to the measurement information of a custom span. | 7057 7058 7059### OH_ArkUI_CustomSpanMeasureInfo_GetFontSize() 7060 7061``` 7062float OH_ArkUI_CustomSpanMeasureInfo_GetFontSize (ArkUI_CustomSpanMeasureInfo * info) 7063``` 7064**Description** 7065 7066Obtains the font size of the parent text node of a custom span. 7067 7068**Since**: 12 7069 7070**Parameters** 7071 7072| Name| Description| 7073| -------- | -------- | 7074| info | Pointer to the measurement information of a custom span. | 7075 7076**Returns** 7077 7078Returns 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. 7079 7080 7081### OH_ArkUI_CustomSpanMetrics_Create() 7082 7083``` 7084ArkUI_CustomSpanMetrics* OH_ArkUI_CustomSpanMetrics_Create (void ) 7085``` 7086**Description** 7087 7088Creates measurement metrics for this custom span. 7089 7090**Since**: 12 7091 7092**Returns** 7093 7094Returns a **CustomSpanMetrics** instance. If a null pointer is returned, the memory may be insufficient. 7095 7096 7097### OH_ArkUI_CustomSpanMetrics_Dispose() 7098 7099``` 7100void OH_ArkUI_CustomSpanMetrics_Dispose (ArkUI_CustomSpanMetrics * metrics) 7101``` 7102**Description** 7103 7104Disposes of measurement metrics of this custom span. 7105 7106**Since**: 12 7107 7108**Parameters** 7109 7110| Name| Description| 7111| -------- | -------- | 7112| metrics | Returns a **CustomSpanMetrics** instance. | 7113 7114 7115### OH_ArkUI_CustomSpanMetrics_SetHeight() 7116 7117``` 7118int32_t OH_ArkUI_CustomSpanMetrics_SetHeight (ArkUI_CustomSpanMetrics * metrics, float height ) 7119``` 7120**Description** 7121 7122Sets the height for a custom span. 7123 7124**Since**: 12 7125 7126**Parameters** 7127 7128| Name| Description| 7129| -------- | -------- | 7130| metrics | Returns a **CustomSpanMetrics** instance. | 7131| height | Height, in vp. | 7132 7133**Returns** 7134 7135Returns **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. 7136 7137 7138### OH_ArkUI_CustomSpanMetrics_SetWidth() 7139 7140``` 7141int32_t OH_ArkUI_CustomSpanMetrics_SetWidth (ArkUI_CustomSpanMetrics * metrics, float width ) 7142``` 7143**Description** 7144 7145Sets the width for a custom span. 7146 7147**Since**: 12 7148 7149**Parameters** 7150 7151| Name| Description| 7152| -------- | -------- | 7153| metrics | Returns a **CustomSpanMetrics** instance. | 7154| width | Width, in vp. | 7155 7156**Returns** 7157 7158Returns **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. 7159 7160 7161### OH_ArkUI_DialogDismissEvent_GetDismissReason() 7162 7163``` 7164int32_t OH_ArkUI_DialogDismissEvent_GetDismissReason (ArkUI_DialogDismissEvent * event) 7165``` 7166**Description** 7167 7168Obtains the dismissal reason from a dialog box dismiss event object. 7169 7170**Since**: 12 7171 7172**Parameters** 7173 7174| Name| Description| 7175| -------- | -------- | 7176| event | Pointer to a dialog box dismiss event object.| 7177 7178**Returns** 7179 7180Returns 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. 7181 7182### OH_ArkUI_DialogDismissEvent_GetUserData() 7183 7184``` 7185void* OH_ArkUI_DialogDismissEvent_GetUserData (ArkUI_DialogDismissEvent * event) 7186``` 7187**Description** 7188 7189Obtains the pointer to user data in a dialog box dismiss event object. 7190 7191**Since**: 12 7192 7193**Parameters** 7194 7195| Name| Description| 7196| -------- | -------- | 7197| event | Pointer to a dialog box dismiss event object.| 7198 7199**Returns** 7200 7201Returns the pointer to user data. 7202 7203 7204### OH_ArkUI_DialogDismissEvent_SetShouldBlockDismiss() 7205 7206``` 7207void OH_ArkUI_DialogDismissEvent_SetShouldBlockDismiss (ArkUI_DialogDismissEvent * event, bool shouldBlockDismiss ) 7208``` 7209**Description** 7210 7211Sets whether to block the system behavior of dismissing a dialog box. 7212 7213**Since**: 12 7214 7215**Parameters** 7216 7217| Name| Description| 7218| -------- | -------- | 7219| event | Pointer to a dialog box dismiss event object. | 7220| 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. | 7221 7222 7223### OH_ArkUI_DisallowNodeAnyDropDataTypes() 7224 7225``` 7226int32_t OH_ArkUI_DisallowNodeAnyDropDataTypes (ArkUI_NodeHandle node) 7227``` 7228**Description** 7229 7230The configuration component is not allowed to accept any data type. This interface resets the data type configured through [OH_ArkUI_SetNodeAllowedDropDataTypes](#oh_arkui_setnodealloweddropdatatypes). 7231 7232**Since**: 12 7233 7234**Parameters** 7235 7236| Name| Description| 7237| -------- | -------- | 7238| node | Pointer to a component node. | 7239 7240**Returns** 7241 7242Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7243 7244 7245### OH_ArkUI_DragAction_Dispose() 7246 7247``` 7248void OH_ArkUI_DragAction_Dispose (ArkUI_DragAction * dragAction) 7249``` 7250**Description** 7251 7252Disposes of an **ArkUI_DragAction** object. 7253 7254**Since**: 12 7255 7256**Parameters** 7257 7258| Name| Description| 7259| -------- | -------- | 7260| dragAction | Pointer to the target drag action object. | 7261 7262 7263### OH_ArkUI_DragAction_RegisterStatusListener() 7264 7265``` 7266int32_t OH_ArkUI_DragAction_RegisterStatusListener (ArkUI_DragAction * dragAction, void * userData, void(*)(ArkUI_DragAndDropInfo *dragAndDropInfo, void *userData) listener ) 7267``` 7268**Description** 7269 7270Registers a drag status listener. This listener can be used to check whether the data is successfully received and processed. 7271 7272**Since**: 12 7273 7274**Parameters** 7275 7276| Name| Description| 7277| -------- | -------- | 7278| dragAction | Pointer to the target drag action object. | 7279| userData | Custom user data. | 7280| 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. | 7281 7282**Returns** 7283 7284Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7285 7286 7287### OH_ArkUI_DragAction_SetData() 7288 7289``` 7290int32_t OH_ArkUI_DragAction_SetData (ArkUI_DragAction * dragAction, OH_UdmfData * data ) 7291``` 7292**Description** 7293 7294Sets the drag data. 7295 7296**Since**: 12 7297 7298**Parameters** 7299 7300| Name| Description| 7301| -------- | -------- | 7302| dragAction | Pointer to the target drag action object. | 7303| data | Drag data. | 7304 7305**Returns** 7306 7307Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7308 7309 7310### OH_ArkUI_DragAction_SetDragPreviewOption() 7311 7312``` 7313int32_t OH_ArkUI_DragAction_SetDragPreviewOption (ArkUI_DragAction * dragAction, ArkUI_DragPreviewOption * option ) 7314``` 7315**Description** 7316 7317Sets an **ArkUI_DragPreviewOption** object for the specified drag action object. 7318 7319**Since**: 12 7320 7321**Parameters** 7322 7323| Name| Description| 7324| -------- | -------- | 7325| dragAction | Pointer to the target drag action object. | 7326| option | Custom parameters. | 7327 7328**Returns** 7329 7330Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7331 7332 7333### OH_ArkUI_DragAction_SetPixelMaps() 7334 7335``` 7336int32_t OH_ArkUI_DragAction_SetPixelMaps (ArkUI_DragAction * dragAction, OH_PixelmapNative * pixelmapArray[], int32_t size ) 7337``` 7338**Description** 7339 7340Sets the drag previews for a drag action. 7341 7342**Since**: 12 7343 7344**Parameters** 7345 7346| Name| Description| 7347| -------- | -------- | 7348| dragAction | Pointer to the target drag action object. | 7349| pixelmapArray | Drag the bitmap array of the follower map. | 7350| size | Number of drag-and-drop images. | 7351 7352**Returns** 7353 7354Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7355 7356 7357### OH_ArkUI_DragAction_SetPointerId() 7358 7359``` 7360int32_t OH_ArkUI_DragAction_SetPointerId (ArkUI_DragAction * dragAction, int32_t pointer ) 7361``` 7362**Description** 7363 7364Sets 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. 7365 7366**Since**: 12 7367 7368**Parameters** 7369 7370| Name| Description| 7371| -------- | -------- | 7372| dragAction | Pointer to the target drag action object. | 7373| pointer | Pointer ID. The value ranges from 0 to 9. | 7374 7375**Returns** 7376 7377Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7378 7379 7380### OH_ArkUI_DragAction_SetTouchPointX() 7381 7382``` 7383int32_t OH_ArkUI_DragAction_SetTouchPointX (ArkUI_DragAction * dragAction, float x ) 7384``` 7385**Description** 7386 7387Sets the touch point relative to the upper left corner of the first drag preview (pixel map). 7388 7389**Since**: 12 7390 7391**Parameters** 7392 7393| Name| Description| 7394| -------- | -------- | 7395| dragAction | Pointer to the target drag action object. | 7396| x | X value of the hand point coordinate. | 7397 7398**Returns** 7399 7400Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7401 7402 7403### OH_ArkUI_DragAction_SetTouchPointY() 7404 7405``` 7406int32_t OH_ArkUI_DragAction_SetTouchPointY (ArkUI_DragAction * dragAction, float y ) 7407``` 7408**Description** 7409 7410Sets the touch point relative to the upper left corner of the first drag preview (pixel map). 7411 7412**Since**: 12 7413 7414**Parameters** 7415 7416| Name| Description| 7417| -------- | -------- | 7418| dragAction | Pointer to the target drag action object. | 7419| y | Y value of the hand point coordinate. | 7420 7421**Returns** 7422 7423Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7424 7425 7426### OH_ArkUI_DragAction_UnregisterStatusListener() 7427 7428``` 7429void OH_ArkUI_DragAction_UnregisterStatusListener (ArkUI_DragAction * dragAction) 7430``` 7431**Description** 7432 7433Unregisters a drag status listener. 7434 7435**Since**: 12 7436 7437**Parameters** 7438 7439| Name| Description| 7440| -------- | -------- | 7441| dragAction | Pointer to the target drag action object. | 7442 7443 7444### OH_ArkUI_DragAndDropInfo_GetDragEvent() 7445 7446``` 7447ArkUI_DragEvent* OH_ArkUI_DragAndDropInfo_GetDragEvent (ArkUI_DragAndDropInfo * dragAndDropInfo) 7448``` 7449**Description** 7450 7451Obtains a drag event based on the specified drag and drop information. The drag event can then be used to obtain the drag result. 7452 7453**Since**: 12 7454 7455**Parameters** 7456 7457| Name| Description| 7458| -------- | -------- | 7459| dragAndDropInfo | Drag-related information returned by the drag status listener. | 7460 7461**Returns** 7462 7463Returns an **ArkUI_DragEvent** object; returns null if an error occurs. 7464 7465 7466### OH_ArkUI_DragAndDropInfo_GetDragStatus() 7467 7468``` 7469ArkUI_DragStatus OH_ArkUI_DragAndDropInfo_GetDragStatus (ArkUI_DragAndDropInfo * dragAndDropInfo) 7470``` 7471**Description** 7472 7473Obtains the drag status of a drag action. 7474 7475**Since**: 12 7476 7477**Parameters** 7478 7479| Name| Description| 7480| -------- | -------- | 7481| dragAndDropInfo | Drag-related information returned by the drag status listener. | 7482 7483**Returns** 7484 7485Returns an **ArkUI_DragStatus** object; returns **ArkUI_DRAG_STATUS_UNKNOWN** if an error occurs. 7486 7487 7488### OH_ArkUI_DragEvent_DisableDefaultDropAnimation() 7489 7490``` 7491int32_t OH_ArkUI_DragEvent_DisableDefaultDropAnimation (ArkUI_DragEvent * event, bool disable ) 7492``` 7493**Description** 7494 7495Sets whether to disable the default drop animation, which is enabled by default. Use this API to apply a custom drop animation. 7496 7497**Since**: 12 7498 7499**Parameters** 7500 7501| Name| Description| 7502| -------- | -------- | 7503| event | Pointer to an **ArkUI_DragEvent** object. | 7504| disable | Whether to disable the default drop animation. The value **true** means to disable the default drop animation, and **false** means the opposite. | 7505 7506**Returns** 7507 7508Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7509 7510 7511### OH_ArkUI_DragEvent_GetDataTypes() 7512 7513``` 7514int32_t OH_ArkUI_DragEvent_GetDataTypes (ArkUI_DragEvent * event, char ** result[], int32_t length ) 7515``` 7516**Description** 7517 7518Obtains the type list of drag data types from a drag event. 7519 7520**Since**: 12 7521 7522**Parameters** 7523 7524| Name| Description| 7525| -------- | -------- | 7526| event | Pointer to an **ArkUI_DragEvent** object. | 7527| char | \*\*result[] Returns the type list of the dragged data. You need to create a string array first. | 7528| 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). | 7529 7530**Returns** 7531 7532Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7533 7534 7535### OH_ArkUI_DragEvent_GetDataTypesCount() 7536 7537``` 7538int32_t OH_ArkUI_DragEvent_GetDataTypesCount (ArkUI_DragEvent * event, int32_t * count ) 7539``` 7540**Description** 7541 7542Obtains the number of drag data types from a drag event. 7543 7544**Since**: 12 7545 7546**Parameters** 7547 7548| Name| Description| 7549| -------- | -------- | 7550| event | Pointer to an **ArkUI_DragEvent** object. | 7551| count | Output parameter, which returns the number of types of dragged data. | 7552 7553**Returns** 7554 7555Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7556 7557 7558### OH_ArkUI_DragEvent_GetDragResult() 7559 7560``` 7561int32_t OH_ArkUI_DragEvent_GetDragResult (ArkUI_DragEvent * event, ArkUI_DragResult * result ) 7562``` 7563**Description** 7564 7565Obtains the drag and drop result from the drag event. 7566 7567**Since**: 12 7568 7569**Parameters** 7570 7571| Name| Description| 7572| -------- | -------- | 7573| event | Pointer to an **ArkUI_DragEvent** object. | 7574| result | Output parameter, which returns the drag result corresponding to the drag event. | 7575 7576**Returns** 7577 7578Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7579 7580 7581### OH_ArkUI_DragEvent_GetModifierKeyStates() 7582 7583``` 7584int32_t OH_ArkUI_DragEvent_GetModifierKeyStates (ArkUI_DragEvent * event, int64_t * keys ) 7585``` 7586**Description** 7587 7588Obtains the pressed status of modifier keys from a drag event. 7589 7590**Since**: 12 7591 7592**Parameters** 7593 7594| Name| Description| 7595| -------- | -------- | 7596| event | Pointer to an **ArkUI_DragEvent** object. | 7597| keys | Returns the modifier key combination that is currently pressed. The application can determine the modifier key combination through bitwise operations. | 7598 7599**Returns** 7600 7601Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7602 7603 7604### OH_ArkUI_DragEvent_GetPreviewRectHeight() 7605 7606``` 7607float OH_ArkUI_DragEvent_GetPreviewRectHeight (ArkUI_DragEvent * event) 7608``` 7609**Description** 7610 7611Obtains the height of a drag preview from a drag event. 7612 7613**Since**: 12 7614 7615**Parameters** 7616 7617| Name| Description| 7618| -------- | -------- | 7619| event | Pointer to an **ArkUI_DragEvent** object. | 7620 7621**Returns** 7622 7623Returns the height of the drag preview, in px; returns the default value **0** if the input parameter is invalid. 7624 7625 7626### OH_ArkUI_DragEvent_GetPreviewRectWidth() 7627 7628``` 7629float OH_ArkUI_DragEvent_GetPreviewRectWidth (ArkUI_DragEvent * event) 7630``` 7631**Description** 7632 7633Obtains the width of a drag preview from a drag event. 7634 7635**Since**: 12 7636 7637**Parameters** 7638 7639| Name| Description| 7640| -------- | -------- | 7641| event | Pointer to an **ArkUI_DragEvent** object. | 7642 7643**Returns** 7644 7645Returns the width of the drag preview, in px; returns the default value **0** if the input parameter is invalid. 7646 7647 7648### OH_ArkUI_DragEvent_GetPreviewTouchPointX() 7649 7650``` 7651float OH_ArkUI_DragEvent_GetPreviewTouchPointX (ArkUI_DragEvent * event) 7652``` 7653**Description** 7654 7655Obtains the X coordinate of the touch point for a drag preview from a drag event. 7656 7657**Since**: 12 7658 7659**Parameters** 7660 7661| Name| Description| 7662| -------- | -------- | 7663| event | Pointer to an **ArkUI_DragEvent** object. | 7664 7665**Returns** 7666 7667Returns the X coordinate of the touch point, in px; returns the default value **0** if the input parameter is invalid. 7668 7669 7670### OH_ArkUI_DragEvent_GetPreviewTouchPointY() 7671 7672``` 7673float OH_ArkUI_DragEvent_GetPreviewTouchPointY (ArkUI_DragEvent * event) 7674``` 7675**Description** 7676 7677Obtains the Y coordinate of the touch point for a drag preview from a drag event. 7678 7679**Since**: 12 7680 7681**Parameters** 7682 7683| Name| Description| 7684| -------- | -------- | 7685| event | ArkUI_DragEvent event pointer. The unit is PX. If the input parameter is invalid, the default value 0 is returned. | 7686 7687**Returns** 7688 7689float returns the y-axis coordinate of the drag and hand point. 7690 7691 7692### OH_ArkUI_DragEvent_GetTouchPointXToDisplay() 7693 7694``` 7695float OH_ArkUI_DragEvent_GetTouchPointXToDisplay (ArkUI_DragEvent * event) 7696``` 7697**Description** 7698 7699Obtains the X coordinate of the touch point relative to the display from a drag event. 7700 7701**Since**: 12 7702 7703**Parameters** 7704 7705| Name| Description| 7706| -------- | -------- | 7707| event | Pointer to an **ArkUI_DragEvent** object. | 7708 7709**Returns** 7710 7711Returns the X coordinate of the touch point relative to the display, in px; returns the default value **0** if the input parameter is invalid. 7712 7713 7714### OH_ArkUI_DragEvent_GetTouchPointXToWindow() 7715 7716``` 7717float OH_ArkUI_DragEvent_GetTouchPointXToWindow (ArkUI_DragEvent * event) 7718``` 7719**Description** 7720 7721Obtains the X coordinate of the touch point relative to the window from a drag event. 7722 7723**Since**: 12 7724 7725**Parameters** 7726 7727| Name| Description| 7728| -------- | -------- | 7729| event | Pointer to an **ArkUI_DragEvent** object. | 7730 7731**Returns** 7732 7733Returns the X coordinate of the touch point relative to the window, in px; returns the default value **0** if the input parameter is invalid. 7734 7735 7736### OH_ArkUI_DragEvent_GetTouchPointYToDisplay() 7737 7738``` 7739float OH_ArkUI_DragEvent_GetTouchPointYToDisplay (ArkUI_DragEvent * event) 7740``` 7741**Description** 7742 7743Obtains the Y coordinate of the touch point relative to the display from a drag event. 7744 7745**Since**: 12 7746 7747**Parameters** 7748 7749| Name| Description| 7750| -------- | -------- | 7751| event | Pointer to an **ArkUI_DragEvent** object. | 7752 7753**Returns** 7754 7755Returns the Y coordinate of the touch point relative to the display, in px; returns the default value **0** if the input parameter is invalid. 7756 7757 7758### OH_ArkUI_DragEvent_GetTouchPointYToWindow() 7759 7760``` 7761float OH_ArkUI_DragEvent_GetTouchPointYToWindow (ArkUI_DragEvent * event) 7762``` 7763**Description** 7764 7765Obtains the Y coordinate of the touch point relative to the window from a drag event. 7766 7767**Since**: 12 7768 7769**Parameters** 7770 7771| Name| Description| 7772| -------- | -------- | 7773| event | Pointer to an **ArkUI_DragEvent** object. | 7774 7775**Returns** 7776 7777Returns the Y coordinate of the touch point relative to the window, in px; returns the default value **0** if the input parameter is invalid. 7778 7779 7780### OH_ArkUI_DragEvent_GetUdmfData() 7781 7782``` 7783int32_t OH_ArkUI_DragEvent_GetUdmfData (ArkUI_DragEvent * event, OH_UdmfData * data ) 7784``` 7785**Description** 7786 7787Obtain the default drag-and-drop data from ArkUI_DragEvent. 7788 7789**Since**: 12 7790 7791**Parameters** 7792 7793| Name| Description| 7794| -------- | -------- | 7795| event | Pointer to an **ArkUI_DragEvent** object. | 7796| 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. | 7797 7798**Returns** 7799 7800Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7801 7802 7803### OH_ArkUI_DragEvent_GetVelocity() 7804 7805``` 7806float OH_ArkUI_DragEvent_GetVelocity (ArkUI_DragEvent * event) 7807``` 7808**Description** 7809 7810Obtains the dragging velocity along the main axis. 7811 7812**Since**: 12 7813 7814**Parameters** 7815 7816| Name| Description| 7817| -------- | -------- | 7818| event | Pointer to an **ArkUI_DragEvent** object. | 7819 7820**Returns** 7821 7822Returns the dragging velocity along the main axis, in px; returns the default value **0** if the input parameter is invalid. 7823 7824 7825### OH_ArkUI_DragEvent_GetVelocityX() 7826 7827``` 7828float OH_ArkUI_DragEvent_GetVelocityX (ArkUI_DragEvent * event) 7829``` 7830**Description** 7831 7832Obtains the dragging velocity along the x-axis. 7833 7834**Since**: 12 7835 7836**Parameters** 7837 7838| Name| Description| 7839| -------- | -------- | 7840| event | Pointer to an **ArkUI_DragEvent** object. | 7841 7842**Returns** 7843 7844Returns the dragging velocity along the x-axis, in px; returns the default value **0** if the input parameter is invalid. 7845 7846 7847### OH_ArkUI_DragEvent_GetVelocityY() 7848 7849``` 7850float OH_ArkUI_DragEvent_GetVelocityY (ArkUI_DragEvent * event) 7851``` 7852**Description** 7853 7854Obtains the dragging velocity along the y-axis. 7855 7856**Since**: 12 7857 7858**Parameters** 7859 7860| Name| Description| 7861| -------- | -------- | 7862| event | Pointer to an **ArkUI_DragEvent** object. | 7863 7864**Returns** 7865 7866Returns the dragging velocity along the y-axis, in px; returns the default value **0** if the input parameter is invalid. 7867 7868 7869### OH_ArkUI_DragEvent_SetData() 7870 7871``` 7872int32_t OH_ArkUI_DragEvent_SetData (ArkUI_DragEvent * event, OH_UdmfData * data ) 7873``` 7874**Description** 7875 7876Sets drag data for a drag event. 7877 7878**Since**: 12 7879 7880**Parameters** 7881 7882| Name| Description| 7883| -------- | -------- | 7884| event | Pointer to an **ArkUI_DragEvent** object. | 7885| data | Drag data. | 7886 7887**Returns** 7888 7889Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7890 7891 7892### OH_ArkUI_DragEvent_SetDragResult() 7893 7894``` 7895int32_t OH_ArkUI_DragEvent_SetDragResult (ArkUI_DragEvent * event, ArkUI_DragResult result ) 7896``` 7897**Description** 7898 7899Sets the result for a drag event. 7900 7901**Since**: 12 7902 7903**Parameters** 7904 7905| Name| Description| 7906| -------- | -------- | 7907| event | Pointer to an **ArkUI_DragEvent** object. | 7908| result | Drag the data processing result. | 7909 7910**Returns** 7911 7912Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7913 7914 7915### OH_ArkUI_DragEvent_SetSuggestedDropOperation() 7916 7917``` 7918int32_t OH_ArkUI_DragEvent_SetSuggestedDropOperation (ArkUI_DragEvent * event, ArkUI_DropProposal proposal ) 7919``` 7920**Description** 7921 7922Sets the data processing mode. 7923 7924**Since**: 12 7925 7926**Parameters** 7927 7928| Name| Description| 7929| -------- | -------- | 7930| proposal | Recommended data processing mode | 7931| proposal | Type of the badge display status. | 7932 7933**Returns** 7934 7935Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7936 7937 7938### OH_ArkUI_DragPreviewOption_Dispose() 7939 7940``` 7941void OH_ArkUI_DragPreviewOption_Dispose (ArkUI_DragPreviewOption * option) 7942``` 7943**Description** 7944 7945Disposes of an **ArkUI_DragPreviewOption** object. 7946 7947**Since**: 12 7948 7949**Parameters** 7950 7951| Name| Description| 7952| -------- | -------- | 7953| option | Custom parameters. | 7954 7955 7956### OH_ArkUI_DragPreviewOption_SetBadgeNumber() 7957 7958``` 7959int32_t OH_ArkUI_DragPreviewOption_SetBadgeNumber (ArkUI_DragPreviewOption * option, uint32_t forcedNumber ) 7960``` 7961**Description** 7962 7963Sets the count on the badge. The settings will overwrite the value in the **SetDragPreviewNumberBadgeEnabled** API. 7964 7965**Since**: 12 7966 7967**Parameters** 7968 7969| Name| Description| 7970| -------- | -------- | 7971| option | Custom parameters. | 7972| forcedNumber | Number of corner marks. | 7973 7974**Returns** 7975 7976Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 7977 7978 7979### OH_ArkUI_DragPreviewOption_SetDefaultAnimationBeforeLiftingEnabled() 7980 7981``` 7982int32_t OH_ArkUI_DragPreviewOption_SetDefaultAnimationBeforeLiftingEnabled (ArkUI_DragPreviewOption * option, bool enabled ) 7983``` 7984**Description** 7985 7986Sets whether to enable the default animation on a click or touch. 7987 7988**Since**: 12 7989 7990**Parameters** 7991 7992| Name| Description| 7993| -------- | -------- | 7994| option | Custom parameters. | 7995| enabled | Whether to enable the default click effect. | 7996 7997**Returns** 7998 7999Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 8000 8001 8002### OH_ArkUI_DragPreviewOption_SetDefaultRadiusEnabled() 8003 8004``` 8005int32_t OH_ArkUI_DragPreviewOption_SetDefaultRadiusEnabled (ArkUI_DragPreviewOption * option, bool enabled ) 8006``` 8007**Description** 8008 8009Sets whether to enable the default corner radius effect for an **ArkUI_DragPreviewOption** object. The effect is enabled by default. 8010 8011**Since**: 12 8012 8013**Parameters** 8014 8015| Name| Description| 8016| -------- | -------- | 8017| option | Custom parameters. | 8018| enabled | Whether to enable the default corner radius effect. | 8019 8020**Returns** 8021 8022Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 8023 8024 8025### OH_ArkUI_DragPreviewOption_SetDefaultShadowEnabled() 8026 8027``` 8028int32_t OH_ArkUI_DragPreviewOption_SetDefaultShadowEnabled (ArkUI_DragPreviewOption * option, bool enabled ) 8029``` 8030**Description** 8031 8032Sets whether to enable the default shadow effect for an **ArkUI_DragPreviewOption** object. The effect is enabled by default. 8033 8034**Since**: 12 8035 8036**Parameters** 8037 8038| Name| Description| 8039| -------- | -------- | 8040| option | Custom parameters. | 8041| enabled | Whether to enable the default shadow effect. | 8042 8043**Returns** 8044 8045Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 8046 8047 8048### OH_ArkUI_DragPreviewOption_SetNumberBadgeEnabled() 8049 8050``` 8051int32_t OH_ArkUI_DragPreviewOption_SetNumberBadgeEnabled (ArkUI_DragPreviewOption * option, bool enabled ) 8052``` 8053**Description** 8054 8055Sets 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. 8056 8057**Since**: 12 8058 8059**Parameters** 8060 8061| Name| Description| 8062| -------- | -------- | 8063| option | Custom parameters. | 8064| enabled | Whether to enable the badge. | 8065 8066**Returns** 8067 8068Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 8069 8070 8071### OH_ArkUI_DragPreviewOption_SetScaleMode() 8072 8073``` 8074int32_t OH_ArkUI_DragPreviewOption_SetScaleMode (ArkUI_DragPreviewOption * option, ArkUI_DragPreviewScaleMode scaleMode ) 8075``` 8076**Description** 8077 8078Sets the scale mode for an **ArkUI_DragPreviewOption** object. 8079 8080**Since**: 12 8081 8082**Parameters** 8083 8084| Name| Description| 8085| -------- | -------- | 8086| option | Custom parameters. | 8087| scaleMode | Scale mode to set. | 8088 8089**Returns** 8090 8091Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 8092 8093 8094### OH_ArkUI_DrawableDescriptor_CreateFromAnimatedPixelMap() 8095 8096``` 8097ArkUI_DrawableDescriptor* OH_ArkUI_DrawableDescriptor_CreateFromAnimatedPixelMap (OH_PixelmapNativeHandle * array, int32_t size ) 8098``` 8099**Description** 8100 8101Creates a **DrawableDescriptor** object from an array of **PixelMap** objects. 8102 8103**Since**: 12 8104 8105**Parameters** 8106 8107| Name| Description| 8108| -------- | -------- | 8109| array | Pointer to the array of **PixelMap** objects. | 8110| size | Size of the **PixelMap** object array. | 8111 8112**Returns** 8113 8114Returns the pointer to the created **DrawableDescriptor** object. 8115 8116 8117### OH_ArkUI_DrawableDescriptor_CreateFromPixelMap() 8118 8119``` 8120ArkUI_DrawableDescriptor* OH_ArkUI_DrawableDescriptor_CreateFromPixelMap (OH_PixelmapNativeHandle pixelMap) 8121``` 8122**Description** 8123 8124Creates a **DrawableDescriptor** object from a **PixelMap** object. 8125 8126**Since**: 12 8127 8128**Parameters** 8129 8130| Name| Description| 8131| -------- | -------- | 8132| pixelMap | Pointer to the **PixelMap** object. | 8133 8134**Returns** 8135 8136Returns the pointer to the created **DrawableDescriptor** object. 8137 8138 8139### OH_ArkUI_DrawableDescriptor_Dispose() 8140 8141``` 8142void OH_ArkUI_DrawableDescriptor_Dispose (ArkUI_DrawableDescriptor * drawableDescriptor) 8143``` 8144**Description** 8145 8146Disposes of the pointer to a **DrawableDescriptor** object. 8147 8148**Since**: 12 8149 8150**Parameters** 8151 8152| Name| Description| 8153| -------- | -------- | 8154| drawableDescriptor | Pointer to the **DrawableDescriptor** object. | 8155 8156 8157### OH_ArkUI_DrawableDescriptor_GetAnimatedPixelMapArray() 8158 8159``` 8160OH_PixelmapNativeHandle* OH_ArkUI_DrawableDescriptor_GetAnimatedPixelMapArray (ArkUI_DrawableDescriptor * drawableDescriptor) 8161``` 8162**Description** 8163 8164Obtains an array of **PixelMap** objects for playing an animation. 8165 8166**Since**: 12 8167 8168**Parameters** 8169 8170| Name| Description| 8171| -------- | -------- | 8172| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 8173 8174**Returns** 8175 8176Pointer to the PixelMap image array. 8177 8178 8179### OH_ArkUI_DrawableDescriptor_GetAnimatedPixelMapArraySize() 8180 8181``` 8182int32_t OH_ArkUI_DrawableDescriptor_GetAnimatedPixelMapArraySize (ArkUI_DrawableDescriptor * drawableDescriptor) 8183``` 8184**Description** 8185 8186Obtains an array of **PixelMap** objects for playing an animation. 8187 8188**Since**: 12 8189 8190**Parameters** 8191 8192| Name| Description| 8193| -------- | -------- | 8194| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 8195 8196**Returns** 8197 8198Size of the PixelMap image array. 8199 8200 8201### OH_ArkUI_DrawableDescriptor_GetAnimationDuration() 8202 8203``` 8204int32_t OH_ArkUI_DrawableDescriptor_GetAnimationDuration (ArkUI_DrawableDescriptor * drawableDescriptor) 8205``` 8206**Description** 8207 8208Obtains the total playback duration of a PixelMap image array. 8209 8210**Since**: 12 8211 8212**Parameters** 8213 8214| Name| Description| 8215| -------- | -------- | 8216| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 8217 8218**Returns** 8219 8220Total playback duration, in milliseconds. 8221 8222 8223### OH_ArkUI_DrawableDescriptor_GetAnimationIteration() 8224 8225``` 8226int32_t OH_ArkUI_DrawableDescriptor_GetAnimationIteration (ArkUI_DrawableDescriptor * drawableDescriptor) 8227``` 8228**Description** 8229 8230Obtains the number of times that a **PixelMap** object array is played. 8231 8232**Since**: 12 8233 8234**Parameters** 8235 8236| Name| Description| 8237| -------- | -------- | 8238| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 8239 8240**Returns** 8241 8242Returns the number of playback times. 8243 8244 8245### OH_ArkUI_DrawableDescriptor_GetStaticPixelMap() 8246 8247``` 8248OH_PixelmapNativeHandle OH_ArkUI_DrawableDescriptor_GetStaticPixelMap (ArkUI_DrawableDescriptor * drawableDescriptor) 8249``` 8250**Description** 8251 8252Obtains the pointer to a **PixelMap** object. 8253 8254**Since**: 12 8255 8256**Parameters** 8257 8258| Name| Description| 8259| -------- | -------- | 8260| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 8261 8262**Returns** 8263 8264Pointer to the PixelMap object. 8265 8266 8267### OH_ArkUI_DrawableDescriptor_SetAnimationDuration() 8268 8269``` 8270void OH_ArkUI_DrawableDescriptor_SetAnimationDuration (ArkUI_DrawableDescriptor * drawableDescriptor, int32_t duration ) 8271``` 8272**Description** 8273 8274Sets the total playback duration of the PixelMap image array. 8275 8276**Since**: 12 8277 8278**Parameters** 8279 8280| Name| Description| 8281| -------- | -------- | 8282| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 8283| duration | Total playback duration, in milliseconds. | 8284 8285 8286### OH_ArkUI_DrawableDescriptor_SetAnimationIteration() 8287 8288``` 8289void OH_ArkUI_DrawableDescriptor_SetAnimationIteration (ArkUI_DrawableDescriptor * drawableDescriptor, int32_t iteration ) 8290``` 8291**Description** 8292 8293Sets the number of times that a pixel map image array is played. 8294 8295**Since**: 12 8296 8297**Parameters** 8298 8299| Name| Description| 8300| -------- | -------- | 8301| drawableDescriptor | Pointer to a **DrawableDescriptor** object. | 8302| iterations | Number of playback times. | 8303 8304 8305### OH_ArkUI_DrawContext_GetCanvas() 8306 8307``` 8308void* OH_ArkUI_DrawContext_GetCanvas (ArkUI_DrawContext * context) 8309``` 8310**Description** 8311 8312Obtains the drawing canvas pointer, which can be converted into the OH_Drawing_Canvas pointer of the graphics library for drawing. 8313 8314**Since**: 12 8315 8316**Parameters** 8317 8318| Name| Description| 8319| -------- | -------- | 8320| context | Draw context. | 8321 8322**Returns** 8323 8324Pointer to the canvas for drawing. 8325 8326 8327### OH_ArkUI_DrawContext_GetSize() 8328 8329``` 8330ArkUI_IntSize OH_ArkUI_DrawContext_GetSize (ArkUI_DrawContext * context) 8331``` 8332**Description** 8333 8334Obtains the size of a drawing area. 8335 8336**Since**: 12 8337 8338**Parameters** 8339 8340| Name| Description| 8341| -------- | -------- | 8342| context | Draw context. | 8343 8344**Returns** 8345 8346Size of the area that can be drawn. 8347 8348 8349### OH_ArkUI_GestureEvent_GetActionType() 8350 8351``` 8352ArkUI_GestureEventActionType OH_ArkUI_GestureEvent_GetActionType (const ArkUI_GestureEvent * event) 8353``` 8354**Description** 8355 8356Obtains the gesture event type. 8357 8358**Since**: 12 8359 8360**Parameters** 8361 8362| Name| Description| 8363| -------- | -------- | 8364| event | Gesture event. | 8365 8366**Returns** 8367 8368Returns the gesture event type. 8369 8370 8371### OH_ArkUI_GestureEvent_GetNode() 8372 8373``` 8374ArkUI_NodeHandle OH_ArkUI_GestureEvent_GetNode (const ArkUI_GestureEvent * event) 8375``` 8376**Description** 8377 8378Obtains the ArkUI component to which the gesture is bound. 8379 8380**Since**: 12 8381 8382**Parameters** 8383 8384| Name| Description| 8385| -------- | -------- | 8386| event | Gesture event. | 8387 8388**Returns** 8389 8390Returns the ArkUI component. 8391 8392 8393### OH_ArkUI_GestureEvent_GetRawInputEvent() 8394 8395``` 8396const ArkUI_UIInputEvent* OH_ArkUI_GestureEvent_GetRawInputEvent (const ArkUI_GestureEvent * event) 8397``` 8398**Description** 8399 8400Obtains gesture input. 8401 8402**Since**: 12 8403 8404**Parameters** 8405 8406| Name| Description| 8407| -------- | -------- | 8408| event | Gesture event. | 8409 8410**Returns** 8411 8412Returns the pointer to the input event of the gesture event. 8413 8414 8415### OH_ArkUI_GestureEvent_GetResponseNode() 8416 8417``` 8418ArkUI_NodeHandle OH_ArkUI_GestureEvent_GetResponseNode (ArkUI_GestureEvent * event) 8419``` 8420**Description** 8421 8422Obtains the node that responds to the gesture. 8423 8424**Since**: 12 8425 8426**Parameters** 8427 8428| Name| Description| 8429| -------- | -------- | 8430| event | Gesture event. | 8431 8432**Returns** 8433 8434Returns the pointer to the node if the node exists; returns **NULL** otherwise. 8435 8436 8437### OH_ArkUI_GestureEventTargetInfo_IsScrollBegin() 8438 8439``` 8440int32_t OH_ArkUI_GestureEventTargetInfo_IsScrollBegin (ArkUI_GestureEventTargetInfo * info, bool * ret ) 8441``` 8442**Description** 8443 8444Obtains whether this scroll container is scrolled to the top. 8445 8446**Since**: 12 8447 8448**Parameters** 8449 8450| Name| Description| 8451| -------- | -------- | 8452| info | Gesture event target information. | 8453| ret | Obtains whether this scroll container is scrolled to the top. | 8454 8455**Returns** 8456 8457Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. Returns **180001** if the component is not a scroll container. 8458 8459 8460### OH_ArkUI_GestureEventTargetInfo_IsScrollEnd() 8461 8462``` 8463int32_t OH_ArkUI_GestureEventTargetInfo_IsScrollEnd (ArkUI_GestureEventTargetInfo * info, bool * ret ) 8464``` 8465**Description** 8466 8467Obtains whether this scroll container is scrolled to the bottom. 8468 8469**Since**: 12 8470 8471**Parameters** 8472 8473| Name| Description| 8474| -------- | -------- | 8475| info | Gesture event target information. | 8476| ret | Obtains whether this scroll container is scrolled to the bottom. | 8477 8478**Returns** 8479 8480Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. Returns **180001** if the component is not a scroll container. 8481 8482 8483### OH_ArkUI_GestureInterruptInfo_GetGestureEvent() 8484 8485``` 8486ArkUI_GestureEvent* OH_ArkUI_GestureInterruptInfo_GetGestureEvent (const ArkUI_GestureInterruptInfo * event) 8487``` 8488**Description** 8489 8490Obtains the pointer to the interrupted gesture event. 8491 8492**Since**: 12 8493 8494**Parameters** 8495 8496| Name| Description| 8497| -------- | -------- | 8498| event | Interrupt callback event. | 8499 8500**Returns** 8501 8502Returns the pointer to the interrupted gesture event. 8503 8504 8505### OH_ArkUI_GestureInterruptInfo_GetRecognizer() 8506 8507``` 8508ArkUI_GestureRecognizer* OH_ArkUI_GestureInterruptInfo_GetRecognizer (const ArkUI_GestureInterruptInfo * event) 8509``` 8510**Description** 8511 8512Returns the pointer to interrupted gesture recognizer. 8513 8514**Since**: 12 8515 8516**Parameters** 8517 8518| Name| Description| 8519| -------- | -------- | 8520| event | Interrupt callback event. | 8521 8522**Returns** 8523 8524Pointer to the interrupted gesture. 8525 8526 8527### OH_ArkUI_GestureInterruptInfo_GetSystemFlag() 8528 8529``` 8530bool OH_ArkUI_GestureInterruptInfo_GetSystemFlag (const ArkUI_GestureInterruptInfo * event) 8531``` 8532**Description** 8533 8534Checks whether a gesture is a built-in gesture of the component. 8535 8536**Since**: 12 8537 8538**Parameters** 8539 8540| Name| Description| 8541| -------- | -------- | 8542| event | Gesture interrupt callback event. | 8543 8544**Returns** 8545 8546true: built-in gestures; false: non-built-in gestures. 8547 8548 8549### OH_ArkUI_GestureInterruptInfo_GetSystemRecognizerType() 8550 8551``` 8552int32_t OH_ArkUI_GestureInterruptInfo_GetSystemRecognizerType (const ArkUI_GestureInterruptInfo * event) 8553``` 8554**Description** 8555 8556Obtains the type of the system gesture to trigger. 8557 8558**Since**: 12 8559 8560**Parameters** 8561 8562| Name| Description| 8563| -------- | -------- | 8564| event | Interrupt callback event. | 8565 8566**Returns** 8567 8568Returns the type of the system gesture to trigger. If the gesture to trigger is not a system gesture, **-1** is returned. 8569 8570 8571### OH_ArkUI_GetContextByNode() 8572 8573``` 8574ArkUI_ContextHandle OH_ArkUI_GetContextByNode (ArkUI_NodeHandle node) 8575``` 8576**Description** 8577 8578Obtains the pointer to the UI context object of the specified node. 8579 8580**Since**: 12 8581 8582**Parameters** 8583 8584| Name| Description| 8585| -------- | -------- | 8586| node | Specified node. | 8587 8588**Returns** 8589 8590Returns the pointer to the UI context object. 8591 8592 8593### OH_ArkUI_GetContextFromNapiValue() 8594 8595``` 8596int32_t OH_ArkUI_GetContextFromNapiValue (napi_env env, napi_value value, ArkUI_ContextHandle * context ) 8597``` 8598**Description** 8599 8600Obtains a **UIContext** object on the ArkTS side and maps it to an **ArkUI_ContextHandle** object on the native side. 8601 8602**Since**: 12 8603 8604**Parameters** 8605 8606| Name| Description| 8607| -------- | -------- | 8608| env | Pointer to the NAPI environment. | 8609| value | Context object created on the ArkTS side. | 8610| context | ArkUI_ContextHandle pointer. | 8611 8612**Returns** 8613 8614Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 8615 8616 8617### OH_ArkUI_GetDrawableDescriptorFromNapiValue() 8618 8619``` 8620int32_t OH_ArkUI_GetDrawableDescriptorFromNapiValue (napi_env env, napi_value value, ArkUI_DrawableDescriptor ** drawableDescriptor ) 8621``` 8622**Description** 8623 8624Maps a **DrawableDescriptor** object on the ArkTS side to an **ArkUI_DrawableDescriptor** object on the native side. 8625 8626**Since**: 12 8627 8628**Parameters** 8629 8630| Name| Description| 8631| -------- | -------- | 8632| env | Pointer to the NAPI environment. | 8633| value | **DrawableDescriptor** object created on the ArkTS side. | 8634| drawableDescriptor | Object that receives the pointer to the **ArkUI_DrawableDescriptor** object. | 8635 8636**Returns** 8637 8638Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 8639 8640 8641### OH_ArkUI_GetDrawableDescriptorFromResourceNapiValue() 8642 8643``` 8644int32_t OH_ArkUI_GetDrawableDescriptorFromResourceNapiValue (napi_env env, napi_value value, ArkUI_DrawableDescriptor ** drawableDescriptor ) 8645``` 8646**Description** 8647 8648Maps an $r resource object on the ArkTS side to an **ArkUI_DrawableDescriptor** object on the native side. 8649 8650**Since**: 12 8651 8652**Parameters** 8653 8654| Name| Description| 8655| -------- | -------- | 8656| env | Pointer to the NAPI environment. | 8657| value | $r resource object created on ArkTS. | 8658| drawableDescriptor | Object that receives the pointer to the **ArkUI_DrawableDescriptor** object. | 8659 8660**Returns** 8661 8662Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 8663 8664 8665### OH_ArkUI_GetGestureBindNodeId() 8666 8667``` 8668int32_t OH_ArkUI_GetGestureBindNodeId (ArkUI_GestureRecognizer * recognizer, char * nodeId, int32_t size, int32_t * result ) 8669``` 8670**Description** 8671 8672Obtains the ID of the component linked to a gesture recognizer. 8673 8674**Since**: 12 8675 8676**Parameters** 8677 8678| Name| Description| 8679| -------- | -------- | 8680| recognizer | Pointer to the gesture recognizer. | 8681| nodeId | ID of a component. | 8682| size | Size of the storage area. | 8683| result | Length of the string to be copied. | 8684 8685**Returns** 8686 8687Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. Returns **180002** if the buffer is not large enough. 8688 8689 8690### OH_ArkUI_GetGestureEventTargetInfo() 8691 8692``` 8693int32_t OH_ArkUI_GetGestureEventTargetInfo (ArkUI_GestureRecognizer * recognizer, ArkUI_GestureEventTargetInfo ** info ) 8694``` 8695**Description** 8696 8697Obtains the information about a gesture event target. 8698 8699**Since**: 12 8700 8701**Parameters** 8702 8703| Name| Description| 8704| -------- | -------- | 8705| recognizer | Pointer to the gesture recognizer. | 8706| info | Gesture event target information. | 8707 8708**Returns** 8709 8710Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 8711 8712 8713### OH_ArkUI_GetGestureRecognizerEnabled() 8714 8715``` 8716bool OH_ArkUI_GetGestureRecognizerEnabled (ArkUI_GestureRecognizer * recognizer) 8717``` 8718**Description** 8719 8720Obtains the enabled state of a gesture recognizer. 8721 8722**Since**: 12 8723 8724**Parameters** 8725 8726| Name| Description| 8727| -------- | -------- | 8728| recognizer | Pointer to the gesture recognizer. | 8729 8730**Returns** 8731 8732**true**: enabled false: disabled 8733 8734 8735### OH_ArkUI_GetGestureRecognizerState() 8736 8737``` 8738int32_t OH_ArkUI_GetGestureRecognizerState (ArkUI_GestureRecognizer * recognizer, ArkUI_GestureRecognizerState * state ) 8739``` 8740**Description** 8741 8742Obtains the state of a gesture recognizer. 8743 8744**Since**: 12 8745 8746**Parameters** 8747 8748| Name| Description| 8749| -------- | -------- | 8750| recognizer | Pointer to the gesture recognizer. | 8751| state | Status of the gesture recognizer. | 8752 8753**Returns** 8754 8755Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 8756 8757 8758### OH_ArkUI_GetGestureTag() 8759 8760``` 8761int32_t OH_ArkUI_GetGestureTag (ArkUI_GestureRecognizer * recognizer, char * buffer, int32_t bufferSize, int32_t * result ) 8762``` 8763**Description** 8764 8765Obtains the mark of the gesture recognizer. 8766 8767**Since**: 12 8768 8769**Parameters** 8770 8771| Name| Description| 8772| -------- | -------- | 8773| recognizer | Pointer to the gesture recognizer. | 8774| buffer | Storage zone | 8775| bufferSize | Size of the storage area. | 8776| result | Length of the string to be copied. | 8777 8778**Returns** 8779 8780Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. Returns **180002** if the buffer is not large enough. 8781 8782 8783### OH_ArkUI_GetNavDestinationId() 8784 8785``` 8786ArkUI_ErrorCode OH_ArkUI_GetNavDestinationId (ArkUI_NodeHandle node, char * buffer, int32_t bufferSize, int32_t * writeLength ) 8787``` 8788**Description** 8789 8790Obtains the ID of the **NavDestination** component where the specified node is located. 8791 8792**Since**: 12 8793 8794**Parameters** 8795 8796| Name| Description| 8797| -------- | -------- | 8798| node | Specified node. | 8799| buffer | buffer. NavDestinationID is written to this memory area. | 8800| bufferSize | Pointer to the buffer size. | 8801| 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. | 8802 8803**Returns** 8804 8805Returns **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. 8806 8807 8808### OH_ArkUI_GetNavDestinationIndex() 8809 8810``` 8811ArkUI_ErrorCode OH_ArkUI_GetNavDestinationIndex (ArkUI_NodeHandle node, int32_t * index ) 8812``` 8813**Description** 8814 8815Obtains the index of the **NavDestination** component where the specified node is located in the navigation stack. 8816 8817**Since**: 12 8818 8819**Parameters** 8820 8821| Name| Description| 8822| -------- | -------- | 8823| node | Specified node. | 8824| index | Returns the index, starting from 0. | 8825 8826**Returns** 8827 8828Returns **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. 8829 8830 8831### OH_ArkUI_GetNavDestinationName() 8832 8833``` 8834ArkUI_ErrorCode OH_ArkUI_GetNavDestinationName (ArkUI_NodeHandle node, char * buffer, int32_t bufferSize, int32_t * writeLength ) 8835``` 8836**Description** 8837 8838Obtains the name of the **NavDestination** component where the specified node is located. 8839 8840**Since**: 12 8841 8842**Parameters** 8843 8844| Name| Description| 8845| -------- | -------- | 8846| node | Specified node. | 8847| buffer | Buffer. The queried NavDestination name is written to this memory area. | 8848| bufferSize | Pointer to the buffer size. | 8849| 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. | 8850 8851**Returns** 8852 8853Returns **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. 8854 8855 8856### OH_ArkUI_GetNavDestinationNameByIndex() 8857 8858``` 8859ArkUI_ErrorCode OH_ArkUI_GetNavDestinationNameByIndex (ArkUI_NodeHandle node, int32_t index, char * buffer, int32_t bufferSize, int32_t * writeLength ) 8860``` 8861**Description** 8862 8863Obtains 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. 8864 8865**Since**: 12 8866 8867**Parameters** 8868 8869| Name| Description| 8870| -------- | -------- | 8871| node | Specified node. | 8872| index | Index of the queried NavDestination in the stack. | 8873| buffer | Buffer. The name of the queried page is written to this memory area. | 8874| bufferSize | Pointer to the buffer size. | 8875| 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. | 8876 8877**Returns** 8878 8879Returns **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. 8880 8881 8882### OH_ArkUI_GetNavDestinationParam() 8883 8884``` 8885napi_value OH_ArkUI_GetNavDestinationParam (ArkUI_NodeHandle node) 8886``` 8887**Description** 8888 8889Obtains the parameters of the **NavDestination** component where the specified node is located. 8890 8891**Since**: 12 8892 8893**Parameters** 8894 8895| Name| Description| 8896| -------- | -------- | 8897| node | Specified node. | 8898 8899**Returns** 8900 8901Parameter object. 8902 8903 8904### OH_ArkUI_GetNavDestinationState() 8905 8906``` 8907ArkUI_ErrorCode OH_ArkUI_GetNavDestinationState (ArkUI_NodeHandle node, ArkUI_NavDestinationState * state ) 8908``` 8909**Description** 8910 8911Obtains the state of the **NavDestination** component where the specified node is located. 8912 8913**Since**: 12 8914 8915**Parameters** 8916 8917| Name| Description| 8918| -------- | -------- | 8919| node | Specified node. | 8920| state | The status value of NavDestination is written back to this parameter. | 8921 8922**Returns** 8923 8924The 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. 8925 8926 8927### OH_ArkUI_GetNavigationId() 8928 8929``` 8930ArkUI_ErrorCode OH_ArkUI_GetNavigationId (ArkUI_NodeHandle node, char * buffer, int32_t bufferSize, int32_t * writeLength ) 8931``` 8932**Description** 8933 8934Obtains the ID of the **Navigation** component where the specified node is located. 8935 8936**Since**: 12 8937 8938**Parameters** 8939 8940| Name| Description| 8941| -------- | -------- | 8942| node | Specified node. | 8943| buffer | buffer. The NavigationID is written to this memory area. | 8944| bufferSize | Pointer to the buffer size. | 8945| 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. | 8946 8947**Returns** 8948 8949Returns **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. 8950 8951 8952### OH_ArkUI_GetNavStackLength() 8953 8954``` 8955ArkUI_ErrorCode OH_ArkUI_GetNavStackLength (ArkUI_NodeHandle node, int32_t * length ) 8956``` 8957**Description** 8958 8959Obtains the length of the navigation stack where the specified node is located. 8960 8961**Since**: 12 8962 8963**Parameters** 8964 8965| Name| Description| 8966| -------- | -------- | 8967| node | Specified node. | 8968| length | Length of the stack. The result, if obtained successfully, is written back to this parameter. | 8969 8970**Returns** 8971 8972Returns **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. 8973 8974 8975### OH_ArkUI_GetNodeContentFromNapiValue() 8976 8977``` 8978int32_t OH_ArkUI_GetNodeContentFromNapiValue (napi_env env, napi_value value, ArkUI_NodeContentHandle * content ) 8979``` 8980**Description** 8981 8982Obtains a **NodeContent** object on the ArkTS side and maps it to an **ArkUI_NodeContentHandle** object on the native side. 8983 8984**Since**: 12 8985 8986**Parameters** 8987 8988| Name| Description| 8989| -------- | -------- | 8990| env | Pointer to the NAPI environment. | 8991| value | NodeContent object created on ArkTS. | 8992| context | ArkUI_NodeContentHandle pointer. | 8993 8994**Returns** 8995 8996Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 8997 8998 8999### OH_ArkUI_GetNodeHandleFromNapiValue() 9000 9001``` 9002int32_t OH_ArkUI_GetNodeHandleFromNapiValue (napi_env env, napi_value frameNode, ArkUI_NodeHandle * handle ) 9003``` 9004**Description** 9005 9006Obtains a **FrameNode** object on the ArkTS side and maps it to an **ArkUI_NodeHandle** object on the native side. 9007 9008**Since**: 12 9009 9010**Parameters** 9011 9012| Name| Description| 9013| -------- | -------- | 9014| env | Pointer to the NAPI environment. | 9015| frameNode | FrameNode object created on the ArkTS side. | 9016| handle | **ArkUI_NodeHandle** pointer. | 9017 9018**Returns** 9019 9020Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9021 9022### OH_ArkUI_GetPanGestureDirectionMask() 9023 9024``` 9025int32_t OH_ArkUI_GetPanGestureDirectionMask (ArkUI_GestureRecognizer * recognizer, ArkUI_GestureDirectionMask * directionMask ) 9026``` 9027**Description** 9028 9029Obtains the direction of a pan gesture. 9030 9031**Since**: 12 9032 9033**Parameters** 9034 9035| Name| Description| 9036| -------- | -------- | 9037| recognizer | Pointer to the gesture recognizer. | 9038| directionMask | Sliding direction of the sliding gesture. | 9039 9040**Returns** 9041 9042Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 9043 9044 9045### OH_ArkUI_GetResponseRecognizersFromInterruptInfo() 9046 9047``` 9048int32_t OH_ArkUI_GetResponseRecognizersFromInterruptInfo (const ArkUI_GestureInterruptInfo * event, ArkUI_GestureRecognizerHandleArray * responseChain, int32_t * count ) 9049``` 9050**Description** 9051 9052Obtains information about a gesture response chain. 9053 9054**Since**: 12 9055 9056**Parameters** 9057 9058| Name| Description| 9059| -------- | -------- | 9060| event | Gesture interrupt callback event. | 9061| responseChain | Gesture recognizer on the response chain component. | 9062| count | Number of gesture recognizers on the response chain component. | 9063 9064**Returns** 9065 9066Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 9067 9068 9069### OH_ArkUI_GetRouterPageId() 9070 9071``` 9072ArkUI_ErrorCode OH_ArkUI_GetRouterPageId (ArkUI_NodeHandle node, char * buffer, int32_t bufferSize, int32_t * writeLength ) 9073``` 9074**Description** 9075 9076Obtains the ID of the page where the specified node is located. 9077 9078**Since**: 12 9079 9080**Parameters** 9081 9082| Name| Description| 9083| -------- | -------- | 9084| node | Specified node. | 9085| buffer | buffer. Page Id is written to this memory area. | 9086| bufferSize | Pointer to the buffer size. | 9087| 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. | 9088 9089**Returns** 9090 9091Returns **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. 9092 9093 9094### OH_ArkUI_GetRouterPageIndex() 9095 9096``` 9097ArkUI_ErrorCode OH_ArkUI_GetRouterPageIndex (ArkUI_NodeHandle node, int32_t * index ) 9098``` 9099**Description** 9100 9101Obtains the index of the page where the specified node is located in the page stack for routing. 9102 9103**Since**: 12 9104 9105**Parameters** 9106 9107| Name| Description| 9108| -------- | -------- | 9109| node | Specified node. | 9110| index | Returns the index, starting from 1. | 9111 9112**Returns** 9113 9114Returns **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. 9115 9116 9117### OH_ArkUI_GetRouterPageName() 9118 9119``` 9120ArkUI_ErrorCode OH_ArkUI_GetRouterPageName (ArkUI_NodeHandle node, char * buffer, int32_t bufferSize, int32_t * writeLength ) 9121``` 9122**Description** 9123 9124Obtains the name of the page where the specified node is located. 9125 9126**Since**: 12 9127 9128**Parameters** 9129 9130| Name| Description| 9131| -------- | -------- | 9132| node | Specified node. | 9133| buffer | Buffer. The page name is written to this memory area. | 9134| bufferSize | Pointer to the buffer size. | 9135| 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. | 9136 9137**Returns** 9138 9139Returns **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. 9140 9141 9142### OH_ArkUI_GetRouterPagePath() 9143 9144``` 9145ArkUI_ErrorCode OH_ArkUI_GetRouterPagePath (ArkUI_NodeHandle node, char * buffer, int32_t bufferSize, int32_t * writeLength ) 9146``` 9147**Description** 9148 9149Obtains the path to the page where the specified node is located. 9150 9151**Since**: 12 9152 9153**Parameters** 9154 9155| Name| Description| 9156| -------- | -------- | 9157| node | Specified node. | 9158| buffer | buffer. Page Path is written to this memory area. | 9159| bufferSize | Pointer to the buffer size. | 9160| 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. | 9161 9162**Returns** 9163 9164Returns **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. 9165 9166 9167### OH_ArkUI_GetRouterPageState() 9168 9169``` 9170ArkUI_ErrorCode OH_ArkUI_GetRouterPageState (ArkUI_NodeHandle node, ArkUI_RouterPageState * state ) 9171``` 9172**Description** 9173 9174Obtains the state of the page where the specified node is located. 9175 9176**Since**: 12 9177 9178**Parameters** 9179 9180| Name| Description| 9181| -------- | -------- | 9182| node | Specified node. | 9183| state | The status value of Router Page is written back to this parameter. | 9184 9185**Returns** 9186 9187The error code ARKUI_ERROR_CODE_NO_ERROR is returned. The ARKUI_ERROR_CODE_GET_INFO_FAILED fails to query information. 9188 9189 9190### OH_ArkUI_GuidelineOption_Create() 9191 9192``` 9193ArkUI_GuidelineOption* OH_ArkUI_GuidelineOption_Create (int32_t size) 9194``` 9195**Description** 9196 9197Creates a guideline configuration for this **RelativeContainer**. 9198 9199**Since**: 12 9200 9201**Parameters** 9202 9203| Name| Description| 9204| -------- | -------- | 9205| size | Number of guidelines. | 9206 9207**Returns** 9208 9209Returns the guideline configuration. 9210 9211 9212### OH_ArkUI_GuidelineOption_Dispose() 9213 9214``` 9215void OH_ArkUI_GuidelineOption_Dispose (ArkUI_GuidelineOption * guideline) 9216``` 9217**Description** 9218 9219Destroys auxiliary line information. 9220 9221**Since**: 12 9222 9223**Parameters** 9224 9225| Name| Description| 9226| -------- | -------- | 9227| guideline | Pointer to a guideline configuration. | 9228 9229 9230### OH_ArkUI_GuidelineOption_GetDirection() 9231 9232``` 9233ArkUI_Axis OH_ArkUI_GuidelineOption_GetDirection (ArkUI_GuidelineOption * guideline, int32_t index ) 9234``` 9235**Description** 9236 9237Obtains the direction of a guideline. 9238 9239**Since**: 12 9240 9241**Parameters** 9242 9243| Name| Description| 9244| -------- | -------- | 9245| guideline | Pointer to a guideline configuration. | 9246| index | Index of the guideline. | 9247 9248**Returns** 9249 9250Returns the direction of the guideline. 9251 9252 9253### OH_ArkUI_GuidelineOption_GetId() 9254 9255``` 9256const char* OH_ArkUI_GuidelineOption_GetId (ArkUI_GuidelineOption * guideline, int32_t index ) 9257``` 9258**Description** 9259 9260Obtains the ID of a guideline. 9261 9262**Since**: 12 9263 9264**Parameters** 9265 9266| Name| Description| 9267| -------- | -------- | 9268| guideline | Pointer to a guideline configuration. | 9269| index | Index of the guideline. | 9270 9271**Returns** 9272 9273Returns the ID of the guideline. 9274 9275 9276### OH_ArkUI_GuidelineOption_GetPositionEnd() 9277 9278``` 9279float OH_ArkUI_GuidelineOption_GetPositionEnd (ArkUI_GuidelineOption * guideline, int32_t index ) 9280``` 9281**Description** 9282 9283Obtains the distance between a guideline and the right or bottom of the container. 9284 9285**Since**: 12 9286 9287**Parameters** 9288 9289| Name| Description| 9290| -------- | -------- | 9291| guideline | Pointer to a guideline configuration. | 9292| index | Index of the guideline. | 9293 9294**Returns** 9295 9296Distance between the guideline and the right or bottom of the container. 9297 9298 9299### OH_ArkUI_GuidelineOption_GetPositionStart() 9300 9301``` 9302float OH_ArkUI_GuidelineOption_GetPositionStart (ArkUI_GuidelineOption * guideline, int32_t index ) 9303``` 9304**Description** 9305 9306Obtains the distance between a guideline and the left or top of the container. 9307 9308**Since**: 12 9309 9310**Parameters** 9311 9312| Name| Description| 9313| -------- | -------- | 9314| guideline | Pointer to a guideline configuration. | 9315| index | Index of the guideline. | 9316 9317**Returns** 9318 9319Distance between the guideline and the left or top of the container. 9320 9321 9322### OH_ArkUI_GuidelineOption_SetDirection() 9323 9324``` 9325void OH_ArkUI_GuidelineOption_SetDirection (ArkUI_GuidelineOption * guideline, ArkUI_Axis value, int32_t index ) 9326``` 9327**Description** 9328 9329Sets the direction of a guideline. 9330 9331**Since**: 12 9332 9333**Parameters** 9334 9335| Name| Description| 9336| -------- | -------- | 9337| guideline | Pointer to a guideline configuration. | 9338| value | Direction. | 9339| index | Index of the guideline. | 9340 9341 9342### OH_ArkUI_GuidelineOption_SetId() 9343 9344``` 9345void OH_ArkUI_GuidelineOption_SetId (ArkUI_GuidelineOption * guideline, const char * value, int32_t index ) 9346``` 9347**Description** 9348 9349Sets the ID of a guideline. 9350 9351**Since**: 12 9352 9353**Parameters** 9354 9355| Name| Description| 9356| -------- | -------- | 9357| guideline | Pointer to a guideline configuration. | 9358| value | ID of the guideline, which must be unique and cannot be the same as the name of any component in the container. | 9359| index | Index of the guideline. | 9360 9361 9362### OH_ArkUI_GuidelineOption_SetPositionEnd() 9363 9364``` 9365void OH_ArkUI_GuidelineOption_SetPositionEnd (ArkUI_GuidelineOption * guideline, float value, int32_t index ) 9366``` 9367**Description** 9368 9369Sets the distance between a guideline and the right or bottom of the container. 9370 9371**Since**: 12 9372 9373**Parameters** 9374 9375| Name| Description| 9376| -------- | -------- | 9377| guideline | Pointer to a guideline configuration. | 9378| value | Distance between the guideline and the right or bottom of the container. | 9379| index | Index of the guideline. | 9380 9381 9382### OH_ArkUI_GuidelineOption_SetPositionStart() 9383 9384``` 9385void OH_ArkUI_GuidelineOption_SetPositionStart (ArkUI_GuidelineOption * guideline, float value, int32_t index ) 9386``` 9387**Description** 9388 9389Sets the distance between a guideline and the left or top of the container. 9390 9391**Since**: 12 9392 9393**Parameters** 9394 9395| Name| Description| 9396| -------- | -------- | 9397| guideline | Pointer to a guideline configuration. | 9398| value | Distance between the guideline and the left or top of the container. | 9399| index | Index of the guideline. | 9400 9401 9402### OH_ArkUI_ImageAnimatorFrameInfo_CreateFromDrawableDescriptor() 9403 9404``` 9405ArkUI_ImageAnimatorFrameInfo* OH_ArkUI_ImageAnimatorFrameInfo_CreateFromDrawableDescriptor (ArkUI_DrawableDescriptor * drawable) 9406``` 9407**Description** 9408 9409Creates an image frame information object based on a **DrawableDescriptor** object, with the image format being Resource or PixelMap. 9410 9411**Since**: 12 9412 9413**Parameters** 9414 9415| Name| Description| 9416| -------- | -------- | 9417| drawable | Pointer to an **ArkUI_DrawableDescriptor** object created using Resource or PixelMap. | 9418 9419**Returns** 9420 9421Returns the pointer to the created frame image object. 9422 9423 9424### OH_ArkUI_ImageAnimatorFrameInfo_CreateFromString() 9425 9426``` 9427ArkUI_ImageAnimatorFrameInfo* OH_ArkUI_ImageAnimatorFrameInfo_CreateFromString (char * src) 9428``` 9429**Description** 9430 9431Creates an image frame information object based on an image path, with the image format being SVG, PNG, or JPG. 9432 9433**Since**: 12 9434 9435**Parameters** 9436 9437| Name| Description| 9438| -------- | -------- | 9439| src | Image path. | 9440 9441**Returns** 9442 9443Returns the pointer to the created frame image object. 9444 9445 9446### OH_ArkUI_ImageAnimatorFrameInfo_Dispose() 9447 9448``` 9449void OH_ArkUI_ImageAnimatorFrameInfo_Dispose (ArkUI_ImageAnimatorFrameInfo * imageInfo) 9450``` 9451**Description** 9452 9453Disposes of the pointer to an image frame information object. 9454 9455**Since**: 12 9456 9457**Parameters** 9458 9459| Name| Description| 9460| -------- | -------- | 9461| imageInfo | Pointer to the frame image object. | 9462 9463 9464### OH_ArkUI_ImageAnimatorFrameInfo_GetDuration() 9465 9466``` 9467int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetDuration (ArkUI_ImageAnimatorFrameInfo * imageInfo) 9468``` 9469**Description** 9470 9471Obtains the playback duration of an image. 9472 9473**Since**: 12 9474 9475**Parameters** 9476 9477| Name| Description| 9478| -------- | -------- | 9479| imageInfo | Pointer to the frame image object. | 9480 9481**Returns** 9482 9483Returns the playback duration of the image, in milliseconds. If **imageInfo** is a null pointer, **0** is returned. 9484 9485 9486### OH_ArkUI_ImageAnimatorFrameInfo_GetHeight() 9487 9488``` 9489int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetHeight (ArkUI_ImageAnimatorFrameInfo * imageInfo) 9490``` 9491**Description** 9492 9493Obtains the image height. 9494 9495**Since**: 12 9496 9497**Parameters** 9498 9499| Name| Description| 9500| -------- | -------- | 9501| imageInfo | Pointer to the frame image object. | 9502 9503**Returns** 9504 9505Returns the image height, in PX. If **imageInfo** is a null pointer, **0** is returned. 9506 9507 9508### OH_ArkUI_ImageAnimatorFrameInfo_GetLeft() 9509 9510``` 9511int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetLeft (ArkUI_ImageAnimatorFrameInfo * imageInfo) 9512``` 9513**Description** 9514 9515Obtains the horizontal coordinate of an image relative to the upper left corner of the component. 9516 9517**Since**: 12 9518 9519**Parameters** 9520 9521| Name| Description| 9522| -------- | -------- | 9523| imageInfo | Pointer to the frame image object. | 9524 9525**Returns** 9526 9527Returns 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. 9528 9529 9530### OH_ArkUI_ImageAnimatorFrameInfo_GetTop() 9531 9532``` 9533int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetTop (ArkUI_ImageAnimatorFrameInfo * imageInfo) 9534``` 9535**Description** 9536 9537Obtains the vertical coordinate of an image relative to the upper left corner of the component. 9538 9539**Since**: 12 9540 9541**Parameters** 9542 9543| Name| Description| 9544| -------- | -------- | 9545| imageInfo | Pointer to the frame image object. | 9546 9547**Returns** 9548 9549Returns 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. 9550 9551 9552### OH_ArkUI_ImageAnimatorFrameInfo_GetWidth() 9553 9554``` 9555int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetWidth (ArkUI_ImageAnimatorFrameInfo * imageInfo) 9556``` 9557**Description** 9558 9559Obtains the image width. 9560 9561**Since**: 12 9562 9563**Parameters** 9564 9565| Name| Description| 9566| -------- | -------- | 9567| imageInfo | Pointer to the frame image object. | 9568 9569**Returns** 9570 9571Returns the image width, in PX. If **imageInfo** is a null pointer, **0** is returned. 9572 9573 9574### OH_ArkUI_ImageAnimatorFrameInfo_SetDuration() 9575 9576``` 9577void OH_ArkUI_ImageAnimatorFrameInfo_SetDuration (ArkUI_ImageAnimatorFrameInfo * imageInfo, int32_t duration ) 9578``` 9579**Description** 9580 9581Sets the playback duration of an image. 9582 9583**Since**: 12 9584 9585**Parameters** 9586 9587| Name| Description| 9588| -------- | -------- | 9589| imageInfo | Pointer to the frame image object. | 9590| duration | Playback duration of an image, in milliseconds. | 9591 9592 9593### OH_ArkUI_ImageAnimatorFrameInfo_SetHeight() 9594 9595``` 9596void OH_ArkUI_ImageAnimatorFrameInfo_SetHeight (ArkUI_ImageAnimatorFrameInfo * imageInfo, int32_t height ) 9597``` 9598**Description** 9599 9600Sets the image height. 9601 9602**Since**: 12 9603 9604**Parameters** 9605 9606| Name| Description| 9607| -------- | -------- | 9608| imageInfo | Pointer to the frame image object. | 9609| height | Image height, in px. | 9610 9611 9612### OH_ArkUI_ImageAnimatorFrameInfo_SetLeft() 9613 9614``` 9615void OH_ArkUI_ImageAnimatorFrameInfo_SetLeft (ArkUI_ImageAnimatorFrameInfo * imageInfo, int32_t left ) 9616``` 9617**Description** 9618 9619Sets the horizontal coordinate of an image relative to the upper left corner of the component. 9620 9621**Since**: 12 9622 9623**Parameters** 9624 9625| Name| Description| 9626| -------- | -------- | 9627| imageInfo | Pointer to the frame image object. | 9628| left | Horizontal coordinate of the image relative to the upper left corner of the component, in px. | 9629 9630 9631### OH_ArkUI_ImageAnimatorFrameInfo_SetTop() 9632 9633``` 9634void OH_ArkUI_ImageAnimatorFrameInfo_SetTop (ArkUI_ImageAnimatorFrameInfo * imageInfo, int32_t top ) 9635``` 9636**Description** 9637 9638Sets the vertical coordinate of an image relative to the upper left corner of the component. 9639 9640**Since**: 12 9641 9642**Parameters** 9643 9644| Name| Description| 9645| -------- | -------- | 9646| imageInfo | Pointer to the frame image object. | 9647| top | Vertical coordinate of the image relative to the upper left corner of the component, in px. | 9648 9649 9650### OH_ArkUI_ImageAnimatorFrameInfo_SetWidth() 9651 9652``` 9653void OH_ArkUI_ImageAnimatorFrameInfo_SetWidth (ArkUI_ImageAnimatorFrameInfo * imageInfo, int32_t width ) 9654``` 9655**Description** 9656 9657Sets the image width. 9658 9659**Since**: 12 9660 9661**Parameters** 9662 9663| Name| Description| 9664| -------- | -------- | 9665| imageInfo | Pointer to the frame image object. | 9666| width | Image width, in px. | 9667 9668 9669### OH_ArkUI_IsBuiltInGesture() 9670 9671``` 9672bool OH_ArkUI_IsBuiltInGesture (ArkUI_GestureRecognizer * recognizer) 9673``` 9674**Description** 9675 9676Obtains whether a gesture is a built-in gesture. 9677 9678**Since**: 12 9679 9680**Parameters** 9681 9682| Name| Description| 9683| -------- | -------- | 9684| recognizer | Pointer to the gesture recognizer. | 9685 9686**Returns** 9687 9688true: built-in gestures. false: The gesture is not a built-in gesture. 9689 9690 9691### OH_ArkUI_IsGestureRecognizerValid() 9692 9693``` 9694bool OH_ArkUI_IsGestureRecognizerValid (ArkUI_GestureRecognizer * recognizer) 9695``` 9696**Description** 9697 9698Obtains whether a gesture recognizer is valid. 9699 9700**Since**: 12 9701 9702**Parameters** 9703 9704| Name| Description| 9705| -------- | -------- | 9706| recognizer | Pointer to the gesture recognizer. | 9707 9708**Returns** 9709 9710true: The gesture recognizer is valid. Returns **false** if the gesture recognizer is invalid. 9711 9712 9713### OH_ArkUI_KeyframeAnimateOption_Create() 9714 9715``` 9716ArkUI_KeyframeAnimateOption* OH_ArkUI_KeyframeAnimateOption_Create (int32_t size) 9717``` 9718**Description** 9719 9720Obtains the keyframe animation parameters. 9721 9722**Since**: 12 9723 9724**Parameters** 9725 9726| Name| Description| 9727| -------- | -------- | 9728| size | Number of key frame animation states. | 9729 9730**Returns** 9731 9732Returns the keyframe animation parameter object; returns **NULL** if the value of **size** is less than 0. 9733 9734 9735### OH_ArkUI_KeyframeAnimateOption_Dispose() 9736 9737``` 9738void OH_ArkUI_KeyframeAnimateOption_Dispose (ArkUI_KeyframeAnimateOption * option) 9739``` 9740**Description** 9741 9742Destroys a keyframe animation parameter object. 9743 9744**Since**: 12 9745 9746**Parameters** 9747 9748| Name| Description| 9749| -------- | -------- | 9750| option | Returns the keyframe animation parameter object; | 9751 9752 9753### OH_ArkUI_KeyframeAnimateOption_GetCurve() 9754 9755``` 9756ArkUI_CurveHandle OH_ArkUI_KeyframeAnimateOption_GetCurve (ArkUI_KeyframeAnimateOption * option, int32_t index ) 9757``` 9758**Description** 9759 9760Obtains the animation curve of a specific state in a keyframe animation. 9761 9762**Since**: 12 9763 9764**Parameters** 9765 9766| Name| Description| 9767| -------- | -------- | 9768| option | Keyframe animation parameters. | 9769| index | Status index. | 9770 9771**Returns** 9772 9773Returns the animation curve. 9774 9775 9776### OH_ArkUI_KeyframeAnimateOption_GetDelay() 9777 9778``` 9779int32_t OH_ArkUI_KeyframeAnimateOption_GetDelay (ArkUI_KeyframeAnimateOption * option) 9780``` 9781**Description** 9782 9783Obtains the overall delay of a keyframe animation 9784 9785**Since**: 12 9786 9787**Parameters** 9788 9789| Name| Description| 9790| -------- | -------- | 9791| option | Keyframe animation parameters. | 9792 9793**Returns** 9794 9795Returns the overall delay. 9796 9797 9798### OH_ArkUI_KeyframeAnimateOption_GetDuration() 9799 9800``` 9801int32_t OH_ArkUI_KeyframeAnimateOption_GetDuration (ArkUI_KeyframeAnimateOption * option, int32_t index ) 9802``` 9803**Description** 9804 9805Obtains the duration of a specific state in a keyframe animation. 9806 9807**Since**: 12 9808 9809**Parameters** 9810 9811| Name| Description| 9812| -------- | -------- | 9813| option | Keyframe animation parameters. | 9814| index | Status index. | 9815 9816**Returns** 9817 9818Duration, in milliseconds. 9819 9820 9821### OH_ArkUI_KeyframeAnimateOption_GetIterations() 9822 9823``` 9824int32_t OH_ArkUI_KeyframeAnimateOption_GetIterations (ArkUI_KeyframeAnimateOption * option) 9825``` 9826**Description** 9827 9828Obtains the number of times that a keyframe animation is played. 9829 9830**Since**: 12 9831 9832**Parameters** 9833 9834| Name| Description| 9835| -------- | -------- | 9836| option | Keyframe animation parameters. | 9837 9838**Returns** 9839 9840Number of times that the animation is played. 9841 9842 9843### OH_ArkUI_KeyframeAnimateOption_RegisterOnEventCallback() 9844 9845``` 9846int32_t OH_ArkUI_KeyframeAnimateOption_RegisterOnEventCallback (ArkUI_KeyframeAnimateOption * option, void * userData, void(*)(void *userData) event, int32_t index ) 9847``` 9848**Description** 9849 9850Sets 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. 9851 9852**Parameters** 9853 9854| Name| Description| 9855| -------- | -------- | 9856| option | Keyframe animation parameters. | 9857| event | Closure function. | 9858| userData | Pointer to a custom object. | 9859| index | Status index. | 9860 9861**Returns** 9862 9863Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9864 9865 9866### OH_ArkUI_KeyframeAnimateOption_RegisterOnFinishCallback() 9867 9868``` 9869int32_t OH_ArkUI_KeyframeAnimateOption_RegisterOnFinishCallback (ArkUI_KeyframeAnimateOption * option, void * userData, void(*)(void *userData) onFinish ) 9870``` 9871**Description** 9872 9873Sets 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. 9874 9875**Parameters** 9876 9877| Name| Description| 9878| -------- | -------- | 9879| option | Keyframe animation parameters. | 9880| userData | Pointer to a custom object. | 9881| onFinish | Callback used to return the result. | 9882 9883**Returns** 9884 9885Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9886 9887 9888### OH_ArkUI_KeyframeAnimateOption_SetCurve() 9889 9890``` 9891int32_t OH_ArkUI_KeyframeAnimateOption_SetCurve (ArkUI_KeyframeAnimateOption * option, ArkUI_CurveHandle value, int32_t index ) 9892``` 9893**Description** 9894 9895Sets the animation curve for a specific keyframe in a keyframe animation. 9896 9897**Parameters** 9898 9899| Name| Description| 9900| -------- | -------- | 9901| option | Keyframe animation parameters. | 9902| value | Animation curve used by the key frame. Default value: **EASE_IN_OUT**. | 9903| index | Status index. | 9904 9905**NOTE** 9906 9907Because the **springMotion**, **responsiveSpringMotion**, and **interpolatingSpring** curves do not have effective duration settings, they are not supported. 9908 9909**Returns** 9910 9911Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9912 9913 9914### OH_ArkUI_KeyframeAnimateOption_SetDelay() 9915 9916``` 9917int32_t OH_ArkUI_KeyframeAnimateOption_SetDelay (ArkUI_KeyframeAnimateOption * option, int32_t value ) 9918``` 9919**Description** 9920 9921Sets the overall delay of a keyframe animation, in milliseconds. By default, the keyframe animation is played without delay. 9922 9923**Parameters** 9924 9925| Name| Description| 9926| -------- | -------- | 9927| option | Keyframe animation parameters. | 9928| value | Delay time, in milliseconds. | 9929 9930**Returns** 9931 9932Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9933 9934 9935### OH_ArkUI_KeyframeAnimateOption_SetDuration() 9936 9937``` 9938int32_t OH_ArkUI_KeyframeAnimateOption_SetDuration (ArkUI_KeyframeAnimateOption * option, int32_t value, int32_t index ) 9939``` 9940**Description** 9941 9942Sets the duration of a keyframe animation, in milliseconds. 9943 9944**Parameters** 9945 9946| Name| Description| 9947| -------- | -------- | 9948| option | Keyframe animation parameters. | 9949| value | Duration, in milliseconds. | 9950| index | Status index. | 9951 9952**Returns** 9953 9954Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9955 9956 9957### OH_ArkUI_KeyframeAnimateOption_SetIterations() 9958 9959``` 9960int32_t OH_ArkUI_KeyframeAnimateOption_SetIterations (ArkUI_KeyframeAnimateOption * option, int32_t value ) 9961``` 9962**Description** 9963 9964Sets 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. 9965 9966**Parameters** 9967 9968| Name| Description| 9969| -------- | -------- | 9970| option | Keyframe animation parameters. | 9971| value | Number of times that the animation is played. | 9972 9973**Returns** 9974 9975Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 9976 9977 9978### OH_ArkUI_LayoutConstraint_Copy() 9979 9980``` 9981ArkUI_LayoutConstraint* OH_ArkUI_LayoutConstraint_Copy (const ArkUI_LayoutConstraint * Constraint) 9982``` 9983**Description** 9984 9985Constraint size deep copy. 9986 9987**Since**: 12 9988 9989**Parameters** 9990 9991| Name| Description| 9992| -------- | -------- | 9993| Constraint | Size constraint. | 9994 9995**Returns** 9996 9997Pointer to the new constraint size. 9998 9999 10000### OH_ArkUI_LayoutConstraint_Create() 10001 10002``` 10003ArkUI_LayoutConstraint* OH_ArkUI_LayoutConstraint_Create () 10004``` 10005**Description** 10006 10007Create a constraint size. 10008 10009**Since**: 12 10010 10011 10012### OH_ArkUI_LayoutConstraint_Dispose() 10013 10014``` 10015void* OH_ArkUI_LayoutConstraint_Dispose (ArkUI_LayoutConstraint * Constraint) 10016``` 10017**Description** 10018 10019Pointer to the size of the destruction constraint. 10020 10021**Since**: 12 10022 10023**Parameters** 10024 10025| Name| Description| 10026| -------- | -------- | 10027| Constraint | Size constraint. | 10028 10029 10030### OH_ArkUI_LayoutConstraint_GetMaxHeight() 10031 10032``` 10033int32_t OH_ArkUI_LayoutConstraint_GetMaxHeight (const ArkUI_LayoutConstraint * Constraint) 10034``` 10035**Description** 10036 10037Obtains the maximum height for a size constraint, in px. 10038 10039**Since**: 12 10040 10041**Parameters** 10042 10043| Name| Description| 10044| -------- | -------- | 10045| Constraint | Size constraint. | 10046 10047**Returns** 10048 10049Maximum height. 10050 10051 10052### OH_ArkUI_LayoutConstraint_GetMaxWidth() 10053 10054``` 10055int32_t OH_ArkUI_LayoutConstraint_GetMaxWidth (const ArkUI_LayoutConstraint * Constraint) 10056``` 10057**Description** 10058 10059Obtains the maximum width for a size constraint, in px. 10060 10061**Since**: 12 10062 10063**Parameters** 10064 10065| Name| Description| 10066| -------- | -------- | 10067| Constraint | Size constraint. | 10068 10069**Returns** 10070 10071Maximum width. 10072 10073 10074### OH_ArkUI_LayoutConstraint_GetMinHeight() 10075 10076``` 10077int32_t OH_ArkUI_LayoutConstraint_GetMinHeight (const ArkUI_LayoutConstraint * Constraint) 10078``` 10079**Description** 10080 10081Obtains the minimum height for a size constraint, in px. 10082 10083**Since**: 12 10084 10085**Parameters** 10086 10087| Name| Description| 10088| -------- | -------- | 10089| Constraint | Size constraint. | 10090 10091**Returns** 10092 10093Minimum Height 10094 10095 10096### OH_ArkUI_LayoutConstraint_GetMinWidth() 10097 10098``` 10099int32_t OH_ArkUI_LayoutConstraint_GetMinWidth (const ArkUI_LayoutConstraint * Constraint) 10100``` 10101**Description** 10102 10103Obtains the minimum width for a size constraint, in px. 10104 10105**Since**: 12 10106 10107**Parameters** 10108 10109| Name| Description| 10110| -------- | -------- | 10111| Constraint | Size constraint. | 10112 10113**Returns** 10114 10115Minimum Width 10116 10117 10118### OH_ArkUI_LayoutConstraint_GetPercentReferenceHeight() 10119 10120``` 10121int32_t OH_ArkUI_LayoutConstraint_GetPercentReferenceHeight (const ArkUI_LayoutConstraint * Constraint) 10122``` 10123**Description** 10124 10125Obtains the height percentage reference for a size constraint, in px. 10126 10127**Since**: 12 10128 10129**Parameters** 10130 10131| Name| Description| 10132| -------- | -------- | 10133| Constraint | Size constraint. | 10134 10135**Returns** 10136 10137Height percentage benchmark. 10138 10139 10140### OH_ArkUI_LayoutConstraint_GetPercentReferenceWidth() 10141 10142``` 10143int32_t OH_ArkUI_LayoutConstraint_GetPercentReferenceWidth (const ArkUI_LayoutConstraint * Constraint) 10144``` 10145**Description** 10146 10147Obtains the width percentage reference for a size constraint, in px. 10148 10149**Since**: 12 10150 10151**Parameters** 10152 10153| Name| Description| 10154| -------- | -------- | 10155| Constraint | Size constraint. | 10156 10157**Returns** 10158 10159Width percentage reference. 10160 10161 10162### OH_ArkUI_LayoutConstraint_SetMaxHeight() 10163 10164``` 10165void OH_ArkUI_LayoutConstraint_SetMaxHeight (ArkUI_LayoutConstraint * Constraint, int32_t value ) 10166``` 10167**Description** 10168 10169Sets the maximum height. 10170 10171**Since**: 12 10172 10173**Parameters** 10174 10175| Name| Description| 10176| -------- | -------- | 10177| Constraint | Size constraint. | 10178| value | Maximum height, in pixels. | 10179 10180 10181### OH_ArkUI_LayoutConstraint_SetMaxWidth() 10182 10183``` 10184void OH_ArkUI_LayoutConstraint_SetMaxWidth (ArkUI_LayoutConstraint * Constraint, int32_t value ) 10185``` 10186**Description** 10187 10188Sets the maximum width. 10189 10190**Since**: 12 10191 10192**Parameters** 10193 10194| Name| Description| 10195| -------- | -------- | 10196| Constraint | Size constraint. | 10197| value | Maximum width, in pixels. | 10198 10199 10200### OH_ArkUI_LayoutConstraint_SetMinHeight() 10201 10202``` 10203void OH_ArkUI_LayoutConstraint_SetMinHeight (ArkUI_LayoutConstraint * Constraint, int32_t value ) 10204``` 10205**Description** 10206 10207Sets the minimum height. 10208 10209**Since**: 12 10210 10211**Parameters** 10212 10213| Name| Description| 10214| -------- | -------- | 10215| Constraint | Size constraint. | 10216| value | Minimum height, in pixels. | 10217 10218 10219### OH_ArkUI_LayoutConstraint_SetMinWidth() 10220 10221``` 10222void OH_ArkUI_LayoutConstraint_SetMinWidth (ArkUI_LayoutConstraint * Constraint, int32_t value ) 10223``` 10224**Description** 10225 10226Sets the minimum width. 10227 10228**Since**: 12 10229 10230**Parameters** 10231 10232| Name| Description| 10233| -------- | -------- | 10234| Constraint | Size constraint. | 10235| value | Minimum width, in pixels. | 10236 10237 10238### OH_ArkUI_LayoutConstraint_SetPercentReferenceHeight() 10239 10240``` 10241void OH_ArkUI_LayoutConstraint_SetPercentReferenceHeight (ArkUI_LayoutConstraint * Constraint, int32_t value ) 10242``` 10243**Description** 10244 10245Sets the height percentage reference. 10246 10247**Since**: 12 10248 10249**Parameters** 10250 10251| Name| Description| 10252| -------- | -------- | 10253| Constraint | Size constraint. | 10254| value | Height percentage base, in px. | 10255 10256 10257### OH_ArkUI_LayoutConstraint_SetPercentReferenceWidth() 10258 10259``` 10260void OH_ArkUI_LayoutConstraint_SetPercentReferenceWidth (ArkUI_LayoutConstraint * Constraint, int32_t value ) 10261``` 10262**Description** 10263 10264Sets the width percentage reference. 10265 10266**Since**: 12 10267 10268**Parameters** 10269 10270| Name| Description| 10271| -------- | -------- | 10272| Constraint | Size constraint. | 10273| value | Width percentage benchmark, in px. | 10274 10275 10276### OH_ArkUI_List_CloseAllSwipeActions() 10277 10278``` 10279int32_t OH_ArkUI_List_CloseAllSwipeActions (ArkUI_NodeHandle node, void * userData, void(*)(void *userData) onFinish ) 10280``` 10281**Description** 10282 10283Collapse the expanded ListItem. 10284 10285**Since**: 12 10286 10287**Parameters** 10288 10289| Name| Description| 10290| -------- | -------- | 10291| node | Node object for which an event needs to be registered. | 10292| userData | Custom event parameter, which is passed in the callback when the event is triggered. | 10293| onFinish | Callback triggered after the collapse animation is complete. | 10294 10295**Returns** 10296 10297Returns **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. 10298 10299 10300### OH_ArkUI_ListChildrenMainSizeOption_Create() 10301 10302``` 10303ArkUI_ListChildrenMainSize* OH_ArkUI_ListChildrenMainSizeOption_Create () 10304``` 10305**Description** 10306 10307Creates a **ListChildrenMainSize** instance. 10308 10309**Since**: 12 10310 10311**Returns** 10312 10313Returns the created **ListChildrenMainSize** instance. 10314 10315 10316### OH_ArkUI_ListChildrenMainSizeOption_Dispose() 10317 10318``` 10319void OH_ArkUI_ListChildrenMainSizeOption_Dispose (ArkUI_ListChildrenMainSize * option) 10320``` 10321**Description** 10322 10323Destroys a ListChildrenMainSize instance. 10324 10325**Since**: 12 10326 10327**Parameters** 10328 10329| Name| Description| 10330| -------- | -------- | 10331| option | ListChildrenMainSize instance to be destroyed. | 10332 10333 10334### OH_ArkUI_ListChildrenMainSizeOption_GetDefaultMainSize() 10335 10336``` 10337float OH_ArkUI_ListChildrenMainSizeOption_GetDefaultMainSize (ArkUI_ListChildrenMainSize * option) 10338``` 10339**Description** 10340 10341Obtains the default size in a **ListChildrenMainSize** instance. 10342 10343**Since**: 12 10344 10345**Parameters** 10346 10347| Name| Description| 10348| -------- | -------- | 10349| option | **ListChildrenMainSize** instance. | 10350 10351**Returns** 10352 10353Returns the default size, in vp. The default value is **0**. If **option** is a null pointer, **-1** is returned. 10354 10355 10356### OH_ArkUI_ListChildrenMainSizeOption_GetMainSize() 10357 10358``` 10359float OH_ArkUI_ListChildrenMainSizeOption_GetMainSize (ArkUI_ListChildrenMainSize * option, int32_t index ) 10360``` 10361**Description** 10362 10363Obtains the value of the ChildrenMainSizeOption array of the List component. 10364 10365**Since**: 12 10366 10367**Parameters** 10368 10369| Name| Description| 10370| -------- | -------- | 10371| option | **ListChildrenMainSize** instance. | 10372| index | Subscript position of the value to be obtained. | 10373 10374**Returns** 10375 10376Value of the specific position of the array. If a parameter error occurs, **-1** is returned. 10377 10378 10379### OH_ArkUI_ListChildrenMainSizeOption_Resize() 10380 10381``` 10382void OH_ArkUI_ListChildrenMainSizeOption_Resize (ArkUI_ListChildrenMainSize * option, int32_t totalSize ) 10383``` 10384**Description** 10385 10386Resets the array size of ChildrenMainSizeOption of the List component. 10387 10388**Since**: 12 10389 10390**Parameters** 10391 10392| Name| Description| 10393| -------- | -------- | 10394| option | **ListChildrenMainSize** instance. | 10395| totalSize | Array size. | 10396 10397 10398### OH_ArkUI_ListChildrenMainSizeOption_SetDefaultMainSize() 10399 10400``` 10401int32_t OH_ArkUI_ListChildrenMainSizeOption_SetDefaultMainSize (ArkUI_ListChildrenMainSize * option, float defaultMainSize ) 10402``` 10403**Description** 10404 10405Sets the default size in a **ListChildrenMainSize** instance. 10406 10407**Since**: 12 10408 10409**Parameters** 10410 10411| Name| Description| 10412| -------- | -------- | 10413| option | **ListChildrenMainSize** instance. | 10414| defaultMainSize | Default size of a list item in a list. The unit is vp. | 10415 10416**Returns** 10417 10418Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 10419 10420 10421### OH_ArkUI_ListChildrenMainSizeOption_Splice() 10422 10423``` 10424int32_t OH_ArkUI_ListChildrenMainSizeOption_Splice (ArkUI_ListChildrenMainSize * option, int32_t index, int32_t deleteCount, int32_t addCount ) 10425``` 10426**Description** 10427 10428The size of the ChildrenMainSizeOption array of the List component is adjusted. 10429 10430**Since**: 12 10431 10432**Parameters** 10433 10434| Name| Description| 10435| -------- | -------- | 10436| option | **ListChildrenMainSize** instance. | 10437| index | Start position of the array whose MainSize is to be modified. | 10438| deleteCount | Number of MainSize arrays to be deleted starting from index. | 10439| addCount | Number of MainSize arrays to be added starting from index. | 10440 10441**Returns** 10442 10443Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 10444 10445 10446### OH_ArkUI_ListChildrenMainSizeOption_UpdateSize() 10447 10448``` 10449int32_t OH_ArkUI_ListChildrenMainSizeOption_UpdateSize (ArkUI_ListChildrenMainSize * option, int32_t index, float mainSize ) 10450``` 10451**Description** 10452 10453Updates the values in a **ChildrenMainSizeOption** array of a List component. 10454 10455**Since**: 12 10456 10457**Parameters** 10458 10459| Name| Description| 10460| -------- | -------- | 10461| option | **ListChildrenMainSize** instance. | 10462| index | Index at which to start changing the values in the array. | 10463| mainSize | New size value to set at the specified index. | 10464 10465**Returns** 10466 10467Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 10468 10469 10470### OH_ArkUI_ListItemSwipeActionItem_Create() 10471 10472``` 10473ArkUI_ListItemSwipeActionItem* OH_ArkUI_ListItemSwipeActionItem_Create () 10474``` 10475**Description** 10476 10477Creates a **ListItemSwipeActionItem** instance. 10478 10479**Since**: 12 10480 10481**Returns** 10482 10483Returns the created **ListItemSwipeActionItem** instance. 10484 10485 10486### OH_ArkUI_ListItemSwipeActionItem_Dispose() 10487 10488``` 10489void OH_ArkUI_ListItemSwipeActionItem_Dispose (ArkUI_ListItemSwipeActionItem * item) 10490``` 10491**Description** 10492 10493Disposes of a **ListItemSwipeActionItem** instance. 10494 10495**Since**: 12 10496 10497**Parameters** 10498 10499| Name| Description| 10500| -------- | -------- | 10501| item | **ListItemSwipeActionItem** instance to dispose of. | 10502 10503 10504### OH_ArkUI_ListItemSwipeActionItem_GetActionAreaDistance() 10505 10506``` 10507float OH_ArkUI_ListItemSwipeActionItem_GetActionAreaDistance (ArkUI_ListItemSwipeActionItem * item) 10508``` 10509**Description** 10510 10511Obtains the swipe distance threshold for deleting the list item. 10512 10513**Since**: 12 10514 10515**Parameters** 10516 10517| Name| Description| 10518| -------- | -------- | 10519| item | Target **ListItemSwipeActionItem** instance. | 10520 10521**Returns** 10522 10523Returns the swipe distance threshold for deleting the list item. Return **0** if an error occurs. 10524 10525 10526### OH_ArkUI_ListItemSwipeActionItem_SetActionAreaDistance() 10527 10528``` 10529void OH_ArkUI_ListItemSwipeActionItem_SetActionAreaDistance (ArkUI_ListItemSwipeActionItem * item, float distance ) 10530``` 10531**Description** 10532 10533Swipe distance threshold for deleting the list item. 10534 10535**Since**: 12 10536 10537**Parameters** 10538 10539| Name| Description| 10540| -------- | -------- | 10541| item | Target **ListItemSwipeActionItem** instance. | 10542| distance | Returns the swipe distance threshold for deleting the list item. | 10543 10544 10545### OH_ArkUI_ListItemSwipeActionItem_SetContent() 10546 10547``` 10548void OH_ArkUI_ListItemSwipeActionItem_SetContent (ArkUI_ListItemSwipeActionItem * item, ArkUI_NodeHandle node ) 10549``` 10550**Description** 10551 10552Sets the layout content of ListItemSwipeActionItem. 10553 10554**Since**: 12 10555 10556**Parameters** 10557 10558| Name| Description| 10559| -------- | -------- | 10560| item | Target **ListItemSwipeActionItem** instance. | 10561| node | Layout information | 10562 10563 10564### OH_ArkUI_ListItemSwipeActionItem_SetOnAction() 10565 10566``` 10567void OH_ArkUI_ListItemSwipeActionItem_SetOnAction (ArkUI_ListItemSwipeActionItem * item, void(*)() callback ) 10568``` 10569**Description** 10570 10571Sets the callback invoked when the list item is deleted while in the delete area. 10572 10573**Since**: 12 10574 10575**Parameters** 10576 10577| Name| Description| 10578| -------- | -------- | 10579| item | Target **ListItemSwipeActionItem** instance. | 10580| callback | Callback to invoke when an event of the specified type occurs. | 10581 10582 10583### OH_ArkUI_ListItemSwipeActionItem_SetOnActionWithUserData() 10584 10585``` 10586void OH_ArkUI_ListItemSwipeActionItem_SetOnActionWithUserData (ArkUI_ListItemSwipeActionItem * item, void * userData, void(*)(void *userData) callback ) 10587``` 10588**Description** 10589 10590Sets the callback invoked when the list item is deleted while in the delete area. 10591 10592**Since**: 12 10593 10594**Parameters** 10595 10596| Name| Description| 10597| -------- | -------- | 10598| item | Target **ListItemSwipeActionItem** instance. | 10599| userData | Custom data. | 10600| callback | Callback to invoke when an event of the specified type occurs. | 10601 10602 10603### OH_ArkUI_ListItemSwipeActionItem_SetOnEnterActionArea() 10604 10605``` 10606void OH_ArkUI_ListItemSwipeActionItem_SetOnEnterActionArea (ArkUI_ListItemSwipeActionItem * item, void(*)() callback ) 10607``` 10608**Description** 10609 10610Sets the callback invoked each time the list item enters the delete area. 10611 10612**Since**: 12 10613 10614**Parameters** 10615 10616| Name| Description| 10617| -------- | -------- | 10618| item | Target **ListItemSwipeActionItem** instance. | 10619| callback | Callback to invoke when an event of the specified type occurs. | 10620 10621 10622### OH_ArkUI_ListItemSwipeActionItem_SetOnEnterActionAreaWithUserData() 10623 10624``` 10625void OH_ArkUI_ListItemSwipeActionItem_SetOnEnterActionAreaWithUserData (ArkUI_ListItemSwipeActionItem * item, void * userData, void(*)(void *userData) callback ) 10626``` 10627**Description** 10628 10629Sets the callback invoked each time the list item enters the delete area. 10630 10631**Since**: 12 10632 10633**Parameters** 10634 10635| Name| Description| 10636| -------- | -------- | 10637| item | Target **ListItemSwipeActionItem** instance. | 10638| userData | Custom data. | 10639| callback | Callback to invoke when an event of the specified type occurs. | 10640 10641 10642### OH_ArkUI_ListItemSwipeActionItem_SetOnExitActionArea() 10643 10644``` 10645void OH_ArkUI_ListItemSwipeActionItem_SetOnExitActionArea (ArkUI_ListItemSwipeActionItem * item, void(*)() callback ) 10646``` 10647**Description** 10648 10649Sets the callback invoked each time the list item exits the delete area. 10650 10651**Since**: 12 10652 10653**Parameters** 10654 10655| Name| Description| 10656| -------- | -------- | 10657| item | Target **ListItemSwipeActionItem** instance. | 10658| callback | Callback to invoke when an event of the specified type occurs. | 10659 10660 10661### OH_ArkUI_ListItemSwipeActionItem_SetOnExitActionAreaWithUserData() 10662 10663``` 10664void OH_ArkUI_ListItemSwipeActionItem_SetOnExitActionAreaWithUserData (ArkUI_ListItemSwipeActionItem * item, void * userData, void(*)(void *userData) callback ) 10665``` 10666**Description** 10667 10668Sets the callback invoked each time the list item exits the delete area. 10669 10670**Since**: 12 10671 10672**Parameters** 10673 10674| Name| Description| 10675| -------- | -------- | 10676| item | Target **ListItemSwipeActionItem** instance. | 10677| userData | Custom data. | 10678| callback | Callback to invoke when an event of the specified type occurs. | 10679 10680### OH_ArkUI_ListItemSwipeActionItem_SetOnStateChange() 10681 10682``` 10683void OH_ArkUI_ListItemSwipeActionItem_SetOnStateChange (ArkUI_ListItemSwipeActionItem * item, void(*)(ArkUI_ListItemSwipeActionState swipeActionState) callback ) 10684``` 10685**Description** 10686 10687Sets the callback invoked when the swipe state of the list item changes. 10688 10689**Since**: 12 10690 10691**Parameters** 10692 10693| Name| Description| 10694| -------- | -------- | 10695| item | Target **ListItemSwipeActionItem** instance. | 10696| callback | Status after the callback event swipeActionState changes. | 10697 10698 10699### OH_ArkUI_ListItemSwipeActionItem_SetOnStateChangeWithUserData() 10700 10701``` 10702void OH_ArkUI_ListItemSwipeActionItem_SetOnStateChangeWithUserData (ArkUI_ListItemSwipeActionItem * item, void * userData, void(*)(ArkUI_ListItemSwipeActionState swipeActionState, void *userData) callback ) 10703``` 10704**Description** 10705 10706Sets the callback invoked when the swipe state of the list item changes. 10707 10708**Since**: 12 10709 10710**Parameters** 10711 10712| Name| Description| 10713| -------- | -------- | 10714| item | Target **ListItemSwipeActionItem** instance. | 10715| userData | Custom data. | 10716| callback | Status after the callback event swipeActionState changes. | 10717 10718 10719### OH_ArkUI_ListItemSwipeActionOption_Create() 10720 10721``` 10722ArkUI_ListItemSwipeActionOption* OH_ArkUI_ListItemSwipeActionOption_Create () 10723``` 10724**Description** 10725 10726Creates a **ListItemSwipeActionOption** instance. 10727 10728**Since**: 12 10729 10730**Returns** 10731 10732ListItemSwipeActionOption configuration item instance. 10733 10734 10735### OH_ArkUI_ListItemSwipeActionOption_Dispose() 10736 10737``` 10738void OH_ArkUI_ListItemSwipeActionOption_Dispose (ArkUI_ListItemSwipeActionOption * option) 10739``` 10740**Description** 10741 10742Destroys a ListItemSwipeActionOption instance. 10743 10744**Since**: 12 10745 10746**Parameters** 10747 10748| Name| Description| 10749| -------- | -------- | 10750| option | ListItemSwipeActionOption instance to destroy. | 10751 10752 10753### OH_ArkUI_ListItemSwipeActionOption_GetEdgeEffect() 10754 10755``` 10756int32_t OH_ArkUI_ListItemSwipeActionOption_GetEdgeEffect (ArkUI_ListItemSwipeActionOption * option) 10757``` 10758**Description** 10759 10760Obtains the sliding effect. 10761 10762**Since**: 12 10763 10764**Parameters** 10765 10766| Name| Description| 10767| -------- | -------- | 10768| option | Target **ListItemSwipeActionItem** instance. | 10769 10770**Returns** 10771 10772Scroll effect. The default return value is **ARKUI_LIST_ITEM_SWIPE_EDGE_EFFECT_SPRING**. 10773 10774 10775### OH_ArkUI_ListItemSwipeActionOption_SetEdgeEffect() 10776 10777``` 10778void OH_ArkUI_ListItemSwipeActionOption_SetEdgeEffect (ArkUI_ListItemSwipeActionOption * option, ArkUI_ListItemSwipeEdgeEffect edgeEffect ) 10779``` 10780**Description** 10781 10782Sets the sliding effect. 10783 10784**Since**: 12 10785 10786**Parameters** 10787 10788| Name| Description| 10789| -------- | -------- | 10790| option | Target **ListItemSwipeActionItem** instance. | 10791| edgeEffect | Scroll effect. | 10792 10793 10794### OH_ArkUI_ListItemSwipeActionOption_SetEnd() 10795 10796``` 10797void OH_ArkUI_ListItemSwipeActionOption_SetEnd (ArkUI_ListItemSwipeActionOption * option, ArkUI_ListItemSwipeActionItem * item ) 10798``` 10799**Description** 10800 10801Sets the layout content for the right edge (for a vertical layout) or bottom edge (for a horizontal layout) of a **ListItemSwipeActionItem** instance. 10802 10803**Since**: 12 10804 10805**Parameters** 10806 10807| Name| Description| 10808| -------- | -------- | 10809| option | Target **ListItemSwipeActionItem** instance. | 10810| builder | Layout information | 10811 10812 10813### OH_ArkUI_ListItemSwipeActionOption_SetOnOffsetChange() 10814 10815``` 10816void OH_ArkUI_ListItemSwipeActionOption_SetOnOffsetChange (ArkUI_ListItemSwipeActionOption * option, void(*)(float offset) callback ) 10817``` 10818**Description** 10819 10820Sets the callback invoked when the scroll offset changes. 10821 10822**Since**: 12 10823 10824**Parameters** 10825 10826| Name| Description| 10827| -------- | -------- | 10828| option | Target **ListItemSwipeActionItem** instance. | 10829| callback | Sliding offset of the callback event offset. | 10830 10831 10832### OH_ArkUI_ListItemSwipeActionOption_SetOnOffsetChangeWithUserData() 10833 10834``` 10835void OH_ArkUI_ListItemSwipeActionOption_SetOnOffsetChangeWithUserData (ArkUI_ListItemSwipeActionOption * option, void * userData, void(*)(float offset, void *userData) callback ) 10836``` 10837**Description** 10838 10839Sets the callback invoked when the scroll offset changes. 10840 10841**Since**: 12 10842 10843**Parameters** 10844 10845| Name| Description| 10846| -------- | -------- | 10847| option | Target **ListItemSwipeActionItem** instance. | 10848| userData | Custom data. | 10849| callback | Sliding offset of the callback event offset. | 10850 10851 10852### OH_ArkUI_ListItemSwipeActionOption_SetStart() 10853 10854``` 10855void OH_ArkUI_ListItemSwipeActionOption_SetStart (ArkUI_ListItemSwipeActionOption * option, ArkUI_ListItemSwipeActionItem * item ) 10856``` 10857**Description** 10858 10859Sets the layout content for the left edge (for a vertical layout) or top edge (for a horizontal layout) of a **ListItemSwipeActionItem** instance. 10860 10861**Since**: 12 10862 10863**Parameters** 10864 10865| Name| Description| 10866| -------- | -------- | 10867| option | Target **ListItemSwipeActionItem** instance. | 10868| builder | Layout information | 10869 10870 10871### OH_ArkUI_LongPress_GetRepeatCount() 10872 10873``` 10874int32_t OH_ArkUI_LongPress_GetRepeatCount (const ArkUI_GestureEvent * event) 10875``` 10876**Description** 10877 10878Obtains the number of times that a long press gesture is triggered periodically. 10879 10880**Since**: 12 10881 10882**Parameters** 10883 10884| Name| Description| 10885| -------- | -------- | 10886| event | Gesture event. | 10887 10888**Returns** 10889 10890Returns the number of times that the long press gesture is triggered periodically. 10891 10892 10893### OH_ArkUI_MarshallStyledStringDescriptor() 10894 10895``` 10896int32_t OH_ArkUI_MarshallStyledStringDescriptor (uint8_t * buffer, size_t * bufferSize, ArkUI_StyledString_Descriptor * descriptor ) 10897``` 10898**Description** 10899 10900Serializes the styled string information into a byte array. 10901 10902**Since**: 14 10903 10904**Parameters** 10905 10906| Name| Description| 10907| -------- | -------- | 10908| buffer | Byte array where the serialized data will be stored. | 10909| bufferSize | Length of the byte array. | 10910| descriptor | Pointer to an **ArkUI_StyledString_Descriptor** object. | 10911 10912**Returns** 10913 10914Returns **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. 10915 10916 10917### OH_ArkUI_NodeAdapter_Create() 10918 10919``` 10920ArkUI_NodeAdapterHandle OH_ArkUI_NodeAdapter_Create () 10921``` 10922**Description** 10923 10924Creates a component adapter. 10925 10926**Since**: 12 10927 10928 10929### OH_ArkUI_NodeAdapter_Dispose() 10930 10931``` 10932void OH_ArkUI_NodeAdapter_Dispose (ArkUI_NodeAdapterHandle handle) 10933``` 10934**Description** 10935 10936Destroys a component adapter. 10937 10938**Since**: 12 10939 10940**Parameters** 10941 10942| Name| Description| 10943| -------- | -------- | 10944| handle | Component adapter object. | 10945 10946 10947### OH_ArkUI_NodeAdapter_GetAllItems() 10948 10949``` 10950int32_t OH_ArkUI_NodeAdapter_GetAllItems (ArkUI_NodeAdapterHandle handle, ArkUI_NodeHandle ** items, uint32_t * size ) 10951``` 10952**Description** 10953 10954Obtains all elements stored in the specified adapter. 10955 10956When 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. 10957 10958**Since**: 12 10959 10960**Parameters** 10961 10962| Name| Description| 10963| -------- | -------- | 10964| handle | Component adapter object. | 10965| items | Array of nodes in the adapter. | 10966| size | Number of elements. | 10967 10968**Returns** 10969 10970Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 10971 10972 10973### OH_ArkUI_NodeAdapter_GetTotalNodeCount() 10974 10975``` 10976uint32_t OH_ArkUI_NodeAdapter_GetTotalNodeCount (ArkUI_NodeAdapterHandle handle) 10977``` 10978**Description** 10979 10980Obtains the total number of elements in the Adapter. 10981 10982**Since**: 12 10983 10984**Parameters** 10985 10986| Name| Description| 10987| -------- | -------- | 10988| handle | Component adapter object. | 10989 10990**Returns** 10991 10992Total number of elements in the Adapter. 10993 10994 10995### OH_ArkUI_NodeAdapter_InsertItem() 10996 10997``` 10998int32_t OH_ArkUI_NodeAdapter_InsertItem (ArkUI_NodeAdapterHandle handle, uint32_t startPosition, uint32_t itemCount ) 10999``` 11000**Description** 11001 11002Instructs the specified adapter to insert certain elements. 11003 11004**Since**: 12 11005 11006**Parameters** 11007 11008| Name| Description| 11009| -------- | -------- | 11010| handle | Component adapter object. | 11011| startPosition | Start position for inserting an element. | 11012| itemCount | Number of inserted elements. | 11013 11014**Returns** 11015 11016Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11017 11018 11019### OH_ArkUI_NodeAdapter_MoveItem() 11020 11021``` 11022int32_t OH_ArkUI_NodeAdapter_MoveItem (ArkUI_NodeAdapterHandle handle, uint32_t from, uint32_t to ) 11023``` 11024**Description** 11025 11026Instructs the specified adapter to move certain elements. 11027 11028**Since**: 12 11029 11030**Parameters** 11031 11032| Name| Description| 11033| -------- | -------- | 11034| handle | Component adapter object. | 11035| from | Start position of the element shift. | 11036| to | End position of the element shift. | 11037 11038**Returns** 11039 11040Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11041 11042 11043### OH_ArkUI_NodeAdapter_RegisterEventReceiver() 11044 11045``` 11046int32_t OH_ArkUI_NodeAdapter_RegisterEventReceiver (ArkUI_NodeAdapterHandle handle, void * userData, void(*)(ArkUI_NodeAdapterEvent *event) receiver ) 11047``` 11048**Description** 11049 11050Registers callback events related to the Adapter. 11051 11052**Since**: 12 11053 11054**Parameters** 11055 11056| Name| Description| 11057| -------- | -------- | 11058| handle | Component adapter object. | 11059| userData | Custom data. | 11060| receiver | Event receiving callback. | 11061 11062**Returns** 11063 11064Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11065 11066 11067### OH_ArkUI_NodeAdapter_ReloadAllItems() 11068 11069``` 11070int32_t OH_ArkUI_NodeAdapter_ReloadAllItems (ArkUI_NodeAdapterHandle handle) 11071``` 11072**Description** 11073 11074Instructs the specified adapter to reload all elements. 11075 11076**Since**: 12 11077 11078**Parameters** 11079 11080| Name| Description| 11081| -------- | -------- | 11082| handle | Component adapter object. | 11083 11084**Returns** 11085 11086Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11087 11088 11089### OH_ArkUI_NodeAdapter_ReloadItem() 11090 11091``` 11092int32_t OH_ArkUI_NodeAdapter_ReloadItem (ArkUI_NodeAdapterHandle handle, uint32_t startPosition, uint32_t itemCount ) 11093``` 11094**Description** 11095 11096Instructs the specified adapter to reload certain elements. 11097 11098**Since**: 12 11099 11100**Parameters** 11101 11102| Name| Description| 11103| -------- | -------- | 11104| handle | Component adapter object. | 11105| startPosition | Start position of an element change. | 11106| itemCount | Number of changed elements. | 11107 11108**Returns** 11109 11110Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11111 11112 11113### OH_ArkUI_NodeAdapter_RemoveItem() 11114 11115``` 11116int32_t OH_ArkUI_NodeAdapter_RemoveItem (ArkUI_NodeAdapterHandle handle, uint32_t startPosition, uint32_t itemCount ) 11117``` 11118**Description** 11119 11120Instructs the specified adapter to remove certain elements. 11121 11122**Since**: 12 11123 11124**Parameters** 11125 11126| Name| Description| 11127| -------- | -------- | 11128| handle | Component adapter object. | 11129| startPosition | Start position for deleting an element. | 11130| itemCount | Number of deleted elements. | 11131 11132**Returns** 11133 11134Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11135 11136 11137### OH_ArkUI_NodeAdapter_SetTotalNodeCount() 11138 11139``` 11140int32_t OH_ArkUI_NodeAdapter_SetTotalNodeCount (ArkUI_NodeAdapterHandle handle, uint32_t size ) 11141``` 11142**Description** 11143 11144Sets the total number of elements in the specified adapter. 11145 11146**Since**: 12 11147 11148**Parameters** 11149 11150| Name| Description| 11151| -------- | -------- | 11152| handle | Component adapter object. | 11153| size | Number of elements. | 11154 11155**Returns** 11156 11157Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11158 11159 11160### OH_ArkUI_NodeAdapter_UnregisterEventReceiver() 11161 11162``` 11163void OH_ArkUI_NodeAdapter_UnregisterEventReceiver (ArkUI_NodeAdapterHandle handle) 11164``` 11165**Description** 11166 11167Deregisters Adapter-related callback events. 11168 11169**Since**: 12 11170 11171**Parameters** 11172 11173| Name| Description| 11174| -------- | -------- | 11175| handle | Component adapter object. | 11176 11177 11178### OH_ArkUI_NodeAdapterEvent_GetHostNode() 11179 11180``` 11181ArkUI_NodeHandle OH_ArkUI_NodeAdapterEvent_GetHostNode (ArkUI_NodeAdapterEvent * event) 11182``` 11183**Description** 11184 11185Obtains the scrolling class container node that uses the adapter. 11186 11187**Since**: 12 11188 11189**Parameters** 11190 11191| Name| Description| 11192| -------- | -------- | 11193| event | Adapter event object. | 11194 11195**Returns** 11196 11197Returns the scrollable container node that uses the specified adapter. 11198 11199 11200### OH_ArkUI_NodeAdapterEvent_GetItemIndex() 11201 11202``` 11203uint32_t OH_ArkUI_NodeAdapterEvent_GetItemIndex (ArkUI_NodeAdapterEvent * event) 11204``` 11205**Description** 11206 11207Sequence number of the element to be operated when the adapter event is obtained. 11208 11209**Since**: 12 11210 11211**Parameters** 11212 11213| Name| Description| 11214| -------- | -------- | 11215| event | Adapter event object. | 11216 11217**Returns** 11218 11219Sequence number of an element. 11220 11221 11222### OH_ArkUI_NodeAdapterEvent_GetRemovedNode() 11223 11224``` 11225ArkUI_NodeHandle OH_ArkUI_NodeAdapterEvent_GetRemovedNode (ArkUI_NodeAdapterEvent * event) 11226``` 11227**Description** 11228 11229Obtains the element to be destroyed in the event to be destroyed. 11230 11231**Since**: 12 11232 11233**Parameters** 11234 11235| Name| Description| 11236| -------- | -------- | 11237| event | Adapter event object. | 11238 11239**Returns** 11240 11241Element to be destroyed. 11242 11243 11244### OH_ArkUI_NodeAdapterEvent_GetType() 11245 11246``` 11247ArkUI_NodeAdapterEventType OH_ArkUI_NodeAdapterEvent_GetType (ArkUI_NodeAdapterEvent * event) 11248``` 11249**Description** 11250 11251Obtains the event type. 11252 11253**Since**: 12 11254 11255**Parameters** 11256 11257| Name| Description| 11258| -------- | -------- | 11259| event | Adapter event object. | 11260 11261**Returns** 11262 11263Represents an event type. 11264 11265 11266### OH_ArkUI_NodeAdapterEvent_GetUserData() 11267 11268``` 11269void* OH_ArkUI_NodeAdapterEvent_GetUserData (ArkUI_NodeAdapterEvent * event) 11270``` 11271**Description** 11272 11273Obtains the custom data passed in during registration of the specified event. 11274 11275**Since**: 12 11276 11277**Parameters** 11278 11279| Name| Description| 11280| -------- | -------- | 11281| event | Adapter event object. | 11282 11283 11284### OH_ArkUI_NodeAdapterEvent_SetItem() 11285 11286``` 11287int32_t OH_ArkUI_NodeAdapterEvent_SetItem (ArkUI_NodeAdapterEvent * event, ArkUI_NodeHandle node ) 11288``` 11289**Description** 11290 11291Sets the component to be added to the specified adapter. 11292 11293**Since**: 12 11294 11295**Parameters** 11296 11297| Name| Description| 11298| -------- | -------- | 11299| event | Adapter event object. | 11300| node | Component to be added. | 11301 11302**Returns** 11303 11304Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11305 11306 11307### OH_ArkUI_NodeAdapterEvent_SetNodeId() 11308 11309``` 11310int32_t OH_ArkUI_NodeAdapterEvent_SetNodeId (ArkUI_NodeAdapterEvent * event, int32_t id ) 11311``` 11312**Description** 11313 11314Sets the generated component ID. 11315 11316**Since**: 12 11317 11318**Parameters** 11319 11320| Name| Description| 11321| -------- | -------- | 11322| event | Adapter event object. | 11323| id | Sets the returned component ID. | 11324 11325**Returns** 11326 11327Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11328 11329 11330### OH_ArkUI_NodeContent_AddNode() 11331 11332``` 11333int32_t OH_ArkUI_NodeContent_AddNode (ArkUI_NodeContentHandle content, ArkUI_NodeHandle node ) 11334``` 11335**Description** 11336 11337Adds an ArkUI component node to the specified NodeContent object. 11338 11339**Since**: 12 11340 11341**Parameters** 11342 11343| Name| Description| 11344| -------- | -------- | 11345| content | NodeContent object to which a node is to be added. | 11346| node | Node to be added. | 11347 11348**Returns** 11349 11350Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11351 11352 11353### OH_ArkUI_NodeContent_GetUserData() 11354 11355``` 11356void* OH_ArkUI_NodeContent_GetUserData (ArkUI_NodeContentHandle content) 11357``` 11358**Description** 11359 11360Obtains the user-defined data saved on the NodeContent object. 11361 11362**Since**: 12 11363 11364**Parameters** 11365 11366| Name| Description| 11367| -------- | -------- | 11368| content | NodeContent object whose user-defined data needs to be saved. | 11369 11370**Returns** 11371 11372Custom data. 11373 11374 11375### OH_ArkUI_NodeContent_InsertNode() 11376 11377``` 11378int32_t OH_ArkUI_NodeContent_InsertNode (ArkUI_NodeContentHandle content, ArkUI_NodeHandle node, int32_t position ) 11379``` 11380**Description** 11381 11382Inserts an ArkUI component node into a specific location of the corresponding NodeContent object. 11383 11384**Since**: 12 11385 11386**Parameters** 11387 11388| Name| Description| 11389| -------- | -------- | 11390| content | NodeContent object of the node to be inserted. | 11391| node | Node to be inserted. | 11392| position | Start time for an asset to be inserted, | 11393 11394**Returns** 11395 11396Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11397 11398 11399### OH_ArkUI_NodeContent_RegisterCallback() 11400 11401``` 11402int32_t OH_ArkUI_NodeContent_RegisterCallback (ArkUI_NodeContentHandle content, ArkUI_NodeContentCallback callback ) 11403``` 11404**Description** 11405 11406Registers the NodeContent event function. 11407 11408**Since**: 12 11409 11410**Parameters** 11411 11412| Name| Description| 11413| -------- | -------- | 11414| content | NodeContent object for which an event needs to be registered. | 11415| callback | Function callback to be executed when an event is triggered. | 11416 11417**Returns** 11418 11419Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11420 11421 11422### OH_ArkUI_NodeContent_RemoveNode() 11423 11424``` 11425int32_t OH_ArkUI_NodeContent_RemoveNode (ArkUI_NodeContentHandle content, ArkUI_NodeHandle node ) 11426``` 11427**Description** 11428 11429Removes an ArkUI component node from the specified NodeContent object. 11430 11431**Since**: 12 11432 11433**Parameters** 11434 11435| Name| Description| 11436| -------- | -------- | 11437| content | NodeContent object of the node to be deleted. | 11438| node | Node to be deleted. | 11439 11440**Returns** 11441 11442Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11443 11444 11445### OH_ArkUI_NodeContent_SetUserData() 11446 11447``` 11448int32_t OH_ArkUI_NodeContent_SetUserData (ArkUI_NodeContentHandle content, void * userData ) 11449``` 11450**Description** 11451 11452Saves user-defined data on the NodeContent object. 11453 11454**Since**: 12 11455 11456**Parameters** 11457 11458| Name| Description| 11459| -------- | -------- | 11460| content | NodeContent object whose user-defined data needs to be saved. | 11461| userData | User-defined data to be saved. | 11462 11463**Returns** 11464 11465Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 11466 11467 11468### OH_ArkUI_NodeContentEvent_GetEventType() 11469 11470``` 11471ArkUI_NodeContentEventType OH_ArkUI_NodeContentEvent_GetEventType (ArkUI_NodeContentEvent * event) 11472``` 11473**Description** 11474 11475Obtains the type of the specified NodeContent event. 11476 11477**Since**: 12 11478 11479**Parameters** 11480 11481| Name| Description| 11482| -------- | -------- | 11483| event | Pointer to the NodeContent event. | 11484 11485**Returns** 11486 11487NodeContent event type. 11488 11489 11490### OH_ArkUI_NodeContentEvent_GetNodeContentHandle() 11491 11492``` 11493ArkUI_NodeContentHandle OH_ArkUI_NodeContentEvent_GetNodeContentHandle (ArkUI_NodeContentEvent * event) 11494``` 11495**Description** 11496 11497Obtains the object that triggers the specified NodeContent event. 11498 11499**Since**: 12 11500 11501**Parameters** 11502 11503| Name| Description| 11504| -------- | -------- | 11505| event | Pointer to the NodeContent event. | 11506 11507**Returns** 11508 11509Returns the NodeContent object that triggers the event. 11510 11511 11512### OH_ArkUI_NodeCustomEvent_GetCustomSpanDrawInfo() 11513 11514``` 11515int32_t OH_ArkUI_NodeCustomEvent_GetCustomSpanDrawInfo (ArkUI_NodeCustomEvent * event, ArkUI_CustomSpanDrawInfo * info ) 11516``` 11517**Description** 11518 11519Obtains the drawing information of a custom span through a custom component event. 11520 11521**Since**: 12 11522 11523**Parameters** 11524 11525| Name| Description| 11526| -------- | -------- | 11527| event | Pointer to the custom component event. | 11528| info | Drawing information to obtain. | 11529 11530**Returns** 11531 11532Returns **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. 11533 11534 11535### OH_ArkUI_NodeCustomEvent_GetCustomSpanMeasureInfo() 11536 11537``` 11538int32_t OH_ArkUI_NodeCustomEvent_GetCustomSpanMeasureInfo (ArkUI_NodeCustomEvent * event, ArkUI_CustomSpanMeasureInfo * info ) 11539``` 11540**Description** 11541 11542Obtains the measurement information of a custom span through a custom component event. 11543 11544**Since**: 12 11545 11546**Parameters** 11547 11548| Name| Description| 11549| -------- | -------- | 11550| event | Pointer to the custom component event. | 11551| info | Measurement information to obtain. | 11552 11553**Returns** 11554 11555Returns **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. 11556 11557 11558### OH_ArkUI_NodeCustomEvent_GetDrawContextInDraw() 11559 11560``` 11561ArkUI_DrawContext* OH_ArkUI_NodeCustomEvent_GetDrawContextInDraw (ArkUI_NodeCustomEvent * event) 11562``` 11563**Description** 11564 11565Obtains the drawing context through a custom component event. 11566 11567**Since**: 12 11568 11569**Parameters** 11570 11571| Name| Description| 11572| -------- | -------- | 11573| event | Pointer to the custom component event. | 11574 11575**Returns** 11576 11577Returns the drawing context. 11578 11579 11580### OH_ArkUI_NodeCustomEvent_GetEventTargetId() 11581 11582``` 11583int32_t OH_ArkUI_NodeCustomEvent_GetEventTargetId (ArkUI_NodeCustomEvent * event) 11584``` 11585**Description** 11586 11587Obtains the ID of a custom component event. 11588 11589**Since**: 12 11590 11591**Parameters** 11592 11593| Name| Description| 11594| -------- | -------- | 11595| event | Pointer to the custom component event. | 11596 11597**Returns** 11598 11599Returns the custom event ID. 11600 11601 11602### OH_ArkUI_NodeCustomEvent_GetEventType() 11603 11604``` 11605ArkUI_NodeCustomEventType OH_ArkUI_NodeCustomEvent_GetEventType (ArkUI_NodeCustomEvent * event) 11606``` 11607**Description** 11608 11609Obtains the event type through a custom component event. 11610 11611**Since**: 12 11612 11613**Parameters** 11614 11615| Name| Description| 11616| -------- | -------- | 11617| event | Pointer to the custom component event. | 11618 11619**Returns** 11620 11621Returns the type of the custom component event. 11622 11623 11624### OH_ArkUI_NodeCustomEvent_GetLayoutConstraintInMeasure() 11625 11626``` 11627ArkUI_LayoutConstraint* OH_ArkUI_NodeCustomEvent_GetLayoutConstraintInMeasure (ArkUI_NodeCustomEvent * event) 11628``` 11629**Description** 11630 11631Obtains the size constraint for measurement through a custom component event. 11632 11633**Since**: 12 11634 11635**Parameters** 11636 11637| Name| Description| 11638| -------- | -------- | 11639| event | Pointer to the custom component event. | 11640 11641**Returns** 11642 11643Pointer to the constraint size. 11644 11645 11646### OH_ArkUI_NodeCustomEvent_GetNodeHandle() 11647 11648``` 11649ArkUI_NodeHandle OH_ArkUI_NodeCustomEvent_GetNodeHandle (ArkUI_NodeCustomEvent * event) 11650``` 11651**Description** 11652 11653Obtains a component object through a custom component event. 11654 11655**Since**: 12 11656 11657**Parameters** 11658 11659| Name| Description| 11660| -------- | -------- | 11661| event | Pointer to the custom component event. | 11662 11663**Returns** 11664 11665Returns the obtained component object. 11666 11667 11668### OH_ArkUI_NodeCustomEvent_GetPositionInLayout() 11669 11670``` 11671ArkUI_IntOffset OH_ArkUI_NodeCustomEvent_GetPositionInLayout (ArkUI_NodeCustomEvent * event) 11672``` 11673**Description** 11674 11675Obtains the expected position of a component relative to its parent component in the layout phase through a custom component event. 11676 11677**Since**: 12 11678 11679**Parameters** 11680 11681| Name| Description| 11682| -------- | -------- | 11683| event | Pointer to the custom component event. | 11684 11685**Returns** 11686 11687Returns the expected position relative to the parent component. 11688 11689 11690### OH_ArkUI_NodeCustomEvent_GetUserData() 11691 11692``` 11693void* OH_ArkUI_NodeCustomEvent_GetUserData (ArkUI_NodeCustomEvent * event) 11694``` 11695**Description** 11696 11697Obtains custom event parameters through a custom component event. 11698 11699**Since**: 12 11700 11701**Parameters** 11702 11703| Name| Description| 11704| -------- | -------- | 11705| event | Pointer to the custom component event. | 11706 11707**Returns** 11708 11709Returns the custom event parameters. 11710 11711 11712### OH_ArkUI_NodeCustomEvent_SetCustomSpanMetrics() 11713 11714``` 11715int32_t OH_ArkUI_NodeCustomEvent_SetCustomSpanMetrics (ArkUI_NodeCustomEvent * event, ArkUI_CustomSpanMetrics * metrics ) 11716``` 11717**Description** 11718 11719Sets the measurement metrics of a custom span through a custom component event. 11720 11721**Since**: 12 11722 11723**Parameters** 11724 11725| Name| Description| 11726| -------- | -------- | 11727| event | Pointer to the custom component event. | 11728| metrics | Measurement metrics to set. | 11729 11730**Returns** 11731 11732Returns **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. 11733 11734 11735### OH_ArkUI_NodeEvent_GetDragEvent() 11736 11737``` 11738ArkUI_DragEvent* OH_ArkUI_NodeEvent_GetDragEvent (ArkUI_NodeEvent * nodeEvent) 11739``` 11740**Description** 11741 11742Obtains an **ArkUI_DragEvent** object from the specified **ArkUI_DragEvent** object. 11743 11744**Since**: 12 11745 11746**Parameters** 11747 11748| Name| Description| 11749| -------- | -------- | 11750| node | Pointer to an **ArkUI_NodeEvent** object. | 11751 11752**Returns** 11753 11754Returns the pointer to an **ArkUI_DragEvent** object; returns null if the parameter passed in is invalid or is not a drag-related event. 11755 11756 11757### OH_ArkUI_NodeEvent_GetEventType() 11758 11759``` 11760ArkUI_NodeEventType OH_ArkUI_NodeEvent_GetEventType (ArkUI_NodeEvent * event) 11761``` 11762**Description** 11763 11764Obtains the type of a component event. 11765 11766**Since**: 12 11767 11768**Parameters** 11769 11770| Name| Description| 11771| -------- | -------- | 11772| event | Pointer to the component event. | 11773 11774**Returns** 11775 11776Returns the type of the component event. 11777 11778 11779### OH_ArkUI_NodeEvent_GetInputEvent() 11780 11781``` 11782ArkUI_UIInputEvent* OH_ArkUI_NodeEvent_GetInputEvent (ArkUI_NodeEvent * event) 11783``` 11784**Description** 11785 11786Obtains input event (for example, touch event) data for a component event. 11787 11788**Since**: 12 11789 11790**Parameters** 11791 11792| Name| Description| 11793| -------- | -------- | 11794| event | Pointer to the component event. | 11795 11796**Returns** 11797 11798Returns the pointer to the input event data. 11799 11800 11801### OH_ArkUI_NodeEvent_GetNodeComponentEvent() 11802 11803``` 11804ArkUI_NodeComponentEvent* OH_ArkUI_NodeEvent_GetNodeComponentEvent (ArkUI_NodeEvent * event) 11805``` 11806**Description** 11807 11808Obtains the numerical data in a component event. 11809 11810**Since**: 12 11811 11812**Parameters** 11813 11814| Name| Description| 11815| -------- | -------- | 11816| event | Pointer to the component event. | 11817 11818**Returns** 11819 11820Returns the pointer to the numerical data. 11821 11822 11823### OH_ArkUI_NodeEvent_GetNodeHandle() 11824 11825``` 11826ArkUI_NodeHandle OH_ArkUI_NodeEvent_GetNodeHandle (ArkUI_NodeEvent * event) 11827``` 11828**Description** 11829 11830Obtains the component object that triggers an event. 11831 11832**Since**: 12 11833 11834**Parameters** 11835 11836| Name| Description| 11837| -------- | -------- | 11838| event | Pointer to the component event. | 11839 11840**Returns** 11841 11842Component object that triggers the event. 11843 11844 11845### OH_ArkUI_NodeEvent_GetNumberValue() 11846 11847``` 11848int32_t OH_ArkUI_NodeEvent_GetNumberValue (ArkUI_NodeEvent * event, int32_t index, ArkUI_NumberValue * value ) 11849``` 11850**Description** 11851 11852Obtains the numeric-type parameter of a component event. 11853 11854**Since**: 12 11855 11856**Parameters** 11857 11858| Name| Description| 11859| -------- | -------- | 11860| event | Pointer to the component event. | 11861| index | Return value index. | 11862| value | Return value. | 11863 11864**Returns** 11865 11866Returns **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. 11867 11868 11869### OH_ArkUI_NodeEvent_GetPreDragStatus() 11870 11871``` 11872ArkUI_PreDragStatus OH_ArkUI_NodeEvent_GetPreDragStatus (ArkUI_NodeEvent * nodeEvent) 11873``` 11874**Description** 11875 11876Obtains the state prior to a drop and drop operation. 11877 11878**Since**: 12 11879 11880**Parameters** 11881 11882| Name| Description| 11883| -------- | -------- | 11884| node | ArkUI_NodeEvent node object. | 11885 11886**Returns** 11887 11888Returns the state prior to the drop and drop operation. 11889 11890 11891### OH_ArkUI_NodeEvent_GetStringAsyncEvent() 11892 11893``` 11894ArkUI_StringAsyncEvent* OH_ArkUI_NodeEvent_GetStringAsyncEvent (ArkUI_NodeEvent * event) 11895``` 11896**Description** 11897 11898Obtains the string data in a component event. 11899 11900**Since**: 12 11901 11902**Parameters** 11903 11904| Name| Description| 11905| -------- | -------- | 11906| event | Pointer to the component event. | 11907 11908**Returns** 11909 11910ArkUI_StringAsyncEvent\Pointer to string data. 11911 11912 11913### OH_ArkUI_NodeEvent_GetStringValue() 11914 11915``` 11916int32_t OH_ArkUI_NodeEvent_GetStringValue (ArkUI_NodeEvent * event, int32_t index, char ** string, int32_t * stringSize ) 11917``` 11918**Description** 11919 11920Obtains 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. 11921 11922**Since**: 12 11923 11924**Parameters** 11925 11926| Name| Description| 11927| -------- | -------- | 11928| event | Pointer to the component event. | 11929| index | Return value index. | 11930| string | Pointer to the string array. | 11931| stringSize | Length of the string array. | 11932 11933**Returns** 11934 11935Returns **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. 11936 11937 11938### OH_ArkUI_NodeEvent_GetTargetId() 11939 11940``` 11941int32_t OH_ArkUI_NodeEvent_GetTargetId (ArkUI_NodeEvent * event) 11942``` 11943**Description** 11944 11945Obtains the custom ID of a component event. 11946 11947The 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. 11948 11949**Since**: 12 11950 11951**Parameters** 11952 11953| Name| Description| 11954| -------- | -------- | 11955| event | Pointer to the component event. | 11956 11957**Returns** 11958 11959Returns the custom ID of the component event. 11960 11961 11962### OH_ArkUI_NodeEvent_GetUserData() 11963 11964``` 11965void* OH_ArkUI_NodeEvent_GetUserData (ArkUI_NodeEvent * event) 11966``` 11967**Description** 11968 11969Obtains the custom data in a component event. 11970 11971This parameter is passed in **registerNodeEvent** and can be applied to the service logic when the event is triggered. 11972 11973**Since**: 12 11974 11975**Parameters** 11976 11977| Name| Description| 11978| -------- | -------- | 11979| event | Pointer to the component event. | 11980 11981**Returns** 11982 11983Returns the pointer to user data. 11984 11985 11986### OH_ArkUI_NodeEvent_SetReturnNumberValue() 11987 11988``` 11989int32_t OH_ArkUI_NodeEvent_SetReturnNumberValue (ArkUI_NodeEvent * event, ArkUI_NumberValue * value, int32_t size ) 11990``` 11991**Description** 11992 11993Sets the return value for a component event. 11994 11995**Since**: 12 11996 11997**Parameters** 11998 11999| Name| Description| 12000| -------- | -------- | 12001| event | Pointer to the component event. | 12002| value | Event numeric type array. | 12003| size | Size of the array. | 12004 12005**Returns** 12006 12007Returns **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. 12008 12009 12010### OH_ArkUI_NodeUtils_AddCustomProperty() 12011 12012``` 12013void OH_ArkUI_NodeUtils_AddCustomProperty (ArkUI_NodeHandle node, const char * name, const char * value ) 12014``` 12015**Description** 12016 12017Sets a custom property for a component. This API takes effect only in the main thread. 12018 12019**Since**: 13 12020 12021**Parameters** 12022 12023| Name| Description| 12024| -------- | -------- | 12025| node | **ArkUI_NodeHandle** pointer. | 12026| name | Name of the custom property. A null pointer is not allowed. | 12027| value | Value of the custom property. A null pointer is not allowed. | 12028 12029 12030### OH_ArkUI_NodeUtils_GetLayoutPosition() 12031 12032``` 12033int32_t OH_ArkUI_NodeUtils_GetLayoutPosition (ArkUI_NodeHandle node, ArkUI_IntOffset * localOffset ) 12034``` 12035**Description** 12036 12037Obtains 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. 12038 12039**Since**: 12 12040 12041**Parameters** 12042 12043| Name| Description| 12044| -------- | -------- | 12045| node | **ArkUI_NodeHandle** pointer. | 12046| localOffset | Offset of the component handle relative to the parent component, in pixels. | 12047 12048**Returns** 12049 12050Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12051 12052 12053### OH_ArkUI_NodeUtils_GetLayoutPositionInScreen() 12054 12055``` 12056int32_t OH_ArkUI_NodeUtils_GetLayoutPositionInScreen (ArkUI_NodeHandle node, ArkUI_IntOffset * screenOffset ) 12057``` 12058**Description** 12059 12060Obtains the position of the component's layout area relative to the screen. The relative position does not count in transformation attributes, such as translate. 12061 12062**Since**: 12 12063 12064**Parameters** 12065 12066| Name| Description| 12067| -------- | -------- | 12068| node | **ArkUI_NodeHandle** pointer. | 12069| screenOffset | Offset of the component handle relative to the screen, in pixels. | 12070 12071**Returns** 12072 12073Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12074 12075 12076### OH_ArkUI_NodeUtils_GetLayoutPositionInWindow() 12077 12078``` 12079int32_t OH_ArkUI_NodeUtils_GetLayoutPositionInWindow (ArkUI_NodeHandle node, ArkUI_IntOffset * globalOffset ) 12080``` 12081**Description** 12082 12083Obtains the position of the component's layout area relative to the window. The relative position does not count in transformation attributes, such as translate. 12084 12085**Since**: 12 12086 12087**Parameters** 12088 12089| Name| Description| 12090| -------- | -------- | 12091| node | **ArkUI_NodeHandle** pointer. | 12092| globalOffset | Offset of the component handle relative to the window, in pixels. | 12093 12094**Returns** 12095 12096Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12097 12098 12099### OH_ArkUI_NodeUtils_GetLayoutSize() 12100 12101``` 12102int32_t OH_ArkUI_NodeUtils_GetLayoutSize (ArkUI_NodeHandle node, ArkUI_IntSize * size ) 12103``` 12104**Description** 12105 12106Obtains the layout area size of a component. The size does not count in transformation attributes, such as scale. 12107 12108**Since**: 12 12109 12110**Parameters** 12111 12112| Name| Description| 12113| -------- | -------- | 12114| node | **ArkUI_NodeHandle** pointer. | 12115| size | Size of the layout area, in px. | 12116 12117**Returns** 12118 12119Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12120 12121 12122### OH_ArkUI_NodeUtils_GetPositionWithTranslateInScreen() 12123 12124``` 12125int32_t OH_ArkUI_NodeUtils_GetPositionWithTranslateInScreen (ArkUI_NodeHandle node, ArkUI_IntOffset * translateOffset ) 12126``` 12127**Description** 12128 12129Obtains the position of a component on the screen, including the translate attribute. 12130 12131**Since**: 12 12132 12133**Parameters** 12134 12135| Name| Description| 12136| -------- | -------- | 12137| node | **ArkUI_NodeHandle** pointer. | 12138| translateOffset | Accumulated offset of the component, its parent component, and its ancestor node, in px. | 12139 12140**Returns** 12141 12142Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12143 12144 12145### OH_ArkUI_NodeUtils_GetPositionWithTranslateInWindow() 12146 12147``` 12148int32_t OH_ArkUI_NodeUtils_GetPositionWithTranslateInWindow (ArkUI_NodeHandle node, ArkUI_IntOffset * translateOffset ) 12149``` 12150**Description** 12151 12152Obtains the position of a component in the window, including the translate attribute. 12153 12154**Since**: 12 12155 12156**Parameters** 12157 12158| Name| Description| 12159| -------- | -------- | 12160| node | **ArkUI_NodeHandle** pointer. | 12161| translateOffset | Accumulated offset of the component, its parent component, and its ancestor node, in px. | 12162 12163**Returns** 12164 12165Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12166 12167 12168### OH_ArkUI_NodeUtils_RemoveCustomProperty() 12169 12170``` 12171void OH_ArkUI_NodeUtils_RemoveCustomProperty (ArkUI_NodeHandle node, const char * name ) 12172``` 12173**Description** 12174 12175Removes a custom property that has been set for the specified component. 12176 12177**Since**: 13 12178 12179**Parameters** 12180 12181| Name| Description| 12182| -------- | -------- | 12183| node | **ArkUI_NodeHandle** pointer. | 12184| name | Name of the custom property. | 12185 12186 12187### OH_ArkUI_PanGesture_GetOffsetX() 12188 12189``` 12190float OH_ArkUI_PanGesture_GetOffsetX (const ArkUI_GestureEvent * event) 12191``` 12192**Description** 12193 12194Obtains the relative offset of a pan gesture along the x-axis. 12195 12196**Since**: 12 12197 12198**Parameters** 12199 12200| Name| Description| 12201| -------- | -------- | 12202| event | Gesture event. | 12203 12204**Returns** 12205 12206Returns the relative offset of the gesture along the x-axis, in px. 12207 12208 12209### OH_ArkUI_PanGesture_GetOffsetY() 12210 12211``` 12212float OH_ArkUI_PanGesture_GetOffsetY (const ArkUI_GestureEvent * event) 12213``` 12214**Description** 12215 12216Obtains the relative offset of a pan gesture along the y-axis. 12217 12218**Since**: 12 12219 12220**Parameters** 12221 12222| Name| Description| 12223| -------- | -------- | 12224| event | Gesture event. | 12225 12226**Returns** 12227 12228Returns the relative offset of the gesture along the y-axis, in px. 12229 12230 12231### OH_ArkUI_PanGesture_GetVelocity() 12232 12233``` 12234float OH_ArkUI_PanGesture_GetVelocity (const ArkUI_GestureEvent * event) 12235``` 12236**Description** 12237 12238Obtains the velocity of a pan gesture along the main axis. 12239 12240**Since**: 12 12241 12242**Parameters** 12243 12244| Name| Description| 12245| -------- | -------- | 12246| event | Gesture event. | 12247 12248**Returns** 12249 12250Returns 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. 12251 12252 12253### OH_ArkUI_PanGesture_GetVelocityX() 12254 12255``` 12256float OH_ArkUI_PanGesture_GetVelocityX (const ArkUI_GestureEvent * event) 12257``` 12258**Description** 12259 12260Obtains the velocity of a pan gesture along the x-axis. 12261 12262**Since**: 12 12263 12264**Parameters** 12265 12266| Name| Description| 12267| -------- | -------- | 12268| event | Gesture event. | 12269 12270**Returns** 12271 12272Returns the velocity of the pan gesture along the x-axis, in px/s. 12273 12274 12275### OH_ArkUI_PanGesture_GetVelocityY() 12276 12277``` 12278float OH_ArkUI_PanGesture_GetVelocityY (const ArkUI_GestureEvent * event) 12279``` 12280**Description** 12281 12282Obtains the velocity of a pan gesture along the y-axis. 12283 12284**Since**: 12 12285 12286**Parameters** 12287 12288| Name| Description| 12289| -------- | -------- | 12290| event | Gesture event. | 12291 12292**Returns** 12293 12294Returns the velocity of the pan gesture along the y-axis, in px/s. 12295 12296 12297### OH_ArkUI_ParallelInnerGestureEvent_GetConflictRecognizers() 12298 12299``` 12300int32_t OH_ArkUI_ParallelInnerGestureEvent_GetConflictRecognizers (ArkUI_ParallelInnerGestureEvent * event, ArkUI_GestureRecognizerHandleArray * array, int32_t * size ) 12301``` 12302**Description** 12303 12304Obtains the conflicting gesture recognizers in a parallel internal gesture event. 12305 12306**Since**: 12 12307 12308**Parameters** 12309 12310| Name| Description| 12311| -------- | -------- | 12312| event | Parallel internal gesture event. | 12313| array | Array of conflicting gesture recognizers. | 12314| size | Size of the conflicting gesture recognizer array. | 12315 12316**Returns** 12317 12318Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 12319 12320 12321### OH_ArkUI_ParallelInnerGestureEvent_GetCurrentRecognizer() 12322 12323``` 12324ArkUI_GestureRecognizer* OH_ArkUI_ParallelInnerGestureEvent_GetCurrentRecognizer (ArkUI_ParallelInnerGestureEvent * event) 12325``` 12326**Description** 12327 12328Obtains the current gesture recognizer in a parallel internal gesture event. 12329 12330**Since**: 12 12331 12332**Parameters** 12333 12334| Name| Description| 12335| -------- | -------- | 12336| event | Parallel internal gesture event. | 12337 12338**Returns** 12339 12340Returns the pointer to the current gesture recognizer. 12341 12342 12343### OH_ArkUI_ParallelInnerGestureEvent_GetUserData() 12344 12345``` 12346void* OH_ArkUI_ParallelInnerGestureEvent_GetUserData (ArkUI_ParallelInnerGestureEvent * event) 12347``` 12348**Description** 12349 12350Obtains custom data in the parallel internal gesture event. 12351 12352**Since**: 12 12353 12354**Parameters** 12355 12356| Name| Description| 12357| -------- | -------- | 12358| event | Parallel internal gesture event. | 12359 12360**Returns** 12361 12362Returns the pointer to custom data. 12363 12364 12365### OH_ArkUI_PinchGesture_GetCenterX() 12366 12367``` 12368float OH_ArkUI_PinchGesture_GetCenterX (const ArkUI_GestureEvent * event) 12369``` 12370**Description** 12371 12372Obtains the X coordinate of the center of the pinch gesture, in vp, relative to the upper left corner of the current component. 12373 12374**Since**: 12 12375 12376**Parameters** 12377 12378| Name| Description| 12379| -------- | -------- | 12380| event | Gesture event. | 12381 12382**Returns** 12383Returns the X coordinate of the center of the pinch gesture, in vp, relative to the upper left corner of the current component. 12384 12385 12386### OH_ArkUI_PinchGesture_GetCenterY() 12387 12388``` 12389float OH_ArkUI_PinchGesture_GetCenterY (const ArkUI_GestureEvent * event) 12390``` 12391**Description** 12392 12393Obtains the Y coordinate of the center of the pinch gesture, in vp, relative to the upper left corner of the current component. 12394 12395**Since**: 12 12396 12397**Parameters** 12398 12399| Name| Description| 12400| -------- | -------- | 12401| event | Gesture event. | 12402 12403**Returns** 12404 12405Returns the Y coordinate of the center of the pinch gesture, in vp, relative to the upper left corner of the current component. 12406 12407 12408### OH_ArkUI_PinchGesture_GetScale() 12409 12410``` 12411float OH_ArkUI_PinchGesture_GetScale (const ArkUI_GestureEvent * event) 12412``` 12413**Description** 12414 12415Obtains the scale ratio of a pinch gesture. 12416 12417**Since**: 12 12418 12419**Parameters** 12420 12421| Name| Description| 12422| -------- | -------- | 12423| event | Gesture event. | 12424 12425**Returns** 12426 12427Scale. 12428 12429 12430### OH_ArkUI_QueryModuleInterfaceByName() 12431 12432``` 12433void* OH_ArkUI_QueryModuleInterfaceByName (ArkUI_NativeAPIVariantKind type, const char * structName ) 12434``` 12435**Description** 12436 12437Obtains the native API set of a specified type. 12438 12439**Since**: 12 12440 12441**Parameters** 12442 12443| Name| Description| 12444| -------- | -------- | 12445| type | Type of the native API set provided by ArkUI, for example, **ARKUI_NATIVE_NODE** or **ARKUI_NATIVE_GESTURE**. | 12446| sturctName | Name of a native struct defined in the corresponding header file, for example, **ArkUI_NativeNodeAPI_1** in <arkui/native_node.h>. | 12447 12448**Returns** 12449 12450Returns 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); } 12451 12452 12453### OH_ArkUI_RegisterSystemColorModeChangeEvent() 12454 12455``` 12456int32_t OH_ArkUI_RegisterSystemColorModeChangeEvent (ArkUI_NodeHandle node, void * userData, void(*)(ArkUI_SystemColorMode colorMode, void *userData) onColorModeChange ) 12457``` 12458**Description** 12459 12460Registers an event listener for system color mode changes. A single component can only register one callback for system color mode changes. 12461 12462**Since**: 12 12463 12464**Parameters** 12465 12466| Name| Description| 12467| -------- | -------- | 12468| node | Specified node. | 12469| userData | Custom event parameter, which is passed in the callback when the event is triggered. | 12470| onColorModeChange | Callback to be executed when the event is triggered. | 12471 12472**Returns** 12473 12474Returns **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. 12475 12476 12477### OH_ArkUI_RegisterSystemFontStyleChangeEvent() 12478 12479``` 12480int32_t OH_ArkUI_RegisterSystemFontStyleChangeEvent (ArkUI_NodeHandle node, void * userData, void(*)(ArkUI_SystemFontStyleEvent *event, void *userData) onFontStyleChange ) 12481``` 12482**Description** 12483 12484Registers an event listener for system font style changes. A single component can only register one callback for system font style changes. 12485 12486**Since**: 12 12487 12488**Parameters** 12489 12490| Name| Description| 12491| -------- | -------- | 12492| node | Specified node. | 12493| userData | Custom event parameter, which is passed in the callback when the event is triggered. | 12494| onFontStyleChange | Callback to be executed when the event is triggered. | 12495 12496**Returns** 12497 12498Returns **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. 12499 12500 12501### OH_ArkUI_RotationGesture_GetAngle() 12502 12503``` 12504float OH_ArkUI_RotationGesture_GetAngle (const ArkUI_GestureEvent * event) 12505``` 12506**Description** 12507 12508Obtains the angle information of a rotation gesture. 12509 12510**Since**: 12 12511 12512**Parameters** 12513 12514| Name| Description| 12515| -------- | -------- | 12516| event | Gesture event. | 12517 12518**Returns** 12519 12520Rotation angle. 12521 12522 12523### OH_ArkUI_SetArkUIGestureRecognizerDisposeNotify() 12524 12525``` 12526int32_t OH_ArkUI_SetArkUIGestureRecognizerDisposeNotify (ArkUI_GestureRecognizer * recognizer, ArkUI_GestureRecognizerDestructNotifyCallback callback, void * userData ) 12527``` 12528**Description** 12529 12530Sets a callback function for notifying gesture recognizer destruction. 12531 12532**Parameters** 12533 12534| Name| Description| 12535| -------- | -------- | 12536| recognizer | Pointer to the gesture recognizer. | 12537| callback | Callback function for notifying gesture recognizer destruction. | 12538| userData | Custom data. | 12539 12540**Returns** 12541 12542Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 12543 12544 12545### OH_ArkUI_SetDragEventStrictReportWithContext() 12546 12547``` 12548int32_t OH_ArkUI_SetDragEventStrictReportWithContext (ArkUI_ContextHandle uiContext, bool enabled ) 12549``` 12550**Description** 12551 12552Sets 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. 12553 12554**Since**: 12 12555 12556**Parameters** 12557 12558| Name| Description| 12559| -------- | -------- | 12560| uiContext | Pointer to the UI instance. | 12561| enabled | Whether to enable strict reporting on drag events. | 12562 12563**Returns** 12564 12565Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12566 12567 12568### OH_ArkUI_SetDragEventStrictReportWithNode() 12569 12570``` 12571int32_t OH_ArkUI_SetDragEventStrictReportWithNode (ArkUI_NodeHandle node, bool enabled ) 12572``` 12573**Description** 12574 12575Sets 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. 12576 12577**Since**: 12 12578 12579**Parameters** 12580 12581| Name| Description| 12582| -------- | -------- | 12583| node | Pointer to a component node. | 12584| enabled | Whether to enable strict reporting on drag events. | 12585 12586**Returns** 12587 12588Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12589 12590 12591### OH_ArkUI_SetGestureRecognizerEnabled() 12592 12593``` 12594int32_t OH_ArkUI_SetGestureRecognizerEnabled (ArkUI_GestureRecognizer * recognizer, bool enabled ) 12595``` 12596**Description** 12597 12598Sets the enabled state of a gesture recognizer. 12599 12600**Since**: 12 12601 12602**Parameters** 12603 12604| Name| Description| 12605| -------- | -------- | 12606| recognizer | Pointer to the gesture recognizer. | 12607| enabled | Whether to enable notification. | 12608 12609**Returns** 12610 12611Returns **0** if the operation is successful. Returns **401** if a parameter error occurs. 12612 12613 12614### OH_ArkUI_SetNodeAllowedDropDataTypes() 12615 12616``` 12617int32_t OH_ArkUI_SetNodeAllowedDropDataTypes (ArkUI_NodeHandle node, const char * typesArray[], int32_t count ) 12618``` 12619**Description** 12620 12621Sets 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). 12622 12623**Since**: 12 12624 12625**Parameters** 12626 12627| Name| Description| 12628| -------- | -------- | 12629| node | Pointer to a component node. | 12630| typesArray | Array of data types that can fall into. | 12631| count | Length of an array. | 12632 12633**Returns** 12634 12635Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12636 12637 12638### OH_ArkUI_SetNodeDraggable() 12639 12640``` 12641int32_t OH_ArkUI_SetNodeDraggable (ArkUI_NodeHandle node, bool enabled ) 12642``` 12643**Description** 12644 12645Sets whether the component is draggable. 12646 12647**Since**: 12 12648 12649**Parameters** 12650 12651| Name| Description| 12652| -------- | -------- | 12653| node | Pointer to a component node. | 12654| bool | Whether the component is draggable. | 12655 12656**Returns** 12657 12658Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12659 12660 12661### OH_ArkUI_SetNodeDragPreview() 12662 12663``` 12664int32_t OH_ArkUI_SetNodeDragPreview (ArkUI_NodeHandle node, OH_PixelmapNative * preview ) 12665``` 12666**Description** 12667 12668Sets a custom drag preview for the specified component. 12669 12670**Since**: 12 12671 12672**Parameters** 12673 12674| Name| Description| 12675| -------- | -------- | 12676| node | Pointer to the target component node. | 12677| preview | Custom drag preview, which is a pixel map. | 12678 12679**Returns** 12680 12681Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12682 12683 12684### OH_ArkUI_SetNodeDragPreviewOption() 12685 12686``` 12687int32_t OH_ArkUI_SetNodeDragPreviewOption (ArkUI_NodeHandle node, ArkUI_DragPreviewOption * option ) 12688``` 12689**Description** 12690 12691Sets an **ArkUI_DragPreviewOption** object for the specified component. 12692 12693**Since**: 12 12694 12695**Parameters** 12696 12697| Name| Description| 12698| -------- | -------- | 12699| node | Pointer to a component node. | 12700| option | Custom parameters. | 12701 12702**Returns** 12703 12704Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12705 12706 12707### OH_ArkUI_StartDrag() 12708 12709``` 12710int32_t OH_ArkUI_StartDrag (ArkUI_DragAction * dragAction) 12711``` 12712**Description** 12713 12714Initiates a drag action through the specified drag action object. 12715 12716**Since**: 12 12717 12718**Parameters** 12719 12720| Name| Description| 12721| -------- | -------- | 12722| dragAction | Drag action object. | 12723 12724**Returns** 12725 12726Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 12727 12728 12729### OH_ArkUI_StyledString_AddPlaceholder() 12730 12731``` 12732void OH_ArkUI_StyledString_AddPlaceholder (ArkUI_StyledString * handle, OH_Drawing_PlaceholderSpan * placeholder ) 12733``` 12734**Description** 12735 12736Adds a placeholder. 12737 12738**Since**: 12 12739 12740**Parameters** 12741 12742| Name| Description| 12743| -------- | -------- | 12744| handle | Pointer to an **ArkUI_StyledString** object. | 12745| placeholder | Pointer to an **OH_Drawing_PlaceholderSpan** object. | 12746 12747 12748### OH_ArkUI_StyledString_AddText() 12749 12750``` 12751void OH_ArkUI_StyledString_AddText (ArkUI_StyledString * handle, const char * content ) 12752``` 12753**Description** 12754 12755Sets the text content based on the current format string style. 12756 12757**Since**: 12 12758 12759**Parameters** 12760 12761| Name| Description| 12762| -------- | -------- | 12763| handle | Pointer to an **ArkUI_StyledString** object. | 12764| content | Pointer to the text content. | 12765 12766 12767### OH_ArkUI_StyledString_Create() 12768 12769``` 12770ArkUI_StyledString* OH_ArkUI_StyledString_Create (OH_Drawing_TypographyStyle * style, OH_Drawing_FontCollection * collection ) 12771``` 12772**Description** 12773 12774Creates an **ArkUI_StyledString** object. 12775 12776**Since**: 12 12777 12778**Parameters** 12779 12780| Name| Description| 12781| -------- | -------- | 12782| style | Pointer to an **OH_Drawing_TypographyStyle** object, which is obtained by calling **OH_Drawing_CreateTypographyStyle**. | 12783| collection | Pointer to an **OH_Drawing_FontCollection** object, which is obtained by calling **OH_Drawing_CreateFontCollection**. | 12784 12785**Returns** 12786 12787Returns 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. 12788 12789 12790### OH_ArkUI_StyledString_CreateTypography() 12791 12792``` 12793OH_Drawing_Typography* OH_ArkUI_StyledString_CreateTypography (ArkUI_StyledString * handle) 12794``` 12795**Description** 12796 12797Creates an **OH_Drawing_Typography** object based on an **ArkUI_StyledString** object. 12798 12799**Since**: 12 12800 12801**Parameters** 12802 12803| Name| Description| 12804| -------- | -------- | 12805| handle | Pointer to an **ArkUI_StyledString** object. | 12806 12807**Returns** 12808 12809Returns 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. 12810 12811 12812### OH_ArkUI_StyledString_Descriptor_Create() 12813 12814``` 12815ArkUI_StyledString_Descriptor* OH_ArkUI_StyledString_Descriptor_Create () 12816``` 12817**Description** 12818 12819Creates an **ArkUI_StyledString_Descriptor** object. 12820 12821**Since**: 14 12822 12823**Returns** 12824 12825Pointer to an **ArkUI_StyledString_Descriptor** object. 12826 12827 12828### OH_ArkUI_StyledString_Descriptor_Destroy() 12829 12830``` 12831void OH_ArkUI_StyledString_Descriptor_Destroy (ArkUI_StyledString_Descriptor * descriptor) 12832``` 12833**Description** 12834 12835Destroys an **ArkUI_StyledString_Descriptor** object and reclaims the memory occupied by the object. 12836 12837**Since**: 14 12838 12839**Parameters** 12840 12841| Name| Description| 12842| -------- | -------- | 12843| descriptor | Pointer to an **ArkUI_StyledString_Descriptor** object. | 12844 12845 12846### OH_ArkUI_StyledString_Destroy() 12847 12848``` 12849void OH_ArkUI_StyledString_Destroy (ArkUI_StyledString * handle) 12850``` 12851**Description** 12852 12853Destroys an **OH_Drawing_TextStyle** object and reclaims the memory occupied by the object. 12854 12855**Since**: 12 12856 12857**Parameters** 12858 12859| Name| Description| 12860| -------- | -------- | 12861| handle | Pointer to an **ArkUI_StyledString** object. | 12862 12863 12864### OH_ArkUI_StyledString_PopTextStyle() 12865 12866``` 12867void OH_ArkUI_StyledString_PopTextStyle (ArkUI_StyledString * handle) 12868``` 12869**Description** 12870 12871Removes the top style from the current formatted string object. 12872 12873**Since**: 12 12874 12875**Parameters** 12876 12877| Name| Description| 12878| -------- | -------- | 12879| handle | Pointer to an **ArkUI_StyledString** object. | 12880 12881 12882### OH_ArkUI_StyledString_PushTextStyle() 12883 12884``` 12885void OH_ArkUI_StyledString_PushTextStyle (ArkUI_StyledString * handle, OH_Drawing_TextStyle * style ) 12886``` 12887**Description** 12888 12889Sets the new typesetting style to the top of the current format string style stack. 12890 12891**Since**: 12 12892 12893**Parameters** 12894 12895| Name| Description| 12896| -------- | -------- | 12897| handle | Pointer to an **ArkUI_StyledString** object. | 12898| style | Pointer to an **OH_Drawing_TextStyle** object. | 12899 12900 12901### OH_ArkUI_SwipeGesture_GetAngle() 12902 12903``` 12904float OH_ArkUI_SwipeGesture_GetAngle (const ArkUI_GestureEvent * event) 12905``` 12906**Description** 12907 12908Obtains the angle information of the swipe gesture. 12909 12910**Since**: 12 12911 12912**Parameters** 12913 12914| Name| Description| 12915| -------- | -------- | 12916| event | Gesture event. | 12917 12918**Returns** 12919 12920Returns the angle of the swipe gesture, which is the result obtained based on the aforementioned formula. 12921 12922 12923### OH_ArkUI_SwipeGesture_GetVelocity() 12924 12925``` 12926float OH_ArkUI_SwipeGesture_GetVelocity (const ArkUI_GestureEvent * event) 12927``` 12928**Description** 12929 12930Obtains the average velocity of all fingers used in the swipe gesture. 12931 12932**Since**: 12 12933 12934**Parameters** 12935 12936| Name| Description| 12937| -------- | -------- | 12938| event | Gesture event. | 12939 12940**Returns** 12941 12942Returns the average velocity of all fingers used in the swipe gesture, in px/s. 12943 12944 12945### OH_ArkUI_SwiperIndicator_Create() 12946 12947``` 12948ArkUI_SwiperIndicator* OH_ArkUI_SwiperIndicator_Create (ArkUI_SwiperIndicatorType type) 12949``` 12950**Description** 12951 12952Creates a navigation indicator for the Swiper component. 12953 12954**Since**: 12 12955 12956**Parameters** 12957 12958| Name| Description| 12959| -------- | -------- | 12960| type | Type of the navigation indicator. | 12961 12962**Returns** 12963 12964Returns the pointer to the navigation point indicator. 12965 12966 12967### OH_ArkUI_SwiperIndicator_Dispose() 12968 12969``` 12970void OH_ArkUI_SwiperIndicator_Dispose (ArkUI_SwiperIndicator * indicator) 12971``` 12972**Description** 12973 12974Disposes of the navigation point indicator of this **Swiper** component. 12975 12976**Since**: 12 12977 12978**Parameters** 12979 12980| Name| Description| 12981| -------- | -------- | 12982| indicator | Returns the pointer to the navigation point indicator. | 12983 12984 12985### OH_ArkUI_SwiperIndicator_GetBottomPosition() 12986 12987``` 12988float OH_ArkUI_SwiperIndicator_GetBottomPosition (ArkUI_SwiperIndicator * indicator) 12989``` 12990**Description** 12991 12992Obtains the distance between the navigation point indicator and the bottom edge of the **Swiper** component. 12993 12994**Since**: 12 12995 12996**Parameters** 12997 12998| Name| Description| 12999| -------- | -------- | 13000| indicator | Returns the pointer to the navigation point indicator. | 13001 13002**Returns** 13003 13004Returns the distance between a navigation point indicator and the bottom edge of the **Swiper** component. 13005 13006 13007### OH_ArkUI_SwiperIndicator_GetColor() 13008 13009``` 13010uint32_t OH_ArkUI_SwiperIndicator_GetColor (ArkUI_SwiperIndicator * indicator) 13011``` 13012**Description** 13013 13014Obtains the color of a navigation point indicator of the dot style of the **Swiper** component. 13015 13016**Since**: 12 13017 13018**Parameters** 13019 13020| Name| Description| 13021| -------- | -------- | 13022| indicator | Returns the pointer to the navigation point indicator. | 13023 13024**Returns** 13025 13026Returns the color, in 0xARGB format. For example, 0xFFFF0000 indicates red. 13027 13028 13029### OH_ArkUI_SwiperIndicator_GetEndPosition() 13030 13031``` 13032float OH_ArkUI_SwiperIndicator_GetEndPosition (ArkUI_SwiperIndicator * indicator) 13033``` 13034**Description** 13035 13036Obtains the distance between a navigation point indicator and the right edge of the **Swiper** component. 13037 13038**Since**: 12 13039 13040**Parameters** 13041 13042| Name| Description| 13043| -------- | -------- | 13044| indicator | Returns the pointer to the navigation point indicator. | 13045 13046**Returns** 13047 13048Returns the distance between the navigation point indicator and the right edge of the **Swiper** component. 13049 13050 13051### OH_ArkUI_SwiperIndicator_GetItemHeight() 13052 13053``` 13054float OH_ArkUI_SwiperIndicator_GetItemHeight (ArkUI_SwiperIndicator * indicator) 13055``` 13056**Description** 13057 13058Obtains the height of a navigation point indicator of the dot style of the **Swiper** component. 13059 13060**Since**: 12 13061 13062**Parameters** 13063 13064| Name| Description| 13065| -------- | -------- | 13066| indicator | Returns the pointer to the navigation point indicator. | 13067 13068**Returns** 13069 13070Returns the height of the navigation point indicator of the dot style. 13071 13072 13073### OH_ArkUI_SwiperIndicator_GetItemWidth() 13074 13075``` 13076float OH_ArkUI_SwiperIndicator_GetItemWidth (ArkUI_SwiperIndicator * indicator) 13077``` 13078**Description** 13079 13080Obtains the width of a navigation point indicator of the dot style of the **Swiper** component. 13081 13082**Since**: 12 13083 13084**Parameters** 13085 13086| Name| Description| 13087| -------- | -------- | 13088| indicator | Returns the pointer to the navigation point indicator. | 13089 13090**Returns** 13091 13092Returns the width of the navigation point indicator of the dot style. 13093 13094 13095### OH_ArkUI_SwiperIndicator_GetMask() 13096 13097``` 13098int32_t OH_ArkUI_SwiperIndicator_GetMask (ArkUI_SwiperIndicator * indicator) 13099``` 13100**Description** 13101 13102Obtains whether the mask is enabled for a navigation point indicator of the dot style of the **Swiper** component. 13103 13104**Since**: 12 13105 13106**Parameters** 13107 13108| Name| Description| 13109| -------- | -------- | 13110| indicator | Returns the pointer to the navigation point indicator. | 13111 13112**Returns** 13113 13114Returns **1** if the mask is enabled; returns **0** otherwise. 13115 13116 13117### OH_ArkUI_SwiperIndicator_GetMaxDisplayCount() 13118 13119``` 13120int32_t OH_ArkUI_SwiperIndicator_GetMaxDisplayCount (ArkUI_SwiperIndicator * indicator) 13121``` 13122**Description** 13123 13124Obtains the maximum number of dots for the navigation point indicator of the dot style. 13125 13126**Since**: 12 13127 13128**Parameters** 13129 13130| Name| Description| 13131| -------- | -------- | 13132| indicator | Pointer to the navigation point indicator. | 13133 13134**Returns** 13135 13136Returns the maximum number of dots. The value ranges from 6 to 9. 13137 13138 13139### OH_ArkUI_SwiperIndicator_GetSelectedColor() 13140 13141``` 13142uint32_t OH_ArkUI_SwiperIndicator_GetSelectedColor (ArkUI_SwiperIndicator * indicator) 13143``` 13144**Description** 13145 13146Obtains the color of the selected navigation point indicator of the dot style of the **Swiper** component. 13147 13148**Since**: 12 13149 13150**Parameters** 13151 13152| Name| Description| 13153| -------- | -------- | 13154| indicator | Returns the pointer to the navigation point indicator. | 13155 13156**Returns** 13157 13158Returns the color, in 0xARGB format. For example, 0xFFFF0000 indicates red. 13159 13160 13161### OH_ArkUI_SwiperIndicator_GetSelectedItemHeight() 13162 13163``` 13164float OH_ArkUI_SwiperIndicator_GetSelectedItemHeight (ArkUI_SwiperIndicator * indicator) 13165``` 13166**Description** 13167 13168Obtains the height of the selected navigation point indicator of the dot style of the **Swiper** component. 13169 13170**Since**: 12 13171 13172**Parameters** 13173 13174| Name| Description| 13175| -------- | -------- | 13176| indicator | Returns the pointer to the navigation point indicator. | 13177 13178**Returns** 13179 13180Returns the height of the navigation point indicator of the dot style. 13181 13182 13183### OH_ArkUI_SwiperIndicator_GetSelectedItemWidth() 13184 13185``` 13186float OH_ArkUI_SwiperIndicator_GetSelectedItemWidth (ArkUI_SwiperIndicator * indicator) 13187``` 13188**Description** 13189 13190Obtains the width of the selected navigation point indicator of the dot style of the **Swiper** component. 13191 13192**Since**: 12 13193 13194**Parameters** 13195 13196| Name| Description| 13197| -------- | -------- | 13198| indicator | Returns the pointer to the navigation point indicator. | 13199 13200**Returns** 13201 13202Returns the width of the navigation point indicator of the dot style. 13203 13204 13205### OH_ArkUI_SwiperIndicator_GetStartPosition() 13206 13207``` 13208float OH_ArkUI_SwiperIndicator_GetStartPosition (ArkUI_SwiperIndicator * indicator) 13209``` 13210**Description** 13211 13212Obtains the distance between a navigation point indicator and the left edge of the **Swiper** component. 13213 13214**Since**: 12 13215 13216**Parameters** 13217 13218| Name| Description| 13219| -------- | -------- | 13220| indicator | Returns the pointer to the navigation point indicator. | 13221 13222**Returns** 13223 13224Returns the distance between the navigation point indicator and the left edge of the **Swiper** component. 13225 13226 13227### OH_ArkUI_SwiperIndicator_GetTopPosition() 13228 13229``` 13230float OH_ArkUI_SwiperIndicator_GetTopPosition (ArkUI_SwiperIndicator * indicator) 13231``` 13232**Description** 13233 13234Obtains the distance between the navigation point indicator and the top edge of the **Swiper** component. 13235 13236**Since**: 12 13237 13238**Parameters** 13239 13240| Name| Description| 13241| -------- | -------- | 13242| indicator | Returns the pointer to the navigation point indicator. | 13243 13244**Returns** 13245 13246Returns the distance between a navigation point indicator and the top edge of the **Swiper** component. 13247 13248 13249### OH_ArkUI_SwiperIndicator_SetBottomPosition() 13250 13251``` 13252void OH_ArkUI_SwiperIndicator_SetBottomPosition (ArkUI_SwiperIndicator * indicator, float value ) 13253``` 13254**Description** 13255 13256Distance between the navigation point indicator and the bottom edge of the **Swiper** component. 13257 13258**Since**: 12 13259 13260**Parameters** 13261 13262| Name| Description| 13263| -------- | -------- | 13264| indicator | Returns the pointer to the navigation point indicator. | 13265| value | Returns the distance between a navigation point indicator and the bottom edge of the **Swiper** component. | 13266 13267 13268### OH_ArkUI_SwiperIndicator_SetColor() 13269 13270``` 13271void OH_ArkUI_SwiperIndicator_SetColor (ArkUI_SwiperIndicator * indicator, uint32_t color ) 13272``` 13273**Description** 13274 13275Sets the color of a navigation point indicator of the dot style for the **Swiper** component. 13276 13277**Since**: 12 13278 13279**Parameters** 13280 13281| Name| Description| 13282| -------- | -------- | 13283| indicator | Returns the pointer to the navigation point indicator. | 13284| color | Returns the color, in 0xARGB format. For example, 0xFFFF0000 indicates red. | 13285 13286 13287### OH_ArkUI_SwiperIndicator_SetEndPosition() 13288 13289``` 13290void OH_ArkUI_SwiperIndicator_SetEndPosition (ArkUI_SwiperIndicator * indicator, float value ) 13291``` 13292**Description** 13293 13294Distance between the navigation point indicator and the left edge of the **Swiper** component. 13295 13296**Since**: 12 13297 13298**Parameters** 13299 13300| Name| Description| 13301| -------- | -------- | 13302| indicator | Returns the pointer to the navigation point indicator. | 13303| value | Returns the distance between the navigation point indicator and the right edge of the **Swiper** component. | 13304 13305 13306### OH_ArkUI_SwiperIndicator_SetItemHeight() 13307 13308``` 13309void OH_ArkUI_SwiperIndicator_SetItemHeight (ArkUI_SwiperIndicator * indicator, float value ) 13310``` 13311**Description** 13312 13313Sets the height of a navigation point indicator of the dot style for the **Swiper** component. 13314 13315**Since**: 12 13316 13317**Parameters** 13318 13319| Name| Description| 13320| -------- | -------- | 13321| indicator | Returns the pointer to the navigation point indicator. | 13322| value | Returns the height of the navigation point indicator of the dot style. | 13323 13324 13325### OH_ArkUI_SwiperIndicator_SetItemWidth() 13326 13327``` 13328void OH_ArkUI_SwiperIndicator_SetItemWidth (ArkUI_SwiperIndicator * indicator, float value ) 13329``` 13330**Description** 13331 13332Sets the width of a navigation point indicator of the dot style for the **Swiper** component. 13333 13334**Since**: 12 13335 13336**Parameters** 13337 13338| Name| Description| 13339| -------- | -------- | 13340| indicator | Returns the pointer to the navigation point indicator. | 13341| value | Returns the width of the navigation point indicator of the dot style. | 13342 13343 13344### OH_ArkUI_SwiperIndicator_SetMask() 13345 13346``` 13347void OH_ArkUI_SwiperIndicator_SetMask (ArkUI_SwiperIndicator * indicator, int32_t mask ) 13348``` 13349**Description** 13350 13351Sets whether to enable the mask for a navigation point indicator of the dot style for the **Swiper** component. 13352 13353**Since**: 12 13354 13355**Parameters** 13356 13357| Name| Description| 13358| -------- | -------- | 13359| indicator | Pointer to a navigation point indicator. | 13360| mask | Whether to enable the mask. The value **1** means to enable the mask, and **0** means the opposite. | 13361 13362 13363### OH_ArkUI_SwiperIndicator_SetMaxDisplayCount() 13364 13365``` 13366int32_t OH_ArkUI_SwiperIndicator_SetMaxDisplayCount (ArkUI_SwiperIndicator * indicator, int32_t maxDisplayCount ) 13367``` 13368**Description** 13369 13370Sets the maximum number of dots for the navigation point indicator of the dot style. 13371 13372**Since**: 12 13373 13374**Parameters** 13375 13376| Name| Description| 13377| -------- | -------- | 13378| indicator | Pointer to a navigation point indicator. | 13379| maxDisplayCount | Maximum number of navigation points. The value ranges from 6 to 9. | 13380 13381**Returns** 13382 13383Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if **maxDisplayCount** is set to an invalid value. 13384 13385 13386### OH_ArkUI_SwiperIndicator_SetSelectedColor() 13387 13388``` 13389void OH_ArkUI_SwiperIndicator_SetSelectedColor (ArkUI_SwiperIndicator * indicator, uint32_t selectedColor ) 13390``` 13391**Description** 13392 13393Sets the color of the selected navigation point indicator of the dot style for the **Swiper** component. 13394 13395**Since**: 12 13396 13397**Parameters** 13398 13399| Name| Description| 13400| -------- | -------- | 13401| indicator | Pointer to a navigation point indicator. | 13402| selectedColor | Color, in 0xARGB format. For example, 0xFFFF0000 indicates red. | 13403 13404 13405### OH_ArkUI_SwiperIndicator_SetSelectedItemHeight() 13406 13407``` 13408void OH_ArkUI_SwiperIndicator_SetSelectedItemHeight (ArkUI_SwiperIndicator * indicator, float value ) 13409``` 13410**Description** 13411 13412Sets the height of the selected navigation point indicator of the dot style for the **Swiper** component. 13413 13414**Since**: 12 13415 13416**Parameters** 13417 13418| Name| Description| 13419| -------- | -------- | 13420| indicator | Pointer to a navigation point indicator. | 13421| value | Height of the navigation point indicator of the dot style. | 13422 13423 13424### OH_ArkUI_SwiperIndicator_SetSelectedItemWidth() 13425 13426``` 13427void OH_ArkUI_SwiperIndicator_SetSelectedItemWidth (ArkUI_SwiperIndicator * indicator, float value ) 13428``` 13429**Description** 13430 13431Sets the width of the selected navigation point indicator of the dot style for the **Swiper** component. 13432 13433**Since**: 12 13434 13435**Parameters** 13436 13437| Name| Description| 13438| -------- | -------- | 13439| indicator | Pointer to a navigation point indicator. | 13440| value | Width of the navigation point indicator of the dot style. | 13441 13442 13443### OH_ArkUI_SwiperIndicator_SetStartPosition() 13444 13445``` 13446void OH_ArkUI_SwiperIndicator_SetStartPosition (ArkUI_SwiperIndicator * indicator, float value ) 13447``` 13448**Description** 13449 13450Sets the distance between the navigation point indicator and the left edge of the **Swiper** component. 13451 13452**Since**: 12 13453 13454**Parameters** 13455 13456| Name| Description| 13457| -------- | -------- | 13458| indicator | Pointer to a navigation point indicator. | 13459| value | Distance between the navigation point indicator and the left edge of the **Swiper** component. | 13460 13461 13462### OH_ArkUI_SwiperIndicator_SetTopPosition() 13463 13464``` 13465void OH_ArkUI_SwiperIndicator_SetTopPosition (ArkUI_SwiperIndicator * indicator, float value ) 13466``` 13467**Description** 13468 13469Sets the distance between the navigation point indicator and the top edge of the **Swiper** component. 13470 13471**Since**: 12 13472 13473**Parameters** 13474 13475| Name| Description| 13476| -------- | -------- | 13477| indicator | Pointer to a navigation point indicator. | 13478| value | Distance between a navigation point indicator and the top edge of the **Swiper** component. | 13479 13480 13481### OH_ArkUI_SystemFontStyleEvent_GetFontSizeScale() 13482 13483``` 13484float OH_ArkUI_SystemFontStyleEvent_GetFontSizeScale (const ArkUI_SystemFontStyleEvent * event) 13485``` 13486**Description** 13487 13488Obtains the font size scale from the system font style change event. 13489 13490**Since**: 12 13491 13492**Parameters** 13493 13494| Name| Description| 13495| -------- | -------- | 13496| event | Pointer to the current system font style change event. | 13497 13498**Returns** 13499 13500Returns the font size scale after the change. Default value: **1.0**. 13501 13502 13503### OH_ArkUI_SystemFontStyleEvent_GetFontWeightScale() 13504 13505``` 13506float OH_ArkUI_SystemFontStyleEvent_GetFontWeightScale (const ArkUI_SystemFontStyleEvent * event) 13507``` 13508**Description** 13509 13510Obtains the font weight scale from the system font style change event. 13511 13512**Since**: 12 13513 13514**Parameters** 13515 13516| Name| Description| 13517| -------- | -------- | 13518| event | Pointer to the current system font style change event. | 13519 13520**Returns** 13521 13522Returns the font weight scale after the change. Default value: **1.0**. 13523 13524 13525### OH_ArkUI_TransitionEffect_Combine() 13526 13527``` 13528int32_t OH_ArkUI_TransitionEffect_Combine (ArkUI_TransitionEffect * option, ArkUI_TransitionEffect * combine ) 13529``` 13530**Description** 13531 13532Sets a combination of transition effects. 13533 13534**Since**: 12 13535 13536**Parameters** 13537 13538| Name| Description| 13539| -------- | -------- | 13540| option | Transition effect options. | 13541| combine | Combination of transition effects. | 13542 13543**Returns** 13544 13545Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13546 13547 13548### OH_ArkUI_TransitionEffect_Dispose() 13549 13550``` 13551void OH_ArkUI_TransitionEffect_Dispose (ArkUI_TransitionEffect * option) 13552``` 13553**Description** 13554 13555Destroys a transition effect object. 13556 13557**Since**: 12 13558 13559**Parameters** 13560 13561| Name| Description| 13562| -------- | -------- | 13563| option | Transition effect object. | 13564 13565 13566### OH_ArkUI_TransitionEffect_SetAnimation() 13567 13568``` 13569int32_t OH_ArkUI_TransitionEffect_SetAnimation (ArkUI_TransitionEffect * option, ArkUI_AnimateOption * animation ) 13570``` 13571**Description** 13572 13573Sets transition effect animation settings. 13574 13575**Since**: 12 13576 13577**Parameters** 13578 13579| Name| Description| 13580| -------- | -------- | 13581| option | Transition effect options. | 13582| animation | Animation settings. | 13583 13584**NOTE** 13585 13586If **combine** is used for combining transition effects, the animation settings of a transition effect are applicable to the one following it. 13587 13588**Returns** 13589 13590Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13591 13592 13593### OH_ArkUI_UnmarshallStyledStringDescriptor() 13594 13595``` 13596int32_t OH_ArkUI_UnmarshallStyledStringDescriptor (uint8_t * buffer, size_t * bufferSize, ArkUI_StyledString_Descriptor * descriptor ) 13597``` 13598**Description** 13599 13600Deserializes a byte array containing styled string information into a styled string. 13601 13602**Since**: 14 13603 13604**Parameters** 13605 13606| Name| Description| 13607| -------- | -------- | 13608| buffer | Byte array to be deserialized. | 13609| bufferSize | Length of the byte array. | 13610| descriptor | Pointer to an **ArkUI_StyledString_Descriptor** object. | 13611 13612**Returns** 13613 13614Returns **ARKUI_ERROR_CODE_NO_ERROR** if the operation is successful. Returns **ARKUI_ERROR_CODE_PARAM_INVALID** if a parameter error occurs. 13615 13616 13617### OH_ArkUI_UnregisterSystemColorModeChangeEvent() 13618 13619``` 13620void OH_ArkUI_UnregisterSystemColorModeChangeEvent (ArkUI_NodeHandle node) 13621``` 13622**Description** 13623 13624Unregisters the event listener for system color mode changes. 13625 13626**Since**: 12 13627 13628**Parameters** 13629 13630| Name| Description| 13631| -------- | -------- | 13632| node | Specified node. | 13633 13634 13635### OH_ArkUI_UnregisterSystemFontStyleChangeEvent() 13636 13637``` 13638void OH_ArkUI_UnregisterSystemFontStyleChangeEvent (ArkUI_NodeHandle node) 13639``` 13640**Description** 13641 13642Unregisters the event listener for system font style changes. 13643 13644**Since**: 12 13645 13646**Parameters** 13647 13648| Name| Description| 13649| -------- | -------- | 13650| node | Specified node. | 13651 13652 13653### OH_ArkUI_WaterFlowSectionOption_Create() 13654 13655``` 13656ArkUI_WaterFlowSectionOption* OH_ArkUI_WaterFlowSectionOption_Create () 13657``` 13658**Description** 13659 13660Creates a water flow section configuration. 13661 13662**Since**: 12 13663 13664**Returns** 13665 13666Return the pointer to the created water flow section configuration. 13667 13668 13669### OH_ArkUI_WaterFlowSectionOption_Dispose() 13670 13671``` 13672void OH_ArkUI_WaterFlowSectionOption_Dispose (ArkUI_WaterFlowSectionOption * option) 13673``` 13674**Description** 13675 13676Disposes of the pointer to a water flow section configuration. 13677 13678**Since**: 12 13679 13680**Parameters** 13681 13682| Name| Description| 13683| -------- | -------- | 13684| option | Pointer to a water flow section configuration. | 13685 13686 13687### OH_ArkUI_WaterFlowSectionOption_GetColumnGap() 13688 13689``` 13690float OH_ArkUI_WaterFlowSectionOption_GetColumnGap (ArkUI_WaterFlowSectionOption * option, int32_t index ) 13691``` 13692**Description** 13693 13694Obtains the gap between columns in the water flow section that matches the specified index. 13695 13696**Since**: 12 13697 13698**Parameters** 13699 13700| Name| Description| 13701| -------- | -------- | 13702| option | Pointer to a water flow section configuration. | 13703| index | Index of the target water flow section. | 13704 13705**Returns** 13706 13707Column spacing. 13708 13709 13710### OH_ArkUI_WaterFlowSectionOption_GetCrossCount() 13711 13712``` 13713int32_t OH_ArkUI_WaterFlowSectionOption_GetCrossCount (ArkUI_WaterFlowSectionOption * option, int32_t index ) 13714``` 13715**Description** 13716 13717Obtains the number of columns (in a vertical layout) or rows (in a horizontal layout) of a water flow. 13718 13719**Since**: 12 13720 13721**Parameters** 13722 13723| Name| Description| 13724| -------- | -------- | 13725| option | Pointer to a water flow section configuration. | 13726| index | Index of the target water flow section. | 13727 13728**Returns** 13729 13730Returns the number of columns (in a vertical layout) or rows (in a horizontal layout) of a water flow. 13731 13732 13733### OH_ArkUI_WaterFlowSectionOption_GetItemCount() 13734 13735``` 13736int32_t OH_ArkUI_WaterFlowSectionOption_GetItemCount (ArkUI_WaterFlowSectionOption * option, int32_t index ) 13737``` 13738**Description** 13739 13740Obtains the number of items in the water flow section that matches the specified index. 13741 13742**Since**: 12 13743 13744**Parameters** 13745 13746| Name| Description| 13747| -------- | -------- | 13748| option | Pointer to a water flow section configuration. | 13749| index | Index of the target water flow section. | 13750 13751**Returns** 13752 13753Returns the number of items in the water flow section. 13754 13755 13756### OH_ArkUI_WaterFlowSectionOption_GetMargin() 13757 13758``` 13759ArkUI_Margin OH_ArkUI_WaterFlowSectionOption_GetMargin (ArkUI_WaterFlowSectionOption * option, int32_t index ) 13760``` 13761**Description** 13762 13763Obtains the margins of the water flow section that matches the specified index. 13764 13765**Since**: 12 13766 13767**Parameters** 13768 13769| Name| Description| 13770| -------- | -------- | 13771| option | Pointer to a water flow section configuration. | 13772| index | Index of the target water flow section. | 13773 13774**Returns** 13775 13776Returns the margins. 13777 13778 13779### OH_ArkUI_WaterFlowSectionOption_GetRowGap() 13780 13781``` 13782float OH_ArkUI_WaterFlowSectionOption_GetRowGap (ArkUI_WaterFlowSectionOption * option, int32_t index ) 13783``` 13784**Description** 13785 13786Obtains the gap between rows in the water flow section that matches the specified index. 13787 13788**Since**: 12 13789 13790**Parameters** 13791 13792| Name| Description| 13793| -------- | -------- | 13794| option | Pointer to a water flow section configuration. | 13795| index | Index of the target water flow section. | 13796 13797**Returns** 13798 13799Returns the gap between rows. 13800 13801 13802### OH_ArkUI_WaterFlowSectionOption_GetSize() 13803 13804``` 13805int32_t OH_ArkUI_WaterFlowSectionOption_GetSize (ArkUI_WaterFlowSectionOption * option) 13806``` 13807**Description** 13808 13809Sets the array length for a water flow section configuration. 13810 13811**Since**: 12 13812 13813**Parameters** 13814 13815| Name| Description| 13816| -------- | -------- | 13817| option | Pointer to a water flow section configuration. | 13818 13819**Returns** 13820 13821Returns 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. 13822 13823 13824### OH_ArkUI_WaterFlowSectionOption_RegisterGetItemMainSizeCallbackByIndex() 13825 13826``` 13827void OH_ArkUI_WaterFlowSectionOption_RegisterGetItemMainSizeCallbackByIndex (ArkUI_WaterFlowSectionOption * option, int32_t index, float(*)(int32_t itemIndex) callback ) 13828``` 13829**Description** 13830 13831Obtains the main axis size of a specified item based on **flowItemIndex** through a water flow section configuration. 13832 13833**Since**: 12 13834 13835**Parameters** 13836 13837| Name| Description| 13838| -------- | -------- | 13839| option | Pointer to a water flow section configuration. | 13840| index | Index of the target water flow section. | 13841| callback | Callback used to return the result. | 13842 13843 13844### OH_ArkUI_WaterFlowSectionOption_RegisterGetItemMainSizeCallbackByIndexWithUserData() 13845 13846``` 13847void OH_ArkUI_WaterFlowSectionOption_RegisterGetItemMainSizeCallbackByIndexWithUserData (ArkUI_WaterFlowSectionOption * option, int32_t index, void * userData, float(*)(int32_t itemIndex, void *userData) callback ) 13848``` 13849**Description** 13850 13851Obtains the main axis size of a specified item based on **flowItemIndex** through a water flow section configuration. 13852 13853**Since**: 12 13854 13855**Parameters** 13856 13857| Name| Description| 13858| -------- | -------- | 13859| option | Pointer to a water flow section configuration. | 13860| index | Index of the target water flow section. | 13861| userData | Custom data of the water flow item. | 13862| callback | Callback used to return the result. | 13863 13864 13865### OH_ArkUI_WaterFlowSectionOption_SetColumnGap() 13866 13867``` 13868void OH_ArkUI_WaterFlowSectionOption_SetColumnGap (ArkUI_WaterFlowSectionOption * , int32_t index, float columnGap ) 13869``` 13870**Description** 13871 13872Sets the gap between columns in the specified water flow section. 13873 13874**Since**: 12 13875 13876**Parameters** 13877 13878| Name| Description| 13879| -------- | -------- | 13880| option | Pointer to a water flow section configuration. | 13881| index | Index of the target water flow section. | 13882| columnGap | Gap between columns. | 13883 13884 13885### OH_ArkUI_WaterFlowSectionOption_SetCrossCount() 13886 13887``` 13888void OH_ArkUI_WaterFlowSectionOption_SetCrossCount (ArkUI_WaterFlowSectionOption * option, int32_t index, int32_t crossCount ) 13889``` 13890**Description** 13891 13892Sets the number of columns (in a vertical layout) or rows (in a horizontal layout) of a water flow. 13893 13894**Since**: 12 13895 13896**Parameters** 13897 13898| Name| Description| 13899| -------- | -------- | 13900| option | Pointer to a water flow section configuration. | 13901| index | Index of the target water flow section. | 13902| crossCount | Number of columns or rows, depending on the layout direction. | 13903 13904 13905### OH_ArkUI_WaterFlowSectionOption_SetItemCount() 13906 13907``` 13908void OH_ArkUI_WaterFlowSectionOption_SetItemCount (ArkUI_WaterFlowSectionOption * option, int32_t index, int32_t itemCount ) 13909``` 13910**Description** 13911 13912Sets the number of items in a water flow section. 13913 13914**Since**: 12 13915 13916**Parameters** 13917 13918| Name| Description| 13919| -------- | -------- | 13920| option | Pointer to a water flow section configuration. | 13921| index | Index of the target water flow section. | 13922| itemCount | Number of items in the water flow section. | 13923 13924 13925### OH_ArkUI_WaterFlowSectionOption_SetMargin() 13926 13927``` 13928void OH_ArkUI_WaterFlowSectionOption_SetMargin (ArkUI_WaterFlowSectionOption * option, int32_t index, float marginTop, float marginRight, float marginBottom, float marginLeft ) 13929``` 13930**Description** 13931 13932Sets the margins for the specified water flow section. 13933 13934**Since**: 12 13935 13936**Parameters** 13937 13938| Name| Description| 13939| -------- | -------- | 13940| option | Pointer to a water flow section configuration. | 13941| index | Index of the target water flow section. | 13942| marginTop | Top margin of the water flow section. | 13943| marginRight | Right margin of the water flow section. | 13944| marginBottom | Bottom margin of the water flow section. | 13945| marginLeft | Left margin of the water flow section. | 13946 13947 13948### OH_ArkUI_WaterFlowSectionOption_SetRowGap() 13949 13950``` 13951void OH_ArkUI_WaterFlowSectionOption_SetRowGap (ArkUI_WaterFlowSectionOption * option, int32_t index, float rowGap ) 13952``` 13953**Description** 13954 13955Sets the gap between rows in the specified water flow section. 13956 13957**Since**: 12 13958 13959**Parameters** 13960 13961| Name| Description| 13962| -------- | -------- | 13963| option | Pointer to a water flow section configuration. | 13964| index | Index of the target water flow section. | 13965| rowGap | Gap between rows to set. | 13966 13967 13968### OH_ArkUI_WaterFlowSectionOption_SetSize() 13969 13970``` 13971void OH_ArkUI_WaterFlowSectionOption_SetSize (ArkUI_WaterFlowSectionOption * option, int32_t size ) 13972``` 13973**Description** 13974 13975Sets the array length for a water flow section configuration. 13976 13977**Since**: 12 13978 13979**Parameters** 13980 13981| Name| Description| 13982| -------- | -------- | 13983| option | Pointer to a water flow section configuration. | 13984| size | Array length. | 13985
