jQuery EasyUI API 中文文档 - DataGrid数据表格


Posted in Javascript onNovember 17, 2011

扩展自 $.fn.panel.defaults ,用 $.fn.datagrid.defaults 重写了 defaults 。
依赖
panel
resizable
linkbutton
pagination
用法

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

$('#tt').datagrid({ 
url:'datagrid_data.json', 
columns:[[ 
{field:'code',title:'Code',width:100}, 
{field:'name',title:'Name',width:100}, 
{field:'price',title:'Price',width:100,align:'right'} 
]] 
});

数据表格(DataGrid)的特性<?XML:NAMESPACE PREFIX = O />

其特性扩展自 panel,下列是为 datagrid 增加的特性。

名称 类型 说明 默认值
columns array datagrid 的 column 的配置对象,更多详细请参见 column 的特性。 null
frozenColumns array 和列的特性一样,但是这些列将被冻结在左边。 null
fitColumns boolean True 就会自动扩大或缩小列的尺寸以适应表格的宽度并且防止水平滚动。 false
striped boolean True 就把行条纹化。(即奇偶行使用不同背景色) false
method string 请求远程数据的 method 类型。 post
nowrap boolean True 就会把数据显示在一行里。 true
idField string 标识字段。 null
url string 从远程站点请求数据的 URL。 null
loadMsg string 当从远程站点加载数据时,显示的提示信息。 Processing, please wait …
pagination boolean True 就会在 datagrid 的底部显示分页栏。 false
rownumbers boolean True 就会显示行号的列。 false
singleSelect boolean True 就会只允许选中一行。 false
pageNumber number 当设置了 pagination 特性时,初始化页码。 1
pageSize number 当设置了 pagination 特性时,初始化页码尺寸。 10
pageList array 当设置了 pagination 特性时,初始化页面尺寸的选择列表。 [10,20,30,40,50]
queryParams object 当请求远程数据时,发送的额外参数。 {}
sortName string 定义可以排序的列。 null
sortOrder string 定义列的排序顺序,只能用 'asc' 或 'desc'。 asc
remoteSort boolean 定义是否从服务器给数据排序。 true
showFooter boolean 定义是否显示一行页脚。 false
rowStyler function 返回例如 'background:red' 的样式,该函数需要两个参数:rowIndex: 行的索引,从 0 开始。rowData: 此行相应的记录。  
loadFilter function 返回过滤的数据去显示。这个函数需要一个参数 'data' ,表示原始数据。 你可以把原始数据变成标准数据格式,此函数必须返回标准数据对象,含有 'total' 和 'rows' 特性。  
editors object 定义编辑行时的 editor 。 预定义的 editor
view object 定义 datagrid 的 view 。 默认的 view
列(Column)的特性
DataGrid 的 Column 是一个数组对象,它的每个元素也是一个数组。数组元素的元素是一个配置对象,它定义了每个列的字段。
代码示例:
columns:[[ 
{field:'itemid',title:'Item ID',rowspan:2,width:80,sortable:true}, 
{field:'productid',title:'Product ID',rowspan:2,width:80,sortable:true}, 
{title:'Item Details',colspan:4} 
],[ 
{field:'listprice',title:'List Price',width:80,align:'right',sortable:true}, 
{field:'unitcost',title:'Unit Cost',width:80,align:'right',sortable:true}, 
{field:'attr1',title:'Attribute',width:100}, 
{field:'status',title:'Status',width:60} 
]]

名称 类型 说明 默认值
title string 列的标题文字。 undefined
field string 列的字段名。 undefined
width number 列的宽度。 undefined
rowspan number 指一个单元格占据多少行。 undefined
colspan number 指一个单元格占据多少列。 undefined
align string 指如何对齐此列的数据,可以用 'left'、'right'、'center'。 undefined
sortable boolean True 就允许此列被排序。 undefined
resizable boolean True 就允许此列被调整尺寸。 undefined
hidden boolean True 就隐藏此列。 undefined
checkbox boolean True 就显示 checkbox。 undefined
formatter function 单元格的格式化函数,需要三个参数: value: 字段的值。rowData: 行的记录数据。rowIndex: 行的索引。 undefined
styler function 单元格的样式函数,返回样式字符串来自定义此单元格的样式,例如 'background:red' 。此函数需要三个参数:value: 字段的值。rowData: 行的记录数据。rowIndex: 行的索引。 undefined
sorter function 自定义字段的排序函数,需要两个参数:a: 第一个字段值。b: 第二个字段值。 undefined
editor string,object 指编辑类型。当是 string 时指编辑类型,当 object 时包含两个特性: type:string,编辑类型,可能的类型是:  text、textarea、checkbox、numberbox、validatebox、datebox、combobox、combotree。options:对象,编辑类型对应的编辑器选项。 undefined
编辑器(Editor)

用 $.fn.datagrid.defaults.editors 重写了 defaults。

每个编辑器有下列行为:

名称 参数 说明
init container, options 初始化编辑器并且返回目标对象。
destroy target 如果必要就销毁编辑器。
getValue target 从编辑器的文本返回值。
setValue target , value 给编辑器设置值。
resize target , width 如果必要就调整编辑器的尺寸。
例如,文本编辑器(text editor)像下面这样定义:
$.extend($.fn.datagrid.defaults.editors, { 
text: { 
init: function(container, options){ 
var input = $('<input type="text" class="datagrid-editable-input">').appendTo(container); 
return input; 
}, 
getValue: function(target){ 
return $(target).val(); 
}, 
setValue: function(target, value){ 
$(target).val(value); 
}, 
resize: function(target, width){ 
var input = $(target); 
if ($.boxModel == true){ 
input.width(width - (input.outerWidth() - input.width())); 
} else { 
input.width(width); 
} 
} 
} 
});

数据表格视图(DataGrid View)
用 $.fn.datagrid.defaults.view 重写了 defaults。
view 是一个对象,它告诉 datagrid 如何呈现行。这个对象必须定义下列方法。
名称 参数 说明
render target, container, frozen 当数据加载时调用。target:DOM 对象,datagrid 对象。container:行的容器。frozen:表示是否呈现冻结容器。
renderFooter target, container, frozen 这是呈现行脚选项的函数。
renderRow target, fields, frozen, rowIndex, rowData 这是选项的函数,将会被 render 函数调用。
refreshRow target, rowIndex 定义如何刷新指定的行。
onBeforeRender target, rows 视图被呈现前触发。
onAfterRender target 视图被呈现后触发。
事件

其事件扩展自 panel,下列是为 datagrid 增加的事件。

名称 参数 说明
onLoadSuccess data 当数据加载成功时触发。
onLoadError none 加载远程数据发生某些错误时触发。
onBeforeLoad param 发送加载数据的请求前触发,如果返回 false加载动作就会取消。
onClickRow rowIndex, rowData 当用户点击一行时触发,参数包括: rowIndex:被点击行的索引,从 0 开始。rowData:被点击行对应的记录。
onDblClickRow rowIndex, rowData 当用户双击一行时触发,参数包括: rowIndex:被双击行的索引,从 0 开始。rowData:被双击行对应的记录。
onClickCell rowIndex, field, value 当用户单击一个单元格时触发。
onDblClickCell rowIndex, field, value 当用户双击一个单元格时触发。
onSortColumn sort, order 当用户对一列进行排序时触发,参数包括: sort:排序的列的字段名order:排序的列的顺序
onResizeColumn field, width 当用户调整列的尺寸时触发。
onSelect rowIndex, rowData 当用户选中一行时触发,参数包括: rowIndex:选中行的索引,从 0 开始rowData:选中行对应的记录
onUnselect rowIndex, rowData 当用户取消选择一行时触发,参数包括: rowIndex:取消选中行的索引,从 0 开始rowData:取消选中行对应的记录
onSelectAll rows 当用户选中全部行时触发。
onUnselectAll rows 当用户取消选中全部行时触发。
onBeforeEdit rowIndex, rowData 当用户开始编辑一行时触发,参数包括: rowIndex:编辑行的索引,从 0 开始rowData:编辑行对应的记录
onAfterEdit rowIndex, rowData, changes 当用户完成编辑一行时触发,参数包括: rowIndex:编辑行的索引,从 0 开始rowData:编辑行对应的记录changes:更改的字段/值对
onCancelEdit rowIndex, rowData 当用户取消编辑一行时触发,参数包括: rowIndex:编辑行的索引,从 0 开始rowData:编辑行对应的记录
onHeaderContextMenu e, field 当 datagrid 的头部被右键单击时触发。
onRowContextMenu e, rowIndex, rowData 当右键点击行时触发。

方法

名称 参数 说明
options none 返回 options 对象。
getPager none 返回 pager 对象。
getPanel none 返回 panel 对象。
getColumnFields frozen 返回列的字段,如果 frozen 设定为 true,冻结列的字段被返回。
getColumnOption field 返回指定列的选项。
resize param 调整尺寸和布局。
load param 加载并显示第一页的行,如果指定 param 参数,它将替换 queryParams 特性。
reload param 重新加载行,就像 load 方法一样,但是保持在当前页。
reloadFooter footer 重新加载脚部的行。
loading none 显示正在加载状态。
loaded none 隐藏正在加载状态。
fitColumns none 使列自动展开/折叠以适应 datagrid 的宽度。
fixColumnSize none 固定列的尺寸。
fixRowHeight index 固定指定行的高度。
loadData data 加载本地数据,旧的行会被移除。
getData none 返回加载的数据。
getRows none 返回当前页的行。
getFooterRows none 返回脚部的行。
getRowIndex row 返回指定行的索引,row 参数可以是一个行记录或者一个 id 字段的值。
getSelected none 返回第一个选中的行或者 null。
getSelections none 返回所有选中的行,当没有选中的记录时,将返回空数组。
clearSelections none 清除所有的选择。
selectAll none 选中当前页所有的行。
unselectAll none 取消选中当前页所有的行。
selectRow index 选中一行,行索引从 0 开始。
selectRecord idValue 通过 id 的值做参数选中一行。
unselectRow index 取消选中一行。
beginEdit index 开始对一行进行编辑。
endEdit index 结束对一行进行编辑。
cancelEdit index 取消对一行进行编辑。
getEditors index 获取指定行的编辑器们。每个编辑器有下列特性:actions:编辑器能做的动作们。target:目标编辑器的 jQuery 对象。field:字段名。type:编辑器的类型。
getEditor options 获取指定的编辑器, options 参数包含两个特性: index:行的索引。field:字段名。
refreshRow index 刷新一行。
validateRow index 验证指定的行,有效时返回 true。
updateRow param 更新指定的行, param 参数包含下列特性:index:更新行的索引。row:行的新数据。
appendRow row 追加一个新行。
insertRow param 插入一个新行, param 参数包括下列特性:index:插入进去的行的索引,如果没有定义,就追加此新行。row:行的数据。
deleteRow index 删除一行。
getChanges type 获取最后一次提交以来更改的行,type 参数表示更改的行的类型,可能的值是:inserted、deleted、updated,等等。 当 type 参数没有分配时,返回所有改变的行。
acceptChanges none 提交自从被加载以来或最后一次调用acceptChanges以来所有更改的数据。
rejectChanges none 回滚自从创建以来或最后一次调用acceptChanges以来所有更改的数据。
mergeCells options 把一些单元格合并为一个单元格,options 参数包括下列特性:index:列的索引。field:字段名。rowspan:合并跨越的行数。colspan:合并跨越的列数。
showColumn field 显示指定的列。
hideColumn field 隐藏指定的列。
Javascript 相关文章推荐
HTA版JSMin(省略修饰语若干)基于javascript语言编写
Dec 24 Javascript
浏览器图片选择预览、旋转、批量上传的JS代码实现
Dec 04 Javascript
Jquery插件分享之气泡形提示控件grumble.js
May 20 Javascript
使用window.prompt()实现弹出用户输入的对话框
Apr 13 Javascript
angularjs客户端实现压缩图片文件并上传实例
Jul 06 Javascript
JavaScript html5 canvas绘制时钟效果(二)
Mar 27 Javascript
JavaScript的兼容性与调试技巧
Nov 22 Javascript
Gulp实现静态网页模块化的方法详解
Jan 09 Javascript
详解Vue-Router源码分析路由实现原理
May 15 Javascript
浅入深出Vue之自动化路由
Aug 06 Javascript
详解Java中String JSONObject JSONArray List转换
Nov 13 Javascript
Vant+postcss-pxtorem 实现浏览器适配功能
Feb 05 Javascript
Jquery 获取checkbox的checked问题
Nov 16 #Javascript
JS 操作符整理[推荐收藏]
Nov 15 #Javascript
js 关于=+与+=日期函数使用说明(赋值运算符)
Nov 15 #Javascript
关于js datetime的那点事
Nov 15 #Javascript
基于jquery封装的一个js分页
Nov 15 #Javascript
js 利用className得到对象的实现代码
Nov 15 #Javascript
基于jquery的web页面日期格式化插件
Nov 15 #Javascript
You might like
UCenter 批量添加用户的php代码
2012/07/17 PHP
PHP排序算法之基数排序(Radix Sort)实例详解
2018/04/21 PHP
Nigma vs AM BO3 第二场2.13
2021/03/10 DOTA
javascript编程起步(第六课)
2007/01/10 Javascript
对采用动态原型方式无法展示继承机制得思考
2009/12/04 Javascript
Javascript Math ceil()、floor()、round()三个函数的区别
2010/03/09 Javascript
js转化毫秒为时间格式代码
2014/04/10 Javascript
jQuery实现数秒后自动提交form的方法
2015/03/05 Javascript
使用jQuery实现图片遮罩半透明坠落遮挡
2015/03/16 Javascript
js省市县三级联动效果实例
2020/04/15 Javascript
微信小程序实战之上拉(分页加载)效果(2)
2017/04/17 Javascript
Javascript 编码约定(编码规范)
2018/03/11 Javascript
总结javascript三元运算符知识点
2018/09/28 Javascript
利用原生JS实现data方法示例代码
2019/05/28 Javascript
详解vue-cli@2.x项目迁移日志
2019/06/06 Javascript
Vue如何基于vue-i18n实现多国语言兼容
2020/07/17 Javascript
[03:22]DOTA2超级联赛专访单车:找到属于自己的英雄
2013/06/08 DOTA
python学习笔记:字典的使用示例详解
2014/06/13 Python
Python 异常处理的实例详解
2017/09/11 Python
python中logging包的使用总结
2018/02/28 Python
Python实现判断并移除列表指定位置元素的方法
2018/04/13 Python
python:print格式化输出到文件的实例
2018/05/14 Python
Linux下python3.6.1环境配置教程
2018/09/26 Python
详谈Python 窗体(tkinter)表格数据(Treeview)
2018/10/11 Python
python之信息加密题目详解
2019/06/26 Python
Python 实现使用空值进行赋值 None
2020/03/12 Python
pytorch快速搭建神经网络_Sequential操作
2020/06/17 Python
python+openCV对视频进行截取的实现
2020/11/27 Python
理工大学毕业生自荐信
2013/11/01 职场文书
教育技术学专业职业规划书
2014/03/03 职场文书
教师一帮一活动总结
2014/07/08 职场文书
小学毕业感言100字
2015/07/30 职场文书
小学五年级(说明文3篇)
2019/08/13 职场文书
100句人生哲理语录集锦:强者征服今天,懒汉坐等明天
2019/10/18 职场文书
vue实现滑动解锁功能
2022/03/03 Vue.js
mybatis 获取更新记录的id
2022/05/20 Java/Android