- Preparing search index...
- The search index is not available
FlexGridDetailProvider Class
Heirarchy
- FlexGridDetailProvider
Constructors
Properties
Methods
Constructors
constructor
-
Initializes a new instance of the FlexGridDetailProvider class.
Parameters
-
grid: FlexGrid
FlexGrid that will receive detail rows.
-
Optional options: any
Initialization options for the new FlexGridDetailProvider.
Returns FlexGridDetailProvider
-
Properties
createDetailCell
Gets or sets the callback function that creates detail cells.
The callback function takes a Row as a parameter and returns an HTML element representing the row details. For example:
// create detail cells for a given row
dp.createDetailCell = (row) => {
let cell = document.createElement('div');
new FlexGrid(cell, {
itemsSource: getProducts(row.dataItem.CategoryID),
headersVisibility: 'Column'
});
return cell;
};detailVisibilityMode
Gets or sets a value that determines when row details are displayed.
The default value for this property is DetailVisibilityMode.ExpandSingle.
disposeDetailCell
Gets or sets the callback function that disposes of detail cells.
The callback function takes a Row as a parameter and disposes of any resources associated with the detail cell.
This function is optional. Use it in cases where the createDetailCell function allocates resources that are not automatically garbage-collected.
grid
Gets the FlexGrid that owns this FlexGridDetailProvider.
isAnimated
Gets or sets a value that indicates whether to use animation when showing row details.
The default value for this property is false.
keyActionEnter
Gets or sets the action to perform when the ENTER key is pressed.
The default setting for this property is KeyAction.None, which lets the grid handle the key. The other option is KeyAction.ToggleDetail, which handles the Enter key to toggle the display of the row details.
maxHeight
Gets or sets the maximum height of the detail rows, in pixels.
The default value for this property is null, which means there's no upper limit to the detail row height.
rowHasDetail
Gets or sets the callback function that determines whether a row has details.
The callback function takes a Row as a parameter and returns a boolean value that indicates whether the row has details. For example:
// remove details from items with odd CategoryID
dp.rowHasDetail = (row) => {
return row.dataItem.CategoryID % 2 == 0;
};Setting this property to null means all regular data rows (not group rows or new item templates) have details.
Methods
getDetailRow
-
Gets the detail row associated with a given grid row.
Parameters
-
row: any
Row or index of the row to investigate.
Returns DetailRow | null
-
hideDetail
isDetailAvailable
-
Gets a value that determines if a row has details to show.
Parameters
-
row: any
Row or index of the row to investigate.
Returns boolean
-
isDetailVisible
-
Gets a value that determines if a row's details are visible.
Parameters
-
row: any
Row or index of the row to investigate.
Returns boolean
-
showDetail
Implements detail rows for FlexGrid controls.
To add detail rows to a FlexGrid control, create an instance of a FlexGridDetailProvider and set the createDetailCell property to a function that creates elements to be displayed in the detail cells.
For example:
import { FlexGrid } from '@grapecity/wijmo.grid'; import { FlexGridDetailProvider } from '@grapecity/wijmo.grid.detail'; // create FlexGrid to show categories let gridCat = new FlexGrid('#gridCat', { itemsSource: getCategories(); }); // add detail rows showing products in each category let detailProvider = new FlexGridDetailProvider(gridCat, { createDetailCell: (row) => { let cell = document.createElement('div'); new FlexGrid(cell, { itemsSource: getProducts(row.dataItem.CategoryID) }); return cell; } });The FlexGridDetailProvider provides a detailVisibilityMode property that determines when the detail rows should be displayed.
The default value for this property is ExpandSingle, which adds collapse/expand icons to the row headers.
The example below shows how you can use a FlexGridDetailProvider to add different types of detail to the rows in a FlexGrid:
Example