Demos
Grid(Vue)
Columns
Dynamic Columns

Dynamic Columns (Vue)

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

This example uses Vue.

JavaScript
Angular
Vue
React
app.vue
index.html
data.js
Copy to CodeMine
<template>
	<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">
						<wj-list-box :itemsSource="columnsAvailable"></wj-list-box>
					</div>

					<div class="col-md-2">
						<button type="button" class="btn btn-default btn-lg btn-block"
							:disabled="columnsAvailable.currentItem == null" @click="addColumn" title="Add Column">
							<span class="wj-glyph-right"></span>
						</button>
						<button type="button" class="btn btn-default btn-lg btn-block"
							:disabled="columns.currentItem == null" @click="removeColumn" title="Remove Column">
							<span class="wj-glyph-left"></span>
						</button>
						<button type="button" class="btn btn-default btn-lg btn-block"
							:disabled="columns.currentPosition <= 0" @click="moveColumn(-1)" title="Move Column Up">
							<span class="wj-glyph-up"></span>
						</button>
						<button type="button" class="btn btn-default btn-lg btn-block"
							:disabled="columns.currentPosition >= columns.items.length - 1" @click="moveColumn(1)"
							title="Move Column Down">
							<span class="wj-glyph-down"></span>
						</button>
					</div>

					<div class="col-md-5">
						<wj-list-box :itemsSource="columns"></wj-list-box>
					</div>
				</div>
			</div>

			<div class="col-sm-8 col-md-8">
				<h3>See the result here</h3>
				<ul>
					<li v-for="col in columns.items" :key="col">{{ columnHeaderCase(col) }}</li>
				</ul>
				<wj-flex-grid class="wide" :items-source="data" :draggedColumn="draggedColumn">
					<wj-flex-grid-column v-for="(col, index) in columns.items" :key="getColKey(col, index)" :binding="col"
						:header="columnHeaderCase(col)"></wj-flex-grid-column>
				</wj-flex-grid>
			</div>
		</div>
	</div>
</template>

<script setup>
import { CollectionView, toHeaderCase, ObservableArray } from "@mescius/wijmo";
import { getData } from "./data";
import { ref, onMounted } from "vue";

let _data = getData(50);
const fields = Object.keys(_data[0]);

const data = ref(new CollectionView(_data));
const columnsAvailable = ref(new CollectionView(fields));
const columns = ref(new CollectionView([]));

onMounted(function () {
    // Add default columns
    for (let i = 0; i < 3; i++) {
        columnsAvailable.value.moveCurrentToFirst();
        addColumn();
    }
});
function getColKey(col, index) {
	return col + '-' + index;
}
function addColumn() {
    let item = columnsAvailable.value.currentItem,
        index = columns.value.currentPosition;
    if (item) {
        columnsAvailable.value.remove(item);
        columns.value.sourceCollection.splice(Math.max(0, index), 0, item);
        columns.value.refresh();
        columns.value.moveCurrentTo(item);
    }
}

function removeColumn() {
    var item = columns.value.currentItem,
        index = columnsAvailable.value.currentPosition;
    if (item) {
        columns.value.remove(item);
        columnsAvailable.value.sourceCollection.splice(Math.max(0, index), 0, item);
        columnsAvailable.value.refresh();
        columnsAvailable.value.moveCurrentTo(item);
    }
}

function moveColumn(offset) {
    var item = columns.value.currentItem;
    if (item) {
        var arr = columns.value.sourceCollection,
            index = arr.indexOf(item),
            newIndex = index + offset;
        if (index > -1 && newIndex > -1) {
            arr.splice(index, 1);
            arr.splice(newIndex, 0, item);
            columns.value.refresh();
            columns.value.moveCurrentTo(item);
        }
    }
}

function columnHeaderCase(col) {
    return toHeaderCase(col);
}

function draggedColumn(s) {
    var _columns = new ObservableArray();
    for (var i = 0; i < s.columns.length; i++) {
        _columns.push(s.columns[i].binding);
    }
    columns.value.sourceCollection = _columns;
}
</script>

<style>
.wide {
	width: 100%;
}

.wj-flexgrid {
	width: 100%;
	height: 400px;
}

.wj-listbox {
	width: 100%;
	height: 225px;
}

.btn-block{
    min-width: 50px;
}
</style>
<template> <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"> <wj-list-box :itemsSource="columnsAvailable"></wj-list-box> </div> <div class="col-md-2"> <button type="button" class="btn btn-default btn-lg btn-block" :disabled="columnsAvailable.currentItem == null" @click="addColumn" title="Add Column"> <span class="wj-glyph-right"></span> </button> <button type="button" class="btn btn-default btn-lg btn-block" :disabled="columns.currentItem == null" @click="removeColumn" title="Remove Column"> <span class="wj-glyph-left"></span> </button> <button type="button" class="btn btn-default btn-lg btn-block" :disabled="columns.currentPosition <= 0" @click="moveColumn(-1)" title="Move Column Up"> <span class="wj-glyph-up"></span> </button> <button type="button" class="btn btn-default btn-lg btn-block" :disabled="columns.currentPosition >= columns.items.length - 1" @click="moveColumn(1)" title="Move Column Down"> <span class="wj-glyph-down"></span> </button> </div> <div class="col-md-5"> <wj-list-box :itemsSource="columns"></wj-list-box> </div> </div> </div> <div class="col-sm-8 col-md-8"> <h3>See the result here</h3> <ul> <li v-for="col in columns.items" :key="col">{{ columnHeaderCase(col) }}</li> </ul> <wj-flex-grid class="wide" :items-source="data" :draggedColumn="draggedColumn"> <wj-flex-grid-column v-for="(col, index) in columns.items" :key="getColKey(col, index)" :binding="col" :header="columnHeaderCase(col)"></wj-flex-grid-column> </wj-flex-grid> </div> </div> </div> </template> <script setup> import { CollectionView, toHeaderCase, ObservableArray } from "@mescius/wijmo"; import { getData } from "./data"; import { ref, onMounted } from "vue"; let _data = getData(50); const fields = Object.keys(_data[0]); const data = ref(new CollectionView(_data)); const columnsAvailable = ref(new CollectionView(fields)); const columns = ref(new CollectionView([])); onMounted(function () { // Add default columns for (let i = 0; i < 3; i++) { columnsAvailable.value.moveCurrentToFirst(); addColumn(); } }); function getColKey(col, index) { return col + '-' + index; } function addColumn() { let item = columnsAvailable.value.currentItem, index = columns.value.currentPosition; if (item) { columnsAvailable.value.remove(item); columns.value.sourceCollection.splice(Math.max(0, index), 0, item); columns.value.refresh(); columns.value.moveCurrentTo(item); } } function removeColumn() { var item = columns.value.currentItem, index = columnsAvailable.value.currentPosition; if (item) { columns.value.remove(item); columnsAvailable.value.sourceCollection.splice(Math.max(0, index), 0, item); columnsAvailable.value.refresh(); columnsAvailable.value.moveCurrentTo(item); } } function moveColumn(offset) { var item = columns.value.currentItem; if (item) { var arr = columns.value.sourceCollection, index = arr.indexOf(item), newIndex = index + offset; if (index > -1 && newIndex > -1) { arr.splice(index, 1); arr.splice(newIndex, 0, item); columns.value.refresh(); columns.value.moveCurrentTo(item); } } } function columnHeaderCase(col) { return toHeaderCase(col); } function draggedColumn(s) { var _columns = new ObservableArray(); for (var i = 0; i < s.columns.length; i++) { _columns.push(s.columns[i].binding); } columns.value.sourceCollection = _columns; } </script> <style> .wide { width: 100%; } .wj-flexgrid { width: 100%; height: 400px; } .wj-listbox { width: 100%; height: 225px; } .btn-block{ min-width: 50px; } </style>
<!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="compiler.js" type="module"></script> <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.js'); </script> </head> <body> <div id="app"> </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; }
(function (global) { System.config({ transpiler: 'plugin-babel', babelOptions: { es2015: true }, meta: { '*.css': { loader: 'css' }, '*.vue': { loader: '../plugin-vue/index.js' } //'*.vue': { loader: 'systemjs-plugin-vue' } }, paths: { // paths serve as alias 'npm:': 'node_modules/' }, // map tells the System loader where to look for things map: { '@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', "@mescius/wijmo.vue2.chart.analytics": "npm:@mescius/wijmo.vue2.chart.analytics/index.js", "@mescius/wijmo.vue2.chart.animation": "npm:@mescius/wijmo.vue2.chart.animation/index.js", "@mescius/wijmo.vue2.chart.annotation": "npm:@mescius/wijmo.vue2.chart.annotation/index.js", "@mescius/wijmo.vue2.chart.finance.analytics": "npm:@mescius/wijmo.vue2.chart.finance.analytics/index.js", "@mescius/wijmo.vue2.chart.finance": "npm:@mescius/wijmo.vue2.chart.finance/index.js", "@mescius/wijmo.vue2.chart.hierarchical": "npm:@mescius/wijmo.vue2.chart.hierarchical/index.js", "@mescius/wijmo.vue2.chart.interaction": "npm:@mescius/wijmo.vue2.chart.interaction/index.js", "@mescius/wijmo.vue2.chart.radar": "npm:@mescius/wijmo.vue2.chart.radar/index.js", '@mescius/wijmo.vue2.chart.map': 'npm:@mescius/wijmo.vue2.chart.map/index.js', "@mescius/wijmo.vue2.chart": "npm:@mescius/wijmo.vue2.chart/index.js", "@mescius/wijmo.vue2.core": "npm:@mescius/wijmo.vue2.core/index.js", "@mescius/wijmo.vue2.gauge": "npm:@mescius/wijmo.vue2.gauge/index.js", "@mescius/wijmo.vue2.grid.detail": "npm:@mescius/wijmo.vue2.grid.detail/index.js", "@mescius/wijmo.vue2.grid.filter": "npm:@mescius/wijmo.vue2.grid.filter/index.js", "@mescius/wijmo.vue2.grid.grouppanel": "npm:@mescius/wijmo.vue2.grid.grouppanel/index.js", '@mescius/wijmo.vue2.grid.search': 'npm:@mescius/wijmo.vue2.grid.search/index.js', "@mescius/wijmo.vue2.grid.multirow": "npm:@mescius/wijmo.vue2.grid.multirow/index.js", "@mescius/wijmo.vue2.grid.sheet": "npm:@mescius/wijmo.vue2.grid.sheet/index.js", '@mescius/wijmo.vue2.grid.transposed': 'npm:@mescius/wijmo.vue2.grid.transposed/index.js', '@mescius/wijmo.vue2.grid.transposedmultirow': 'npm:@mescius/wijmo.vue2.grid.transposedmultirow/index.js', "@mescius/wijmo.vue2.grid": "npm:@mescius/wijmo.vue2.grid/index.js", "@mescius/wijmo.vue2.input": "npm:@mescius/wijmo.vue2.input/index.js", "@mescius/wijmo.vue2.olap": "npm:@mescius/wijmo.vue2.olap/index.js", "@mescius/wijmo.vue2.viewer": "npm:@mescius/wijmo.vue2.viewer/index.js", "@mescius/wijmo.vue2.nav": "npm:@mescius/wijmo.vue2.nav/index.js", "@mescius/wijmo.vue2.base": "npm:@mescius/wijmo.vue2.base/index.js", '@mescius/wijmo.vue2.barcode.common': 'npm:@mescius/wijmo.vue2.barcode.common/index.js', '@mescius/wijmo.vue2.barcode.composite': 'npm:@mescius/wijmo.vue2.barcode.composite/index.js', '@mescius/wijmo.vue2.barcode.specialized': 'npm:@mescius/wijmo.vue2.barcode.specialized/index.js', 'bootstrap.css': 'npm:bootstrap/dist/css/bootstrap.min.css', 'jszip': 'npm:jszip/dist/jszip.js', 'css': 'npm:systemjs-plugin-css/css.js', 'vue': 'npm:vue/dist/vue.cjs.js', '@vue/compiler-dom':'npm:@vue/compiler-dom/dist/compiler-dom.global.prod.js', '@vue/runtime-dom':'npm:@vue/runtime-dom/dist/runtime-dom.global.prod.js', '@vue/shared':'npm:@vue/shared/dist/shared.cjs.js', '@vue/compiler-dom':'npm:@vue/compiler-dom/dist/compiler-dom.global.prod.js', '@vue/runtime-dom':'npm:@vue/runtime-dom/dist/runtime-dom.global.prod.js', '@vue/shared':'npm:@vue/shared/dist/shared.cjs.js', '@vue/compiler-dom':'npm:@vue/compiler-dom/dist/compiler-dom.global.prod.js', '@vue/runtime-dom':'npm:@vue/runtime-dom/dist/runtime-dom.global.prod.js', '@vue/shared':'npm:@vue/shared/dist/shared.cjs.js', '@vue/compiler-dom':'npm:@vue/compiler-dom/dist/compiler-dom.global.prod.js', '@vue/runtime-dom':'npm:@vue/runtime-dom/dist/runtime-dom.global.prod.js', '@vue/shared':'npm:@vue/shared/dist/shared.cjs.js', '@vue/compiler-dom':'npm:@vue/compiler-dom/dist/compiler-dom.global.prod.js', '@vue/runtime-dom':'npm:@vue/runtime-dom/dist/runtime-dom.global.prod.js', '@vue/shared':'npm:@vue/shared/dist/shared.cjs.js', '@vue/compiler-dom':'npm:@vue/compiler-dom/dist/compiler-dom.global.prod.js', '@vue/runtime-dom':'npm:@vue/runtime-dom/dist/runtime-dom.global.prod.js', '@vue/shared':'npm:@vue/shared/dist/shared.cjs.js', '@vue/compiler-dom':'npm:@vue/compiler-dom/dist/compiler-dom.global.prod.js', '@vue/runtime-dom':'npm:@vue/runtime-dom/dist/runtime-dom.global.prod.js', '@vue/shared':'npm:@vue/shared/dist/shared.cjs.js', '@vue/compiler-dom':'npm:@vue/compiler-dom/dist/compiler-dom.global.prod.js', '@vue/runtime-dom':'npm:@vue/runtime-dom/dist/runtime-dom.global.prod.js', '@vue/shared':'npm:@vue/shared/dist/shared.cjs.js', 'vue-loader': 'npm:systemjs-vue-browser/index.js', //'systemjs-plugin-vue': 'npm:systemjs-plugin-vue/index.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' }, rxjs: { defaultExtension: 'js' }, "node_modules": { defaultExtension: 'js' }, wijmo: { defaultExtension: 'js', } } }); })(this);