10 KiB
| title | sidebar_label | sidebar_position |
|---|---|---|
| Cell Comments and Notes | Cell Comments | 4 |
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
File Format Support (click to show)
Comments and Notes have evolved over the years.
Excel 2.0 - '95 "Notes" were displayed in a master list.
Excel '97 - 2024 "Comments" float over the sheet and support styling.
Excel 365 introduced "Threaded Comments" which do not support rich text but do allow users to "reply". The original "Comments" were renamed to "Notes".
| Formats | Notes | Comment | Threaded |
|---|---|---|---|
| XLSX / XLSM | ✕ | ✔ | ✔ |
| XLSB | ✕ | R | R |
| NUMBERS | ✕ | ✕ | ✔ |
| XLS (BIFF8) | ✕ | ✔ | ✕ |
| XLML | ✕ | ✔ | ✕ |
| ODS / FODS / UOS | ✕ | ✔ | ✕ |
| SYLK | ✔ | ✕ | ✕ |
| XLS (BIFF5) | ✔ | ✕ | ✕ |
| XLS (BIFF 2/3/4) | ✔ | ✕ | ✕ |
X (✕) marks features that are not supported by the file formats. For example, the NUMBERS file format supports plaintext threaded comments but does not support Excel styled comments or Excel legacy notes.
The letter R (R) marks features parsed but not written in the format.
:::tip pass
SheetJS Pro supports comment rich text and styling.
:::
Comments and notes are cell annotations. Cells with comments or notes are marked
with ◥ or ¬ in the upper-right corner.
Excel notes are standalone text boxes with adjustable background colors and support for rich text. Historically people "replied" to comments by adding text to the end of existing comments.
Excel comments are simple text boxes that allow users to enter plain text. Users can reply to comments. The replies are typically shown in a vertical stack.
Live Example
The following live example shows a spreadsheet with comments and a note.
- The note is associated with cell A1 (the cell with the red triangle). It has a green gradient background fill.
- The comments are associated with cell A2 (the cell with the blue
¬). There are 2 comments from different authors. A "Reply" box appears below the thread.
:::caution pass
Excel for Mac and other software that lack full support for threaded comments will show a fallback note that includes each reply on a separate line.
:::
Live Example (click to hide)
function SheetJSThreadedComments() {
return ( <button onClick={() => {
var ws = XLSX.utils.aoa_to_sheet([["SheetJS"], [5433795]], {dense: true});
var cell_A1 = (ws["!data"][0]??=[])[0]??={t:"z"}; // Cell A1
var cell_A2 = (ws["!data"][1]??=[])[0]??={t:"z"}; // Cell A2
/* normal comment in cell A1 */
cell_A1.c ??= [];
cell_A1.c.push({a:"SheetJS", t:"This is not threaded"});
/* threaded comment in cell A2 */
cell_A2.c ??= [];
/* add parts */
cell_A2.c.push({a:"SheetJS", t:"This is threaded", T: true});
var part = {a:"JSSheet", t:"This is also threaded"};
cell_A2.c.push({...part, T: true});
/* create workbook and export */
var wb = XLSX.utils.book_new(ws, "Sheet1");
XLSX.writeFile(wb, "SheetJSThreadedComments.xlsx");
}}>Click me to generate a sample file</button> );
}
:::info Application Support
Google Sheets "notes" do not currently support rich text or background colors.
Apple Numbers supports "comments" but does not support "notes".
:::
Basic Structure
Cell comments are stored in the c property of cell objects. They are expected
to be arrays of fragments objects that include text and metadata.
For example, the following snippet appends a cell comment into cell A1:
/* get cell A1, creating an empty cell if necessary */
var cell = ws["A1"];
if(!cell) cell = ws["A1"] = { t: "z" };
/* create comment array if it does not exist */
if(!cell.c) cell.c = [];
/* create a comment part */
var comment_part = {
a: "SheetJS",
t: "I'm a little comment, short and stout!"
};
/* Add comment part to the comment array */
cell.c.push(comment_part);
:::info pass
read, aoa_to_sheet,
and other SheetJS methods will generate sparse worksheets by default.
Dense mode worksheets require explicit opt-in.
:::
/* get cell A1, creating an empty cell if necessary */
var row = ws["!data"][0];
if(!row) row = ws["!data"][0] = [];
var cell = row[0];
if(!row[0]) cell = row[0] = { t: "z" };
/* create comment array if it does not exist */
if(!cell.c) cell.c = [];
/* create a comment part */
var comment_part = {
a: "SheetJS",
t: "I'm a little comment, short and stout!"
};
/* Add comment part to the comment array */
cell.c.push(comment_part);
Fragment Properties
Fragments support the following properties:
| Key | Description |
|---|---|
t |
Text |
a |
Author |
T |
If true, fragment is a threaded comment part |
Fragment Text
Each fragment must include text.
Note and comment fragment texts are concatenated to form the full text.
Threaded comment fragments are visually distinct.
:::tip pass
SheetJS CE supports plaintext comments.
SheetJS Pro supports comment styling and rich text.
Google Sheets and Excel threaded comments currently do not support styling.
:::
Fragment Author
The fragment author is optional.
Note and comment fragment authors are not displayed in Excel.
Threaded comment fragment authors are displayed in the thread in Excel.
:::note XLSB Author limits
XLSB enforces a 54 character limit on the Author name. Names longer than 54 characters may cause issues with other formats.
:::
Comment Properties
Visibility
The hidden property of the comment block indicates comment visibility. If set
to true, the comment will not be visible until users hover over the comment.
if(!cell.c) cell.c = [];
// highlight-next-line
cell.c.hidden = true;
cell.c.push({a:"SheetJS", t:"This comment will be hidden"});
Live Example (click to show)
The following demo creates a worksheet with two comments. The comment in cell A1 will be visibile and the comment in cell A2 will be hidden.
function SheetJSComments2() {
return (<button onClick={() => {
var ws = XLSX.utils.aoa_to_sheet([["SheetJS"], [5433795]]);
if(!ws.A1.c) ws.A1.c = [];
ws.A1.c.push({a:"SheetJS", t:"This comment is visible"});
if(!ws.A2.c) ws.A2.c = [];
ws.A2.c.hidden = true;
ws.A2.c.push({a:"SheetJS", t:"This comment will be hidden"});
var wb = XLSX.utils.book_new(); XLSX.utils.book_append_sheet(wb, ws, "Sheet1");
XLSX.writeFile(wb, "SheetJSComments2.xlsx");
}}>Click me to generate a sample file</button>);
}
Demos
Export
Live Export Example (click to hide)
This example creates a small worksheet with a comment in cell A1:
function SheetJSComments1() {
return (<button onClick={() => {
var ws = XLSX.utils.aoa_to_sheet([["SheetJS"]]);
if(!ws.A1.c) ws.A1.c = [];
ws.A1.c.push({a:"SheetJS", t:"I'm a little comment, short and stout!"});
var wb = XLSX.utils.book_new(); XLSX.utils.book_append_sheet(wb, ws, "Sheet1");
XLSX.writeFile(wb, "SheetJSComments1.xlsx");
}}>Click me to generate a sample file</button>);
}
Import
Live Import Example (click to show)
This example displays every comment in the workbook:
function SheetJSParseComments(props) {
const [__html, setHTML] = React.useState("");
return ( <>
<input type="file" onChange={async(e) => {
/* parse workbook */
const file = e.target.files[0];
const data = await file.arrayBuffer();
const wb = XLSX.read(data);
const html = [];
wb.SheetNames.forEach(n => {
var ws = wb.Sheets[n]; if(!ws) return;
var ref = XLSX.utils.decode_range(ws["!ref"]);
for(var R = 0; R <= ref.e.r; ++R) for(var C = 0; C <= ref.e.c; ++C) {
var addr = XLSX.utils.encode_cell({r:R,c:C});
if(!ws[addr] || !ws[addr].c) continue;
var comments = ws[addr].c;
if(!comments.length) continue;
var threaded = !!comments[0].T;
var msg = comments.map(c => c.t).join(threaded ? "\n" : "");
console.log(comments);
html.push(`${n}:${addr}:${+!!threaded}:${msg}`);
}
});
setHTML(html.join("\n"));
}}/>
<pre dangerouslySetInnerHTML={{ __html }}/>
</> );
}
Threaded Comments
Threaded comments are plain text comment snippets with author metadata and parent references. They are supported in XLSX, XLSB, and NUMBERS files.
To mark a comment as threaded, each comment part must have a true T property:
if(!cell.c) cell.c = [];
var part1 = {
a:"SheetJS",
t:"This is threaded",
// highlight-next-line
T: true
};
cell.c.push(part1);
var part2 = {
a:"JSSheet",
t:"This is also threaded",
};
// The next line uses Object Spread syntax to add T: true
// highlight-next-line
cell.c.push({ ...part2, T: true});
:::caution pass
There is no Active Directory or Office 365 metadata associated with authors.
:::