The FlexGrid control allows users to import and export content to/from an Excel (.xlsx) file asynchronously. This sample demonstrates how to do so using the saveAsync/loadAsync methods of the FlexGridXlsxConverter class.
Learn about FlexGrid | FlexGrid API Reference
This example uses React.
import 'bootstrap.css';
import '@mescius/wijmo.styles/wijmo.css';
import ReactDOM from 'react-dom/client';
import React, { useRef, useState } from 'react';
import useEvent from 'react-use-event-hook';
import * as wjcCore from '@mescius/wijmo';
import * as wjcGrid from '@mescius/wijmo.react.grid';
import * as wjGrid from '@mescius/wijmo.grid';
import * as wjcXlsx from '@mescius/wijmo.xlsx';
import * as wjcGridXlsx from '@mescius/wijmo.grid.xlsx';
import './app.css';
import { data } from './data';
function App() {
const [includeColumnHeader, setIncludeColumnHeader] = useState(false);
const [customContent, setCustomContent] = useState(false);
const flexRef = useRef(null);
const initializeFlexSheet = useEvent((flex) => {
flexRef.current = flex;
let groupNames = ['Product', 'Country', 'Amount'], cv = flex.collectionView;
// start update
cv.beginUpdate();
// clear existing groups
cv.groupDescriptions.clear();
// add new groups
for (let i = 0; i < groupNames.length; i++) {
let propName = groupNames[i].toLowerCase();
if (propName == 'amount') {
// group amounts in ranges
// (could use the mapping function to group countries into continents,
// names into initials, etc)
let groupDesc = new wjcCore.PropertyGroupDescription(propName, (item, prop) => {
let value = item[prop];
if (value > 1000)
return 'Large Amounts';
if (value > 100)
return 'Medium Amounts';
if (value > 0)
return 'Small Amounts';
return 'Negative';
});
cv.groupDescriptions.push(groupDesc);
}
else if (propName) {
// group other properties by their specific values
let groupDesc = new wjcCore.PropertyGroupDescription(propName);
cv.groupDescriptions.push(groupDesc);
}
}
// done updating
cv.endUpdate();
});
const save = () => {
wjcGridXlsx.FlexGridXlsxConverter.saveAsync(flexRef.current, {
includeColumnHeaders: includeColumnHeader,
includeStyles: false,
formatItem: customContent ? exportFormatItem : undefined
}, 'FlexGrid.xlsx');
};
const load = () => {
let fileInput = document.getElementById('importFile');
if (fileInput.files[0]) {
setCustomContent(false);
wjcGridXlsx.FlexGridXlsxConverter.loadAsync(flexRef.current, fileInput.files[0], { includeColumnHeaders: includeColumnHeader });
}
};
const customContentChanged = (event) => {
setCustomContent(event.target.checked);
wjcCore.Control.invalidateAll();
};
const formatItem = useEvent((s, e) => {
let panel = e.panel, grid = panel.grid, r = e.row, c = e.col, cell = e.cell;
if (panel.cellType === wjGrid.CellType.Cell) {
let binding = grid.columns[c].binding, row = grid.rows[r];
if (row instanceof wjGrid.GroupRow) {
if (row.level <= 2) {
if (binding === 'active') {
cell.innerHTML = customContent
? 'Amount/Pending: ' + Math.round(grid.getCellData(r, 'amount', false) / grid.getCellData(r, 'amount2', false) * 100) / 100
: '';
}
}
}
else {
if (binding === 'color') {
cell.style.color = customContent ? grid.getCellData(r, c, true) : '';
}
}
}
});
const exportFormatItem = (args) => {
var p = args.panel, row = args.row, col = args.col, xlsxCell = args.xlsxCell;
if (p.cellType === wjGrid.CellType.Cell) {
if (p.columns[col].binding === 'color') {
if (xlsxCell.value) {
if (!xlsxCell.style.font) {
xlsxCell.style.font = {};
}
xlsxCell.style.font.color = xlsxCell.value.toLowerCase();
}
}
else if (p.columns[col].binding === 'active' && p.rows[row] instanceof wjGrid.GroupRow) {
let cell = args.getFormattedCell();
xlsxCell.value = cell.textContent.trim();
xlsxCell.style.hAlign = wjcXlsx.HAlign.Left;
}
}
};
return (<div className="container-fluid">
<div className="row">
{/* the grid */}
<wjcGrid.FlexGrid itemsSource={data} initialized={initializeFlexSheet} formatItem={formatItem}>
<wjcGrid.FlexGridColumn header="ID" binding="id"/>
<wjcGrid.FlexGridColumn header="Start Date" binding="start" format="d"/>
<wjcGrid.FlexGridColumn header="End Date" binding="end" format="d"/>
<wjcGrid.FlexGridColumn header="Country" binding="country"/>
<wjcGrid.FlexGridColumn header="Product" binding="product"/>
<wjcGrid.FlexGridColumn header="Color" binding="color"/>
<wjcGrid.FlexGridColumn header="Amount" binding="amount" format="c" aggregate="Sum"/>
<wjcGrid.FlexGridColumn header="Pending" binding="amount2" format="c2" aggregate="Sum"/>
<wjcGrid.FlexGridColumn header="Discount" binding="discount" format="p1" aggregate="Avg"/>
<wjcGrid.FlexGridColumn header="Active" binding="active" width={185}/>
</wjcGrid.FlexGrid>
</div>
<div className="row">
<div className="col-md-6 col-xs-12">
<div className="form-inline well well-lg">
<input type="file" className="form-control" style={{ width: '250px' }} id="importFile" accept="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.ms-excel.sheet.macroEnabled.12"/>
<button onClick={load} className="btn btn-default">Import</button>
<div className="checkbox">
<label>
<input type="checkbox" checked={includeColumnHeader} onChange={(event) => setIncludeColumnHeader(event.target.checked)}/>
Include Column Header
</label>
</div>
</div>
</div>
<div className="col-md-6 col-xs-12">
<div className="form-inline well well-lg">
<button onClick={save} className="btn btn-default">Export</button>
<div className="checkbox">
<label>
<input type="checkbox" checked={includeColumnHeader} onChange={(event) => setIncludeColumnHeader(event.target.checked)}/>
Include Column Header
</label>
</div>
<div className="checkbox">
<label>
<input type="checkbox" checked={customContent} onChange={customContentChanged}/>
Custom Cell Content
</label>
</div>
</div>
</div>
</div>
</div>);
}
const container = document.getElementById('app');
if (container) {
const root = ReactDOM.createRoot(container);
root.render(<App />);
}
Submit and view feedback for