What's new in Excel JavaScript API 1.18
The ExcelApi 1.18 adds support for creating, deleting, and managing notes in a workbook.This requirement set also expands support for cell formatting with Excel.CheckboxCellControl and Excel.RangeTextRun.
API list
The following table lists the APIs in Excel JavaScript API requirement set 1.18. To view API reference documentation for all APIs supported by Excel JavaScript API requirement set 1.18 or earlier, see Excel APIs in requirement set 1.18 or earlier.
| Class | Fields | Description |
|---|---|---|
| CheckboxCellControl | type | Represents an interactable control inside of a cell. |
| EmptyCellControl | type | |
| MixedCellControl | type | |
| Note | authorName | Gets the author of the note. |
| content | Gets or sets the text of the note. | |
| delete() | Deletes the note. | |
| getLocation() | Gets the cell where this note is located. | |
| height | Specifies the height of the note. | |
| visible | Specifies the visibility of the note. | |
| width | Specifies the width of the note. | |
| NoteCollection | add(cellAddress: Range | string, content: any) | Adds a new note with the given content on the given cell. |
| getCount() | Gets the number of notes in the collection. | |
| getItem(key: string) | Gets a note by its cell address. | |
| getItemAt(index: number) | Gets a note from the collection based on its position. | |
| getItemOrNullObject(key: string) | Gets a note by its cell address. | |
| items | Gets the loaded child items in this collection. | |
| Range | clearOrResetContents() | Clears the values of the cells in the range, with special consideration given to cells containing controls. |
| control | Accesses the cell control applied to this range. | |
| RangeAreas | clearOrResetContents() | Clears the values of the cells in the ranges, with special consideration given to cells containing controls. |
| select() | Selects the specified range areas in the Excel UI. | |
| RangeTextRun | font | The font attributes (such as font name, font size, and color) applied to this text run. |
| text | The text of this text run. | |
| UnknownCellControl | type | |
| Workbook | notes | Returns a collection of all the notes objects in the workbook. |
| Worksheet | notes | Returns a collection of all the notes objects in the worksheet. |
See also
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Office Add-ins