Javascript and AngularJS 1.x
Below are listed all the properties of the grid. Remember you can add these properties as follows:
Javascript and AngularJS 1.x
Add properties to the gridOptions object.
AngularJS 2
Add properties to the gridOptions object, or you can also add as HTML attributes or AngularJS 2 bound properties.
Web Components
Add properties to the gridOptions object, or you can also add as HTML attributes or set directly onto the DOM element.
| Property | Description |
|---|---|
| columnDefs | Array of Column Definitions.. |
| groupHeaders | Whether to group the headers. |
| headerHeight | Height, in pixels, of the header row. If not grouping headers, default is 25. If grouping headers, default is 50. |
| rowData | Data to be displayed as rows in the table |
| floatingTopRowData | Data to be displayed as floating top rows in the table |
| floatingBottomRowData | Data to be displayed as floating bottom rows in the table |
| rowSelection | Type of row selection, set to either 'single' or 'multiple' to enable selection. |
| rowDeselection | Set to true or false. If true, then rows will be deselected if you hold down ctrl + click the row. |
| pinnedColumnCount | Number of columns to pin. Default is 0. |
| rowHeight | Height of rows, in pixels. Default is 25 pixels. |
| enableColResize | Set to true or false. |
| enableSorting, enableServerSideSorting | Set one of these to true to enable sorting. enableSorting will allow header clicks and show sort icons and sort within the grid. enableServerSideSorting will allow header clicks and show sort icons, but the sorting will be deferred to your datasource. |
| enableCellExpressions | Set to true to allow cells to contain expressions. |
| unSortIcon | Set to true to show the 'no sort' icon. |
| suppressMultiSort | Set to true or false. If true, shift-clicking column header doesn't multi sort. |
| enableFilter, enableServerSideFilter | Set one of these to true to enable filtering. enableFilter will present filters and do the filtering within the grid. enableServerSideFilter will present filters but defer the filtering to your datasource. |
| quickFilterText | Rows are filtered using this text as a 'quick filter'. |
| angularCompileRows | Whether to compile the rows for Angular. Default is false (for performance). Turn on if you want to use AngularJS in your custom cell renderers. |
| angularCompileFilters | Whether to compile provided custom filters. Default is false (for performance). Turn on if you want to use AngularJS in your custom filters. |
| angularCompileHeaders | Whether to compile the customer headers for AngularJS. Default is false (for performance). Turn on if you want to user AngularJS in your custom column headers. |
| groupKeys groupUseEntireRow groupDefaultExpanded groupAggFields groupSelectsChildren groupSuppressAutoColumn groupHidePivotColumns groupSuppressBlankHeader |
Parameters for grouping. See the section on grouping for details explanation. |
| forPrint | Set to true or false. When true, scrollbars are not used. Intention is to print the grid. Do not do this if you have many (more than 500??) rows as the browser will probably die. |
| suppressRowClickSelection | If true, rows won't be selected when clicked. Use when you want checkbox selection exclusively. |
| suppressCellSelection | If true, cells won't be selectable. This means cells will not get keyboard focus when you click on them. |
| colWidth | The default width for each col. Widths specified in column definitions get preference over this. |
| rowsAlreadyGrouped | Set to true if data provided to the grid is already in node structure (this is for passing already aggregated data to the grid). |
| rowsBuffer | The number of rows rendered outside the scrollable viewable area the grid renders. Defaults to 20. Having a buffer means the grid will have rows ready to show as the user slowly scrolls vertically. |
| showToolPanel | Set to true to show the tool panel by default. |
| toolPanelSuppressPivot | Set to true to not show the values or the pivots in the tool panel. It does not make sense to show the values if no pivot functionality is allowed. |
| toolPanelSuppressValues | Set to true to not show the values in the tool panel. The pivot may optionally still be shown. This is useful when you are providing your own aggregate function. |
| suppressScrollLag | By default, scrolling lag is enabled for Safari and Internet Explorer (to solve scrolling performance issues in these browsers). To override when to use scroll lag either a) set suppressScrollLag to true to turn off scroll lag feature or b) return true of false from the function isScrollLag. This is a function, as it's expected your code will check the environment to decide whether to use scroll lag or not. |
| suppressMenuHide | Set to true to always show the column menu button, rather than only showing when the mouse is over the column header. |
| singleClickEdit | Set to true to allow editable cells to start editing with a single click. |
| suppressHorizontalScroll | Set to true to never show the horizontal scroll. This is useful if the grid is a slave grid, and will scroll with a master grid. |
| slaveGrids | A list of grids to treat as slaves. If a grid is a slave, it's columns and horizontal scrolling will try to mirror the columns of the master. |