ts-appendix-enums.md 22.9 KB
Newer Older
Z
zengyawen 已提交
1
# Built-in Enums
Z
zengyawen 已提交
2

E
esterzhou 已提交
3
## Color
Z
zengyawen 已提交
4

E
esterzhou 已提交
5 6 7 8 9 10
| 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) |
E
ester.zhou 已提交
11
| Grey                     | 0x808080 | ![en-us_image_0000001174264376](figures/en-us_image_0000001174264376.png) |
E
esterzhou 已提交
12 13 14 15 16 17 18
| 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 已提交
19

E
esterzhou 已提交
20
## ImageFit
Z
zengyawen 已提交
21

E
esterzhou 已提交
22 23 24 25 26 27 28 29
| Name     | Description                                                        |
| --------- | ------------------------------------------------------------ |
| 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.|
| 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 已提交
30

E
esterzhou 已提交
31
## BorderStyle
Z
zengyawen 已提交
32

E
esterzhou 已提交
33 34 35 36 37
| Name  | Description                                           |
| ------ | ----------------------------------------------- |
| Dotted | Dotted border. The radius of a dot is half of **borderWidth**.|
| Dashed | Dashed border.                     |
| Solid  | Solid border.                               |
Z
zengyawen 已提交
38

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

E
esterzhou 已提交
41 42 43 44 45
| Name | Description                |
| ----- | -------------------- |
| Bevel | Bevel is used to connect paths.|
| Miter | Miter is used to connect paths.|
| Round | Round is used to connect paths.|
Z
zengyawen 已提交
46

E
esterzhou 已提交
47
## TouchType
Z
zengyawen 已提交
48

E
esterzhou 已提交
49 50 51 52 53 54
| Name  | Description                          |
| ------ | ------------------------------ |
| Down   | A finger is pressed.              |
| Up     | A finger is lifted.              |
| Move   | A finger moves on the screen in pressed state.|
| Cancel | A touch event is canceled.          |
Z
zengyawen 已提交
55

E
esterzhou 已提交
56
## MouseButton
Z
zengyawen 已提交
57

E
esterzhou 已提交
58 59 60 61 62 63 64 65
| Name   | Description            |
| ------- | ---------------- |
| Left    | Left button on the mouse.      |
| Right   | Right button on the mouse.      |
| Middle  | Middle button on the mouse.      |
| Back    | Back button on the left of the mouse.|
| Forward | Forward button on the left of the mouse.|
| None    | No button.        |
Z
zengyawen 已提交
66

E
esterzhou 已提交
67
## MouseAction
Z
zengyawen 已提交
68

E
esterzhou 已提交
69 70 71 72 73
| Name   | Description          |
| ------- | -------------- |
| Press   | The mouse button is pressed.|
| Release | The mouse button is released.|
| Move    | The mouse cursor moves.    |
E
ester.zhou 已提交
74
| Hover    | The mouse pointer is hovered on an element.    |
Z
zengyawen 已提交
75

E
esterzhou 已提交
76
## Curve
Z
zengyawen 已提交
77

E
esterzhou 已提交
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
| Name               | Description                                                        |
| ------------------- | ------------------------------------------------------------ |
| Linear              | The animation speed keeps unchanged.                          |
| 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.|
| 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.      |
| EaseInOut           | The animation starts and ends at a low speed. The cubic-bezier curve (0.42, 0.0, 0.58, 1.0) is used.|
| 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 已提交
93

E
esterzhou 已提交
94
## AnimationStatus
Z
zengyawen 已提交
95

E
esterzhou 已提交
96 97 98 99 100 101
| Name   | Description              |
| ------- | ------------------ |
| Initial | The animation is in the initial state.    |
| Running | The animation is being played.|
| Paused  | The animation is paused.|
| Stopped | The animation is stopped.|
Z
zengyawen 已提交
102

E
esterzhou 已提交
103
## FillMode
Z
zengyawen 已提交
104

E
ester.zhou 已提交
105 106 107 108 109 110
| 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.                |
| 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 已提交
111

E
esterzhou 已提交
112
## PlayMode
Z
zengyawen 已提交
113

E
esterzhou 已提交
114 115 116 117 118 119
| Name            | Description                                                        |
| ---------------- | ------------------------------------------------------------ |
| Normal           | The animation is played forwards.                                            |
| Reverse          | The animation is played backwards.                                              |
| 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 已提交
120

E
esterzhou 已提交
121
## KeyType
Z
zengyawen 已提交
122

E
esterzhou 已提交
123 124 125 126
| Name| Description      |
| ---- | ---------- |
| Down | The key is pressed.|
| Up   | The key is released.|
Z
zengyawen 已提交
127

E
esterzhou 已提交
128
## KeySource
Z
zengyawen 已提交
129

E
esterzhou 已提交
130 131 132 133
| Name    | Description                |
| -------- | -------------------- |
| Unknown  | Unknown input device.  |
| Keyboard | The input device is a keyboard.|
Z
zengyawen 已提交
134

E
esterzhou 已提交
135
## Edge
Z
zengyawen 已提交
136

E
esterzhou 已提交
137 138 139
| Name    | Description                  |
| -------- | ---------------------- |
| Top      | Top edge in the vertical direction.        |
E
ester.zhou 已提交
140
| Center<sup>(deprecated) </sup>   | Center position in the vertical direction.<br>This API is deprecated since API version 9.      |
E
esterzhou 已提交
141
| Bottom   | Bottom edge in the vertical direction.        |
E
ester.zhou 已提交
142
| Baseline<sup>(deprecated) </sup> | Text baseline position in the cross axis direction.<br>This API is deprecated since API version 9. |
E
esterzhou 已提交
143
| Start    | Start position in the horizontal direction.      |
E
ester.zhou 已提交
144
| Middle<sup>(deprecated) </sup>   | Center position in the horizontal direction.<br>This API is deprecated since API version 9.      |
E
esterzhou 已提交
145
| End      | End position in the horizontal direction.      |
Z
zengyawen 已提交
146

E
esterzhou 已提交
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
## Week

| Name    | Description                  |
| -------- | ---------------------- |
| Mon      | Monday.               |
| Tue      | Tuesday.               |
| Wed      | Wednesday.               |
| Thur     | Thursday.               |
| Fri      | Friday.               |
| Sat      | Saturday.               |
| Sun      | Sunday.               |

## Direction

| Name| Description                  |
| ---- | ---------------------- |
| Ltr  | Components are arranged from left to right.    |
| Rtl  | Components are arranged from right to left.    |
| Auto | The default layout direction is used.|

## BarState

| Name| Description                            |
| ---- | -------------------------------- |
| Off  | Not displayed.                        |
| On   | Always displayed.                      |
| Auto | Displayed when the screen is touched and hidden after 2s.|

## EdgeEffect

| Name  | Description                                                        |
| ------ | ------------------------------------------------------------ |
| 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.                    |
| None   | No effect when the component is at one of the edges.                                        |

## Alignment

| Name       | Description            |
| ----------- | ---------------- |
| TopStart    | Top start.    |
| Top         | Horizontally centered on the top.  |
| TopEnd      | Top end.      |
| Start       | Vertically centered start.|
| Center      | Horizontally and vertically centered.|
| End         | Vertically centered end.  |
| BottomStart | Bottom start.    |
| Bottom      | Horizontally centered on the bottom.  |
| BottomEnd   | Bottom end.      |

## TransitionType

| Name  | Description                                              |
| ------ | -------------------------------------------------- |
| All    | The transition takes effect in all scenarios.|
| Insert | The transition takes effect when a component is inserted.    |
| Delete | The transition takes effect when a component is deleted.    |

## RelateType

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

## Visibility

| Name   | Description                            |
| ------- | -------------------------------- |
| Hidden  | The component is hidden, and a placeholder is used for it in the layout.      |
| Visible | The component is visible.                          |
| None    | The component is hidden. It is not involved in the layout, and no placeholder is used for it.|

## LineCapStyle

| Name  | Description                |
| ------ | -------------------- |
E
ester.zhou 已提交
224 225 226
| 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.|
| 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 已提交
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251

## Axis

| Name      | Description        |
| ---------- | ------------ |
| Vertical   | Vertical direction.|
| Horizontal | Horizontal direction.|

## HorizontalAlign

| Name  | Description                    |
| ------ | ------------------------ |
| 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.|
| End    | Aligned with the end edge in the same direction as the language in use.  |

## FlexAlign

| 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.|
| 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.|
E
ester.zhou 已提交
252
| 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 已提交
253 254 255 256 257

## ItemAlign

| Name    | Description                                                        |
| -------- | ------------------------------------------------------------ |
E
ester.zhou 已提交
258 259 260 261 262 263
| Auto     | The default configuration in the flex container is used.                                    |
| Start    | The elements are in the flex container, top-aligned in the cross-axis direction.                      |
| Center   | The elements are in the flex container, centered in the cross-axis direction.                      |
| End      | The elements are in the flex container, bottom-aligned in the cross-axis direction.                      |
| Stretch  | The elements are in the flex container, stretched and padded in the cross-axis direction. If the size is not set, the elements are stretched to the container size.|
| Baseline | The elements are in the flex container, text baseline aligned in the cross-axis direction.                  |
E
esterzhou 已提交
264 265 266 267 268 269 270 271 272 273 274 275 276 277

## FlexDirection

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

## FlexWrap

| Name       | Description                                             |
| ----------- | ------------------------------------------------- |
E
ester.zhou 已提交
278 279 280
| 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.    |
| WrapReverse | The child components in the flex container are reversely arranged in multiple lines, and they may overflow.|
E
esterzhou 已提交
281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357

## VerticalAlign

| Name  | Description                    |
| ------ | ------------------------ |
| Top    | Top aligned.              |
| Center | Center aligned. This is the default alignment mode.|
| Bottom | Bottom aligned.              |

## ImageRepeat

| Name    | Description                      |
| -------- | -------------------------- |
| X        | The image is repeatedly drawn only along the horizontal axis.|
| Y        | The image is repeatedly drawn only along the vertical axis.|
| XY       | The image is repeatedly drawn along both axes.  |
| NoRepeat | The image is not repeatedly drawn.          |

## ImageSize

| Type   | Description                                                        |
| ------- | ------------------------------------------------------------ |
| 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.|
| 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.                                        |

## GradientDirection

| Name       | Description      |
| ----------- | ---------- |
| 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.|
| 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.      |

## SharedTransitionEffectType

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

## FontStyle

| Name  | Description            |
| ------ | ---------------- |
| Normal | Standard font style.|
| Italic | Italic font style.|

## FontWeight

| Name   | Description          |
| ------- | -------------- |
| Lighter | The font weight is lighter.    |
| Normal  | The font weight is normal.|
| Regular | The font weight is regular.|
| Medium  | The font weight is medium.|
| Bold    | The font weight is bold.    |
| Bolder  | The font weight is bolder.  |

## TextAlign

| Name  | Description          |
| ------ | -------------- |
| Start  | Aligned with the start.|
| Center | Horizontally centered.|
| End    | Aligned with the end.|

## TextOverflow

| Name    | Description                                  |
| -------- | -------------------------------------- |
E
ester.zhou 已提交
358
| Clip     | Extra-long text is clipped.              |
E
esterzhou 已提交
359
| Ellipsis | An ellipsis (...) is used to represent clipped text.|
E
ester.zhou 已提交
360
| None     | No clipping or ellipsis is used for extra-long text.                |
E
esterzhou 已提交
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397

## TextDecorationType

| Name       | Description              |
| ----------- | ------------------ |
| Underline   | Line under the text.  |
| LineThrough | Line through the text.|
| Overline    | Line over the text.  |
| None        | No decorative lines.|

## TextCase

| Name     | Description                |
| --------- | -------------------- |
| Normal    | The original case of the text is retained.|
| LowerCase | All letters in the text are in lowercase.    |
| UpperCase | All letters in the text are in uppercase.    |

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

| Name      | Description                      |
| ---------- | -------------------------- |
| LongPress  | The menu is displayed when the component is long-pressed.    |
| RightClick | The menu is displayed when the component is right-clicked.|

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

| Name     | Description                        |
| --------- | ---------------------------- |
| Auto      | Default hover effect.|
| Scale     | Scale effect.              |
| Highlight | Background fade-in and fade-out effect.    |
| None      | No effect.                |

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

| Name         | Description                                                        |
Z
zengyawen 已提交
398
| ------------- | ------------------------------------------------------------ |
E
esterzhou 已提交
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
| 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.                  |
| 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.|
| 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.                  |

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

| Name       | Description                |
| ----------- | -------------------- |
E
ester.zhou 已提交
416 417 418
| None        | Copy is not allowed.    |
| InApp       | Intra-application copy is allowed.|
| LocalDevice | Intra-device copy is allowed.|
E
esterzhou 已提交
419 420

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

E
esterzhou 已提交
422 423
| Name       | Description                |
| ----------- | -------------------- |
E
ester.zhou 已提交
424 425 426 427
| 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.       |
| 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.|
| 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.|