Bootstrap相关方法,事件整理

相关方法

这些方法的调用方法主要是$(\'#bsTableTest\').bootstrap(\'<方法名>\',<一个object形式的参数>)。

常用的方法有:

getOptions

获取表格的一些基本属性,返回一个object,key有像conlumns,data,sortOrder,class这些。

getSelections

获取被选中的(包括radio或者checkbox)各行对象组成的列表。

load,append,prepend  

这三个方法的参数都是data,即[{...},{...}...]形式的数据,load是清空当前表中所有数据,append是在表尾加,prepend是在第一行前面插入数据。

remove

参数是一个object,含有两个字段,field和values。通过两个字段的值可以定位一个或多个单元格,把这些单元格所在的行删除。例如:bootstrapTable(\'remove\',{field:\'id\',values:[3]})。

需要注意的是即便是只定位一个单元格,即values后列表中只有一个值,那也要写出是个列表,否则会识别失败

insertRow,updateRow

这两个方法分别用于在指定位置插入一个新行或者更新指定行的信息。参数有index和row,如:bootstrapTable(\'insertRow\',{index:2,row:{id:99,name:\'New Row\',desc:\'Test\'}}),

需注意,如果某些字段没有在params中给出值的话,那么insert时默认这些字段为undefined,update时默认这些字段没有改变。

showLoading,hideLoading

显示/隐藏加载状态

mergeCells

用于合并单元格,参数有四个,如果把合并后最左上角的那个单元格称为初始单元格的话,那么index是初始单元格的行的index,field是初始单元格所在列字段名。

这两个参数确定了一个起始单元格,然后还有两个参数rowspan和colspan都是int型,指出了从初始单元格开始向下并几行向右并几列。

updateCell

index,field和value三个参数用来更新单个单元格内的值。

refresh

刷新表格数据,可以加入参数url指定请求发向的url(可以是一个新的),silent:true时静默更新,query:{} 可以指出一些新的ajax请求时的参数。

resetSearch

可以设置搜索框中文字,这个方法比较特殊的是参数不是一个object而是单纯的string。例如:bootstrapTable(\'resetSearch\',\'Hello\')。

resetView/Width

可以重设样式(如宽度高度等),常用在页面大小、宽度等发生变化时。

比如侧边栏收放引起表格所在容器宽度发生变化,容易导致表头和表内容列错位。在宽度变化时调用这个函数便可以自动修正。

checkAll,uncheckAll

全选/全不选当前页面中的行。

check/uncheck

选中/不选一行,同resetSearch一样,不用传递object,直接写int型的index数据即可。例如:bootstrapTable(\'check\',2)。

checkBy/uncheckBy

bootstrapTable(\'checkBy\',{field:\'id\',values:[1,3,5]}),选中部分,条件由参数给出。

getHiddenRows/getHiddenColumns

获取隐藏着的行和列们

getScrollPosition/scrollTo

当表格有滚动条时,前者返回滚动条滚动位置,后者设置。单位是px,scrollTo可以是\'bottom\'来拉到底。

filterBy

在客户端进行数据过滤,参数是field和values。

prevPage/nextPage/selectPage

跳往前一页/后一页/指定页。

相关事件

事件会关联一个函数,而不同的事件,关联的函数有哪些参数也都是不一样的。

onClickRow

点击一行时触发的事件,参数有row , element , field三个,分别代表点击行的行对象,点击行的jquery<tr>对象,点击的列的title

onDblClickRow

双击行事件,参数和onClickRow一样。

onClickCell

点击单元格触发的事件,参数包括field , value , row , element,分别表示点击单元格所在列title,单元格的值,单元格所在行行对象,单元格的jquery<td>对象。

onDblClickCell

双击单元格事件,参数和onClickCell一样。

onSort

点击排序按钮进行数据排序时触发的事件,包括参数name和order分别代表排序字段名和排序方式(asc和desc)。

onCheck/onUncheck

当某一行被选中/取消选中时触发事件,参数有row和element。

onCheckAll/onUncheckAll

参数是rows,一个被选中所有行对象的数组。需要注意,手动一个一个选择时不会触发这个事件,只有按表头的那个全选,全选行时才会触发。

onLoadSuccess/onLoadError

当加载数据成功/失败时触发的事件,前者参数data,后者参数status(HTTP返回码,如500,404之类的)。

onColumnSwitch

当设置某一列可见/不可见时触发,参数是field和checked,field是被操作的字段title名,而checked是boolean值,表示操作后该字段是否是显示状态。

onPageChange

换页时触发事件,参数有number和size,分别代表跳转后位于第几页且页面内有多少条记录。

onSearch

使用bs-table自带搜索框进行搜索时触发事件,参数是text即搜索关键文。

onRefresh

刷新表格数据是触发的事件,参数params是一个挺复杂的对象,包含了此次刷新的一些信息。