Dynamic Columns

This sample demonstrates how to dynamically create FlexGrid columns based on a collection, ensuring that the FlexGrid stays in sync with the data model.

Key Features:

  • Dynamic Column Creation: An editor allows users to select which columns to display and define their order.

  • Synchronization: The collection used to define the columns dynamically updates the FlexGrid to reflect changes.

  • Two-Way Interaction: Any changes made to the FlexGrid, such as rearranging columns by dragging, are reflected back in the underlying collection.

This approach provides a flexible way to manage column layouts programmatically, ensuring consistency between the FlexGrid's state and the application's data model.

Learn about FlexGrid | ColumnCollection Documentation | FlexGrid API Reference

import 'bootstrap.css'; import '@mescius/wijmo.styles/wijmo.css'; import './styles.css'; import { CollectionView, toHeaderCase, ObservableArray, Control } from '@mescius/wijmo'; import { FlexGrid, Column } from '@mescius/wijmo.grid'; import { ListBox } from '@mescius/wijmo.input'; import { getData } from './data'; const columns = new CollectionView([], { collectionChanged: s => { updateListHTML(s.items); const leftButton = document.getElementById('leftBtn'); if (s.itemCount == 0) { leftButton.disabled = true; } else { leftButton.disabled = false; } //button is not disabled when current position is 0 let dwnButton = document.getElementById('downBtn'); if (s.itemCount > 1 && s.currentPosition < s.itemCount - 1) { dwnButton.disabled = false; } } }); let columnsAvailable = new CollectionView(); document.readyState === 'complete' ? init() : window.onload = init; function init() { const upButton = document.getElementById('upBtn'); const dwnButton = document.getElementById('downBtn'); const leftButton = document.getElementById('leftBtn'); const rightButton = document.getElementById('rightBtn'); const data = getData(50); const fields = Object.keys(data[0]); columnsAvailable = new CollectionView(fields, { collectionChanged: (s) => { if (s.itemCount == 0) { rightButton.disabled = true; } else { rightButton.disabled = false; } } }); //init columns add for (var i = 0; i < 3; i++) { columnsAvailable.moveCurrentToFirst(); addColumn(); } var theGrid = new FlexGrid('#theGrid', { deferResizing: true, autoGenerateColumns: false, columns: columns.items.map((col) => { return { binding: col, header: toHeaderCase(col) }; }), draggedColumn: (s) => { var _columns = new ObservableArray(); for (var i = 0; i < s.columns.length; i++) { _columns.push(s.columns[i].binding); } columns.sourceCollection = _columns; columns.refresh(); }, itemsSource: data, }); //available columns list new ListBox('#addList', { itemsSource: columnsAvailable }); //columns list new ListBox('#columnList', { selectedIndexChanged: s => { if (s.selectedIndex <= 0) { upButton.disabled = true; } else { upButton.disabled = false; } if (s.selectedIndex >= columns.itemCount - 1) { dwnButton.disabled = true; } else { dwnButton.disabled = false; } }, itemsSource: columns }); rightButton.addEventListener('click', () => { addColumn(); }); leftButton.addEventListener('click', () => { removeColumn(); }); upButton.addEventListener('click', (e) => { moveColumn(-1); }); dwnButton.addEventListener('click', (e) => { moveColumn(1); }); } function updateListHTML(items) { let html = ''; items.forEach((item) => { html += `<li>${toHeaderCase(item)}</li>`; }); document.querySelector('#selectedColumns').innerHTML = html; let grid = Control.getControl('#theGrid'); if (grid) { grid.columns.clear(); columns.items.forEach((col) => { grid.columns.push(new Column({ binding: col, header: toHeaderCase(col) })); }); } } // move item from columnsAvailable to columns function addColumn() { var item = columnsAvailable.currentItem, index = columns.currentPosition; if (item) { columnsAvailable.remove(item); columns.sourceCollection.splice(Math.max(0, index), 0, item); columns.moveCurrentTo(item); columns.refresh(); } } // move item from columns to columnsAvailable function removeColumn() { var item = columns.currentItem, index = columnsAvailable.currentPosition; if (item) { columnsAvailable.sourceCollection.splice(Math.max(0, index), 0, item); columnsAvailable.refresh(); columnsAvailable.moveCurrentTo(item); columns.remove(item); } } // move a column within the columns collection function moveColumn(offset) { var item = columns.currentItem; if (item) { var arr = columns.sourceCollection, index = arr.indexOf(item), newIndex = index + offset; if (index > -1 && newIndex > -1) { arr.splice(index, 1); arr.splice(newIndex, 0, item); columns.moveCurrentTo(item); columns.refresh(); } } }
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>MESCIUS Wijmo FlexGrid Dynamic Columns</title> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <!-- SystemJS --> <script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.21.5/system.src.js" 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"> <div class="row"> <div class="col-sm-4 col-md-4"> <h3>Edit the ColumnCollection</h3> <div class="row"> <div class="col-md-5"> <div id="addList"></div> </div> <div class="col-md-2"> <button id="rightBtn" class="btn btn-default btn-lg btn-block"><span class="wj-glyph-right"></span></button> <button id="leftBtn" class="btn btn-default btn-lg btn-block"><span class="wj-glyph-left"></span></button> <button id="upBtn" class="btn btn-default btn-lg btn-block"><span class="wj-glyph-up"></span></button> <button id="downBtn" class="btn btn-default btn-lg btn-block"><span class="wj-glyph-down"></span></button> </div> <div class="col-md-5"> <div id="columnList"></div> </div> </div> </div> <div class="col-sm-8 col-md-8"> <h3>See the result here:</h3> <ul id="selectedColumns"></ul> <div id="theGrid"></div> </div> </div> </div> </body> </html>
export const getData = (count) => { let data = [], countries = ['US', 'Germany', 'UK', 'Japan', 'Italy', 'Greece', 'Spain', 'Canada', 'Australia', 'China', 'Austria'], products = ['Widget', 'Gadget', 'Doohickey'], colors = ['Black', 'White', 'Red', 'Green', 'Blue'], dt = new Date(); for (let i = 0; i < count; i++) { data.push({ id: i, date: new Date(dt.getFullYear(), i % 12, 25, i % 24, i % 60, i % 60), country: countries[Math.floor(Math.random() * countries.length)], product: products[Math.floor(Math.random() * products.length)], color: colors[Math.floor(Math.random() * colors.length)], amount: Math.random() * 10000 - 5000, discount: Math.random() / 4, active: i % 4 == 0, }); } return data; };
.wj-flexgrid { width: 100%; height: 400px; } .wj-listbox { width: 100%; height: 225px; } .btn-block{ min-width: 50px; }
(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/wijmo.chart.analytics': 'npm:@mescius/wijmo.chart.analytics/index.js', '@mescius/wijmo.chart.animation': 'npm:@mescius/wijmo.chart.animation/index.js', '@mescius/wijmo.chart.annotation': 'npm:@mescius/wijmo.chart.annotation/index.js', '@mescius/wijmo.chart.finance': 'npm:@mescius/wijmo.chart.finance/index.js', '@mescius/wijmo.chart.finance.analytics': 'npm:@mescius/wijmo.chart.finance.analytics/index.js', '@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/wijmo.chart.map': 'npm:@mescius/wijmo.chart.map/index.js', '@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/wijmo.grid.search': 'npm:@mescius/wijmo.grid.search/index.js', '@mescius/wijmo.grid.style': 'npm:@mescius/wijmo.grid.style/index.js', '@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/wijmo.rest': 'npm:@mescius/wijmo.rest/index.js', '@mescius/wijmo.pdf': 'npm:@mescius/wijmo.pdf/index.js', '@mescius/wijmo.pdf.security': 'npm:@mescius/wijmo.pdf.security/index.js', '@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/wijmo.cloud': 'npm:@mescius/wijmo.cloud/index.js', '@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);