未验证 提交 83fdc22c 编写于 作者: O openharmony_ci 提交者: Gitee

!18824 ImageAnimator组件补充ArkTs卡片说明

Merge pull request !18824 from HuangXW/ETSForm
......@@ -17,31 +17,33 @@
ImageAnimator()
从API version 10开始,该接口支持在ArkTS卡片中使用。
## 属性
除支持[通用属性](ts-universal-attributes-size.md)外,还支持以下属性:
| 参数名称 | 参数类型 |参数描述 |
| ---------- | ----------------------- |-------- |
| images | Array&lt;[ImageFrameInfo](#imageframeinfo对象说明)&gt; | 设置图片帧信息集合。每一帧的帧信息(ImageFrameInfo)包含图片路径、图片大小、图片位置和图片播放时长信息,详见ImageFrameInfo属性说明。<br/>默认值:[]<br/>**说明:**<br>不支持动态更新。 |
| state | [AnimationStatus](ts-appendix-enums.md#animationstatus) | 默认为初始状态,用于控制播放状态。<br/>默认值:AnimationStatus.Initial |
| duration | number | 单位为毫秒,默认时长为1000ms;duration为0时,不播放图片;值的改变只会在下一次循环开始时生效;当images中任意一帧图片设置了单独的duration后,该属性设置无效。<br/>默认值:1000 |
| reverse | boolean | 设置播放顺序。false表示从第1张图片播放到最后1张图片;&nbsp;true表示从最后1张图片播放到第1张图片。<br/>默认值:false |
| fixedSize | boolean | 设置图片大小是否固定为组件大小。&nbsp;true表示图片大小与组件大小一致,此时设置图片的width&nbsp;、height&nbsp;、top&nbsp;和left属性是无效的。false表示每一张图片的width&nbsp;、height&nbsp;、top和left属性都要单独设置。<br/>默认值:true |
| preDecode<sup>(deprecated)</sup> | number | 预解码的图片数量。例如该值设为2,则播放当前页时会提前加载后面两张图片至缓存以提升性能。<br/>从API version9开始废弃。<br/>默认值:0 |
| fillMode | [FillMode](ts-appendix-enums.md#fillmode) | 设置动画开始前和结束后的状态,可选值参见FillMode说明。<br/>默认值:FillMode.Forwards |
| iterations | number | 默认播放一次,设置为-1时表示无限次播放。<br/>默认值:1 |
| images | Array&lt;[ImageFrameInfo](#imageframeinfo对象说明)&gt; | 设置图片帧信息集合。每一帧的帧信息(ImageFrameInfo)包含图片路径、图片大小、图片位置和图片播放时长信息,详见ImageFrameInfo属性说明。<br/>默认值:[]<br/>**说明:**<br>不支持动态更新。<br/>从API version 10开始,该接口支持在ArkTS卡片中使用。 |
| state | [AnimationStatus](ts-appendix-enums.md#animationstatus) | 默认为初始状态,用于控制播放状态。<br/>默认值:AnimationStatus.Initial <br/>从API version 10开始,该接口支持在ArkTS卡片中使用。 |
| duration | number | 单位为毫秒,默认时长为1000ms;duration为0时,不播放图片;值的改变只会在下一次循环开始时生效;当images中任意一帧图片设置了单独的duration后,该属性设置无效。<br/>默认值:1000 <br/>从API version 10开始,该接口支持在ArkTS卡片中使用。 |
| reverse | boolean | 设置播放顺序。false表示从第1张图片播放到最后1张图片;&nbsp;true表示从最后1张图片播放到第1张图片。<br/>默认值:false <br/>从API version 10开始,该接口支持在ArkTS卡片中使用。 |
| fixedSize | boolean | 设置图片大小是否固定为组件大小。&nbsp;true表示图片大小与组件大小一致,此时设置图片的width&nbsp;、height&nbsp;、top&nbsp;和left属性是无效的。false表示每一张图片的width&nbsp;、height&nbsp;、top和left属性都要单独设置。<br/>默认值:true <br/>从API version 10开始,该接口支持在ArkTS卡片中使用。 |
| preDecode<sup>(deprecated)</sup> | number | 预解码的图片数量。例如该值设为2,则播放当前页时会提前加载后面两张图片至缓存以提升性能。<br/>从API version9开始废弃。<br/>默认值:0 |
| fillMode | [FillMode](ts-appendix-enums.md#fillmode) | 设置动画开始前和结束后的状态,可选值参见FillMode说明。<br/>默认值:FillMode.Forwards <br/>从API version 10开始,该接口支持在ArkTS卡片中使用。 |
| iterations | number | 默认播放一次,设置为-1时表示无限次播放。<br/>默认值:1 |
## ImageFrameInfo对象说明
| 参数名称 | 参数类型 | 必填 | 参数描述 |
| -------- | -------------- | -------- | -------- |
| src | string \| [Resource](ts-types.md#resource)<sup>9+</sup> | 是 | 图片路径,图片格式为svg,png和jpg,从API Version9开始支持[Resource](ts-types.md#resource)类型的路径。|
| width | number&nbsp;\|&nbsp;string | 否 | 图片宽度。<br/>默认值:0 |
| height | number&nbsp;\|&nbsp;string | 否 | 图片高度。<br/>默认值:0 |
| top | number&nbsp;\|&nbsp;string | 否 | 图片相对于组件左上角的纵向坐标。<br/>默认值:0 |
| left | number&nbsp;\|&nbsp;string | 否 | 图片相对于组件左上角的横向坐标。<br/>默认值:0 |
| duration | number | 否 | 每一帧图片的播放时长,单位毫秒。<br/>默认值:0 |
| src | string \| [Resource](ts-types.md#resource)<sup>9+</sup> | 是 | 图片路径,图片格式为svg,png和jpg,从API Version9开始支持[Resource](ts-types.md#resource)类型的路径。 <br/>从API version 10开始,该接口支持在ArkTS卡片中使用。|
| width | number&nbsp;\|&nbsp;string | 否 | 图片宽度。<br/>默认值:0 <br/>从API version 10开始,该接口支持在ArkTS卡片中使用 |
| height | number&nbsp;\|&nbsp;string | 否 | 图片高度。<br/>默认值:0 <br/>从API version 10开始,该接口支持在ArkTS卡片中使用 |
| top | number&nbsp;\|&nbsp;string | 否 | 图片相对于组件左上角的纵向坐标。<br/>默认值:0 <br/>从API version 10开始,该接口支持在ArkTS卡片中使用 |
| left | number&nbsp;\|&nbsp;string | 否 | 图片相对于组件左上角的横向坐标。<br/>默认值:0 <br/>从API version 10开始,该接口支持在ArkTS卡片中使用 |
| duration | number | 否 | 每一帧图片的播放时长,单位毫秒。<br/>默认值:0 |
## 事件
......@@ -49,11 +51,11 @@ ImageAnimator()
| 名称 | 功能描述 |
| -------- | -------- |
| onStart(event:&nbsp;()&nbsp;=&gt;&nbsp;void) | 状态回调,动画开始播放时触发。 |
| onPause(event:&nbsp;()&nbsp;=&gt;&nbsp;void) | 状态回调,动画暂停播放时触发。 |
| onRepeat(event:&nbsp;()&nbsp;=&gt;&nbsp;void) | 状态回调,动画重复播放时触发。 |
| onCancel(event:&nbsp;()&nbsp;=&gt;&nbsp;void) | 状态回调,动画取消播放时触发。 |
| onFinish(event:&nbsp;()&nbsp;=&gt;&nbsp;void) | 状态回调,动画播放完成时触发。 |
| onStart(event:&nbsp;()&nbsp;=&gt;&nbsp;void) | 状态回调,动画开始播放时触发。 <br/>从API version 10开始,该接口支持在ArkTS卡片中使用。 |
| onPause(event:&nbsp;()&nbsp;=&gt;&nbsp;void) | 状态回调,动画暂停播放时触发。 <br/>从API version 10开始,该接口支持在ArkTS卡片中使用。 |
| onRepeat(event:&nbsp;()&nbsp;=&gt;&nbsp;void) | 状态回调,动画重复播放时触发。 |
| onCancel(event:&nbsp;()&nbsp;=&gt;&nbsp;void) | 状态回调,动画取消播放时触发。 <br/>从API version 10开始,该接口支持在ArkTS卡片中使用。 |
| onFinish(event:&nbsp;()&nbsp;=&gt;&nbsp;void) | 状态回调,动画播放完成时触发。 <br/>从API version 10开始,该接口支持在ArkTS卡片中使用。 |
## 示例
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册