ts-appendix-enums.md 27.6 KB
Newer Older
E
ester.zhou 已提交
1
# Enums
Z
zengyawen 已提交
2

E
ester.zhou 已提交
3 4 5 6
>**NOTE**
>
>The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.

E
esterzhou 已提交
7
## Color
Z
zengyawen 已提交
8

E
ester.zhou 已提交
9 10
Since API version 9, this API is supported in ArkTS widgets.

E
ester.zhou 已提交
11 12 13 14 15 16 17 18 19 20 21 22 23 24
| Color                    | Value          | Illustration                                    |
| ------------------------ | ------------- | ---------------------------------------- |
| Black                    | 0x000000      | ![en-us_image_0000001219864153](figures/en-us_image_0000001219864153.png) |
| Blue                     | 0x0000ff      | ![en-us_image_0000001174104404](figures/en-us_image_0000001174104404.png) |
| Brown                    | 0xa52a2a      | ![en-us_image_0000001219744201](figures/en-us_image_0000001219744201.png) |
| Gray                     | 0x808080      | ![en-us_image_0000001174264376](figures/en-us_image_0000001174264376.png) |
| Grey                     | 0x808080      | ![en-us_image_0000001174264376](figures/en-us_image_0000001174264376.png) |
| Green                    | 0x008000      | ![en-us_image_0000001174422914](figures/en-us_image_0000001174422914.png) |
| Orange                   | 0xffa500      | ![en-us_image_0000001219662661](figures/en-us_image_0000001219662661.png) |
| Pink                     | 0xffc0cb      | ![en-us_image_0000001219662663](figures/en-us_image_0000001219662663.png) |
| Red                      | 0xff0000      | ![en-us_image_0000001219662665](figures/en-us_image_0000001219662665.png) |
| White                    | 0xffffff      | ![en-us_image_0000001174582866](figures/en-us_image_0000001174582866.png) |
| Yellow                   | 0xffff00      | ![en-us_image_0000001174582864](figures/en-us_image_0000001174582864.png) |
| Transparent<sup>9+</sup> | rgba(0,0,0,0) | Transparent                                     |
Z
zengyawen 已提交
25

E
esterzhou 已提交
26
## ImageFit
Z
zengyawen 已提交
27

E
ester.zhou 已提交
28 29
Since API version 9, this API is supported in ArkTS widgets.

E
ester.zhou 已提交
30 31
| Name       | Description                             |
| --------- | ------------------------------- |
E
ester.zhou 已提交
32 33
| Contain   | The image is scaled with its aspect ratio retained for the content to be completely displayed within the display boundaries.  |
| Cover     | The image is scaled with its aspect ratio retained for both sides to be greater than or equal to the display boundaries.|
E
ester.zhou 已提交
34 35 36 37
| Auto      | The image is scaled automatically to fit the display area.                          |
| Fill      | The image is scaled to fill the display area, and its aspect ratio is not retained.       |
| ScaleDown | The image is displayed with its aspect ratio retained, in a size smaller than or equal to the original size.            |
| None      | The original size is retained.                      |
Z
zengyawen 已提交
38

E
esterzhou 已提交
39
## BorderStyle
Z
zengyawen 已提交
40

E
ester.zhou 已提交
41 42
Since API version 9, this API is supported in ArkTS widgets.

E
ester.zhou 已提交
43 44
| Name    | Description                           |
| ------ | ----------------------------- |
E
ester.zhou 已提交
45
| Dotted | Dotted border. The radius of a dot is half of **borderWidth**.|
E
ester.zhou 已提交
46 47
| Dashed | Dashed border.                |
| Solid  | Solid border.                     |
Z
zengyawen 已提交
48

E
esterzhou 已提交
49
## LineJoinStyle
Z
zengyawen 已提交
50

E
ester.zhou 已提交
51 52
Since API version 9, this API is supported in ArkTS widgets.

E
ester.zhou 已提交
53 54
| Name   | Description        |
| ----- | ---------- |
E
ester.zhou 已提交
55 56 57
| Bevel | Bevel is used to connect paths.|
| Miter | Miter is used to connect paths.|
| Round | Round is used to connect paths.|
Z
zengyawen 已提交
58

E
esterzhou 已提交
59
## TouchType
Z
zengyawen 已提交
60

E
ester.zhou 已提交
61 62 63 64
| Name    | Description             |
| ------ | --------------- |
| Down   | A finger is pressed.       |
| Up     | A finger is lifted.       |
E
ester.zhou 已提交
65
| Move   | A finger moves on the screen in pressed state.|
E
ester.zhou 已提交
66
| Cancel | A touch event is canceled.     |
Z
zengyawen 已提交
67

E
esterzhou 已提交
68
## MouseButton
Z
zengyawen 已提交
69

E
ester.zhou 已提交
70 71 72 73 74
| Name     | Description      |
| ------- | -------- |
| Left    | Left button on the mouse.   |
| Right   | Right button on the mouse.   |
| Middle  | Middle button on the mouse.   |
E
ester.zhou 已提交
75 76
| Back    | Back button on the left of the mouse.|
| Forward | Forward button on the left of the mouse.|
E
ester.zhou 已提交
77
| None    | No button.    |
Z
zengyawen 已提交
78

E
esterzhou 已提交
79
## MouseAction
Z
zengyawen 已提交
80

E
ester.zhou 已提交
81 82
| Name     | Description     |
| ------- | ------- |
E
ester.zhou 已提交
83 84
| Press   | The mouse button is pressed.|
| Release | The mouse button is released.|
E
ester.zhou 已提交
85 86
| Move    | The mouse cursor moves.  |
| Hover   | The mouse pointer is hovered on an element.  |
Z
zengyawen 已提交
87

E
esterzhou 已提交
88
## Curve
Z
zengyawen 已提交
89

E
ester.zhou 已提交
90 91
Since API version 9, this API is supported in ArkTS widgets.

E
ester.zhou 已提交
92 93 94
| Name                 | Description                                      |
| ------------------- | ---------------------------------------- |
| Linear              | The animation speed keeps unchanged.                       |
E
ester.zhou 已提交
95
| Ease                | The animation starts slowly, accelerates, and then slows down towards the end. The cubic-bezier curve (0.25, 0.1, 0.25, 1.0) is used.|
E
ester.zhou 已提交
96 97
| EaseIn              | The animation starts at a low speed and then picks up speed until the end. The cubic-bezier curve (0.42, 0.0, 1.0, 1.0) is used.|
| EaseOut             | The animation ends at a low speed. The cubic-bezier curve (0.0, 0.0, 0.58, 1.0) is used.|
E
ester.zhou 已提交
98
| EaseInOut           | The animation starts and ends at a low speed. The cubic-bezier curve (0.42, 0.0, 0.58, 1.0) is used.|
E
ester.zhou 已提交
99 100 101 102 103 104 105 106
| FastOutSlowIn       | The animation uses the standard cubic-bezier curve (0.4, 0.0, 0.2, 1.0).  |
| LinearOutSlowIn     | The animation uses the deceleration cubic-bezier curve (0.0, 0.0, 0.2, 1.0).  |
| FastOutLinearIn     | The animation uses the acceleration cubic-bezier curve (0.4, 0.0, 1.0, 1.0).  |
| ExtremeDeceleration | The animation uses the extreme deceleration cubic-bezier curve (0.0, 0.0, 0.0, 1.0).  |
| Sharp               | The animation uses the sharp cubic-bezier curve (0.33, 0.0, 0.67, 1.0).|
| Rhythm              | The animation uses the rhythm cubic-bezier curve (0.7, 0.0, 0.2, 1.0).  |
| Smooth              | The animation uses the smooth cubic-bezier curve (0.4, 0.0, 0.4, 1.0).  |
| Friction            | The animation uses the friction cubic-bezier curve (0.2, 0.0, 0.2, 1.0).   |
Z
zengyawen 已提交
107

E
esterzhou 已提交
108
## AnimationStatus
Z
zengyawen 已提交
109

E
ester.zhou 已提交
110
Since API version 10, this API is supported in ArkTS widgets.
E
ester.zhou 已提交
111

E
ester.zhou 已提交
112 113 114
| Name     | Description       |
| ------- | --------- |
| Initial | The animation is in the initial state.  |
E
ester.zhou 已提交
115 116 117
| Running | The animation is being played.|
| Paused  | The animation is paused.|
| Stopped | The animation is stopped.|
Z
zengyawen 已提交
118

E
esterzhou 已提交
119
## FillMode
Z
zengyawen 已提交
120

E
ester.zhou 已提交
121
Since API version 10, this API is supported in ArkTS widgets.
E
ester.zhou 已提交
122

E
ester.zhou 已提交
123 124 125 126
| Name       | Description                                      |
| --------- | ---------------------------------------- |
| 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.    |
| Forwards  | The target component retains the state set by the last keyframe encountered during execution of the animation.                  |
E
ester.zhou 已提交
127 128
| 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**. The first relevant keyframe depends on the value of **playMode**. If **playMode** is **Normal** or **Alternate**, the first relevant keyframe is in the **from** state. If **playMode** is **Reverse** or **AlternateReverse**, the first relevant keyframe is in the **to** state.|
| Both      | The animation follows the rules for both **Forwards** and **Backwards**, extending the animation attributes in both directions.|
Z
zengyawen 已提交
129

E
esterzhou 已提交
130
## PlayMode
Z
zengyawen 已提交
131

E
ester.zhou 已提交
132 133
Since API version 9, this API is supported in ArkTS widgets.

E
ester.zhou 已提交
134 135 136 137
| Name              | Description                                      |
| ---------------- | ---------------------------------------- |
| Normal           | The animation is played forwards.                                |
| Reverse          | The animation is played backwards.                                 |
E
ester.zhou 已提交
138 139
| 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...).|
| AlternateReverse | 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...).|
Z
zengyawen 已提交
140

E
esterzhou 已提交
141
## KeyType
Z
zengyawen 已提交
142

E
ester.zhou 已提交
143 144
| Name  | Description   |
| ---- | ----- |
E
ester.zhou 已提交
145 146
| Down | The key is pressed.|
| Up   | The key is released.|
Z
zengyawen 已提交
147

E
esterzhou 已提交
148
## KeySource
Z
zengyawen 已提交
149

E
ester.zhou 已提交
150 151 152
| Name      | Description        |
| -------- | ---------- |
| Unknown  | Unknown input device. |
E
ester.zhou 已提交
153
| Keyboard | The input device is a keyboard.|
Z
zengyawen 已提交
154

E
esterzhou 已提交
155
## Edge
Z
zengyawen 已提交
156

E
ester.zhou 已提交
157 158 159 160 161 162 163 164 165
| Name                              | Description                                      |
| -------------------------------- | ---------------------------------------- |
| Top                              | Top edge in the vertical direction.<br>Since API version 9, this API is supported in ArkTS widgets.|
| Center<sup>(deprecated) </sup>   | Center position in the vertical direction.<br> This API is deprecated since API version 9.        |
| Bottom                           | Bottom edge in the vertical direction.<br>Since API version 9, this API is supported in ArkTS widgets.|
| Baseline<sup>(deprecated) </sup> | Text baseline position in the cross axis direction.<br> This API is deprecated since API version 9.     |
| Start                            | Start position in the horizontal direction.<br>Since API version 9, this API is supported in ArkTS widgets.|
| Middle<sup>(deprecated) </sup>   | Center position in the horizontal direction.<br> This API is deprecated since API version 9.        |
| End                              | End position in the horizontal direction.<br>Since API version 9, this API is supported in ArkTS widgets.|
Z
zengyawen 已提交
166

E
esterzhou 已提交
167 168
## Week

E
ester.zhou 已提交
169 170 171 172 173 174 175 176 177
| Name  | Description  |
| ---- | ---- |
| Mon  | Monday. |
| Tue  | Tuesday. |
| Wed  | Wednesday. |
| Thur | Thursday. |
| Fri  | Friday. |
| Sat  | Saturday. |
| Sun  | Sunday. |
E
esterzhou 已提交
178 179 180

## Direction

E
ester.zhou 已提交
181 182
Since API version 9, this API is supported in ArkTS widgets.

E
ester.zhou 已提交
183 184 185 186
| Name  | Description         |
| ---- | ----------- |
| Ltr  | Components are arranged from left to right.  |
| Rtl  | Components are arranged from right to left.  |
E
ester.zhou 已提交
187
| Auto | The default layout direction is used.|
E
esterzhou 已提交
188 189 190

## BarState

E
ester.zhou 已提交
191 192
Since API version 9, this API is supported in ArkTS widgets.

E
ester.zhou 已提交
193 194 195 196
| Name  | Description                |
| ---- | ------------------ |
| Off  | Not displayed.              |
| On   | Always displayed.             |
E
ester.zhou 已提交
197
| Auto | Displayed when the screen is touched and hidden after 2s.|
E
esterzhou 已提交
198 199 200

## EdgeEffect

E
ester.zhou 已提交
201 202
Since API version 9, this API is supported in ArkTS widgets.

E
ester.zhou 已提交
203 204
| Name    | Description                                      |
| ------ | ---------------------------------------- |
E
ester.zhou 已提交
205 206
| 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.|
| Fade   | Fade effect. When at one of the edges, the component produces a fade effect.                    |
E
ester.zhou 已提交
207
| None   | No effect when the component is at one of the edges.                              |
E
esterzhou 已提交
208 209 210

## Alignment

E
ester.zhou 已提交
211 212
Since API version 9, this API is supported in ArkTS widgets.

E
ester.zhou 已提交
213 214 215 216 217
| Name         | Description      |
| ----------- | -------- |
| TopStart    | Top start.  |
| Top         | Horizontally centered on the top. |
| TopEnd      | Top end.   |
E
ester.zhou 已提交
218 219
| Start       | Vertically centered start.|
| Center      | Horizontally and vertically centered.|
E
ester.zhou 已提交
220 221 222 223
| End         | Vertically centered end. |
| BottomStart | Bottom start.  |
| Bottom      | Horizontally centered on the bottom. |
| BottomEnd   | Bottom end.   |
E
esterzhou 已提交
224 225 226

## TransitionType

E
ester.zhou 已提交
227 228
Since API version 9, this API is supported in ArkTS widgets.

E
ester.zhou 已提交
229 230
| Name    | Description                            |
| ------ | ------------------------------ |
E
ester.zhou 已提交
231
| All    | The transition takes effect in all scenarios.|
E
ester.zhou 已提交
232 233
| Insert | The transition takes effect when a component is inserted or displayed.|
| Delete | The transition takes effect when a component is deleted or hidden.|
E
esterzhou 已提交
234 235 236

## RelateType

E
ester.zhou 已提交
237 238 239 240
| Name  | Description            |
| ---- | -------------- |
| FILL | The current child component is scaled to fill the parent component.|
| FIT  | The current child component is scaled to adapt to the parent component.|
E
esterzhou 已提交
241 242 243

## Visibility

E
ester.zhou 已提交
244 245
Since API version 9, this API is supported in ArkTS widgets.

E
ester.zhou 已提交
246 247 248 249
| Name     | Description              |
| ------- | ---------------- |
| Hidden  | The component is hidden, and a placeholder is used for it in the layout.   |
| Visible | The component is visible.             |
E
ester.zhou 已提交
250
| None    | The component is hidden. It is not involved in the layout, and no placeholder is used for it.|
E
esterzhou 已提交
251 252 253

## LineCapStyle

E
ester.zhou 已提交
254 255
Since API version 9, this API is supported in ArkTS widgets.

E
ester.zhou 已提交
256 257 258 259
| Name    | Description                           |
| ------ | ----------------------------- |
| Butt   | The ends of the line are squared off, and the line does not extend beyond its two endpoints.              |
| Round  | The line is extended at the endpoints by a half circle whose diameter is equal to the line width.           |
E
ester.zhou 已提交
260
| Square | The line is extended at the endpoints by a rectangle whose width is equal to half the line width and height equal to the line width.|
E
esterzhou 已提交
261 262 263

## Axis

E
ester.zhou 已提交
264 265
Since API version 9, this API is supported in ArkTS widgets.

E
ester.zhou 已提交
266 267
| Name        | Description    |
| ---------- | ------ |
E
ester.zhou 已提交
268 269
| Vertical   | Vertical direction.|
| Horizontal | Horizontal direction.|
E
esterzhou 已提交
270 271 272

## HorizontalAlign

E
ester.zhou 已提交
273 274
Since API version 9, this API is supported in ArkTS widgets.

E
ester.zhou 已提交
275 276
| Name    | Description          |
| ------ | ------------ |
E
ester.zhou 已提交
277 278
| Start  | Aligned with the start edge in the same direction as the language in use.|
| Center | Aligned with the center. This is the default alignment mode.|
E
ester.zhou 已提交
279
| End    | Aligned with the end edge in the same direction as the language in use. |
E
esterzhou 已提交
280 281 282

## FlexAlign

E
ester.zhou 已提交
283 284
Since API version 9, this API is supported in ArkTS widgets.

E
ester.zhou 已提交
285 286 287 288 289
| Name          | Description                                      |
| ------------ | ---------------------------------------- |
| Start        | The child components are aligned with the start edge of the main axis. The first component is aligned with the main-start, and subsequent components are aligned with the previous one.   |
| Center       | The child components are aligned in the center of the main axis. The space between the first component and the main-start is the same as that between the last component and the main-end.  |
| End          | The child components are aligned with the end edge of the main axis. The last component is aligned with the main-end, and other components are aligned with the next one.     |
E
ester.zhou 已提交
290 291 292
| SpaceBetween | 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, the last component is aligned with the main-end, and the remaining components are distributed so that the space between any two adjacent components is the same.|
| SpaceAround  | 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.|
| SpaceEvenly  | 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.|
E
esterzhou 已提交
293 294 295

## ItemAlign

E
ester.zhou 已提交
296 297
Since API version 9, this API is supported in ArkTS widgets.

E
ester.zhou 已提交
298 299 300 301 302 303
| Name      | Description                                      |
| -------- | ---------------------------------------- |
| Auto     | The default configuration of the flex container is used.                          |
| Start    | The items in the flex container are aligned with the cross-start edge.                   |
| Center   | The items in the flex container are centered along the cross axis.                   |
| End      | The items in the flex container are aligned with the cross-end edge.                   |
E
ester.zhou 已提交
304
| Stretch  | The items in the flex container are stretched and padded along the cross axis. If the flex container has the **Wrap** attribute set to **FlexWrap.Wrap** or **FlexWrap.WrapReverse**, the items are stretched to the cross size of the widest element on the current row or column. In other cases, the items with no size set are stretched to the container size.|
E
ester.zhou 已提交
305
| Baseline | The items in the flex container are aligned in such a manner that their text baselines are aligned along the cross axis.                 |
E
esterzhou 已提交
306 307 308

## FlexDirection

E
ester.zhou 已提交
309 310
Since API version 9, this API is supported in ArkTS widgets.

E
ester.zhou 已提交
311 312 313 314 315 316
| Name           | Description              |
| ------------- | ---------------- |
| Row           | The child components are arranged in the same direction as the main axis runs along the rows. |
| RowReverse    | The child components are arranged opposite to the **Row** direction. |
| Column        | The child components are arranged in the same direction as the main axis runs down the columns. |
| ColumnReverse | The child components are arranged opposite to the **Column** direction.|
E
esterzhou 已提交
317 318 319

## FlexWrap

E
ester.zhou 已提交
320 321
Since API version 9, this API is supported in ArkTS widgets.

E
ester.zhou 已提交
322 323 324 325
| Name         | Description                         |
| ----------- | --------------------------- |
| NoWrap      | The child components in the flex container are arranged in a single line, and they cannot overflow. |
| Wrap        | The child components in the flex container are arranged in multiple lines, and they may overflow.  |
E
ester.zhou 已提交
326
| WrapReverse | The child components in the flex container are reversely arranged in multiple lines, and they may overflow.|
E
esterzhou 已提交
327 328 329

## VerticalAlign

E
ester.zhou 已提交
330 331
Since API version 9, this API is supported in ArkTS widgets.

E
ester.zhou 已提交
332 333 334
| Name    | Description          |
| ------ | ------------ |
| Top    | Top aligned.       |
E
ester.zhou 已提交
335
| Center | Center aligned. This is the default alignment mode.|
E
ester.zhou 已提交
336
| Bottom | Bottom aligned.       |
E
esterzhou 已提交
337 338 339

## ImageRepeat

E
ester.zhou 已提交
340 341
Since API version 9, this API is supported in ArkTS widgets.

E
ester.zhou 已提交
342 343
| Name      | Description           |
| -------- | ------------- |
E
ester.zhou 已提交
344 345
| X        | The image is repeatedly drawn only along the horizontal axis.|
| Y        | The image is repeatedly drawn only along the vertical axis.|
E
ester.zhou 已提交
346 347
| XY       | The image is repeatedly drawn along both axes. |
| NoRepeat | The image is not repeatedly drawn.     |
E
esterzhou 已提交
348 349 350

## ImageSize

E
ester.zhou 已提交
351 352
Since API version 9, this API is supported in ArkTS widgets.

E
ester.zhou 已提交
353 354
| Type     | Description                                 |
| ------- | ----------------------------------- |
E
ester.zhou 已提交
355
| 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.|
E
ester.zhou 已提交
356 357
| Contain | The image is scaled with its aspect ratio retained for the content to be completely displayed within the display boundaries.      |
| Auto    | The original image aspect ratio is retained.                         |
E
esterzhou 已提交
358 359 360

## GradientDirection

E
ester.zhou 已提交
361 362
Since API version 9, this API is supported in ArkTS widgets.

E
ester.zhou 已提交
363 364
| Name         | Description   |
| ----------- | ----- |
E
ester.zhou 已提交
365 366 367 368
| Left        | The gradient direction is from right to left.|
| Top         | The gradient direction is from bottom to top.|
| Right       | The gradient direction is from left to right.|
| Bottom      | The gradient direction is from top to bottom.|
E
ester.zhou 已提交
369 370 371 372 373
| LeftTop     | The gradient direction is upper left.  |
| LeftBottom  | The gradient direction is lower left.  |
| RightTop    | The gradient direction is upper right.  |
| RightBottom | The gradient direction is lower right.  |
| None        | No gradient.   |
E
esterzhou 已提交
374 375 376

## SharedTransitionEffectType

E
ester.zhou 已提交
377 378 379 380
| Name      | Description                                      |
| -------- | ---------------------------------------- |
| Static   | The element position remains unchanged on the target page, and transition opacity can be configured. Currently, this effect is only valid in redirecting to the target page.|
| Exchange | The element is relocated and scaled properly on the target page.                 |
E
esterzhou 已提交
381 382 383

## FontStyle

E
ester.zhou 已提交
384 385
Since API version 9, this API is supported in ArkTS widgets.

E
ester.zhou 已提交
386 387
| Name    | Description      |
| ------ | -------- |
E
ester.zhou 已提交
388 389
| Normal | Standard font style.|
| Italic | Italic font style.|
E
esterzhou 已提交
390 391 392

## FontWeight

E
ester.zhou 已提交
393 394
Since API version 9, this API is supported in ArkTS widgets.

E
ester.zhou 已提交
395 396 397
| Name     | Description     |
| ------- | ------- |
| Lighter | The font weight is lighter.  |
E
ester.zhou 已提交
398 399 400
| Normal  | The font weight is normal.|
| Regular | The font weight is regular.|
| Medium  | The font weight is medium.|
E
ester.zhou 已提交
401 402
| Bold    | The font weight is bold.  |
| Bolder  | The font weight is bolder. |
E
esterzhou 已提交
403 404 405

## TextAlign

E
ester.zhou 已提交
406 407
Since API version 9, this API is supported in ArkTS widgets.

E
ester.zhou 已提交
408 409
| Name                   | Description     |
| --------------------- | ------- |
E
ester.zhou 已提交
410 411 412
| Start                 | Aligned with the start.|
| Center                | Horizontally centered.|
| End                   | Aligned with the end.|
E
ester.zhou 已提交
413
| JUSTIFY<sup>10+</sup> | Aligned with both margins.  |
E
esterzhou 已提交
414 415 416

## TextOverflow

E
ester.zhou 已提交
417 418
Since API version 9, this API is supported in ArkTS widgets.

E
ester.zhou 已提交
419 420 421 422
| Name                   | Description                 |
| --------------------- | ------------------- |
| None                  | Extra-long text is clipped.         |
| Clip                  | Extra-long text is clipped.       |
E
ester.zhou 已提交
423
| Ellipsis              | An ellipsis (...) is used to represent text overflow.|
E
ester.zhou 已提交
424
| MARQUEE<sup>10+</sup> | Text continuously scrolls when text overflow occurs.    |
E
esterzhou 已提交
425 426 427

## TextDecorationType

E
ester.zhou 已提交
428 429
Since API version 9, this API is supported in ArkTS widgets.

E
ester.zhou 已提交
430 431 432
| Name         | Description       |
| ----------- | --------- |
| Underline   | Line under the text. |
E
ester.zhou 已提交
433
| LineThrough | Line through the text.|
E
ester.zhou 已提交
434
| Overline    | Line over the text. |
E
ester.zhou 已提交
435
| None        | No decorative lines.|
E
esterzhou 已提交
436 437 438

## TextCase

E
ester.zhou 已提交
439 440
Since API version 9, this API is supported in ArkTS widgets.

E
ester.zhou 已提交
441 442
| Name       | Description        |
| --------- | ---------- |
E
ester.zhou 已提交
443
| Normal    | The original case of the text is retained.|
E
ester.zhou 已提交
444 445
| LowerCase | All letters in the text are in lowercase.  |
| UpperCase | All letters in the text are in uppercase.  |
E
esterzhou 已提交
446 447 448

## ResponseType<sup>8+</sup>

E
ester.zhou 已提交
449 450 451
| Name        | Description           |
| ---------- | ------------- |
| LongPress  | The menu is displayed when the component is long-pressed.  |
E
ester.zhou 已提交
452
| RightClick | The menu is displayed when the component is right-clicked.|
E
esterzhou 已提交
453 454 455

## HoverEffect<sup>8+</sup>

E
ester.zhou 已提交
456 457
| Name       | Description            |
| --------- | -------------- |
E
ester.zhou 已提交
458
| Auto      | Default hover effect.|
E
ester.zhou 已提交
459 460 461
| Scale     | Scale effect.       |
| Highlight | Background fade-in and fade-out effect.  |
| None      | No effect.        |
E
esterzhou 已提交
462 463 464

## Placement<sup>8+</sup>

E
ester.zhou 已提交
465 466 467 468 469 470
| Name           | Description                                    |
| ------------- | -------------------------------------- |
| Left          | The popup is on the left of the component, vertically aligned with the component on the left.                 |
| Right         | The popup is on the right of the component, vertically aligned with the component on the right.                 |
| Top           | The popup is at the top of the component, horizontally aligned with the component at the top.                 |
| Bottom        | The popup is at the bottom of the component, horizontally aligned with the component at the bottom.                 |
E
ester.zhou 已提交
471 472 473 474
| TopLeft       | The popup is at the top of the component and, since API version 9, aligned with the left of the component.|
| TopRight      | The popup is at the top of the component and, since API version 9, aligned with the right of the component.|
| BottomLeft    | The popup is at the bottom of the component and, since API version 9, aligned with the left of the component.|
| BottomRight   | The popup is at the bottom of the component and, since API version 9, aligned with the right of the component.|
E
ester.zhou 已提交
475 476 477 478
| LeftTop9+     | The popup is on the left of the component and aligned with the top of the component.                 |
| LeftBottom9+  | The popup is on the left of the component and aligned with the bottom of the component.                 |
| RightTop9+    | The popup is on the right of the component and aligned with the top of the component.                 |
| RightBottom9+ | The popup is on the right of the component and aligned with the bottom of the component.                 |
E
esterzhou 已提交
479 480 481

## CopyOptions<sup>9+</sup>

E
ester.zhou 已提交
482 483
Since API version 9, this API is supported in ArkTS widgets.

E
ester.zhou 已提交
484 485 486
| Name         | Description      |
| ----------- | -------- |
| None        | Copy is not allowed.  |
E
ester.zhou 已提交
487 488
| InApp       | Intra-application copy is allowed.|
| LocalDevice | Intra-device copy is allowed.|
E
esterzhou 已提交
489 490

## HitTestMode<sup>9+</sup>
Z
zengyawen 已提交
491

E
ester.zhou 已提交
492 493 494 495
| Name         | Description                                      |
| ----------- | ---------------------------------------- |
| 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.|
| 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.|
E
ester.zhou 已提交
496
| 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.|
E
ester.zhou 已提交
497
| None        | The node does not respond to the hit test of a touch event, but its child node and sibling node are considered during the hit test.     |
E
ester.zhou 已提交
498 499 500 501 502

## BlurStyle<sup>9+</sup>

This API is supported in ArkTS widgets.

E
ester.zhou 已提交
503 504 505 506 507 508 509 510 511
| Name                  | Description       |
| -------------------- | --------- |
| Thin                 | Thin material.  |
| Regular              | Regular material.|
| Thick                | Thick material.   |
| BACKGROUND_THIN       | Material that creates the minimum depth of field effect.  |
| BACKGROUND_REGULAR    | Material that creates a medium shallow depth of field effect.  |
| BACKGROUND_THICK      | Material that creates a high shallow depth of field effect.  |
| BACKGROUND_ULTRA_THICK | Material that creates the maximum depth of field effect. |
E
ester.zhou 已提交
512
| NONE<sup>10+</sup> | No blur. |
E
ester.zhou 已提交
513

E
ester.zhou 已提交
514 515
## ThemeColorMode<sup>10+</sup>

E
ester.zhou 已提交
516 517 518 519 520
| Name    | Description        |
| ------ | ---------- |
| SYSTEM | Following the system color mode.|
| LIGHT  | Light color mode. |
| DARK   | Dark color mode. |
E
ester.zhou 已提交
521 522 523

## AdaptiveColor<sup>10+</sup>

E
ester.zhou 已提交
524 525 526 527
| Name     | Description                       |
| ------- | ------------------------- |
| DEFAULT | Adaptive color mode is not used. The default color is used as the mask color.   |
| AVERAGE | Adaptive color mode is used. The average color value of the color picking area is used as the mask color.|
E
ester.zhou 已提交
528 529 530

## TextHeightAdaptivePolicy<sup>10+</sup>

E
ester.zhou 已提交
531 532 533 534
| Name                     | Description                      |
| ----------------------- | ------------------------ |
| MAX_LINES_FIRST         | Prioritize the **maxLines** settings.|
| MIN_FONT_SIZE_FIRST     | Prioritize the **minFontSize** settings.    |
E
ester.zhou 已提交
535
| LAYOUT_CONSTRAINT_FIRST | Prioritize the layout constraint settings in terms of height.|
E
ester.zhou 已提交
536

E
ester.zhou 已提交
537 538 539 540 541 542 543 544
## ObscuredReasons<sup>10+</sup>

This API is supported in ArkTS widgets.

| Name       | Description                    |
| ----------- | ------------------------ |
| PLACEHOLDER | The content is replaced by a placeholder.|

E
ester.zhou 已提交
545
## TransitionEdge<sup>10+<sup>
E
ester.zhou 已提交
546 547 548 549

| Name    | Description    |
| ------ | ------ |
| TOP    | Top edge of the window.|
E
ester.zhou 已提交
550
| BOTTOM | Bottom edge of the window.|
E
ester.zhou 已提交
551 552 553 554 555 556 557 558 559 560
| START  | Left edge of the window.|
| END    | Right edge of the window.|

## ClickEffectLevel<sup>10+<sup>

| Name  | Description              | Animation Settings                         | Default Zoom Ratio                    |
| ------ | --------------------------------- | --------------------------------- | --------------------------------- |
| LIGHT  | Small area (light)| Spring effect, with stiffness of 410, damping of 38, and initial velocity of 1.| 90% |
| MIDDLE | Medium area (stable)| Spring effect, with stiffness of 350, damping of 35, and initial velocity of 0.5.| 95% |
| HEAVY  | Large area (heavy)| Spring effect, with stiffness of 240, damping of 28, and initial velocity of 0.| 95% |
E
ester.zhou 已提交
561 562 563 564 565 566 567

## TextContentStyle<sup>10+</sup>

| Name   | Description                                                        |
| ------- | ------------------------------------------------------------ |
| 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.|
| INLINE  | Inline input style. The background height of the selected text is the same as the height of the text box.            |