目录

ArkUI_NodeAttributeType (Information Selection Component Attribute)

enum ArkUI_NodeAttributeType

Overview

Enumerates the attribute types that can be set by ArkUI on the native side for information selection components including DatePicker, TimePicker, TextPicker, and CalendarPicker.

Since: 12

Related module: ArkUI_NativeModule

Header file: native_node.h

NODE_DATE_PICKER_LUNAR

NODE_DATE_PICKER_LUNAR = MAX_NODE_SCOPE_NUM * ARKUI_NODE_DATE_PICKER = 13000

Whether to display the lunar calendar in the date picker. This attribute can be set, reset, and obtained as required through APIs.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 12

Parameters

Name Description
.value[0].i32 Whether to display the lunar calendar. The default value is 0. The value 1 indicates to display, and 0 indicates the opposite.

Returns

Type Description
.value[0].i32 Whether the lunar calendar is displayed. The value 1 indicates the lunar calendar is displayed, and 0 indicates the opposite.

NODE_DATE_PICKER_START

NODE_DATE_PICKER_START = 13001

Start date of the date picker. This attribute can be set, reset, and obtained as required through APIs. The start date limits the valid range of date selection, and a selected date out of range is automatically adjusted.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 12

Parameters

Name Description
.string Date. The default value is "1970-1-1". Format: YYYY-MM-DD, where YYYY supports 1 or 4 digits, and MM and DD are 1-2 digit numbers.

Returns

Type Description
.string Start date to set, in the format of YYYY-MM-DD.

NODE_DATE_PICKER_END

NODE_DATE_PICKER_END = 13002

End date of the date picker. This attribute can be set, reset, and obtained as required through APIs. The end date limits the valid range of date selection, and a selected date out of range is automatically adjusted.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 12

Parameters

Name Description
.string Date. The default value is "2100-12-31". Format: YYYY-MM-DD, where YYYY supports 1 or 4 digits, and MM and DD are 1-2 digit numbers.

Returns

Type Description
.string End date to set, in the format of YYYY-MM-DD.

NODE_DATE_PICKER_SELECTED

NODE_DATE_PICKER_SELECTED = 13003

Date of the selected item in the date picker. This attribute can be set, reset, and obtained as required through APIs.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 12

Parameters

Name Description
.string Date. The default value is "2024-01-22". When not set, the default value is used. Format: YYYY-MM-DD, where YYYY supports 1 or 4 digits, and MM and DD are 1-2 digit numbers.

Returns

Type Description
.string Selected date, in the format of YYYY-MM-DD.

NODE_DATE_PICKER_DISAPPEAR_TEXT_STYLE

NODE_DATE_PICKER_DISAPPEAR_TEXT_STYLE = 13004

Text 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.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 12

Parameters

Name Description
.string

Five parameters of the string type, separated by semicolons (;):

Parameter 1: text color, in #ARGB format.

Parameter 2: font size, in fp. The value is a number.

Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").

Parameter 4: fonts, separated by commas (,).

Parameter 5: font style. Available options are ("normal", "italic").

Example: "#ff182431;14;normal;Arial,HarmonyOS Sans;normal". When not set, the system default style is used.

Returns

Type Description
.string

Five parameters of the string type, separated by semicolons (;):

Parameter 1: text color, in #ARGB format.

Parameter 2: font size, in fp. The value is a number.

Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").

Parameter 4: fonts, separated by commas (,).

Parameter 5: font style. Available options are ("normal", "italic").

Example: "#ff182431;14;normal;Arial,HarmonyOS Sans;normal".

NODE_DATE_PICKER_TEXT_STYLE

NODE_DATE_PICKER_TEXT_STYLE = 13005

Text color, font size, and font weight for all items except edge items and selected items in the date picker. This attribute can be set, reset, and obtained as required through APIs.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 12

Parameters

Name Description
.string

Five parameters of the string type, separated by semicolons (;):

Parameter 1: text color, in #ARGB format.

Parameter 2: font size, in fp. The value is a number.

Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").

Parameter 4: fonts, separated by commas (,).

Parameter 5: font style. Available options are ("normal", "italic").

Example: "#ff182431;14;normal;Arial,HarmonyOS Sans;normal". When not set, the system default style is used.

Returns

Type Description
.string

Five parameters of the string type, separated by semicolons (;):

Parameter 1: text color, in #ARGB format.

Parameter 2: font size, in fp. The value is a number.

Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").

Parameter 4: fonts, separated by commas (,).

Parameter 5: font style. Available options are ("normal", "italic").

Example: "#ff182431;14;normal;Arial,HarmonyOS Sans;normal".

NODE_DATE_PICKER_SELECTED_TEXT_STYLE

NODE_DATE_PICKER_SELECTED_TEXT_STYLE = 13006

Text 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.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 12

Parameters

Name Description
.string

Five parameters of the string type, separated by semicolons (;):

Parameter 1: text color, in #ARGB format.

Parameter 2: font size, in fp. The value is a number.

Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").

Parameter 4: fonts, separated by commas (,).

Parameter 5: font style. Available options are ("normal", "italic").

Example: "#ff182431;14;normal;Arial,HarmonyOS Sans;normal". When not set, the system default style is used.

Returns

Type Description
.string

Five parameters of the string type, separated by semicolons (;):

Parameter 1: text color, in #ARGB format.

Parameter 2: font size, in fp. The value is a number.

Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").

Parameter 4: fonts, separated by commas (,).

Parameter 5: font style. Available options are ("normal", "italic").

Example: "#ff182431;14;normal;Arial,HarmonyOS Sans;normal".

NODE_DATE_PICKER_MODE

NODE_DATE_PICKER_MODE = 13007

Date column to be displayed. DatePicker displays different styles of date columns. This attribute can be set, reset, and obtained as required through APIs.

Use scenario: Select an appropriate date display mode based on application requirements. For example, use the year/month/day mode when precise selection down to the day is required, and use the year/month mode when only the month is required.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 18

Parameters

Name Description
.value[0].i32 Type of the date column to be displayed. The parameter type is ArkUI_DatePickerMode. Default value: the complete date columns (year, month, day).

Returns

Type Description
.value[0].i32 Type of the date column to be displayed. The parameter type is ArkUI_DatePickerMode.

NODE_DATE_PICKER_ENABLE_HAPTIC_FEEDBACK

NODE_DATE_PICKER_ENABLE_HAPTIC_FEEDBACK = 13008

Whether to enable haptic feedback. This attribute can be set, reset, and obtained as required through APIs.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 18

Parameters

Name Description
.value[0].i32 Whether to enable haptic feedback. The value 1 indicates to enable, and 0 indicates the opposite. After enabled, whether haptic feedback exists depends on the hardware support of the system.

Returns

Type Description
.value[0].i32 Whether haptic feedback is enabled. The value 1 indicates haptic feedback is enabled, and 0 indicates the opposite.

NODE_DATE_PICKER_CAN_LOOP

NODE_DATE_PICKER_CAN_LOOP = 13009

Whether to enable looping for the date picker. This attribute can be set, reset, and obtained as required through APIs.

Use scenario: Looping is suitable for scenarios with limited options where a quick selection experience is desired (such as month selection); non-looping is suitable for scenarios where options have clear boundaries and the user selection range needs to be restricted (such as date selection to avoid confusion across years).

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 20

Parameters

Name Description
.value[0].i32 Whether to enable looping. 1 to enable; 0 otherwise. The default value is 1. If an invalid value is provided, the default value is used.

Returns

Type Description
.value[0].i32

Whether looping is enabled. The value 1 means that the looping is enabled, and 0 means the opposite.

Note: When looping is enabled, the year increments or decrements in linkage with the month's cycle, and the month increments or decrements in linkage with the day's cycle.

When looping is disabled, scrolling beyond the bounds of the year, month, or day columns is prevented, and cross-column value synchronization (between year, month, and day) is also disabled.

NODE_TIME_PICKER_SELECTED

NODE_TIME_PICKER_SELECTED = MAX_NODE_SCOPE_NUM * ARKUI_NODE_TIME_PICKER = 14000

Time of the selected item in the timer picker. This attribute can be set, reset, and obtained as required through APIs.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 12

Parameters

Name Description
.string Time. The default value is current system time. Format: only hours and minutes are supported (for example, 23:59/23-59). Return format: hour,minute,second (for example, 23,59,0).

Returns

Type Description
.string Selected time. Format: hour,minute,second, separated by commas (for example, 23,59,0).

NODE_TIME_PICKER_USE_MILITARY_TIME

NODE_TIME_PICKER_USE_MILITARY_TIME = 14001

Whether the display time of the time picker is in 24-hour format. This attribute can be set, reset, and obtained as required through APIs.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 12

Parameters

Name Description
.value[0].i32 Whether the display time is in 24-hour format. The default value is 0. 1: The display time is in 24-hour format. 0: The display time is in 12-hour format.

Returns

Type Description
.value[0].i32 Whether the display time is in 24-hour format. The value 1 indicates that the time is displayed in the 24-hour format (corresponding to true), and 0 indicates that the time is displayed in the 12-hour format (corresponding to false).

NODE_TIME_PICKER_DISAPPEAR_TEXT_STYLE

NODE_TIME_PICKER_DISAPPEAR_TEXT_STYLE = 14002

Text style for edge items (the second item above or below the selected item). This attribute can be set, reset, and obtained as required through APIs.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 12

Parameters

Name Description
.string

Five parameters of the string type, separated by semicolons (;):

Parameter 1: text color, in #ARGB format.

Parameter 2: font size, in fp. The value is a number.

Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").

Parameter 4: fonts, separated by commas (,).

Parameter 5: font style. Available options are ("normal", "italic").

Example: "#ff182431;14;normal;Arial,HarmonyOS Sans;normal". When not set, the system default style is used.

Returns

Type Description
.string

Five parameters of the string type, separated by semicolons (;):

Parameter 1: text color, in #ARGB format.

Parameter 2: font size, in fp. The value is a number.

Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").

Parameter 4: fonts, separated by commas (,).

Parameter 5: font style. Available options are ("normal", "italic").

Example: "#ff182431;14;normal;Arial,HarmonyOS Sans;normal".

NODE_TIME_PICKER_TEXT_STYLE

NODE_TIME_PICKER_TEXT_STYLE = 14003

Text color, font size, and font weight for all items except edge items and selected items in the time picker. This attribute can be set, reset, and obtained as required through APIs.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 12

Parameters

Name Description
.string

Five parameters of the string type, separated by semicolons (;):

Parameter 1: text color, in #ARGB format.

Parameter 2: font size, in fp. The value is a number.

Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").

Parameter 4: fonts, separated by commas (,).

Parameter 5: font style. Available options are ("normal", "italic").

Example: "#ff182431;14;normal;Arial,HarmonyOS Sans;normal". When not set, the system default style is used.

Returns

Type Description
.string

Five parameters of the string type, separated by semicolons (;):

Parameter 1: text color, in #ARGB format.

Parameter 2: font size, in fp. The value is a number.

Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").

Parameter 4: fonts, separated by commas (,).

Parameter 5: font style. Available options are ("normal", "italic").

Example: "#ff182431;14;normal;Arial,HarmonyOS Sans;normal".

NODE_TIME_PICKER_SELECTED_TEXT_STYLE

NODE_TIME_PICKER_SELECTED_TEXT_STYLE = 14004

Text 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.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 12

Parameters

Name Description
.string

Five parameters of the string type, separated by semicolons (;):

Parameter 1: text color, in #ARGB format.

Parameter 2: font size, in fp. The value is a number.

Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").

Parameter 4: fonts, separated by commas (,).

Parameter 5: font style. Available options are ("normal", "italic").

Example: "#ff182431;14;normal;Arial,HarmonyOS Sans;normal". When not set, the system default style is used.

Returns

Type Description
.string

Five parameters of the string type, separated by semicolons (;):

Parameter 1: text color, in #ARGB format.

Parameter 2: font size, in fp. The value is a number.

Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").

Parameter 4: fonts, separated by commas (,).

Parameter 5: font style. Available options are ("normal", "italic").

Example: "#ff182431;14;normal;Arial,HarmonyOS Sans;normal".

NODE_TIME_PICKER_START

NODE_TIME_PICKER_START = 14005

Start time of the timer picker. This attribute can be set, reset, and obtained as required through APIs.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 18

Parameters

Name Description
.string Time. The default value is "0:0". When set, only hours and minutes are supported, separated by : or - (for example, 12:59 or 12-59).

Returns

Type Description
.string Start time to set. Format: hour:minute:second (for example, 0:0:0).

NODE_TIME_PICKER_END

NODE_TIME_PICKER_END = 14006

End time of the timer picker. This attribute can be set, reset, and obtained as required through APIs.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 18

Parameters

Name Description
.string Time. The default value is "23:59". When set, only hours and minutes are supported, separated by : or - (for example, 23:59 or 23-59).

Returns

Type Description
.string End time to set. Format: hour:minute:second (for example, 23:59:0).

NODE_TIME_PICKER_ENABLE_CASCADE

NODE_TIME_PICKER_ENABLE_CASCADE = 14007

Whether the AM/PM indicator automatically switches based on the hour in 12-hour format. This attribute can be set, reset, and obtained as required through APIs. In the 24-hour format, this attribute does not take effect.

Use scenario: It is suitable for scenarios that require a friendly 12-hour format selection experience. For example, when the user scrolls to select the hour, the AM/PM indicator changes automatically without manual switching.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 18

Parameters

Name Description
.value[0].i32 Whether the AM/PM indicator automatically switches based on the hour in 12-hour format. The default value is 0. The value 1 means that the AM/PM indicator automatically switches based on the hour in 12-hour format, and 0 means the opposite.

Returns

Type Description
.value[0].i32 Whether the AM/PM indicator automatically switches based on the hour in 12-hour format. The value 1 means that the AM/PM indicator automatically switches (corresponding to true), and the value 0 that the AM/PM indicator does not automatically switch (corresponding to false).

NODE_TEXT_PICKER_OPTION_RANGE

NODE_TEXT_PICKER_OPTION_RANGE = MAX_NODE_SCOPE_NUM * ARKUI_NODE_TEXT_PICKER = 15000

Data selection range of the text picker. This attribute can be set, reset, and obtained as required through APIs.

Use scenario: A single-column picker is suitable for selecting a single category (such as province or brand), a multi-column picker is suitable for combined selection of multiple independent categories (such as province-city), and a multi-column cascading picker is suitable for hierarchical selection scenarios (such as province-city-district, where the second column is automatically updated based on the first column). This attribute must be set before NODE_TEXT_PICKER_OPTION_SELECTED and NODE_TEXT_PICKER_SELECTED_INDEX can be used to set the selected items.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 12

Parameters

Name Description
.value[0].i32 Type of the text picker, specified using ArkUI_TextPickerRangeType. The default value is ARKUI_TEXTPICKER_RANGETYPE_SINGLE. ARKUI_TEXTPICKER_RANGETYPE_SINGLE applies to single-column selection, ARKUI_TEXTPICKER_RANGETYPE_MULTI applies to multi-column independent selection, ARKUI_TEXTPICKER_RANGETYPE_RANGE_CONTENT applies to single-column selection with images, and ARKUI_TEXTPICKER_RANGETYPE_CASCADE applies to multi-column cascade selection.
?.string

string input, whose format varies by picker type:

1: single-column picker. The input format is a group of strings separated by semicolons (;).

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 (,). If this parameter is not passed, the selection list is not set.
?.object

object input, whose format varies by picker type:

1: single-column picker with image support. The input struct is ARKUI_TextPickerRangeContentArray.

2: multi-column cascading picker. The input struct is ARKUI_TextCascadePickerRangeContentArray. If this parameter is not passed, the selection list is not set.

Returns

Type Description
.value[0].i32 Type of the text picker, specified using ArkUI_TextPickerRangeType.
?.string

string output, whose format varies by picker type.

1: single-column picker. The output format is a group of strings separated by semicolons (;).

2: multi-column picker. Multiple pairs of plain text strings are output. The pairs are separated by semicolons (;), and strings within each pair are separated by commas (,).

NODE_TEXT_PICKER_OPTION_SELECTED

NODE_TEXT_PICKER_OPTION_SELECTED = 15001

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. This attribute can be used only after the option list is set through NODE_TEXT_PICKER_OPTION_RANGE.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 12

Parameters

Name Description
.value[0].u32 Index of the default selected item in the picker option array. The value range is [0, length - 1]. An exception is thrown if the value is out of range. For a multi-column picker, if multiple index values exist, add them one by one. Default value: 0.

Returns

Type Description
.value[0].u32 Index of the selected item in the picker option array. If multiple index values exist, add them one by one.

NODE_TEXT_PICKER_OPTION_VALUE

NODE_TEXT_PICKER_OPTION_VALUE = 15002

Value of the default selected item in the text picker. This attribute can be set, reset, and obtained as required through APIs.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 12

Parameters

Name Description
.string Value of the selected item. If multiple values exist, add them one by one, separated by semicolons (;). Default value: empty string. When not set, use the default value.

Returns

Type Description
.string Value of the selected item. If there are multiple values, add them one by one and separate them with semicolons (;).

NODE_TEXT_PICKER_DISAPPEAR_TEXT_STYLE

NODE_TEXT_PICKER_DISAPPEAR_TEXT_STYLE = 15003

Text 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.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 12

Parameters

Name Description
.string

Five parameters of the string type, separated by semicolons (;):

Parameter 1: text color, in #ARGB format.

Parameter 2: font size, in fp. The value is a number.

Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").

Parameter 4: fonts, separated by commas (,).

Parameter 5: font style. Available options are ("normal", "italic").

Example: "#ff182431;14;normal;Arial,HarmonyOS Sans;normal". When not set, the system default style is used.

Returns

Type Description
.string

Five parameters of the string type, separated by semicolons (;):

Parameter 1: text color, in #ARGB format.

Parameter 2: font size, in fp. The value is a number.

Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").

Parameter 4: fonts, separated by commas (,).

Parameter 5: font style. Available options are ("normal", "italic").

Example: "#ff182431;14;normal;Arial,HarmonyOS Sans;normal".

NODE_TEXT_PICKER_TEXT_STYLE

NODE_TEXT_PICKER_TEXT_STYLE = 15004

Text 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.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 12

Parameters

Name Description
.string

Five parameters of the string type, separated by semicolons (;):

Parameter 1: text color, in #ARGB format.

Parameter 2: font size, in fp. The value is a number.

Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").

Parameter 4: fonts, separated by commas (,).

Parameter 5: font style. Available options are ("normal", "italic").

Example: "#ff182431;14;normal;Arial,HarmonyOS Sans;normal". When not set, the system default style is used.

Returns

Type Description
.string

Five parameters of the string type, separated by semicolons (;):

Parameter 1: text color, in #ARGB format.

Parameter 2: font size, in fp. The value is a number.

Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").

Parameter 4: fonts, separated by commas (,).

Parameter 5: font style. Available options are ("normal", "italic").

Example: "#ff182431;14;normal;Arial,HarmonyOS Sans;normal".

NODE_TEXT_PICKER_SELECTED_TEXT_STYLE

NODE_TEXT_PICKER_SELECTED_TEXT_STYLE = 15005

Text 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.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 12

Parameters

Name Description
.string

Five parameters of the string type, separated by semicolons (;):

Parameter 1: text color, in #ARGB format.

Parameter 2: font size, in fp. The value is a number.

Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").

Parameter 4: fonts, separated by commas (,).

Parameter 5: font style. Available options are ("normal", "italic").

Example: "#ff182431;14;normal;Arial,HarmonyOS Sans;normal". When not set, the system default style is used.

Returns

Type Description
.string

Five parameters of the string type, separated by semicolons (;):

Parameter 1: text color, in #ARGB format.

Parameter 2: font size, in fp. The value is a number.

Parameter 3: font weight. Available options are ("bold", "normal", "bolder", "lighter", "medium", "regular").

Parameter 4: fonts, separated by commas (,).

Parameter 5: font style. Available options are ("normal", "italic").

Example: "#ff182431;14;normal;Arial,HarmonyOS Sans;normal".

NODE_TEXT_PICKER_SELECTED_INDEX

NODE_TEXT_PICKER_SELECTED_INDEX = 15006

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. This attribute can be used only after the option list is set through NODE_TEXT_PICKER_OPTION_RANGE. After the option list is set, if the index array is not set through this attribute, the first item of each column is selected by default.

The format of the ArkUI_AttributeItem parameter for setting the attribute is as follows.

Since: 12

Parameters

Name Description
.value[0...].i32 Array of the indexes of the default selected items in the picker option array. When used for a multi-column picker, it indicates the index of the default selected item in each column. Default value: 0 for each column. Value range: the index of each column is in [0, Length of the corresponding column - 1]. An exception is thrown when the value is out of range.

Returns

Type Description
.value[0...].i32 Array of the indexes of the currently selected items. When used for a multi-column picker, it indicates the index of the selected item in each column.

NODE_TEXT_PICKER_CAN_LOOP

NODE_TEXT_PICKER_CAN_LOOP = 15007

Whether to enable looping for the picker. This attribute can be set, reset, and obtained as required through APIs.

Use scenario: Looping is suitable for scenarios with limited options where a quick selection experience is desired (such as province selection). Non-looping is suitable for scenarios where options have clear boundaries and the user selection range needs to be restricted (such as quantity selection to avoid misoperation).

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 12

Parameters

Name Description
.value[0].i32 Whether to enable looping. 1 to enable; 0 otherwise. Default value: 1.

Returns

Type Description
.value[0].i32 Whether looping is enabled. The value 1 means that the looping is enabled, and 0 means the opposite.

NODE_TEXT_PICKER_DEFAULT_PICKER_ITEM_HEIGHT

NODE_TEXT_PICKER_DEFAULT_PICKER_ITEM_HEIGHT = 15008

Height of each item in the text picker. This attribute can be set, reset, and obtained as required through APIs.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 12

Parameters

Name Description
.value[0].f32 Height of the currently set item, in vp. Default value: 40.0vp. When not set, the default value is used.

Returns

Type Description
.value[0].f32 Height of the currently set item, in vp.

NODE_TEXT_PICKER_COLUMN_WIDTHS

NODE_TEXT_PICKER_COLUMN_WIDTHS = 15009

Width of each column in the picker. This attribute can be set, reset, and obtained as required through APIs.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 18

Parameters

Name Description
.value[0].f32 Width of the first column, specified as a percentage of the total width. By default, all columns have equal widths. When not set, the columns are evenly divided.
.value[1]?.f32 Width of the second column, specified as a percentage of the total width. By default, all columns have equal widths.
.value[2]?.f32 Width of the third column, specified as a percentage of the total width. By default, all columns have equal widths.
... ...
.value[n]?.f32 Width of the (n+1)-th column, specified as a percentage of the total width. By default, all columns have equal widths.

Returns

Type Description
.value[0].f32 Width of the first column, specified as a percentage of the total width.
.value[1].f32 Width of the second column, specified as a percentage of the total width.
.value[2].f32 Width of the third column, specified as a percentage of the total width.
... ...
.value[n].f32 Width of the (n+1)-th column, specified as a percentage of the total width.

NODE_TEXT_PICKER_ENABLE_HAPTIC_FEEDBACK

NODE_TEXT_PICKER_ENABLE_HAPTIC_FEEDBACK = 15010

Whether to enable haptic feedback. This attribute can be set, reset, and obtained as required through APIs.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 18

Parameters

Name Description
.value[0].i32 Whether to enable haptic feedback. The value 1 indicates to enable, and 0 indicates the opposite. After enabled, whether haptic feedback exists depends on the hardware support of the system.

Returns

Type Description
.value[0].i32 Whether haptic feedback is enabled. The value 1 indicates haptic feedback is enabled, and 0 indicates the opposite.

NODE_TEXT_PICKER_SELECTED_BACKGROUND_STYLE

NODE_TEXT_PICKER_SELECTED_BACKGROUND_STYLE = 15011

Background color and border radius of the selected item. This attribute can be set, reset, and obtained as required through APIs.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 20

Parameters

Name Description
.value[0].u32 Background color, in 0xARGB format. A indicates the opacity (0x00 fully transparent to 0xFF fully opaque), and RGB indicates the color value (0x000000 to 0xFFFFFF). Each byte ranges from 0x00 to 0xFF. For example, 0xFF1122FF indicates a fully opaque blue.
.value[1].f32 Radius of the upper left corner, in vp.
.value[2].f32 Radius of the upper right corner, in vp.
.value[3].f32 Radius of the lower left corner, in vp.
.value[4].f32

Radius of the lower right corner, in vp.

Default background color: 0x0C182431; default corner radius: 24.0.

Returns

Type Description
.value[0].u32 Background color, in 0xARGB format, for example, 0xFF1122FF.
.value[1].f32 Radius of the upper left corner, in vp.
.value[2].f32 Radius of the upper right corner, in vp.
.value[3].f32 Radius of the lower left corner, in vp.
.value[4].f32 Radius of the lower right corner, in vp.

NODE_PICKER_OPTION_SELECTED_INDEX

NODE_PICKER_OPTION_SELECTED_INDEX = MAX_NODE_SCOPE_NUM * ARKUI_NODE_PICKER

Index of the default selected item in the picker's selection range. This attribute can be set, reset, and obtained as required through APIs.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 23

Parameters

Name Description
.value[0].u32 Index value. The default value is 0.

Returns

Type Description
.value[0].u32 Index of the currently selected item within the picker data selection range.

NODE_PICKER_ENABLE_HAPTIC_FEEDBACK

NODE_PICKER_ENABLE_HAPTIC_FEEDBACK = 1018001

Whether to enable haptic feedback. This attribute can be set, reset, and obtained as required through APIs.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 23

Parameters

Name Description
.value[0].i32 Whether to enable haptic feedback. 1 indicates to enable, and 0 indicates opposite. Default value: 1. When enabled, whether haptic feedback exists depends on the hardware support of the system.

Returns

Type Description
.value[0].i32 Whether haptic feedback is enabled. 1 indicates enabled, and 0 indicates the opposite. Whether haptic feedback exists depends on the hardware support of the system.

NODE_PICKER_CAN_LOOP

NODE_PICKER_CAN_LOOP = 1018002

Whether the picker supports looping. This attribute can be set, reset, and obtained as required through APIs.

Use scenario: Looping is suitable for scenarios with limited options where a quick selection experience is desired (such as gender selection). Non-looping is suitable for scenarios where options have clear boundaries and the user selection range needs to be restricted.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 23

Parameters

Name Description
.value[0].i32

Whether the picker supports looping. 1 to support; 0 otherwise. The default value is 1.

If the number of child components is less than 8, looping will not occur regardless of whether the value is 1 or 0.

Returns

Type Description
.value[0].i32 Whether the picker supports looping. 0 indicates that looping is not supported; 1 indicates that looping is supported.

NODE_PICKER_SELECTION_INDICATOR

NODE_PICKER_SELECTION_INDICATOR = 1018003

Picker indicator style. This attribute can be set, reset, and obtained as required through APIs.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 23

Parameters

Name Description
.object

Picker indicator style. The parameter type is ArkUI_PickerIndicatorStyle. Default value:

{

type: PickerIndicatorType.BACKGROUND,

borderRadius: {

value:12,

unit:LengthUnit.vp

},

backgroundColor: 'sys.color.comp_background_tertiary'

}

When not set, the default value is used.

Returns

Type Description
.object Picker indicator style. The parameter type is ArkUI_PickerIndicatorStyle.

NODE_PICKER_DISPLAYED_ITEM_COUNT

NODE_PICKER_DISPLAYED_ITEM_COUNT = 1018004

Number of displayed items in the Picker container. The semantics is the same as that of displayedItemCount in UIPickerComponent on the ArkTS side. If this attribute is not set, the value 7 is used. When Picker is in a three-dimensional wheel style, all items except the selected ones rotate at an angle, and the actual visible height is less than the item line height. To increase the number of visible lines or the line height, increase the container height accordingly. For details, see UIPickerComponent. This attribute can be set, reset, and obtained as required through APIs.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 26.0.0

Parameters

Name Description
.value[0].i32 Number of displayed items. The value is an integer within the range of [2, 9]. If a number with a decimal is passed, it is rounded down. If an even number is passed, it is rounded up to the nearest odd number (for example, 2 becomes 3 and 8 becomes 9). If a number is not within the range, the default value 7 is used.

Returns

Type Description
.value[0].i32 Number of displayed items in the Picker container, which is an integer in the range [2, 9].

NODE_PICKER_ITEM_HEIGHT

NODE_PICKER_ITEM_HEIGHT = 1018005

Height of each item in the Picker container. The semantics is the same as that of itemHeight in UIPickerComponent on the ArkTS side. If this attribute is not set, the height of each item is 40 vp. C APIs pass the height value in vp. This attribute can be set, reset, and obtained as required through APIs.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 26.0.0

Parameters

Name Description
.value[0].f32 Item height, in vp. The valid range is [40, 64]. If the value is less than 40 vp or greater than 64 vp, the default value 40 vp is used. The value cannot be in percentage.

Returns

Type Description
.value[0].f32 Item height, in vp.

NODE_CALENDAR_PICKER_HINT_RADIUS

NODE_CALENDAR_PICKER_HINT_RADIUS = MAX_NODE_SCOPE_NUM * ARKUI_NODE_CALENDAR_PICKER = 16000

Corner radius of the background of the selected state in the calendar picker. This attribute can be set, reset, and obtained as required through APIs.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 12

Parameters

Name Description
.value[0].f32 Corner radius of the background of the selected state in the calendar picker. The default value is 16.0, in vp, which indicates that the background is a circle. If the value is 0.0, the background is a right-angled rectangle. If the value is within the (0.0, 16.0) range, the background is a rounded rectangle. If the value is a negative number or greater than 16.0, the default value 16.0 is used, which means the background is a circle.

Returns

Type Description
.value[0].f32 Corner radius of the background of the selected state in the calendar picker. The default value is 16.0, in vp, which indicates that the background is a circle. The value range is [0.0, 16.0]. If the value is 0.0, the background is a right-angled rectangle.

NODE_CALENDAR_PICKER_SELECTED_DATE

NODE_CALENDAR_PICKER_SELECTED_DATE = 16001

Date of the selected item in the calendar picker. This attribute can be set, reset, and obtained as required through APIs.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 12

Parameters

Name Description
.value[0].u32 Selected year. Default value: the current system year. The default value is used when an invalid value is passed in.
.value[1].u32 Selected month. Default value: the current system month. The default value is used when an invalid value is passed in.
.value[2].u32 Selected day. Default value: the current system date. The default value is used when an invalid value is passed in.

Returns

Type Description
.value[0].u32 Selected year.
.value[1].u32 Selected month.
.value[2].u32 Selected day.

NODE_CALENDAR_PICKER_EDGE_ALIGNMENT

NODE_CALENDAR_PICKER_EDGE_ALIGNMENT = 16002

How the calendar picker is aligned with the entry component. This attribute can be set, reset, and obtained as required through APIs.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 12

Parameters

Name Description
.value[0].i32 Alignment mode. The parameter type is ArkUI_CalendarAlignment. It is used to set the alignment position of the calendar picker relative to the entry component.
.value[1]?.f32 Offset of the picker relative to the entry component along the x-axis after alignment based on the specified alignment mode, in vp. Default value: 0.
.value[2]?.f32 Offset of the picker relative to the entry component along the y-axis after alignment based on the specified alignment mode, in vp. Default value: 0.

Returns

Type Description
.value[0].i32 Alignment mode. The parameter type is ArkUI_CalendarAlignment.
.value[1].f32 Offset of the picker relative to the entry component along the x-axis after alignment based on the specified alignment mode, in vp.
.value[2].f32 Offset of the picker relative to the entry component along the y-axis after alignment based on the specified alignment mode, in vp.

NODE_CALENDAR_PICKER_TEXT_STYLE

NODE_CALENDAR_PICKER_TEXT_STYLE = 16003

Text color, font size, and font weight in the entry area of the calendar picker.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 12

Parameters

Name Description
.value[0]?.u32 Text color of the entry area. When not set or after resetAttribute is executed, the value resolved by the system theme calendar_picker_entry_font_color is used (the specific color value varies with the theme and can be obtained through getAttribute).
.value[1]?.f32 Font size of the entry area, in fp. When not set or after resetAttribute is executed, the value resolved by the system theme calendar_picker_entry_font_size is used (the specific value varies with the theme and can be obtained through getAttribute).
.value[2]?.i32 Font weight of the entry area. The parameter type is ArkUI_FontWeight. When not set or after resetAttribute is executed, the default value is ARKUI_FONT_WEIGHT_NORMAL.

Returns

Type Description
.value[0].u32 Text color of the entry area.
.value[1].f32 Font size of the entry area, in fp.
.value[2].i32 Font weight of the entry area. The parameter type is ArkUI_FontWeight.

NODE_CALENDAR_PICKER_START

NODE_CALENDAR_PICKER_START = 16004

Start date of the calendar picker. This attribute can be set, reset, and obtained as required through APIs.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 18

Parameters

Name Description
.string Date. The value format is "YYYY-MM-DD", where YYYY supports 1 or 4 digits, and MM and DD are 1-2 digit numbers, for example, "1970-1-1" or "2024-05-20". Default value: 1970-1-1.

Returns

Type Description
.string Start date of the calendar picker to set, in the format of "YYYY-MM-DD".

NODE_CALENDAR_PICKER_END

NODE_CALENDAR_PICKER_END = 16005

End date of the calendar picker. This attribute can be set, reset, and obtained as required through APIs.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 18

Parameters

Name Description
.string Date. The value format is "YYYY-MM-DD", where YYYY supports 1 or 4 digits, and MM and DD are 1-2 digit numbers, for example, "2100-12-31" or "2025-1-25". Default value: "2100-12-31".

Returns

Type Description
.string End date of the calendar picker to set, in the format of "YYYY-MM-DD".

NODE_CALENDAR_PICKER_DISABLED_DATE_RANGE

NODE_CALENDAR_PICKER_DISABLED_DATE_RANGE = 16006

Disabled date ranges of the calendar picker. This attribute can be set, reset, and obtained as required through APIs.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 19

Parameters

Name Description
.string

String representing the disabled date ranges. The format is "start_date,end_date" for each range, with multiple ranges separated by commas (,).

Format of the disabled date range: "1910-01-01,1910-12-31,2020-01-01,2020-12-31". Default value: empty string, indicating that no disabled date range is set.

Returns

Type Description
.string String representing the disabled date ranges. The format is "start_date,end_date" for each range, with multiple ranges separated by commas (,), for example, "1910-01-01,1910-12-31".

NODE_CALENDAR_PICKER_MARK_TODAY

NODE_CALENDAR_PICKER_MARK_TODAY = 16007

Whether to highlight the current system date in the calendar picker. This attribute can be set, reset, and obtained as required through APIs.

The format of the ArkUI_AttributeItem parameter for setting the attribute and the format of the return value ArkUI_AttributeItem are as follows.

Since: 19

Parameters

Name Description
.value[0].i32 Whether to highlight the current system date in the calendar picker. 1 to highlight; 0 otherwise.

Returns

Type Description
.value[0].i32 Whether the current system date is highlighted in the calendar picker.