Column API —— 一些API方法采用colKey类型为的列关键字(名为)Column | string。这意味着您可以传递一个Column对象(通过调用其他方法之一接收到的对象),也可以传递Column ID(即string)。列ID是列定义的属性。如果不提供“列ID”,则网格将为您创建一个(如果是唯一的,则首先尝试使用该字段,否则将生成ID)。 | |
sizeColumnsToFit(width) | 获取网格以将列的大小调整为指定的宽度(以像素为单位),例如sizeColumnsToFix(900)。若要使网格适合列的宽度,请改用Grid API gridApi.sizeColumnsToFit()。 |
setColumnGroupOpened(group, newValue) | 如果要打开或关闭列组,请调用此方法。 |
getColumnGroup(name) | 返回具有给定名称的列组。 |
getDisplayNameForColumn(column) | 返回列的显示名称。如果您正在执行自己的标题渲染并且希望使用网格来进行计算headerValueGetter,或者如果您正在执行自己的列管理GUI,则很有用,以了解显示为列名的内容。 |
getDisplayNameForColumnGroup(columnGroup) | 返回列组的显示名称(对列进行分组时)。 |
getColumn(colKey) | 返回具有给定的列,该列colKey可以是colId(字符串)或colDef(对象)。 |
getColumnState() | 获取列的状态。通常在保存列状态时使用。 |
applyColumnState(params) | 应用先前状态中的列状态。false如果找不到一列或多列,则返回。 |
resetColumnState() | 将状态设置回以匹配最初提供的列定义。 |
getColumnGroupState() | 获取列组的状态。通常在保存列组状态时使用。 |
setColumnGroupState(columnState) | 从先前状态设置列组状态的状态。 |
resetColumnGroupState() | 将状态设置回以匹配最初提供的列定义。 |
isPinning() | true如果固定在左侧或右侧,则返回,否则返回false。 |
isPinningLeft() | true如果向左固定,则返回,否则返回false。 |
isPinningRight() | true如果固定正确,则返回,否则返回false。 |
getDisplayedColAfter(col) | 考虑到打开/关闭的列组和可见的列,返回提供的列右边的列。如果您需要知道自己的旁边是哪一列,例如实现自己的单元格导航,这将很有用。 |
getDisplayedColBefore(col) | getVisibleColAfter除左栏外与其他相同。 |
setColumnVisible(colKey, visible) | 设置列的可见性。键可以是列ID或Column对象。 |
setColumnsVisible(colKeys, visible) | 与相同setColumnVisible,但提供列键列表。 |
setColumnPinned(colKey, pinned) | 设置固定/不固定的列。键可以是列ID,字段,ColDef对象或Column对象。 |
setColumnsPinned(colKeys, pinned) | 与相同setColumnPinned,但提供列键列表。 |
autoSizeColumn(colKey, skipHeader) | 根据其内容自动调整列的大小。 |
autoSizeColumns(colKeys, skipHeader) | 与相同autoSizeColumn,但提供列键列表。 |
autoSizeAllColumns(skipHeader) | autoSizeColumns在所有显示的列上调用。 |
getAllColumns() | 返回所有列,无论是否可见。 |
getAllGridColumns() | 返回所有与Grid相同的网格列,getAllColumns()除了a)具有在网格中显示的列的顺序,b)在“ pivot”步骤之后,因此如果进行透视,则具有该透视的值列。 |
getPrimaryColumns() | 返回网格的主列。 |
getSecondaryColumns() | 返回网格的辅助列。 |
getAllDisplayedVirtualColumns() | 与相同getAllGridColumns(),除了仅返回渲染的列,即不显示不在视口内且由于列虚拟化而因此未渲染的列。 |
getDisplayedCenterColumns() | 返回网格的固定左,中和右固定部分的当前显示的所有列(例如可见,如果在一个组中,则该组显示列)。 |
getDisplayedLeftColumns() | |
getDisplayedRightColumns() | |
getAllDisplayedColumns() | |
getLeftDisplayedColumnGroups() | 返回所有“根”列标题。如果您不对列进行分组,则这些将返回列。如果要分组,则它们将返回顶层组-您可以向下浏览每个组,以获取其他较低层的标题,最后是底部的列。 |
getCenterDisplayedColumnGroups() | |
getRightDisplayedColumnGroups() | |
getAllDisplayedColumnGroups() | |
moveColumn(colKey, toIndex) | 将一列移到toIndex。首先删除该列,然后将其添加到该toIndex位置,因此删除后索引位置将更改为该列的右侧。 |
moveColumns(colKeys[], toIndex) | 与相同,moveColumn但在列表上起作用。 |
moveColumnByIndex(fromIndex, toIndex) | 与相同,moveColumn但适用于索引位置。 |
setColumnAggFunc(column, aggFunc) | 设置列的agg函数。aggFunc可以是其中之一'min' | 'max' | 'sum'. |
setColumnWidth(colKey, newWidth, finished = true) | 在单列上设置列宽。完成标志将包含在结果事件中,并且不会在网格内部使用。Finished标志用于拖动,其中拖动动作将产生许多columnWidth事件,因此事件的使用者知道何时接收到流中的最后一个事件。finish参数是可选的,默认为true。 |
setColumnWidths(columnWidths: {colKey, newWidth}[], finished = true) | 在多列上设置列宽。与setColumnWidth多次调用相比,此方法提供更好的性能。完成标志将包含在结果事件中,并且不会在网格内部使用。Finished标志用于拖动,其中拖动动作将产生许多columnWidth事件,因此事件的使用者知道何时接收到流中的最后一个事件。finish参数是可选的,默认为true。 |
getRowGroupColumns() | 列行组的管理方法。 |
addRowGroupColumn(colKey) | |
addRowGroupColumns(colKeys) | |
removeRowGroupColumn(colKey) | |
removeRowGroupColumns(colKeys) | |
setRowGroupColumns(colKeys) | |
moveRowGroupColumn(fromIndex, toIndex) | |
getPivotColumns() | 列枢轴管理方法。 |
setPivotColumns(colKeys) | |
removePivotColumn() | |
removePivotColumns(colKeys) | |
addPivotColumn(colKey) | |
addPivotColumns(colKeys) | |
isPivotMode() | 获取/设置数据透视模式的方法。 |
setPivotMode(mode) | |
getSecondaryPivotColumn(pivotKeys, valueColId) | 返回给定pivotKeys和的枢轴列valueColId。有助于在枢轴列上调用操作。 |
getValueColumns() | 值列聚合的管理方法(用于分组或数据透视时的聚合)。 |
removeValueColumn(colKey) | |
removeValueColumns(colKeys) | |
addValueColumn(colKey) | |
addValueColumns(colKeys) |
ag-grid Column API(机器翻译)
最新推荐文章于 2024-09-02 21:33:03 发布