表格API
- 列
|方法 | 描述 |
|:--- | ---- |
|sizeColumnsToFit()| 調(diào)整列寬至表格合適的寬度 |
|setColumnDefs(colDefs)| 設(shè)置列定義 |
|setAutoGroupColumnDef(colDef)| 設(shè)置自動(dòng)組的定義 |
- 數(shù)據(jù)
|方法 | 描述 | 參數(shù)解析 |
|---- | ---- | ---- |
|setRowData(rows)| 設(shè)置行數(shù)據(jù) | |
|updateRowData(rows)| 插入行數(shù)據(jù) | add：添加
update: 更新
remove：移除<br />addIndex：位置 |
|applyTransaction(transaction)| 行數(shù)據(jù)更新 | |
|applyTransactionAsync(transaction, callback)| 異步行數(shù)據(jù)更新 | |
|setPinnedTopRowData(rowData)| 獲取固定頭部行數(shù)據(jù) | |
|setPinnedBottomRowData()| 獲取固定底部行數(shù)據(jù) | |
|getPinnedTopRowCount()| 獲取固定頭部行數(shù) | |
|getPinnedBottomRowCount() | 獲取固定底部行數(shù) | |
|getPinnedTopRow(index)| 獲取固定頭部行 | |
|getPinnedBottomRow(index)| 獲取固定底部行 | |
|getModel()| 獲取行模型 | |
|refreshClientSideRowModel(params)| 刷新客戶端行模型 | |
|setDatasource(datasource)| 設(shè)置數(shù)據(jù)給無限模型 | |
|setServerSideDatasource(datasource)| 設(shè)置數(shù)據(jù)給服務(wù)端模型 | |
|setViewportDatasource(datasource)| 設(shè)置數(shù)據(jù)給視圖模型 | |
transaction
interface RowDataTransaction {
// rows to add
add?: any[];
// rows to remove
remove?: any[];
// rows to update
update?: any[];
}
獲取行節(jié)點(diǎn)
|方法 | 描述 |
|---- | ---- |
|getRowNode(id)| 獲取行節(jié)點(diǎn) |
|forEachNode(callback(node, index))| 遍歷每個(gè)節(jié)點(diǎn) |
|forEachNodeAfterFilter(callback(node, index))| 遍歷過濾后的每個(gè)節(jié)點(diǎn) |
|forEachNodeAfterFilterAndSort(callback(node, index))| 遍歷過濾和排序后的節(jié)點(diǎn) |
|forEachLeafNode(callback(node, index))| 遍歷葉節(jié)點(diǎn) |行顯示
|方法 | 描述 |
|---- | ---- |
|getDisplayedRowAtIndex(index)| 返回顯示的行節(jié)點(diǎn) |
|getDisplayedRowCount()| 返回顯示行的總數(shù) |
|getFirstDisplayedRow()| 返回第一個(gè)顯示的行 |
|getLastDisplayedRow()| 返回最后一個(gè)顯示的行 |主要數(shù)據(jù)
|方法 | 描述 |
|---- | ---- |
|getDetailGridInfo(detailGridId)| |
|forEachDetailGridInfo(callback)| |選擇
|方法 | 描述 |
|---- | ---- |
|selectAll()| 全選 |
|deselectAll()| 取消全選 |
|selectAllFiltered()| 全選過濾后的 |
|deselectAllFiltered()| 取消全選過濾后的 |
|getSelectedNodes()| 獲取選中的節(jié)點(diǎn) |
|getSelectedRows()| 獲取選中的行 |
|getBestCostNodeSelection()| |
|getCellRanges()| 獲取單元格范圍 |
|addCellRange(params)| 添加單元格范圍 |
|clearRangeSelection()| 取消范圍選擇 |
|setSuppressRowClickSelection(value)| 設(shè)置suppressRowClickSelection的狀態(tài) |
interface AddCellRangeParams {
// start row
rowStartIndex?: number;
rowStartPinned?: string; // either 'top', 'bottom' or undefined
// end row
rowEndIndex?: number;
rowEndPinned?: string; // either 'top', 'bottom' or undefined
// columns
columnStart?: string | Column;
columnEnd?: string | Column;
columns?: (string | Column)[];
}
- 刷新
|方法 | 描述 |
|---- | ---- |
|refreshCells(RefreshCellsParams)| 對(duì)所有單元格執(zhí)行更改檢測(cè)扭弧，在需要時(shí)刷新單元格 |
|redrawRows(RedrawRowsParams)| 刪除行時(shí)初肉，將會(huì)重繪所有行 |
|refreshHeader()| 重繪標(biāo)題 |
|flashCells(FlashCellsParams)| 使單元格务荆，行楚堤，列閃爍 |
interface GetCellsParams {
rowNodes?: RowNode[];
columns?: (string | Column)[];
}
interface RefreshCellsParams extends GetCellsParams {
force?: boolean;
suppressFlash?: boolean;
}
interface FlashCellsParams extends GetCellsParams {
flashDelay?: number;
fadeDelay?: number;
}
interface RedrawRowsParams {
rowNodes?: RowNode[];
}
過濾和排序
|方法 | 描述 |
|---- | ---- |
|setQuickFilter(quickFilter)| 設(shè)置快速過濾器 |
|isQuickFilterPresent()| 是否使用快速過濾器 |
|isColumnFilterPresent()| 是否使用列過濾器 |
|isAnyFilterPresent()| 是否使用過濾器 |
|getFilterInstance(col, callback)| 獲取過濾器實(shí)例 |
|getFilterModel()| 獲取所有過濾狀態(tài) |
|setFilterModel(model)| 設(shè)置過濾狀態(tài) |
|onFilterChanged()| 通知表格過濾器已更改 |
|destroyFilter()| 銷毀過濾器 |
|onSortChanged()| 通知表格排序已更改 |
|setSortModel(model)| 設(shè)置排序狀態(tài) |
|getSortModel()| 獲取所有排序狀態(tài) |導(dǎo)航
|方法 | 描述 |
|---- | ---- |
|getFocusedCell()| 獲取單元格焦點(diǎn) |
|setFocusedCell(rowIndex, colKey, floating)| 設(shè)置單元格焦點(diǎn) |
|clearFocusedCell()| 刪除單元格聚焦 |
|tabToNextCell()| 將焦點(diǎn)移到下一個(gè)單元格 |
|tabToPreviousCell()| 將焦點(diǎn)移到上一個(gè)單元格 |
編輯
|方法 | 描述 |
|---- | ---- |
|stopEditing(cancel?)| 停止編輯 |
|startEditingCell(params)| 開始編輯 |
|getEditingCells()| 獲取編輯的單元格 |導(dǎo)出
|方法 | 描述 |
|---- | ---- |
|exportDataAsCsv(params)| |
|getDataAsCsv(params)| |
|exportDataAsExcel(params)| |
|getDataAsExcel(params)| |
- 事件
|方法 | 描述 |
|---- | ---- |
|addEventListener(eventType, listener)| 添加事件監(jiān)聽 |
|addGlobalListener(listener)| 給所有的事件添加一個(gè)全局監(jiān)聽器 |
|removeEventListener(eventType, listener)| 移除事件監(jiān)聽 |
|removeGlobalListener(listener)| 移除所有的事件的全局監(jiān)聽 |
|dispatchEvent(event)| |
行組
|方法 | 描述 |
|---- | ---- |
|expandAll()| 展開所有組 |
|collapseAll()| 關(guān)閉所有組 |
|setRowNodeExpanded(rowNode, expanded)| 設(shè)置某行節(jié)點(diǎn)關(guān)閉或打開 |
|onGroupExpandedOrCollapsed()| 通知表格模型已經(jīng)展開/關(guān)閉 |行拖動(dòng)
|方法 | 描述 |
|---- | ---- |
|setSuppressRowDrag(value)| 設(shè)置suppressRowDrag的狀態(tài) |
|setSuppressMoveWhenRowDragging(value)| 設(shè)置suppressMoveWhenRowDragging的狀態(tài) |
|addRowDropZone(params)| 添加外部拖放區(qū) |
|removeRowDropZone(params)| 移除外部拖放區(qū) |
|getRowDropZoneParams()| 獲取拖放區(qū)參數(shù) |
- 渲染
|方法 | 描述 |
|---- | ---- |
|getRenderedNodes()| |
|getCellRendererInstances(params)| |
|getCellEditorInstances(params)| |
|getSizesForCurrentTheme()| |
滾動(dòng)
|方法 | 描述 |
|---- | ---- |
|setAlwaysShowVerticalScroll(show)| |
|ensureIndexVisible(index, position)| |
|ensureNodeVisible(comparator, position)| |
|ensureColumnVisible(colId)| |
|getHorizontalPixelRange()| |
|getVerticalPixelRange()| |無限滾動(dòng)
|方法 | 描述 |
|---- | ---- |
|refreshInfiniteCache()| |
|purgeInfiniteCache()| |
|getInfiniteRowCount()| |
|isMaxRowFound()| |
|setInfiniteRowCount(rowCount, maxRowFound)| |
|getCacheBlockState()| |
- 覆蓋層
|方法 | 描述 |
|---- | ---- |
|showLoadingOverlay()| |
|showNoRowsOverlay()| |
|hideOverlay()| |
- 剪切
|方法 | 描述 |
|---- | ---- |
|copySelectedRangeToClipboard(includeHeaders)| |
|copySelectedRangeDown()| |
分頁(yè)
|方法 | 描述 |
|---- | ---- |
|paginationIsLastPageFound()| 返回是否找到最后一頁(yè) |
|paginationGetPageSize()| 返回顯示的行數(shù) |
|paginationSetPageSize(newPageSize)| 設(shè)置頁(yè)數(shù) |
|paginationGetCurrentPage()| 返回當(dāng)前頁(yè) |
|paginationGetTotalPages()| 返回總頁(yè)數(shù) |
|paginationGetRowCount()| 返回總行數(shù) |
|paginationGoToPage(pageNumber)| 跳到某頁(yè) |
|paginationGoToNextPage() | 下一頁(yè) |
|paginationGoToPreviousPage() | 上一頁(yè) |
|paginationGoToFirstPage() | 首頁(yè) |
|paginationGoToLastPage()| 尾頁(yè) |表格頭部
|方法 | 描述 |
|---- | ---- |
|setHeaderHeight(heightInPx)| 設(shè)置列高度 |
|setGroupHeaderHeight(heightInPx)| 設(shè)置列組高度 |
|setFloatingFiltersHeight(heightInPx)| 設(shè)置浮動(dòng)過濾器高度 |
|setPivotHeaderHeight(heightInPx)| 透視模式下設(shè)置列的高度 |
|setPivotGroupHeaderHeight(heightInPx)| 透視模式下設(shè)置列組的高度 |狀態(tài)欄
|方法 | 描述 |
|---- | ---- |
|getStatusBarComponent(key)| |
圖表
|方法 | 描述 |
|---- | ---- |
|getChartModels()| |
|createRangeChart(params)| |
|createPivotChart(params)| |其他
|方法 | 描述 |
|---- | ---- |
|setPopupParent(element)| |
|addRenderedRowListener(event, rowIndex, callback)| |
|showToolPanel(show)| |
|isToolPanelShowing()| |
|getToolPanelInstance(id)| |
|doLayout()| |
|getValue(colKey, node)| |
|destroy()| |
|showColumnMenuAfterButtonClick(colKey, buttonElement)
showColumnMenuAfterMouseClick(colKey, mouseEvent)| |
|checkGridSize()| |
|resetRowHeights()| 重新設(shè)置行高 |
|onRowHeightChanged()| 通知表格行高已經(jīng)更改 |
|copySelectedRowsToClipboard(includeHeaders, columnKeys)| |
|addAggFunc(key, aggFunc), addAggFuncs(aggFuncs), clearAggFuncs()| |
|hidePopupMenu()| |
|setEnableCellTextSelection()| |
|setGridAutoHeight(value)| |
|isAnimationFrameQueueEmpty()| |
|purgeServerSideCache(route)| |
|setDomLayout| 設(shè)置domLayout的值 |
|navigateToNextCell| 設(shè)置自定義導(dǎo)航 |
