Inline Editing

Although the FlexGrid provides efficient, Excel-style editing by default, you may want to customize the editing behavior. If for some reason you don't like the Excel-style editing and prefer to add editing buttons to every row (typical of editable HTML tables), you can accomplish that using the formatItem event and a little code.

import 'bootstrap.css'; import '@grapecity/wijmo.styles/wijmo.css'; import './styles.css'; import * as wjGrid from '@grapecity/wijmo.grid'; import * as wjCore from '@grapecity/wijmo'; // document.readyState === 'complete' ? init() : window.onload = init; // function init() { // // create some random data var countries = 'US,Germany,UK,Japan,Italy,Greece'.split(','); var data = []; for (var i = 0; i < countries.length; i++) { data.push({ id: i, country: countries[i], sales: Math.random() * 10000, expenses: Math.random() * 5000, overdue: (i + 1) % 4 == 0 }); } // // create the grid with custom editing behavior var theGrid = new wjGrid.FlexGrid('#theGrid', { isReadOnly: true, selectionMode: 'None', headersVisibility: 'Column', itemsSource: data, columns: [ { binding: 'id', header: 'ID', width: 50 }, { binding: 'country', header: 'Country', isRequired: true, dataMap: countries }, { binding: 'sales', header: 'Sales', format: 'n2' }, { binding: 'expenses', header: 'Expenses', format: 'n2' }, { binding: 'buttons', header: 'Edit', width: 160 } ] }); // // make rows taller to accommodate edit buttons and input controls theGrid.rows.defaultSize = 40; // // custom formatter to paint buttons and editors theGrid.formatItem.addHandler(function (s, e) { if (e.panel == s.cells) { var col = s.columns[e.col], item = s.rows[e.row].dataItem; // if (item == currentEditItem) { // // create editors and buttons for the item being edited switch (col.binding) { case 'buttons': e.cell.innerHTML = document.getElementById('tplBtnEditMode').innerHTML; e.cell['dataItem'] = item; break; case 'country': case 'sales': case 'expenses': e.cell.innerHTML = '<input class="form-control" ' + 'id="' + col.binding + '" ' + 'value="' + s.getCellData(e.row, e.col, true) + '"/>'; break; } } else { // // create buttons for items not being edited switch (col.binding) { case 'buttons': e.cell.innerHTML = document.getElementById('tplBtnViewMode').innerHTML; e.cell['dataItem'] = item; break; } } } }); // // handle button clicks theGrid.addEventListener(theGrid.hostElement, 'click', function (e) { let targetBtn; if (e.target instanceof HTMLButtonElement) { targetBtn = e.target; } else if (e.target instanceof HTMLSpanElement && e.target.classList.contains('glyphicon')) { targetBtn = e.target.parentElement; } if (targetBtn) { // // get button's data item var item = wjCore.closest(targetBtn, '.wj-cell')['dataItem']; // // handle buttons switch (targetBtn.id) { // // start editing this item case 'btnEdit': editItem(item); break; // // remove this item from the collection case 'btnDelete': theGrid.collectionView.remove(item); break; // // commit edits case 'btnOK': commitEdit(); break; // // cancel edits case 'btnCancel': cancelEdit(); break; } } }); // // exit edit mode when scrolling the grid or losing focus theGrid.scrollPositionChanged.addHandler(cancelEdit); theGrid.lostFocus.addHandler(cancelEdit); // // editing commands var currentEditItem = null; // function editItem(item) { cancelEdit(); currentEditItem = item; theGrid.invalidate(); } // function commitEdit() { if (currentEditItem) { theGrid.columns.forEach(function (col) { var input = theGrid.hostElement.querySelector('#' + col.binding); if (input) { var value = wjCore.changeType(input.value, col.dataType, col.format); if (wjCore.getType(value) == col.dataType) { currentEditItem[col.binding] = value; } } }); } currentEditItem = null; theGrid.invalidate(); } // function cancelEdit() { if (currentEditItem) { currentEditItem = null; theGrid.invalidate(); } } }
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>GrapeCity Wijmo FlexGrid Inline Editing</title> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <!-- SystemJS --> <script src="node_modules/systemjs/dist/system.src.js"></script> <script src="systemjs.config.js"></script> <script> System.import('./src/app'); </script> </head> <body> <div class="container-fluid"> <div id="theGrid"> </div> <!-- template for buttons on items in view mode --> <div id="tplBtnViewMode" style="display:none"> <button id="btnEdit" class="btn btn-default btn-sm"> <span class="glyphicon glyphicon-pencil"></span> Edit </button> <button id="btnDelete" class="btn btn-default btn-sm"> <span class="glyphicon glyphicon-remove"></span> Delete </button> <div> <!-- template for buttons on items in edit mode --> <div id="tplBtnEditMode" style="display:none"> <button id="btnOK" class="btn btn-primary btn-sm"> <span class="glyphicon glyphicon-ok"></span> OK </button> <button id="btnCancel" class="btn btn-warning btn-sm"> <span class="glyphicon glyphicon-ban-circle"></span> Cancel </button> </div> </div> </body> </html>
.wj-flexgrid { max-height: 200px; margin-bottom: 12px; } body { margin-bottom: 24px; }
(function (global) { System.config({ transpiler: 'plugin-babel', babelOptions: { es2015: true }, meta: { '*.css': { loader: 'css' } }, paths: { // paths serve as alias 'npm:': 'node_modules/' }, // map tells the System loader where to look for things map: { 'jszip': 'npm:jszip/dist/jszip.js', '@grapecity/wijmo': 'npm:@grapecity/wijmo/index.js', '@grapecity/wijmo.input': 'npm:@grapecity/wijmo.input/index.js', '@grapecity/wijmo.styles': 'npm:@grapecity/wijmo.styles', '@grapecity/wijmo.cultures': 'npm:@grapecity/wijmo.cultures', '@grapecity/wijmo.chart': 'npm:@grapecity/wijmo.chart/index.js', '@grapecity/wijmo.chart.analytics': 'npm:@grapecity/wijmo.chart.analytics/index.js', '@grapecity/wijmo.chart.animation': 'npm:@grapecity/wijmo.chart.animation/index.js', '@grapecity/wijmo.chart.annotation': 'npm:@grapecity/wijmo.chart.annotation/index.js', '@grapecity/wijmo.chart.finance': 'npm:@grapecity/wijmo.chart.finance/index.js', '@grapecity/wijmo.chart.finance.analytics': 'npm:@grapecity/wijmo.chart.finance.analytics/index.js', '@grapecity/wijmo.chart.hierarchical': 'npm:@grapecity/wijmo.chart.hierarchical/index.js', '@grapecity/wijmo.chart.interaction': 'npm:@grapecity/wijmo.chart.interaction/index.js', '@grapecity/wijmo.chart.radar': 'npm:@grapecity/wijmo.chart.radar/index.js', '@grapecity/wijmo.chart.render': 'npm:@grapecity/wijmo.chart.render/index.js', '@grapecity/wijmo.gauge': 'npm:@grapecity/wijmo.gauge/index.js', '@grapecity/wijmo.grid': 'npm:@grapecity/wijmo.grid/index.js', '@grapecity/wijmo.grid.detail': 'npm:@grapecity/wijmo.grid.detail/index.js', '@grapecity/wijmo.grid.filter': 'npm:@grapecity/wijmo.grid.filter/index.js', '@grapecity/wijmo.grid.search': 'npm:@grapecity/wijmo.grid.search/index.js', '@grapecity/wijmo.grid.grouppanel': 'npm:@grapecity/wijmo.grid.grouppanel/index.js', '@grapecity/wijmo.grid.multirow': 'npm:@grapecity/wijmo.grid.multirow/index.js', '@grapecity/wijmo.grid.transposed': 'npm:@grapecity/wijmo.grid.transposed/index.js', '@grapecity/wijmo.grid.pdf': 'npm:@grapecity/wijmo.grid.pdf/index.js', '@grapecity/wijmo.grid.sheet': 'npm:@grapecity/wijmo.grid.sheet/index.js', '@grapecity/wijmo.grid.xlsx': 'npm:@grapecity/wijmo.grid.xlsx/index.js', '@grapecity/wijmo.grid.selector': 'npm:@grapecity/wijmo.grid.selector/index.js', '@grapecity/wijmo.grid.cellmaker': 'npm:@grapecity/wijmo.grid.cellmaker/index.js', '@grapecity/wijmo.nav': 'npm:@grapecity/wijmo.nav/index.js', '@grapecity/wijmo.odata': 'npm:@grapecity/wijmo.odata/index.js', '@grapecity/wijmo.olap': 'npm:@grapecity/wijmo.olap/index.js', '@grapecity/wijmo.pdf': 'npm:@grapecity/wijmo.pdf/index.js', '@grapecity/wijmo.viewer': 'npm:@grapecity/wijmo.viewer/index.js', '@grapecity/wijmo.xlsx': 'npm:@grapecity/wijmo.xlsx/index.js', '@grapecity/wijmo.undo': 'npm:@grapecity/wijmo.undo/index.js', '@grapecity/wijmo.interop.grid': 'npm:@grapecity/wijmo.interop.grid/index.js', 'jszip': 'npm:jszip/dist/jszip.js', 'bootstrap.css': 'npm:bootstrap/dist/css/bootstrap.min.css', 'css': 'npm:systemjs-plugin-css/css.js', 'plugin-babel': 'npm:systemjs-plugin-babel/plugin-babel.js', 'systemjs-babel-build':'npm:systemjs-plugin-babel/systemjs-babel-browser.js' }, // packages tells the System loader how to load when no filename and/or no extension packages: { src: { defaultExtension: 'js' }, "node_modules": { defaultExtension: 'js' }, } }); })(this);