表格API
- 列
|方法 | 描述 |
|:--- | ---- |
|sizeColumnsToFit()| 调整列宽至表格合适的宽度 |
|setColumnDefs(colDefs)| 设置列定义 |
|setAutoGroupColumnDef(colDef)| 设置自动组的定义 |
- 数据
|方法 | 描述 | 参数解析 |
|---- | ---- | ---- |
|setRowData(rows)| 设置行数据 | |
|updateRowData(rows)| 插入行数据 | add：添加
update: 更新
remove：移除<br />addIndex：位置 |
|applyTransaction(transaction)| 行数据更新 | |
|applyTransactionAsync(transaction, callback)| 异步行数据更新 | |
|setPinnedTopRowData(rowData)| 获取固定头部行数据 | |
|setPinnedBottomRowData()| 获取固定底部行数据 | |
|getPinnedTopRowCount()| 获取固定头部行数 | |
|getPinnedBottomRowCount() | 获取固定底部行数 | |
|getPinnedTopRow(index)| 获取固定头部行 | |
|getPinnedBottomRow(index)| 获取固定底部行 | |
|getModel()| 获取行模型 | |
|refreshClientSideRowModel(params)| 刷新客户端行模型 | |
|setDatasource(datasource)| 设置数据给无限模型 | |
|setServerSideDatasource(datasource)| 设置数据给服务端模型 | |
|setViewportDatasource(datasource)| 设置数据给视图模型 | |
transaction
interface RowDataTransaction {
// rows to add
add?: any[];
// rows to remove
remove?: any[];
// rows to update
update?: any[];
}
获取行节点
|方法 | 描述 |
|---- | ---- |
|getRowNode(id)| 获取行节点 |
|forEachNode(callback(node, index))| 遍历每个节点 |
|forEachNodeAfterFilter(callback(node, index))| 遍历过滤后的每个节点 |
|forEachNodeAfterFilterAndSort(callback(node, index))| 遍历过滤和排序后的节点 |
|forEachLeafNode(callback(node, index))| 遍历叶节点 |行显示
|方法 | 描述 |
|---- | ---- |
|getDisplayedRowAtIndex(index)| 返回显示的行节点 |
|getDisplayedRowCount()| 返回显示行的总数 |
|getFirstDisplayedRow()| 返回第一个显示的行 |
|getLastDisplayedRow()| 返回最后一个显示的行 |主要数据
|方法 | 描述 |
|---- | ---- |
|getDetailGridInfo(detailGridId)| |
|forEachDetailGridInfo(callback)| |选择
|方法 | 描述 |
|---- | ---- |
|selectAll()| 全选 |
|deselectAll()| 取消全选 |
|selectAllFiltered()| 全选过滤后的 |
|deselectAllFiltered()| 取消全选过滤后的 |
|getSelectedNodes()| 获取选中的节点 |
|getSelectedRows()| 获取选中的行 |
|getBestCostNodeSelection()| |
|getCellRanges()| 获取单元格范围 |
|addCellRange(params)| 添加单元格范围 |
|clearRangeSelection()| 取消范围选择 |
|setSuppressRowClickSelection(value)| 设置suppressRowClickSelection的状态 |
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)| 对所有单元格执行更改检测，在需要时刷新单元格 |
|redrawRows(RedrawRowsParams)| 删除行时，将会重绘所有行 |
|refreshHeader()| 重绘标题 |
|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)| 设置快速过滤器 |
|isQuickFilterPresent()| 是否使用快速过滤器 |
|isColumnFilterPresent()| 是否使用列过滤器 |
|isAnyFilterPresent()| 是否使用过滤器 |
|getFilterInstance(col, callback)| 获取过滤器实例 |
|getFilterModel()| 获取所有过滤状态 |
|setFilterModel(model)| 设置过滤状态 |
|onFilterChanged()| 通知表格过滤器已更改 |
|destroyFilter()| 销毁过滤器 |
|onSortChanged()| 通知表格排序已更改 |
|setSortModel(model)| 设置排序状态 |
|getSortModel()| 获取所有排序状态 |导航
|方法 | 描述 |
|---- | ---- |
|getFocusedCell()| 获取单元格焦点 |
|setFocusedCell(rowIndex, colKey, floating)| 设置单元格焦点 |
|clearFocusedCell()| 删除单元格聚焦 |
|tabToNextCell()| 将焦点移到下一个单元格 |
|tabToPreviousCell()| 将焦点移到上一个单元格 |
编辑
|方法 | 描述 |
|---- | ---- |
|stopEditing(cancel?)| 停止编辑 |
|startEditingCell(params)| 开始编辑 |
|getEditingCells()| 获取编辑的单元格 |导出
|方法 | 描述 |
|---- | ---- |
|exportDataAsCsv(params)| |
|getDataAsCsv(params)| |
|exportDataAsExcel(params)| |
|getDataAsExcel(params)| |
- 事件
|方法 | 描述 |
|---- | ---- |
|addEventListener(eventType, listener)| 添加事件监听 |
|addGlobalListener(listener)| 给所有的事件添加一个全局监听器 |
|removeEventListener(eventType, listener)| 移除事件监听 |
|removeGlobalListener(listener)| 移除所有的事件的全局监听 |
|dispatchEvent(event)| |
行组
|方法 | 描述 |
|---- | ---- |
|expandAll()| 展开所有组 |
|collapseAll()| 关闭所有组 |
|setRowNodeExpanded(rowNode, expanded)| 设置某行节点关闭或打开 |
|onGroupExpandedOrCollapsed()| 通知表格模型已经展开/关闭 |行拖动
|方法 | 描述 |
|---- | ---- |
|setSuppressRowDrag(value)| 设置suppressRowDrag的状态 |
|setSuppressMoveWhenRowDragging(value)| 设置suppressMoveWhenRowDragging的状态 |
|addRowDropZone(params)| 添加外部拖放区 |
|removeRowDropZone(params)| 移除外部拖放区 |
|getRowDropZoneParams()| 获取拖放区参数 |
- 渲染
|方法 | 描述 |
|---- | ---- |
|getRenderedNodes()| |
|getCellRendererInstances(params)| |
|getCellEditorInstances(params)| |
|getSizesForCurrentTheme()| |
滚动
|方法 | 描述 |
|---- | ---- |
|setAlwaysShowVerticalScroll(show)| |
|ensureIndexVisible(index, position)| |
|ensureNodeVisible(comparator, position)| |
|ensureColumnVisible(colId)| |
|getHorizontalPixelRange()| |
|getVerticalPixelRange()| |无限滚动
|方法 | 描述 |
|---- | ---- |
|refreshInfiniteCache()| |
|purgeInfiniteCache()| |
|getInfiniteRowCount()| |
|isMaxRowFound()| |
|setInfiniteRowCount(rowCount, maxRowFound)| |
|getCacheBlockState()| |
- 覆盖层
|方法 | 描述 |
|---- | ---- |
|showLoadingOverlay()| |
|showNoRowsOverlay()| |
|hideOverlay()| |
- 剪切
|方法 | 描述 |
|---- | ---- |
|copySelectedRangeToClipboard(includeHeaders)| |
|copySelectedRangeDown()| |
分页
|方法 | 描述 |
|---- | ---- |
|paginationIsLastPageFound()| 返回是否找到最后一页 |
|paginationGetPageSize()| 返回显示的行数 |
|paginationSetPageSize(newPageSize)| 设置页数 |
|paginationGetCurrentPage()| 返回当前页 |
|paginationGetTotalPages()| 返回总页数 |
|paginationGetRowCount()| 返回总行数 |
|paginationGoToPage(pageNumber)| 跳到某页 |
|paginationGoToNextPage() | 下一页 |
|paginationGoToPreviousPage() | 上一页 |
|paginationGoToFirstPage() | 首页 |
|paginationGoToLastPage()| 尾页 |表格头部
|方法 | 描述 |
|---- | ---- |
|setHeaderHeight(heightInPx)| 设置列高度 |
|setGroupHeaderHeight(heightInPx)| 设置列组高度 |
|setFloatingFiltersHeight(heightInPx)| 设置浮动过滤器高度 |
|setPivotHeaderHeight(heightInPx)| 透视模式下设置列的高度 |
|setPivotGroupHeaderHeight(heightInPx)| 透视模式下设置列组的高度 |状态栏
|方法 | 描述 |
|---- | ---- |
|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()| 重新设置行高 |
|onRowHeightChanged()| 通知表格行高已经更改 |
|copySelectedRowsToClipboard(includeHeaders, columnKeys)| |
|addAggFunc(key, aggFunc), addAggFuncs(aggFuncs), clearAggFuncs()| |
|hidePopupMenu()| |
|setEnableCellTextSelection()| |
|setGridAutoHeight(value)| |
|isAnimationFrameQueueEmpty()| |
|purgeServerSideCache(route)| |
|setDomLayout| 设置domLayout的值 |
|navigateToNextCell| 设置自定义导航 |
