Popup Column Picker (Vue)

You can easily implement a column-picker UI using the grid's columns property, a ListBox control, and Wijmo's showPopup and hidePopup methods. For example, the grid below starts with an auto-generated set of columns. Click the gear icon at the top-left cell to show a ListBox where you can select the columns you want to display.

This example uses Vue.

<template> <div class="container-fluid"> <wj-flex-grid :itemsSource="data" :initialized="initializedGrid"></wj-flex-grid> <div style="display:none"> <wj-list-box class="column-picker" :initialized="initializedPicker"></wj-list-box> </div> <div class="checkbox"> <label> <input v-on:click="enableDrag" type="checkbox"> Enable drag-and-drop </label> </div> <p> You can use the grid's <b>columnLayout</b> property to allow users to save and restore column layouts. Click the buttons below to see how this works: </p> <button v-on:click="saveLayout" class="btn btn-default">Save Layout</button> <button v-on:click="loadLayout" class="btn btn-default">Restore Layout</button> </div> </template> <script> import "@grapecity/wijmo.styles/wijmo.css"; import "bootstrap.css"; import Vue from "vue"; import "@grapecity/wijmo.vue2.grid"; import "@grapecity/wijmo.vue2.input"; import { showPopup, hidePopup, hasClass, contains, closest, createElement, getElement, removeChild } from "@grapecity/wijmo"; import { getData } from "./data"; new Vue({ el: "#app", data: function() { return { data: getData(), isDragEnabled: false, dragSrc: null, dragDst: null }; }, methods: { saveLayout() { localStorage.setItem("myLayout", this.flex.columnLayout); }, loadLayout() { let layout = localStorage.getItem("myLayout"); if (layout) { this.flex.columnLayout = layout; } }, initializedPicker(picker) { this.columnPicker = picker; }, initializedGrid(ctl) { this.flex = ctl; this.flex.formatItem.addHandler((s, e) => { if (e.panel == s.topLeftCells) { e.cell.innerHTML = '<span class="column-picker-icon glyphicon glyphicon-cog"></span>'; } }); // show the column picker when the user clicks the top-left cell let ref = this.flex.hostElement.querySelector(".wj-topleft"); ref.addEventListener("mousedown", e => { if (hasClass(e.target, "column-picker-icon")) { let host = this.columnPicker.hostElement; if (!host.offsetHeight) { showPopup(host, ref, false, true, false); this.columnPicker.focus(); } else { hidePopup(host, true, true); this.flex.focus(); } e.preventDefault(); } }); // work around Safari/IOS bug (TFS 321525, 361500, 402670) // https://developer.mozilla.org/en-US/docs/Web/Events/click#Safari_Mobile window.addEventListener('touchstart', (e) => { let host = this.columnPicker.hostElement; if (!contains(host, e.target) && !closest(e.target, '.wj-flexgrid')) { hidePopup(host, true, true); } }); }, handleDragStart(e) { this.dragSrc = closest(e.target, '.wj-listbox-item'); if (this.dragSrc) { e.dataTransfer.setData('text', this.dragSrc.innerHTML); e.dataTransfer.effectAllowed = 'move'; } }, handleDragOver(e) { const dragOver = closest(e.target, '.wj-listbox-item'); if (this.dragDst && this.dragDst !== dragOver) { this._removeDropMarker(); } if (dragOver && dragOver !== this.dragSrc) { e.preventDefault(); e.dataTransfer.dropEffect = 'move'; this.dragDst = dragOver; const src = this._getElementIndex(this.dragSrc); const dst = this._getElementIndex(this.dragDst); this._removeDropMarker(); this._addDropMarker(dst > src); } else { this.dragDst = null; } }, handleDrop(e) { if (this.dragSrc && this.dragDst) { e.preventDefault(); const src = this._getElementIndex(this.dragSrc); const dst = this._getElementIndex(this.dragDst); this.flex.columns.moveElement(src, dst); } }, handleDragEnd(e) { this.dragSrc = null; this.dragDst = null; this._removeDropMarker(); }, enableDrag(e) { const element = e.target; this.isDragEnabled = element.checked; const host = this.columnPicker.hostElement; const items = host.getElementsByClassName('wj-listbox-item'); for (let i = 0; i < items.length; i++) { this._enableDragItem(items[i], this.isDragEnabled); } }, _enableDragItem(item, enabled) { item.setAttribute('draggable', enabled.toString()); }, _getElementIndex(element) { const parent = element.parentElement; const siblings = Array.prototype.slice.call(parent.children); return siblings.indexOf(element); }, _removeDropMarker() { removeChild(getElement('.drop-marker')); }, _addDropMarker(isAfterPos) { const itemsGap = 10; const width = 6; const margin = itemsGap/width; const height = this.dragDst.clientHeight; const topPos = this.dragDst.offsetTop; const leftPos = isAfterPos ? (this.dragDst.offsetLeft + this.dragDst.clientWidth + margin) : (this.dragDst.offsetLeft - itemsGap + margin); const css = `top:${topPos}px;left:${leftPos}px;height:${height}px;width:${width}px`; const html = `<div class="drop-marker" style="${css}">&nbsp</div>`; createElement(html, this.columnPicker.hostElement); } }, mounted: function() { if (this.flex) { this.columnPicker.itemsSource = this.flex.columns; this.columnPicker.checkedMemberPath = 'visible'; this.columnPicker.displayMemberPath = 'header'; this.columnPicker.lostFocus.addHandler(() => { hidePopup(this.columnPicker.hostElement); }); this.columnPicker.formatItem.addHandler((s, e) => { this._enableDragItem(e.item, this.isDragEnabled); }); const host = this.columnPicker.hostElement; host.addEventListener('dragstart', this.handleDragStart); host.addEventListener('dragover', this.handleDragOver); host.addEventListener('drop', this.handleDrop); host.addEventListener('dragend', this.handleDragEnd); } } }); </script> <style> .wj-flexgrid { max-height: 300px; margin: 10px 0; } .column-picker-icon { cursor: pointer; color: #FF8754; margin: 3px; } .wj-listbox.column-picker { display: grid; grid-template-columns: repeat(4, 1fr); grid-gap: 0 10px; columns: 4; /* IE fallback */ padding: 12px; margin-left: 12px; margin-top: 26px; box-shadow: 0 10px 20px rgba(0,0,0,0.19), 0 6px 6px rgba(0,0,0,0.23); } body .wj-listbox .wj-listbox-item > label { display: block; margin: 0 0 3px 0; } .wj-listbox .wj-listbox-item.wj-state-selected { background: transparent; color: inherit; } .wj-listbox .wj-listbox-item:hover { background: rgba(0,0,0,.05); } .wj-listbox .drop-marker { position: absolute; background: #0085c7; opacity: 0.5; pointer-events: none; z-index: 1000; } </style>
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>GrapeCity Wijmo FlexGrid Column Picker</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.vue'); </script> </head> <body> <div id="app"> </div> </body> </html>
export function getData() { let data = [], countries = ['US', 'Germany', 'UK', 'Japan', 'Italy', 'Greece'], products = ['Widget', 'Sprocket', 'Gadget', 'Doohickey'], colors = ['Black', 'White', 'Red', 'Green', 'Blue'], dt = new Date(); for (let i = 0; i < 100; i++) { let date = new Date(dt.getFullYear(), i % 12, 25, i % 24, i % 60, i % 60), countryId = Math.floor(Math.random() * countries.length), productId = Math.floor(Math.random() * products.length), colorId = Math.floor(Math.random() * colors.length); let item = { id: i, start: date, end: date, country: countries[countryId], product: products[productId], color: colors[colorId], countryId: countryId, productId: productId, colorId: colorId, amount1: Math.random() * 10000 - 5000, amount2: Math.random() * 10000 - 5000, amount3: Math.random() * 10000 - 5000, amount4: Math.random() * 10000 - 5000, amount5: Math.random() * 10000 - 5000, discount: Math.random() / 4, active: i % 4 == 0 }; data.push(item); } return data; }
(function (global) { System.config({ transpiler: 'plugin-babel', babelOptions: { es2015: true }, meta: { '*.css': { loader: 'css' }, '*.vue': { loader: 'vue-loader' } //'*.vue': { loader: 'systemjs-plugin-vue' } }, paths: { // paths serve as alias 'npm:': 'node_modules/' }, // map tells the System loader where to look for things map: { '@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.chart.webgl': 'npm:@grapecity/wijmo.chart.webgl/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', '@grapecity/wijmo.touch': 'npm:@grapecity/wijmo.touch/index.js', '@grapecity/wijmo.cloud': 'npm:@grapecity/wijmo.cloud/index.js', "@grapecity/wijmo.vue2.chart.analytics": "npm:@grapecity/wijmo.vue2.chart.analytics/index.js", "@grapecity/wijmo.vue2.chart.animation": "npm:@grapecity/wijmo.vue2.chart.animation/index.js", "@grapecity/wijmo.vue2.chart.annotation": "npm:@grapecity/wijmo.vue2.chart.annotation/index.js", "@grapecity/wijmo.vue2.chart.finance.analytics": "npm:@grapecity/wijmo.vue2.chart.finance.analytics/index.js", "@grapecity/wijmo.vue2.chart.finance": "npm:@grapecity/wijmo.vue2.chart.finance/index.js", "@grapecity/wijmo.vue2.chart.hierarchical": "npm:@grapecity/wijmo.vue2.chart.hierarchical/index.js", "@grapecity/wijmo.vue2.chart.interaction": "npm:@grapecity/wijmo.vue2.chart.interaction/index.js", "@grapecity/wijmo.vue2.chart.radar": "npm:@grapecity/wijmo.vue2.chart.radar/index.js", "@grapecity/wijmo.vue2.chart": "npm:@grapecity/wijmo.vue2.chart/index.js", "@grapecity/wijmo.vue2.core": "npm:@grapecity/wijmo.vue2.core/index.js", "@grapecity/wijmo.vue2.gauge": "npm:@grapecity/wijmo.vue2.gauge/index.js", "@grapecity/wijmo.vue2.grid.detail": "npm:@grapecity/wijmo.vue2.grid.detail/index.js", "@grapecity/wijmo.vue2.grid.filter": "npm:@grapecity/wijmo.vue2.grid.filter/index.js", "@grapecity/wijmo.vue2.grid.grouppanel": "npm:@grapecity/wijmo.vue2.grid.grouppanel/index.js", '@grapecity/wijmo.vue2.grid.search': 'npm:@grapecity/wijmo.vue2.grid.search/index.js', "@grapecity/wijmo.vue2.grid.multirow": "npm:@grapecity/wijmo.vue2.grid.multirow/index.js", "@grapecity/wijmo.vue2.grid.sheet": "npm:@grapecity/wijmo.vue2.grid.sheet/index.js", '@grapecity/wijmo.vue2.grid.transposed': 'npm:@grapecity/wijmo.vue2.grid.transposed/index.js', "@grapecity/wijmo.vue2.grid": "npm:@grapecity/wijmo.vue2.grid/index.js", "@grapecity/wijmo.vue2.input": "npm:@grapecity/wijmo.vue2.input/index.js", "@grapecity/wijmo.vue2.olap": "npm:@grapecity/wijmo.vue2.olap/index.js", "@grapecity/wijmo.vue2.viewer": "npm:@grapecity/wijmo.vue2.viewer/index.js", "@grapecity/wijmo.vue2.nav": "npm:@grapecity/wijmo.vue2.nav/index.js", "@grapecity/wijmo.vue2.base": "npm:@grapecity/wijmo.vue2.base/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.min.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);