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