Use the bindingPath method to bind the table to a field with records, and then bind the table columns to the record's fields. For example:
When you set a different data source, the table will automatically bind to the corresponding records.
We also provide the bind API to easily solve complicated call issues:
When you bind data source, you can get dirty data-item after change the data source:
import * as React from 'react';
import * as ReactDOM from 'react-dom';
import './styles.css';
import { AppFunc } from './app-func';
// import { App } from './app-class';
// 1. Functional Component sample
ReactDOM.render(<AppFunc />, document.getElementById('app'));
// 2. Class Component sample
// ReactDOM.render(<App />, document.getElementById('app'));
import * as React from 'react';
import GC from '@mescius/spread-sheets';
import { SpreadSheets } from '@mescius/spread-sheets-react';
export function AppFunc() {
let spread = null;
let dataSource1 = null;
let dataSource2 = null;
const changeDataSource = () => {
let sheet = spread.getActiveSheet();
if (sheet.getDataSource() === dataSource1) {
sheet.setDataSource(dataSource2);
} else {
sheet.setDataSource(dataSource1);
}
}
const initSpread = (currSpread) => {
spread = currSpread;
let company1 = new Company("Baidu", null, "We know everything!", "Beijing 1st road", "Beijing", "010-12345678", "baidu@baidu.com"),
company2 = new Company("Tecent", null, "We have everything!", "Shenzhen 2st road", "Shenzhen", "0755-12345678", "tecent@qq.com"),
company3 = new Company("Alibaba", null, "We sale everything!", "Hangzhou 3rd road", "Hangzhou", "0571-12345678", "alibaba@alibaba.com"),
customer1 = new Customer("A1", "employee 1", company2),
customer2 = new Customer("A2", "employee 2", company3),
records1 = [new Record("Finance charge on overdue balance at 1.5%", 1, 150), new Record("Invoice #100 for $1000 on 2014/1/1", 1, 150)],
records2 = [new Record("Purchase server device", 2, 15000), new Record("Company travel", 100, 1500), new Record("Company Dinner", 100, 200)],
invoice1 = new Invoice(company1, "00001", new Date(2014, 0, 1), customer1, customer1, records1),
invoice2 = new Invoice(company2, "00002", new Date(2014, 6, 6), customer2, customer2, records2);
dataSource1 = new GC.Spread.Sheets.Bindings.CellBindingSource(invoice1);
dataSource2 = new GC.Spread.Sheets.Bindings.CellBindingSource(invoice2);
//Get sheet instance
spread.suspendPaint();
let sheet = spread.sheets[0];
sheet.name("FINANCE CHARGE");
//Set value or bindingPath and style
let bindingPathCellType = new BindingPathCellType();
sheet.getCell(1, 2).bindingPath("company.slogan").cellType(bindingPathCellType).vAlign(GC.Spread.Sheets.VerticalAlign.bottom);
sheet.getCell(1, 4).value("INVOICE").foreColor("#58B6C0").font("33px Arial");
sheet.getCell(3, 1).bindingPath("company.name").cellType(bindingPathCellType).foreColor("#58B6C0").font("bold 20px Arial");
sheet.getCell(5, 1).bindingPath("company.address").cellType(bindingPathCellType);
sheet.getCell(5, 3).value("INVOICE NO.").font("bold 15px Arial");
sheet.getCell(5, 4).bindingPath("number").cellType(bindingPathCellType);
sheet.getCell(6, 1).bindingPath("company.city").cellType(bindingPathCellType);
sheet.getCell(6, 3).value("DATE").font("bold 15px Arial");
sheet.getCell(6, 4).bindingPath("date").cellType(bindingPathCellType).formatter("MM/dd/yyyy").hAlign(GC.Spread.Sheets.HorizontalAlign.left);
sheet.getCell(7, 1).bindingPath("company.phone").cellType(bindingPathCellType);
sheet.getCell(7, 3).value("CUSTOMER ID").font("bold 15px Arial");
sheet.getCell(7, 4).bindingPath("customer.id").cellType(bindingPathCellType);
sheet.getCell(8, 1).bindingPath("company.email").cellType(bindingPathCellType);
sheet.getCell(10, 1).value("TO").font("bold 15px Arial");
sheet.getCell(10, 3).value("SHIP TO").font("bold 15px Arial");
sheet.getCell(11, 1).bindingPath("customer.name").cellType(bindingPathCellType).textIndent(10);
sheet.getCell(12, 1).bindingPath("customer.company.name").cellType(bindingPathCellType).textIndent(10);
sheet.getCell(13, 1).bindingPath("customer.company.address").cellType(bindingPathCellType).textIndent(10);
sheet.getCell(14, 1).bindingPath("customer.company.city").cellType(bindingPathCellType).textIndent(10);
sheet.getCell(15, 1).bindingPath("customer.company.phone").cellType(bindingPathCellType).textIndent(10);
sheet.getCell(11, 4).bindingPath("receiverCustomer.name").cellType(bindingPathCellType);
sheet.getCell(12, 4).bindingPath("receiverCustomer.company.name").cellType(bindingPathCellType);
sheet.getCell(13, 4).bindingPath("receiverCustomer.company.address").cellType(bindingPathCellType);
sheet.getCell(14, 4).bindingPath("receiverCustomer.company.city").cellType(bindingPathCellType);
sheet.getCell(15, 4).bindingPath("receiverCustomer.company.phone").cellType(bindingPathCellType);
sheet.addSpan(17, 1, 1, 2);
sheet.getCell(17, 1).value("JOB").foreColor("#58B6C0").font("bold 12px Arial");
sheet.addSpan(17, 3, 1, 2);
sheet.getCell(17, 3).value("PAYMENT TERMS").foreColor("#58B6C0").font("bold 12px Arial");
sheet.addSpan(18, 1, 1, 2);
sheet.getCell(18, 1).backColor("#DDF0F2");
sheet.addSpan(18, 3, 1, 2);
sheet.getCell(18, 3).value("Due on receipt").backColor("#DDF0F2").foreColor("#58B6C0").font("12px Arial");
sheet.getRange(17, 1, 2, 4).setBorder(new GC.Spread.Sheets.LineBorder("#58B6C0", GC.Spread.Sheets.LineStyle.thin), { top: true, bottom: true, innerHorizontal: true });
let table = sheet.tables.add("tableRecordds", 20, 1, 4, 4, GC.Spread.Sheets.Tables.TableThemes.light6);
table.autoGenerateColumns(false);
let tableColumn1 = new GC.Spread.Sheets.Tables.TableColumn();
tableColumn1.name("DESCRIPTION");
tableColumn1.dataField("description");
let tableColumn2 = new GC.Spread.Sheets.Tables.TableColumn();
tableColumn2.name("QUANTITY");
tableColumn2.dataField("quantity");
let tableColumn3 = new GC.Spread.Sheets.Tables.TableColumn();
tableColumn3.name("AMOUNT");
tableColumn3.dataField("amount");
table.bindColumns([tableColumn1, tableColumn2, tableColumn3]);
table.bindingPath("records");
table.showFooter(true);
table.setColumnName(3, "TOTAL");
table.setColumnValue(2, "TOTAL DUE");
table.setColumnDataFormula(3, "=[@QUANTITY]*[@AMOUNT]");
table.setColumnFormula(3, "=SUBTOTAL(109,[TOTAL])");
sheet.getCell(26, 1).formula('="Make all checks payable to "&B4&". THANK YOU FOR YOUR BUSINESS!"').foreColor("gray").font("italic 14px Arial");
sheet.options.allowCellOverflow = true;
//Adjust row height and column width
sheet.setColumnWidth(0, 5);
sheet.setColumnWidth(1, 300);
sheet.setColumnWidth(2, 115);
sheet.setColumnWidth(3, 125);
sheet.setColumnWidth(4, 155);
sheet.setRowHeight(0, 5);
sheet.setRowHeight(1, 40);
sheet.setRowHeight(2, 10);
sheet.setRowHeight(3, 28);
sheet.setRowHeight(17, 0);
sheet.setRowHeight(18, 0);
sheet.setRowHeight(19, 0);
sheet.setRowHeight(25, 10);
sheet.options.gridline = { showHorizontalGridline: false, showVerticalGridline: false };
spread.resumePaint();
}
return (
<div class="sample-tutorial">
<div class="sample-spreadsheets">
<SpreadSheets workbookInitialized={spread => initSpread(spread)}>
</SpreadSheets>
</div>
<div class="options-container">
<div class="option-row">
<label style={{ backgroundColor: '#F4F8EB' }}>Click this button to set the data source for the data-bound table.</label>
</div>
<input type="button" onClick={() => { changeDataSource() }} id="changeDataSource" value="Set DataSource" title="Toggle table binding's data source" />
</div>
</div>
);
}
class Company {
constructor(name, logo, slogan, address, city, phone, email) {
this.name = name;
this.logo = logo;
this.slogan = slogan;
this.address = address;
this.city = city;
this.phone = phone;
this.email = email;
}
}
class Customer {
constructor(id, name, company) {
this.id = id;
this.name = name;
this.company = company;
}
}
class Record {
constructor(description, quantity, amount) {
this.description = description;
this.quantity = quantity;
this.amount = amount;
}
}
class Invoice {
constructor(company, number, date, customer, receiverCustomer, records) {
this.company = company;
this.number = number;
this.date = date;
this.customer = customer;
this.receiverCustomer = receiverCustomer;
this.records = records;
}
}
class BindingPathCellType extends GC.Spread.Sheets.CellTypes.Text {
constructor() {
super();
}
paint(ctx, value, x, y, w, h, style, context) {
if (value === null || value === undefined) {
let sheet = context.sheet, row = context.row, col = context.col;
if (sheet && (row === 0 || !!row) && (col === 0 || !!col)) {
let bindingPath = sheet.getBindingPath(context.row, context.col);
if (bindingPath) {
value = "[" + bindingPath + "]";
}
}
}
super.paint(ctx, value, x, y, w, h, style, context);
}
}
import * as React from 'react';
import GC from '@mescius/spread-sheets';
import { SpreadSheets } from '@mescius/spread-sheets-react';
export class App extends Component {
constructor(props) {
super(props);
this.spread = null;
this.dataSource1 = null;
this.dataSource2 = null;
}
render() {
return (
<div class="sample-tutorial">
<div class="sample-spreadsheets">
<SpreadSheets workbookInitialized={spread => this.initSpread(spread)}>
</SpreadSheets>
</div>
<div class="options-container">
<div class="option-row">
<label style={{ backgroundColor: '#F4F8EB' }}>Click this button to set the data source for the data-bound table.</label>
</div>
<input type="button" onClick={() => { this.changeDataSource() }} id="changeDataSource" value="Set DataSource" title="Toggle table binding's data source" />
</div>
</div>
)
}
changeDataSource() {
let sheet = this.spread.getActiveSheet();
if (sheet.getDataSource() === this.dataSource1) {
sheet.setDataSource(this.dataSource2);
} else {
sheet.setDataSource(this.dataSource1);
}
}
initSpread(spread) {
this.spread = spread;
let company1 = new Company("Baidu", null, "We know everything!", "Beijing 1st road", "Beijing", "010-12345678", "baidu@baidu.com"),
company2 = new Company("Tecent", null, "We have everything!", "Shenzhen 2st road", "Shenzhen", "0755-12345678", "tecent@qq.com"),
company3 = new Company("Alibaba", null, "We sale everything!", "Hangzhou 3rd road", "Hangzhou", "0571-12345678", "alibaba@alibaba.com"),
customer1 = new Customer("A1", "employee 1", company2),
customer2 = new Customer("A2", "employee 2", company3),
records1 = [new Record("Finance charge on overdue balance at 1.5%", 1, 150), new Record("Invoice #100 for $1000 on 2014/1/1", 1, 150)],
records2 = [new Record("Purchase server device", 2, 15000), new Record("Company travel", 100, 1500), new Record("Company Dinner", 100, 200)],
invoice1 = new Invoice(company1, "00001", new Date(2014, 0, 1), customer1, customer1, records1),
invoice2 = new Invoice(company2, "00002", new Date(2014, 6, 6), customer2, customer2, records2);
this.dataSource1 = new GC.Spread.Sheets.Bindings.CellBindingSource(invoice1),
this.dataSource2 = new GC.Spread.Sheets.Bindings.CellBindingSource(invoice2);
//Get sheet instance
spread.suspendPaint();
let sheet = spread.sheets[0];
sheet.name("FINANCE CHARGE");
//Set value or bindingPath and style
let bindingPathCellType = new BindingPathCellType();
sheet.getCell(1, 2).bindingPath("company.slogan").cellType(bindingPathCellType).vAlign(GC.Spread.Sheets.VerticalAlign.bottom);
sheet.getCell(1, 4).value("INVOICE").foreColor("#58B6C0").font("33px Arial");
sheet.getCell(3, 1).bindingPath("company.name").cellType(bindingPathCellType).foreColor("#58B6C0").font("bold 20px Arial");
sheet.getCell(5, 1).bindingPath("company.address").cellType(bindingPathCellType);
sheet.getCell(5, 3).value("INVOICE NO.").font("bold 15px Arial");
sheet.getCell(5, 4).bindingPath("number").cellType(bindingPathCellType);
sheet.getCell(6, 1).bindingPath("company.city").cellType(bindingPathCellType);
sheet.getCell(6, 3).value("DATE").font("bold 15px Arial");
sheet.getCell(6, 4).bindingPath("date").cellType(bindingPathCellType).formatter("MM/dd/yyyy").hAlign(GC.Spread.Sheets.HorizontalAlign.left);
sheet.getCell(7, 1).bindingPath("company.phone").cellType(bindingPathCellType);
sheet.getCell(7, 3).value("CUSTOMER ID").font("bold 15px Arial");
sheet.getCell(7, 4).bindingPath("customer.id").cellType(bindingPathCellType);
sheet.getCell(8, 1).bindingPath("company.email").cellType(bindingPathCellType);
sheet.getCell(10, 1).value("TO").font("bold 15px Arial");
sheet.getCell(10, 3).value("SHIP TO").font("bold 15px Arial");
sheet.getCell(11, 1).bindingPath("customer.name").cellType(bindingPathCellType).textIndent(10);
sheet.getCell(12, 1).bindingPath("customer.company.name").cellType(bindingPathCellType).textIndent(10);
sheet.getCell(13, 1).bindingPath("customer.company.address").cellType(bindingPathCellType).textIndent(10);
sheet.getCell(14, 1).bindingPath("customer.company.city").cellType(bindingPathCellType).textIndent(10);
sheet.getCell(15, 1).bindingPath("customer.company.phone").cellType(bindingPathCellType).textIndent(10);
sheet.getCell(11, 4).bindingPath("receiverCustomer.name").cellType(bindingPathCellType);
sheet.getCell(12, 4).bindingPath("receiverCustomer.company.name").cellType(bindingPathCellType);
sheet.getCell(13, 4).bindingPath("receiverCustomer.company.address").cellType(bindingPathCellType);
sheet.getCell(14, 4).bindingPath("receiverCustomer.company.city").cellType(bindingPathCellType);
sheet.getCell(15, 4).bindingPath("receiverCustomer.company.phone").cellType(bindingPathCellType);
sheet.addSpan(17, 1, 1, 2);
sheet.getCell(17, 1).value("JOB").foreColor("#58B6C0").font("bold 12px Arial");
sheet.addSpan(17, 3, 1, 2);
sheet.getCell(17, 3).value("PAYMENT TERMS").foreColor("#58B6C0").font("bold 12px Arial");
sheet.addSpan(18, 1, 1, 2);
sheet.getCell(18, 1).backColor("#DDF0F2");
sheet.addSpan(18, 3, 1, 2);
sheet.getCell(18, 3).value("Due on receipt").backColor("#DDF0F2").foreColor("#58B6C0").font("12px Arial");
sheet.getRange(17, 1, 2, 4).setBorder(new GC.Spread.Sheets.LineBorder("#58B6C0", GC.Spread.Sheets.LineStyle.thin), { top: true, bottom: true, innerHorizontal: true });
let table = sheet.tables.add("tableRecordds", 20, 1, 4, 4, GC.Spread.Sheets.Tables.TableThemes.light6);
table.autoGenerateColumns(false);
let tableColumn1 = new GC.Spread.Sheets.Tables.TableColumn();
tableColumn1.name("DESCRIPTION");
tableColumn1.dataField("description");
let tableColumn2 = new GC.Spread.Sheets.Tables.TableColumn();
tableColumn2.name("QUANTITY");
tableColumn2.dataField("quantity");
let tableColumn3 = new GC.Spread.Sheets.Tables.TableColumn();
tableColumn3.name("AMOUNT");
tableColumn3.dataField("amount");
table.bindColumns([tableColumn1, tableColumn2, tableColumn3]);
table.bindingPath("records");
table.showFooter(true);
table.setColumnName(3, "TOTAL");
table.setColumnValue(2, "TOTAL DUE");
table.setColumnDataFormula(3, "=[@QUANTITY]*[@AMOUNT]");
table.setColumnFormula(3, "=SUBTOTAL(109,[TOTAL])");
sheet.getCell(26, 1).formula('="Make all checks payable to "&B4&". THANK YOU FOR YOUR BUSINESS!"').foreColor("gray").font("italic 14px Arial");
sheet.options.allowCellOverflow = true;
//Adjust row height and column width
sheet.setColumnWidth(0, 5);
sheet.setColumnWidth(1, 300);
sheet.setColumnWidth(2, 115);
sheet.setColumnWidth(3, 125);
sheet.setColumnWidth(4, 155);
sheet.setRowHeight(0, 5);
sheet.setRowHeight(1, 40);
sheet.setRowHeight(2, 10);
sheet.setRowHeight(3, 28);
sheet.setRowHeight(17, 0);
sheet.setRowHeight(18, 0);
sheet.setRowHeight(19, 0);
sheet.setRowHeight(25, 10);
sheet.options.gridline = { showHorizontalGridline: false, showVerticalGridline: false };
spread.resumePaint();
}
}
class Company {
constructor(name, logo, slogan, address, city, phone, email) {
this.name = name;
this.logo = logo;
this.slogan = slogan;
this.address = address;
this.city = city;
this.phone = phone;
this.email = email;
}
}
class Customer {
constructor(id, name, company) {
this.id = id;
this.name = name;
this.company = company;
}
}
class Record {
constructor(description, quantity, amount) {
this.description = description;
this.quantity = quantity;
this.amount = amount;
}
}
class Invoice {
constructor(company, number, date, customer, receiverCustomer, records) {
this.company = company;
this.number = number;
this.date = date;
this.customer = customer;
this.receiverCustomer = receiverCustomer;
this.records = records;
}
}
class BindingPathCellType extends GC.Spread.Sheets.CellTypes.Text {
constructor() {
super();
}
paint(ctx, value, x, y, w, h, style, context) {
if (value === null || value === undefined) {
let sheet = context.sheet, row = context.row, col = context.col;
if (sheet && (row === 0 || !!row) && (col === 0 || !!col)) {
let bindingPath = sheet.getBindingPath(context.row, context.col);
if (bindingPath) {
value = "[" + bindingPath + "]";
}
}
}
super.paint(ctx, value, x, y, w, h, style, context);
}
}
<!doctype html>
<html style="height:100%;font-size:14px;">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="stylesheet" type="text/css" href="$DEMOROOT$/en/react/node_modules/@mescius/spread-sheets/styles/gc.spread.sheets.excel2013white.css">
<!-- SystemJS -->
<script src="$DEMOROOT$/en/react/node_modules/systemjs/dist/system.src.js"></script>
<script src="systemjs.config.js"></script>
<script>
System.import('$DEMOROOT$/en/lib/react/license.js').then(function () {
System.import('./src/app');
});
</script>
</head>
<body>
<div id="app" style="height: 100%;"></div>
</body>
</html>
.sample-tutorial {
position: relative;
height: 100%;
overflow: hidden;
}
.sample-spreadsheets {
width: calc(100% - 280px);
height: 100%;
overflow: hidden;
float: left;
}
.options-container {
float: right;
width: 280px;
padding: 12px;
height: 100%;
box-sizing: border-box;
background: #fbfbfb;
overflow: auto;
}
.option-row {
font-size: 14px;
padding: 5px;
margin-top: 10px;
}
label {
display: block;
margin-bottom: 6px;
}
input {
padding: 4px 6px;
}
input[type=button] {
margin-top: 6px;
display: block;
}
body {
position: absolute;
top: 0;
bottom: 0;
left: 0;
right: 0;
}
(function (global) {
System.config({
transpiler: 'plugin-babel',
babelOptions: {
es2015: true,
react: true
},
meta: {
'*.css': { loader: 'css' }
},
paths: {
// paths serve as alias
'npm:': 'node_modules/'
},
// map tells the System loader where to look for things
map: {
'@mescius/spread-sheets': 'npm:@mescius/spread-sheets/index.js',
'@mescius/spread-sheets-react': 'npm:@mescius/spread-sheets-react/index.js',
'@grapecity/jsob-test-dependency-package/react-components': 'npm:@grapecity/jsob-test-dependency-package/react-components/index.js',
'react': 'npm:react/umd/react.production.min.js',
'react-dom': 'npm:react-dom/umd/react-dom.production.min.js',
'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: 'jsx'
},
"node_modules": {
defaultExtension: 'js'
},
}
});
})(this);