The FlexGrid control provides a powerful and flexible way to display and edit data in a tabular format.
The FlexGrid control is a full-featured grid, providing all the features you are used to including several selection modes, sorting, column reordering, grouping, filtering, editing, custom cells, XAML-style star-sizing columns, row and column virtualization, etc.
The FlexGrid control supports the following keyboard commands:
| Key Combination | Action |
|---|---|
| Shift + Space | Select row |
| Control + Space | Select column |
| F2 | Start editing the current cell |
| Space | Start editing or toggle checkbox |
| Control + A | Select the entire grid contents |
| Left/Right | Select the cell to the left/right of the selection, collapse/expand group rows |
| Shift + Left/Right | Extend the selection to include the next cell to the left/right of the selection |
| Up/Down | Select the next cell above or below the selection |
| Shift + Up/Down | Extend the selection to include the cell above or below the selection |
| Alt + Up/Down | Drop down the listbox editor for the current cell |
| PageUp/Down | Select the cell one page above or below the selection |
| Shift + PageUp/Down | Extend the selection to include the cell one page above or below the selection |
| Alt + PageUp/Down | Move the selection to the first or last row |
| Shift + Alt + PageUp/Down | Extend the selection to include the first or last row |
| Home/End | Move the selection to the first or last column |
| Shift + Home/End | Extend the selection to include the first or last column |
| Ctrl + Home/End | Move the selection to the first/last row and column |
| Shift + Ctrl + Home/End | Extend the selection to include the first/last row and column |
| Escape | Cancel current cell or row editing operation |
| Tab | Move the selection to the next focusable element on the page (by default, can be overridden using the keyActionTab property) |
| Enter | Exit editing mode and move the selection to the cell below the current one (by default, can be overridden using the keyActionEnter property) |
| Delete, Backspace | Delete the currently selected rows (if the allowDelete property is set to true), or clear the content of the selected cells (if the values are not required). |
| Control + C or Control + Insert | Copy the selection to the clipboard (if the autoClipboard property is set to true) |
| Control + V or Shift + Insert | Paste the content of the clipboard into the selected area (if the autoClipboard property is set to true) |
{@sample Grid/Overview/purejs Example}
constructor(element: any, options?): FlexGrid
Initializes a new instance of the FlexGrid class.
The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').
JavaScript object containing initialization data for the control.
Gets the HTMLInputElement that represents the cell editor currently active.
Gets or sets a value that indicates whether the grid should provide a new row template so users can add items to the source collection.
The new row template will not be displayed if the isReadOnly property is set to true.
The default value for this property is false.
Gets or sets a value that indicates whether the grid should delete selected rows when the user presses the Delete key.
Selected rows will not be deleted if the isReadOnly property is set to true.
The default value for this property is false.
Gets or sets a value that determines whether users are allowed to drag rows and/or columns with the mouse.
If the autoScroll property is set to true, the grid will automatically scroll its contents while the user drags rows or columns into new positions.
The grid allows dragging columns by default.
Dragging rows requires special considerations in bound scenarios.
When you drag rows on bound grids, the rows will get out of sync with the data source (row 4 may refer to item 6 for example). To avoid this, you should handle the draggedRow event and synchronize the data with the new row positions.
Also, remember to set the allowSorting property to false or you the row order will be determined by the data, and dragging rows will be pointless.
This fiddle demonstrates row dragging with a bound grid: Bound Row Dragging.
The default value for this property is AllowDragging.Columns.
Gets or sets which parts of the grid provide cell merging.
The default value for this property is AllowMerging.None.
Gets or sets a value that determines whether users may resize rows and/or columns with the mouse.
If resizing is enabled, users can resize columns by dragging the right edge of column header cells, or rows by dragging the bottom edge of row header cells.
Users may also double-click the edge of the header cells to automatically resize rows and columns to fit their content. The auto-size behavior can be customized using the autoSizeMode property.
The default value for this property is AllowResizing.Columns.
Gets or sets a value that determines whether users are allowed to sort columns by clicking the column header cells.
The default value for this property is true.
Gets or sets a value that determines the number of regular rows between 'alternating' rows.
The default value for this property is 1. Set it to zero to disable alternating rows, or to a number greater than one to insert multiple regular rows between alternating rows.
Gets or sets a value that determines whether extending selections with the mouse or keyboard should change the start (cursor) or the end of the current selection.
The default value for this property is false, which causes the grid to move the cursor and keep the selection end anchored.
Setting this property to true causes the grid to move the selection end and keep the cursor anchored. This is Excel's behavior.
Gets or sets a value that determines whether the grid should handle clipboard shortcuts.
The clipboard shortcuts are as follows:
Only visible rows and columns are included in clipboard operations.
Read-only cells are not affected by paste operations.
The default value for this property is true.
Gets or sets a value that determines whether the grid should generate columns automatically based on the itemsSource.
The column generation depends on the itemsSource property containing at least one item. This data item is inspected and a column is created and bound to each property that contains a primitive value (number, string, Boolean, or Date).
Properties set to null do not generate columns, because the grid would have no way of guessing the appropriate type. In this type of scenario, you should set the autoGenerateColumns property to false and create the columns explicitly. For example:
```typescript import { FlexGrid } from '@grapecity/wijmo.grid'; var grid = new FlexGrid('#theGrid', { autoGenerateColumns: false, // data items may contain null values columns: [ // so define columns explicitly { binding: 'name', header: 'Name', dataType: 'String' }, { binding: 'amount', header: 'Amount', dataType: 'Number' }, { binding: 'date', header: 'Date', dataType: 'Date' }, { binding: 'active', header: 'Active', dataType: 'Boolean' } ], itemsSource: customers }); ```
The default value for this property is true.
Gets or sets a value that determines whether the grid should automatically scroll its contents while users drag rows or columns into new positions.
Row and column dragging are controlled by the allowDragging property.
The default value for this property is true.
Gets or sets a value that determines whether the grid should search for cells as the users types into read-only cells.
The search happens on the column that is currently selected, if it is not editable. The search starts at the currently selected row and is case-insensitive.
The default value for this property is false.
Gets or sets which cells should be taken into account when auto-sizing a row or column.
This property controls what happens when users double-click the edge of a column header.
By default, the grid will automatically set the column width based on the content of the header and data cells in the column. This property allows you to change that to include only the headers or only the data.
The default value for this property is AutoSizeMode.Both.
Gets the GridPanel that contains the bottom left cells.
The bottomLeftCells panel appears below the row headers, to the left of the columnFooters panel.
Gets or sets the CellFactory that creates and updates cells for this grid.
Gets or sets the name of the property (or properties) used to generate child rows in hierarchical grids.
Set this property to a string to specify the name of the property that contains an item's child items (e.g. childItemsPath = 'items';).
If items at different levels have child items with different names, set this property to an array containing the names of the properties that contain child items et each level (e.g. childItemsPath = ['checks','earnings'];).
{@sample Grid/TreeGrid/ChildItems/purejs Example}
Gets the client size of the control (control size minus headers and scrollbars).
Gets or sets a value that determines whether the FlexGrid should clone frozen cells and show then in a separate element to reduce flicker while scrolling.
The default value for this property is null, which causes the grid to select the best setting depending on the browser.
Gets the ICollectionView that contains the grid data.
If the itemsSource property was set to an ICollectionView, this property returns that value.
If the itemsSource property was set to an array of data items, this property returns the internal CollectionView created by the grid to support currency, editing, and sorting.
Gets or sets a JSON string that defines the current column layout.
The column layout string represents an array with the columns and their properties. It can be used to persist column layouts defined by users so they are preserved across sessions, and can also be used to implement undo/redo functionality in applications that allow users to modify the column layout.
The column layout string does not include dataMap properties because data maps are not serializable.
Gets or sets the template used to instantiate FlexGrid controls.
Gets or sets a value that determines whether row and column resizing should be deferred until the user releases the mouse button.
By default, deferResizing is set to false, causing rows and columns to be resized as the user drags the mouse. Setting this property to true causes the grid to show a resizing marker and to resize the row or column only when the user releases the mouse button.
The default value for this property is false.
Gets the IEditableCollectionView that contains the grid data.
Gets or sets the index of column in the row header panel that shows whether items are being edited.
The default value for this property is null, which cause the grid to show the edit glyph on the last column of the rowHeaders panel.
Gets or sets the Tooltip object used to show validation errors detected by the grid when the showErrors property is set to true.
By default, this property is set to a tooltip with zero show delay (so it appears immediately when hovering over invalid cells), no HTML content, and a "wj-error-tip" class which can be used to customize the tooltip's appearance.
Setting this property to null causes the control to use the cell's "title" attribute to show validation errors.
Gets or sets the number of frozen columns.
Frozen columns do not scroll horizontally, but the cells they contain may be selected and edited.
The default value for this property is 0.
Gets or sets the number of frozen rows.
Frozen rows do not scroll vertically, but the cells they contain may be selected and edited.
The default value for this property is 0.
Gets or sets the format string used to create the group header content.
The string may contain any text, plus the following replacement strings:
If a column is bound to the grouping property, the column header is used to replace the {name} parameter, and the column's format and data maps are used to calculate the {value} parameter. If no column is available, the group information is used instead.
You may add invisible columns bound to the group properties in order to customize the formatting of the group header cells.
The default value for this property is
'{name}: <b>{value}</b>({count:n0} items)', which creates group headers similar to
'Country: UK (12 items)' or
'Country: Japan (8 items)'.
Gets or sets a value that determines whether the row and column headers are visible.
The default value for this property is HeadersVisibility.All.
Gets the DOM element that is hosting the control.
Gets or sets a value that determines whether the grid should support Input Method Editors (IME) while not in edit mode.
This property is relevant only for sites/applications in Japanese, Chinese, Korean, and other languages that require IME support.
The default value for this property is false.
Gets or sets a value that determines whether the control is disabled.
Disabled controls cannot get mouse or keyboard events.
Gets or sets a value that determines whether the user can modify cell values using the mouse and keyboard.
The default value for this property is false.
Gets a value that indicates whether the control is currently handling a touch event.
Gets a value that indicates whether the control is currently being updated.
Gets or sets a formatter function used to customize cells on this grid.
The formatter function can add any content to any cell. It provides complete flexibility over the appearance and behavior of grid cells.
If specified, the function should take four parameters: the GridPanel that contains the cell, the row and column indices of the cell, and the HTML element that represents the cell. The function will typically change the innerHTML property of the cell element.
For example:
flex.itemFormatter = function(panel, r, c, cell) {
if (panel.cellType == CellType.Cell) {
// draw sparklines in the cell
var col = panel.columns[c];
if (col.name == 'sparklines') {
cell.innerHTML = getSparklike(panel, r, c);
}
}
}
Note that the FlexGrid recycles cells, so if your itemFormatter modifies the cell's style attributes, you must make sure that it resets these attributes for cells that should not have them. For example:
flex.itemFormatter = function(panel, r, c, cell) {
// reset attributes we are about to customize
var s = cell.style;
s.color = '';
s.backgroundColor = '';
// customize color and backgroundColor attributes for this cell
...
}
If you have a scenario where multiple clients may want to customize the grid rendering (for example when creating directives or re-usable libraries), consider using the formatItem event instead. The event allows multiple clients to attach their own handlers.
Gets or sets the array or ICollectionView that contains items shown on the grid.
Gets or sets a validator function to determine whether cells contain valid data.
If specified, the validator function should take two parameters containing the cell's row and column indices, and should return a string containing the error description.
This property is especially useful when dealing with unbound grids, since bound grids can be validated using the getError property instead.
This example shows how you could prevent cells from containing the same data as the cell immediately above it:
// check that the cell above doesn't contain the same value as this one
theGrid.itemValidator = function (row, col) {
if (row > 0) {
var valThis = theGrid.getCellData(row, col, false),
valPrev = theGrid.getCellData(row - 1, col, false);
if (valThis != null && valThis == valPrev) {
return 'This is a duplicate value...'
}
}
return null; // no errors
}
Gets or sets the action to perform when the ENTER key is pressed.
The default setting for this property is MoveDown, which causes the control to move the selection to the next row. This is the standard Excel behavior.
Gets or sets the action to perform when the TAB key is pressed.
The default setting for this property is None, which causes the browser to select the next or previous controls on the page when the TAB key is pressed. This is the recommended setting to improve page accessibility.
In previous versions, the default was set to Cycle, which caused the control to move the selection across and down the grid. This is the standard Excel behavior, but is not good for accessibility.
There is also a CycleOut setting that causes the selection to move through the cells (as Cycle), and then on to the next/previous control on the page when the last or first cells are selected.
Gets or sets the MergeManager object responsible for determining how cells should be merged.
Gets or sets a value that indicates whether the new row template should be located at the top of the grid or at the bottom.
If you set the newRowAtTop property to true, and you want the new row template to remain visible at all times, set the frozenRows property to one. This will freeze the new row template at the top so it won't scroll off the view.
The new row template will be displayed only if the allowAddNew property is set to true and if the itemsSource object supports adding new items.
The default value for this property is false.
Gets or sets a value that determines whether the grid should preserve the expanded/collapsed state of nodes when the data is refreshed.
The preserveOutlineState property implementation is based on JavaScript's Map object, which is not available in IE 9 or 10.
The default value for this property is true.
Gets or sets a value that determines whether the grid should preserve the selected state of rows when the data is refreshed.
The default value for this property is true.
Gets or sets a value that determines whether the grid should optimize performance over precision when auto-sizing columns.
Setting this property to false disables quick auto-sizing. Setting it to true enables the feature, subject to the value of each column's quickAutoSize property. Setting it to null (the default value) enables the feature for grids that don't have a custom itemFormatter or handlers attached to the formatItem event.
Gets a value indicating whether the control is hosted in an element with right-to-left layout.
Gets or sets the name of the property used to create row header cells.
Row header cells are not visible or selectable. They are meant for use with accessibility tools.
Gets or sets an array containing the data items that are currently selected.
Note: this property can be read in all selection modes, but it can be set only when selectionMode is set to SelectionMode.ListBox.
Gets or sets an array containing the rows that are currently selected.
Note: this property can be read in all selection modes, but it can be set only when selectionMode is set to SelectionMode.ListBox.
Gets or sets a value that indicates whether the grid adds drop-down buttons to the cells in columns that have the showDropDown property set to true.
The drop-down buttons are shown only on columns that have a dataMap set and are editable. Clicking on the drop-down buttons causes the grid to show a list where users can select the value for the cell.
Cell drop-downs require the wijmo.input module to be loaded.
Gets or sets a value that determines whether the grid should add the 'wj-state-invalid' class to cells that contain validation errors and tooltips with error descriptions.
The grid detects validation errors using the itemValidator property and the getError property on the grid's itemsSource.
The default value for this property is true.
Gets or sets a value that determines whether the FlexGrid should insert group rows to delimit data groups.
Data groups are created by modifying the groupDescriptions property of the itemsSource.
The default value for this property is true.
Gets or sets a value that indicates whether the grid should display an Excel-style marquee around the current selection.
The default value for this property is false.
Gets or sets a value that indicates whether the grid should add class names to indicate selected header cells.
The default value for this property is HeadersVisibility.None.
Gets or sets a value that determines whether the grid should display sort indicators in the column headers.
Sorting is controlled by the sortDescriptions property of the ICollectionView object used as a the grid's itemsSource.
The default value for this property is true.
Gets or sets the index of row in the column header panel that shows and changes the current sort.
The default value for this property is null, which causes the bottom row in the columnHeaders panel to act as the sort row.
Gets or sets a value that determines whether column headers should remain visible when the user scrolls the document.
The default value for this property is false.
Gets the GridPanel that contains the top left cells (to the left of the column headers).
Gets or sets a value that determines whether the grid should remain in edit mode when the user tries to commit edits that fail validation.
The grid detects validation errors by calling the getError method on the grid's itemsSource.
The default value for this property is true.
Gets or sets the minimum number of rows and/or columns required to enable virtualization.
This property is set to zero by default, meaning virtualization is always enabled. This improves binding performance and memory requirements, at the expense of a small performance decrease while scrolling.
If your grid has a small number of rows (about 50 to 100), you may be able to improve scrolling performance by setting this property to a slightly higher value (like 150). This will disable virtualization and will slow down binding, but may improve perceived scroll performance. For example, the code below sets causes the grid to virtualize cells when the data source has more than 150 items:
// virtualize grid when there are more than 150 items theGrid.virtualizationThreshold = 150;
Setting this property to values higher than 200 is not recommended. Loading times will become too long; the grid will freeze for a few seconds while creating cells for all rows, and the browser will become slow because of the large number of elements on the page.
If you want to set separate virtualization thresholds for rows and columns, you may set the virtualizationThreshold property to an array with two numbers. In this case, the first number will be used as the row threshold and the second as the column threshold. For example, the code below sets causes the grid to virtualize rows but not columns:
// virtualize rows (threshold 0) but not columns (threshold 10,000) theGrid.virtualizationThreshold = [0, 10000];
The default value for this property is 0, which virtualizes all rows and columns.
addEventListener(target: EventTarget, type: string, fn: any, capture?: boolean, passive?: boolean): void
Adds an event listener to an element owned by this Control.
The control keeps a list of attached listeners and their handlers, making it easier to remove them when the control is disposed (see the dispose and removeEventListener methods).
Failing to remove event listeners may cause memory leaks.
The passive parameter is set to false by default, which means the event handler may call event.preventDefault(). If you are adding passive handlers to touch or wheel events, setting this parameter to true will improve application performance.
For details on passive event listeners, please see Improving scrolling performance with passive listeners.
Target element for the event.
String that specifies the event.
Function to execute when the event occurs.
Whether the listener should be handled by the control before it is handled by the target element.
Indicates that the handler will never call preventDefault().
applyTemplate(classNames: string, template: string, parts: Object, namePart?: string): HTMLElement
Applies the template to a new instance of a control, and returns the root element.
This method should be called by constructors of templated controls. It is responsible for binding the template parts to the corresponding control members.
For example, the code below applies a template to an instance of an InputNumber control. The template must contain elements with the 'wj-part' attribute set to 'input', 'btn-inc', and 'btn-dec'. The control members '_tbx', '_btnUp', and '_btnDn' will be assigned references to these elements.
this.applyTemplate('wj-control wj-inputnumber', template, {
_tbx: 'input',
_btnUp: 'btn-inc',
_btnDn: 'btn-dec'
}, 'input');
Names of classes to add to the control's host element.
An HTML string that defines the control template.
A dictionary of part variables and their names.
Name of the part to be named after the host element. This determines how the control submits data when used in forms.
autoSizeColumn(c: number, header?: boolean, extra?: number): void
Resizes a column to fit its content.
This method only works if the grid is visible. If its host element has not been added to the DOM, or if any of the grid's ancestor elements is hidden, the grid will not be able to measure the cells and therefore will not be able to auto-size the columns.
Index of the column to resize.
Whether the column index refers to a regular or a header row.
Extra spacing, in pixels.
autoSizeColumns(firstColumn?: number, lastColumn?: number, header?: boolean, extra?: number): void
Resizes a range of columns to fit their content.
The grid will always measure all rows in the current view range, plus up to 2,000 rows not currently in view. If the grid contains a large amount of data (say 50,000 rows), then not all rows will be measured since that could take a long time.
This method only works if the grid is visible. If its host element has not been added to the DOM, or if any of the grid's ancestor elements is hidden, the grid will not be able to measure the cells and therefore will not be able to auto-size the columns.
Index of the first column to resize (defaults to the first column).
Index of the last column to resize (defaults to the last column).
Whether the column indices refer to regular or header columns.
Extra spacing, in pixels.
autoSizeRow(r: number, header?: boolean, extra?: number): void
Resizes a row to fit its content.
This method only works if the grid is visible. If its host element has not been added to the DOM, or if any of the grid's ancestor elements are hidden, the grid will not be able to measure the cells and therefore will not be able to auto-size the rows.
Index of the row to resize.
Whether the row index refers to a regular or a header row.
Extra spacing, in pixels.
autoSizeRows(firstRow?: number, lastRow?: number, header?: boolean, extra?: number): void
Resizes a range of rows to fit their content.
This method only works if the grid is visible. If its host element has not been added to the DOM, or if any of the grid's ancestor elements is hidden, the grid will not be able to measure the cells and therefore will not be able to auto-size the rows.
Index of the first row to resize.
Index of the last row to resize.
Whether the row indices refer to regular or header rows.
Extra spacing, in pixels.
beginUpdate(): void
Suspends notifications until the next call to endUpdate.
canEditCell(r: number, c: number): void
Gets a value that indicates whether a given cell can be edited.
Index of the row that contains the cell.
Index of the column that contains the cell.
collapseGroupsToLevel(level: number): void
Collapses all the group rows to a given level.
Maximum group level to show.
deferUpdate(fn: Function): void
Executes a function within a beginUpdate/endUpdate block.
The control will not be updated until the function has been executed. This method ensures endUpdate is called even if the function throws an exception.
Function to be executed.
dispose(): void
Disposes of the control by removing its association with the host element.
disposeAll(e?: HTMLElement): void
Disposes of all Wijmo controls contained in an HTML element.
Container element.
endUpdate(): void
Resumes notifications suspended by calls to beginUpdate.
finishEditing(cancel?: boolean): boolean
Commits any pending edits and exits edit mode.
Whether pending edits should be canceled or committed.
focus(): void
Overridden to set the focus to the grid without scrolling the whole grid into view.
getCellBoundingRect(r: number, c: number, raw?: boolean): Rect
Gets a the bounds of a cell element in viewport coordinates.
This method returns the bounds of cells in the cells panel (scrollable data cells). To get the bounds of cells in other panels, use the getCellBoundingRect method in the appropriate GridPanel object.
The returned value is a Rect object which contains the position and dimensions of the cell in viewport coordinates. The viewport coordinates are the same used by the getBoundingClientRect method.
Index of the row that contains the cell.
Index of the column that contains the cell.
Whether to return the rectangle in raw panel coordinates as opposed to viewport coordinates.
getCellData(r: number, c: number, formatted: boolean): any
Gets the value stored in a cell in the scrollable area of the grid.
Index of the row that contains the cell.
Index of the column that contains the cell.
Whether to format the value for display.
getClipString(rng?: CellRange, csv?: boolean, colHdrs?: boolean, rowHdrs?: boolean): string
Gets the content of a CellRange as a string suitable for copying to the clipboard.
Hidden rows and columns are not included in the clip string.
CellRange to copy. If omitted, the current selection is used.
Whether to use the CSV format (comma-delimited cells).
Whether to include the column headers.
Whether to include the row headers.
getColumn(name: string): Column
Gets a column by name or by binding.
The method searches the column by name. If a column with the given name is not found, it searches by binding. The searches are case-sensitive.
The name or binding to find.
getControl(element: any): Control
Gets the control that is hosted in a given DOM element.
The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').
getMergedRange(p: GridPanel, r: number, c: number, clip?: boolean): CellRange
The GridPanel that contains the range.
Index of the row that contains the cell.
Index of the column that contains the cell.
Whether to clip the merged range to the grid's current view range.
getSelectedState(r: number, c: number): SelectedState
Gets a SelectedState value that indicates the selected state of a cell.
getTemplate(): string
Gets the HTML template used to create instances of the control.
This method traverses up the class hierarchy to find the nearest ancestor that specifies a control template. For example, if you specify a prototype for the ComboBox control, which does not specify a template, it will override the template defined by the DropDown base class (the nearest ancestor that does specify a template).
hitTest(pt: any, y?: any): HitTestInfo
Gets a HitTestInfo object with information about a given point.
For example:
// hit test a point when the user clicks on the grid
flex.hostElement.addEventListener('click', function (e) {
var ht = flex.hitTest(e.pageX, e.pageY);
console.log('you clicked a cell of type "' +
wijmo.grid.CellType[ht.cellType] + '".');
});
Point to investigate, in page coordinates, or a MouseEvent object, or x coordinate of the point.
Y coordinate of the point in page coordinates (if the first parameter is a number).
initialize(options: any): void
Initializes the control by copying the properties from a given object.
This method allows you to initialize controls using plain data objects instead of setting the value of each property in code.
For example:
grid.initialize({
itemsSource: myList,
autoGenerateColumns: false,
columns: [
{ binding: 'id', header: 'Code', width: 130 },
{ binding: 'name', header: 'Name', width: 60 }
]
});
// is equivalent to
grid.itemsSource = myList;
grid.autoGenerateColumns = false;
// etc.
The initialization data is type-checked as it is applied. If the initialization object contains unknown property names or invalid data types, this method will throw.
Object that contains the initialization data.
invalidate(fullUpdate?: boolean): void
Invalidates the control causing an asynchronous refresh.
Whether to update the control layout as well as the content.
invalidateAll(e?: HTMLElement): void
Invalidates all Wijmo controls contained in an HTML element.
Use this method when your application has dynamic panels that change the control's visibility or dimensions. For example, splitters, accordions, and tab controls usually change the visibility of its content elements. In this case, failing to notify the controls contained in the element may cause them to stop working properly.
If this happens, you must handle the appropriate event in the dynamic container and call the invalidateAll method so the contained Wijmo controls will update their layout information properly.
Container element. If set to null, all Wijmo controls on the page will be invalidated.
isRangeValid(rng: CellRange): boolean
Checks whether a given CellRange is valid for this grid's row and column collections.
Range to check.
onAutoSizedColumn(e: CellRangeEventArgs): void
Raises the autoSizedColumn event.
CellRangeEventArgs that contains the event data.
onAutoSizedRow(e: CellRangeEventArgs): void
Raises the autoSizedRow event.
CellRangeEventArgs that contains the event data.
onAutoSizingColumn(e: CellRangeEventArgs): boolean
Raises the autoSizingColumn event.
CellRangeEventArgs that contains the event data.
onAutoSizingRow(e: CellRangeEventArgs): boolean
Raises the autoSizingRow event.
CellRangeEventArgs that contains the event data.
onBeginningEdit(e: CellRangeEventArgs): boolean
Raises the beginningEdit event.
CellRangeEventArgs that contains the event data.
onCellEditEnded(e: CellRangeEventArgs): void
Raises the cellEditEnded event.
CellRangeEventArgs that contains the event data.
onCellEditEnding(e: CellEditEndingEventArgs): boolean
Raises the cellEditEnding event.
CellEditEndingEventArgs that contains the event data.
onCopied(e: CellRangeEventArgs): void
Raises the copied event.
CellRangeEventArgs that contains the event data.
onCopying(e: CellRangeEventArgs): boolean
Raises the copying event.
CellRangeEventArgs that contains the event data.
onDeletedRow(e: CellRangeEventArgs): void
Raises the deletedRow event.
CellRangeEventArgs that contains the event data.
onDeletingRow(e: CellRangeEventArgs): boolean
Raises the deletingRow event.
CellRangeEventArgs that contains the event data.
onDraggedColumn(e: CellRangeEventArgs): void
Raises the draggedColumn event.
CellRangeEventArgs that contains the event data.
onDraggedRow(e: CellRangeEventArgs): void
Raises the draggedRow event.
CellRangeEventArgs that contains the event data.
onDraggingColumn(e: CellRangeEventArgs): boolean
Raises the draggingColumn event.
CellRangeEventArgs that contains the event data.
onDraggingColumnOver(e: CellRangeEventArgs): boolean
Raises the draggingColumnOver event.
CellRangeEventArgs that contains the event data.
onDraggingRow(e: CellRangeEventArgs): boolean
Raises the draggingRow event.
CellRangeEventArgs that contains the event data.
onDraggingRowOver(e: CellRangeEventArgs): boolean
Raises the draggingRowOver event.
CellRangeEventArgs that contains the event data.
onFormatItem(e: FormatItemEventArgs): void
Raises the formatItem event.
FormatItemEventArgs that contains the event data.
onGotFocus(e?: EventArgs): void
Raises the gotFocus event.
onGroupCollapsedChanged(e: CellRangeEventArgs): void
Raises the groupCollapsedChanged event.
CellRangeEventArgs that contains the event data.
onGroupCollapsedChanging(e: CellRangeEventArgs): boolean
Raises the groupCollapsedChanging event.
CellRangeEventArgs that contains the event data.
onItemsSourceChanged(e?: EventArgs): void
Raises the itemsSourceChanged event.
onItemsSourceChanging(e: CancelEventArgs): boolean
Raises the itemsSourceChanged event.
CancelEventArgs that contains the event data.
onLoadedRows(e?: EventArgs): void
Raises the loadedRows event.
onLoadingRows(e: CancelEventArgs): boolean
Raises the loadingRows event.
CancelEventArgs that contains the event data.
onLostFocus(e?: EventArgs): void
Raises the lostFocus event.
onPasted(e: CellRangeEventArgs): void
Raises the pasted event.
CellRangeEventArgs that contains the event data.
onPastedCell(e: CellRangeEventArgs): void
Raises the pastedCell event.
CellRangeEventArgs that contains the event data.
onPasting(e: CellRangeEventArgs): boolean
Raises the pasting event.
CellRangeEventArgs that contains the event data.
onPastingCell(e: CellRangeEventArgs): boolean
Raises the pastingCell event.
CellRangeEventArgs that contains the event data.
onPrepareCellForEdit(e: CellRangeEventArgs): void
Raises the prepareCellForEdit event.
CellRangeEventArgs that contains the event data.
onRefreshed(e?: EventArgs): void
Raises the refreshed event.
onRefreshing(e?: EventArgs): void
Raises the refreshing event.
onResizedColumn(e: CellRangeEventArgs): void
Raises the resizedColumn event.
CellRangeEventArgs that contains the event data.
onResizedRow(e: CellRangeEventArgs): void
Raises the resizedRow event.
CellRangeEventArgs that contains the event data.
onResizingColumn(e: CellRangeEventArgs): boolean
Raises the resizingColumn event.
CellRangeEventArgs that contains the event data.
onResizingRow(e: CellRangeEventArgs): boolean
Raises the resizingRow event.
CellRangeEventArgs that contains the event data.
onRowAdded(e: CellRangeEventArgs): boolean
Raises the rowAdded event.
CellRangeEventArgs that contains the event data.
onRowEditEnded(e: CellRangeEventArgs): void
Raises the rowEditEnded event.
CellRangeEventArgs that contains the event data.
onRowEditEnding(e: CellRangeEventArgs): void
Raises the rowEditEnding event.
CellRangeEventArgs that contains the event data.
onRowEditStarted(e: CellRangeEventArgs): void
Raises the rowEditStarted event.
CellRangeEventArgs that contains the event data.
onRowEditStarting(e: CellRangeEventArgs): void
Raises the rowEditStarting event.
CellRangeEventArgs that contains the event data.
onScrollPositionChanged(e?: EventArgs): void
Raises the scrollPositionChanged event.
onSelectionChanged(e: CellRangeEventArgs): void
Raises the selectionChanged event.
CellRangeEventArgs that contains the event data.
onSelectionChanging(e: CellRangeEventArgs): boolean
Raises the selectionChanging event.
CellRangeEventArgs that contains the event data.
onSortedColumn(e: CellRangeEventArgs): void
Raises the sortedColumn event.
CellRangeEventArgs that contains the event data.
onSortingColumn(e: CellRangeEventArgs): boolean
Raises the sortingColumn event.
CellRangeEventArgs that contains the event data.
onUpdatedLayout(e?: EventArgs): void
Raises the updatedLayout event.
onUpdatedView(e?: EventArgs): void
Raises the updatedView event.
onUpdatingLayout(e: CancelEventArgs): boolean
Raises the updatingLayout event.
CancelEventArgs that contains the event data.
onUpdatingView(e: CancelEventArgs): boolean
Raises the updatingView event.
CancelEventArgs that contains the event data.
refresh(fullUpdate?: boolean): void
Refreshes the grid display.
Whether to update the grid layout and content, or just the content.
refreshAll(e?: HTMLElement): void
Refreshes all Wijmo controls contained in an HTML element.
This method is similar to invalidateAll, except the controls are updated immediately rather than after an interval.
Container element. If set to null, all Wijmo controls on the page will be invalidated.
refreshCells(fullUpdate: boolean, recycle?: boolean, state?: boolean): void
Refreshes the grid display.
Whether to update the grid layout and content, or just the content.
Whether to recycle existing elements.
Whether to keep existing elements and update their state.
removeEventListener(target?: EventTarget, type?: string, fn?: any, capture?: boolean): number
Removes one or more event listeners attached to elements owned by this Control.
Target element for the event. If null, removes listeners attached to all targets.
String that specifies the event. If null, removes listeners attached to all events.
Handler to remove. If null, removes all handlers.
Whether the listener is capturing. If null, removes capturing and non-capturing listeners.
scrollIntoView(r: number, c: number, refresh?: boolean): boolean
Scrolls the grid to bring a specific cell into view.
Negative row and column indices are ignored, so if you call
grid.scrollIntoView(200, -1);
The grid will scroll vertically to show row 200, and will not scroll horizontally.
Index of the row to scroll into view.
Index of the column to scroll into view.
Optional parameter that determines whether the grid should refresh to show the new scroll position immediately.
select(rng: any, show?: any): void
Selects a cell range and optionally scrolls it into view.
The select method can be called by passing a CellRange and an optional boolean parameter that indicates whether the new selection should be scrolled into view. For example:
// select cell 1,1 and scroll it into view
grid.select(new CellRange(1, 1), true);
// select range (1,1)-(2,4) and do not scroll it into view
grid.select(new CellRange(1, 1, 2, 4), false);
You can also call the select method passing the index or the row and column you want to select. In this case, the new selection always scrolls into view. For example:
// select cell 1,1 and scroll it into view
grid.select(1, 1);
Range to select.
Whether to scroll the new selection into view.
setCellData(r: number, c: any, value: any, coerce?: boolean, invalidate?: boolean): boolean
Sets the value of a cell in the scrollable area of the grid.
Index of the row that contains the cell.
Index, name, or binding of the column that contains the cell.
Value to store in the cell.
Whether to change the value automatically to match the column's data type.
Whether to invalidate the grid to show the change.
setClipString(text: string, rng?: CellRange): void
Parses a string into rows and columns and applies the content to a given range.
Hidden rows and columns are skipped.
Tab and newline delimited text to parse into the grid.
CellRange to copy. If omitted, the current selection is used.
startEditing(fullEdit?: boolean, r?: number, c?: number, focus?: boolean): boolean
Starts editing a given cell.
Editing in the FlexGrid is similar to editing in Excel: Pressing F2 or double-clicking a cell puts the grid in full-edit mode. In this mode, the cell editor remains active until the user presses Enter, Tab, or Escape, or until he moves the selection with the mouse. In full-edit mode, pressing the cursor keys does not cause the grid to exit edit mode.
Typing text directly into a cell puts the grid in quick-edit mode. In this mode, the cell editor remains active until the user presses Enter, Tab, or Escape, or any arrow keys.
Full-edit mode is normally used to make changes to existing values. Quick-edit mode is normally used for entering new data quickly.
While editing, the user can toggle between full and quick modes by pressing the F2 key.
Whether to stay in edit mode when the user presses the cursor keys. Defaults to true.
Index of the row to be edited. Defaults to the currently selected row.
Index of the column to be edited. Defaults to the currently selected column.
Whether to give the editor the focus when editing starts. Defaults to true.
toggleDropDownList(): void
Toggles the drop-down list-box associated with the currently selected cell.
This method can be used to show the drop-down list automatically when the cell enters edit mode, or when the user presses certain keys.
For example, this code causes the grid to show the drop-down list whenever the grid enters edit mode:
// show the drop-down list when the grid enters edit mode
theGrid.beginningEdit = function () {
theGrid.toggleDropDownList();
}
This code causes the grid to show the drop-down list when the grid enters edit mode after the user presses the space bar:
// show the drop-down list when the user presses the space bar
theGrid.hostElement.addEventListener('keydown', function (e) {
if (e.keyCode == 32) {
e.preventDefault();
theGrid.toggleDropDownList();
}
}, true);
Occurs after the user auto-sizes a column by double-clicking the right edge of a column header cell.
Occurs after the user auto-sizes a row by double-clicking the bottom edge of a row header cell.
Occurs before the user auto-sizes a column by double-clicking the right edge of a column header cell.
Occurs before the user auto-sizes a row by double-clicking the bottom edge of a row header cell.
Occurs when a cell edit is ending.
You can use this event to perform validation and prevent invalid edits. For example, the code below prevents users from entering values that do not contain the letter 'a'. The code demonstrates how you can obtain the old and new values before the edits are applied.
function cellEditEnding (sender, e) {
// get old and new values
var flex = sender,
oldVal = flex.getCellData(e.row, e.col),
newVal = flex.activeEditor.value;
// cancel edits if newVal doesn't contain 'a'
e.cancel = newVal.indexOf('a') < 0;
}
Setting the cancel parameter to true causes the grid to discard the edited value and keep the cell's original value.
If you also set the stayInEditMode parameter to true, the grid will remain in edit mode so the user can correct invalid entries before committing the edits.
Occurs after the user has copied the selection content to the clipboard by pressing one of the clipboard shortcut keys (see the autoClipboard property).
Occurs when the user is copying the selection content to the clipboard by pressing one of the clipboard shortcut keys (see the autoClipboard property).
The event handler may cancel the copy operation.
Occurs after the user has deleted a row by pressing the Delete key (see the allowDelete property).
Occurs when the user is deleting a selected row by pressing the Delete key (see the allowDelete property).
The event handler may cancel the row deletion.
Occurs as the user drags a column to a new position.
The handler may cancel the event to prevent users from dropping columns at certain positions. For example:
// remember column being dragged
flex.draggingColumn.addHandler(function (s, e) {
theColumn = s.columns[e.col].binding;
});
// prevent 'sales' column from being dragged to index 0
s.draggingColumnOver.addHandler(function (s, e) {
if (theColumn == 'sales' && e.col == 0) {
e.cancel = true;
}
});
Occurs when an element representing a cell has been created.
This event can be used to format cells for display. It is similar in purpose to the itemFormatter property, but has the advantage of allowing multiple independent handlers.
For example, this code removes the 'wj-wrap' class from cells in group rows:
flex.formatItem.addHandler(function (s, e) {
if (flex.rows[e.row] instanceof wijmo.grid.GroupRow) {
wijmo.removeClass(e.cell, 'wj-wrap');
}
});
Occurs after a group has been expanded or collapsed.
Occurs when a group is about to be expanded or collapsed.
Occurs after the grid has been bound to a new items source.
Occurs after the grid rows have been bound to items in the data source.
Occurs before the grid rows are bound to items in the data source.
Occurs after the user has pasted content from the clipboard by pressing one of the clipboard shortcut keys (see the autoClipboard property).
Occurs after the user has pasted content from the clipboard into a cell (see the autoClipboard property).
Occurs when the user is pasting content from the clipboard by pressing one of the clipboard shortcut keys (see the autoClipboard property).
The event handler may cancel the paste operation.
Occurs when the user is pasting content from the clipboard into a cell (see the autoClipboard property).
The event handler may cancel the paste operation.
Occurs when an editor cell is created and before it becomes active.
Occurs after the control has refreshed its contents.
Occurs when the control is about to refresh its contents.
Occurs when the user creates a new item by editing the new row template (see the allowAddNew property).
The event handler may customize the content of the new item or cancel the new item creation.
Occurs when a row edit is ending, before the changes are committed or canceled.
This event can be used in conjunction with the rowEditStarted event to implement deep-binding edit undos. For example:
// save deep bound values when editing starts
var itemData = {};
s.rowEditStarted.addHandler(function (s, e) {
var item = s.collectionView.currentEditItem;
itemData = {};
s.columns.forEach(function (col) {
if (col.binding.indexOf('.') > -1) { // deep binding
var binding = new wijmo.Binding(col.binding);
itemData[col.binding] = binding.getValue(item);
}
})
});
// restore deep bound values when edits are canceled
s.rowEditEnded.addHandler(function (s, e) {
if (e.cancel) { // edits were canceled by the user
var item = s.collectionView.currentEditItem;
for (var k in itemData) {
var binding = new wijmo.Binding(k);
binding.setValue(item, itemData[k]);
}
}
itemData = {};
});
Occurs after the user applies a sort by clicking on a column header.
Occurs before the user applies a sort by clicking on a column header.
Occurs when the grid finishes creating/updating the elements that make up the current view.
The grid updates the view in response to several actions, including:
Occurs when the grid starts creating/updating the elements that make up the current view.