Optional childrenThe childrenCountField is used to specify the name of the field that contains the number of children of the current item. This is used to show the expand/collapse icon. If this is not specified, the grid will use the childrenField to determine if the item has children. This is useful when the children are not loaded. In that case, the childrenCountField can be used to show the expand/collapse icon. The children will be loaded when the expand icon is clicked. Please see https://reactdatagrid.com/examples?example=Nested_Lazy_Load for an example. And https://github.com/flexicious/euxdt-example/blob/main/src/app/examples/nested-lazy-load.tsx for the code.
Optional childrenThe childrenField is used to specify the name of the field that contains the children of the current item.
Optional childrenThe childrenFunction is used to specify a function that returns the children of the current item. This is used to show the expand/collapse icon. If this is not specified, the grid will use the childrenField to determine if the item has children. This is useful when the children are not loaded. In that case, the childrenFunction can be used to show the expand/collapse icon. The children will be loaded when the expand icon is clicked.
Optional columnsThe columns to displayed in the grid. IF not provided, the columns will be generated from the data. For grouped columns, you can use the children property to define the sub columns. The children property can be used recursively to define sub columns.
Optional displayChanges the order in which the grid displays the filter,header,body,footer,and toolbar. The order in which the various sections of the grid are laid out.
Defaults to toolbar,header,filter,body,footer
Optional enableEnables the filter.
Optional enableEnables the footer
Optional enableEnable height auto adjust. This is used to adjust the height of the grid based on the number of rows. Please see: https://reactdatagrid.com/examples/?example=Auto_Sizing_Grid
Optional enableEnables paging in the grid.
Optional enableEnables the toolbar.
Optional filterThe Filter/Page/Sort Mode. Can be either "server" or "client". In client mode, the grid will take care of paging, sorting and filtering once the dataprovider is set. In server mode, the grid will fire a com.flexicious.grids.events.FilterPageSortChangeEvent named filterPageSortChange that should be used to construct an appropriate query to be sent to the backend.
Optional gridThe sections to be displayed in the grid. The sections are the header, body, footer, and the toolbar.
Optional heightThe maximum height of the grid when enableHeightAutoAdjust is set to true.
Optional iconiconWidth is used to specify the width of the expand/collapse icon. This allows you to show the children indented. Default value is 24. You can change this globally by setting CONSTANTS.DEFAULT_ICON_WIDTH
Optional itemThe childrenLoadMode is used to specify how the children are loaded. This is used in conjunction with the childrenField or childrenFunction. Please see https://reactdatagrid.com/examples?example=Nested_Lazy_Load for an example. And https://github.com/flexicious/euxdt-example/blob/main/src/app/examples/nested-lazy-load.tsx for the code. The value can be one of the following:
Optional nestnestIndent is used to specify the indent for the children. This allows you to show the children indented. Default value is 24. You can change this globally by setting CONSTANTS.DEFAULT_NEST_INDENT
Optional nextThe nextLevel property is used to defined hierarchical grids. If you know upfront how deep the hierarchy is, you can define the nextLevel property recursively. If you do not know how deep the hierarchy is, you can use the enableDynamicLevels property to dynamically add the nextLevel property.
Optional nextnextLevelRendererOptions is used to specify the options for the next level renderer. Please see https://reactdatagrid.com/examples?example=Level_Renderer for an example and https://github.com/flexicious/euxdt-example/blob/main/src/app/examples/level-renderer.tsx for the code.
Optional paginationThese options control the pagesize, and the allowed pagesizes, and whether the pagesize can be changed.
Optional rowThe rowHeight to be used. You can customize the rowHeight by setting it on the grid or by setting the Constants.GRID_CONSTANTS.DEFAULT_ROW_HEIGHT to a different value.
Optional sortThe options to control the sorting. This allows you to control whether or not multiple columns can be sorted and lets you specify the default sort.
Optional toolbarControls the various sections of the toolbar.
Generated using TypeDoc
GridLevelOptions is used to configure the grid at a particular level.