方法 / 定制
better-scroll 还提供了一些定制的方法,专门用来实现某一个 feature 所用。
goToPage(x, y, time, easing)
- 参数
- {Number} x 横轴的页数
- {Number} y 纵轴的页数
- {Number} time 动画执行的时间
- {Object} easing 缓动函数,一般不建议修改,如果想修改,参考源码中的 ease.js 里的写法
- 返回值:无
- 作用:当我们做 slide 组件的时候,slide 通常会分成多个页面。调用此方法可以滚动到指定的页面。
next(time, easing)
- 参数:
- {Number} time 动画执行的时间
- {Object} easing 缓动函数,一般不建议修改,如果想修改,参考源码中的 ease.js 里的写法
- 返回值:无
- 作用:滚动到下一个页面
prev(time, easing)
- 参数:
- {Number} time 动画执行的时间
- {Object} easing 缓动函数,一般不建议修改,如果想修改,参考源码中的 ease.js 里的写法
- 返回值:无
- 作用:滚动到上一个页面
getCurrentPage()
- 参数:无
- 返回值:{Object}
{ x: posX, y: posY,pageX: x, pageY: y}
其中,x 和 y 表示偏移的坐标值,pageX 和 pageY 表示横轴方向和纵轴方向的页面数。 - 作用:获取当前页面的信息。
wheelTo(index)
- 参数:
- {Number} index 索引值
- 返回值:无
- 作用:当我们做 picker 组件的时候,调用该方法可以滚动到索引对应的位置。
getSelectedIndex()
- 参数:无
- 返回值:{Number} 当前选中的索引值。
- 作用:获取当前选中的索引值。
finishPullDown()
- 参数:无
- 返回值:无
- 作用:当下拉刷新数据加载完毕后,需要调用此方法告诉 better-scroll 数据已加载。
openPullDown(config) (v1.9.0+)
- 参数:
- {Object} config,参考
pullDownRefresh
的配置,默认为 true。
- {Object} config,参考
- 返回值:无
- 作用:动态开启下拉刷新功能。
closePullDown() (v1.9.0+)
- 参数:无
- 返回值:无
- 作用:动态关闭下拉刷新功能。
autoPullDownRefresh() (v1.14.0)
- 参数:无
- 返回值:无
- 作用:自动触发下拉刷新。
finishPullUp()
- 参数:无
- 返回值:无
- 作用:当上拉加载数据加载完毕后,需要调用此方法告诉 better-scroll 数据已加载。
openPullUp(config) (v1.9.0+)
- 参数:
- {Object} config,参考
pullUpLoad
的配置,默认为 true。
- {Object} config,参考
- 返回值:无
- 作用:动态开启上拉加载功能。
closePullUp() (v1.9.0+)
- 参数:无
- 返回值:无
- 作用:动态关闭上拉加载功能。
zoomTo(scale, x, y) (v1.12.0+)
- 参数:
{Number} scale
, 缩放大小.{Number} x
, 缩放原点的横坐标, 相对于整个文档的左边距。{Number} y
, 缩放原点的纵坐标, 相对于整个文档的上边距。
- 返回值: 无
- 作用: 将滚动体缩放到指定的大小。