• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 属性动画
2
3组件的某些通用属性变化时,可以通过属性动画实现渐变过渡效果,提升用户体验。支持的属性包括width、height、backgroundColor、opacity、scale、rotate、translate等。
4
5> **说明:**
6>
7> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
8
9animation(value: {duration?: number, tempo?: number, curve?: string | Curve | ICurve, delay?:number, iterations: number, playMode?: PlayMode, onFinish?: () => void})
10
11从API version 9开始,该接口支持在ArkTS卡片中使用。
12
13**参数:**
14
15| 名称         | 参数类型                                       | 必填    | 描述                                                         |
16| ---------- | ------------------------------------------| ---- | ------------------------------------------------------------ |
17| duration   | number                                    | 否    | 设置动画时长。<br/>默认值:1000<br/>单位:毫秒<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。<br/>**说明:**<br/>- 在ArkTS卡片上最大动画持续时间为1000毫秒。<br/>-&nbsp;设置浮点型类型的值时,向下取整。例如,设置值为1.2,按照1处理。 |
18| tempo      | number                                    | 否    | 动画播放速度。数值越大,动画播放速度越快,数值越小,播放速度越慢。<br/>值为0时,表示不存在动画。<br/>默认值:1 |
19| curve      | string&nbsp;\|&nbsp;[Curve](ts-appendix-enums.md#curve)&nbsp;\|&nbsp;[ICurve](../apis/js-apis-curve.md#icurve)<sup>9+</sup> | 否   | 设置动画曲线。<br/>默认值:Curve.EaseInOut<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
20| delay      | number                                    | 否    | 设置动画延迟执行的时长。单位为毫秒,默认不延时播放。<br/>默认值:0<br/>取值范围:[0, +∞)<br/>**说明:** <br/>-&nbsp;设置浮点型类型的值时,向下取整。例如,设置值为1.2,按照1处理。 |
21| iterations | number                                    | 否    | 设置播放次数。<br/>默认值:1<br/>取值范围:[-1, +∞)<br/>**说明:** <br/>设置为-1时表示无限次播放。设置为0时表示无动画效果。 |
22| playMode   | [PlayMode](ts-appendix-enums.md#playmode) | 否    | 设置动画播放模式,默认播放完成后重头开始播放。<br/>默认值:PlayMode.Normal<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。<br/>相关使用约束请参考PlayMode说明。 |
23| onFinish   | () => void                                | 否    | 状态回调,动画播放完成时触发。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。<br/>**说明:** <br/>当iterations设置为-1时,动画效果无限循环不会停止,所以不会触发此回调。 |
24
25> **PlayMode说明:**
26> - PlayMode推荐使用PlayMode.NormalPlayMode.Alternate,此场景下动画的第一轮是正向播放的。如使用PlayMode.ReversePlayMode.AlternateReverse,则动画的第一轮是逆向播放的,在动画刚开始时会跳变到终止状态,然后逆向播放动画。
27> - 使用PlayMode.AlternatePlayMode.AlternateReverse时,开发者应保证动画最终状态和状态变量的取值一致,即应保证动画的最后一轮是正向播放的。使用PlayMode.Alternate时,iterations应为奇数。使用PlayMode.AlternateReverse时,iterations应为偶数。
28> - 不推荐使用PlayMode.Reverse,此场景下不仅会导致动画刚开始就跳变到终止状态,也会导致动画最终状态和状态变量的取值不同。
29
30## 示例
31
32```ts
33// xxx.ets
34@Entry
35@Component
36struct AttrAnimationExample {
37  @State widthSize: number = 250
38  @State heightSize: number = 100
39  @State rotateAngle: number = 0
40  @State flag: boolean = true
41
42  build() {
43    Column() {
44      Button('change size')
45        .onClick(() => {
46          if (this.flag) {
47            this.widthSize = 150
48            this.heightSize = 60
49          } else {
50            this.widthSize = 250
51            this.heightSize = 100
52          }
53          this.flag = !this.flag
54        })
55        .margin(30)
56        .width(this.widthSize)
57        .height(this.heightSize)
58        .animation({
59          duration: 2000,
60          curve: Curve.EaseOut,
61          iterations: 3,
62          playMode: PlayMode.Normal
63        })
64      Button('change rotate angle')
65        .onClick(() => {
66          this.rotateAngle = 90
67        })
68        .margin(50)
69        .rotate({ angle: this.rotateAngle })
70        .animation({
71          duration: 1200,
72          curve: Curve.Friction,
73          delay: 500,
74          iterations: -1, // 设置-1表示动画无限循环
75          playMode: PlayMode.Alternate
76        })
77    }.width('100%').margin({ top: 20 })
78  }
79}
80```
81
82![animation](figures/animation.gif)