
OpenHarmony应用开发-基础组件ImageAnimator/Marquee/MenuItem
版本:v3.2 Release
ImageAnimator
提供帧动画组件来实现逐帧播放图片的能力,可以配置需要播放的图片列表,每张图片可以配置时长。
说明:
该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
子组件
无
接口
ImageAnimator()
属性
除支持通用属性外,还支持以下属性:
参数名称 | 参数类型 | 参数描述 |
images | Array<ImageFrameInfo> | 设置图片帧信息集合。每一帧的帧信息(ImageFrameInfo)包含图片路径、图片大小、图片位置和图片播放时长信息,详见ImageFrameInfo属性说明。 默认值:[] 说明: 不支持动态更新。 |
state | 默认为初始状态,用于控制播放状态。 默认值:AnimationStatus.Initial | |
duration | number | 单位为毫秒,默认时长为1000ms;duration为0时,不播放图片;值的改变只会在下一次循环开始时生效;当images中任意一帧图片设置了单独的duration后,该属性设置无效。 默认值:1000 |
reverse | boolean | 设置播放顺序。false表示从第1张图片播放到最后1张图片; true表示从最后1张图片播放到第1张图片。 默认值:false |
fixedSize | boolean | 设置图片大小是否固定为组件大小。 true表示图片大小与组件大小一致,此时设置图片的width 、height 、top 和left属性是无效的。false表示每一张图片的width 、height 、top和left属性都要单独设置。 默认值:true |
preDecode(deprecated) | number | 预解码的图片数量。例如该值设为2,则播放当前页时会提前加载后面两张图片至缓存以提升性能。 从API version9开始废弃。 默认值:0 |
fillMode | 设置动画开始前和结束后的状态,可选值参见FillMode说明。 默认值:FillMode.Forwards | |
iterations | number | 默认播放一次,设置为-1时表示无限次播放。 默认值:1 |
ImageFrameInfo对象说明
参数名称 | 参数类型 | 必填 | 参数描述 |
src | string | Resource9+ | 是 | 图片路径,图片格式为svg,png和jpg,从API Version9开始支持Resource类型的路径。 |
width | number | string | 否 | 图片宽度。 默认值:0 |
height | number | string | 否 | 图片高度。 默认值:0 |
top | number | string | 否 | 图片相对于组件左上角的纵向坐标。 默认值:0 |
left | number | string | 否 | 图片相对于组件左上角的横向坐标。 默认值:0 |
duration | number | 否 | 每一帧图片的播放时长,单位毫秒。 默认值:0 |
事件
除支持通用事件外,还支持以下事件:
名称 | 功能描述 |
onStart(event: () => void) | 状态回调,动画开始播放时触发。 |
onPause(event: () => void) | 状态回调,动画暂停播放时触发。 |
onRepeat(event: () => void) | 状态回调,动画重复播放时触发。 |
onCancel(event: () => void) | 状态回调,动画取消播放时触发。 |
onFinish(event: () => void) | 状态回调,动画播放完成时触发。 |
示例
LoadingProgress
用于显示加载动效的组件。
说明:
该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
子组件
无
接口
LoadingProgress()
创建加载进展组件。
从API version 9开始,该接口支持在ArkTS卡片中使用。
属性
名称 | 参数类型 | 描述 |
color | 设置加载进度条前景色。 从API version 9开始,该接口支持在ArkTS卡片中使用。 |
示例
Marquee
跑马灯组件,用于滚动展示一段单行文本,仅当文本内容宽度超过跑马灯组件宽度时滚动。
说明:
该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
子组件
无
接口
Marquee(value: { start: boolean, step?: number, loop?: number, fromStart?: boolean, src: string })
从API version 9开始,该接口支持在ArkTS卡片中使用。
参数:
参数名 | 参数类型 | 必填 | 参数描述 |
start | boolean | 是 | 控制跑马灯是否进入播放状态。 |
step | number | 否 | 滚动动画文本滚动步长。 默认值:6,单位vp |
loop | number | 否 | 设置重复滚动的次数,小于等于零时无限循环。 默认值:-1 说明: ArkTS卡片上该参数设置任意值都仅在可见时滚动一次。 |
fromStart | boolean | 否 | 设置文本从头开始滚动或反向滚动。 默认值:true |
src | string | 是 | 需要滚动的文本。 |
属性
名称 | 参数类型 | 描述 |
allowScale | boolean | 是否允许文本缩放。 默认值:false 从API version 9开始,该接口支持在ArkTS卡片中使用。 |
事件
名称 | 功能描述 |
onStart(event: () => void) | 开始滚动时触发回调。 从API version 9开始,该接口支持在ArkTS卡片中使用。 |
onBounce(event: () => void) | 完成一次滚动时触发,若循环次数不为1,则该事件会多次触发。 从API version 9开始,该接口支持在ArkTS卡片中使用。 |
onFinish(event: () => void) | 滚动全部循环次数完成时触发回调。 从API version 9开始,该接口支持在ArkTS卡片中使用。 |
示例
Menu
以垂直列表形式显示的菜单。
说明:
该组件从API Version 9开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
子组件
包含MenuItem、MenuItemGroup子组件。
接口
Menu()
作为菜单的固定容器,无参数。
属性
除支持通用属性外,还支持以下属性:
名称 | 参数类型 | 描述 |
fontSize | Length | 统一设置Menu中所有文本的尺寸,Length为number类型时,使用fp单位。 |
示例
MenuItem
用来展示菜单Menu中具体的item菜单项。
说明:
该组件从API Version 9开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
子组件
无
接口
MenuItem(value?: MenuItemOptions| CustomBuilder)
参数:
参数 | 类型 | 必填 | 参数描述 |
value | MenuItemOptions | CustomBuilder | 否 | 包含设置MenuItem的各项信息。 |
MenuItemOptions类型说明
名称 | 类型 | 必填 | 描述 |
startIcon | 否 | item中显示在左侧的图标信息路径。 | |
content | 是 | item的内容信息。 | |
endIcon | 否 | item中显示在右侧的图标信息路径。 | |
labelInfo | 否 | 定义结束标签信息,如快捷方式Ctrl+C等。 | |
builder | 否 | 用于构建二级菜单。 |
属性
除支持通用属性外,还支持以下属性:
名称 | 参数类型 | 描述 |
selected | boolean | 设置菜单项是否选中。 默认值:false |
selectIcon | boolean | 当菜单项被选中时,是否显示被选中的图标。 |
事件
名称 | 参数类型 | 描述 |
onChange | (selected: boolean) => void | 当选中状态发生变化时,触发该回调。只有手动触发且MenuItem状态改变时才会触发onChange回调。 - value为true时,表示已选中。 - value为false时,表示未选中。 |
示例
详见Menu组件示例。
MenuItemGroup
该组件用来展示菜单MenuItem的分组。
说明:
该组件从API Version 9开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
子组件
包含MenuItem子组件。
接口
MenuItemGroup(value?: MenuItemGroupOptions)
参数:
参数 | 类型 | 必填 | 参数描述 |
value | 否 | 包含设置MenuItemGroup的标题和尾部显示信息。 |
MenuItemGroupOptions类型说明
名称 | 类型 | 必填 | 描述 |
header | ResourceStr | CustomBuilder | 否 | 设置对应group的标题显示信息。 |
footer | ResourceStr | CustomBuilder | 否 | 设置对应group的尾部显示信息。 |
示例
详见Menu组件示例。
