• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 显式动画
2
3提供全局animateTo显式动画接口来指定由于闭包代码导致的状态变化插入过渡动效。同属性动画,布局类改变宽高的动画,内容都是直接到终点状态,例如文字、canvas的内容、linearGradient等,如果要内容跟随宽高变化,可以使用[renderFit](ts-universal-attributes-renderfit.md)属性配置。
4
5>  **说明:**
6>
7>  从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
8>
9>  本模块功能依赖UI的执行上下文,不可在UI上下文不明确的地方使用,参见[UIContext](../apis/js-apis-arkui-UIContext.md#uicontext)说明。
10>
11>  从API version 10开始,可以通过使用[UIContext](../apis/js-apis-arkui-UIContext.md#uicontext)中的[animateTo](../apis/js-apis-arkui-UIContext.md#animateto)来明确UI的执行上下文。
12
13animateTo(value: AnimateParam, event: () => void): void
14
15从API version 9开始,该接口支持在ArkTS卡片中使用。
16
17| 参数    | 类型                                | 是否必填 | 描述                                    |
18| ----- | --------------------------------- | ---- | ------------------------------------- |
19| value | [AnimateParam](#animateparam对象说明) | 是    | 设置动画效果相关参数。                           |
20| event | () => void                        | 是    | 指定显示动效的闭包函数,在闭包函数中导致的状态变化系统会自动插入过渡动画。 |
21
22## AnimateParam对象说明
23
24| 名称         | 类型                                       | 描述                                       |
25| ---------- | ---------------------------------------- | ---------------------------------------- |
26| duration   | number                                   | 动画持续时间,单位为毫秒。<br/>默认值:1000<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。<br/>**说明:**<br/>- 在ArkTS卡片上最大动画持续时间为1000毫秒,若超出则固定为1000毫秒。<br/>-&nbsp;设置小于0的值时按0处理。<br/>-&nbsp;设置浮点型类型的值时,向下取整。例如,设置值为1.2,按照1处理。 |
27| tempo      | number                                   | 动画播放速度,值越大动画播放越快,值越小播放越慢,为0时无动画效果。<br/>默认值:1.0<br/>**说明:** <br/>当设置小于0的值时按值为1处理。 |
28| curve      | [Curve](ts-appendix-enums.md#curve)&nbsp;\|&nbsp;[ICurve](../apis/js-apis-curve.md#icurve)&nbsp;\|&nbsp;string | 动画曲线。<br/>默认值:Curve.EaseInOut<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
29| delay      | number                                   | 动画延迟播放时间,单位为ms(毫秒),默认不延时播放。<br/>默认值:0<br/>**说明:** <br/>-&nbsp;delay>=0为延迟播放,delay<0表示提前播放。对于delay<0的情况:当delay的绝对值小于实际动画时长,动画将在开始后第一帧直接运动到delay绝对值的时刻的状态;当delay的绝对值大于等于实际动画时长,动画将在开始后第一帧直接运动到终点状态。其中实际动画时长等于单次动画时长乘以动画播放次数。<br/>-&nbsp;设置浮点型类型的值时,向下取整。例如,设置值为1.2,按照1处理。 |
30| iterations | number                                   | 动画播放次数。默认播放一次,设置为-1时表示无限次播放。<br/>默认值:1          |
31| playMode   | [PlayMode](ts-appendix-enums.md#playmode) | 动画播放模式,默认播放完成后重头开始播放。<br/>默认值:PlayMode.Normal<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。<br/>相关使用约束请参考PlayMode说明。 |
32| onFinish   | ()&nbsp;=&gt;&nbsp;void                  | 动画播放完成回调。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
33
34> **PlayMode说明:**
35> - PlayMode推荐使用PlayMode.NormalPlayMode.Alternate,此场景下动画的第一轮是正向播放的。如使用PlayMode.ReversePlayMode.AlternateReverse,则动画的第一轮是逆向播放的,在动画刚开始时会跳变到终止状态,然后逆向播放动画。
36> - 使用PlayMode.AlternatePlayMode.AlternateReverse时,开发者应保证动画最终状态和状态变量的取值一致,即应保证动画的最后一轮是正向播放的。使用PlayMode.Alternate时,iterations应为奇数。使用PlayMode.AlternateReverse时,iterations应为偶数。
37> - 不推荐使用PlayMode.Reverse,此场景下不仅会导致动画刚开始就跳变到终止状态,也会导致动画最终状态和状态变量的取值不同。
38
39## 示例
40
41```ts
42// xxx.ets
43@Entry
44@Component
45struct AnimateToExample {
46  @State widthSize: number = 250
47  @State heightSize: number = 100
48  @State rotateAngle: number = 0
49  private flag: boolean = true
50
51  build() {
52    Column() {
53      Button('change size')
54        .width(this.widthSize)
55        .height(this.heightSize)
56        .margin(30)
57        .onClick(() => {
58          if (this.flag) {
59            animateTo({
60              duration: 2000,
61              curve: Curve.EaseOut,
62              iterations: 3,
63              playMode: PlayMode.Normal,
64              onFinish: () => {
65                console.info('play end')
66              }
67            }, () => {
68              this.widthSize = 150
69              this.heightSize = 60
70            })
71          } else {
72            animateTo({}, () => {
73              this.widthSize = 250
74              this.heightSize = 100
75            })
76          }
77          this.flag = !this.flag
78        })
79      Button('change rotate angle')
80        .margin(50)
81        .rotate({ x: 0, y: 0, z: 1, angle: this.rotateAngle })
82        .onClick(() => {
83          animateTo({
84            duration: 1200,
85            curve: Curve.Friction,
86            delay: 500,
87            iterations: -1, // 设置-1表示动画无限循环
88            playMode: PlayMode.Alternate,
89            onFinish: () => {
90              console.info('play end')
91            }
92          }, () => {
93            this.rotateAngle = 90
94          })
95        })
96    }.width('100%').margin({ top: 5 })
97  }
98}
99```
100
101![animation1](figures/animation1.gif)
102