1# 显式动画 (animateTo) 2 3提供全局animateTo显式动画接口来指定由于闭包代码导致的状态变化插入过渡动效。同属性动画，布局类改变宽高的动画，内容都是直接到终点状态，例如文字、[Canvas](ts-components-canvas-canvas.md)的内容等，如果要内容跟随宽高变化，可以使用[renderFit](ts-universal-attributes-renderfit.md)属性配置。 4 5> **说明：** 6> 7> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 8> 9> 本模块功能依赖UI的执行上下文，不可在UI上下文不明确的地方使用，参见[UIContext](../js-apis-arkui-UIContext.md#uicontext)说明。 10> 11>**卡片能力：** 从API version 9开始，该接口支持在ArkTS卡片中使用。 12> 13> 从API version 10开始，可以通过使用[UIContext](../js-apis-arkui-UIContext.md#uicontext)中的[animateTo](../js-apis-arkui-UIContext.md#animateto)来明确UI的执行上下文。 14> 15> 从API version 11开始，该接口支持在原子化服务中使用。 16 17## 接口 18animateTo(value: AnimateParam, event: () => void): void 19 20**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 21 22> **说明：** 23> - 不推荐在aboutToAppear、aboutToDisappear中调用动画。 24> - 如果在[aboutToAppear](./ts-custom-component-lifecycle.md#abouttoappear)中调用动画，自定义组件内的build还未执行，内部组件还未创建，动画时机过早，动画属性没有初值无法对组件产生动画。 25> - 执行[aboutToDisappear](./ts-custom-component-lifecycle.md#abouttodisappear)时，组件即将销毁，不能在aboutToDisappear里面做动画。 26> - 在组件出现和消失时，可以通过[组件内转场](./ts-transition-animation-component.md)添加动画效果。 27> - 组件内转场不支持的属性，可以参考[示例2](#示例2动画执行结束后组件消失)，使用animateTo实现动画执行结束后组件消失的效果。 28> - 某些场景下，在[状态管理V2](../../../quick-start/arkts-state-management-overview.md#状态管理v2)中使用animateTo动画，会产生异常效果，具体可参考：[在状态管理V2中使用animateTo动画效果异常](../../../quick-start/arkts-new-local.md#在状态管理v2中使用animateto动画效果异常)。 29 30**参数：** 31| 参数 | 类型 | 是否必填 | 描述 | 32| ----- | --------------------------------- | ---- | ------------------------------------- | 33| value | [AnimateParam](#animateparam对象说明) | 是 | 设置动画效果相关参数。 | 34| event | () => void | 是 | 指定动效的闭包函数，在闭包函数中导致的状态变化系统会自动插入过渡动画。 | 35 36## AnimateParam对象说明 37 38| 名称 | 类型 | 是否必填 | 描述 | 39| ---------- | ---------------|------------------------ | ---------------------------------------- | 40| duration | number | 否 | 动画持续时间，单位为毫秒。<br/>默认值：1000<br/>**卡片能力：** 从API version 9开始，该接口支持在ArkTS卡片中使用。<br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。<br/>**说明：**<br/>- 在ArkTS卡片上最大动画持续时间为1000毫秒，若超出则固定为1000毫秒。<br/>- 可以通过在持续时间为0的动画闭包函数中改变属性，以实现停止该属性动画的效果。<br/>- 设置小于0的值时按0处理。<br/>- 设置浮点型类型的值时，向下取整。例如，设置值为1.2，按照1处理。 | 41| tempo | number | 否 | 动画播放速度，值越大动画播放越快，值越小播放越慢，为0时无动画效果。<br/>默认值：1.0<br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。<br/>**说明：** <br/>当设置小于0的值时按值为1处理。 | 42| curve | [Curve](ts-appendix-enums.md#curve) \| [ICurve<sup>9+</sup>](../js-apis-curve.md#icurve) \| string | 否 | 动画曲线。<br/>默认值：Curve.EaseInOut<br/>**卡片能力：** 从API version 9开始，该接口支持在ArkTS卡片中使用。<br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 43| delay | number | 否 | 动画延迟播放时间，单位为ms(毫秒)，默认不延时播放。<br/>默认值：0<br/>取值范围：(-∞, +∞)<br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。<br/>**说明：** <br/>- delay>=0为延迟播放，delay<0表示提前播放。对于delay<0的情况：当delay的绝对值小于实际动画时长，动画将在开始后第一帧直接运动到delay绝对值的时刻的状态；当delay的绝对值大于等于实际动画时长，动画将在开始后第一帧直接运动到终点状态。其中实际动画时长等于单次动画时长乘以动画播放次数。<br/>- 设置浮点型类型的值时，向下取整。例如，设置值为1.2，按照1处理。 | 44| iterations | number | 否 | 动画播放次数。默认播放一次，设置为-1时表示无限次播放。设置为0时表示无动画效果。<br/>默认值：1 <br/>取值范围：[-1, +∞)<br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 45| playMode | [PlayMode](ts-appendix-enums.md#playmode)|否 | 动画播放模式，默认播放完成后重头开始播放。<br/>默认值：PlayMode.Normal<br/>**卡片能力：** 从API version 9开始，该接口支持在ArkTS卡片中使用。<br/>相关使用约束请参考PlayMode说明。<br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 46| onFinish | () => void | 否 | 动画播放完成回调。UIAbility从前台切换至后台时会立即结束仍在步进中的有限循环动画，触发播放完成回调。 <br/>**卡片能力：** 从API version 9开始，该接口支持在ArkTS卡片中使用。<br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。<br/>| 47| finishCallbackType<sup>11+</sup> | [FinishCallbackType](#finishcallbacktype11)|否 | 在动画中定义onFinish回调的类型。<br/>默认值：FinishCallbackType.REMOVED<br/>**卡片能力：** 从API version 11开始，该接口支持在ArkTS卡片中使用。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 48| expectedFrameRateRange<sup>11+</sup> | [ExpectedFrameRateRange](#expectedframeraterange11) | 否 | 设置动画的期望帧率。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。| 49 50> **PlayMode说明：** 51> 52> - PlayMode推荐使用PlayMode.Normal和PlayMode.Alternate，此场景下动画的第一轮是正向播放的。如使用PlayMode.Reverse和PlayMode.AlternateReverse，则动画的第一轮是逆向播放的，在动画刚开始时会跳变到终止状态，然后逆向播放动画。 53> - 使用PlayMode.Alternate或PlayMode.AlternateReverse时，开发者应保证动画最终状态和状态变量的取值一致，即应保证动画的最后一轮是正向播放的。使用PlayMode.Alternate时，iterations应为奇数。使用PlayMode.AlternateReverse时，iterations应为偶数。 54> - 不推荐使用PlayMode.Reverse，此场景下不仅会导致动画刚开始就跳变到终止状态，也会导致动画最终状态和状态变量的取值不同。 55 56## FinishCallbackType<sup>11+</sup> 57 58**卡片能力：** 从API version 11开始，该接口支持在ArkTS卡片中使用。 59 60**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 61 62**系统能力：** SystemCapability.ArkUI.ArkUI.Full 63 64| 名称 | 描述 | 65| --------- | ------------------------------------------------------------ | 66| REMOVED | 当整个动画结束并立即删除时，将触发回调。 | 67| LOGICALLY | 当动画在逻辑上处于下降状态，但可能仍处于其长尾状态时，将触发回调。 | 68 69## ExpectedFrameRateRange<sup>11+</sup> 70 71**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 72 73| 名称 | 类型 | 说明 | 74|-----|--------|---------| 75| min | number | 期望的最小帧率。 | 76| max | number | 期望的最大帧率。 | 77| expected | number | 期望的最优帧率。 | 78 79## 示例 80 81### 示例1（在组件出现时创建动画） 82 83> **说明：** 84> 85> 直接使用animateTo可能导致实例不明确的问题，建议使用[getUIContext](../js-apis-arkui-UIContext.md#uicontext)获取UIContext实例，并使用[animateTo](../js-apis-arkui-UIContext.md#animateto)调用绑定实例的animateTo。 86 87该示例通过在onAppear方法中创建组件出现时的动画效果。 88 89```ts 90// xxx.ets 91@Entry 92@Component 93struct AnimateToExample { 94 @State widthSize: number = 250 95 @State heightSize: number = 100 96 @State rotateAngle: number = 0 97 private flag: boolean = true 98 99 build() { 100 Column() { 101 Button('change size') 102 .width(this.widthSize) 103 .height(this.heightSize) 104 .margin(30) 105 .onClick(() => { 106 if (this.flag) { 107 // 建议使用this.getUIContext()?.animateTo() 108 animateTo({ 109 duration: 2000, 110 curve: Curve.EaseOut, 111 iterations: 3, 112 playMode: PlayMode.Normal, 113 onFinish: () => { 114 console.info('play end') 115 } 116 }, () => { 117 this.widthSize = 150 118 this.heightSize = 60 119 }) 120 } else { 121 // 建议使用this.getUIContext()?.animateTo() 122 animateTo({}, () => { 123 this.widthSize = 250 124 this.heightSize = 100 125 }) 126 } 127 this.flag = !this.flag 128 }) 129 Button('stop rotating') 130 .margin(50) 131 .rotate({ x: 0, y: 0, z: 1, angle: this.rotateAngle }) 132 .onAppear(() => { 133 // 组件出现时开始做动画 134 // 建议使用this.getUIContext()?.animateTo() 135 animateTo({ 136 duration: 1200, 137 curve: Curve.Friction, 138 delay: 500, 139 iterations: -1, // 设置-1表示动画无限循环 140 playMode: PlayMode.Alternate, 141 expectedFrameRateRange: { 142 min: 10, 143 max: 120, 144 expected: 60, 145 } 146 }, () => { 147 this.rotateAngle = 90 148 }) 149 }) 150 .onClick(() => { 151 // 建议使用this.getUIContext()?.animateTo() 152 animateTo({ duration: 0 }, () => { 153 // this.rotateAngle之前为90，在duration为0的动画中修改属性，可以停止该属性之前的动画，按新设置的属性显示 154 this.rotateAngle = 0 155 }) 156 }) 157 }.width('100%').margin({ top: 5 }) 158 } 159} 160``` 161 162 163 164### 示例2（动画执行结束后组件消失） 165 166该示例主要演示如何实现在动画执行结束后组件消失。 167 168```ts 169// xxx.ets 170@Entry 171@Component 172struct AttrAnimationExample { 173 @State heightSize: number = 100; 174 @State isShow: boolean= true; 175 @State count: number= 0; 176 private isToBottom: boolean = true; // 向下 177 178 build() { 179 Column() { 180 if (this.isShow) { 181 Column() 182 .width(200) 183 .height(this.heightSize) 184 .backgroundColor('blue') 185 .onClick(() => { 186 // 建议使用this.getUIContext()?.animateTo() 187 animateTo({ 188 duration: 2000, 189 curve: Curve.EaseOut, 190 iterations: 1, 191 playMode: PlayMode.Normal, 192 onFinish: () => { 193 this.count--; 194 if (this.count == 0 && !this.isToBottom) { // 组件只有在向下做完动画才会消失 195 this.isShow = false; 196 } 197 } 198 }, () => { 199 this.count++; 200 if (this.isToBottom) { 201 this.heightSize = 60; 202 } else { 203 this.heightSize = 100; 204 } 205 this.isToBottom = !this.isToBottom; 206 }) 207 }) 208 } 209 }.width('100%').height('100%').margin({ top: 5 }) 210 .justifyContent(FlexAlign.End) 211 } 212} 213``` 214 215
