To add a comment to a sheet, first create a comment and set some settings for it. Then you can use the add method to set a comment for the specified cell. For example:
Sometimes you want to remove the comment you added, as shown in the following example:
After you add a comment to a cell, you can use the get method to get the comment, or use the all method to get all the comments in the sheet.
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 * as ReactDOM from 'react-dom';
import { SpreadSheets, Worksheet } from '@mescius/spread-sheets-react';
import './styles.css';
function _getElementById(id) {
return document.getElementById(id);
}
const Component = React.Component;
export function AppFunc() {
let spread = null;
let initSpread = function(value) {
spread = value;
spread.suspendPaint();
let sheet = spread.getSheet(0);
sheet.addSpan(1, 1, 1, 6);
sheet.setValue(1, 1, "there is a comment on the upper right corner of the cell");
sheet.comments.add(1, 1, "new comment!");
spread.resumePaint();
}
let addComment = function(commentSetting) {
let row = commentSetting.rowIndex;
let col = commentSetting.colIndex;
let sheet = spread.getSheet(0);
sheet.setValue(row, col, 'new comment');
let text = commentSetting.commentText;
sheet.comments.add(row, col, text);
}
return (<div class="sample-tutorial">
<div class="sample-spreadsheets">
<SpreadSheets workbookInitialized={spread=>initSpread(spread)}>
<Worksheet/>
</SpreadSheets>
</div>
<Panel addComment={(e)=>{addComment(e)}}/>
</div>);
}
class Panel extends Component{
constructor(props){
super(props);
this.state = {
rowIndex: 5,
colIndex: 2,
commentText: "comment demo"
}
}
render() {
return (
<div class="options-container">
<div class="option-row">
<label for="txtRowIndex">Row index:</label>
<input id="txtRowIndex" type="text" value= {this.state.rowIndex} onChange={(e)=>{this.setState({rowIndex: parseInt(e.target.value)})}}/>
</div>
<div class="option-row">
<label for="txtColumnIndex">Column index:</label>
<input id="txtColumnIndex" type="text" value= {this.state.colIndex} onChange={(e)=>{this.setState({colIndex: parseInt(e.target.value)})}}/>
</div>
<div class="option-row">
<label for="txtComment">Comment text:</label>
<input id="txtComment" type="text" value= {this.state.commentText} onChange={(e)=>{this.setState({commentText: e.target.value})}} />
</div>
<div class="option-row">
<input type="button" id="btnAddComment" value="AddComment" onClick={(e)=>{this.props.addComment(this.state)}}/>
</div>
</div>
)
}
}
import * as React from 'react';
import * as ReactDOM from 'react-dom';
import { SpreadSheets, Worksheet } from '@mescius/spread-sheets-react';
import './styles.css';
function _getElementById(id) {
return document.getElementById(id);
}
const Component = React.Component;
export class App extends Component {
constructor(props) {
super(props);
this.spread = null;
}
render() {
return (<div class="sample-tutorial">
<div class="sample-spreadsheets">
<SpreadSheets workbookInitialized={spread=>this.initSpread(spread)}>
<Worksheet/>
</SpreadSheets>
</div>
<Panel addComment={(e)=>{this.addComment(e)}}/>
</div>);
}
initSpread(spread) {
this.spread = spread;
spread.suspendPaint();
let sheet = spread.getSheet(0);
sheet.addSpan(1, 1, 1, 6);
sheet.setValue(1, 1, "there is a comment on the upper right corner of the cell");
sheet.comments.add(1, 1, "new comment!");
spread.resumePaint();
}
addComment(commentSetting) {
let row = commentSetting.rowIndex;
let col = commentSetting.colIndex;
let sheet = this.spread.getSheet(0);
sheet.setValue(row, col, 'new comment');
let text = commentSetting.commentText;
sheet.comments.add(row, col, text);
}
}
class Panel extends Component{
constructor(props){
super(props);
this.state = {
rowIndex: 5,
colIndex: 2,
commentText: "comment demo"
}
}
render() {
return (
<div class="options-container">
<div class="option-row">
<label for="txtRowIndex">Row index:</label>
<input id="txtRowIndex" type="text" value= {this.state.rowIndex} onChange={(e)=>{this.setState({rowIndex: parseInt(e.target.value)})}}/>
</div>
<div class="option-row">
<label for="txtColumnIndex">Column index:</label>
<input id="txtColumnIndex" type="text" value= {this.state.colIndex} onChange={(e)=>{this.setState({colIndex: parseInt(e.target.value)})}}/>
</div>
<div class="option-row">
<label for="txtComment">Comment text:</label>
<input id="txtComment" type="text" value= {this.state.commentText} onChange={(e)=>{this.setState({commentText: e.target.value})}} />
</div>
<div class="option-row">
<input type="button" id="btnAddComment" value="AddComment" onClick={(e)=>{this.props.addComment(this.state)}}/>
</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-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;
overflow: auto;
padding: 12px;
height: 100%;
box-sizing: border-box;
background: #fbfbfb;
}
label {
display: inline-block;
min-width: 90px;
margin: 6px 0;
}
input {
padding: 4px 6px;
box-sizing: border-box;
margin-bottom: 6px;
}
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-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);
