ImageAnimator

About 8 min

ImageAnimator

说明: 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。

提供帧动画组件来实现逐帧播放图片的能力,可以配置需要播放的图片列表,每张图片可以配置时长。

权限列表

子组件

接口

ImageAnimator()

属性

参数名称

参数类型

默认值

必填

参数描述

images

Array<{

src:string,

width?:Length,

height?:Length,

top?:Length,

left?:Length,

duration?:number

}>

[]

设置图片帧信息集合。每一帧的帧信息包含图片路径、图片大小、图片位置和图片播放时长信息。详细说明如下:

src:图片路径,图片格式为svg,png和jpg。

width:图片宽度。

height:图片高度。

top:图片相对于组件左上角的纵向坐标。

left:图片相对于组件左上角的横向坐标。

duration:每一帧图片的播放时长,单位毫秒。

state

AnimationStatus

Initial

默认为初始状态,用于控制播放状态。

duration

number

1000

单位为毫秒,默认时长为1000ms;duration为0时,不播放图片;值的改变只会在下一次循环开始时生效;当images中设置了单独的duration后,该属性设置无效。

reverse

boolean

false

设置播放顺序。false表示从第1张图片播放到最后1张图片; true表示从最后1张图片播放到第1张图片。

fixedSize

boolean

true

设置图片大小是否固定为组件大小。 true表示图片大小与组件大小一致,此时设置图片的width 、height 、top 和left属性是无效的。false表示每一张图片的 width 、height 、top和left属性都要单独设置。

preDecode

number

0

是否启用预解码,默认值为0,即不启用预解码,如该值设为2,则播放当前页时会提前加载后面两张图片至缓存以提升性能。

fillMode

FillMode

Forwards

设置动画开始前和结束后的状态,可选值参见FillMode说明。

iterations

number

1

默认播放一次,设置为-1时表示无限次播放。

  • AnimationStatus枚举说明

    名称

    描述

    Initial

    动画初始状态

    Running

    动画处于播放状态。

    Paused

    动画处于暂停状态。

    Stopped

    动画处于停止状态。

  • FillMode枚举值说明

    名称

    描述

    None

    播放完成后恢复初始状态。

    Forwards

    播放完成后保持动画结束时的状态。

    Backwards

    在animation-delay所指定的一段时间内,在动画显示之前,应用开始属性值。

    Both

    向前和向后填充模式都被应用。

事件

名称

功能描述

onStart() => void

状态回调,动画开始播放时触发。

onPause() => void

状态回调,动画暂停播放时触发。

onRepeat() => void

状态回调,动画重新播放时触发。

onCancel() => void

状态回调,动画取消播放时触发。

onFinish() => void

状态回调,动画播放完成时触发。

示例

@Entry
@Component
struct ImageAnimatorExample {
  @State state: AnimationStatus = AnimationStatus.Initial
  @State reverse: boolean = false
  @State iterations: number = 1

  build() {
    Column({ space:5 }) {
      ImageAnimator()
        .images([
          {
            src: '/comment/bg1.jpg',
            duration: 500,
            width: 325,
            height: 200,
            top: 0,
            left: 0
          },
          {
            src: '/comment/bg2.jpg',
            duration: 500,
            width: 325,
            height: 200,
            top: 0,
            left: 0
          },
          {
            src: '/comment/bg3.jpg',
            duration: 500,
            width: 325,
            height: 200,
            top: 0,
            left: 0
          },
          {
            src: '/comment/bg4.jpg',
            duration: 500,
            width: 325,
            height: 200,
            top: 0,
            left: 0
          }
        ])
        .state(this.state).reverse(this.reverse).fixedSize(false).preDecode(2)
        .fillMode(FillMode.None).iterations(this.iterations).width(325).height(210)
        .margin({top:100})
        .onStart(() => { // 当帧动画开始播放后触发
          console.info('Start')
        })
        .onPause(() => {
          console.info('Pause')
        })
        .onRepeat(() => {
          console.info('Repeat')
        })
        .onCancel(() => {
          console.info('Cancel')
        })
        .onFinish(() => { // 当帧动画播放完成后触发
          console.info('Finish')
        })
      Row() {
        Button('start').width(100).padding(5).onClick(() => {
          this.state = AnimationStatus.Running
        })
        Button('pause').width(100).padding(5).onClick(() => {
          this.state = AnimationStatus.Paused
        })
        Button('stop').width(100).padding(5).onClick(() => {
          this.state = AnimationStatus.Stopped
        })
      }
      Row() {
        Button('reverse').width(100).padding(5).onClick(() => {
          this.reverse = !this.reverse
        })
        Button('once').width(100).padding(5).onClick(() => {
          this.iterations = 1
        })
        Button('iteration').width(100).padding(5).onClick(() => {
          this.iterations = -1
        })
      }
    }.width('100%').height('100%').backgroundColor(0xF1F3F5)
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87