UIListBook
open close show hide setAttr getIndex getDataByIndex setSwipeBtns reloadData deleteItem updateItem appendData getCount setRefreshHeader setRefreshFooter sort cancelOrder closeMenu setStyle cancelStyle
概述
UIListBook 插件封装了一个数据列表控件，列表项水平侧滑可出现控制按钮；开发者可自定义列表的数据源，及列表的样式，支持列表项的增、删、改、查，支持批量更新、追加数据，支持下拉刷新和上拉加载事件
注意：本插件 iOS 平台上最低适配系统版本为 iOS 9.0
open
打开 UIListBook 插件
open({params}, callback(ret, err))
params
rect：
- 类型：JSON 对象
- 描述：（可选项）插件的位置及尺寸
- 备注：Android 必须传此参数。
- 内部字段：
{
x: 0, //（可选项）数字类型；插件左上角的 x 坐标（相对于所属的 Window 或 Frame）；默认值：0
y: 0, //（可选项）数字类型；插件左上角的 y 坐标（相对于所属的 Window 或 Frame）；默认值：0
w: 320, //（可选项）数字类型；支持设置'auto'；插件的宽度；默认值：所属的 Window 或 Frame 的宽度
h: 480 //（可选项）数字类型；支持设置'auto'；插件的高度；默认值：所属的 Window 或 Frame 的高度
}
data：
- 类型：数组
- 描述：列表的数据源，开发者可以自定义唯一的键值对信息（如：uid: '1001'），供 getIndex 使用
- 内部字段：
[{
imgPath: '', //（可选项）字符串类型；列表项的配图路径，支持http://、https://、widget://、fs://等协议，网络图片会被缓存到本地
title: '', //（可选项）字符串类型；标题，
subTitle: '', //（可选项）字符串类型；子标题，
label: '', //（可选项）字符串类型；标签
subLabel: '', //（可选项）字符串类型；子标签
grop: '', //（可选项）字符串类型；分组
time: '', //（可选项）字符串类型；时间
icon: '', //（可选项）字符串类型；右侧按钮图标路径（本地路径，支持fs://、widget://）
chooseIcon: '', //（可选项）字符串类型；右侧按钮弹出扇形页面图标情况下路径，图片时扇形一部分，扇形消失，图片就消失，不需要扇形时不要设置此路径（本地路径，支持fs://、widget://）；默认：icon设置路径
rightBtns: [] //（可选项）数组类型；列表项向左滑动露出的按钮组，配置某一项的特定按钮组，若不传则显示通用按钮，内部字段同下方 rightBtns 参数
}]
rightBtns：
- 类型：数组
- 描述：（可选项）列表项向左滑动露出的按钮组，建议：配置列表每项的通用按钮，用此参数；配置某一项的特定按钮，可在
data数组的指定项传入rightBtns参数 - 内部字段：
[{
bgColor: '#388e8e', //（可选项）字符串类型；按钮背景色，支持 rgb、rgba、#；默认：'#388e8e'
width: 70, //（可选项）数字类型；按钮的宽度；默认：w / 4
title: '', //（可选项）字符串类型；按钮标题，水平、垂直居中
titleSize: 12, //（可选项）数字类型；按钮标题文字大小；默认：12
titleColor: '#fff', //（可选项）字符串类型；按钮标题文字颜色，支持 rgb、rgba、#；默认：'#ffffff'
icon: '', //（可选项）字符串类型；按钮标题前的图标路径（本地路径，支持fs://、widget://），水平、垂直居中，图标为正方形
iconWidth: 20 //（可选项）数字类型；按钮标题前的图标宽度，图标为正方形；默认：20
}]
bounces:
- 类型：布尔
- 描述：（可选项）是否开启弹动，android 平台不支持本参数
- 默认：false
styles:
- 类型：JSON 对象
- 描述：（可选项）插件各部分的样式
- 内部字段：
{
borderColor: '#EEEEEE', //（可选项）字符串类型；列表分割线的颜色，支持 rgb、rgba、#；默认：'#EEEEEE'
borderHigh: 1, //（可选项）数字类型；列表分割线的高度；默认：1
borderLeftMargin:15,//（可选项）数字类型;列表分割线的左边距；默认：列表项的配图的最左边
borderRightMargin:0,//（可选项）数字类型;列表分割线的右边距；默认：索引的最左边
marginLeft:15, //（可选项）数字类型；列表项的(左上方索引,配图)的左边距；默认：15
item: { //（可选项）JSON对象；列表项的样式
bgColor: '#FFFFFF', //（可选项）字符串类型；列表项的背景色，支持 rgb、rgba、#；默认：'#FFFFFF'
activeBgColor: '#F5F5F5', //（可选项）字符串类型；列表项按下时的背景色，支持 rgb、rgba、#；默认：'#F5F5F5'
height:113 //（可选项）数字类型；列表的高度；默认：113
imgWidth: 90, //（可选项）数字类型；列表项配图的宽度；默认：90
imgHeight: 51, //（可选项）数字类型；列表项配图的高度；默认：51
imgCorner: 4, //（可选项）数字类型；列表项配图的圆角大小；默认：0
placeholderImg: '', //（可选项）字符串类型；列表项配图的占位图路径（本地路径，fs://、widget://）
indexItemSize: 10, //（可选项）数字类型；列表右边索引文字大小；默认：10
认：'rgba(0,0,0,0)'
indexItemTop: 52, //（可选项）数字类型；列表右边索引上边距；默认：52
indexItemBottom: 15, //（可选项）数字类型；列表右边索引下边距；默认：52
indexSize: 16, //（可选项）数字类型；列表项索引文字大小；默认：16
indexColor: '#000', //（可选项）字符串类型：列表项索引文字颜色，支持 rgb、rgba、#；默认：'#000000'
titleSize: 16, //（可选项）数字类型；列表项标题文字大小；默认：16
titleColor: '#000', //（可选项）字符串类型；列表项标题文字颜色，支持 rgb，rgba，#；默认：'#000000'
titleWordSpace: 0, //（可选项）（仅ios支持）数字类型；列表项标题字间距；默认：0
subTitleSize: 14, //（可选项）数字类型；列表项子标题文字大小；默认：14
subTitleColor: '#999999', //（可选项）字符串类型：列表项子标题文字颜色，支持 rgb、rgba、#；默认：'##999999'
subTitleWordSpace: 0, //（可选项）（仅ios支持）数字类型；列表项子标题字间距；默认：0
subTitleLineSpace: 8, //（可选项）数字类型；列表项子标题行间距（距离标题位置）；默认：8
labelSize: 11, //（可选项）数字类型；列表项标签文字大小；默认：11
labelColor: '#97A0DC', //（可选项）字符串类型；列表项标签文字颜色，支持 rgb，rgba，#；默认：'#97A0DC'
labelBorderWide: 1, //（可选项）数字类型；列表标签边框宽度；默认：1
labelBorderColor: '#000000', //（可选项）字符串类型；列表项标签边框颜色，支持 rgb，rgba，#；默认：'#000000'
labelBorderCorners: 1, //（可选项）数字类型；列表标签边框圆角；默认：1
labelWordSpace: 0, //（可选项）（仅ios支持）数字类型；列表项标签字间距；默认：0
subLabelSize: 12, //（可选项）数字类型；列表项子标签文字大小；默认：12
subLabelColor: '#999999', //（可选项）字符串类型：列表项子标签文字颜色，支持 rgb、rgba、#；默认：'##999999'
subLabelWordSpace: 0, //（可选项）（仅ios支持）数字类型；列表项子标签字间距；默认：0
subLabelLineSpace: 8, //（可选项）数字类型；列表项子标签行间距（距离子标题位置）；默认：8
gropSize: 12, //（可选项）数字类型；列表项分组文字大小；默认：12
gropColor: '#999999', //（可选项）字符串类型：列表项分组文字颜色，支持 rgb、rgba、#；默认：'##999999'
gropLineSpace: 8, //（可选项）数字类型；列表项分组行间距（距离子标题位置）；默认：8
timeSize: 12, //（可选项）数字类型；列表项时间文字大小；默认：12
timeColor: '#999999', //（可选项）字符串类型：列表项时间文字颜色，支持 rgb、rgba、#；默认：'##999999'
timeLineSpace: 8, //（可选项）数字类型；列表项时间行间距（距离子标题位置）；默认：8
}
}
rightButtonInfo：
- 类型：json对象
- 描述：（可选项）列表右边按钮相关设置，设置后点击将会弹出扇形页面，不传将不会弹出
- 内部字段：
[{
image:'' //字符类型；图片地址，仅支持本地图片（支持widget、fs）
}]
fixedOn：
- 类型：字符串类型
- 描述：（可选项）插件视图添加到指定 frame 的名字（只指 frame，传 window 无效）
- 默认：插件依附于当前 window
showScrollBar：
- 类型：布尔
- 描述：（可选项）是否显示滚动条
- 默认：true
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
eventType: 'show', //字符串类型；交互事件类型
//取值范围如下：
//show（插件加载成功）
//clickRightBtn（点击侧滑出现的右侧按钮）
//clickContent（点击列表项）
//clickPopupBtn（点击弹窗按钮）
index: 0, //数字类型；列表项的索引
btnIndex: 0, //数字类型；列表项侧滑出现的按钮的索引
infoIndex: 0 //数字类型；列表项右边按钮弹窗索引
}
示例代码
var UIListBook = api.require('UIListBook');
UIListBook.open({
rect: {
x: 0,
y: 0,
w: api.winWidth,
h: api.frameHeight
},
data: [{
uid: '1001',
imgPath: 'widget://res/img/apicloud.png',
title: '标题',
subTitle: '子标题，说明文字',
icon: ''
}, {
uid: '1001',
imgPath: 'widget://res/img/apicloud.png',
title: '标题',
subTitle: '子标题，说明文字',
icon: ''
}],
rightBtns: [{
bgColor: '#388e8e',
width: 70,
title: '按钮',
titleSize: 12,
titleColor: '#fff',
icon: '',
iconWidth: 20
}],
styles: {
borderColor: '#696969',
item: {
bgColor: '#AFEEEE',
activeBgColor: '#F5F5F5',
imgWidth: 40,
imgHeight: 40,
imgCorner: 4,
placeholderImg: '',
titleSize: 12.0,
titleColor: '#000',
subTitleSize: 12.0,
subTitleColor: '#000',
remarkColor: '#000',
remarkSize: 16,
remarkIconWidth: 30
}
},
fixedOn: api.frameName
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
# **close**关闭数据列表插件
close()
示例代码
var UIListBook = api.require('UIListBook');
UIListBook.close();
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
# **show**显示 UIListBook 插件
show()
示例代码
var UIListBook = api.require('UIListBook');
UIListBook.show();
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
# **hide**隐藏 UIListBook 插件
hide()
示例代码
var UIListBook = api.require('UIListBook');
UIListBook.hide();
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
# **setAttr**设置列表的纵坐标和高度
setAttr({params}, callback(ret))
params
y：
- 类型：数字
- 描述：（可选项）插件的纵坐标
- 默认值：原 y 值
h：
- 类型：数字
- 描述：（可选项）插件的高度
- 默认值：原 h 值
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: true //布尔型；true||false
}
示例代码
var UIListBook = api.require('UIListBook');
UIListBook.setAttr({
y: 40,
h: 200
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
# **getIndex**根据开发者自定义的唯一标识（open 接口的 data 参数中自定义的唯一标识）查找列表项对应的数据（此接口仅支持iOS）
getIndex({params}, callback(ret, err))
params
key：
- 类型：字符串
- 描述：调用 open 接口时，data 参数传入的开发者自定义的唯一标识的 key
value：
- 类型：字符串
- 描述：调用 open 接口时，data 参数传入的开发者自定义的唯一标识的 value
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
index: 0, //数字类型；当前列表项的索引
data: [] //数组类型；当前列表项的数据，内部字段与 open 时的 data 参数一致
}
示例代码
var UIListBook = api.require('UIListBook');
UIListBook.getIndex({
key: 'uid',
value: '1001'
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
可用性
iOS系统 可提供的1.0.0及更高版本
# **getDataByIndex**根据列表项的索引获取对应的数据
getDataByIndex({params}, callback(ret))
params
index：
- 类型：数字
- 描述：（可选项）列表项的索引
- 默认值：0
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
data: {} //json对象类型；当前列表项的数据，内部字段与 open 时的 data 参数一致
}
示例代码
var UIListBook = api.require('UIListBook');
UIListBook.getDataByIndex({
index: 0
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
# **setSwipeBtns**设置侧滑显示出来的按钮
setSwipeBtns({params}, callback(ret))
params
index：
- 类型：数字
- 描述：（可选项）列表项的索引
- 默认值：0
btns：
- 类型：数组
- 描述：（可选项）列表项侧滑露出的按钮组
- 内部字段：
[{
bgColor: '#388e8e', //（可选项）字符串类型；按钮背景色，支持 rgb、rgba、#；默认：'#388e8e'
width: 70, //（可选项）数字类型；按钮的宽度；默认：w / 4
title: '', //（可选项）字符串类型；按钮标题，水平、垂直居中
titleSize: 12, //（可选项）数字类型；按钮标题文字大小；默认：12
titleColor: '#fff', //（可选项）字符串类型；按钮标题文字颜色，支持 rgb、rgba、#；默认：'#ffffff'
icon: '', //（可选项）字符串类型；按钮标题前的图标路径（本地路径，支持fs://、widget://），水平、垂直居中，图标为正方形
iconWidth: 20 //（可选项）数字类型；按钮标题前的图标宽度，图标为正方形；默认：20
}]
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: true //布尔型；true||false
}
示例代码
var UIListBook = api.require('UIListBook');
UIListBook.setSwipeBtns({
index: 0,
btns: [{
bgColor: '#388e8e',
width: 70,
title: '',
titleSize: 12,
titleColor: '#fff',
icon: '',
iconWidth: 20
}]
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
# **reloadData**刷新列表数据
reloadData({params}, callback(ret))
params
data：
- 类型：数组
- 描述：（可选项）列表的数据源，若不传或传空，仅收起下拉刷新组件
- 内部字段：
[{
imgPath: '', //（可选项）字符串类型；列表项的配图路径，支持http://、https://、widget://、fs://等协议，网络图片会被缓存到本地，若不传则（子）标题和（子）标签靠最左侧显示
title: '', //（可选项）字符串类型；标题，若不传或为空则 subTitle 上下位置居中显示
subTitle: '', //（可选项）字符串类型；子标题，若不传或为空则 title 上下位置居中显示
label: '', //（可选项）字符串类型；标签
subLabel: '', //（可选项）字符串类型；子标签
grop: '', //（可选项）字符串类型；分组
time: '', //（可选项）字符串类型；时间
icon: '', //（可选项）字符串类型；右侧按钮图标路径（本地路径，支持fs://、widget://）
chooseIcon: '', //（可选项）字符串类型；右侧按钮选中情况下图标路径（本地路径，支持fs://、widget://）；默认：icon设置路径
rightBtns: [] //（可选项）数组类型；列表项向左滑动露出的按钮组，配置某一项的特定按钮组，若不传则显示通用按钮，内部字段同下方 rightBtns 参数
}]
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: true //布尔型；true||false
}
示例代码
var UIListBook = api.require('UIListBook');
UIListBook.reloadData({
data: [{
imgPath: 'http://img1.3lian.com/gif/more/11/201206/a5194ba8c27b17def4a7c5495aba5e32.jpg',
title: '新标题',
subTitle: '新子标题',
remark: '新备注',
icon: ''
}]
}, function(ret) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
# **deleteItem**根据索引删除某一条列表的数据
deleteItem({params}, callback(ret))
params
index：
- 类型：数字
- 描述：（可选项）数据列表的索引
- 默认值：0
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: true //布尔型；true||false
}
示例代码
var UIListBook = api.require('UIListBook');
UIListBook.deleteItem({
index: 2
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
# **updateItem**根据索引更新某一条列表的数据
updateItem({params}, callback(ret))
params
index：
- 类型：数字
- 描述：（可选项）数据列表的索引
- 默认值：0
data：
- 类型：JSON 对象
- 描述：列表的数据源
- 内部字段：
{
imgPath: '', //（可选项）字符串类型；列表项的配图路径，支持http://、https://、widget://、fs://等协议，网络图片会被缓存到本地，若不传则标题和子标题靠最左侧显示
title: '', //（可选项）字符串类型；标题，若不传或为空则 subTitle 上下位置居中显示
subTitle: '', //（可选项）字符串类型；子标题，若不传或为空则 title 上下位置居中显示
grop: '', //（可选项）字符串类型；分组
time: '', //（可选项）字符串类型；时间
remark: '', //（可选项）字符串类型；右边备注文字
icon: '', //（可选项）字符串类型；右侧备注的图标路径（本地路径，支持fs://、widget://）
chooseIcon: '', //（可选项）字符串类型；右侧按钮选中情况下图标路径（本地路径，支持fs://、widget://）；默认：icon设置路径
rightBtns: [] //（可选项）数组类型；列表项向左滑动露出的按钮组，配置某一项的特定按钮组，若不传则显示通用按钮，内部字段同 rightBtns 参数
}
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: true //布尔型；true||false
}
示例代码
var UIListBook = api.require('UIListBook');
UIListBook.updateItem({
index: 2,
data: {
imgPath: 'http://img1.3lian.com/gif/more/11/201206/a5194ba8c27b17def4a7c5495aba5e32.jpg',
title: '刷新标题',
subTitle: '刷新子标题',
remark: '刷新备注'
}
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
# **appendData**向列表追加数据
appendData({params}, callback(ret))
params
data：
- 类型：数组对象
- 描述：列表的数据源，若不传或传空，仅收起上拉加载组件
- 内部字段：
[{
imgPath: '', //（可选项）字符串类型；列表项的配图路径，支持http://、https://、widget://、fs://等协议，网络图片会被缓存到本地，若不传则（子）标题和（子）标签靠最左侧显示
title: '', //（可选项）字符串类型；标题，若不传或为空则 subTitle 上下位置居中显示
subTitle: '', //（可选项）字符串类型；子标题，若不传或为空则 title 上下位置居中显示
label: '', //（可选项）字符串类型；标签
subLabel: '', //（可选项）字符串类型；子标签
grop: '', //（可选项）字符串类型；分组
time: '', //（可选项）字符串类型；时间
icon: '', //（可选项）字符串类型；右侧按钮图标路径（本地路径，支持fs://、widget://）
rightBtns: [] //（可选项）数组类型；列表项向左滑动露出的按钮组，配置某一项的特定按钮组，若不传则显示通用按钮，内部字段同下方 rightBtns 参数
}]
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: true //布尔型；true||false
}
示例代码
var UIListBook = api.require('UIListBook');
UIListBook.appendData({
data: [{
imgPath: 'http://d.hiphotos.baidu.com/image/pic/item/4d086e061d950a7b29a788c209d162d9f2d3c922.jpg',
title: '新增标题',
subTitle: '新增子标题',
remark: '新增备注'
}]
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
# **getCount**获取当前列表的总数据量
getCount(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
count: 21 //数字类型；当前列表包含的数据总数
}
示例代码
var UIListBook = api.require('UIListBook');
UIListBook.getCount(function(ret) {
api.alert({msg: JSON.stringify(ret)});
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
# **setRefreshHeader**设置下拉刷新，通过 reloadData 收起下拉刷新组件
setRefreshHeader({params}, callback(ret))
params
loadingImg：
- 类型：字符串
- 描述：下拉刷新时显示的小箭头图标的本地路径，要求本地路径（fs://、widget://）
bgColor：
- 类型：字符串
- 描述：（可选项）下拉刷新区域的背景色，支持 rgb、rgba、#
- 默认值：'#f5f5f5'
textColor：
- 类型：字符串
- 描述：（可选项）提示文字颜色，支持 rgb、rgba、#
- 默认值：'#8e8e8e'
textDown：
- 类型：字符串
- 描述：（可选项）下拉提示文字
- 默认值：下拉可以刷新...
textUp：
- 类型：字符串
- 描述：（可选项）松开提示文字
- 默认值：松开开始刷新...
loadingText:
- 类型：字符串
- 描述：（可选项）提示文字
- 默认值：正在加载...
callback()
下拉刷新的事件回调
示例代码
var UIListBook = api.require('UIListBook');
UIListBook.setRefreshHeader({
loadingImg: 'widget://res/UIListBook_arrow.png',
bgColor: '#F5F5F5',
textColor: '#8E8E8E',
textDown: '下拉可以刷新...',
textUp: '松开开始刷新...',
showTime: true
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
# **setRefreshFooter**设置上拉加载，通过 appendData 收起上拉加载组件
setRefreshFooter({params}, callback())
params
loadingImg：
- 类型：字符串
- 描述：上拉加载时显示的小箭头图标的本地路径，要求本地路径（fs://、widget://）
bgColor：
- 类型：字符串
- 描述：（可选项）上拉加载区域的背景色，支持 rgb、rgba、#
- 默认值：'#f5f5f5'
textColor：
- 类型：字符串
- 描述：（可选项）提示文字颜色，支持 rgb、rgba、#
- 默认值：'#8e8e8e'
textUp：
- 类型：字符串
- 描述：（可选项）上拉提示文字
- 默认值：'上拉加载更多...'
textDown：
- 类型：字符串
- 描述：（可选项）（仅ios支持）松开提示文字
- 默认值：'松开开始加载...'
loadingText:
- 类型：字符串
- 描述：（可选项）（仅ios支持）提示文字
- 默认值：正在加载...
callback(ret)
上拉加载的事件回调
示例代码
var UIListBook = api.require('UIListBook');
UIListBook.setRefreshFooter({
loadingImg: 'widget://res/UIListBook_arrow.png',
bgColor: '#F5F5F5',
textColor: '#8E8E8E',
textUp: '上拉加载更多...',
textDown: '松开开始加载...',
showTime: true
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
# **sort**排序
sort({params}, callback(ret))
params
sort：
- 类型：数字
- 描述：（可选项）排序；0:正序,1:倒序
- 默认值：0
示例代码
var UIListBook = api.require('UIListBook');
UIListBook.sort({
sort:0,
});
可用性
iOS系统，Android系统
可提供的1.0.1及更高版本
# **cancelOrder**恢复取消排序
cancelOrder({params}, callback(ret))
params
isSort：
- 类型：布尔
- 描述：（可选项）是否排序
- 默认值：false（不排序）
示例代码
var UIListBook = api.require('UIListBook');
UIListBook.cancelOrder({
isSort:false
});
可用性
iOS系统，Android系统
可提供的1.0.2及更高版本
# **closeMenu**关闭右边弹窗（跳转其他页面时需调用此接口关闭弹窗，此接口仅支持iOS）
closeMenu()
示例代码
var UIListBook = api.require('UIListBook');
UIListBook.closeMenu();
可用性
iOS系统
可提供的1.0.5及更高版本
# **setStyle**设置列表项样式（分组时间不可同时设置）
setStyle({params})
params
of：
- 类型：数字
- 描述：（可选项）设置哪一项
- 默认值：0
- 取值范围：0：分组，1：时间，2：子标签
styles:
- 类型：JSON 对象
- 描述：（可选项）列表项样式
- 内部字段：
{
color: '#000', //（可选项）字符串类型；文字颜色，支持 rgb，rgba，#；默认：'#000000'
size: 14, //（可选项）数字类型；文字大小；默认：14
}
示例代码
var UIListBook = api.require('UIListBook');
UIListBook.setStyle({
styles:{
color: '#000', //（可选项）字符串类型；文字颜色，支持 rgb，rgba，#；默认：'#000000'
size: 14, //（可选项）数字类型；文字大小；默认：14
}
});
可用性
iOS系统，Android系统
可提供的1.0.7及更高版本
# **cancelStyle**取消设置列表项样式
cancelStyle()
示例代码
var UIListBook = api.require('UIListBook');
UIListBook.cancelStyle();
可用性
iOS系统
可提供的1.0.7及更高版本