按照Metronic的Bootstrap开发框架经验总括(16)– 使用插件bootstrap-table实现表格记录的查询、分页、排序等处理

在作业系统开发中,对表格记录的查询、分页、排序等处理是充足常见的,在Web开发中,可以使用很多效能强大的插件来满意要求,且能大幅度的滋长开发效用,本随笔介绍这么些bootstrap-table是一款万分出名的开源表格插件,在众多类型中常见的施用。Bootstrap-table插件提供了相当丰硕的性质设置,可以兑现查询、分页、排序、复选框、设置展现列、Card
view视图、主从表呈现、合并列、国际化处理等拍卖效能,而且该插件同时也提供了一部分毋庸置疑的恢宏效率,如运动行、移动列地方等局部不同日常的效率,插件能够用基于HTML5的data-*属性标识设置,也足以动用Javascript格局展开安装,相当有利于。本篇随笔介绍bootstrap-table插件在自我其实项目中的应用意况,总括相关应用中遇见的问题处理经验。

1、Bootstrap-table资源及使用介绍

在GitHub上Bootstrap-table的源码地址是:https://github.com/wenzhixin/bootstrap-table

Bootstrap-table的文档地址:http://bootstrap-table.wenzhixin.net.cn/

Bootstrap-table的各种样例:https://github.com/wenzhixin/bootstrap-table-examples

Bootstrap-Table彰显数据到表格的办法有二种,一种是客户端(client)模式,一种是服务器(server)情势。

  所谓客户端形式,指的是在服务器中把要出示到表格的数额五遍性加载出来,然后转换成JSON格式传到要呈现的界面中,客户端形式较为简单,它是把数据两遍性加载出来放到界面上,然后依据你设置的每页记录数,自动生成分页。当点击第二页时,会自行加载出多少,不会再向服务器发送请求。同时用户可以接纳其自带的搜寻功效,可以实现全数据检索。对于数据量较少的时候,可以应用那些法子。

  所谓服务器格局,指的是按照设定的每页记录数和当下要体现的页码,发送数据到服务器举行查询,然后再突显到表格中。该方法可以遵照用户的急需动态的加载数据,节省了服务器的资源,可是无法选取其自带的全数据检索效果。

Bootstrap-table是基于Boostrap开发的插件,由此使用的时候,需要引入Bootstrap的本子和样式。

如果我们项目中绝非引入相关的文本,则需要引入这些样式和本子文件,如下所示。

<link rel="stylesheet" href="bootstrap.min.css">

<script src="jquery.min.js"></script>
<script src="bootstrap.min.js"></script>

不过上述内容,在大家付出项目标时候都必将有的了,所以我们仍然把中央放到使用这一个插件所需要的引入文件上来。

CSS文件引入

<link rel="stylesheet" href="bootstrap-table.css">

本子文件引入

<script src="bootstrap-table.js"></script>
<--汉化文件,放在 bootstrap-table.js 后面-->
<script src="bootstrap-table-zh-CN.js"></script>

 一般的话大家只即便依照MVC开发的系统,CSS和JS的代码,都是坐落BundleConfig.cs里面起头化的,如下所示

图片 1

 

bootstrap-table在页面中的使用,可以分为二种,一种是纯粹用HTML5的写法,通过data-*的不二法门指定各种性能设置,一种是HTML+JS形式实现弹性装置。

一经大家应用HTML5标识的法子开端化HTML代码,则是底下的代码。

<table data-toggle="table" data-url="data1.json">
    <thead>
        <tr>
            <th data-field="id">Item ID</th>
            <th data-field="name">Item Name</th>
            <th data-field="price">Item Price</th>
        </tr>
    </thead>
</table>

如果大家运用JS代码形式来起先化表格插件,那么只需要在HTML上声明一个表格对象即可,如下代码。

<table id="table"></table>

接下来简单的JS代码开头化如下所示

$('#table').bootstrapTable({
    url: 'data1.json',
    columns: [{
        field: 'id',
        title: 'Item ID'
    }, {
        field: 'name',
        title: 'Item Name'
    }, {
        field: 'price',
        title: 'Item Price'
    }, ]
});

可是实在我们运用 bootstrap-table的JS配置功用肯定比这一个纷繁很多,上面界面效果是实际表的多少展现。

图片 2

 

2、bootstrap-table的详细使用

1)整个JS属性配置

在上图中,我们是利用JS情势展开初阶化表格内容的,JS代码如下所示

        var $table;
        //初始化bootstrap-table的内容
        function InitMainTable () {
            //记录页面bootstrap-table全局变量$table,方便应用
            var queryUrl = '/TestUser/FindWithPager?rnd=' + Math.random()
            $table = $('#grid').bootstrapTable({
                url: queryUrl,                      //请求后台的URL(*)
                method: 'GET',                      //请求方式(*)
                //toolbar: '#toolbar',              //工具按钮用哪个容器
                striped: true,                      //是否显示行间隔色
                cache: false,                       //是否使用缓存,默认为true,所以一般情况下需要设置一下这个属性(*)
                pagination: true,                   //是否显示分页(*)
                sortable: true,                     //是否启用排序
                sortOrder: "asc",                   //排序方式
                sidePagination: "server",           //分页方式:client客户端分页,server服务端分页(*)
                pageNumber: 1,                      //初始化加载第一页,默认第一页,并记录
                pageSize: rows,                     //每页的记录行数(*)
                pageList: [10, 25, 50, 100],        //可供选择的每页的行数(*)
                search: false,                      //是否显示表格搜索
                strictSearch: true,
                showColumns: true,                  //是否显示所有的列(选择显示的列)
                showRefresh: true,                  //是否显示刷新按钮
                minimumCountColumns: 2,             //最少允许的列数
                clickToSelect: true,                //是否启用点击选中行
                //height: 500,                      //行高,如果没有设置height属性,表格自动根据记录条数觉得表格高度
                uniqueId: "ID",                     //每一行的唯一标识,一般为主键列
                showToggle: true,                   //是否显示详细视图和列表视图的切换按钮
                cardView: false,                    //是否显示详细视图
                detailView: false,                  //是否显示父子表
                //得到查询的参数
                queryParams : function (params) {
                    //这里的键的名字和控制器的变量名必须一直,这边改动,控制器也需要改成一样的
                    var temp = {   
                        rows: params.limit,                         //页面大小
                        page: (params.offset / params.limit) + 1,   //页码
                        sort: params.sort,      //排序列名  
                        sortOrder: params.order //排位命令(desc,asc) 
                    };
                    return temp;
                },
                columns: [{
                    checkbox: true,  
                    visible: true                  //是否显示复选框  
                }, {
                    field: 'Name',
                    title: '姓名',
                    sortable: true
                }, {
                    field: 'Mobile',
                    title: '手机',
                    sortable: true
                }, {
                    field: 'Email',
                    title: '邮箱',
                    sortable: true,
                    formatter: emailFormatter
                }, {
                    field: 'Homepage',
                    title: '主页',
                    formatter: linkFormatter
                }, {
                    field: 'Hobby',
                    title: '兴趣爱好'
                }, {
                    field: 'Gender',
                    title: '性别',
                    sortable: true
                }, {
                    field: 'Age',
                    title: '年龄'
                }, {
                    field: 'BirthDate',
                    title: '出生日期',
                    formatter: dateFormatter
                }, {
                    field: 'Height',
                    title: '身高'
                }, {
                    field: 'Note',
                    title: '备注'
                }, {
                    field:'ID',
                    title: '操作',
                    width: 120,
                    align: 'center',
                    valign: 'middle',
                    formatter: actionFormatter
                }, ],
                onLoadSuccess: function () {
                },
                onLoadError: function () {
                    showTips("数据加载失败!");
                },
                onDblClickRow: function (row, $element) {
                    var id = row.ID;
                    EditViewById(id, 'view');
                },
            });
        };

地方JS代码的布置属性,基本上都加了诠释表明,是相比较易于明白的了。

2)查询及分页

此处的报表数据分页是拔取服务器分页的主意,依据查找条件从服务器再次来到数据记录的,并应用了排序的处理模式,这里的queryParams参数就是交给到劳动器端的参数了

                //得到查询的参数
                queryParams : function (params) {
                    //这里的键的名字和控制器的变量名必须一直,这边改动,控制器也需要改成一样的
                    var temp = {   
                        rows: params.limit,                         //页面大小
                        page: (params.offset / params.limit) + 1,   //页码
                        sort: params.sort,      //排序列名  
                        sortOrder: params.order //排位命令(desc,asc) 
                    };
                    return temp;
                },

其余我们见到重回数据的URL地址接口是FindWithPager,我们来看望这个MVC控制器方法是咋样处理数据再次回到的。

        /// <summary>
        /// 根据条件查询数据库,并返回对象集合(用于分页数据显示)
        /// </summary>
        /// <returns>指定对象的集合</returns>
        public override ActionResult FindWithPager()
        {
            //检查用户是否有权限,否则抛出MyDenyAccessException异常
            base.CheckAuthorized(AuthorizeKey.ListKey);

            string where = GetPagerCondition();
            PagerInfo pagerInfo = GetPagerInfo();
            var sort = GetSortOrder();

            List<TestUserInfo> list = null;
            if (sort != null && !string.IsNullOrEmpty(sort.SortName))
            {
                list = baseBLL.FindWithPager(where, pagerInfo, sort.SortName, sort.IsDesc);
            }
            else
            {
                list = baseBLL.FindWithPager(where, pagerInfo);
            } 

            //Json格式的要求{total:22,rows:{}}
            //构造成Json的格式传递
            var result = new { total = pagerInfo.RecordCount, rows = list };
            return ToJsonContent(result);
        }

地方代码处理了五个部分的对象信息,一个是分页实体类信息,一个是排序信息,然后按照那多少个规则拿到记录,重回类似

{total:22,rows:{}}

格式的JSON数据记录。

            var result = new { total = pagerInfo.RecordCount, rows = list };
            return ToJsonContent(result);

获取分页的参数新闻如下所示

        /// <summary>
        /// 根据Request参数获取分页对象数据
        /// </summary>
        /// <returns></returns>
        protected virtual PagerInfo GetPagerInfo()
        {
            int pageIndex = Request["page"] == null ? 1 : int.Parse(Request["page"]);
            int pageSize = Request["rows"] == null ? 10 : int.Parse(Request["rows"]);

            PagerInfo pagerInfo = new PagerInfo();
            pagerInfo.CurrenetPageIndex = pageIndex;
            pagerInfo.PageSize = pageSize;

            return pagerInfo;
        }

取得排序参数音信的代码如下所示

        /// <summary>
        /// 获取排序的信息
        /// </summary>
        /// <returns></returns>
        protected SortInfo GetSortOrder()
        {
            var name = Request["sort"];
            var order = Request["sortOrder"];
            return new SortInfo(name, order);
        }

最终就是具体实现具体条件、具体页码、具体排序条件下的数额记录了,这部分能够依照自己的渴求兑现逻辑,这里只是给出一个包裹好的拍卖调用即可。

baseBLL.FindWithPager(where, pagerInfo, sort.SortName, sort.IsDesc);

实在意况下,大家列表的来得,一般需要接纳不同的标准举办数量的查询的,即使那一个Bootstrap-table控件提供了一个默认的询问按钮,但是貌似是在客户端分页的状态下行使,而且略显简单,大家一般接纳自己询问条件举行拍卖,如下界面所示。

图片 3

抑或正如的

图片 4

这就是说这么对于地方的js属性就需要调动下接受询问条件参数queryParams 了

                //得到查询的参数
                queryParams : function (params) {
                    //这里的键的名字和控制器的变量名必须一直,这边改动,控制器也需要改成一样的
                    var temp = {   
                        rows: params.limit,                         //页面大小
                        page: (params.offset / params.limit) + 1,   //页码
                        sort: params.sort,      //排序列名  
                        sortOrder: params.order //排位命令(desc,asc) 
                    };
                    return temp;
                },

对此自定义查询条件,我们可以用下边的健康办法加码参数,如下所示

 图片 5

不过查询条件的参数我们不便宜一一设置,大家想经过一种相比较快捷的方法来处理,那么就需要对这么些处理格局举行一个专门的改动了,首先添加一个恢宏函数来处理表单的准绳(参考博客http://www.cnblogs.com/zcsj/p/6635677.html的介绍)

        //自定义函数处理queryParams的批量增加
        $.fn.serializeJsonObject = function () {
            var json = {};
            var form = this.serializeArray();
            $.each(form, function () {
                if (json[this.name]) {
                    if (!json[this.name].push) {
                        json[this.name] = [json[this.name]];
                    }
                    json[this.name].push();
                } else {
                    json[this.name] = this.value || '';
                }
            });
            return json;
        }

接下来我们就可以批量处理表单的询问条件了

                queryParams : function (params) {
                    //这里的键的名字和控制器的变量名必须一直,这边改动,控制器也需要改成一样的
                    var temp = $("#ffSearch").serializeJsonObject();
                    temp["rows"] = params.limit;                        //页面大小
                    temp["page"] = (params.offset / params.limit) + 1;  //页码
                    temp["sort"] = params.sort;                         //排序列名
                    temp["sortOrder"] = params.order;                   //排位命令(desc,asc) 

                    //特殊格式的条件处理
                    temp["WHC_Age"] = $("#WHC_Age").val() + "~" + $("#WHC_Age2").val();
                    temp["WHC_BirthDate"] = $("#WHC_BirthDate").val() + "~" + $("#WHC_BirthDate2").val();

                    return temp;
                },

下一场后端统一按照逻辑处理查询参数即可。

3)格式化输出函数及此外

对此地点JS的布置音信,咱们再来回顾一下,例如对于数据转义函数,可以格式化输出的始末的,如下界面代码。

图片 6

格式化的数量转义函数如下,首要就是基于内容举行格式化输出的JS函数,好像是急需放在一个文本内。

        //连接字段格式化
        function linkFormatter(value, row, index) {                
            return "<a href='" + value + "' title='单击打开连接' target='_blank'>" + value + "</a>";
        }
        //Email字段格式化
        function emailFormatter(value, row, index) {
            return "<a href='mailto:" + value + "' title='单击打开连接'>" + value + "</a>";
        }
        //性别字段格式化
        function sexFormatter(value) {
            if (value == "女") { color = 'Red'; }
            else if (value == "男") { color = 'Green'; }
            else { color = 'Yellow'; }

            return '<div  style="color: ' + color + '">' + value + '</div>';
        }

另外,我们来看行记录的结尾增添了多少个操作按钮,方便对当下记下的查阅、编辑和删除操作,如下效果图所示。

图片 7

这有些我们也是经过格式化函数举办拍卖的

图片 8

        //操作栏的格式化
        function actionFormatter(value, row, index) {
            var id = value;
            var result = "";
            result += "<a href='javascript:;' class='btn btn-xs green' onclick=\"EditViewById('" + id + "', view='view')\" title='查看'></a>";
            result += "<a href='javascript:;' class='btn btn-xs blue' onclick=\"EditViewById('" + id + "')\" title='编辑'></a>";
            result += "<a href='javascript:;' class='btn btn-xs red' onclick=\"DeleteByIds('" + id + "')\" title='删除'></a>";

            return result;
        }

 假设我们需要双击弹出编辑界面的层,我们得以拍卖表格的双击事件,如下代码所示。

                onDblClickRow: function (row, $element) {
                    var id = row.ID;
                    EditViewById(id, 'view');
                },

图片 9

比方我们需要设置行的例外的样式展现,可以透过扩充rowStyle的JS处理函数即可,如下代码所示

                rowStyle: function (row, index) { //设置行的特殊样式
                    //这里有5个取值颜色['active', 'success', 'info', 'warning', 'danger'];
                    var strclass = "";
                    if (index == 0) {
                        strclass = "warning";
                    }
                    return { classes: strclass }
                }

 对于表格记录的收获,大家得以经过下面的代码举办获取:$table.bootstrapTable(‘getSelections’)

            var rows = $table.bootstrapTable('getSelections');
            if (rows.length > 0) {
                ID = rows[0].ID;
            }

假定是多条记下的拍卖,例如删除记录

        //实现删除数据的方法
        function Delete() {
            var ids = "";//得到用户选择的数据的ID
            var rows = $table.bootstrapTable('getSelections');
            for (var i = 0; i < rows.length; i++) {
                ids += rows[i].ID + ',';
            }
            ids = ids.substring(0, ids.length - 1);

            DeleteByIds(ids);
        }

比方急需设置显示列彰显,如下界面所示

图片 10

以及排序处理

图片 11

那个需要在JS代码开启相关的习性即可。

图片 12

还有就是一种CardView的卡片视图格式,如下所示。

图片 13

除此以外一种是父子表的展开明细的格式,如下所示

图片 14

 以上就是bootstrap-table插件在自家骨子里项目中的应用情况,基本上对JS各样属性的使用举行了部分介绍了,具体的应用我们得以参照它的文档,获取对应属性、方法、事件的事无巨细表达,这样大家就足以更进一步详细的施用这几个插件的各样效用了。

 http://bootstrap-table.wenzhixin.net.cn/documentation/

期待地点的下结论介绍对您利用bootstrap-table插件有所助益,感谢耐心阅读。

 

 相关核心小说如下所示:

依照Metronic的Bootstrap开发框架经验总计(15)– 更新使用Metronic
4.75版本

从开发框架提升开支功用说起 

按照Metronic的Bootstrap开发框架经验总结(14)–条码和二维码的变通及打印处理

据悉Metronic的Bootstrap开发框架经验总括(13)–页面链接收藏夹功效的兑现2

基于Metronic的Bootstrap开发框架经验总括(12)–页面链接收藏夹成效的落实

依照Metronic的Bootstrap开发框架经验总括(11)–页面菜单的三种表现情势 

遵照Metronic的Bootstrap开发框架经验总括(10)–优化Bootstrap图标管理 

在MVC控制器里面使用dynamic和ExpandoObject,实现数量转义的出口

遵照Metronic的Bootstrap开发框架经验总计(9)–实现Web页面内容的打印预览和保存操作

据悉Metronic的Bootstrap开发框架经验总计(8)–框架效用一体化界面介绍

基于Metronic的Bootstrap开发框架经验总计(7)–数据的导入、导出及附件的查阅处理 

基于Metronic的Bootstrap开发框架经验总括(6)–对话框及提醒框的处理和优化

依据Metronic的Bootstrap开发框架经验总结(5)–Bootstrap文件上传插件File
Input的行使

据悉Metronic的Bootstrap开发框架经验总括(4)–Bootstrap图标的领到和使用

基于Metronic的Bootstrap开发框架经验总括(3)–下拉列表Select2插件的接纳 

依照Metronic的Bootstrap开发框架经验总括(2)–列表分页处理和插件JSTree的行使

据悉Metronic的Bootstrap开发框架经验总计(1)-框架总览及菜单模块的处理 

相关文章