harmony 鸿蒙@ohos.animator (动画)

2025-06-12
浏览 (3)

@ohos.animator (动画)

本模块提供组件动画效果，包括定义动画、启动动画和以相反的顺序播放动画等。

说明：

本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

本模块从API version 9开始支持在ArkTS中使用。

该模块不支持在UIAbility的文件声明处使用，即不能在UIAbility的生命周期中调用，需要在创建组件实例后使用。

本模块功能依赖UI的执行上下文，不可在UI上下文不明确的地方使用，参见UIContext说明。

导入模块

import { Animator as animator, AnimatorOptions, AnimatorResult, SimpleAnimatorOptions } from '@kit.ArkUI';

Animator

定义Animator类。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

create^(deprecated)

create(options: AnimatorOptions): AnimatorResult

创建animator动画结果对象（AnimatorResult）。

说明：

从API version 9开始支持，从API version 18开始废弃，建议使用UIContext中的createAnimator替代。

从API version 10开始，可以通过使用UIContext中的createAnimator来明确UI的执行上下文。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
options	AnimatorOptions	是	定义动画选项。

返回值：

类型	说明
AnimatorResult	Animator结果接口。

错误码：

以下错误码详细介绍请参考通用错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2.Incorrect parameters types; 3. Parameter verification failed.

示例：

说明：

推荐通过使用UIContext中的createAnimator接口明确UI上下文。

import { Animator as animator, AnimatorOptions } from '@kit.ArkUI';

let options: AnimatorOptions = {
  duration: 1500,
  easing: "friction",
  delay: 0,
  fill: "forwards",
  direction: "normal",
  iterations: 3,
  begin: 200.0,
  end: 400.0
};
animator.create(options); // 建议使用 UIContext.createAnimator()接口

create¹⁸⁺

create(options: AnimatorOptions |SimpleAnimatorOptions): AnimatorResult

创建animator动画结果对象（AnimatorResult）。与create相比，新增对SimpleAnimatorOptions类型入参的支持。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
options	AnimatorOptions \|SimpleAnimatorOptions	是	定义动画参数选项。

返回值：

类型	说明
AnimatorResult	Animator结果接口。

错误码：

以下错误码详细介绍请参考通用错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2.Incorrect parameters types; 3. Parameter verification failed.

示例：

说明：

推荐通过使用UIContext中的createAnimator接口明确UI上下文。

import { Animator as animator, SimpleAnimatorOptions } from '@kit.ArkUI';
let options: SimpleAnimatorOptions = new SimpleAnimatorOptions(100, 200).duration(2000);
animator.create(options);// 建议使用 UIContext.createAnimator()接口

createAnimator^(deprecated)

createAnimator(options: AnimatorOptions): AnimatorResult

创建动画

从API version9开始不再维护，建议使用UIContext中的createAnimator

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
options	AnimatorOptions	是	定义动画选项。

返回值：

类型	说明
AnimatorResult	Animator结果接口。

示例：

import { Animator as animator } from '@kit.ArkUI';

let options: AnimatorOptions = {
  // xxx.js文件中不需要强调显式类型AnimatorOptions
  duration: 1500,
  easing: "friction",
  delay: 0,
  fill: "forwards",
  direction: "normal",
  iterations: 3,
  begin: 200.0,
  end: 400.0,
};
this.animator = animator.createAnimator(options);

AnimatorResult

定义Animator结果接口。

reset⁹⁺

reset(options: AnimatorOptions): void

更新当前animator动画。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
options	AnimatorOptions	是	定义动画选项。

错误码：

以下错误码的详细介绍请参见ohos.animator(动画)错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2.Incorrect parameters types; 3. Parameter verification failed.
100001	The specified page is not found or the object property list is not obtained.

示例：

import { Animator as animator, AnimatorOptions, AnimatorResult } from '@kit.ArkUI';
import { BusinessError } from '@kit.BasicServicesKit';

let options: AnimatorOptions = {
  duration: 1500,
  easing: "friction",
  delay: 0,
  fill: "forwards",
  direction: "normal",
  iterations: 3,
  begin: 200.0,
  end: 400.0
};
let optionsNew: AnimatorOptions = {
  duration: 1500,
  easing: "friction",
  delay: 0,
  fill: "forwards",
  direction: "normal",
  iterations: 5,
  begin: 200.0,
  end: 400.0
};
try {
  let animatorResult: AnimatorResult|undefined = animator.create(options)
  animatorResult.reset(optionsNew);
} catch (error) {
  let message = (error as BusinessError).message
  let code = (error as BusinessError).code
  console.error(`Animator reset failed, error code: ${code}, message: ${message}.`);
}

reset¹⁸⁺

reset(options: AnimatorOptions |SimpleAnimatorOptions): void

更新当前animator动画。与reset相比，新增对SimpleAnimatorOptions类型入参的支持。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
options	AnimatorOptions \|SimpleAnimatorOptions	是	定义动画选项。

错误码：

以下错误码的详细介绍请参考通用错误码和ohos.animator(动画)错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2.Incorrect parameters types; 3. Parameter verification failed.
100001	The specified page is not found or the object property list is not obtained.

示例：

import { Animator as animator, AnimatorResult, AnimatorOptions, SimpleAnimatorOptions } from '@kit.ArkUI';
let options: AnimatorOptions = {
  duration: 1500,
  easing: "ease",
  delay: 0,
  fill: "forwards",
  direction: "normal",
  iterations: 1,
  begin: 100,
  end: 200
};
let optionsNew: SimpleAnimatorOptions = new SimpleAnimatorOptions(100, 200)
  .duration(2000)
  .iterations(3)
  .delay(1000)
let animatorResult:AnimatorResult = animator.create(options);
animatorResult.reset(optionsNew);

play

play(): void

启动动画。动画会保留上一次的播放状态，比如播放状态设置reverse后，再次播放会保留reverse的播放状态。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

示例：

animator.play();

finish

finish(): void

结束动画，会触发onFinish回调。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

示例：

animator.finish();

pause

pause(): void

暂停动画。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

示例：

animator.pause();

cancel

cancel(): void

取消动画，会触发onCancel回调。此接口和finish接口功能上没有区别，仅触发的回调不同，建议使用finish接口结束动画。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

示例：

animator.cancel();

reverse

reverse(): void

以相反的顺序播放动画。使用interpolating-spring曲线时此接口无效。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

示例：

animator.reverse();

onFrame¹²⁺

onFrame: (progress: number) => void

接收到帧时回调。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
progress	number	是	动画的当前值。取值范围为AnimatorOptions定义的[begin, end]，默认取值范围为[0, 1]。

示例：

import { Animator as animator, AnimatorResult } from '@kit.ArkUI';

let animatorResult: AnimatorResult|undefined = animator.create(options)
animatorResult.onFrame = (value: number) => {
  console.info("onFrame callback")
}

onFinish¹²⁺

onFinish: () => void

动画完成时回调。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

示例：

import {Animator as animator, AnimatorResult } from '@kit.ArkUI';
let animatorResult:AnimatorResult|undefined = animator.create(options)
animatorResult.onFinish = ()=> {
  console.info("onFinish callback")
}

onCancel¹²⁺

onCancel: () => void

动画被取消时回调。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

示例：

import { Animator as animator, AnimatorResult } from '@kit.ArkUI';

let animatorResult: AnimatorResult|undefined = animator.create(options)
animatorResult.onCancel = () => {
  console.info("onCancel callback")
}

onRepeat¹²⁺

onRepeat: () => void

动画重复时回调。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

示例：

import { Animator as animator, AnimatorResult } from '@kit.ArkUI';

let animatorResult: AnimatorResult|undefined = animator.create(options)
animatorResult.onRepeat = () => {
  console.info("onRepeat callback")
}

onframe^(deprecated)

说明：

从API version 12开始废弃，推荐使用onFrame。

onframe: (progress: number) => void

接收到帧时回调。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
progress	number	是	动画的当前进度。

示例：

import { Animator as animator, AnimatorResult } from '@kit.ArkUI';

let animatorResult: AnimatorResult|undefined = animator.create(options)
animatorResult.onframe = (value) => {
  console.info("onframe callback")
}

onfinish^(deprecated)

说明：

从API version 12开始废弃，推荐使用onFinish。

onfinish: () => void

动画完成时回调。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

示例：

import { Animator as animator, AnimatorResult } from '@kit.ArkUI';

let animatorResult: AnimatorResult|undefined = animator.create(options)
animatorResult.onfinish = () => {
  console.info("onfinish callback")
}

oncancel^(deprecated)

说明：

从API version 12开始废弃，推荐使用onCancel。

oncancel: () => void

动画被取消时回调。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

示例：

import { Animator as animator, AnimatorResult } from '@kit.ArkUI';

let animatorResult: AnimatorResult|undefined = animator.create(options)
animatorResult.oncancel = () => {
  console.info("oncancel callback")
}

onrepeat^(deprecated)

说明：

从API version 12开始废弃，推荐使用onRepeat。

onrepeat: () => void

动画重复时回调。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

示例：

import { Animator as animator, AnimatorResult } from '@kit.ArkUI';

let animatorResult: AnimatorResult|undefined = animator.create(options)
animatorResult.onrepeat = () => {
  console.info("onrepeat callback")
}

setExpectedFrameRateRange¹²⁺

setExpectedFrameRateRange(rateRange: ExpectedFrameRateRange): void

设置期望的帧率范围。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
rateRange	ExpectedFrameRateRange	是	设置期望的帧率范围。

示例：

import { Animator as animator, AnimatorResult } from '@kit.ArkUI';

let animatorResult: AnimatorResult|undefined = animator.create({
  duration: 2000,
  easing: "ease",
  delay: 0,
  fill: "forwards",
  direction: "normal",
  iterations: 1,
  begin: 100,
  end: 200
})
let expectedFrameRate: ExpectedFrameRateRange = {
  min: 0,
  max: 120,
  expected: 30
}
animatorResult.setExpectedFrameRateRange(expectedFrameRate);

update^(deprecated)

update(options: AnimatorOptions): void

更新当前动画器。

从API version9开始不再维护，建议使用reset⁹⁺。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
options	AnimatorOptions	是	定义动画选项。

示例：

animator.update(options);

AnimatorOptions

定义动画选项。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

名称	类型	必填	说明
duration	number	是	动画播放的时长，单位毫秒。取值范围：[0, +∞)
easing	string	是	动画插值曲线，仅支持以下可选值： “linear”：动画线性变化。 “ease”：动画开始和结束时的速度较慢，cubic-bezier(0.25、0.1、0.25、1.0)。 “ease-in”：动画播放速度先慢后快，cubic-bezier(0.42, 0.0, 1.0, 1.0)。 “ease-out”：动画播放速度先快后慢，cubic-bezier(0.0, 0.0, 0.58, 1.0)。 “ease-in-out”：动画播放速度先加速后减速，cubic-bezier(0.42, 0.0, 0.58, 1.0)。 “fast-out-slow-in”：标准曲线，cubic-bezier(0.4，0.0，0.2，1.0)。 “linear-out-slow-in”：减速曲线，cubic-bezier(0.0，0.0，0.2，1.0)。 “fast-out-linear-in”：加速曲线，cubic-bezier(0.4, 0.0, 1.0, 1.0)。 “friction”：阻尼曲线，cubic-bezier(0.2, 0.0, 0.2, 1.0)。 “extreme-deceleration”：急缓曲线，cubic-bezier(0.0, 0.0, 0.0, 1.0)。 “rhythm”：节奏曲线，cubic-bezier(0.7, 0.0, 0.2, 1.0)。 “sharp”：锐利曲线，cubic-bezier(0.33, 0.0, 0.67, 1.0)。 “smooth”：平滑曲线，cubic-bezier(0.4, 0.0, 0.4, 1.0)。 “cubic-bezier(x1,y1,x2,y2)“：三次贝塞尔曲线，x1、x2的值必须处于0-1之间。例如”cubic-bezier(0.42,0.0,0.58,1.0)“。 “steps(number,step-position)“：阶梯曲线，number必须设置，为正整数，step-position参数可选，支持设置start或end，默认值为end。例如”steps(3,start)“。 “interpolating-spring(velocity,mass,stiffness,damping)“：插值弹簧曲线，从API version 11开始支持且仅在ArkTS中支持使用。velocity、mass、stiffness、damping都是数值类型，且mass、stiffness、damping参数均应该大于0，具体参数含义参考插值弹簧曲线。使用interpolating-spring时，duration不生效，由弹簧参数决定；fill、direction、iterations设置无效，fill固定设置为”forwards”，direction固定设置为”normal”，iterations固定设置为1，且对animator的reverse函数调用无效。即animator使用interpolating-spring时只能正向播放1次。非法字符串时取:“ease”。
delay	number	是	动画延时播放时长，单位毫秒，设置为0时，表示不延时。设置为负数时动画提前播放，如果提前播放的时长大于动画总时长，动画直接过渡到终点。
fill	‘none’ \|‘forwards’ \|‘backwards’ \|‘both’	是	动画执行后是否恢复到初始状态，动画执行后，动画结束时的状态（在最后一个关键帧中定义）将保留。 ‘none’：在动画执行之前和之后都不会应用任何样式到目标上。 ‘forwards’：在动画结束后，目标将保留动画结束时的状态（在最后一个关键帧中定义）。 ‘backwards’：动画将在animation-delay期间应用第一个关键帧中定义的值。当animation-direction为’normal’或’alternate’时应用from关键帧中的值，当animation-direction为’reverse’或’alternate-reverse’时应用to关键帧中的值。 ‘both’：动画将遵循forwards和backwards的规则，从而在两个方向上扩展动画属性。
direction	‘normal’ \|‘reverse’ \|‘alternate’ \|‘alternate-reverse’	是	动画播放模式。 ‘normal’：动画正向循环播放。 ‘reverse’：动画反向循环播放。 ‘alternate’：动画交替循环播放，奇数次正向播放，偶数次反向播放。 ‘alternate-reverse’：动画反向交替循环播放，奇数次反向播放，偶数次正向播放。
iterations	number	是	动画播放次数。设置为0时不播放，设置为-1时无限次播放，设置大于0时为播放次数。说明: 设置为除-1外其他负数视为无效取值，无效取值动画默认播放1次。
begin	number	是	动画插值起点。说明: 会影响onFrame回调的入参值。
end	number	是	动画插值终点。说明: 会影响onFrame回调的入参值。

SimpleAnimatorOptions¹⁸⁺

animator简易动画参数对象。与AnimatorOptions相比，部分动画参数有默认值，可不设置。

constructor¹⁸⁺

constructor(begin: number, end: number)

SimpleAnimatorOptions的构造函数。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
begin	number	是	动画插值起点。
end	number	是	动画插值终点。

示例：

import { Animator as animator, AnimatorResult, SimpleAnimatorOptions } from '@kit.ArkUI';

let options: SimpleAnimatorOptions = new SimpleAnimatorOptions(100, 200); // 动画插值过程从100到200，其余动画参数使用默认值。
let animatorResult:AnimatorResult = animator.create(options);

duration¹⁸⁺

duration(duration: number): SimpleAnimatorOptions

设置animator动画时长。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
duration	number	是	设置动画时长，单位毫秒。默认值：1000

返回值：

类型	说明
SimpleAnimatorOptions	Animator简易动画参数对象。

示例：

import { Animator as animator, AnimatorResult, SimpleAnimatorOptions } from '@kit.ArkUI';

let options: SimpleAnimatorOptions = new SimpleAnimatorOptions(100, 200).duration(500);
let animatorResult:AnimatorResult = animator.create(options);

easing¹⁸⁺

easing(curve: string): SimpleAnimatorOptions

设置animator动画插值曲线。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
curve	string	是	设置animator动画插值曲线，具体说明参考[AnimatorOptions]。默认值：“ease”

返回值：

类型	说明
SimpleAnimatorOptions	Animator简易动画参数对象。

示例：

import { Animator as animator, AnimatorResult, SimpleAnimatorOptions } from '@kit.ArkUI';

let options: SimpleAnimatorOptions = new SimpleAnimatorOptions(100, 200).easing("ease-in");
let animatorResult:AnimatorResult = animator.create(options);

delay¹⁸⁺

delay(delay: number): SimpleAnimatorOptions

设置animator动画播放时延。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
delay	number	是	设置animator动画播放时延，单位毫秒，设置为0时，表示不延时。设置为负数时动画提前播放，如果提前播放的时长大于动画总时长，动画直接过渡到终点。默认值：0

返回值：

类型	说明
SimpleAnimatorOptions	Animator简易动画参数对象。

示例：

import { Animator as animator, AnimatorResult, SimpleAnimatorOptions } from '@kit.ArkUI';

let options: SimpleAnimatorOptions = new SimpleAnimatorOptions(100, 200).delay(500);
let animatorResult:AnimatorResult = animator.create(options);

fill¹⁸⁺

fill(fillMode: FillMode): SimpleAnimatorOptions

设置animator动画填充方式。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
fillMode	FillMode	是	设置animator动画填充方式，影响动画delay期间和结束时的表现。默认值：FillMode.Forwards

返回值：

类型	说明
SimpleAnimatorOptions	Animator简易动画参数对象。

示例：

import { Animator as animator, AnimatorResult, SimpleAnimatorOptions } from '@kit.ArkUI';

let options: SimpleAnimatorOptions = new SimpleAnimatorOptions(100, 200).fill(FillMode.Forwards);
let animatorResult:AnimatorResult = animator.create(options);

direction¹⁸⁺

direction(direction: PlayMode): SimpleAnimatorOptions

设置animator动画播放方向。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
direction	PlayMode	是	设置animator动画播放方向。默认值：PlayMode.Normal

返回值：

类型	说明
SimpleAnimatorOptions	Animator简易动画参数对象。

示例：

import { Animator as animator, AnimatorResult, SimpleAnimatorOptions } from '@kit.ArkUI';

let options: SimpleAnimatorOptions = new SimpleAnimatorOptions(100, 200).direction(PlayMode.Alternate);
let animatorResult:AnimatorResult = animator.create(options);

iterations¹⁸⁺

iterations(iterations: number): SimpleAnimatorOptions

设置animator动画播放次数。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
iterations	number	是	设置animator动画播放次数，设置为0时不播放，设置为-1时无限次播放。默认值：1

返回值：

类型	说明
SimpleAnimatorOptions	Animator简易动画参数对象。

示例：

import { Animator as animator, AnimatorResult, SimpleAnimatorOptions } from '@kit.ArkUI';

let options: SimpleAnimatorOptions = new SimpleAnimatorOptions(100, 200).iterations(3);
let animatorResult:AnimatorResult = animator.create(options);

完整示例

基于JS扩展的类Web开发范式

<!-- hml -->
<div class="container">
  <div class="Animation" style="height: {{divHeight}}px; width: {{divWidth}}px; background-color: red;" onclick="Show">
  </div>
</div>

import { Animator as animator, AnimatorResult } from '@kit.ArkUI';
import { BusinessError } from '@kit.BasicServicesKit';

let DataTmp: Record<string, Animator> = {
  'divWidth': 200,
  'divHeight': 200,
  'animator': animator
}

class Tmp {
  data: animator = DataTmp
  onInit: Function = () => {
  }
  Show: Function = () => {
  }
}

class DateT {
  divWidth: number = 0
  divHeight: number = 0
  animator: AnimatorResult|null = null
}

(Fn: (v: Tmp) => void) => {
  Fn({
    data: DataTmp,
    onInit() {
      let options: AnimatorOptions = {
        duration: 1500,
        easing: "friction",
        delay: 0,
        fill: "forwards",
        direction: "normal",
        iterations: 2,
        begin: 200.0,
        end: 400.0
      };
      let DataTmp: DateT = {
        divWidth: 200,
        divHeight: 200,
        animator: null
      }
      DataTmp.animator = animator.create(options);
    },
    Show() {
      let options1: AnimatorOptions = {
        duration: 1500,
        easing: "friction",
        delay: 0,
        fill: "forwards",
        direction: "normal",
        iterations: 2,
        begin: 0,
        end: 400.0,
      };
      let DataTmp: DateT = {
        divWidth: 200,
        divHeight: 200,
        animator: null
      }
      try {
        DataTmp.animator = animator.create(options1);
        DataTmp.animator.reset(options1);
      } catch (error) {
        let message = (error as BusinessError).message
        let code = (error as BusinessError).code
        console.error(`Animator reset failed, error code: ${code}, message: ${message}.`);
      }
      let _this = DataTmp;
      if (DataTmp.animator) {
        DataTmp.animator.onFrame = (value: number) => {
          _this.divWidth = value;
          _this.divHeight = value;
        };
        DataTmp.animator.play();
      }
    }
  })
}

zh-cn_image_00007

基于ArkTS扩展的声明式开发范式

说明：

推荐通过使用UIContext中的createAnimator接口明确UI上下文。

import { AnimatorResult } from '@kit.ArkUI';

@Entry
@Component
struct AnimatorTest {
  private TAG: string = '[AnimatorTest]'
  private backAnimator: AnimatorResult|undefined = undefined
  private flag: boolean = false
  @State wid: number = 100
  @State hei: number = 100

  create() {
    this.backAnimator = this.getUIContext().createAnimator({
      // 建议使用 this.getUIContext().createAnimator()接口
      duration: 2000,
      easing: "ease",
      delay: 0,
      fill: "forwards",
      direction: "normal",
      iterations: 1,
      begin: 100, //动画插值起点
      end: 200 //动画插值终点
    })
    this.backAnimator.onFinish = () => {
      this.flag = true
      console.info(this.TAG, 'backAnimator onFinish')
    }
    this.backAnimator.onRepeat = () => {
      console.info(this.TAG, 'backAnimator repeat')
    }
    this.backAnimator.onCancel = () => {
      console.info(this.TAG, 'backAnimator cancel')
    }
    this.backAnimator.onFrame = (value: number) => {
      this.wid = value
      this.hei = value
    }
  }

  aboutToDisappear() {
    // 自定义组件消失时调用finish使未完成的动画结束，避免动画继续运行。
    // 由于backAnimator在onframe中引用了this, this中保存了backAnimator，
    // 在自定义组件消失时应该将保存在组件中的backAnimator置空，避免内存泄漏
    this.backAnimator?.finish();
    this.backAnimator = undefined;
  }

  build() {
    Column() {
      Column() {
        Column()
          .width(this.wid)
          .height(this.hei)
          .backgroundColor(Color.Red)
      }
      .width('100%')
      .height(300)

      Column() {
        Row() {
          Button('create')
            .fontSize(30)
            .fontColor(Color.Black)
            .onClick(() => {
              this.create()
            })
        }
        .padding(10)

        Row() {
          Button('play')
            .fontSize(30)
            .fontColor(Color.Black)
            .onClick(() => {
              this.flag = false
              if (this.backAnimator) {
                this.backAnimator.play()
              }
            })
        }
        .padding(10)

        Row() {
          Button('pause')
            .fontSize(30)
            .fontColor(Color.Black)
            .onClick(() => {
              if (this.backAnimator) {
                this.backAnimator.pause()
              }
            })
        }
        .padding(10)

        Row() {
          Button('finish')
            .fontSize(30)
            .fontColor(Color.Black)
            .onClick(() => {
              this.flag = true
              if (this.backAnimator) {
                this.backAnimator.finish()
              }
            })
        }
        .padding(10)

        Row() {
          Button('reverse')
            .fontSize(30)
            .fontColor(Color.Black)
            .onClick(() => {
              this.flag = false
              if (this.backAnimator) {
                this.backAnimator.reverse()
              }
            })
        }
        .padding(10)

        Row() {
          Button('cancel')
            .fontSize(30)
            .fontColor(Color.Black)
            .onClick(() => {
              if (this.backAnimator) {
                this.backAnimator.cancel()
              }
            })
        }
        .padding(10)

        Row() {
          Button('reset')
            .fontSize(30)
            .fontColor(Color.Black)
            .onClick(() => {
              if (this.flag) {
                this.flag = false
                if (this.backAnimator) {
                  this.backAnimator.reset({
                    duration: 3000,
                    easing: "ease-in",
                    delay: 0,
                    fill: "forwards",
                    direction: "alternate",
                    iterations: 3,
                    begin: 100,
                    end: 300
                  })
                }
              } else {
                console.info(this.TAG, 'Animation not ended')
              }
            })
        }
        .padding(10)
      }
    }
  }
}

位移动画示例（简易入参）

import { AnimatorResult, SimpleAnimatorOptions } from '@kit.ArkUI';

@Entry
@Component
struct AnimatorTest {
  private TAG: string = '[AnimatorTest]'
  private backAnimator: AnimatorResult|undefined = undefined
  private flag: boolean = false
  @State translate_: number = 0

  create() {
    this.backAnimator = this.getUIContext()?.createAnimator(
      new SimpleAnimatorOptions(0, 100)
    )
    this.backAnimator.onFinish = ()=> {
      this.flag = true
      console.info(this.TAG, 'backAnimator onFinish')
    }
    this.backAnimator.onFrame = (value:number)=> {
      this.translate_ = value
    }
  }

  aboutToDisappear() {
    // 自定义组件消失时调用finish使未完成的动画结束，避免动画继续运行。
    // 由于backAnimator在onframe中引用了this, this中保存了backAnimator，
    // 在自定义组件消失时应该将保存在组件中的backAnimator置空，避免内存泄漏
    this.backAnimator?.finish();
    this.backAnimator = undefined;
  }

  build() {
    Column() {
      Column() {
        Column()
          .width(100)
          .height(100)
          .translate({x: this.translate_})
          .backgroundColor(Color.Green)
      }
      .width('100%')
      .height(300)

      Column() {
        Column() {
          Button('create')
            .fontSize(30)
            .fontColor(Color.Black)
            .onClick(() => {
              this.create()
            })
        }
        .padding(10)

        Column() {
          Button('play')
            .fontSize(30)
            .fontColor(Color.Black)
            .onClick(() => {
              this.flag = false
              if(this.backAnimator){
                this.backAnimator.play()
              }
            })
        }
        .padding(10)

        Column() {
          Button('reset')
            .fontSize(30)
            .fontColor(Color.Black)
            .onClick(() => {
              if (this.flag) {
                this.flag = false
                if(this.backAnimator){
                  this.backAnimator.reset(
                    new SimpleAnimatorOptions(0, -100)
                      .duration(2000)
                      .easing("ease-in")
                      .fill(FillMode.Forwards)
                      .direction(PlayMode.Alternate)
                      .iterations(2)
                  )
                }
              } else {
                console.info(this.TAG, 'Animation not ended')
              }
            })
        }
        .padding(10)
      }
    }
  }
}

animator

你可能感兴趣的鸿蒙文章

harmony 鸿蒙ArkUI（方舟UI框架）

harmony 鸿蒙ARKUI_TextPickerCascadeRangeContent

harmony 鸿蒙ARKUI_TextPickerRangeContent

harmony 鸿蒙ArkUI_AnimateCompleteCallback

harmony 鸿蒙ArkUI_AttributeItem

harmony 鸿蒙ArkUI_ColorStop

harmony 鸿蒙ArkUI_ContextCallback

harmony 鸿蒙ArkUI_EventModule

harmony 鸿蒙ArkUI_ExpectedFrameRateRange

harmony 鸿蒙ArkUI_IntOffset

0 赞

所属分类： 后端技术
本文标签：
版权声明： 原创文章如转载，请注明本文链接: https://m.seaxiang.com/blog/hUSCaB

harmony 鸿蒙@ohos.animator (动画)

@ohos.animator (动画)

导入模块

Animator

create(deprecated)

create18+

createAnimator(deprecated)

AnimatorResult

reset9+

reset18+

play

finish

pause

cancel

reverse

onFrame12+

onFinish12+

onCancel12+

onRepeat12+

onframe(deprecated)

onfinish(deprecated)

oncancel(deprecated)

onrepeat(deprecated)

setExpectedFrameRateRange12+

update(deprecated)

AnimatorOptions

SimpleAnimatorOptions18+

constructor18+

duration18+

easing18+

delay18+

fill18+

direction18+

iterations18+

完整示例

基于JS扩展的类Web开发范式

基于ArkTS扩展的声明式开发范式

位移动画示例（简易入参）

你可能感兴趣的鸿蒙文章

热门推荐

标签云

最新文章

本文目录

create^(deprecated)

create¹⁸⁺

createAnimator^(deprecated)

reset⁹⁺

reset¹⁸⁺

onFrame¹²⁺

onFinish¹²⁺

onCancel¹²⁺

onRepeat¹²⁺

onframe^(deprecated)

onfinish^(deprecated)

oncancel^(deprecated)

onrepeat^(deprecated)

setExpectedFrameRateRange¹²⁺

update^(deprecated)

SimpleAnimatorOptions¹⁸⁺

constructor¹⁸⁺

duration¹⁸⁺

easing¹⁸⁺

delay¹⁸⁺

fill¹⁸⁺

direction¹⁸⁺

iterations¹⁸⁺