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