The defaultValue API is used to set a default value/formula to a cell, so that when the cell is empty, it will display the default value or the value calculated from a default formula.
When an empty cell has a default value/formula applied to it and a user edits that cell, the default value will not be overridden.
The APIs are as follows:
import * as React from 'react';
import * as ReactDOM from 'react-dom';
import './styles.css';
import { App } from './app-class';
ReactDOM.render(<App />, document.getElementById('app'));
import * as React from 'react';
import GC from '@mescius/spread-sheets';
import '@mescius/spread-sheets-io';
import { SpreadSheets, Worksheet } from '@mescius/spread-sheets-react';
import './styles.css';
const Component = React.Component;
export class App extends Component {
constructor(props) {
super(props);
this.spread = null;
this.fbx = null;
this.state = {
showDefault: '',
value: ''
}
this.handleShowDefault = this.handleShowDefault.bind(this);
}
render() {
return (<div class="sample-tutorial">
<div class="sample-spreadsheets">
<SpreadSheets workbookInitialized={spread => this.initSpread(spread)}>
<Worksheet></Worksheet>
</SpreadSheets>
</div>
<Panel showDefault={this.state.showDefault} value = {this.state.value} handleSetDefault={(e) => { this.handleSetDefault(e) }} handleShowDefault={(e)=>{this.handleShowDefault(e)}} handleSetDefaultValue={(e)=>{this.handleSetDefaultValue(e)}} />
</div>);
}
initSpread(spread) {
this.spread = spread;
this.fbx = new GC.Spread.Sheets.FormulaTextBox.FormulaTextBox(document.getElementById('formula'), {rangeSelectMode: true});
this.fbx.workbook(spread);
fetch(this.getFileUrl()).then(res => res.blob()).then((file) => {
spread.open(file, () => {
let sheet = spread.getActiveSheet();
sheet.suspendPaint();
sheet.suspendCalcService();
for (let i = 0; i < 12; i++) {
sheet.getCell(2, 3 + i, 3).defaultValue('=$B3/12');
sheet.getCell(3, 3 + i, 3).defaultValue('=$B4/12');
}
sheet.resumeCalcService();
sheet.resumePaint();
this.getDefault(spread);
});
});
this.bindEvents(spread);
}
getFileUrl () {
return '$DEMOROOT$/spread/source/data/defaultValue.sjs';
}
bindEvents(spread) {
let self = this;
spread.bind(GC.Spread.Sheets.Events.SelectionChanged, function () {
self.getDefault(spread);
});
spread.bind(GC.Spread.Sheets.Events.ActiveSheetChanged, function () {
self.getDefault(spread);
});
}
handleShowDefault(e){
this.setState({
showDefault: e.target.value
});
}
handleSetDefaultValue (e) {
this.setState({
value: e.target.value
});
}
handleSetDefault(e) {
let spread = this.spread;
let sheet = spread.getActiveSheet();
let value = this.state.value;
let selections = sheet.getSelections();
if (!selections || selections.length === 0) {
return;
}
sheet.suspendPaint();
let length = selections.length;
for (let i = 0; i < length; i++) {
let sel = selections[i],
rowIndex = sel.row,
colIndex = sel.col,
rowCount = sel.rowCount,
colCount = sel.colCount,
maxRow = rowIndex + rowCount,
maxColumn = colIndex + colCount,
r, c;
if (rowIndex !== -1 && colIndex !== -1) {
for (r = rowIndex; r < maxRow; r++) {
for (c = colIndex; c < maxColumn; c++) {
sheet.setDefaultValue(r, c, this.fbx.text() || this.convertValue(value));
}
}
}
}
sheet.resumePaint();
this.getDefault(spread);
}
getDefault(spread) {
let sheet = spread.getActiveSheet(), selections = sheet.getSelections();
if (!selections || selections.length === 0) {
this.setState({
showDefault: ''
});
return;
}
let sel = selections[0], row = sel.row, col = sel.col;
this.setState({
showDefault: sheet.getDefaultValue(row, col) || ''
});
}
convertValue (value) {
if (!value) {
return value;
}
// try to convert to number
let num = Number(value);
if (!isNaN(num)) {
return num;
}
// try to convert to boolean
if (value.toLowerCase() === "true" || value.toLowerCase() === "false") {
return value.toLowerCase() === "true";
}
// try to convert to date
let date = new Date(value);
if (!isNaN(date.getTime())) {
return date;
}
return value;
}
}
class Panel extends Component {
constructor(props) {
super(props);
}
render() {
const {handleSetDefault, handleSetDefaultValue} = this.props;
return (
<div class="options-container">
<div class="option-row">
<p>
<span>You can set, get the default value and formula for the active cells.</span>
</p>
</div>
<div class="option-row">
<label for="value">Default Value: </label>
<input id="value" value={this.props.value} onChange = {(e)=>{handleSetDefaultValue(e)}} />
</div>
<div class="option-row">
<label for="formula">Default Formula: </label>
<div id="formula" spellcheck="false" style={{border: '1px solid #808080', width:'100%', height:'21px', overflow:'hidden'}}></div>
</div>
<div class="option-row">
<input type="button" id="btnSetDefault" value="Set Default" title="Set default value and formula to selected item(s)" onClick={(e) => { handleSetDefault(this.state) }} />
</div>
<div class="option-row">
<label for="showDefault">Get Default Value: </label>
<textarea id="showDefault" cols="31" readOnly value={this.props.showDefault}></textarea>
</div>
</div>
)
}
}
<!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"></div>
</body>
</html>
.sample {
position: relative;
height: 100%;
overflow: auto;
}
.sample::after {
display: block;
content: "";
clear: both;
}
.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: inline-block;
margin-bottom: 6px;
}
input {
padding: 4px;
width: 100%;
margin: 0 4px 4px 0;
box-sizing: border-box;
}
input[type=button] {
width: 30%;
}
p {
background-color: #F4F8EB;
padding: 4px;
}
p span {
display: block;
}
body {
position: absolute;
top: 0;
bottom: 0;
left: 0;
right: 0;
}
#app {
height: 100%;
}
(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-io': 'npm:@mescius/spread-sheets-io/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);
