ag-grid表格属性

      1.列

属性	描述	默认值	属性值
columnDefs	列名称和内容		[]
defaultColDef	默认列定义，会被列继承
defaultColGroupDef	默认列组定义，会被列组继承
columnTypes	列类型模板定义，会被列继承
colResizeDefault	设置shift，拖放时按住shift其他列列宽不变		'shift'
suppressAutoSize	禁止自动缩放	false	true/false
autoSizePadding	自动缩放的padding	4
skipHeaderOnAutoSize	自动缩放跳过标题	false	true/false
suppressColumnMoveAnimation	禁止使用列移动动画	false	true/false
suppressMovableColumns	禁止移动列	false	true/false
suppressFieldDotNotation	禁止使用点标记	false	true/false
unSortIcon	显示无排序图标	false	true/false
suppressMultiSort	按住Shift键并单击列标题时取消多重排序	false	true/false
suppressMenuHide	禁止列标题菜单隐藏	false	true/false
autoGroupColumnDef	自动列组定义	false	true/false
suppressSetColumnStateEvents	禁止调用SetColumnState/resetColumnState时触发列事件	false	true/false
allowDragFromColumnsToolPanel	允许从工具面板拖拽列到表格	false	true/false
immutableColumns	是否使用不可变模式	false	true/false

  2.排序和过滤   

属性	描述	默认值	属性值
quickFilterText	快速过滤
cacheQuickFilter	缓存快速过滤器	false	true/false
sortingOrder	设置排序顺序		‘asc’,'desc',null
accentedSort	使用重音排序	false	true/false
multiSortKey	使用ctrl进行多排序		'ctrl'
suppressMaintainUnsortedOrder
excludeChildrenWhenTreeDataFiltering

  3.选择

属性	描述	默认值	属性值
rowSelection	行选择类型		'single','multiple'
rowMultiSelectWithClick	允许单击选择多行	false	true/false
rowDeselection	使用ctrl+单击取消选择	false	true/false
suppressRowClickSelection	禁止点击行选中行	false	true/false
suppressCellSelection	禁止点击单元格获取焦点	false	true/false
enableRangeSelection	使用范围选择	false	true/false

  4.行拖放

属性	描述	默认值	属性值
rowDragManaged	允许使用行拖放	false	true/false
suppressRowDrag	禁止拖放	false	true/false
suppressMoveWhenRowDragging	行拖放时禁止移动	false	true/false
enableMultiRowDragging	允许多行拖动	false	true/false

  5.编辑

属性	描述	默认值	属性值
singleClickEdit	单击编辑	false	true/false
suppressClickEdit	禁止单击编辑	false	true/false
editType	编辑类型		‘fullRow’
enableCellChangeFlash	单元格数据变化时闪烁	false	true/false
cellFlashDelay	单元格闪烁延迟	500
cellFadeDelay	单元格淡出延迟，在cellFlashDelay完成后执行	false	true/false
allowShowChangeAfterFilter	允许使用过滤时单元格闪烁	false	true/false
stopEditingWhenGridLosesFocus	表格失去焦点时停止编辑	false	true/false
enterMovesDown enterMovesDownAfterEdit	两个设置true，使用Enter键时会自动向下移动	false	true/false

  6.表格头部

属性	描述	默认值	属性值
headerHeight	列标题高度	25
groupHeaderHeight	列组标题高度，不设置时使用headerHeight	默认值
floatingFiltersHeight	浮动过滤器高度	20
pivotHeaderHeight	浮动过滤器高度，不设置时使用headerHeight
pivotGroupHeaderHeight	浮动过滤器高度，不设置时使用groupHeaderHeight

7.行组
|属性 | 描述 | 默认值 | 属性值 |
|---- | ---- | ---- | ---- |
|groupUseEntireRow| | | |
|groupDefaultExpanded| 默认打开行组级别，-1打开全部级别 | 0 | |
|autoGroupColumnDef| | false | true/false |
|groupSuppressAutoColumn| | false | true/false |
|groupMultiAutoColumn| 允许将列变组时保留在当前列中 | false | true/false |
|groupSuppressRow| | false | true/false |
|groupSelectsChildren| 选择组是否全选子数据 | false | true/false |
|groupIncludeFooter| | false | true/false |
|groupIncludeTotalFooter| | false | true/false |
|groupSuppressBlankHeader| | false | true/false |
|groupSelectsFiltered| 使用groupSelectsChildren时，只能获取过滤后的子级 | false | true/false |
|groupRemoveSingleChildren| | false | true/false |
|groupRemoveLowestSingleChildren| | false | true/false |
|groupHideOpenParents| 隐藏打开的父层 | false | true/false |
|rowGroupPanelShow| 行组面板显示 | never | 'never','always','onlyWhenGrouping' |

8.行pivot
|属性 | 描述 | 默认值 | 属性值 |
|---- | ---- | ---- | ---- |
|pivotMode| | | |
|pivotPanelShow| | | |
|rememberGroupStateWhenNewData| 数据变更时保存组状态 | false | true/false |
|suppressAggFuncInHeader| 禁止标题使用聚合函数 | false | true/false |
|suppressAggAtRootLevel| 禁止顶行使用聚合 | false | true/false |
|aggregateOnlyChangedColumns| | false | |
|functionsReadOnly| | | |
|aggFuncs| | | |
|suppressMakeVisibleAfterUnGroup| | | |
|pivotColumnGroupTotals| | | |
|pivotRowTotals| | | |
|pivotSuppressAutoColumn| | | |

9.数据与行模型
|属性 | 描述 | 默认值 | 属性值 |
|---- | ---- | ---- | ---- |
|rowModelType| 行模型类型 | clientSide | 'clientSide','infinite','viewport','serverSide' |
|rowData| 行数据 | | |
|immutableData| 不可变模式数据 | | |
|pinnedTopRowData| 固定头部行数据 | | |
|pinnedBottomRowData| 固定底部行数据 | | |

10.服务端：行模型
|属性 | 描述 | 默认值 | 属性值 |
|---- | ---- | ---- | ---- |
|cacheBlockSize| 每次请求时的条数 | 100 | |
|maxBlocksInCache| 保留最大缓存块数量（慎用，值设置过小容易造成请求死循环） | | |
|cacheOverflowSize| 设置缓存的超出数量 | 1 | |
|maxConcurrentDatasourceRequests| 设置并发请求的最大数值 | 1 | |
|blockLoadDebounceMillis| 滚动停止后块加载的时间 | | |
|infiniteInitialRowCount| 初始化滚动行数 | | |
|purgeClosedRowNodes| 关闭节点时清除缓存 | | |
|serverSideSortingAlwaysRests| 服务端排序时总是刷新 | | |

11.视图行模型

属性	描述
viewportRowModelPageSize
viewportRowModelBufferSize
viewportDatasource

12.滚动
|属性 | 描述 | 默认值 | 属性值 |
|---- | ---- | ---- | ---- |
|alwaysShowVerticalScroll| 总是允许垂直滚动 | false | true/false |
|suppressHorizontalScroll| 禁止水平滚动 | false | true/false |
|suppressColumnVirtualisation| 禁止列虚拟化 | false | true/false |
|suppressRowVirtualisation| 禁止行虚拟化 | false | true/false |
|suppressMaxRenderedRowRestriction| 禁止行渲染最大约束 | false | true/false |
|suppressScrollOnNewData| 新增数据禁止滚动 | false | true/false |
|suppressAnimationFrame| 滚动时禁止使用动画 | false | true/false |

13.分页
|属性 | 描述 | 默认值 | 属性值 |
|---- | ---- | ---- | ---- |
|pagination| 使用分页 | false | true/false |
|paginationPageSize| 设置每页展示数量 | 100 | |
|paginationAutoPageSize| 自动调节每页展示数量 | false | true/false |
|suppressPaginationPanel| 禁止使用分页面板 | false | true/false |
|paginateChildRows| | | |

14.宽度渲染器
| 属性 | 描述 | 类型 | 默认值 | 属性值 |
| ---- | ------- | ------- | ------ | ------ |
| groupRowRenderer | 渲染行组，与frameworkComponents配合使用 | string/(params)=>ReactNode | | |
| groupRowRendererFramework | 渲染行组 | ReactNode | | |
| groupRowRendererParams | 渲染行组参数 | | | |
| groupRowInnerRenderer | 渲染行组内部，与frameworkComponents配合使用 | string | | |
| groupRowInnerRendererFramework | 渲染行组内部 | ReactNode | | |
| fullWidthCellRenderer | 渲染全宽表格，与frameworkComponents配合使用 | string | | |
| fullWidthCellRendererFramework | 渲染全宽表格 | ReactNode | | |
| fullWidthCellRendererParams | 渲染全宽表格参数 | | | |

15.主要详情
|属性 | 描述 |
|---- | ---- |
|masterDetail| |
|detailCellRendererParams| |
|keepDetailRows| |
|keepDetailRowsCount| |
|detailRowHeight| |
|autoHeight| |

16.样式渲染
|属性 | 描述 | 默认值 | 属性值 |
|---- | ---- | ---- | ---- |
|icons| 图标 | | |
|rowHeight| 行高 | 25 | |
|animateRows| 行动画 | false | true/false |
|rowStyle| 行style | | |
|rowClass| 行class | | |
|rowClassRules| 行class规则 | | |
|excelStyles| 导出的Excel样式 | | |
|scrollbarWidth| 滚动条宽度 | | |
|suppressRowHoverHighlight| 禁止行高亮 | false | true/false |

interface params = {
    data,
    node, 
    rowIndex, 
    api,
    context
}
gridOptions.rowClassRules: {
  // apply green to 2008
  'rag-green-outer': function(params) { return params.data.year === 2008; },

  // apply amber 2004
  'rag-amber-outer': function(params) { return params.data.year === 2004; },

  // apply red to 2000
  'rag-red-outer': function(params) { return params.data.year === 2000; }
}
gridOptions.rowClassRules: {
    'rag-green': 'data.age < 20',
    'rag-amber': 'data.age >= 20 && data.age < 25',
    'rag-red': 'data.age >= 25'
}

17.剪切板

|属性 | 描述 | 默认值 | 属性值 |
|---- | ---- | ---- | ---- |
|suppressCopyRowsToClipboard| 禁止复制到剪切板 | false | true/false |
|copyHeadersToClipboard| 使用ctrl+c时包含标题复制到剪切板 | false | true/false |
|clipboardDeliminator| 剪切分隔符 | | |
|suppressFocusAfterRefresh| 刷新后禁止聚焦 | false | true/false |
|suppressLastEmptyLineOnPaste| 禁止最后一行空行（使用Excel导出时） | false | true/false |
|enableCellTextSelection| 单元格使用文字选择，true时Clipboard失效 | false | true/false |

18.本地化
|属性 | 描述 |
|---- | ---- |
|localeText
localeTextFunc| 设置分页面板和默认过滤器中的文本 |

19.覆盖层
|属性 | 描述 | 默认值 | 属性值 |
|---- | ---- | ---- | ---- |
|suppressLoadingOverlay| 禁止使用加载覆盖 |||
|suppressNoRowsOverlay| 禁止使用无行覆盖 |||
|overlayLoadingTemplate| 加载覆盖层模板 |||
|overlayNoRowsTemplate| 无行覆盖层模板 |||
|loadingOverlayComponent
loadingOverlayComponentFramework | 加载覆盖层组件 |||
|noRowsOverlayComponent
noRowsOverlayComponentFramework| 无行覆盖层组件 |||

20.图表
|属性 | 描述 | 默认值 | 属性值 |
|---- | ---- | ---- | ---- |
|enableCharts| 使用图表 | false | true |

21.组件
|属性 | 描述 |
|---- | ---- |
|components| JavaScript的组件映射 |
|frameworkComponents| 框架组件的映射 |

22.其他
|属性 | 描述 | 默认值 | 属性值 |
|---- | ---- | ---- | ---- |
|popupParent| | | |
|valueCache| | | |
|valueCacheNeverExpires| | | |
|defaultExportParams| | | |
|suppressMiddleClickScrolls| | | |
|suppressPreventDefaultOnMouseWheel| | | |
|enableBrowserTooltips| 设置为true可以使用浏览器的默认工具提示，而不是使用ag-Grid的工具提示组件 | | |
|tooltipShowDelay| 延迟提示的时间，enableBrowserTooltips true 时无效 | 2s | |
|tooltipMouseTrack| 提示跟踪鼠标 | false | true/false |
|enableCellExpressions| | | |
|domLayout| 设置表格容器的布局 | normal | 'normal','autoHeight','print' |
|ensureDomOrder| | | |
|rowBuffer| | | |
|alignedGrids| | | |
|suppressParentsInRowNodes| | | |
|suppressDragLeaveHidesColumns| 拖拽离开表格时禁止隐藏 | false | true/false |
|layoutInterval| | | |
|enableRtl| | | |
|debug| 使用ag提供的调试模式 | false | true/false |
|context| 提供上下文对象 | | |
|suppressContextMenu| 禁止使用右击菜单 | false | true/false |
|preventDefaultOnContextMenu| 使用右击时阻止默认行为 | false | true/false |
|allowContextMenuWithControlKey| 按下Ctrl时允许使用右击菜单 | false | true/false |
|statusBar| 状态栏 | | agTotalRowCountComponent
agTotalAndFilteredRowCountComponent
agFilteredRowCountComponent
agSelectedRowCountComponent
agAggregationComponent|
|suppressTouch| 禁止触摸 | false | true/false |
|suppressAsyncEvents| 禁止使用异步特性 | false | true/false |
|suppressCsvExport| 禁止CSV导出 | false | true/false |
|suppressExcelExport| 禁止Excel导出 | false | true/false |
|asyncTransactionWaitMillis| 执行事务前等待的时间 | 50 | |
|suppressPropertyNamesCheck| | | |
|suppressRowTransform| 禁止行转换 | false | true/false |
|serverSideSortingAlwaysResets| | | |
|suppressBrowserResizeObserver| | | |

 状态栏
 statusBar: {
        statusPanels: [
            { statusPanel: 'agTotalAndFilteredRowCountComponent', align: 'left' }
        ]
    }

1. 侧边栏

属性	描述	类型	属性值
sideBar	设置右侧边栏的显示	undefined、boolean、string、SideBarDef(long form)	true包含filter 和 column 'columns','filters' SideBarDef

23-1. SideBarDef

属性	描述	类型	默认值	属性值
toolPanels	面板列表	array<toolPanels>、array<string>
defaultToolPanel	设置默认打开的面板ID	string
hiddenByDefault	隐藏侧边栏	boolean	false	true/false
position	侧边栏位置	string	right	left / right

23-2.toolPanels

属性	描述	类型	默认值	属性值
id	面板ID	toolPanels、string
labelKey	label
labdeDefault	面板名称	string
iconKey	icon	boolean	false	true/false
toolPanel toolPanelFramework toolPanelParams	面板信息	string	right	left / right