sortList

open close hide show upLoad addSource reduceSource

概述

sortList简介

sortList插件是一个字母检索器,根据传入的数据源来展示检索器的字母。

插件接口

open

打开索引列表

open({params}, callback(ret))

params

rect：

  • 类型：JSON 对象
  • 默认值：见内部字段
  • 描述：索引器的frame

内部字段：

{
    x:0,     //数字类型;视图的左上角点的坐标; 默认值:0
    y:0,     //数字类型;视图的左上角点的坐标; 默认值:0
    w:10,    //数字类型;视图的宽; 默认值:10
    h:,        //数字类型；视图的高度；默认值：300（仅android支持）
}

height：

  • 类型：数字类型
  • 描述：每个字母显示的高度（仅iOS支持）
  • 默认值:15

bgColor：

  • 类型：字符串类型
  • 描述：索引器背景颜色
  • 默认:透明

dataArray：

  • 类型：数组类型
  • 默认值：无
  • 描述：数据源,名单列表

内部字段：

[
 '小明',
 '小红'
]

style：

  • 类型：JSON 对象
  • 默认值：见内部字段

内部字段：

{
    textColor:‘’  ,   //字符串类型;字体颜色; 默认:#000000
    font:0    , //数字类型;字体大小; 默认:10
    selectColor:'', //字符串类型; 选中时字体颜色; 默认;无
    highLightColor:'' //字符串类型; 点击时字体颜色 ; 默认;无（仅iOS支持）
}

fixedOn：

  • 类型：字符串类型
  • 描述：（可选项）插件视图添加到指定 frame 的名字（只指 frame，传 window 无效）（仅android支持）

fixed:

  • 类型：布尔类型
  • 描述：（可选项）是否将插件视图固定到窗口上，不跟随窗口上下滚动（仅android支持）
  • 默认：false

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    index:1,   //数字类型；
    letter:'h', //字符串类型;

}

示例代码

var demo = api.require('sortList');
demo.open({
     rect:{
          x:100,
          y:100,
          w:20,
     },
     height:20,
     dataArray:['小明','小红']
}, function(ret){
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

close

关闭索引列表

close(callback(ret))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    status:,   //布尔类型
}

示例代码

var demo = api.require('sortList');
demo.close(function(ret){
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

hide

隐藏索引列表

hide({callback(ret))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    status:,   //布尔类型
}

示例代码

var demo = api.require('sortList');
demo.hide(function(ret){
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

show

显示索引列表

show(callback(ret))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    status:,   //布尔类型
}

示例代码

var demo = api.require('sortList');
demo.show(function(ret){
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

upLoad

更新索引列表

upLoad({params}, callback(ret))

params

dataArray：

  • 类型：数组类型
  • 默认值：无
  • 描述：数据源,名单列表

内部字段：

[
 '小明',
 '小红'
]

callback(ret, err)（进iOS支持）

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    index:1,   //数字类型；
    letter:'h', //字符串类型;
}

示例代码

var demo = api.require('sortList');
demo. upLoad({
     dataArray:['小明','小红']
}, function(ret){
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

addSource

添加数据

addSource({params}, callback(ret))

params

dataArray：

  • 类型：数组类型
  • 默认值：无
  • 描述：数据源,名单列表

内部字段：

[
 '小明',
 '小红'
]

callback(ret, err)（仅iOS支持）

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    index:1,   //数字类型；
    letter:'h', //字符串类型;
}

示例代码

var demo = api.require('sortList');
demo.addSource({
     dataArray:['小明','小红']
}, function(ret){
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

# **reduceSource**

删除数据（仅iOS支持）

reduceSource({params}, callback(ret))

params

dataArray：

  • 类型：数组类型
  • 默认值：无
  • 描述：数据源,名单列表

内部字段：

[
 '小明',
 '小红'
]

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    index:1,   //数字类型；
    letter:'h', //字符串类型;
}

示例代码

var demo = api.require('sortList');
demo.reduceSource({
     dataArray:['小明','小红']
}, function(ret){
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS系统

可提供的1.0.0及更高版本

是否仍需要帮助？ 请保持联络！
最后更新于 2024/04/24