ag-grid api方法
ag-Grid 的 gridApi 提供了一系列功能,允许你对网格进行各种操作,如数据操作、过滤、排序、分页等。以下是一些常用的 gridApi 方法及其功能:
数据操作
-
setRowData(rowData): 设置网格的数据。gridApi.setRowData(myRowData);
-
updateRowData(transaction): 更新网格的数据。const transaction = { add: [{...}], update: [{...}], remove: [{...}] }; gridApi.updateRowData(transaction); -
getRowNode(id): 根据行 ID 获取行节点。const rowNode = gridApi.getRowNode('someId'); -
applyTransaction(transaction): 应用数据事务(添加、更新、删除)。gridApi.applyTransaction({ add: [{...}], update: [{...}], remove: [{...}] });
过滤和排序
-
setFilterModel(model): 设置过滤模型。gridApi.setFilterModel({ colId: { type: 'contains', filter: 'text' } });、
-
getFilterModel(): 获取当前的过滤模型。const filterModel = gridApi.getFilterModel();
-
setSortModel(model): 设置排序模型。gridApi.setSortModel([ { colId: 'field', sort: 'asc' } ]);
-
getSortModel(): 获取当前的排序模型。const sortModel = gridApi.getSortModel();
选择
-
selectAll(): 选择所有行。gridApi.selectAll();
-
deselectAll(): 取消选择所有行。gridApi.deselectAll();
-
getSelectedRows(): 获取所有被选中的行数据。const selectedRows = gridApi.getSelectedRows();
-
getSelectedNodes(): 获取所有被选中的行节点。const selectedNodes = gridApi.getSelectedNodes();
分页
-
paginationGoToNextPage(): 跳转到下一页。gridApi.paginationGoToNextPage();
-
paginationGoToPreviousPage(): 跳转到上一页。gridApi.paginationGoToPreviousPage();
-
paginationGoToFirstPage(): 跳转到第一页。gridApi.paginationGoToFirstPage();
-
paginationGoToLastPage(): 跳转到最后一页。gridApi.paginationGoToLastPage();
-
paginationGoToPage(pageNumber): 跳转到指定页。gridApi.paginationGoToPage(2);
刷新和重绘
-
refreshCells(params): 刷新单元格。gridApi.refreshCells({ force: true, // 强制刷新 rowNodes: [rowNode], // 只刷新特定行 columns: ['colId'] // 只刷新特定列 });
-
redrawRows(params): 重绘行。gridApi.redrawRows({ rowNodes: [rowNode] // 只重绘特定行 });
-
refreshView(): 刷新整个视图。gridApi.refreshView();
其他
-
sizeColumnsToFit(): 调整列宽以适应网格宽度。gridApi.sizeColumnsToFit();
-
exportDataAsCsv(params): 导出数据为 CSV 文件。gridApi.exportDataAsCsv({ fileName: 'my-data.csv' });
-
getDisplayedRowAtIndex(index): 获取显示的行节点。const rowNode = gridApi.getDisplayedRowAtIndex(0);
-
getFirstDisplayedRow(): 获取第一个显示的行节点。const firstRowNode = gridApi.getFirstDisplayedRow();
-
getLastDisplayedRow(): 获取最后一个显示的行节点。const lastRowNode = gridApi.getLastDisplayedRow();

浙公网安备 33010602011771号