url 分页跳转URL
- 类型:
string
- 默认值:
无默认值,该参数为必填参数
- 使用方式:
http://xxx.com/load
在页面跳转模式下,url设置为目标跳转位置,插件会自动拼接分页参数及用户自定义参数;在异步模式下作为数据请求的目标位置,插件同样会自动拼接上参数
例如:
http://xxx.com/load?aa=1&bb=2
pageSize 每页显示记录数
- 类型:
number
- 默认值:
10
- 使用方式:
根据使用需要设置每页显示记录数,默认值为10
pageNumber 当前页号
- 类型:
number
- 默认值:
1
- 使用方式:
设置当前页号,默认值为1
totalRow 总记录个数
- 类型:
number
- 默认值:
0
- 使用方式:
设置数据的总记录个数,该参数仅在页面跳转模式下
asyncLoas:false
才需要显式设置
totalPage 总页数
- 类型:
number
- 默认值:
1
- 使用方式:
设置分页总页数,该参数仅在页面跳转模式下
asyncLoas:false
才需要显式设置
callback 分页操作处理完成后的回调函数(异步)
- 类型:
function
- 默认值:
无
- 使用方式:
该回调仅在异步模式中使用,在每次分页操作完成后执行
params 传递参数
- 类型:
object
- 默认值:
无
- 使用方式:
进行页面跳转或数据请求时需要传递给服务端的参数集
格式:
{'name':'aa','sex':1}
例如:
params : {'name':'aa','sex':1}
pageBarSize 显示页码个数,建议使用奇数
- 类型:
number
- 默认值:
5
- 使用方式:
该参数用于设置分页插件显示的分页页码个数,意义在于页码数较多时,可指定分页栏中显示页码的个数
pageSizeMenu 每页显示记录数设置
- 类型:
array
- 默认值:
[10,20,50,100]
- 使用方式:
设置快速改变每页显示记录数的选项,结果以下拉列表显示,用户通过选择下拉列表项可立即改变每页显示的记录数
asyncLoad 异步处理分页
- 类型:
boolean
- 默认值:
false
- 使用方式:
设置分页插件的分页模式
- 页面跳转模式(false)
- 异步请求页面模式(服务端页面)(true)
- 异步请求数据模式(服务端JSON数据)(true)
asyncTarget 异步处理对象容器,支持使用jquery表达式
- 类型:
string | object
- 默认值:
无
- 使用方式:
该参数在异步模式且
serverSidePage:true
时使用,参数指定了服务端返回的页面内容放置的目标区域参数设置接受jquery表达式,也允许直接传递jQuery对象
serverSidePage 是否使用服务端返回页面的形式
- 类型:
boolean
- 默认值:
false
- 使用方式:
插件的异步模式分为服务端返回页面模式(true),及服务端返回数据(json)模式(false)
注意 服务端返回页面模式下,需要在返回的页面内容中增加分页数据元素,用于读取分页数据,若不设置该内容,插件则没有办法读取到分页信息,则在异步服务端页面模式下必须设置,格式如下:
className 为分页插件自定义样式
- 类型:
string
- 默认值:
无
- 使用方式:
页面中需要设置不同的风格样式时,可以使用该参数指定需要使用的样式名称
提示 样式内容需要预先定义,插件本身仅为默认的样式
render 异步数据模式自定义处理回调
- 类型:
function
- 默认值:
无
- 使用方式:
ajax请求服务端并返回json数据后,可使用数据进行自定义页面渲染
提示 该回调仅在
serverSidePage:false
时使用例:
render : function(data){ $('#aa').val(data.name); }
$.fn.bPageSwitch 切换当前页
- 类型:
function
- 默认值:
无
- 使用方式:
该API函数提供在代码中手动切换插件当前分页的功能
例:
$('#page').bPageSwitch(2);
$.fn.bPageRefresh 刷新新页栏
- 类型:
function
- 默认值:
无
- 使用方式:
该API方法可刷新插件的内部参数,并立即响应修改
例:
$('#page').bPageRefresh({pageSize:20,pageBarSize:7});