ag-grid api方法

ag-Grid 的 gridApi 提供了一系列功能,允许你对网格进行各种操作,如数据操作、过滤、排序、分页等。以下是一些常用的 gridApi 方法及其功能:

数据操作

  1. setRowData(rowData): 设置网格的数据。

    gridApi.setRowData(myRowData);
  2. updateRowData(transaction): 更新网格的数据。

    const transaction = {
      add: [{...}],
      update: [{...}],
      remove: [{...}]
    };
    gridApi.updateRowData(transaction);
  3. getRowNode(id): 根据行 ID 获取行节点。

    const rowNode = gridApi.getRowNode('someId');
  4. applyTransaction(transaction): 应用数据事务(添加、更新、删除)。

    gridApi.applyTransaction({
      add: [{...}],
      update: [{...}],
      remove: [{...}]
    });

过滤和排序

  1. setFilterModel(model): 设置过滤模型。

    gridApi.setFilterModel({
      colId: {
        type: 'contains',
        filter: 'text'
      }
    });、
  2. getFilterModel(): 获取当前的过滤模型。

    const filterModel = gridApi.getFilterModel();
  3. setSortModel(model): 设置排序模型。

    gridApi.setSortModel([
      { colId: 'field', sort: 'asc' }
    ]);
  4. getSortModel(): 获取当前的排序模型。

    const sortModel = gridApi.getSortModel();

选择

  1. selectAll(): 选择所有行。

    gridApi.selectAll();
  2. deselectAll(): 取消选择所有行。

    gridApi.deselectAll();
  3. getSelectedRows(): 获取所有被选中的行数据。

    const selectedRows = gridApi.getSelectedRows();
  4. getSelectedNodes(): 获取所有被选中的行节点。

    const selectedNodes = gridApi.getSelectedNodes();

分页

  1. paginationGoToNextPage(): 跳转到下一页。

    gridApi.paginationGoToNextPage();
  2. paginationGoToPreviousPage(): 跳转到上一页。

    gridApi.paginationGoToPreviousPage();
  3. paginationGoToFirstPage(): 跳转到第一页。

    gridApi.paginationGoToFirstPage();
  4. paginationGoToLastPage(): 跳转到最后一页。

    gridApi.paginationGoToLastPage();
  5. paginationGoToPage(pageNumber): 跳转到指定页。

    gridApi.paginationGoToPage(2);

刷新和重绘

  1. refreshCells(params): 刷新单元格。

    gridApi.refreshCells({
      force: true, // 强制刷新
      rowNodes: [rowNode], // 只刷新特定行
      columns: ['colId'] // 只刷新特定列
    });
  2. redrawRows(params): 重绘行。

    gridApi.redrawRows({
      rowNodes: [rowNode] // 只重绘特定行
    });
  3. refreshView(): 刷新整个视图。

    gridApi.refreshView();

其他

  1. sizeColumnsToFit(): 调整列宽以适应网格宽度。

    gridApi.sizeColumnsToFit();
  2. exportDataAsCsv(params): 导出数据为 CSV 文件。

    gridApi.exportDataAsCsv({
      fileName: 'my-data.csv'
    });
  3. getDisplayedRowAtIndex(index): 获取显示的行节点。

    const rowNode = gridApi.getDisplayedRowAtIndex(0);
  4. getFirstDisplayedRow(): 获取第一个显示的行节点。

    const firstRowNode = gridApi.getFirstDisplayedRow();
  5. getLastDisplayedRow(): 获取最后一个显示的行节点。

    const lastRowNode = gridApi.getLastDisplayedRow();

     

 

posted @ 2024-08-14 08:47  芬-mi  阅读(221)  评论(0编辑  收藏  举报