RestCollectionView RestAPI with Server-Side Grouping

This sample shows how you can extend the RestCollectionView class to create a custom RestGroupCollectionView class that talks to Mescius Demo Service's Grouping and Pagination RestAPI.

The RestGroupCollectionView class supports server-side grouping. It also supports virtualization and group lazy-loading for server based grouping with server based sorting, filtering.

You can check a sample implementation with server and client code Wijmo-Rest-CollectionView-Sample

Learn about FlexGrid | Loading Data Documentation | CollectionView API Reference

import 'bootstrap.css'; import '@mescius/wijmo.styles/wijmo.css'; import './styles.css'; // import { RestGroupCollectionView } from "./rest-group-collection-view"; import { DataType, createElement } from '@mescius/wijmo'; import { FlexGrid } from '@mescius/wijmo.grid'; import { FlexGridFilter } from '@mescius/wijmo.grid.filter'; // field info for PurchaseOrders table const fields = 'OrderId,StockItem,Color,State,City,Quantity,UnitPrice,Date,IsChillerStock'.split(','); document.readyState === 'complete' ? init() : window.onload = init; // function init() { let _firstLoad = true; let cvSettings = { virtualization: false, groupLazyLoading: false, fields: fields, groupDescriptions: ['State', 'City'], loading: () => { toggleSpinner(theGrid, true); }, loaded: (s, e) => { toggleSpinner(theGrid, false); if (_firstLoad) { _firstLoad = false; // select first group row setTimeout(() => { theGrid.select(0, 0); }); } } }; // create the grid to show the data let theGrid = new FlexGrid('#theGrid', { isReadOnly: true, autoGenerateColumns: false, columns: [ { binding: "OrderId", header: "Order ID" }, { binding: "StockItem", header: "Stock Item", width: "*", minWidth: 200 }, { binding: "Color", header: "Color" }, { binding: "Quantity", header: "Quantity", dataType: DataType.Number, format: 'n0' }, { binding: "UnitPrice", header: "Unit Price", dataType: DataType.Number, format: 'n2' }, { binding: "Date", header: "Date", dataType: DataType.Date }, { binding: "IsChillerStock", header: "Is Chiller Stock", dataType: DataType } ], //create RestGroupCollectionView instance //with settings for default server grouping on first load itemsSource: new RestGroupCollectionView('purchaseorders', cvSettings) }); // add the filter with Condition filter as default new FlexGridFilter(theGrid, { defaultFilterType: 'Condition' }); document.getElementById("feature-options").addEventListener('click', (e) => { let element = e.target; // to avoid click for label switch (element && element.id) { case 'groupServer': cvSettings.virtualization = false; cvSettings.groupLazyLoading = false; break; case 'virtual': cvSettings.virtualization = true; cvSettings.groupLazyLoading = false; break; case 'lazyload': cvSettings.virtualization = false; cvSettings.groupLazyLoading = true; break; } if (element.tagName == "INPUT") { _firstLoad = true; //reset _firstLoad before CV change theGrid.itemsSource = new RestGroupCollectionView('purchaseorders', cvSettings); } }); } //show gif loader while data loading function toggleSpinner(grid, show) { let _rect = grid.controlRect; let elem = grid.hostElement.querySelector('.spinner'); if (!elem) elem = createElement(`<div class='spinner' style="left:${_rect.left}px;top:${_rect.top}px;width:${_rect.width}px;height:${_rect.height}px;"><img src="resources/Rounded%20blocks.gif"></div>`, grid.hostElement); elem.style.display = show ? 'block' : 'none'; }
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>MESCIUS Wijmo RestCollectionView RestAPI</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 id="feature-options"> <label for="groupServer"> <input id="groupServer" type="radio" name="feature" value="groupOnServer" checked> Server Side Grouping </label> <br> <label for="virtual"> <input id="virtual" type="radio" name="feature" value="virtualGrouping"> Server Side Grouping with virtualization </label> <br> <label for="lazyload"> <input id="lazyload" type="radio" name="feature" value="lazyLoadGrouping"> Server Side Grouping with group lazy-loading </label> </div> <div id="theGrid"></div> </div> </body> </html>
body { margin-bottom: 36pt; margin-top: 10px; } .wj-flexgrid { height: 400px; } .spinner { position: absolute; z-index: 10; opacity: .5; } .spinner img { margin: auto; position: relative; top: 40%; left: 45%; }
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) { return new (P || (P = Promise))(function (resolve, reject) { function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } } function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } } function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); } step((generator = generator.apply(thisArg, _arguments || [])).next()); }); }; import { DataType, DateTime, httpRequest, copy, changeType, isString, isDate, asNumber, isBoolean, } from '@mescius/wijmo'; import { RestCollectionView } from '@mescius/wijmo.rest'; // limit item count to fetch when virtualization or group lazy-loading is not enabled const _MAXITEMCOUNT = 10000; const _TableRecordCount = 231412; // total number of records available in DB for API. // DataSource API const _apiUrl = "https://demodata.mescius.io/wwi/api/v1/"; /** * Class that extends {@link RestCollectionView} to support RestAPI data sources. */ export class RestGroupCollectionView extends RestCollectionView { /** * Initializes a new instance of the {@link RestGroupCollectionView} class to support ServerSide Grouping. * * @param tableName Name of the table (entity) to retrieve from the service. * @param options JavaScript object containing initialization data (property * values and event handlers) for the {@link RestCollectionView}. */ constructor(tableName, options) { super(options); this._url = _apiUrl; this._pendingRequest = null; this._tbl = tableName; this.groupOnServer = true; copy(this, options); } // parse data _jsonReviver(key, value) { // regex to parse date const _rxDate = /^\d{4}\-\d{2}\-\d{2}T\d{2}\:\d{2}\:\d{2}|\/Date\([\d\-]*?\)/; if (typeof value === 'string' && _rxDate.test(value)) { value = value.indexOf('/Date(') == 0 // verbosejson ? new Date(parseInt(value.substr(6))) : new Date(value); } return value; } // get request parameters to fetch data based on settings _getReadParams(item, groupInfo = true, virtualParams = true) { let gDescs = this.groupDescriptions; let settings = {}; // #region Only required when ServerAPI limits top to 100 or other value // load max _MAXITEMCOUNT items when virtualization is not enabled if (!this.virtualization && this.groupOnServer) { settings.top = _MAXITEMCOUNT; } // all available groups in-case of virtualization if (this.virtualization && groupInfo && this.groupOnServer) { settings.top = _MAXITEMCOUNT; } // load all available records from table for ServerSide GroupOnly case if (this.groupOnServer && !this.virtualization && !this.groupLazyLoading && !groupInfo) { settings.top = _TableRecordCount; } // #endRegion // get filter definition if (this.filterOnServer && this._filterProvider) { let filter = this._asODataFilter(this._filterProvider); if (filter.length > 0) { settings.filterBy = filter; } } // get groupby defintion if (this.groupOnServer && gDescs.length > 0) { // groupby def for groupLazyloading feature if (this.groupLazyLoading) { if (item) { let filters = []; for (let i = 0; i <= (item.isBottomLevel ? gDescs.length - 1 : item.level); i++) { let group = gDescs[i].propertyName; const val = item.items[0][group]; filters.push(`(${group} eq '${val}')`); } if (settings.filterBy && settings.filterBy.length > 0) { filters.splice(0, 0, settings.filterBy); } if (filters.length > 0) { settings.filterBy = filters.join(' and '); } if (!item.isBottomLevel) settings.groupBy = item.groups[0].groupDescription.propertyName; } else settings.groupBy = gDescs[0].propertyName; } // groupby definition for other cases if (!this.groupLazyLoading) { let _groupBy = []; let _sortBy = []; for (let i = 0; i < gDescs.length; i++) { let _prop = gDescs[i].propertyName; _groupBy.push(_prop); _sortBy.push(`${_prop} ASC`); } settings.groupBy = _groupBy; settings.sortBy = _sortBy.join(','); //sort the defined groups } } // donot set groupby if request is not for groupItems if (!groupInfo) { delete settings.groupBy; } //update sortBy definition if (this.sortDescriptions.length > 0) { let _sortBy = []; //check existing sort if (settings.sortBy) { _sortBy = settings.sortBy.split(','); } for (let i = 0; i < this.sortDescriptions.length; i++) { let sort = `${this.sortDescriptions[i].property} ${this.sortDescriptions[i].ascending ? 'ASC' : 'DESC'}`; var _cSrtIdx = _sortBy.findIndex(x => x.indexOf(this.sortDescriptions[i].property) > -1); if (_cSrtIdx > -1) _sortBy[_cSrtIdx] = sort; // update existing sort else _sortBy.push(sort); // add new sort } settings.sortBy = _sortBy.join(','); } //skip and top for fetch data when virtualization is enabled if (virtualParams && this.virtualization) { settings.skip = this._start; settings.top = this._fetchSize(); } // for paginated data if (this.pageOnServer && this.pageSize > 0 && !groupInfo) { settings.skip = this.pageIndex * this.pageSize; settings.top = (this.pageIndex * this.pageSize) + this.pageSize; } // set aggregates property if required (only with groupBy) if (groupInfo && this.aggregates && this.aggregates.length > 0 && this.groupDescriptions.length > 0) { settings.aggregates = this.aggregates; } // get specified fields only if set if (this.fields && this.fields.length > 0 && !groupInfo) { settings.select = this.fields; } return settings; } // ** overrides //fetch data getItems(item) { // cancel any pending requests if (this._pendingReq) { this._pendingReq.abort(); } return new Promise(resolve => { let _settings = this._getReadParams(item, false, true); // get data chunks if virtualization enabled this._pendingReq = httpRequest(this._url + this._tbl, { requestHeaders: this.requestHeaders, data: _settings, success: (xhr) => __awaiter(this, void 0, void 0, function* () { // parse response let resp = JSON.parse(xhr.responseText, this._jsonReviver); let _count = asNumber(resp.totalItemCount); if (_count != this._totalItemCount) this._totalItemCount = _count; resolve(resp.items); }), error: xhr => this._raiseError(xhr.responseText, false), complete: xhr => { this._pendingReq = null; } // no pending requests }); }); } //fetch group items getGroupItems(item) { // cancel any pending requests if (this._pendingRequest) { this._pendingRequest.abort(); } return new Promise(resolve => { let _settings = this._getReadParams(item, true, false); // request parameters for grouping if (this.groupDescriptions.length > 0 && this.groupOnServer) { httpRequest(this._url + this._tbl, { requestHeaders: this.requestHeaders, data: _settings, success: (xhr) => __awaiter(this, void 0, void 0, function* () { // parse response let re = xhr.responseText; let resp = JSON.parse(xhr.responseText, this._jsonReviver); this._totalGroupItemCount = asNumber(resp.totalGroupCount); let _count = asNumber(resp.totalItemCount); if (_count != this._totalItemCount) this._totalItemCount = _count; resolve(resp.groupItems); }), error: xhr => this._raiseError(xhr.responseText, false), complete: xhr => this._pendingRequest = null // no pending requests }); } }); } //#region Filter Implementation // gets the OData like filter definition that accepts by datasource from a wijmo.grid.filter.FlexGridFilter object. _asODataFilter(filter) { let def = ''; for (let c = 0; c < filter.grid.columns.length; c++) { let col = filter.grid.columns[c], cf = filter.getColumnFilter(col, false); if (cf && cf.isActive) { if (def) { def += ' and '; } if (cf.conditionFilter && cf.conditionFilter.isActive) { def += this._asODataConditionFilter(cf.conditionFilter); } else if (cf.valueFilter && cf.valueFilter.isActive) { def += this._asODataValueFilter(cf.valueFilter); } } } return def; } _asODataValueFilter(vf) { let col = vf.column, fld = col.binding, map = col.dataMap, def = ''; // build condition with 'eq/or' for (let key in vf.showValues) { let value = changeType(key, col.dataType, col.format); if (map && isString(value)) { // TFS 239356 value = map.getKeyValue(value); } if (def) def += ' or '; def += this._asEquals(fld, value, col.dataType); } // enclose in parenthesis if not empty if (def.length) { def = '(' + def + ')'; } // all done return def; } _asEquals(fld, value, type) { let def = '', DT = DataType; if (value === '' || value == null) { // null or empty def += fld + ' eq null'; if (type == DT.String) { // empty OK for strings only def += ' or ' + fld + ' eq \'\''; } } else if (type == DT.Date) { // non-null/empty dates (TFS 458080) def += fld + ' ge ' + this._asODataValue(value, type) + ' and ' + fld + ' lt ' + this._asODataValue(DateTime.addDays(value, 1), type); } else { // other types def += fld + ' eq ' + this._asODataValue(value, type); } return '(' + def + ')'; } _asODataConditionFilter(cf) { let c1 = this._asODataCondition(cf, cf.condition1), c2 = this._asODataCondition(cf, cf.condition2); if (c1 && c2) return '(' + c1 + (cf.and ? ' and ' : ' or ') + c2 + ')'; if (c1) return '(' + c1 + ')'; if (c2) return '(' + c2 + ')'; return null; } _asODataCondition(cf, cnd) { let col = cf.column, fld = col.binding, map = col.dataMap, value = cnd.value; if (map && isString(value)) { // TFS 440901 value = map.getKeyValue(value); } value = this._asODataValue(value, cf.column.dataType); switch (cnd.operator) { case 0: // EQ = 0, return fld + ' eq ' + value; case 1: // NE = 1, return fld + ' ne ' + value; case 2: // GT = 2, return fld + ' gt ' + value; case 3: // GE = 3, return fld + ' ge ' + value; case 4: // LT = 4, return fld + ' lt ' + value; case 5: // LE = 5, return fld + ' le ' + value; case 6: // BW = 6, return `${fld} starts-with ${value}`; case 7: // EW = 7, return `${fld} ends-with ${value}`; case 8: // CT = 8, return `${fld} contains ${value}`; case 9: // NC = 9 return `${fld} not-contains ${value}`; case 10: // NBW = 10 return `${fld} not-starts-with ${value}`; case 11: // NEW = 11 return `${fld} not-ends-with ${value}`; } } _asODataValue(value, dataType) { if (isDate(value)) { value = `'${value.toJSON()}'`; return value; } else if (isString(value)) { return "'" + value.replace(/'/g, "''") + "'"; } else if (isBoolean(value)) { return "'" + value + "'"; } else if (value != null) { return value.toString(); } return dataType == DataType.String ? "''" : null; } }
(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.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);