
HarmonyOS API:@ohos.animator (动画)
版本:v3.1 Beta
@ohos.animator (动画)
更新时间: 2023-02-17 09:19
本模块提供组件动画效果,包括定义动画、启动动画和以相反的顺序播放动画等。
说明
本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
导入模块
create9+
create(options: AnimatorOptions): AnimatorResult
定义Animator类。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名 | 类型 | 必填 | 说明 |
options | 是 | 定义动画选项。 |
返回值:
类型 | 说明 |
Animator结果接口。 |
示例:
AnimatorResult
定义Animator结果接口。
reset9+
reset(options: AnimatorOptions): void
更新当前动画器。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名 | 类型 | 必填 | 说明 |
options | 是 | 定义动画选项。 |
错误码:
以下错误码的详细介绍请参见ohos.animator(动画)错误码。
错误码ID | 错误信息 |
100001 | if no page is found for pageId or fail to get object property list. |
示例:
play
play(): void
启动动画。动画会保留上一次的播放状态,比如播放状态设置reverse后,再次播放会保留reverse的播放状态。
系统能力: SystemCapability.ArkUI.ArkUI.Full
示例:
finish
finish(): void
结束动画。
系统能力: SystemCapability.ArkUI.ArkUI.Full
示例:
pause
pause(): void
暂停动画。
系统能力: SystemCapability.ArkUI.ArkUI.Full
示例:
cancel
cancel(): void
删除动画。
系统能力: SystemCapability.ArkUI.ArkUI.Full
示例:
reverse
reverse(): void
以相反的顺序播放动画。
系统能力: SystemCapability.ArkUI.ArkUI.Full
示例:
onframe
onframe: (progress: number) => void
接收到帧时回调。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名 | 类型 | 必填 | 说明 |
progress | number | 是 | 动画的当前进度。 |
示例:
onfinish
onfinish: () => void
动画完成时回调。
系统能力: SystemCapability.ArkUI.ArkUI.Full
示例:
oncancel
oncancel: () => void
动画被取消时回调。
系统能力: SystemCapability.ArkUI.ArkUI.Full
示例:
onrepeat
onrepeat: () => void
动画重复时回调。
系统能力: SystemCapability.ArkUI.ArkUI.Full
示例:
AnimatorOptions
定义动画选项。
系统能力: SystemCapability.ArkUI.ArkUI.Full
名称 | 类型 | 必填 | 说明 |
duration | number | 是 | 动画播放的时长,单位毫秒。 |
easing | string | 是 | 动画插值曲线。 |
delay | number | 是 | 动画延时播放时长,单位毫秒,即不延时。 |
fill | "none" | "forwards" | "backwards" | "both" | 是 | 动画执行后是否恢复到初始状态。动画执行后,动画结束时的状态(在最后一个关键帧中定义)将保留。 |
direction | "normal" | "reverse" | "alternate" | "alternate-reverse" | 是 | 动画播放模式。 |
iterations | number | 是 | 动画播放次数。设置为0时不播放,设置为-1时无限次播放。 |
begin | number | 是 | 动画插值起点。 |
end | number | 是 | 动画插值终点。 |
完整示例
基于JS扩展的类Web开发范式
基于TS扩展的声明式开发范式
update(deprecated)
update(options: AnimatorOptions): void
更新当前动画器。
从API version9开始不再维护,建议使用reset9+
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名 | 类型 | 必填 | 说明 |
options | 是 | 定义动画选项。 |
示例:
createAnimator(deprecated)
createAnimator(options: AnimatorOptions): AnimatorResult
定义Animator类。
从API version9开始不再维护,建议使用create9+
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名 | 类型 | 必填 | 说明 |
options | 是 | 定义动画选项。 |
返回值:
类型 | 说明 |
Animator结果接口。 |
示例:
