dhtmlxGrid API 汉化

更新时间:2024-01-04 15:09:01 阅读量: 教育文库 文档下载

说明:文章内容仅供预览,部分内容可能不全。下载后的文档,内容与下面显示的完全一致。下载之前请确认下面内容是否您想要的,是否完整无缺。

1.1.56 addRow (new_id, text, ind) new_id:行id grid中唯一

text:行内容,多列数据以分隔符合隔开字符串,或以数组形式提供

inx:行索引,行序号等,选填,默认在最后一行新增 用途:在grid中新增一行 参考实例:

grid.addRow(newId,\grid.addRow(newId,[\

1.1.57 changeRowId (oldRowId, newRowId) oldRowId:原id值

newRowId:新id值 grid 中唯一 用途:修改某行id值 参考实例:

mygrid.changeRowId(\

1.1.58 copyRowContent (from_row_id, to_row_id) from_row_id:源行id to_row_id:目标行id 用途:拷贝某行数据到目标行

参考实例:

mygrid.copyRowContent(\

1.1.59 deleteRow(row_id) row_id:行id

用途:通过行id删除目标行

参考实例:mygrid.deleteRow(\

1.1.60 deleteSelectedRows 用途:删除当前选中行数

参考实例:mygrid.deleteSelectedRows();

1.1.61 doesRowExist(row_id) row_id: 行id

用途:通过row_id检查是否行存在 参考实例:var

exist=mygrid.doesRowExist(\

1.1.62 enableAlterCss (cssE, cssU, perLevel, levelUnique)

cssE:偶数行样式名称(序号为准) cssU:奇数行样式名称

perLevel:是否排序、分层。默认为true,但在treegrid默认为false

levelUnique:否成存在唯一层 用途: 参考实例:

1.1.63 enableMultiline(state) state:true/false 用途:是否多选行模式

参考实例:mygrid.enableMultiline(true);

1.1.64 enableRowsHover (mode, cssClass) mode:true/false cssClass:样式名称,样式 用途:鼠标滑过当前行是否改变样式 参考实例:

1.1.65 enableRowspan 需要dhtmlxgrid_rowspan.js 用途:设置当前grid跨行可用

参考实例:mygrid.enableRowspan();

1.1.66 forEachRow (custom_code) custom_code:自定义js操作

用途:遍历当前行操作,提供rowid,供用户扩展自定义js操作

参考实例:

mygrid.forEachRow(function(id){ //自定义js操作 //id - row's id });

1.1.67 getAllRowIds(separator) separator:分隔符,默认为逗号 用途:获得所有行id,并与分隔符组合 参考实例:

//默认分隔符

var ids=mygrid.getAllRowIds();

//retrun list of row ids with dot delimiter var ids=mygrid.getAllRowIds(\

1.1.68 getChangedRows (and_added) and_added:true/false

用途:获得当前修改行的所有rowid组合,是否包含新增行 参考实例:

//获得修改行的rowid的组合

var ids=mygrid.getChangedRows();

//获得修改行的rowid的组合,包含新增行

var ids=mygrid.getChangedRows(true);

1.1.69 getCheckedRows (col_ind) col_ind:ck所在列索引

用途:获得当前选中行的所有rowid组合

参考实例:var checked=mygrid.getCheckedRows(0);

1.1.70 getRowId(ind) ind:行索引

用途:通过行索引获得行id

参考实例:var rowID=mygrid.getRowId(0);

1.1.71 getRowIndex(row_id) row_id:行id

用途:通过行id获得行索引

参考实例:var rowID=mygrid.getRowId(0);

1.1.72 getRowsNum 用途:通过grid中行数量

1.1.73 getSelectedRowId

用途:获得当前选中行id,多个以分隔符组合

1.1.74 lockRow(rowId,mode) rowid:行id mode:true/false

用途:是否锁定当前行,锁定后不可再编辑 参考实例:mygrid.lockRow(\

1.1.75 moveRow

(rowId,mode,targetId,targetGrid) 版本:专用版 dhtmlxgrid_drag.js支持 rowId:源rowid

mode:移动方向 up,down,row_sibling

targetId:目标rowid(跨grid),则移动到顶部 targetGrid:目标grid(跨grid) 用途:一个或多个grid间移动row 参考实例: //向上移动row

mygrid1.moveRow(\

//移动row1到mygrid2的row2之后

mygrid1.moveRow(\d2);

1.1.76 moveRowDown(row_id) rowId:行id 用途:向下移动当前行 1.1.77

moveRowTo(srowId,trowId,mode,dropmode,sourceGrid,targetGrid)

版本:专业版 dhtmlxgrid_drag.js srowId:源rowid

trowId:目标rowid 为空,则移动到顶部

mode:操作方式“move” or “copy”:copy是源grid保留当前row,反之则删除

dropmode:移动方式 同级或子级“sibling” or “child” (默认同级下方)

sourceGrid:源grid,默认当前grid中 targetGrid:目标grid默认当前grid中 用途:一个或多个grid间移动row 参考实例: //同一grid中移动

mygrid1.moveRowTo(\

//不同grid中拷贝

var

movedId=mygrid1.moveRowTo(\\

1.1.78 moveRowUp(row_id) 参考 moveRowDown

1.1.79 selectRow (rIndex, fl, preserve, show) rIndex:行索引或行对象

fl:true/false是否触发选中事件function

preserve:true/false 是否保存原有选中行,true时必须保证多选模式可用

show:是否自动滚动显示选中行,默认true 用途:行选择

参考实例:mygrid.selectRow(0);

mygrid.selectRow(0,true,true,true);

1.1.80 selectRowById (row_id, preserve, show, call)

row_id:行id

call:true/false是否触发选中事件function

preservel:true/false 是否保存原有选中行,true时必须保证多选模式可用

show:是否自动滚动显示选中行,默认true 用途:行选择

1.1.81 setCheckedRows (cInd,v)

cInd:列索引

v:是否选中 0 不选中,1 选中 用途:设置grid中行是否全选中

参考实例: mygrid.setCheckedRows(0,1);//全选中

mygrid.setCheckedRows(0,0); //全不选

1.1.82 setRowColor(row_id,color)

row_id:行id color:颜色

用途:设置某行背景颜色,grid加载后使用 参考实例:mygrid.setRowColor(\

1.1.83 setRowExcellType (rowId, type)

rowId:行id type:excell类型

(cp\\calck\\dhxCalendar\\dhxCalendarA\\calendar\\clist) 用途:设置某行数据为复杂的扩展类型

参考实例:mygrid.setRowExcellType(\

1.1.84 setRowHidden (id, state)

id:行id

state:true/false 用途:设置某行是否显示

参考实例:mygrid.setRowHidden(\

1.1.85 setRowId (ind, row_id)

Ind: 行索引 row_id:行id

用途:设置某行id值,grid内唯一

参考实例:mygrid.setRowId(0,\

1.1.86 setRowTextBold (row_id)

row_id:行id

用途:设置某行数据为粗体

参考实例:mygrid.setRowTextBold(\

1.1.87 setRowTextNormal(row_id)

row_id:行id

用途:设置某行数据为标准字体

参考实例:mygrid.setRowTextNormal(\

1.1.88 setRowTextStyle (row_id, styleString)

row_id:行id

styleString:样式字符串,以分隔符组合 用途:设置某行数据样式 参考实例:

grid.setRowTextStyle(\font-family: arial;\

1.1.89 showRow (rowID)

row_id:行id 用途:显示某行

*****************************************************************

列操作

1.1.90 adjustColumnSize(cind)

cind:列索引

用途:调整某列宽,使列所有数据可见,但需要在制定列宽的情况下,即不能设定列宽为 * 参考实例:

mygrid.adjustColumnSize(0);

1.1.91 deleteColumn(ind)

版本:专业版 dhtmlxgrid_mcol.js支持 cind:列索引

用途:调整某列宽,使列所有数据可见 参考实例:

mygrid.adjustColumnSize(0);

1.1.92 enableColumnMove (mode,columns)

版本:专业版 dhtmlxgrid_mcol.js支持 mode:true/false

columns:设定某列是否可以 用途:设置所有列或某列是否可以移动 参考实例: //全部列可移动

mygrid.enableColumnMove(true);

//某列可移动

mygrid.enableColumnMove(true,\true\

1.1.93 enableHeaderMenu

版本:专业版 dhtmlxgrid_hmenu.js支持 用途:设置表头右键菜单可用

1.1.94 enableResizing(list)

list:设置当前grid中各列size是否可变参数组合 用途:设置当前grid中各列size是否可变 参考实例:

myrid.enableResizing(\

1.1.95 enableTooltips(list)

list:设置当前grid中各列tooltip是否可用参数组合

用途:设置当前grid中各列tooltip是否可用,即当前列title是否显示 参考实例:

myrid.enableResizing(\

;1.1.96 getColIndexById (id)

id:列id

用途:通过列id获得列索引

参考实例:

var colIndex=mygrid.getColIndexById(\

1.1.97 getColType(index)

index:列索引

用途:通过列id索引获得列数据类型 参考实例:

var type=mygrid.getColType(0);

1.1.98 getColTypeById (cID)

cID:列ID

用途:通过列列ID获得列数据类型 参考实例:

var type=mygrid.getColTypeById(\

1.1.99 getColWidth (ind)

index:列索引

用途:通过列id索引获得列数据宽 参考实例:

var width=mygrid.getColWidth(0);

1.1.100 getColumnId (cin)

cin:列索引

用途:通过列id索引获得列Id

参考实例:

var colId=mygrid.getColumnId(0);

1.1.101 getColumnLabel (cin, ind)

cin:列索引

ind: 表头行索引,默认为0,只有在多表头下有用 用途:获得列标题 参考实例: //第一列标题

var colLabel=mygrid.getColumnLabel(0); //第一列第二个表头标题

var colLabel=mygrid.getColumnLabel(0,1);

1.1.102 getColumnsNum

用途:获得列的数量 参考实例:

var colNum=mygrid.getColumnsNum();

1.1.103 getFooterLabel (cin, ind)

参考getColumnLabel (cin, ind)

1.1.104

insertColumn(ind,header,type,width,sort,align,v

align,reserved,columnColor)

版本:专业版 需要dhtmlxgrid_mcol.js ind:列索引 header:列表头标题 type:列数据类型 width:列宽度 sort:排序方式 align:水平布局方式 valign:垂直布局方式 reserved:无效参数 columnColor:列背景颜色 用途:获得列的数量 参考实例: //最小设置

mygrid.insertColumn(10); //最大参数设置

mygrid.insertColumn(11,\

text\

1.1.105 isColumnHidden (ind)

ind:列索引

用途:判断当前索引列是否隐藏

参考实例:

var isHidden=mygrid.isColumnHidden(0);//隐藏返回true,反之false

1.1.106 moveColumn (oldInd,newInd)

版本:专业版 需要dhtmlxgrid_mcol.js oldInd:原列索引 newInd:新列索引

用途:通过列索引调整列位置 参考实例:

mygrid.mygrid.moveColumn(0,2);

1.1.107 setColumnColor (clr)

clr:颜色定义字符串 用途:定义列背景色 参考实例:

mygrid.setColumnColor(\ 1.1.108 setColumnExcellType (colIndex, type) colIndex:列索引 type: 扩展类型

用途:定义列数据为扩展类型 参考实例:

mygrid.setColumnExcellType(2,\

1.1.109 setColumnHidden (ind, state) ind:列索引 state:true/false

用途:设置当前索引列是否隐藏 参考实例:

mygrid.setColumnHidden(0,false); 1.1.110 setColumnId (ind, id) ind:列索引 id:列id

用途:通过索引设置列id 参考实例:

mygrid.setColumnId(0,\ 1.1.111 setColumnIds (ids) ids:列id组合

用途:设置grid内所有列的id,可重复定义,但通过id读取索引时,仅对第一个设置有效 参考实例:

mygrid.setColumnIds(\ing,best,date\

1.1.112 setColumnLabel (col, label, ind) col:表头索引 lable:标题

ind:多表头时索引 用途:设置grid表头标题 参考实例: //单表头设置

mygrid.setColumnLabel(0,\//多行表头设置

mygrid.setColumnLabel(0,\ 1.1.113 setColumnMinWidth (width, ind) width:宽度 ind:列索引

用途:设置grid某列、各列最小宽度 参考实例: //设置第一列

mygrid.setColumnMinWidth(50,0); //设置所有列

mygrid.setColumnMinWidth(\0\

1.1.114 setColumnsVisibility (list) list:各列是否可见参数组合,false可见,true隐藏 用途:设置各列是否可见 参考实例:

mygrid.setColumnsVisibility(\

1.1.115 setFooterLabel (c, label, ind) c: 列索引

lable:标题内容,可包含 img:[imageUrl] 图片引用格式 lnd:多表脚时,行索引 用途:设置表脚标题信息

1.1.116 cellById (row_id, col) row_id: rowId col:列索引

用途:获得单元格对象,无参数时返回当前选中cell对象 参考实例: var cellObj = grid.cellById(row_id, col);

1.1.117 cellByIndex (row_index, col)

通过行索引获得cell对象,参考cellById (row_id, col)

1.1.118 cells(row_id, col)

通过行id,列索引获得cell对象,参考cellById (row_id, col) 1.1.119 cells2 (row_index, col)

通过行索引,列索引获得cell对象,参考cellById (row_id, col) 1.1.120 checkAll(mode) mode: true/false

用途:设置grid内所有checkbox是否全部选中 参考实例: mygrid.checkAll(true);

1.1.121 clearChangedState 用途:清除grid内所有改变状态

参考实例: mygrid.clearChangedState(); 1.1.122 editCell

用途:清除grid内单元格为编辑状态 1.1.123 editStop

用途:清除grid内单元格为编辑状态 1.1.124 enableColSpan (mode) mode:true/false 用途:是否支持跨行操作

1.1.125 enableEditEvents (click, dblclick, f2Key) click:true|false 是否单击进入编辑状态 dbclick:true|false是否双击进入编辑状态 f2Key:true|false是否按F2进入编辑状态 用途:触发编辑模式的方法

参考实例:mygrid.enableEditEvents(true,false,true); 1.1.126 enableMarkedCells (mode) 需要dhtmlxgrid_markers.js mode:true|false 是否允许标记 用途:单元格设置标记

1.1.127 enableMathEditing (mode) 版本:专业版dhtmlxgrid_math.js

mode:true|false 是否允许编辑 用途:计算单元格是否允许编辑

参考实例: mygrid.enableMathEditing(true); 1.1.128 forEachCell (rowId, custom_code) 参考foreachrow_custom_code 1.1.129 getCombo (col_ind) col_ind:列索引

用途:获得当前列的combo对象 参考实例:

var combo=mygrid.getCombo(0); 1.1.130 getCustomCombo (id, ind) id: 行id ind:列索引

用途:当前自定义的combo对象 参考实例: var

combo=mygrid.getCustomCombo(\

1.1.131 getMarked 需要dhtmlxgrid_markers.js

用途:当前mark单元格数组(行id\\列索引)

参考实例: var markedArray = mygrid.getMarked();

1.1.132 getSelectedCellIndex

用途:返回当前选中cell索引,无选中则返回-1

参考实例: var ind=mygrid.getSelectedCellIndex();

1.1.133 mark (rid,cindex,fl) 需要 dhtmlxgrid_markers.js rid:行id cindex:列索引 fl:true/false

用途:设置单元格是否为标志状态

1.1.134 selectCell (r, cInd, fl, preserve, edit, show)

r:行索引或行对象 cind:单元格索引

fl:true/false 是否调用onRowSelect事件 preserve:true/false是否保存原有状态 edit:true/false 选中cell是否转为编辑状态 show:true/false 是否自动滚动选择 用途:选择某个单元格

1.1.135 setCellExcellType (rowId, cellIndex, type) rowid:行id

cellindex:单元格索引 type:单元格类型 用途:设置单元格类型

参考实例: mygrid.setCellExcellType(\

1.1.136 setCellTextStyle (row_id, ind, styleString) rowid:行id

cellindex:单元格索引 styleString:样式字符串 用途:设置单元格样式 参考实例:

mygrid.setCellTextStyle(\x solid gray;\

1.1.137 setColspan (row_id, col_ind, colspan) row_id:行id col_index:列索引 colspan:合并单元格数量

用途:设置单元格样式 参考实例:

mygrid.enableColSpan(true);

//merge first 2 cells in the row with id \ mygrid.setColspan(\1.1.138 setDateFormat (mask) mask:时间格式

用途:设置单元格时间格式,仅作用于“dhxCalendar” and “dhxCalendarA”

参考实例:mygrid.setDateFormat(\ 1.1.139 setEditable (mode) mode:true/false 用途:设置grid是否可编辑

1.1.140 setMathRound (digits) digits:true/false

用途:设置grid中数字表格精确位数 参考实例:mygrid.setMathRound(2);

1.1.141 setNumberFormat (mask, cInd, p_sep, d_sep) mask:格式 cind:列索引

p_sep: 小数为格式符号 d_sep: 整数分组符号 用途:设置grid中数字格式化 参考实例:

mygrid.setNumberFormat(\1.1.142 setRowspan (rowID,colInd,length) 设置跨行数setColspan 1.1.143 uncheckAll

用途:设置grid中checkbox全部不选 1.1.144 unmarkAll 用途:清除grid中单元格

本文来源:https://www.bwwdw.com/article/e0ax.html

Top