In addition to customizing header style and caption, users can also customize style, conditional formats and validator of column cells in tableSheet view:
import * as React from 'react';
import { createRoot } from 'react-dom/client';
import './styles.css';
import { AppFunc } from './app-func';
import { App } from './app-class';
// 1. Functional Component sample
createRoot(document.getElementById('app')).render(<AppFunc />);
// 2. Class Component sample
// createRoot(document.getElementById('app')).render(<App />);
/*REPLACE_MARKER*/
/*DO NOT DELETE THESE COMMENTS*/
import * as React from 'react';
import GC from '@mescius/spread-sheets';
import "@mescius/spread-sheets-tablesheet";
import { SpreadSheets } from '@mescius/spread-sheets-react';
import './styles.css';
export function AppFunc() {
const initSpread = (spread) => {
spread.suspendPaint();
spread.clearSheets();
spread.options.autoFitType = GC.Spread.Sheets.AutoFitType.cellWithHeader;
spread.bind(GC.Spread.Sheets.Events.EditStarting, function (e, args) {
if (args.sheet.getValue(0, args.col, GC.Spread.Sheets.SheetArea.colHeader) === 'Customer') {
args.cancel = true;
}
});
//init a data manager
var baseApiUrl = getBaseApiUrl();
var dataManager = spread.dataManager();
//add order table
var orderTable = dataManager.addTable("orderTable", {
remote: {
read: {
url: baseApiUrl + "/Order"
}
},
schema: {
columns: {
CustomerId: {
lookup: {
name: 'customer', columns: [
{ value: "Id", width: 60 },
{ value: "CompanyName", width: 200 },
{ value: "ContactName", width: 140 },
{ value: "ContactTitle", width: 140 }
]
}
}
}
}
});
//add customer table
var customerTable = dataManager.addTable("customerTable", {
remote: {
read: {
url: baseApiUrl + "/Customer"
}
}
});
//add employee table
var employeeTable = dataManager.addTable("employeeTable", {
remote: {
read: {
url: baseApiUrl + "/Employee"
}
}
});
//add relationship between order table, customer table and employee table
dataManager.addRelationship(orderTable, "CustomerId", "customer", customerTable, "Id", "orders");
dataManager.addRelationship(orderTable, "EmployeeId", "employee", employeeTable, "Id", "orders");
//init a table sheet
var sheet = spread.addSheetTab(0, "TableSheet1", GC.Spread.Sheets.SheetType.tableSheet);
sheet.options.allowAddNew = false; //hide new row
//bind a view to the table sheet
var addressStyle = {
formatter: 'Ship To: {{=CONCAT(@.ShipAddress, ", ", @.ShipCity)}}'
};
var formulaRule = {
ruleType: "formulaRule",
formula: "@>50",
style: {
backColor: "pink"
}
};
var multiSelectStyle = {
formatter: '{{=CONCAT([@customer.CompanyName], ", ", [@customer.ContactName])}}', // convert the object to string
};
var myView = orderTable.addView("myView", [
{ value: "Id", width: 60 }, //set column width 100px
{
value: "OrderDate", width: 120, style: {
formatter: "MM/dd/yyyy", hAlign: "center", cellButtons: [{
command: "openDateTimePicker",
imageType: "dropdown",
useButtonStyle: true,
}]
}
},
{ value: "Freight", width: 100, conditionalFormats: [formulaRule], style: { backColor: "white" } },
/**
* customer.companyName - this is a related field from the customer table
* update the customerId in orderTable by select from customer table.
*/
{ caption: "Customer", value: "CustomerId", width: 350, style: multiSelectStyle },
/**
* [=@] this column will contain the full row as a value, the formatter formula will extract the shipping address from the full row.
* Format functions can be used to customize column display value
* use star-size "2*" to set column width relative to the viewport width
*/
{ value: "=[@]", caption: "Address", style: addressStyle, width: 450 },
/**
* The formatter formula will extract the properties from the full row.
* Format functions can be used to customize column display value.
*/
{ caption: "Employee", value: "employee", width: 250, style: { formatter: '{{=[@employee.FirstName] & " " & [@employee.LastName]}} ({{=[@ShipRegion]}})' } },
]);
myView.fetch().then(function () {
sheet.setDataView(myView);
});
spread.resumePaint();
}
return (
<div class="sample-tutorial">
<div class="sample-spreadsheets">
<SpreadSheets workbookInitialized={spread => initSpread(spread)}>
</SpreadSheets>
</div>
</div>
);
}
function getBaseApiUrl() {
return window.location.href.match(/http.+spreadjs\/demos\//)[0] + 'server/api';
}
/*REPLACE_MARKER*/
/*DO NOT DELETE THESE COMMENTS*/
import * as React from 'react';
import GC from '@mescius/spread-sheets';
import "@mescius/spread-sheets-tablesheet";
import { SpreadSheets } from '@mescius/spread-sheets-react';
import './styles.css';
const Component = React.Component;
export class App extends Component {
render() {
return (
<div class="sample-tutorial">
<div class="sample-spreadsheets">
<SpreadSheets workbookInitialized={spread => this.initSpread(spread)}>
</SpreadSheets>
</div>
</div>
);
}
initSpread(spread) {
spread.suspendPaint();
spread.clearSheets();
spread.options.autoFitType = GC.Spread.Sheets.AutoFitType.cellWithHeader;
spread.bind(GC.Spread.Sheets.Events.EditStarting, function (e, args) {
if (args.sheet.getValue(0, args.col, GC.Spread.Sheets.SheetArea.colHeader) === 'Customer'){
args.cancel = true;
}
});
//init a data manager
var baseApiUrl = getBaseApiUrl();
var dataManager = spread.dataManager();
//add order table
var orderTable = dataManager.addTable("orderTable", {
remote: {
read: {
url: baseApiUrl + "/Order"
}
},
schema: {
columns: {
CustomerId: {
lookup: {
name: 'customer', columns: [
{ value: "Id", width: 60 },
{ value: "CompanyName", width: 200 },
{ value: "ContactName", width: 140 },
{ value: "ContactTitle", width: 140 }
]
}
}
}
}
});
//add customer table
var customerTable = dataManager.addTable("customerTable", {
remote: {
read: {
url: baseApiUrl + "/Customer"
}
}
});
//add employee table
var employeeTable = dataManager.addTable("employeeTable", {
remote: {
read: {
url: baseApiUrl + "/Employee"
}
}
});
//add relationship between order table, customer table and employee table
dataManager.addRelationship(orderTable, "CustomerId", "customer", customerTable, "Id", "orders");
dataManager.addRelationship(orderTable, "EmployeeId", "employee", employeeTable, "Id", "orders");
//init a table sheet
var sheet = spread.addSheetTab(0, "TableSheet1", GC.Spread.Sheets.SheetType.tableSheet);
sheet.options.allowAddNew = false; //hide new row
//bind a view to the table sheet
var addressStyle = {
formatter: 'Ship To: {{=CONCAT(@.ShipAddress, ", ", @.ShipCity)}}'
};
var formulaRule = {
ruleType: "formulaRule",
formula: "@>50",
style: {
backColor: "pink"
}
};
var multiSelectStyle = {
formatter: '{{=CONCAT([@customer.CompanyName], ", ", [@customer.ContactName])}}', // convert the object to string
};
var myView = orderTable.addView("myView", [
{ value: "Id", width: 60}, //set column width 100px
{ value: "OrderDate", width: 120, style: { formatter: "MM/dd/yyyy", hAlign: "center", cellButtons: [{
command: "openDateTimePicker",
imageType: "dropdown",
useButtonStyle: true,
}]}},
{ value: "Freight", width: 100, conditionalFormats: [formulaRule], style: {backColor: "white"}},
/**
* customer.companyName - this is a related field from the customer table
* update the customerId in orderTable by select from customer table.
*/
{ caption: "Customer", value: "CustomerId", width: 350, style: multiSelectStyle},
/**
* [=@] this column will contain the full row as a value, the formatter formula will extract the shipping address from the full row.
* Format functions can be used to customize column display value
* use star-size "2*" to set column width relative to the viewport width
*/
{ value: "=[@]", caption: "Address", style: addressStyle, width: 450},
/**
* The formatter formula will extract the properties from the full row.
* Format functions can be used to customize column display value.
*/
{ caption: "Employee", value: "employee", width: 250 , style: { formatter: '{{=[@employee.FirstName] & " " & [@employee.LastName]}} ({{=[@ShipRegion]}})'} },
]);
myView.fetch().then(function() {
sheet.setDataView(myView);
});
spread.resumePaint();
}
}
function getBaseApiUrl() {
return window.location.href.match(/http.+spreadjs\/demos\//)[0] + 'server/api';
}
<!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: 100%;
height: 100%;
overflow: hidden;
float: left;
}
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-tablesheet': 'npm:@mescius/spread-sheets-tablesheet/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/cjs/react.production.js',
'react-dom': 'npm:react-dom/cjs/react-dom.production.js',
'react-dom/client': 'npm:react-dom/cjs/react-dom-client.production.js',
'scheduler': 'npm:scheduler/cjs/scheduler.production.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);
