sortList

立即使用

open close hide show upLoad addSource reduceSource

概述

sortList简介

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

模块接口

open

打开索引列表

open({params}, callback(ret))

params

rect：

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

内部字段：

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

height：

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

bgColor：

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

dataArray：

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

内部字段：

  1. [
  2.  '小明',
  3.  '小红'
  4. ]

style：

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

内部字段：

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

fixedOn：

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

fixed:

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

callback(ret, err)

ret：

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

示例代码

  1. var demo = api.require('sortList');
  2. demo.open({
  3.      rect:{
  4.           x:100,
  5.           y:100,
  6.           w:20,
  7.      },
  8.      height:20,
  9.      dataArray:['小明','小红']
  10. }, function(ret){
  11.     alert(JSON.stringify(ret));
  12. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

close

关闭索引列表

close(callback(ret))

callback(ret, err)

ret：

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

示例代码

  1. var demo = api.require('sortList');
  2. demo.close(function(ret){
  3.     alert(JSON.stringify(ret));
  4. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

hide

隐藏索引列表

hide({callback(ret))

callback(ret, err)

ret：

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

示例代码

  1. var demo = api.require('sortList');
  2. demo.hide(function(ret){
  3.     alert(JSON.stringify(ret));
  4. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

show

显示索引列表

show(callback(ret))

callback(ret, err)

ret：

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

示例代码

  1. var demo = api.require('sortList');
  2. demo.show(function(ret){
  3.     alert(JSON.stringify(ret));
  4. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

upLoad

更新索引列表

upLoad({params}, callback(ret))

params

dataArray：

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

内部字段：

  1. [
  2.  '小明',
  3.  '小红'
  4. ]

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

ret：

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

示例代码

  1. var demo = api.require('sortList');
  2. demo. upLoad({
  3.      dataArray:['小明','小红']
  4. }, function(ret){
  5.     alert(JSON.stringify(ret));
  6. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

addSource

添加数据

addSource({params}, callback(ret))

params

dataArray：

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

内部字段：

  1. [
  2.  '小明',
  3.  '小红'
  4. ]

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

ret：

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

示例代码

  1. var demo = api.require('sortList');
  2. demo.addSource({
  3.      dataArray:['小明','小红']
  4. }, function(ret){
  5.     alert(JSON.stringify(ret));
  6. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

reduceSource

删除数据（仅iOS支持）

reduceSource({params}, callback(ret))

params

dataArray：

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

内部字段：

  1. [
  2.  '小明',
  3.  '小红'
  4. ]

callback(ret, err)

ret：

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

示例代码

  1. var demo = api.require('sortList');
  2. demo.reduceSource({
  3.      dataArray:['小明','小红']
  4. }, function(ret){
  5.     alert(JSON.stringify(ret));
  6. });

可用性

iOS系统

可提供的1.0.0及更高版本