dHtmlxGrid 使用手册
Phoenixjava 整理于 2011-11-02
目录
目录.....................................................................................................................................................2
1. 自定义 XML:................................................................................................................................7
2. 支持多行表头、表尾展现...........................................................................................................7
3. 移动、添加、删除列...................................................................................................................8
4. 处理大型数据集-支持分页..........................................................................................................8
5. 处理大型数据集-智能渲染..........................................................................................................9
6. 与数据库交互...............................................................................................................................9
7. 扩展单元格-EXCEL...................................................................................................................10
8. 拆分模式（冻结栏）.................................................................................................................10
9. 控制于一体的网络和树.............................................................................................................11
2.1 表格操作 API.............................................................................................................12
2.1.1 attachEvent(evName , evHandler)..........................................................................................12
2.1.2 attachFooter(values, style)......................................................................................................14
2.1.3 attachHeader(values, style).....................................................................................................15
2.1.4 attachToObject(obj)................................................................................................................16
2.1.5 destructor................................................................................................................................17
2.1.6 detachEvent(id).......................................................................................................................18
2.1.7 detachFooter(index)................................................................................................................18
2.2 表格样式 API.............................................................................................................19
2.2.1 detachHeader(index)...............................................................................................................19
2.2.2 enableAutoHeight(mode,maxHeight, countFullHeight)........................................................19
2.2.3 enableAutoWidth (mode, max_limit, min_limit)...................................................................20
2.2.4 enableCellIds(mode)...............................................................................................................21
2.2.5 enableHeaderImages(fl)..........................................................................................................21
2.2.6 init...........................................................................................................................................22
2.2.7 setAwaitedRowHeight(height)...............................................................................................22
2.2.8 setCSVDelimiter(str)..............................................................................................................23
2.2.9 setColAlign(alStr)...................................................................................................................23
2.2.10 setColSorting(sortStr)...........................................................................................................23
2.2.11 setColTypes(typeStr)............................................................................................................24
2.2.12 setColVAlign(valStr)............................................................................................................24
2.2.13 setColWidth (ind, value).......................................................................................................25
2.2.14 setDelimiter (delim)..............................................................................................................25
2.2.15 setHeader (hdrStr, splitSign, styles).....................................................................................25
2.2.16 setIconPath (path).................................................................................................................26
2.2.17 setImagePath (path)..............................................................................................................26
2.2.18 setInitWidths (wp)................................................................................................................27
2.2.19 setInitWidthsP(wp)...............................................................................................................27
2.2.20 setNoHeader(fl)....................................................................................................................28
2.2.21 setSkin(name).......................................................................................................................28
2.2.22 setStyle (ss_header, ss_grid, ss_selCell, ss_selRow)...........................................................29
2.2.23uid..........................................................................................................................................29
3.1 dhtmlxgrid数据加载部分...........................................................................................30
3.1.31 changePage(pageNum).........................................................................................................30
3.1.32 changePageRelative(ind)......................................................................................................30
3.1.33 clearAll(header)....................................................................................................................30
3.1.34 clearAndLoad (url, call, type)...............................................................................................31
3.1.35 enableCSVAutoID(mode).....................................................................................................31
3.1.36 enableCSVHeader(mode).....................................................................................................31
3.1.37 enableDistributedParsing=(mode, count, time).....................................................................32
3.1.39 (mode,buffer,reserved)..........................................................................................................32
3.1.40 getRowAttribute (rId, name)................................................................................................33
3.1.41 getStateOfView.....................................................................................................................33
3.1.43 load (url, call, type)...............................................................................................................34
3.1.44 loadCSVFile (path,afterCall)................................................................................................34
3.1.45 loadCSVString(str)...............................................................................................................34
3.1.46 parse(data,call,type)..............................................................................................................35
3.1.47 preventIECaching(mode)......................................................................................................35
3.1.48 setPagingSkin(name)............................................................................................................35
3.1.49 setPagingTemplates(navigation_template,info_template)....................................................36
3.1.50 setPagingWTMode(navButtons,navLabel,pageSelect,perPageSelect)................................36
3.1.51 setRowAttribute(rId, name, value).......................................................................................36
3.1.52 setUserData (row_id, name, value)......................................................................................37
3.1.53 startFastOperations...............................................................................................................37
3.1.54 stopFastOperations...............................................................................................................37
3.1.55 updateFromXML (url, insert_new, del_missed, afterCall)...................................................37
3.2 dhtmlxgrid保存数据操作...........................................................................................38
3.2.160 enableMathSerialization (mode).........................................................................................38
3.2.161 serialize...............................................................................................................................38
3.2.162 serializeToCSV (textmode)................................................................................................38
3.2.163 setFieldNam (mask)............................................................................................................39
3.2.164 setSerializableColumns (list)..............................................................................................39
3.2.165 setSerializationLevel (userData, selectedAttr, config, changedAttr, onlyChanged,
asCDATA)........................................................................................................................................39
4.1 dhtmlxgrid行操作......................................................................................................41
4.1.56 addRow (new_id, text, ind)..................................................................................................41
4.1.57 changeRowId (oldRowId, newRowId).................................................................................41
4.1.58 copyRowContent (from_row_id, to_row_id).......................................................................42
4.1.59 deleteRow(row_id)...............................................................................................................42
4.1.60 deleteSelectedRows..............................................................................................................42
4.1.61 doesRowExist(row_id).........................................................................................................42
4.1.62 enableAlterCss (cssE, cssU, perLevel, levelUnique)...........................................................43
4.1.63 enableMultiline(state)...........................................................................................................43
4.1.64 enableRowsHover (mode, cssClass).....................................................................................44
4.1.65 enableRowspan.....................................................................................................................44
4.1.66 forEachRow (custom_code).................................................................................................44
4.1.67 getAllRowIds(separator)......................................................................................................45
4.1.68 getChangedRows (and_added).............................................................................................45
4.1.69 getCheckedRows (col_ind)...................................................................................................45
4.1.70 getRowId(ind).......................................................................................................................45
4.1.71 getRowIndex(row_id)=..........................................................................................................46
4.1.72 getRowsNum........................................................................................................................46
4.1.73 getSelectedRowId.................................................................................................................46
4.1.74 lockRow(rowId,mode)..........................................................................................................46
4.1.75 moveRow (rowId,mode,targetId,targetGrid)........................................................................47
4.1.76 moveRowDown(row_id)......................................................................................................47
4.1.77 moveRowTo(srowId,trowId,mode,dropmode,sourceGrid,targetGrid).................................47
4.1.78 moveRowUp(row_id)...........................................................................................................48
4.1.79 selectRow (rIndex, fl, preserve, show).................................................................................48
4.1.80 selectRowById (row_id, preserve, show, call).....................................................................48
4.1.81 setCheckedRows (cInd,v).....................................................................................................49
4.1.82 setRowColor(row_id,color)..................................................................................................49
4.1.83 setRowExcellType (rowId, type)..........................................................................................49
4.1.84 setRowHidden (id, state)......................................................................................................49
4.1.85 setRowId (ind, row_id).........................................................................................................50
4.1.86 setRowTextBold (row_id)....................................................................................................50
4.1.87 setRowTextNormal(row_id).................................................................................................50
4.1.88 setRowTextStyle (row_id, styleString).................................................................................50
4.1.89 showRow (rowID)................................................................................................................51
4.2 dhtmlxgrid列操作......................................................................................................51
4.2.90 adjustColumnSize(cind).......................................................................................................51
4.2.91 deleteColumn(ind)................................................................................................................51
4.2.92 enableColumnMove (mode,columns)..................................................................................52
4.2.93 enableHeaderMenu...............................................................................................................52
4.2.94 enableResizing(list)..............................................................................................................52
4.2.95 enableTooltips(list)...............................................................................................................52
4.2.96 getColIndexById (id)............................................................................................................53
4.2.97 getColType(index)................................................................................................................53
4.2.98 getColTypeById (cID)..........................................................................................................53
4.2.99 getColWidth (ind).................................................................................................................53
4.2.100 getColumnId (cin)...............................................................................................................54
4.2.101 getColumnLabel (cin, ind)..................................................................................................54
4.2.102 getColumnsNum.................................................................................................................54
4.2.103 getFooterLabel (cin, ind)....................................................................................................54
4.2.104 insertColumn(ind,header,type,width,sort,align,valign,reserved,columnColor)..................55
4.2.105 isColumnHidden (ind)........................................................................................................55
4.2.106 moveColumn (oldInd,newInd)...........................................................................................55
4.2.107 setColumnColor (clr)..........................................................................................................56
4.2.108 setColumnExcellType (colIndex, type)..............................................................................56
4.2.109 setColumnHidden (ind, state).............................................................................................56
4.2.110 setColumnId (ind, id)..........................................................................................................56
4.2.111 setColumnIds (ids)..............................................................................................................57
4.2.112 setColumnLabel (col, label, ind).........................................................................................57
4.2.113 setColumnMinWidth (width, ind).......................................................................................57
4.2.114 setColumnsVisibility (list)..................................................................................................58
4.2.115 setFooterLabel (c, label, ind)..............................................................................................58
4.3 dhtmlxgrid单元格操作...............................................................................................58
4.3.116 cellById (row_id, col).........................................................................................................58
4.3.117 cellByIndex (row_index, col).............................................................................................59
4.3.118 cells(row_id, col)................................................................................................................59
4.3.119 cells2 (row_index, col).......................................................................................................59
4.3.120 checkAll(mode)..................................................................................................................59
4.3.121 clearChangedState..............................................................................................................59
4.3.122 editCell................................................................................................................................59
4.3.123 editStop...............................................................................................................................60
4.3.124 enableColSpan (mode).......................................................................................................60
4.3.125 enableEditEvents (click, dblclick, f2Key)..........................................................................60
4.3.126 enableMarkedCells (mode).................................................................................................60
4.3.127 enableMathEditing (mode).................................................................................................60
4.3.128 forEachCell (rowId, custom_code).....................................................................................61
4.3.129 getCombo (col_ind)............................................................................................................61
4.3.130 getCustomCombo (id, ind).................................................................................................61
4.3.131 getMarked...........................................................................................................................61
4.3.132 getSelectedCellIndex..........................................................................................................62
4.3.133 mark (rid,cindex,fl).............................................................................................................62
4.3.134 selectCell (r, cInd, fl, preserve, edit, show)........................................................................62
4.3.135 setCellExcellType (rowId, cellIndex, type)........................................................................62
4.3.136 setCellTextStyle (row_id, ind, styleString)........................................................................63
4.3.137 setColspan (row_id, col_ind, colspan)...............................................................................63
4.3.138 setDateFormat (mask).........................................................................................................63
4.3.139 setEditable (mode)..............................................................................................................64
4.3.140 setMathRound (digits)........................................................................................................64
4.3.141 setNumberFormat (mask, cInd, p_sep, d_sep)...................................................................64
4.3.142 setRowspan (rowID,colInd,length).....................................................................................64
4.3.143 uncheckAll..........................................................................................................................65
4.3.144 unmarkAll...........................................................................................................................65
4.4 dhtmlxgrid选择过滤操作...........................................................................................65
4.4.144 clearSelection......................................................................................................................65
4.4.145 enableBlockSelection(mode)..............................................................................................65
4.4.146 enableMultiselect (state).....................................................................................................65
4.4.147 forceLabelSelection(mode)................................................................................................66
- 1
- 2
- 3
前往页