## Workbook class
Represents a root object to create an Excel spreadsheet.
```javascript
class Workbook;
```
### Remarks
The Workbook class denotes an Excel spreadsheet. Each spreadsheet can contain multiple worksheets. The basic feature of the class is to open and save native excel files. The class has some advanced features like copying data from other Workbooks, combining two Workbooks, converting Excel to PDF, rendering Excel to image and protecting the Excel spreadsheet.
### Example
The following example creates a Workbook and makes the horizontal and vertical scroll bars invisible for the Workbook. It then replaces two string values with an Integer value and string value respectively within the spreadsheet and finally save it to file named result.xls.
```javascript
const { Workbook, XlsSaveOptions } = require("aspose.cells.node");
//Open a xls file
var workbook = new Workbook("input/Book1.xls");
//Set scroll bars
workbook.settings.isHScrollBarVisible = false;
workbook.settings.isVScrollBarVisible = false;
//Replace the placeholder string with new values
workbook.replace("OldInt", 100);
var newString = "Hello world";
workbook.replace("OldString", newString);
var saveOptions = new XlsSaveOptions();
workbook.save("output/result.xls", saveOptions);
```
## Constructors
| Constructor | Description |
| --- | --- |
| [constructor()](#constructor--)| Initializes a new instance of the [Workbook](../workbook/) class. |
| [constructor(FileFormatType)](#constructor-fileformattype-)| Initializes a new instance of the [Workbook](../workbook/) class. |
| [constructor(LoadOptions)](#constructor-loadoptions-)| Initializes a new empty instance of the [Workbook](../workbook/) class with options |
| [constructor(string)](#constructor-string-)| Initializes a new instance of the [Workbook](../workbook/) class and open a file. |
| [constructor(Uint8Array)](#constructor-uint8array-)| Initializes a new instance of the [Workbook](../workbook/) class and open a stream. |
| [constructor(string, LoadOptions)](#constructor-string-loadoptions-)| Initializes a new instance of the [Workbook](../workbook/) class and open a file. |
| [constructor(Uint8Array, LoadOptions)](#constructor-uint8array-loadoptions-)| Initializes a new instance of the [Workbook](../workbook/) class and open stream. |
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [settings](#settings--)| WorkbookSettings | Readonly. Represents the workbook settings. |
| [worksheets](#worksheets--)| WorksheetCollection | Readonly. Gets the [WorksheetCollection](../worksheetcollection/) collection in the spreadsheet. |
| [isLicensed](#isLicensed--)| boolean | Readonly. Indicates whether license is set. |
| [colors](#colors--)| Color[] | Readonly. Returns colors in the palette for the spreadsheet. |
| [countOfStylesInPool](#countOfStylesInPool--)| number | Readonly. Gets number of the styles in the style pool. |
| [defaultStyle](#defaultStyle--)| Style | Gets or sets the default [Style](../style/) object of the workbook. |
| [isDigitallySigned](#isDigitallySigned--)| boolean | Readonly. Indicates if this spreadsheet is digitally signed. |
| [isWorkbookProtectedWithPassword](#isWorkbookProtectedWithPassword--)| boolean | Readonly. Indicates whether structure or window is protected with password. |
| [vbaProject](#vbaProject--)| VbaProject | Readonly. Gets the [VbaProject](../vbaproject/) in a spreadsheet. |
| [hasMacro](#hasMacro--)| boolean | Readonly. Indicates if this spreadsheet contains macro/VBA. |
| [hasRevisions](#hasRevisions--)| boolean | Readonly. Gets if the workbook has any tracked changes |
| [fileName](#fileName--)| string | Gets and sets the current file name. |
| [dataSorter](#dataSorter--)| DataSorter | Readonly. Gets a DataSorter object to sort data. |
| [theme](#theme--)| string | Readonly. Gets the theme name. |
| [builtInDocumentProperties](#builtInDocumentProperties--)| BuiltInDocumentPropertyCollection | Readonly. Returns a [DocumentProperty](../documentproperty/) collection that represents all the built-in document properties of the spreadsheet. |
| [customDocumentProperties](#customDocumentProperties--)| CustomDocumentPropertyCollection | Readonly. Returns a [DocumentProperty](../documentproperty/) collection that represents all the custom document properties of the spreadsheet. |
| [fileFormat](#fileFormat--)| FileFormatType | Gets and sets the file format. |
| [hasCustomFunction](#hasCustomFunction--)| boolean | Readonly. Detects whether there is custom function used in this workbook, such as in cell's formula, in defined names... |
| [interruptMonitor](#interruptMonitor--)| AbstractInterruptMonitor | Gets and sets the interrupt monitor. |
| [contentTypeProperties](#contentTypeProperties--)| ContentTypePropertyCollection | Readonly. Gets the list of [ContentTypeProperty](../contenttypeproperty/) objects in the workbook. |
| [customXmlParts](#customXmlParts--)| CustomXmlPartCollection | Readonly. Represents a Custom XML Data Storage Part (custom XML data within a package). |
| [dataMashup](#dataMashup--)| DataMashup | Readonly. Gets mashup data. |
| [ribbonXml](#ribbonXml--)| string | Gets and sets the XML file that defines the Ribbon UI. |
| [absolutePath](#absolutePath--)| string | Gets and sets the absolute path of the file. |
| [dataConnections](#dataConnections--)| ExternalConnectionCollection | Readonly. Gets the [ExternalConnection](../externalconnection/) collection. |
| [dataModel](#dataModel--)| DataModel | Readonly. Gets data model in the workbook. |
## Methods
| Method | Description |
| --- | --- |
| [getSettings()](#getSettings--)| @deprecated. Please use the 'settings' property instead. Represents the workbook settings. |
| [getWorksheets()](#getWorksheets--)| @deprecated. Please use the 'worksheets' property instead. Gets the [WorksheetCollection](../worksheetcollection/) collection in the spreadsheet. |
| [isLicensed()](#isLicensed--)| @deprecated. Please use the 'isLicensed' property instead. Indicates whether license is set. |
| [getColors()](#getColors--)| @deprecated. Please use the 'colors' property instead. Returns colors in the palette for the spreadsheet. |
| [getCountOfStylesInPool()](#getCountOfStylesInPool--)| @deprecated. Please use the 'countOfStylesInPool' property instead. Gets number of the styles in the style pool. |
| [getDefaultStyle()](#getDefaultStyle--)| @deprecated. Please use the 'defaultStyle' property instead. Gets or sets the default [Style](../style/) object of the workbook. |
| [setDefaultStyle(Style)](#setDefaultStyle-style-)| @deprecated. Please use the 'defaultStyle' property instead. Gets or sets the default [Style](../style/) object of the workbook. |
| [isDigitallySigned()](#isDigitallySigned--)| @deprecated. Please use the 'isDigitallySigned' property instead. Indicates if this spreadsheet is digitally signed. |
| [isWorkbookProtectedWithPassword()](#isWorkbookProtectedWithPassword--)| @deprecated. Please use the 'isWorkbookProtectedWithPassword' property instead. Indicates whether structure or window is protected with password. |
| [getVbaProject()](#getVbaProject--)| @deprecated. Please use the 'vbaProject' property instead. Gets the [VbaProject](../vbaproject/) in a spreadsheet. |
| [getHasMacro()](#getHasMacro--)| @deprecated. Please use the 'hasMacro' property instead. Indicates if this spreadsheet contains macro/VBA. |
| [getHasRevisions()](#getHasRevisions--)| @deprecated. Please use the 'hasRevisions' property instead. Gets if the workbook has any tracked changes |
| [getFileName()](#getFileName--)| @deprecated. Please use the 'fileName' property instead. Gets and sets the current file name. |
| [setFileName(string)](#setFileName-string-)| @deprecated. Please use the 'fileName' property instead. Gets and sets the current file name. |
| [getDataSorter()](#getDataSorter--)| @deprecated. Please use the 'dataSorter' property instead. Gets a DataSorter object to sort data. |
| [getTheme()](#getTheme--)| @deprecated. Please use the 'theme' property instead. Gets the theme name. |
| [getBuiltInDocumentProperties()](#getBuiltInDocumentProperties--)| @deprecated. Please use the 'builtInDocumentProperties' property instead. Returns a [DocumentProperty](../documentproperty/) collection that represents all the built-in document properties of the spreadsheet. |
| [getCustomDocumentProperties()](#getCustomDocumentProperties--)| @deprecated. Please use the 'customDocumentProperties' property instead. Returns a [DocumentProperty](../documentproperty/) collection that represents all the custom document properties of the spreadsheet. |
| [getFileFormat()](#getFileFormat--)| @deprecated. Please use the 'fileFormat' property instead. Gets and sets the file format. |
| [setFileFormat(FileFormatType)](#setFileFormat-fileformattype-)| @deprecated. Please use the 'fileFormat' property instead. Gets and sets the file format. |
| [getHasCustomFunction()](#getHasCustomFunction--)| @deprecated. Please use the 'hasCustomFunction' property instead. Detects whether there is custom function used in this workbook, such as in cell's formula, in defined names... |
| [getInterruptMonitor()](#getInterruptMonitor--)| @deprecated. Please use the 'interruptMonitor' property instead. Gets and sets the interrupt monitor. |
| [setInterruptMonitor(AbstractInterruptMonitor)](#setInterruptMonitor-abstractinterruptmonitor-)| @deprecated. Please use the 'interruptMonitor' property instead. Gets and sets the interrupt monitor. |
| [getContentTypeProperties()](#getContentTypeProperties--)| @deprecated. Please use the 'contentTypeProperties' property instead. Gets the list of [ContentTypeProperty](../contenttypeproperty/) objects in the workbook. |
| [getCustomXmlParts()](#getCustomXmlParts--)| @deprecated. Please use the 'customXmlParts' property instead. Represents a Custom XML Data Storage Part (custom XML data within a package). |
| [getDataMashup()](#getDataMashup--)| @deprecated. Please use the 'dataMashup' property instead. Gets mashup data. |
| [getRibbonXml()](#getRibbonXml--)| @deprecated. Please use the 'ribbonXml' property instead. Gets and sets the XML file that defines the Ribbon UI. |
| [setRibbonXml(string)](#setRibbonXml-string-)| @deprecated. Please use the 'ribbonXml' property instead. Gets and sets the XML file that defines the Ribbon UI. |
| [getAbsolutePath()](#getAbsolutePath--)| @deprecated. Please use the 'absolutePath' property instead. Gets and sets the absolute path of the file. |
| [setAbsolutePath(string)](#setAbsolutePath-string-)| @deprecated. Please use the 'absolutePath' property instead. Gets and sets the absolute path of the file. |
| [getDataConnections()](#getDataConnections--)| @deprecated. Please use the 'dataConnections' property instead. Gets the [ExternalConnection](../externalconnection/) collection. |
| [getDataModel()](#getDataModel--)| @deprecated. Please use the 'dataModel' property instead. Gets data model in the workbook. |
| [parseFormulas(boolean)](#parseFormulas-boolean-)| Parses all formulas which have not been parsed when they were loaded from template file or set to a cell. |
| [startAccessCache(AccessCacheOptions)](#startAccessCache-accesscacheoptions-)| Starts the session that uses caches to access data. |
| [closeAccessCache(AccessCacheOptions)](#closeAccessCache-accesscacheoptions-)| Closes the session that uses caches to access data. |
| [save(string, SaveFormat)](#save-string-saveformat-)| Saves the workbook to the disk. |
| [save(string)](#save-string-)| Save the workbook to the disk. |
| [save(string, SaveOptions)](#save-string-saveoptions-)| Saves the workbook to the disk. |
| [save(SaveFormat)](#save-saveformat-)| Saves the workbook to the stream. |
| [save(SaveOptions)](#save-saveoptions-)| Saves the workbook to the stream. |
| [saveAsync(string, SaveFormat)](#saveAsync-string-saveformat-)| Saves the workbook to the disk. |
| [saveAsync(string)](#saveAsync-string-)| Save the workbook to the disk. |
| [saveAsync(string, SaveOptions)](#saveAsync-string-saveoptions-)| Saves the workbook to the disk. |
| [saveAsync(SaveFormat)](#saveAsync-saveformat-)| Saves the workbook to the stream. |
| [saveAsync(SaveOptions)](#saveAsync-saveoptions-)| Saves the workbook to the stream. |
| [saveToStream()](#saveToStream--)| Saves Excel file to a MemoryStream object as an Excel97-2003 xls file and returns it. |
| [saveToStreamAsync()](#saveToStreamAsync--)| Saves Excel file to a MemoryStream object as an Excel97-2003 xls file and returns it. |
| [removeUnusedStyles()](#removeUnusedStyles--)| Remove all unused styles. |
| [createStyle()](#createStyle--)| Creates a new style. |
| [createStyle(boolean)](#createStyle-boolean-)| Creates a new style. |
| [createBuiltinStyle(BuiltinStyleType)](#createBuiltinStyle-builtinstyletype-)| Creates built-in style by given type. |
| [createCellsColor()](#createCellsColor--)| Creates a [CellsColor](../cellscolor/) object. |
| [replace(string, string)](#replace-string-string-)| Replaces a cell's value with a new string. |
| [replace(string, number)](#replace-string-number-)| Replaces a cell's value with a new integer. |
| [replace(string, number)](#replace-string-number-)| Replaces a cell's value with a new double. |
| [replace(string, string[], boolean)](#replace-string-stringarray-boolean-)| Replaces a cell's value with a new string array. |
| [replace(string, number[], boolean)](#replace-string-numberarray-boolean-)| Replaces cells' values with an integer array. |
| [replace(string, number[], boolean)](#replace-string-numberarray-boolean-)| Replaces cells' values with a double array. |
| [replace(boolean, Object)](#replace-boolean-object-)| Replaces cells' values with new data. |
| [replace(number, Object)](#replace-number-object-)| Replaces cells' values with new data. |
| [replace(string, string, ReplaceOptions)](#replace-string-string-replaceoptions-)| Replaces a cell's value with a new string. |
| [copy(Workbook, CopyOptions)](#copy-workbook-copyoptions-)| Copies another Workbook object. |
| [copy(Workbook)](#copy-workbook-)| Copies data from a source Workbook object. |
| [combine(Workbook)](#combine-workbook-)| Combines another Workbook object. |
| [getStyleInPool(number)](#getStyleInPool-number-)| Gets the style in the style pool. All styles in the workbook will be gathered into a pool. There is only a simple reference index in the cells. |
| [getFonts()](#getFonts--)| Gets all fonts in the style pool. |
| [getNamedStyle(string)](#getNamedStyle-string-)| Gets the named style in the style pool. |
| [mergeNamedStyles(Workbook)](#mergeNamedStyles-workbook-)| Merges named styles from the other Excel file. |
| [changePalette(Color, number)](#changePalette-color-number-)| Changes the palette for the spreadsheet in the specified index. |
| [isColorInPalette(Color)](#isColorInPalette-color-)| Checks if a color is in the palette for the spreadsheet. |
| [calculateFormula()](#calculateFormula--)| Calculates the result of formulas. |
| [calculateFormula(boolean)](#calculateFormula-boolean-)| Calculates the result of formulas. |
| [calculateFormula(CalculationOptions)](#calculateFormula-calculationoptions-)| Calculating formulas in this workbook. |
| [calculateFormulaAsync()](#calculateFormulaAsync--)| Calculates the result of formulas. |
| [calculateFormulaAsync(boolean)](#calculateFormulaAsync-boolean-)| Calculates the result of formulas. |
| [calculateFormulaAsync(CalculationOptions)](#calculateFormulaAsync-calculationoptions-)| Calculating formulas in this workbook. |
| [refreshDynamicArrayFormulas(boolean)](#refreshDynamicArrayFormulas-boolean-)| Refreshes dynamic array formulas(spill into new range of neighboring cells according to current data) Other formulas in the workbook will not be calculated recursively even if they were used by dynamic array formulas. |
| [refreshDynamicArrayFormulas(boolean, CalculationOptions)](#refreshDynamicArrayFormulas-boolean-calculationoptions-)| Refreshes dynamic array formulas(spill into new range of neighboring cells according to current data) |
| [getMatchingColor(Color)](#getMatchingColor-color-)| Find best matching Color in current palette. |
| [setEncryptionOptions(EncryptionType, number)](#setEncryptionOptions-encryptiontype-number-)| Set Encryption Options. |
| [protect(ProtectionType, string)](#protect-protectiontype-string-)| Protects a workbook. |
| [protectSharedWorkbook(string)](#protectSharedWorkbook-string-)| Protects a shared workbook. |
| [unprotect(string)](#unprotect-string-)| Unprotects a workbook. |
| [unprotectSharedWorkbook(string)](#unprotectSharedWorkbook-string-)| Unprotects a shared workbook. |
| [removeMacro()](#removeMacro--)| Removes VBA/macro from this spreadsheet. |
| [removeDigitalSignature()](#removeDigitalSignature--)| Removes digital signature from this spreadsheet. |
| [acceptAllRevisions()](#acceptAllRevisions--)| Accepts all tracked changes in the workbook. |
| [getThemeColor(ThemeColorType)](#getThemeColor-themecolortype-)| Gets theme color. |
| [setThemeColor(ThemeColorType, Color)](#setThemeColor-themecolortype-color-)| Sets the theme color |
| [customTheme(string, Color[])](#customTheme-string-colorarray-)| Customs the theme. |
| [copyTheme(Workbook)](#copyTheme-workbook-)| Copies the theme from another workbook. |
| [updateCustomFunctionDefinition(CustomFunctionDefinition)](#updateCustomFunctionDefinition-customfunctiondefinition-)| Updates definition of custom functions. |
| [updateLinkedDataSource(Workbook[])](#updateLinkedDataSource-workbookarray-)| If this workbook contains external links to other data source, Aspose.Cells will attempt to retrieve the latest data from give sources. |
| [setInterruptMonitor(InterruptMonitor)](#setInterruptMonitor-interruptmonitor-)| Sets the interrupt monitor. |
| [importXml(string, string, number, number)](#importXml-string-string-number-number-)| Imports/Updates an XML data file into the workbook. |
| [importXml(Uint8Array, string, number, number)](#importXml-uint8array-string-number-number-)| Imports/Updates an XML data file into the workbook. |
| [exportXml(string, string)](#exportXml-string-string-)| Export XML data linked by the specified XML map. |
| [exportXml(string)](#exportXml-string-)| Export XML data. |
| [setDigitalSignature(DigitalSignatureCollection)](#setDigitalSignature-digitalsignaturecollection-)| Sets digital signature to an spreadsheet file (Excel2007 and later). |
| [addDigitalSignature(DigitalSignatureCollection)](#addDigitalSignature-digitalsignaturecollection-)| Adds digital signature to an OOXML spreadsheet file (Excel2007 and later). |
| [getDigitalSignature()](#getDigitalSignature--)| Gets digital signature from file. |
| [removePersonalInformation()](#removePersonalInformation--)| Removes personal information. |
| [refreshAll()](#refreshAll--)| Refresh linked shapes, all pivot tables and charts with pivot source. |
| [dispose()](#dispose--)| Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
| [isNull()](#isNull--)| Checks whether the implementation object is null. |
| static [openAsync()](#openAsync--)| Initializes a new instance of the [Workbook](../workbook/) class. |
| static [openAsync(FileFormatType)](#openAsync-fileformattype-)| Initializes a new instance of the [Workbook](../workbook/) class. |
| static [openAsync(LoadOptions)](#openAsync-loadoptions-)| Initializes a new empty instance of the [Workbook](../workbook/) class with options |
| static [openAsync(string)](#openAsync-string-)| Initializes a new instance of the [Workbook](../workbook/) class and open a file. |
| static [openAsync(Uint8Array)](#openAsync-uint8array-)| Initializes a new instance of the [Workbook](../workbook/) class and open a stream. |
| static [openAsync(string, LoadOptions)](#openAsync-string-loadoptions-)| Initializes a new instance of the [Workbook](../workbook/) class and open a file. |
| static [openAsync(Uint8Array, LoadOptions)](#openAsync-uint8array-loadoptions-)| Initializes a new instance of the [Workbook](../workbook/) class and open stream. |
### constructor() {#constructor--}
Initializes a new instance of the [Workbook](../workbook/) class.
```javascript
constructor();
```
**Remarks**
The default file format type is Xlsx. If you want to create other types of files, please use Workbook(FileFormatType).
**Example**
The following code shows how to use the Workbook constructor to create and initialize a new instance of the class.
```javascript
const { Workbook } = require("aspose.cells.node");
var workbook = new Workbook();
```
### constructor(FileFormatType) {#constructor-fileformattype-}
Initializes a new instance of the [Workbook](../workbook/) class.
```javascript
constructor(fileFormatType: FileFormatType);
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileFormatType | [FileFormatType](../fileformattype/) | The new file format. |
**Remarks**
The default file format type is Excel97To2003.
**Example**
The following code shows how to use the Workbook constructor to create and initialize a new instance of the class.
```javascript
const { Workbook, FileFormatType } = require("aspose.cells.node");
var workbook = new Workbook(FileFormatType.Xlsx);
```
### constructor(LoadOptions) {#constructor-loadoptions-}
Initializes a new empty instance of the [Workbook](../workbook/) class with options
```javascript
constructor(loadOptions: LoadOptions);
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| loadOptions | [LoadOptions](../loadoptions/) | The options. |
### constructor(string) {#constructor-string-}
Initializes a new instance of the [Workbook](../workbook/) class and open a file.
```javascript
constructor(file: string);
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| file | string | The file name. |
### constructor(Uint8Array) {#constructor-uint8array-}
Initializes a new instance of the [Workbook](../workbook/) class and open a stream.
```javascript
constructor(stream: Uint8Array);
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | Uint8Array | The stream. |
### constructor(string, LoadOptions) {#constructor-string-loadoptions-}
Initializes a new instance of the [Workbook](../workbook/) class and open a file.
```javascript
constructor(file: string, loadOptions: LoadOptions);
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| file | string | The file name. |
| loadOptions | [LoadOptions](../loadoptions/) | The load options |
### constructor(Uint8Array, LoadOptions) {#constructor-uint8array-loadoptions-}
Initializes a new instance of the [Workbook](../workbook/) class and open stream.
```javascript
constructor(stream: Uint8Array, loadOptions: LoadOptions);
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | Uint8Array | The stream. |
| loadOptions | [LoadOptions](../loadoptions/) | The load options |
### settings {#settings--}
Readonly. Represents the workbook settings.
```javascript
settings : WorkbookSettings;
```
### worksheets {#worksheets--}
Readonly. Gets the [WorksheetCollection](../worksheetcollection/) collection in the spreadsheet.
```javascript
worksheets : WorksheetCollection;
```
**Returns**
[WorksheetCollection](../worksheetcollection/) collection
### isLicensed {#isLicensed--}
Readonly. Indicates whether license is set.
```javascript
isLicensed : boolean;
```
### colors {#colors--}
Readonly. Returns colors in the palette for the spreadsheet.
```javascript
colors : Color[];
```
**Remarks**
The palette has 56 entries, each represented by an RGB value.
### countOfStylesInPool {#countOfStylesInPool--}
Readonly. Gets number of the styles in the style pool.
```javascript
countOfStylesInPool : number;
```
### defaultStyle {#defaultStyle--}
Gets or sets the default [Style](../style/) object of the workbook.
```javascript
defaultStyle : Style;
```
**Remarks**
The DefaultStyle property is useful to implement a Style for the whole Workbook.
**Example**
The following code creates and instantiates a new Workbook and sets a default Style to it.
```javascript
const { Workbook } = require("aspose.cells.node");
var workbook = new Workbook();
var defaultStyle = workbook.defaultStyle;
defaultStyle.font.setName("Tahoma");
workbook.defaultStyle = defaultStyle;
```
### isDigitallySigned {#isDigitallySigned--}
Readonly. Indicates if this spreadsheet is digitally signed.
```javascript
isDigitallySigned : boolean;
```
### isWorkbookProtectedWithPassword {#isWorkbookProtectedWithPassword--}
Readonly. Indicates whether structure or window is protected with password.
```javascript
isWorkbookProtectedWithPassword : boolean;
```
### vbaProject {#vbaProject--}
Readonly. Gets the [VbaProject](../vbaproject/) in a spreadsheet.
```javascript
vbaProject : VbaProject;
```
### hasMacro {#hasMacro--}
Readonly. Indicates if this spreadsheet contains macro/VBA.
```javascript
hasMacro : boolean;
```
### hasRevisions {#hasRevisions--}
Readonly. Gets if the workbook has any tracked changes
```javascript
hasRevisions : boolean;
```
### fileName {#fileName--}
Gets and sets the current file name.
```javascript
fileName : string;
```
**Remarks**
If the file is opened by stream and there are some external formula references, please set the file name.
### dataSorter {#dataSorter--}
Readonly. Gets a DataSorter object to sort data.
```javascript
dataSorter : DataSorter;
```
### theme {#theme--}
Readonly. Gets the theme name.
```javascript
theme : string;
```
### builtInDocumentProperties {#builtInDocumentProperties--}
Readonly. Returns a [DocumentProperty](../documentproperty/) collection that represents all the built-in document properties of the spreadsheet.
```javascript
builtInDocumentProperties : BuiltInDocumentPropertyCollection;
```
**Remarks**
A new property cannot be added to built-in document properties list. You can only get a built-in property and change its value. The following is the built-in properties name list: Title
Subject
Author
Keywords
Comments
Template
Last Author
Revision Number
Application Name
Last Print Date
Creation Date
Last Save Time
Total Editing Time
Number of Pages
Number of Words
Number of Characters
Security
Category
Format
Manager
Company
Number of Bytes
Number of Lines
Number of Paragraphs
Number of Slides
Number of Notes
Number of Hidden Slides
Number of Multimedia Clips
**Example**
```javascript
const { Workbook } = require("aspose.cells.node");
var workbook = new Workbook();
var doc = workbook.builtInDocumentProperties.get("Author");
doc.value = "John Smith";
```
### customDocumentProperties {#customDocumentProperties--}
Readonly. Returns a [DocumentProperty](../documentproperty/) collection that represents all the custom document properties of the spreadsheet.
```javascript
customDocumentProperties : CustomDocumentPropertyCollection;
```
**Example**
```javascript
const { Workbook } = require("aspose.cells.node");
var excel = new Workbook();
excel.customDocumentProperties.add("Checked by", "Jane");
```
### fileFormat {#fileFormat--}
Gets and sets the file format.
```javascript
fileFormat : FileFormatType;
```
### hasCustomFunction {#hasCustomFunction--}
Readonly. Detects whether there is custom function used in this workbook, such as in cell's formula, in defined names...
```javascript
hasCustomFunction : boolean;
```
### interruptMonitor {#interruptMonitor--}
Gets and sets the interrupt monitor.
```javascript
interruptMonitor : AbstractInterruptMonitor;
```
### contentTypeProperties {#contentTypeProperties--}
Readonly. Gets the list of [ContentTypeProperty](../contenttypeproperty/) objects in the workbook.
```javascript
contentTypeProperties : ContentTypePropertyCollection;
```
### customXmlParts {#customXmlParts--}
Readonly. Represents a Custom XML Data Storage Part (custom XML data within a package).
```javascript
customXmlParts : CustomXmlPartCollection;
```
### dataMashup {#dataMashup--}
Readonly. Gets mashup data.
```javascript
dataMashup : DataMashup;
```
### ribbonXml {#ribbonXml--}
Gets and sets the XML file that defines the Ribbon UI.
```javascript
ribbonXml : string;
```
### absolutePath {#absolutePath--}
Gets and sets the absolute path of the file.
```javascript
absolutePath : string;
```
**Remarks**
Only used for external links.
### dataConnections {#dataConnections--}
Readonly. Gets the [ExternalConnection](../externalconnection/) collection.
```javascript
dataConnections : ExternalConnectionCollection;
```
### dataModel {#dataModel--}
Readonly. Gets data model in the workbook.
```javascript
dataModel : DataModel;
```
### getSettings() {#getSettings--}
@deprecated. Please use the 'settings' property instead. Represents the workbook settings.
```javascript
getSettings() : WorkbookSettings;
```
**Returns**
[WorkbookSettings](../workbooksettings/)
### getWorksheets() {#getWorksheets--}
@deprecated. Please use the 'worksheets' property instead. Gets the [WorksheetCollection](../worksheetcollection/) collection in the spreadsheet.
```javascript
getWorksheets() : WorksheetCollection;
```
**Returns**
[WorksheetCollection](../worksheetcollection/) collection
### isLicensed() {#isLicensed--}
@deprecated. Please use the 'isLicensed' property instead. Indicates whether license is set.
```javascript
isLicensed() : boolean;
```
### getColors() {#getColors--}
@deprecated. Please use the 'colors' property instead. Returns colors in the palette for the spreadsheet.
```javascript
getColors() : Color[];
```
**Returns**
[Color](../color/)[]
**Remarks**
The palette has 56 entries, each represented by an RGB value.
### getCountOfStylesInPool() {#getCountOfStylesInPool--}
@deprecated. Please use the 'countOfStylesInPool' property instead. Gets number of the styles in the style pool.
```javascript
getCountOfStylesInPool() : number;
```
### getDefaultStyle() {#getDefaultStyle--}
@deprecated. Please use the 'defaultStyle' property instead. Gets or sets the default [Style](../style/) object of the workbook.
```javascript
getDefaultStyle() : Style;
```
**Returns**
[Style](../style/)
**Remarks**
The DefaultStyle property is useful to implement a Style for the whole Workbook.
### setDefaultStyle(Style) {#setDefaultStyle-style-}
@deprecated. Please use the 'defaultStyle' property instead. Gets or sets the default [Style](../style/) object of the workbook.
```javascript
setDefaultStyle(value: Style) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [Style](../style/) | The value to set. |
**Remarks**
The DefaultStyle property is useful to implement a Style for the whole Workbook.
### isDigitallySigned() {#isDigitallySigned--}
@deprecated. Please use the 'isDigitallySigned' property instead. Indicates if this spreadsheet is digitally signed.
```javascript
isDigitallySigned() : boolean;
```
### isWorkbookProtectedWithPassword() {#isWorkbookProtectedWithPassword--}
@deprecated. Please use the 'isWorkbookProtectedWithPassword' property instead. Indicates whether structure or window is protected with password.
```javascript
isWorkbookProtectedWithPassword() : boolean;
```
### getVbaProject() {#getVbaProject--}
@deprecated. Please use the 'vbaProject' property instead. Gets the [VbaProject](../vbaproject/) in a spreadsheet.
```javascript
getVbaProject() : VbaProject;
```
**Returns**
[VbaProject](../vbaproject/)
### getHasMacro() {#getHasMacro--}
@deprecated. Please use the 'hasMacro' property instead. Indicates if this spreadsheet contains macro/VBA.
```javascript
getHasMacro() : boolean;
```
### getHasRevisions() {#getHasRevisions--}
@deprecated. Please use the 'hasRevisions' property instead. Gets if the workbook has any tracked changes
```javascript
getHasRevisions() : boolean;
```
### getFileName() {#getFileName--}
@deprecated. Please use the 'fileName' property instead. Gets and sets the current file name.
```javascript
getFileName() : string;
```
**Remarks**
If the file is opened by stream and there are some external formula references, please set the file name.
### setFileName(string) {#setFileName-string-}
@deprecated. Please use the 'fileName' property instead. Gets and sets the current file name.
```javascript
setFileName(value: string) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | string | The value to set. |
**Remarks**
If the file is opened by stream and there are some external formula references, please set the file name.
### getDataSorter() {#getDataSorter--}
@deprecated. Please use the 'dataSorter' property instead. Gets a DataSorter object to sort data.
```javascript
getDataSorter() : DataSorter;
```
**Returns**
[DataSorter](../datasorter/)
### getTheme() {#getTheme--}
@deprecated. Please use the 'theme' property instead. Gets the theme name.
```javascript
getTheme() : string;
```
### getBuiltInDocumentProperties() {#getBuiltInDocumentProperties--}
@deprecated. Please use the 'builtInDocumentProperties' property instead. Returns a [DocumentProperty](../documentproperty/) collection that represents all the built-in document properties of the spreadsheet.
```javascript
getBuiltInDocumentProperties() : BuiltInDocumentPropertyCollection;
```
**Returns**
[BuiltInDocumentPropertyCollection](../builtindocumentpropertycollection/)
**Remarks**
A new property cannot be added to built-in document properties list. You can only get a built-in property and change its value. The following is the built-in properties name list:
Title
Subject
Author
Keywords
Comments
Template
Last Author
Revision Number
Application Name
Last Print Date
Creation Date
Last Save Time
Total Editing Time
Number of Pages
Number of Words
Number of Characters
Security
Category
Format
Manager
Company
Number of Bytes
Number of Lines
Number of Paragraphs
Number of Slides
Number of Notes
Number of Hidden Slides
Number of Multimedia Clips
### getCustomDocumentProperties() {#getCustomDocumentProperties--}
@deprecated. Please use the 'customDocumentProperties' property instead. Returns a [DocumentProperty](../documentproperty/) collection that represents all the custom document properties of the spreadsheet.
```javascript
getCustomDocumentProperties() : CustomDocumentPropertyCollection;
```
**Returns**
[CustomDocumentPropertyCollection](../customdocumentpropertycollection/)
### getFileFormat() {#getFileFormat--}
@deprecated. Please use the 'fileFormat' property instead. Gets and sets the file format.
```javascript
getFileFormat() : FileFormatType;
```
**Returns**
[FileFormatType](../fileformattype/)
### setFileFormat(FileFormatType) {#setFileFormat-fileformattype-}
@deprecated. Please use the 'fileFormat' property instead. Gets and sets the file format.
```javascript
setFileFormat(value: FileFormatType) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [FileFormatType](../fileformattype/) | The value to set. |
### getHasCustomFunction() {#getHasCustomFunction--}
@deprecated. Please use the 'hasCustomFunction' property instead. Detects whether there is custom function used in this workbook, such as in cell's formula, in defined names...
```javascript
getHasCustomFunction() : boolean;
```
### getInterruptMonitor() {#getInterruptMonitor--}
@deprecated. Please use the 'interruptMonitor' property instead. Gets and sets the interrupt monitor.
```javascript
getInterruptMonitor() : AbstractInterruptMonitor;
```
**Returns**
[AbstractInterruptMonitor](../abstractinterruptmonitor/)
### setInterruptMonitor(AbstractInterruptMonitor) {#setInterruptMonitor-abstractinterruptmonitor-}
@deprecated. Please use the 'interruptMonitor' property instead. Gets and sets the interrupt monitor.
```javascript
setInterruptMonitor(value: AbstractInterruptMonitor) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [AbstractInterruptMonitor](../abstractinterruptmonitor/) | The value to set. |
### getContentTypeProperties() {#getContentTypeProperties--}
@deprecated. Please use the 'contentTypeProperties' property instead. Gets the list of [ContentTypeProperty](../contenttypeproperty/) objects in the workbook.
```javascript
getContentTypeProperties() : ContentTypePropertyCollection;
```
**Returns**
[ContentTypePropertyCollection](../contenttypepropertycollection/)
### getCustomXmlParts() {#getCustomXmlParts--}
@deprecated. Please use the 'customXmlParts' property instead. Represents a Custom XML Data Storage Part (custom XML data within a package).
```javascript
getCustomXmlParts() : CustomXmlPartCollection;
```
**Returns**
[CustomXmlPartCollection](../customxmlpartcollection/)
### getDataMashup() {#getDataMashup--}
@deprecated. Please use the 'dataMashup' property instead. Gets mashup data.
```javascript
getDataMashup() : DataMashup;
```
**Returns**
[DataMashup](../datamashup/)
### getRibbonXml() {#getRibbonXml--}
@deprecated. Please use the 'ribbonXml' property instead. Gets and sets the XML file that defines the Ribbon UI.
```javascript
getRibbonXml() : string;
```
### setRibbonXml(string) {#setRibbonXml-string-}
@deprecated. Please use the 'ribbonXml' property instead. Gets and sets the XML file that defines the Ribbon UI.
```javascript
setRibbonXml(value: string) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | string | The value to set. |
### getAbsolutePath() {#getAbsolutePath--}
@deprecated. Please use the 'absolutePath' property instead. Gets and sets the absolute path of the file.
```javascript
getAbsolutePath() : string;
```
**Remarks**
Only used for external links.
### setAbsolutePath(string) {#setAbsolutePath-string-}
@deprecated. Please use the 'absolutePath' property instead. Gets and sets the absolute path of the file.
```javascript
setAbsolutePath(value: string) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | string | The value to set. |
**Remarks**
Only used for external links.
### getDataConnections() {#getDataConnections--}
@deprecated. Please use the 'dataConnections' property instead. Gets the [ExternalConnection](../externalconnection/) collection.
```javascript
getDataConnections() : ExternalConnectionCollection;
```
**Returns**
[ExternalConnectionCollection](../externalconnectioncollection/)
### getDataModel() {#getDataModel--}
@deprecated. Please use the 'dataModel' property instead. Gets data model in the workbook.
```javascript
getDataModel() : DataModel;
```
**Returns**
[DataModel](../datamodel/)
### parseFormulas(boolean) {#parseFormulas-boolean-}
Parses all formulas which have not been parsed when they were loaded from template file or set to a cell.
```javascript
parseFormulas(ignoreError: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| ignoreError | boolean | Whether ignore error for invalid formula. /// For one invalid formula, if ignore error then this formula will be ignored /// and the process will continue to parse other formulas, otherwise exception will be thrown. |
### startAccessCache(AccessCacheOptions) {#startAccessCache-accesscacheoptions-}
Starts the session that uses caches to access data.
```javascript
startAccessCache(opts: AccessCacheOptions) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| opts | [AccessCacheOptions](../accesscacheoptions/) | options of data access |
**Remarks**
If the cache of specified data access requires some data models in worksheet to be "read-only", then corresponding data models in every worksheet in this workbook will be taken as "read-only" and user should not change any of them.
After finishing the access to the data, [CloseAccessCache(AccessCacheOptions)](../closeaccesscache(accesscacheoptions)/) should be invoked with same options to clear all caches and recover normal access mode.
;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileName | string | The file name. |
| saveFormat | [SaveFormat](../saveformat/) | The save format type. |
**Returns**
[Promise](../promise/)
### saveAsync(string) {#saveAsync-string-}
Save the workbook to the disk.
```javascript
saveAsync(fileName: string) : Promise;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileName | string | |
**Returns**
[Promise](../promise/)
### saveAsync(string, SaveOptions) {#saveAsync-string-saveoptions-}
Saves the workbook to the disk.
```javascript
saveAsync(fileName: string, saveOptions: SaveOptions) : Promise;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileName | string | The file name. |
| saveOptions | [SaveOptions](../saveoptions/) | The save options. |
**Returns**
[Promise](../promise/)
### saveAsync(SaveFormat) {#saveAsync-saveformat-}
Saves the workbook to the stream.
```javascript
saveAsync(saveFormat: SaveFormat) : Promise;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| saveFormat | [SaveFormat](../saveformat/) | The save file format type. |
**Returns**
The result stream
**Example**
```javascript
const fs = require("fs");
const { Workbook, SaveFormat } = require("aspose.cells.node");
var workbook = new Workbook("input/Book1.xls");
workbook.saveAsync(SaveFormat.Pdf)
.then((buffer) => {
var writeStream = fs.createWriteStream("output/Book1.xlsx");
writeStream.write(buffer);
writeStream.end();
})
.catch(error => {
console.error(error);
});
```
### saveAsync(SaveOptions) {#saveAsync-saveoptions-}
Saves the workbook to the stream.
```javascript
saveAsync(saveOptions: SaveOptions) : Promise;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| saveOptions | [SaveOptions](../saveoptions/) | The save options. |
**Returns**
The result stream
### saveToStream() {#saveToStream--}
Saves Excel file to a MemoryStream object as an Excel97-2003 xls file and returns it.
```javascript
saveToStream() : Uint8Array;
```
**Returns**
MemoryStream object which contains an xls Excel file.
**Remarks**
This method provides same function as Save method and only save the workbook as Excel97-2003 xls file. It's mainly for calling from COM clients.
### saveToStreamAsync() {#saveToStreamAsync--}
Saves Excel file to a MemoryStream object as an Excel97-2003 xls file and returns it.
```javascript
saveToStreamAsync() : Promise;
```
**Returns**
MemoryStream object which contains an xls Excel file.
**Remarks**
This method provides same function as Save method and only save the workbook as Excel97-2003 xls file. It's mainly for calling from COM clients.
### removeUnusedStyles() {#removeUnusedStyles--}
Remove all unused styles.
```javascript
removeUnusedStyles() : void;
```
### createStyle() {#createStyle--}
Creates a new style.
```javascript
createStyle() : Style;
```
**Returns**
Returns a style object.
### createStyle(boolean) {#createStyle-boolean-}
Creates a new style.
```javascript
createStyle(cloneDefaultStyle: boolean) : Style;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cloneDefaultStyle | boolean | Incidates whether clones the default style |
**Returns**
Returns a style object.
### createBuiltinStyle(BuiltinStyleType) {#createBuiltinStyle-builtinstyletype-}
Creates built-in style by given type.
```javascript
createBuiltinStyle(type: BuiltinStyleType) : Style;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BuiltinStyleType](../builtinstyletype/) | The builtin style stype. |
**Returns**
[Style](../style/) object
### createCellsColor() {#createCellsColor--}
Creates a [CellsColor](../cellscolor/) object.
```javascript
createCellsColor() : CellsColor;
```
**Returns**
Returns a [CellsColor](../cellscolor/) object.
### replace(string, string) {#replace-string-string-}
Replaces a cell's value with a new string.
```javascript
replace(placeHolder: string, newValue: string) : number;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| placeHolder | string | Cell placeholder |
| newValue | string | String value to replace |
**Example**
```javascript
const { Workbook } = require("aspose.cells.node");
var workbook = new Workbook();
workbook.replace("AnOldValue", "NewValue");
```
### replace(string, number) {#replace-string-number-}
Replaces a cell's value with a new integer.
```javascript
replace(placeHolder: string, newValue: number) : number;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| placeHolder | string | Cell placeholder |
| newValue | number | Integer value to replace |
**Example**
```javascript
const { Workbook } = require("aspose.cells.node");
var workbook = new Workbook();
var newValue = 100;
workbook.replace("AnOldValue", newValue);
```
### replace(string, number) {#replace-string-number-}
Replaces a cell's value with a new double.
```javascript
replace(placeHolder: string, newValue: number) : number;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| placeHolder | string | Cell placeholder |
| newValue | number | Double value to replace |
**Example**
```javascript
const { Workbook } = require("aspose.cells.node");
var workbook = new Workbook();
var newValue = 100.0;
workbook.replace("AnOldValue", newValue);
```
### replace(string, string[], boolean) {#replace-string-stringarray-boolean-}
Replaces a cell's value with a new string array.
```javascript
replace(placeHolder: string, newValues: string[], isVertical: boolean) : number;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| placeHolder | string | Cell placeholder |
| newValues | string[] | String array to replace |
| isVertical | boolean | True - Vertical, False - Horizontal |
**Example**
```javascript
const { Workbook } = require("aspose.cells.node");
var workbook = new Workbook("input/Replace.xls");
var newValues = ["Tom", "Alice", "Jerry"];
workbook.replace("AnOldValue", newValues, true);
workbook.save("output/ReplaceResult1.xls");
```
### replace(string, number[], boolean) {#replace-string-numberarray-boolean-}
Replaces cells' values with an integer array.
```javascript
replace(placeHolder: string, newValues: number[], isVertical: boolean) : number;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| placeHolder | string | Cell placeholder |
| newValues | number[] | Integer array to replace |
| isVertical | boolean | True - Vertical, False - Horizontal |
**Example**
```javascript
const { Workbook } = require("aspose.cells.node");
var workbook = new Workbook("input/Replace.xls");
var newValues = [1, 2, 3];
workbook.replace("AnOldValue", newValues, true);
workbook.save("output/ReplaceResult2.xls");
```
### replace(string, number[], boolean) {#replace-string-numberarray-boolean-}
Replaces cells' values with a double array.
```javascript
replace(placeHolder: string, newValues: number[], isVertical: boolean) : number;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| placeHolder | string | Cell placeholder |
| newValues | number[] | Double array to replace |
| isVertical | boolean | True - Vertical, False - Horizontal |
**Example**
```javascript
const { Workbook } = require("aspose.cells.node");
var workbook = new Workbook("input/Replace.xls");
var newValues = [1.23, 2.56, 3.14159];
workbook.replace("AnOldValue", newValues, true);
workbook.save("output/ReplaceResult3.xls");
```
### replace(boolean, Object) {#replace-boolean-object-}
Replaces cells' values with new data.
```javascript
replace(boolValue: boolean, newValue: Object) : number;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| boolValue | boolean | The boolean value to be replaced. |
| newValue | Object | New value. Can be string, integer, double or DateTime value. |
### replace(number, Object) {#replace-number-object-}
Replaces cells' values with new data.
```javascript
replace(intValue: number, newValue: Object) : number;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| intValue | number | The integer value to be replaced. |
| newValue | Object | New value. Can be string, integer, double or DateTime value. |
### replace(string, string, ReplaceOptions) {#replace-string-string-replaceoptions-}
Replaces a cell's value with a new string.
```javascript
replace(placeHolder: string, newValue: string, options: ReplaceOptions) : number;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| placeHolder | string | Cell placeholder |
| newValue | string | String value to replace |
| options | [ReplaceOptions](../replaceoptions/) | The replace options |
### copy(Workbook, CopyOptions) {#copy-workbook-copyoptions-}
Copies another Workbook object.
```javascript
copy(source: Workbook, copyOptions: CopyOptions) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | [Workbook](../workbook/) | Source Workbook object. |
| copyOptions | [CopyOptions](../copyoptions/) | The options of copying other workbook. |
**Remarks**
It's very simple to clone an Excel file.
### copy(Workbook) {#copy-workbook-}
Copies data from a source Workbook object.
```javascript
copy(source: Workbook) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | [Workbook](../workbook/) | Source Workbook object. |
### combine(Workbook) {#combine-workbook-}
Combines another Workbook object.
```javascript
combine(secondWorkbook: Workbook) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| secondWorkbook | [Workbook](../workbook/) | Another Workbook object. |
**Remarks**
Merge Excel, ODS , CSV and other files to one file.
### getStyleInPool(number) {#getStyleInPool-number-}
Gets the style in the style pool. All styles in the workbook will be gathered into a pool. There is only a simple reference index in the cells.
```javascript
getStyleInPool(index: number) : Style;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | number | The index. |
**Returns**
The style in the pool corresponds to given index, may be null.
**Remarks**
If the returned style is changed, the style of all cells(which refers to this style) will be changed.
### getFonts() {#getFonts--}
Gets all fonts in the style pool.
```javascript
getFonts() : Font[];
```
**Returns**
[Font](../font/)[]
### getNamedStyle(string) {#getNamedStyle-string-}
Gets the named style in the style pool.
```javascript
getNamedStyle(name: string) : Style;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | string | name of the style |
**Returns**
named style, maybe null.
### mergeNamedStyles(Workbook) {#mergeNamedStyles-workbook-}
Merges named styles from the other Excel file.
```javascript
mergeNamedStyles(source: Workbook) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | [Workbook](../workbook/) | The other file |
### changePalette(Color, number) {#changePalette-color-number-}
Changes the palette for the spreadsheet in the specified index.
```javascript
changePalette(color: Color, index: number) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| color | [Color](../color/) | Color structure. |
| index | number | Palette index, 0 - 55. |
**Remarks**
The palette has 56 entries, each represented by an RGB value.
If you set a color which is not in the palette, it will not take effect.
So if you want to set a custom color, please change the palette at first.
The following is the standard color palette.
Color Red Green Blue - Black 0 0 0
- White 255 255 255
- Red 255 0 0
- Lime 0 255 0
- Blue 0 0 255
- Yellow 255 255 0
- Magenta 255 0 255
- Cyan 0 255 255
- Maroon 128 0 0
- Green 0 128 0
- Navy 0 0 128
- Olive 128 128 0
- Purple 128 0 128
- Teal 0 128 128
- Silver 192 192 192
- Gray 128 128 128
- Color17 153 153 255
- Color18 153 51 102
- Color19 255 255 204
- Color20 204 255 255
- Color21 102 0 102
- Color22 255 128 128
- Color23 0 102 204
- Color24 204 204 255
- Color25 0 0 128
- Color26 255 0 255
- Color27 255 255 0
- Color28 0 255 255
- Color29 128 0 128
- Color30 128 0 0
- Color31 0 128 128
- Color32 0 0 255
- Color33 0 204 255
- Color34 204 255 255
- Color35 204 255 204
- Color36 255 255 153
- Color37 153 204 255
- Color38 255 153 204
- Color39 204 153 255
- Color40 255 204 153
- Color41 51 102 255
- Color42 51 204 204
- Color43 153 204 0
- Color44 255 204 0
- Color45 255 153 0
- Color46 255 102 0
- Color47 102 102 153
- Color48 150 150 150
- Color49 0 51 102
- Color50 51 153 102
- Color51 0 51 0
- Color52 51 51 0
- Color53 153 51 0
- Color54 153 51 102
- Color55 51 51 153
- Color56 51 51 51
;
```
**Returns**
[Promise](../promise/)
**Remarks**
For all supported formulas, please see the list at https://docs.aspose.com/display/cellsnet/Supported+Formula+Functions
**Example**
```javascript
const { Workbook } = require("aspose.cells.node");
var workbook = new Workbook("input/Book1.xls");
workbook.calculateFormulaAsync()
.then(() => {
workbook.save("output/Book1-Calc.pdf");
})
.catch(error => {
console.error(error);
});
```
### calculateFormulaAsync(boolean) {#calculateFormulaAsync-boolean-}
Calculates the result of formulas.
```javascript
calculateFormulaAsync(ignoreError: boolean) : Promise;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| ignoreError | boolean | Indicates if hide the error in calculating formulas. The error may be unsupported function, external links, etc. |
**Returns**
[Promise](../promise/)
### calculateFormulaAsync(CalculationOptions) {#calculateFormulaAsync-calculationoptions-}
Calculating formulas in this workbook.
```javascript
calculateFormulaAsync(options: CalculationOptions) : Promise;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | [CalculationOptions](../calculationoptions/) | Options for calculation |
**Returns**
[Promise](../promise/)
### refreshDynamicArrayFormulas(boolean) {#refreshDynamicArrayFormulas-boolean-}
Refreshes dynamic array formulas(spill into new range of neighboring cells according to current data) Other formulas in the workbook will not be calculated recursively even if they were used by dynamic array formulas.
```javascript
refreshDynamicArrayFormulas(calculate: boolean) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| calculate | boolean | Whether calculates and updates cell values for those dynamic array formulas |
### refreshDynamicArrayFormulas(boolean, CalculationOptions) {#refreshDynamicArrayFormulas-boolean-calculationoptions-}
Refreshes dynamic array formulas(spill into new range of neighboring cells according to current data)
```javascript
refreshDynamicArrayFormulas(calculate: boolean, copts: CalculationOptions) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| calculate | boolean | Whether calculates and updates cell values for those dynamic array formulas |
| copts | [CalculationOptions](../calculationoptions/) | The options for calculating formulas |
**Remarks**
For performance consideration, we do not refresh all dynamic array formulas automatically when the formula itself or the data it references to changed. So user need to call this method manually after those operations which may influence dynamic array formulas, such as importing/setting cell values, inserting/deleting rows/columns/ranges, ...etc.
For most formulas with functions, calculating the spill range also needs to calculating the formula, so in general true value for "calculate" flag is preferred. If the formula is simple, such as a range reference or array(for example "=C1:E5", "={1,2;3,4}", ...), simple function on a range or array(for example "=ABS(C1:E5)", "=1+{1,2;3,4}", ...), and all formulas will be calculated later(such as by [Workbook.CalculateFormula(CalculationOptions)](../workbook.calculateformula(calculationoptions)/)), then using false vlaue for "calculate" flag may avoid the duplicated calculation for the benefit of performance.
### getMatchingColor(Color) {#getMatchingColor-color-}
Find best matching Color in current palette.
```javascript
getMatchingColor(rawColor: Color) : Color;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| rawColor | [Color](../color/) | Raw color. |
**Returns**
Best matching color.
**Remarks**
There are only 56 colors in the color palette in Excel 97-2003. If the color is not in the palette, the similar color will be set.
### setEncryptionOptions(EncryptionType, number) {#setEncryptionOptions-encryptiontype-number-}
Set Encryption Options.
```javascript
setEncryptionOptions(encryptionType: EncryptionType, keyLength: number) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| encryptionType | [EncryptionType](../encryptiontype/) | The encryption type. |
| keyLength | number | The key length. |
### protect(ProtectionType, string) {#protect-protectiontype-string-}
Protects a workbook.
```javascript
protect(protectionType: ProtectionType, password: string) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| protectionType | [ProtectionType](../protectiontype/) | Protection type. |
| password | string | Password to protect the workbook. |
### protectSharedWorkbook(string) {#protectSharedWorkbook-string-}
Protects a shared workbook.
```javascript
protectSharedWorkbook(password: string) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| password | string | Password to protect the workbook. |
### unprotect(string) {#unprotect-string-}
Unprotects a workbook.
```javascript
unprotect(password: string) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| password | string | Password to unprotect the workbook. |
### unprotectSharedWorkbook(string) {#unprotectSharedWorkbook-string-}
Unprotects a shared workbook.
```javascript
unprotectSharedWorkbook(password: string) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| password | string | Password to unprotect the workbook. |
### removeMacro() {#removeMacro--}
Removes VBA/macro from this spreadsheet.
```javascript
removeMacro() : void;
```
### removeDigitalSignature() {#removeDigitalSignature--}
Removes digital signature from this spreadsheet.
```javascript
removeDigitalSignature() : void;
```
### acceptAllRevisions() {#acceptAllRevisions--}
Accepts all tracked changes in the workbook.
```javascript
acceptAllRevisions() : void;
```
### getThemeColor(ThemeColorType) {#getThemeColor-themecolortype-}
Gets theme color.
```javascript
getThemeColor(type: ThemeColorType) : Color;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| type | [ThemeColorType](../themecolortype/) | The theme color type. |
**Returns**
The theme color.
### setThemeColor(ThemeColorType, Color) {#setThemeColor-themecolortype-color-}
Sets the theme color
```javascript
setThemeColor(type: ThemeColorType, color: Color) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| type | [ThemeColorType](../themecolortype/) | The theme color type. |
| color | [Color](../color/) | the theme color |
### customTheme(string, Color[]) {#customTheme-string-colorarray-}
Customs the theme.
```javascript
customTheme(themeName: string, colors: Color[]) : void;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| themeName | string | The theme name |
| colors | [Color](../color/)[] | The theme colors |
**Remarks**
The length of colors should be 12. Array index Theme type - 0 Backgournd1
- 1 Text1
- 2 Backgournd2
- 3 Text2
- 4 Accent1
- 5 Accent2
- 6 Accent3
- 7 Accent4
- 8 Accent5
- 9 Accent6
- 10 Hyperlink
- 11 Followed Hyperlink
;
```
**Returns**
[Promise](../promise/)
**Remarks**
The default file format type is Xlsx. If you want to create other types of files, please use Workbook(FileFormatType).
### openAsync(FileFormatType) {#openAsync-fileformattype-}
Initializes a new instance of the [Workbook](../workbook/) class.
```javascript
static openAsync(fileFormatType: FileFormatType) : Promise;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| fileFormatType | [FileFormatType](../fileformattype/) | The new file format. |
**Returns**
[Promise](../promise/)
**Remarks**
The default file format type is Excel97To2003.
### openAsync(LoadOptions) {#openAsync-loadoptions-}
Initializes a new empty instance of the [Workbook](../workbook/) class with options
```javascript
static openAsync(loadOptions: LoadOptions) : Promise;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| loadOptions | [LoadOptions](../loadoptions/) | The options. |
**Returns**
[Promise](../promise/)
### openAsync(string) {#openAsync-string-}
Initializes a new instance of the [Workbook](../workbook/) class and open a file.
```javascript
static openAsync(file: string) : Promise;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| file | string | The file name. |
**Returns**
[Promise](../promise/)
**Example**
```javascript
const { Workbook } = require("aspose.cells.node");
Workbook.openAsync("input/Book1.xls")
.then(workbook => {
workbook.save("output/Book1.pdf");
})
.catch(error => {
console.error(error);
});
```
### openAsync(Uint8Array) {#openAsync-uint8array-}
Initializes a new instance of the [Workbook](../workbook/) class and open a stream.
```javascript
static openAsync(stream: Uint8Array) : Promise;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | Uint8Array | The stream. |
**Returns**
[Promise](../promise/)
### openAsync(string, LoadOptions) {#openAsync-string-loadoptions-}
Initializes a new instance of the [Workbook](../workbook/) class and open a file.
```javascript
static openAsync(file: string, loadOptions: LoadOptions) : Promise;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| file | string | The file name. |
| loadOptions | [LoadOptions](../loadoptions/) | The load options |
**Returns**
[Promise](../promise/)
### openAsync(Uint8Array, LoadOptions) {#openAsync-uint8array-loadoptions-}
Initializes a new instance of the [Workbook](../workbook/) class and open stream.
```javascript
static openAsync(stream: Uint8Array, loadOptions: LoadOptions) : Promise;
```
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| stream | Uint8Array | The stream. |
| loadOptions | [LoadOptions](../loadoptions/) | The load options |
**Returns**
[Promise](../promise/)