CollectionView Validation

The CollectionView has a getError property that provides validation support. You can perform your own validation using a custom function when items are edited.

This sample uses the getError property function to only allow certain countries and positive numbers to be committed.

Learn about FlexGrid | Editing Views Documentation | CollectionView API Reference

import 'bootstrap.css'; import '@mescius/wijmo.styles/wijmo.css'; import './styles.css'; // import * as wijmo from '@mescius/wijmo'; import * as grid from '@mescius/wijmo.grid'; import { countries, getData } from './data'; // document.readyState === 'complete' ? init() : window.onload = init; // function init() { // create a CollectionView let view = new wijmo.CollectionView(getData(), { sortDescriptions: ['country'], getError, }); // // CollectionView validation function function getError(item, propName) { switch (propName) { case 'country': return countries.indexOf( < 0 ? 'Invalid Country' : ''; case 'downloads': case 'sales': case 'expenses': return item[propName] < 0 ? 'Negative values not allowed!' : ''; case 'active': return &&^(US|Germany)$/) ? 'Active items not allowed in the US or Germany!' : ''; case null: let errors = []; for (let key in item) { let err = getError(item, key); if (err) errors.push(err); } return errors.length > 1 ? 'this item has ' + errors.length + ' errors' : (errors.length == 1 ? errors[0] : null); } return null; } // // create grid for editing with validation let theGrid = new grid.FlexGrid('#theGrid', { itemsSource: view }); // // use getError to provide form validation let theItem = {}; // document.getElementById('theForm').addEventListener('input', e => { let input =; let propName =; // theItem[propName] = input.value; input.setCustomValidity(view.getError(theItem, propName)); }); // document.getElementById('theForm').addEventListener('submit', e => e.preventDefault()); }
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>MESCIUS Wijmo CollectionView Validation</title> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <!-- SystemJS --> <script src="" integrity="sha512-skZbMyvYdNoZfLmiGn5ii6KmklM82rYX2uWctBhzaXPxJgiv4XBwJnFGr5k8s+6tE1pcR1nuTKghozJHyzMcoA==" crossorigin="anonymous"></script> <script src="systemjs.config.js"></script> <script> System.import('./src/app'); </script> </head> <body> <div class="container-fluid"> <h2> FlexGrid Validation </h2> <p> When you use the <b>CollectionView.getError</b> method for validation, the <b>FlexGrid</b> will show errors in data cells and also in the row header cells. </p> <p> By default, the row header cells will show all the errors in the item. To customize that behavior, return the error message you want to show for the row header when <b>getError</b> is called without a specific property (prop == null). </p> <p> Try entering an invalid country or a negative number to see how the grid identifies the error and prevents the invalid entry from being committed: </p> <div id="theGrid"> </div> <h2> Forms Validation </h2> <p> You can use the the <b>CollectionView.getError</b> property to validate forms as well. Simply call the function and apply the result to the appropriate input element using the <b>setCustomValidity</b> method that is part of the HTML5 validation API: </p> <form id="theForm" class="form-inline"> <div class="form-group"> <label for="country">Country</label> <input id="country" type="text" class="form-control" required value="US"> </div> <div class="form-group"> <label for="downloads">Downloads</label> <input id="downloads" type="number" class="form-control" required value="123"> </div> <div class="form-group"> <label for="sales">Sales</label> <input id="sales" type="number" class="form-control" required value="123"> </div> <button type="submit" class="btn btn-primary">Submit</button> </form> </div> </body> </html>
// export const countries = ['US', 'Germany', 'UK', 'Japan', 'Italy', 'Greece', 'Spain', 'Portugal', 'Australia']; // export function getData() { // create some random data let data = []; // for (let i = 0; i < countries.length; i++) { data.push({ country: countries[i], downloads: Math.round(Math.random() * 20000), sales: (countries[i] == 'Germany' ? -1 : 1) * Math.random() * 10000, expenses: (countries[i] == 'US' ? -1 : 1) * Math.random() * 5000, active: i % 4 == 0 }); } // return data; }
.form-group { margin-right: 8px; } .form-group > label { margin-right: 3px; } .form-group input:invalid { border-color: red; box-shadow: inset 0 1px 1px rgba(0,0,0,.075), 0 0 8px rgba(255,0,0,.6); }
(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', '@mescius/wijmo': 'npm:@mescius/wijmo/index.js', '@mescius/wijmo.input': 'npm:@mescius/wijmo.input/index.js', '@mescius/wijmo.styles': 'npm:@mescius/wijmo.styles', '@mescius/wijmo.cultures': 'npm:@mescius/wijmo.cultures', '@mescius/wijmo.chart': 'npm:@mescius/wijmo.chart/index.js', '@mescius/': 'npm:@mescius/', '@mescius/wijmo.chart.animation': 'npm:@mescius/wijmo.chart.animation/index.js', '@mescius/wijmo.chart.annotation': 'npm:@mescius/wijmo.chart.annotation/index.js', '@mescius/': 'npm:@mescius/', '@mescius/': 'npm:@mescius/', '@mescius/wijmo.chart.hierarchical': 'npm:@mescius/wijmo.chart.hierarchical/index.js', '@mescius/wijmo.chart.interaction': 'npm:@mescius/wijmo.chart.interaction/index.js', '@mescius/wijmo.chart.radar': 'npm:@mescius/wijmo.chart.radar/index.js', '@mescius/wijmo.chart.render': 'npm:@mescius/wijmo.chart.render/index.js', '@mescius/wijmo.chart.webgl': 'npm:@mescius/wijmo.chart.webgl/index.js', '@mescius/': 'npm:@mescius/', '@mescius/wijmo.gauge': 'npm:@mescius/wijmo.gauge/index.js', '@mescius/wijmo.grid': 'npm:@mescius/wijmo.grid/index.js', '@mescius/wijmo.grid.detail': 'npm:@mescius/wijmo.grid.detail/index.js', '@mescius/wijmo.grid.filter': 'npm:@mescius/wijmo.grid.filter/index.js', '@mescius/': 'npm:@mescius/', '@mescius/wijmo.grid.grouppanel': 'npm:@mescius/wijmo.grid.grouppanel/index.js', '@mescius/wijmo.grid.multirow': 'npm:@mescius/wijmo.grid.multirow/index.js', '@mescius/wijmo.grid.transposed': 'npm:@mescius/wijmo.grid.transposed/index.js', '@mescius/wijmo.grid.transposedmultirow': 'npm:@mescius/wijmo.grid.transposedmultirow/index.js', '@mescius/wijmo.grid.pdf': 'npm:@mescius/wijmo.grid.pdf/index.js', '@mescius/wijmo.grid.sheet': 'npm:@mescius/wijmo.grid.sheet/index.js', '@mescius/wijmo.grid.xlsx': 'npm:@mescius/wijmo.grid.xlsx/index.js', '@mescius/wijmo.grid.selector': 'npm:@mescius/wijmo.grid.selector/index.js', '@mescius/wijmo.grid.cellmaker': 'npm:@mescius/wijmo.grid.cellmaker/index.js', '@mescius/wijmo.nav': 'npm:@mescius/wijmo.nav/index.js', '@mescius/wijmo.odata': 'npm:@mescius/wijmo.odata/index.js', '@mescius/wijmo.olap': 'npm:@mescius/wijmo.olap/index.js', '@mescius/': 'npm:@mescius/', '@mescius/wijmo.pdf': 'npm:@mescius/wijmo.pdf/index.js', '@mescius/': 'npm:@mescius/', '@mescius/wijmo.viewer': 'npm:@mescius/wijmo.viewer/index.js', '@mescius/wijmo.xlsx': 'npm:@mescius/wijmo.xlsx/index.js', '@mescius/wijmo.undo': 'npm:@mescius/wijmo.undo/index.js', '@mescius/wijmo.interop.grid': 'npm:@mescius/wijmo.interop.grid/index.js', '@mescius/wijmo.touch': 'npm:@mescius/wijmo.touch/index.js', '@mescius/': 'npm:@mescius/', '@mescius/wijmo.barcode': 'npm:@mescius/wijmo.barcode/index.js', '@mescius/wijmo.barcode.common': 'npm:@mescius/wijmo.barcode.common/index.js', '@mescius/wijmo.barcode.composite': 'npm:@mescius/wijmo.barcode.composite/index.js', '@mescius/wijmo.barcode.specialized': 'npm:@mescius/wijmo.barcode.specialized/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);