Skip to content

API

方法

init(data)

初始化list-view组件,有返回值,操作返回值更新视图

参数名类型说明
dataArray列表数据集合

注意: 获取基本类型数据可以直接操作返回值使用,获取引用类型数据可以通过JSON.parse(JSON.stringify(返回值))获取;

点击查看源码
js
  初始化 let returnVal = this.$refs.list_view.init(data)

init返回值相关API

function说明
pushreturnVal.push({单条数据}) returnVal.push(...[多条数据])
popreturnVal.pop() 末尾删除一条item
concatreturnVal.concat() 链接returnVal数据
splice(1个参数)删除 returnVal.splice(1) 从第一项开始删除之后所有item
splice(2个参数)删除 returnVal.splice(1,2) 从第1个开始 删除2条item
splice(3个参数-替换)returnVal.splice(4, 2, data) 从索引位置 4 开始,替换两个元素,替换的data (当三个参数第二个参数不为0时 为替换)
splice(3个参数-插入)returnVal.splice(4, 0, data) 从索引位置 4 开始,替换0,插入的data (当三个参数第二个参数为0时 为插入)仅支持runtime版本 2.3+
deleteItemreturnVal.deleteItem(id,number) //第一个参数是item的 id(初始化data中的数据必须包含id) 第二个参数是从包括id之后删除的个数
forEachreturnVal.forEach(el => {el.assetTitle = '修改assetTitle'}) //循环修改每个item的值 整体更新


scrollToTop()

列表滑动到顶部

点击查看源码
js
  this.$refs.list_view.scrollToTop()

setDisplay(display)

设置列表是否显示

参数名类型说明
displayBoolean是否显示

点击查看源码
js
  this.$refs.list_view.setDisplay(false)

scrollToPosition(index)

滑动到指定位置

参数名类型说明
indexInt要滑到的位置

点击查看源码
js
  this.$refs.list_view.scrollToPosition(index)

scrollToIndex(y, anim, offsetndex)

滑动到指定位置并附带动画和偏移量

参数名类型说明
yInt要滑到的位置
animBoolean是否开启动画
offsetndexInt偏移量

点击查看源码
js
  this.$refs.list_view.scrollToIndex(y, anim, offsetndex)

setItemFocused(pos)

设置指定子Item获取焦点

参数名类型说明
posInt子Item位置

点击查看源码
js
  this.$refs.list_view.setItemFocused(pos)

setItemSelected(pos,b)

设置选中的子item,注意此方法只在view已经显示出来以后调用才有效

参数名类型说明
posInt要选中的子View位置
bBoolean设置要选中的子View的焦点

点击查看源码
js
  this.$refs.list_view.setItemSelected(pos, b)

stopPage()

当在分页加载完数据时,调用该方法停止分页关闭进度条样式

点击查看源码
js
  this.$refs.list_view.stopPage()

事件

@item-click

Item点击事件回调

参数名类型说明
positionInt点击Item的位置(在子布局里)
parentPositionInt点击Item的在父布局中的位置
nameString点击Item的name类型
itemObject当前点击item绑定的数据

@item-focused

Item焦点事件回调

参数名类型说明
positionInt焦点所在Item的位置(在子布局里)
parentPositionInt焦点所在Item的在父布局中的位置
hasFocusBoolean焦点所在Item是否获得焦点
nameString点击Item的name类型
itemObject当前点击item绑定的数据

@item-bind

Item绑定事件回调

参数名类型说明
positionInt绑定Item的位置
nameString绑定Item的name

@item-unbind

Item解除绑定事件回调

参数名类型说明
positionInt解除绑定Item的位置
nameString解除绑定Item的name

@scroll

列表滑动onScroll事件回调

参数名类型说明
contentOffsetMap滑动参数

contentOffset参数:

参数名类型说明
xFloat列表滑动x轴偏移量
yFloat列表滑动y轴偏移量

@scroll-state-changed

列表滑动onScrollStateChanged事件回调

参数名类型说明
contentOffsetMap滑动参数
stateMap滑动状态

contentOffset参数:

参数名类型说明
xFloat列表滑动x轴偏移量
yFloat列表滑动y轴偏移量

state参数:

参数名类型说明
oldStateInt之前列表滑动状态
newStateInt当前列表滑动状态

@focus-search-failed

列表寻焦失败事件回调

参数名类型说明
childMap当前焦点所在item
focusedMap焦点将要落在item
directionInt滑动方向

child参数:

参数名类型说明
indexInt当前item的位置
idInt当前item的id
nameString当前item的name

focused参数:

参数名类型说明
idInt焦点将要落在item的id
nameString焦点将要落在item的name

注意事项

  1. horizontaladvancedFocusSearchSpanpadding属性不可动态改变,这三个在list-view初始化时就确定;

  2. 要实现onItemClickonItemFocus回调,需要在item中加上属性eventClickeventFocus,这样才能让item响应点击和焦点事件;

  3. :scrollThresholdHorizontal:scrollThresholdVertical属性的生效条件是:makeChildVisibleType='center';