jqGridapi中文说明Word下载.docx
- 文档编号:18829618
- 上传时间:2023-01-01
- 格式:DOCX
- 页数:63
- 大小:40.85KB
jqGridapi中文说明Word下载.docx
《jqGridapi中文说明Word下载.docx》由会员分享,可在线阅读,更多相关《jqGridapi中文说明Word下载.docx(63页珍藏版)》请在冰豆网上搜索。
title>
My
First
Grid<
/title>
link
rel="
stylesheet"
type="
text/css"
media="
screen"
href="
css/ui-lightness/jquery-ui-1.7.1.custom.css"
js/src/css/ui.jqgrid.css"
js/src/css/jquery.searchFilter.css"
style>
html,
body
{
margin:
0;
padding:
font-size:
75%;
}
/style>
script
src="
js/jquery-1.3.2.min.js"
text/JavaScript"
/script>
js/src/grid.loader.js"
text/javascript"
/head>
body>
...
/body>
/html>
需要说明的是,jquery-ui的字体大小与jqgrid字体大小不一致,故需要在页面上在加上一段
style来指定页面上文字大小。
jqGrid皮肤
从3.5版本开始,jqGrid完全支持jqueryUI的theme。
我们可以从
也并不需要把所有的css文件都引入进来,只需导入核心css文件“ui.theme.css
”以及“ui.core.css”即可,文件位于目录development-bundle/themes下。
jqGrid原理
jqGrid是典型的B/S架构,服务器端只是提供数据管理,客户端只提供数据显示。
换句话说,jqGrid可以以一种更加简单的方式来展现你数据库的信息,而且也可以把客户端数据传回给服务器端。
对于jqGrid我们所关心的就是:
必须有一段代码把一些页面信息保存到数据库中,而且也能够把响应信息返回给客户端。
jqGrid是用ajax来实现对请求与响应的处理。
jqGrid参数
名称
类型
描述
默认值
可修改
url
string
获取数据的地址
datatype
从服务器端返回的数据类型,默认xml。
可选类型:
xml,local,json,jsonnp,script,xmlstring,jsonstring,clientside
mtype
ajax提交方式。
POST或者GET,默认GET
colNames
Array
列显示名称,是一个数组对象
colModel
常用到的属性:
name
列显示的名称;
index
传到服务器端用来排序用的列名称;
width
列宽度;
align
对齐方式;
sortable
是否可以排序
pager
定义翻页用的导航栏,必须是有效的html元素。
翻页工具栏可以放置在html页面任意位置
rowNum
int
在grid上显示记录条数,这个参数是要被传递到后台
rowList
array
一个下拉选择框,用来改变显示记录数,当选择时会覆盖rowNum参数传递到后台
sortname
默认的排序列。
可以是列名称或者是一个数字,这个参数会被提交到后台
viewrecords
boolean
定义是否要显示总记录数
caption
表格名称
ajaxGridOptions[a1]
object
对ajax参数进行全局设置,可以覆盖ajax事件
null
是
ajaxSelectOptions[a2]
对ajax的select参数进行全局设置
altclass
String
用来指定行显示的css,可以编辑自己的css文件,只有当altRows设为
ture时起作用
ui-priority-secondary
altRows
设置表格
zebra-striped
值
autoencode
对url进行编码
false
autowidth
如果为ture时,则当表格在首次被创建时会根据父元素比例重新调整表格宽度。
如果父元素宽度改变,为了使表格宽度能够自动调整则需要实现函数:
setGridWidth
否
cellLayout
integer
定义了单元格padding+border
宽度。
通常不必修改此值。
初始值为
5
cellEdit
启用或者禁用单元格编辑功能
cellsubmit
定义了单元格内容保存位置
‘remote’
cellurl
单元格提交的url
空值
datastr
xmlstring或者jsonstring
deselectAfterSort
只有当datatype为local时起作用。
当排序时不选择当前行
true
direction
表格中文字的显示方向,从左向右(ltr)或者从右向左(rtr)
ltr
editurl
定义对form编辑时的url
emptyrecords
当返回的数据行数为0时显示的信息。
只有当属性
viewrecords
设置为ture时起作用
ExpandColClick
当为true时,点击展开行的文本时,treeGrid就能展开或者收缩,不仅仅是点击图片
ExpandColumn
指定那列来展开treegrid,默认为第一列,只有在treeGrid为true时起作用
footerrow[a3]
当为true时,会在翻页栏之上增加一行
forceFit
当为ture时,调整列宽度不会改变表格的宽度。
当shrinkToFit
为false时,此属性会被忽略
gridstate
定义当前表格的状态:
'
visible'
or'
hidden'
visible
gridview
构造一行数据后添加到grid中,如果设为true则是将整个表格的数据都构造完成后再添加到grid中,但treeGrid,subGrid,orafterInsertRow
不能用
height
mixed
表格高度,可以是数字,像素值或者百分比
150
hiddengrid
当为ture时,表格不会被显示,只显示表格的标题。
只有当点击显示表格的那个按钮时才会去初始化表格数据。
hidegrid
启用或者禁用控制表格显示、隐藏的按钮,只有当caption
属性不为空时起效
hoverrows
当为false时mousehovering会被禁用
jsonReader
描述json
数据格式的数组
lastpage
只读属性,定义了总页数
lastsort
只读属性,定义了最后排序列的索引,从0开始
loadonce
如果为ture则数据只从服务器端抓取一次,之后所有操作都是在客户端执行,翻页功能会被禁用
loadtext
当请求或者排序时所显示的文字内容
Loading....
loadui
当执行ajax请求时要干什么。
disable禁用ajax执行提示;
enable默认,当执行ajax请求时的提示;
block启用Loading提示,但是阻止其他操作
enable
multikey
只有在multiselect设置为ture时起作用,定义使用那个key来做多选。
shiftKey,altKey,ctrlKey
multiboxonly
只有当multiselect=true.起作用,当multiboxonly
为ture时只有选择checkbox才会起作用
multiselect
定义是否可以多选
multiselectWidth
当multiselect为true时设置multiselect列宽度
20
page
设置初始的页码
1
pagerpos
指定分页栏的位置
center
pgbuttons
是否显示翻页按钮
pginput
是否显示跳转页面的输入框
pgtext
当前页信息
prmNames
DefaultvaluesprmNames:
{page:
“page”,rows:
“rows”,sort:
“sidx”,order:
“sord”,search:
“_search”,nd:
“nd”,npage:
null}
当参数为null时不会被发到服务器端
none
postData
此数组内容直接赋值到url上,参数类型:
{name1:
value1…}
空array
reccount
只读属性,定义了grid中确切的行数。
通常情况下与records属性相同,但有一种情况例外,假如rowNum=15,但是从服务器端返回的记录数是20,那么records值是20,但reccount值仍然为15,而且表格中也只显示15条记录。
recordpos
定义了记录信息的位置:
left,center,right
right
records
只读属性,定义了返回的记录数
recordtext
显示记录数信息。
{0}
为记录数开始,{1}为记录数结束。
viewrecords为ture时才能起效,且总记录数大于0时才会显示此信息
resizeclass
定义一个class到一个列上用来显示列宽度调整时的效果
一个数组用来调整表格显示的记录数,此参数值会替代rowNum参数值传给服务器端。
[]
rownumbers
如果为ture则会在表格左边新增一列,显示行顺序号,从1开始递增。
此列名为'
rn'
.
rownumWidth
如果rownumbers为true,则可以设置column的宽度
25
savedRow
只读属性,只用在编辑模式下保存数据
scroll
创建一个动态滚动的表格,当为true时,翻页栏被禁用,使用垂直滚动条加载数据,且在首次访问服务器端时将加载所有数据到客户端。
当此参数为数字时,表格只控制可见的几行,所有数据都在这几行中加载
scrollOffset
设置垂直滚动条宽度
18
scrollrows
当为true时让所选择的行可见
selarrrow
只读属性,用来存放当前选择的行
selrow
只读属性,最后选择行的id
shrinkToFit
此属性用来说明当初始化列宽度时候的计算类型,如果为ture,则按比例初始化列宽度。
如果为false,则列宽度使用colModel指定的宽度
sortable
是否可排序
排序列的名称,此参数会被传到后台
空字符串
sortorder
排序顺序,升序或者降序(ascordesc)
asc
subGrid
是否使用suggrid
subGridModel
subgrid模型
subGridType
如果为空则使用表格的dataType
subGridUrl
加载subgrid数据的url,jqGrid会把每行的id值加到url中
subGridWidth
subgrid列的宽度
toolbar
表格的工具栏。
数组中有两个值,第一个为是否启用,第二个指定工具栏位置(相对于bodylayer),如:
[true,”both”]
。
工具栏位置可选值:
“top”,”bottom”,“both”.
如果工具栏在上面,则工具栏id为“t_”+表格id;
如果在下面则为
“tb_”+表格id;
如果只有一个工具栏则为
“t_”+表格id
[false,'
]
totaltime
只读属性,计算加载数据的时间。
目前支持xml跟json数据
treedatatype
数据类型,通常情况下与datatype相同,不会变
treeGrid
启用或者禁用treegrid模式
treeGridModel
treeGrid所使用的方法
Nested
treeIcons
树的图标,默认值:
{plus:
ui-icon-triangle-1-e'
minus:
ui-icon-triangle-1-s'
leaf:
ui-icon-radio-off'
}
treeReader
扩展表格的colModel且加在colModel定义的后面
tree_root_level
numeric
root元素的级别,
userData
从request中取得的一些用户信息
userDataOnFooter
当为true时把userData放到底部,用法:
如果userData的值与colModel的值相同,那么此列就显示正确的值,如果不等那么此列就为空
是否要显示总记录数
viewsortcols
定义排序列的外观跟行为。
数据格式:
vertical'
true].第一个参数是说,是否都要显示排序列的图标,false就是只显示
当前排序列的图标;
第二个参数是指图标如何显示,vertical:
排序图标垂直放置,horizontal:
排序图标水平放置;
第三个参数指单击功
能,true:
单击列可排序,false:
单击图标排序。
说明:
如果第三个参数为false则第一个参数必须为ture否则不能排序
width
number
如果设置则按此设置为主,如果没有设置则按colModel中定义的宽度计算
xmlReader
对xml数据结构的描述
Jqgrid学习-------ColModelAPI
ColModel是jqGrid里最重要的一个属性,设置表格列的属性。
属性
数据类型
备注
align
left,center,right.
left
classes
设置列的css。
多个class之间用空格分隔,如:
class1class2'
表格默认的css属性是ui-ellipsis
emptystring
datefmt
”/”,”-”,and”.”都是有效的日期分隔符。
y,Y,yyyy
年YY,yy
月m,mmformonthsd,dd
日.
ISODate(Y-m-d)
defval
查询字段的默认值
空
editable
单元格是否可编辑
editoptions
编辑的一系列选项。
{name:
’__department_id’,index:
’__department_id’,width:
200,editable:
true,edittype:
’select’,editoptions:
{dataUrl:
”${ctx}/admin/deplistforstu.action”}},这个是演示动态从服务器端获取数据。
empty
editrules
编辑的规则{name:
’age’,index:
’age’,width:
90,editable:
true,editrules:
{edithidden:
true,required:
true,number:
true,minValue:
10,maxValue:
100}},设定
年龄的最大值为100,最小值为10,而且为数字类型,并且为必输字段。
edittype
可以编辑的类型。
可选值:
text,textarea,select,checkbox,password,button,imageandfile.
text
fixed
列宽度是否要固定不可变
formoptions
对于form进行编辑时的属性设置
formatoptions
对某些列进行格式化的设置
formatter
对列进行格式化时设置的函数名或者类型
’sex’,index:
’sex’,align:
’center’,width:
60,editable:
{value:
’0:
待定;
1:
男;
2:
女’},formatter:
function(cellvalue,options,rowObject){
vartemp=“<
imgsrc=’${ctx}/jquery-ui-1.7.2.custom/css/img/”
if(cellvalue==1){
temp=temp+”user-white.png”;
}elseif(cellvalue==2){
temp=temp+”user-white-female.png”;
}else{
temp=temp+“user-silhouette.png”;
temp=temp+“‘border=’0′
”
returntemp;
}},//返回性别的图标。
hidedlg
是否显示或者隐藏此列
hidden
在初始化表格时是否要隐藏此列
index
索引。
其和后台交互的参数为sidx
jsonmap
定义了返回的json数据映射
key
当从服务器端返回的数据中没有id时,将此作为唯一rowid使用只有一个列可以做这项设置。
如果设置多于一个,那么只选取第一个,其他被忽略
label
如果colNames为空则用此值来作为列的显示名称,如果都没有设置则使用name
name
表格列的名称,所有关键字,保留字都不能作为名称使用包括subgrid,cbandrn.
Required
resizable
是否可以被resizable
search
b
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- jqGridapi 中文 说明